• Documentation
• Connecting and Managing Devices in the Cloud
• Managing Devices

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.

Prerequisite

• Ensure that you have the corresponding permissions for the Device Management Service. 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 the Device Status

1. In EnOS Management Console, select Device Management > Device Assets.

2. In the table of devices, you can view the device status in the Status column.

   • Inactive: The device has not been activated. Once the product is activated, the running status - online or offline - will be displayed.

   • Online: The device is currently online.

   • Offline: The device is currently offline.

   • Disabled: The device has been disabled.

   • Mirrored: The data of this device is provided by another device.

Exporting Devices

This function enables you to export devices across different products.

1. In EnOS Management 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

Before you start, ensure that your account has been authorized the policy that includes the following service(s) and action permission(s). If not, contact your OU administrator.

Required Service	Required Operation Permission
Device Management Service	Full Access

This function enables you to batch create new devices or batch update existing devices across different products using Excel. Batch importing of existing devices will update the existing information. If there are no existing devices, new devices will be created.

1. In EnOS Management Console, select Device Management > Device Assets.

2. Click the Import button.

3. Upload a ZIP File that contains one or multiple standard device .xlsx files. For file size limitations, refer to the pop-up window.

   
   

   If you require a template, select one or multiple existing products from Template and click Generate Template to generate Excel templates based on the selected products. The templates will be inside a ZIP file. Edit the template once it’s downloaded, ZIP it up, and upload the file.

Note

• Each Excel template represents a product. The naming convention is "ProductKey_yourProductKey.xlsx", where yourProductKey refers to the product key of a product, which can be found in Device Management > Products. Therefore, all devices inside the Excel file will be under the product that the Excel template represents.

• The number of the devices in Device Management > Device Assets plus the device records in the template should not exceed 100,000.

Excel Template Parameters

Name	Mandatory/Optional	Description
Asset ID	Depends on creating new or updating devices. See description for more information.	The identifier of the device. For creating new devices, leave it blank to let the system automatically generate one. Manually created asset IDs will be ignored. For updating devices, the Asset ID and Device Key must match the device’s device key and asset ID that you are updating. If it cannot be found, it will be an invalid record.
Device Key	Depends on creating new or updating devices. See description for more information.	The unique identifier of a device used for authentication. For creating new devices, you can either provide your own (it is recommended that you use the device SN, IMEI, MAC address, etc.) or leave it blank and let the system automatically generate a device key for you. 4-64 characters. Supports uppercase alphabets (A-Z), lowercase alphabets (a-z), numbers (0-9), dash “-”, and underline “_”. For updating devices, the Device Key and Asset ID must match the device’s device key and asset ID that you are updating. If it cannot be found, it will be an invalid record.
Device Name (Default)	Mandatory	The default name for the device which will be used when device names in other languages are not given. 1 - 64 characters. Does not support <>;@*%&\ characters.
Device Name (Internationalization)	Optional	The internationalization name of the device, e.g. English(en_US) and Simplified Chinese(zh_CN). If not given, the default device name will be used. 1 - 64 characters.
Time Zone	Mandatory	The local time zone of city of the device. If you need to use Daylight Saving Time (DST) for the device, select the city where DST applies. EnOS will validate format of the time zone.
Description	Optional	The description of the device. Max 512 characters.
Device Tag	Optional	The device tags in the form of key-value pairs. The format is in JSON and both key and value must be String. Example: {“key”:”value”}

Note

Do not leave blank rows between the rows as the file may fail to import.

4. Click Import.

5. If invalid records exist, a pop-up window will show an error message and a Download Error File link. Click to download the file, check the cause of the error, rectify it, and upload the file again.

6. Once the devices are successfully imported, the new devices will appear in the list of devices in 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 Management 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”.

Migrating Devices

Before you start, ensure that your account has been authorized the policy that includes the following service(s) and action permission(s). If not, contact your OU administrator.

Required Service	Required Operation Permission
Device Management Service	Full Access

You can migrate devices to another OU by moving it. Moving the device will delete the device from the original OU and the target OU will be able to edit the device information.

When moved, if the model or product of the device does not exist in the target OU, the model and product will be shared to the target OU. Both the model and product will appear in the target OU’s list of models and products respectively, and the target OU will be given read access to both. The target OU will not be able to edit any information for the shared model/product. Any changes to the model/product in the original OU will be reflected in the target OU. Deleting the model/product in the original OU will delete it in the target OU as well.

1. In EnOS Management Console, go to Device Management > Device Assets.

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

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

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

3. Select Move for Action. For Gateway devices, you can choose whether to migrate the sub-device together with the Gateway device. Similar to moving devices, moving sub-devices will also delete them from the original OU.

4. Enter the OU ID for the OU you wish to share the product to.

5. Select the Verification Method, either via email or mobile.

6. Click Get Code. Depending on the Verification Method selected, a verification code will be sent via email or SMS to the owner of the target OU.

7. Enter the verification code (6-digits) and click OK.

8. A pop-up window to confirm the migration will appear. Click OK to proceed.

9. The device will be deleted from the original OU and it will appear in the target OU’s list of devices.

Deleting Devices

Before you start, ensure that your account has been authorized the policy that includes the following service(s) and action permission(s). If not, contact your OU administrator.

Required Service	Required Operation Permission
Device Management Service	Full Access

1. In EnOS Management 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 the Device Triple Information

The productKey, deviceKey, and deviceSecret are considered as the device triple information. Before you start, ensure that your account has been authorized the policy that includes the following service(s) and action permission(s). If not, contact the OU administrator.

Operation	Required Service	Required Permission
Viewing Product Key	Device Management Service	Read (default)
Viewing Device Key	Device Management Service	Read (default)
Viewing Device Secret	Device Management Service	Full Access

1. In EnOS Management Console, select Device Management > Device Assets.

2. In the table of devices, click 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

Before you start, ensure that your account has been authorized the policy that includes the following service(s) and action permission(s). If not, contact your OU administrator.

Required Service	Required Operation Permission
Device Management Service	Full Access

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 .

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.

Message Tracing

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 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.

Related Information

If the device belongs to one or more asset trees, you can click its … > Asset Tree to further manage the device.