Managing Devices


This section describes the device management operations such as how to view and change device status, how to obtain device secret credentials, and more.

Prerequisites

  • Ensure that you have obtained the Developer role to have the access to Application Portal > Developer Console. If not, contact your OU administrator.

  • To learn about the activation and running status of a device, see Device and Cloud Security.

  • Ensure that you have read the limitations for devices. See Limitations.

Viewing Device Dashboard


  1. In EnOS Application Portal > Developer Console, select Device Management > Dashboard.

  2. In the overview report, you can access the following information:

    • Device Status: Includes total number of devices, number of online devices, number of offline devices, number of inactive devices, and number of disabled devices.

    • Firmware Version Distribution: Statistics of firmware versions for devices within the selected range.

    • Measurement Point Report: Includes the number of successful data point reports and the number of failed requests.

    • Command Issue: Includes the number of successfully issued commands and the number of failed issuances.

Viewing Device Status


  1. In EnOS Application Portal > Developer Console, select Device Management > Device Assets.

  2. In the device list, check the device status in the Status column.

    • Inactive: The device has never been activated in the EnOS cloud. Once activated, the page will display the device’s operational status: Online or Offline.

    • Online: The device is currently online. It could be a real device online, or the cloud may have enabled a Virtual Device for this device, simulating an online state.

    • Offline: The device is currently offline.

    • Disabled: The device has been disabled.

Viewing Device Data


  1. In EnOS Application Portal > Developer Console, select Device Management > Logical Assets.

  2. Click the View icon view corresponding to the device to perform the following operations on the device details page:

    • On the Asset Details tab, view the basic information of the device and its associated model information.

    • On the Attributes tab, view the attribute values of the device.

      • If a real device is available, device attributes can be reported using the MQTT protocol. For more information, see Reporting Attributes.

      • If you need to debug the device’s data before a real device is connected, you can use Online Debugging to simulate the process of reporting attribute values for devices in an Inactive or Offline state. Simulated attribute values will also be displayed in the current list.

    • On the Measurement Points tab, view the data point values reported by the device.

      • If a real device is available, device data points can be reported using the MQTT or HTTP protocol. For more information, see EnOS Device Connection Protocols.

      • If no real device is available, you can use the Device Simulator to simulate the process of a device reporting data point values over a period of time. Simulated data point values will be displayed in the current list.

      • If you need to debug the device’s data before a real device is connected, you can use Online Debugging to simulate the process of reporting data point values for devices in an Inactive or Offline state. Simulated data point values will also be displayed in the current list.

    • On the Commands tab, view the status of commands sent from the cloud to the device. For more information, see Issuing Commands.

      • If you need to debug the process of a device (with or without a real device) receiving commands, you can use Online Debugging to simulate the cloud issuing commands, including setting data points and invoking services, and retrieve logs from both the cloud and device sides.

    • On the File tab, view the files uploaded by the device, and download or delete specified files. For more information, see Managing Asset Files.

Exporting Devices


  1. In EnOS Application Portal > Developer Console, select Device Management > Device Assets, and click Batch Operations.

  2. You can either export all of the devices listed by clicking Export > Export All, or export specific devices by selecting the devices you wish to export and click Export > Export Selected.

  3. Save the ZIP file to your local directory. The ZIP file will contain Excel files. Each Excel file represents a product with the file name containing the product’s product key, with the devices inside each Excel file under the product that the Excel template represents.

Importing Devices


You can batch create new devices or update existing devices from different products by importing an Excel file. If an imported device already exists, its information will be updated. If the device does not exist, a new device will be created.

  1. In the Developer Console of EnOS Application Portal, select Device Management > Device Assets.

  2. Click Import.

  3. Upload a compressed package containing one or more .xlsx files for devices. If you need a template, select one or more current products from the Template dropdown, then click Generate Template to download a compressed package containing Excel templates generated based on the selected products. After downloading, edit the template, compress it, and upload the file.


Note

Each Excel template represents one product. The template file naming convention is ProductKey_yourProductKey.xlsx, where yourProductKey is the product key of the product to which the devices belong, obtainable from Device Management > Products. Therefore, all devices in the Excel file will be assigned to the product represented by the Excel template.


4. Click Import. Ensure there are no blank rows in the table, as this may cause the file to fail to import successfully.

5. If invalid records are detected, a pop-up window will display error messages and a Download Error File link. Click the link to download the file, check the error reasons, correct the errors, and re-upload the file.

6. Successfully imported new devices will appear in the device list under Device Management > Device Assets.

Enabling/Disabling Devices


When a device is created, it is automatically enabled no matter the status (Inactive/Online/Offline). If the device is found to be abnormal, it can be disabled in EnOS.

  1. In EnOS Application Portal > Developer Console, select Device Management > Device Assets.

  2. You can either enable/disable a single device or in batch.

    • Single device: In the list of devices, toggle the Enable/Disable switch for the device that you wish to enable/disable.

    • Batch: Click Batch Operations, select the devices you wish to enable/disable, and click Enable or Disable as per required.

  3. If the device is enabled, the Status column will show its status (Inactive/Online/Offline). If the device is disabled, the Status column will show “Disabled”.

Deleting Devices


  1. In EnOS Application Portal > Developer Console, select Device Management > Device Assets.

  2. You can either delete a single device or in batch.

    • Single device: In the list of devices, click … > Delete for the device you wish to delete.

    • Batch: Click Batch Operations, select the devices you wish to delete, and click … > Delete.

  3. A pop-up window will appear. Read the information provided and if you are sure you want to delete the device(s), click Delete.

  4. The deleted device(s) will be removed from Device Management > Device Assets.

Retrieving Device Triple Information


The productKey, deviceKey, and deviceSecret are considered as the device triple information.


  1. In EnOS Application Portal > Developer Console, select Device Management > Device Assets.

  2. In the table of devices, click view to open the Device Details page for the target device and you will be able to see its productKey, deviceKey, and deviceSecret there.

Adding Sub-Devices to a Gateway Device


Perform the following steps to add sub-devices to gateway devices other than EnOS Edge.

  1. Go to Device Management > Device Assets.

  2. For those devices whose Asset Type is Gateway, click the View icon view.

  3. In Device Details page, go to the Sub-Device tab.

  4. Click New Sub-Device, select the devices to be added to this gateway device and click OK. You can only select those that have not been added to other gateway devices.

Tracing Message


You can use message tracing to quickly locate and analyze the cause if a failure occurs during device activation, command issuance, and data reporting.

  1. Go to Device Management > Device Assets.

  2. Click the View icon view for the device that you wish to trace.

  3. In Device Details page, go to the Tracing tab.

  4. Click Start Message Trace, enter the trace duration (max 3 days), and click OK.

  5. The real-time logs of the device (if any) will be displayed below, with the most recent log on top. To clear the display, you can click the Clear button on the right.

  6. To stop tracing, click Stop Message Trace.


Note

Closing the webpage will stop retrieving the real-time logs and clear the display, but will not stop the tracing. You need to manually click Stop Message Trace in order to stop the process.