Skip to main content

Managing IoT Devices: Create, View, Update, and Delete

Overview​

This article provides a step-by-step guide for managing IoT devices in the system through the IoT Server Dashboard. It covers how to create, view, update, and delete devices, including field explanations and usage tips.

✅ 1. Creating a New Device​

Steps​

  1. Log in to the IoT Dashboard.
  2. Go to the Devices section in the main menu.
  3. Click on the “Add Device” or “Create Device” button.
  4. Fill in the following required fields:
    • Name: Internal system name (e.g., bedroom_1_lamp).
    • Display Name: User-friendly name shown in the guest and tablet app UI (e.g., Lamp).
    • Type: Select the type of device from the dropdown (e.g., light, sensor, hvac).
    • Is Enabled: Toggle to activate or deactivate the device. When disabled, it will disappear from the tablet & guest app.
    • Category: Logical grouping (e.g., lamps, climate, etc.).
    • Area: Assign the device to a specific area or sub-area.
    • Integration ID / Target ID: Link to third-party systems (e.g., TIS, Lutron).
    • Metadata: Optional key-value configuration data for storing custom information, notes, or tags not covered by other fields. (Must be valid JSON).
    • Localizations: Localized display names for different languages (e.g., Arabic, Russian, Chinese).
  5. Click Create to save.

Result​

The device will now appear in the device list and is available for automation or control.

📄 2. Viewing Devices​

Steps​

  1. Go to the Devices section from the dashboard.
  2. A table will be displayed with a list of all active (non-deleted) devices.
  3. Each row displays key information, including:
    • Name
    • Type
    • Integration
    • Target
    • Display Name
    • Created At
    • Action buttons: View, Update, Delete
  4. Use the search and filter options to locate specific devices.
  5. Click the View button to see full device details.

✏️ 3. Updating a Device​

Steps​

  1. In the Devices List, click the “Edit” button on a device row.
  2. Modify any of the following fields:
    • Name
    • Display Name
    • Category
    • Area Assignment
    • Integration
    • Target
    • Type
    • Is Enabled
    • Metadata
    • Localization fields
  3. Click Save to confirm the changes.

Notes​

  • Some fields like ID and Created At are system-managed and not editable.
  • Updates are saved immediately and reflected in the device list.

🗑️ 4. Deleting a Device​

Steps​

  1. Go to the Devices List.
  2. Click the “Delete” button for the desired device.
  3. A confirmation dialog will appear.
  4. Click Confirm to proceed.

What Happens​

  • The device is removed from the list.
  • A success message is displayed.
  • The device is no longer available for interaction.
warning

Deletion is permanent from the user's perspective—deleted devices cannot be restored via the dashboard.

💡 Best Practices​

  • Use clear and distinct names for devices to avoid confusion (e.g., Bedroom Lamp, Kitchen Sensor).
  • Organize devices by category and area for easier filtering and management.
  • Regularly review and remove unused or disconnected devices.