Platforms
Product Lines
Platforms Safecrete Safewall Mine Operating System (Coming Soon)
On this page

Managing Devices

Introduction

Devices are fundamental IoT entities in IndustryOS that can generate telemetry data (such as temperature, humidity, GPS coordinates, etc.) and transmit it to the IndustryOS platform, as well as respond to Remote Procedure Call (RPC) commands. Devices can be either physical (e.g., sensors, controllers, trackers) or virtual (e.g., emulators) network-connected objects that are capable of:

  • Generating telemetry data — Send measured data such as temperature, humidity, or location
  • Transmitting data to the IndustryOS platform via supported protocols (MQTT, HTTP, CoAP, etc.)
  • Responding to RPC commands — Receiving and executing remote procedure calls sent from the platform

Each device:

  • Is stored as a separate entity
  • Has a device profile that defines type, transport settings, firmware, alarm rules, etc.
  • Can be assigned an owner
  • Supports both attributes (static or semi-static properties) and telemetry (time-series data)

Note: IndustryOS supports device management functions via both the web UI and the REST API.

Adding New Device

To add a new device:

  1. Navigate to EntitiesDevices
  2. Click the “+” icon in the upper-right corner and select Add new device from the drop-down menu
  3. In the device creation form, fill in the required fields:
    • Name – A unique name for the device
    • Device profile – By default, the profile is set to “default”, but you can choose a different profile if needed
  4. Optional fields such as Label or Description can be filled in if needed
  5. Click Add

Device successfully created and is now available in the list.

A window will immediately open where you can check the device’s connection to IndustryOS platform. This step is optional. For now, let’s close this window and return to the connection check in more detail later.

You’ll also receive a notification (bell icon) indicating the device was added.

Editing Device

You can change the device name, its device profile, label, assign the firmware and software. To edit the device:

  1. In the devices list, locate and click on the desired device, then click the pencil (✏️ Edit) icon on the right to open the edit form
  2. Make the necessary changes and click the Apply changes button to save them

Deleting Device

You can delete a device using one of the following methods:

Method 1:

  1. Click on the trash can icon opposite the device’s name you want to delete
  2. Confirm deleting the device in the dialogue box

Method 2:

  1. Click on the device that you want to delete. In the device details window, click the Delete device button
  2. Confirm deleting the device in the dialogue box

Check Connectivity

To verify if your device is successfully connected to IndustryOS:

  1. Open the Device details window and click Check connectivity
  2. Select:
    • Communication protocol (MQTT, HTTP, CoAP, etc.)
    • Operating system
  3. Copy the generated command and run it in a Terminal

If successful, the device status will change from “Inactive” to “Active”, and telemetry data (e.g., temperature) will appear.

Manage Device Credentials

Supported credential types:

  • Access Token (default)
  • X.509 certificate
  • MQTT Basic

To change or manage credentials:

  1. Open Device details window and click the Manage credentials button
  2. Select the desired credential type and generate or enter required fields. Click Save

Make Device Public

You can make a device public so that all its data is accessible to everyone. This is ideal for creating public demo dashboards that require access to device data or for open data use cases.

  1. Open Device details window and click the Make device public button
  2. Confirm the action in the dialogue box

To make the device private again:

  1. Open Device details window and click the Make device private button
  2. Confirm the action in the dialogue box

Note: Once the device is made private, it will no longer be publicly accessible, and any public dashboards referencing it will lose access to its data.

Assign Device to Customer

You can assign the device to a specific Customer. This ensures that only users associated with that customer will have access to the device and its data.

Important: This step is crucial for ensuring data access control. Each customer user will only see their own devices and will not have access to devices or data assigned to other customers.

  1. Open Device details window and click the Assign device to customer button
  2. Select the customer to assign the device. Then click Assign
  3. The device is assigned to the selected customer

Device Details

Clicking on the device opens a window where you can access and manage various aspects of that device.

Copy Device ID

To retrieve the device’s unique identifier in IndustryOS:

  1. Open the device’s detail page by clicking on the device name in the list
  2. Click the Copy device Id button

This will copy the Device ID (UUID) to your clipboard for use in scripts, API calls, or integrations.

Copy Device Credentials

Depending on the credentials type in use, you can copy:

  • Access Token — by clicking “Copy access token”
  • MQTT Credentials — by clicking “Copy MQTT credentials”

These credentials are required to authenticate your device when sending data or connecting via API.

Device Attributes

This tab displays the client, server, and shared attributes of the device. For example, serial number, model, and firmware version. Attributes are static and semi-static key-value pairs associated with devices.

You can add, edit, or delete attributes from this tab. Attributes can be used for:

  • Storing device configuration
  • Enriching telemetry data
  • Filtering devices in dashboards
  • Defining alarm thresholds

Device Telemetry

This tab shows the real-time telemetry data the device sends, such as sensor readings, status, and other measurable variables. Time-series data points are available for storage, querying, and visualisation. For example, temperature, humidity, and battery level.

Adding Telemetry

You can manually add telemetry using the IndustryOS UI:

  1. Click the plus icon in the top right corner of the window
  2. In the new window, enter the key name, select the value type, and enter the value
  3. Click Add button

Deleting Telemetry

To delete telemetry:

  1. Click the trash can icon next to the name of the telemetry key you want to delete
  2. Choose what you want to delete specifically:
    • Delete all data
    • Delete all data except latest value
    • Delete latest value
    • Delete all data for time period
  3. Confirm the deletion by clicking the Apply button

Device Alarms

This tab shows alarms that identify issues with your devices. Alarms can be:

  • Active — Currently occurring issues
  • Acknowledged — Issues that have been seen by an operator
  • Cleared — Issues that have been resolved

Device Events

Here, events related to the device are displayed, including system logs, errors, warnings, and other important moments in the device’s lifecycle. This is useful for troubleshooting connectivity issues, debugging rule chains, and monitoring device behaviour.

Device Relations

Relations are directed connections to other entities. This tab displays the relationships of this device with other devices, dashboards, assets, and other entities in the IndustryOS system.

Relations enable:

  • Creating hierarchies (e.g., device belongs to asset)
  • Data aggregation (e.g., combining data from multiple devices)
  • Dashboard navigation (e.g., drilling down from asset to devices)

Device Audit Logs

IndustryOS provides the ability to track user actions in order to keep an audit log. It is possible to log user actions related to main entities: assets, devices, dashboards, rules, etc.

This is useful for:

  • Security compliance
  • Troubleshooting configuration changes
  • Understanding who made what changes and when

Next Steps