Skip to main content

Integrations

🔌 Integrations in the IoT Server Dashboard let you connect external IoT platforms, monitor runtime status, and manage each connection from one place. Use this page to add new providers, control integration lifecycle, and inspect provider-specific behavior from the details view.

📍 Accessing Integrations​

  1. Log in to the IoT Server Dashboard with a management account.
  2. Open the IoT section in the left sidebar.
  3. Click Integrations to open the integrations list page.

📋 Viewing and Managing Integrations​

The Integrations list is your main operations page for connected providers.

The table shows:

  • Name — Integration display name.
  • Platform — Connected provider type.
  • Status — Current runtime state such as Running, Stopped, Error, Initializing, Shutting Down, or Degraded.
  1. Use Search by Name to find a specific integration quickly.
  2. Open column settings to show or hide available columns.
  3. Use the enable toggle on a row to enable or disable an integration.
  4. Click View to open the integration details page.
  5. Click Edit to update integration settings.
  6. Click Start to start a stopped integration.
  7. Click Stop to stop a running integration.
  8. Click Reload to restart the integration runtime without deleting it.
  9. Click Delete to permanently remove an integration.
info

The Start action is available only for enabled integrations that are currently stopped. If an integration is disabled, enable it first, then start it.

warning

Deleting an integration is irreversible from the dashboard. Use Reload or Stop first if you only need temporary maintenance.

➕ Adding and Editing Integrations​

  1. Click Add Integration on the list toolbar.
  2. Set Enabled based on whether the integration should run immediately after creation.
  3. Select Integration Type .
  4. Enter Name .
  5. Fill in the provider-specific section under {Platform} Configuration.
  6. Click Add to create the integration.
  7. Open Edit on any row and click Save to update an existing integration.

Supported integration types:

  • Mock (for testing in a non-production enviroment)
  • Home Assistant
  • TIS
  • Lutron
  • Salto
  • Zigbee2MQTT
info

Configuration fields in {Platform} Configuration change based on the selected Integration Type. Complete all required fields before submitting.

⚙️ Integration Details Page​

  1. Open an integration by clicking its Name or View from the list page.
  2. Review the summary block at the top:
  • Integration ID
  • Name
  • Status
  1. Open Overview to view platform-specific information.
  2. Open Logs to inspect persisted integration logs.

Inside the Logs tab, you can:

  • Refresh — Reload the latest persisted logs.
  • Clear filters — Reset all active filters.
  • Search (text + payload) — Search across message text and payload content.
  • From / To — Filter by date and time range.
  • Log level — Filter by Info, Warn, and Error.
  • Show / Hide payload — Expand structured payloads per log entry.

🔍 Provider-Specific Behavior​

⚙️ Zigbee2MQTT​

Zigbee2MQTT currently has the deepest level of integration, in the details page you can do the following:

  1. Open Overview on a Zigbee2MQTT integration.
  2. Use Permit Join to allow new Zigbee device pairing.
  3. Review bridge summary values like Devices count and Coordinator.
  4. Open the internal Devices tab to manage discovered devices.
  5. Use Search devices to narrow large device lists.
  6. Expand a device to inspect exposes and available controls.
  7. Use provider actions such as rename, remove, and Force remove.
  8. Send live commands through exposed controls (for example toggle, enum options, slider values, and Set actions).
  9. Open the internal Logs tab and enable Show live logs to monitor streaming bridge output while the page is open.
warning

Force remove only removes a device from the Zigbee2MQTT database. The physical device may still communicate on the network until it is factory-reset.

⚙️ Mock​

The Mock provider includes a rich overview, including test-oriented device/entity behavior. Use it for validation and controlled simulation in non-production environments.

⚙️ Home Assistant​

The Home Assistant details overview currently shows basic provider context. Shared Logs tab capabilities still apply for operational troubleshooting.

⚙️ TIS​

The TIS details overview currently shows basic provider context. Shared Logs tab capabilities still apply for operational troubleshooting.

⚙️ Lutron​

The Lutron details overview currently shows basic provider context. Shared Logs tab capabilities still apply for operational troubleshooting.

⚙️ Salto​

The Salto details overview currently shows basic provider context. Shared Logs tab capabilities still apply for operational troubleshooting.

  • Devices & Entities — Manage device and entity inventory synced from integrations.
  • Areas — Organize where devices and controls are grouped.
  • Smart Devices & Guest App — Understand how configured devices appear in guest-facing experiences.