Device Management

Device Model

The device model describes the metadata and management characteristics of a device. This metadata determines the version of firmware or the solution software which will be running on the device. Currently, the model is composed of the following fields:
vendor.platform.type.model
  • Vendor: The manufacture of the device
  • Platform: The main CPU used on the device
  • Type: General functionality of the device, such as gateway, l2switch, firewall.
  • Model: The device’s model number. On most devices, it can be found on the label located on the front, back, side, or bottom.
_images/model.png

For example, a reference board made by NXP could take the model string as: nxp.ls1043a.gateway.rdb

Create a New Device Model

There are two parts in model, Public Model and Private Model, users can create private model. If user wants to public the model, can send a request to administrator, after approved, the model can be public.
  • Click Devices -> Device Model -> Create.
_images/model-create1.png
  • Input the device model arguments. Select from the pull down box or provide new data.

    If this device model is only used by yourself, make sure private is selected.

_images/model-create2.png
  • Go back to the device model list and check that the new model is generated.
_images/model-create3.png
  • Click audit button, purple frame button, and can send a request to administrator.
_images/model-audit.png

Device

Create and Enroll Device

Click Devices -> Device List -> Create

  • Fill in the SN number and device model (select from the drop-down list) in the following form:
_images/device-create.png

Inactivate a Device

Inactivating a device means to disable the device’s functionality from the cloud. After the instruction is sent to the device, the identification and certificate will be erased and the device will be disconnected from the cloud. Nonetheless, the bootstrap image will not be erased and the device can go through the enrollment process as a new device.

_images/device-unenroll.png _images/device-unenroll-step1.png

Activate a Device

When the device is in “Inactive” state, click the Active button on the device page, and the bootscript download window will pop up. The bootscript contains the device identity and device-specific private key. The device can go through the enrollment process again with the script and connect to the cloud.

_images/device-enroll.png _images/device-enroll-step1.png _images/device-enroll-step2.png

Device Lifecycle

The device lifecycle shows users which state the device is in and the number of devices in a certain state. Device lifecycle is divided into six states:

  • Created: the logic device is registered at cloud
  • New: factory-reset state, the physical device is booted and trying to connect cloud
  • Authenticated: device sends the enroll/re-enroll information to cloud, the device is get authenticated
  • Active: The device is issued with valid certificate
  • Inactive: the certificate is expired or erased
  • Retired: destroy the device, erase the sensitive info on device and the device is dis-functional
_images/device-lifecycle1.png _images/device-lifecycle2.png

Device Area

Device area display shows the user where the device is located. When the device location information is not available, it is displayed as “others”.

_images/device-area.png

Device Detail

Device detail page displays more information of the device’s running status:

  • App Number: Number of running APPs on the device
  • CPU Usage: percentage of CPU load
  • Mem Usage: percentage of memory used
  • EdgeScale Version: EdgeScale agents version
  • Device Logs: including system log and EdgeScale agents logs
  • Statistics: Including CPU Usage, Mem Usage and Disk Usage
_images/device-detail1.png _images/device-detail2.png _images/device-detail3.png

Delete Device

To delete a device, click Delete button of the corresponding device in the “DeviceList” page. It will ask for user’s confirmation before it is deleted.

_images/device-delete.png

Monitor Device

When the user starts a device, a start time will be sent to the database. EdgeScale will receive the start time and show a mark (marked with red box) on device list page to show that the device is online. When user turns off the device, the mark will be offline.

_images/device-online.png

Erasing Device

When the user clicks the Destroy button on device detail page, a pop up window will emerge. If the user clicks Yes, all the data on the device will be erased.

_images/device-erase.png

Sub Device

Registration

To register sub-device in EdgeScale platform, An iot gateway application(or a process) should be running on the gateway device which could scan the sub-devices and send registration message to EdgeScale cloud, then the scanned sub-devices will be registered automatically.

In EdgeScale Application Store, there is one iot-gateway app demo which supports NXP OPENMV_CAMERA_IMXRT_1062 camera board and NXP Netherlands BV DR1174 Carrier Board and user can deploy the app to the gateway device. After the app is deployed and running, the scanned sub-devices will be registered and user could view and manage these sub-devices from EdgeScale dashboard web page.

Note

The most of deployment steps for iot-gateway app demo are same as other common application, the only difference: remember to select the Hostnetwork in More Arguments page. For full deployment steps, referring to Application Management -> App Management -> Deploy App.

In addition, users could design and implement their own iot-gateway, refer to Connect to EdgeScale -> Connect Iot endpoints for full introduction.

Check subordinate device

Click Devices -> Device List

If a device has subordinate devices, there will be a tree button besides it.

_images/subdev1.png

Click the tree button and go to subordinate devices page

_images/subdev2.png

Delete and edit

User can delete and edit subordinate device, Click the operation button on each row

_images/subdev3.png

Subordinate attributes

Each subordinate device has their attributes. Some of these attributes can edit, and there will be an edit button at the end of the attribute.click the button, and you can edit current attributes.
_images/subdev4.png

Device Group

For effective and quick device management, EdgeScale allows users to manage several devices at once by categorizing them into groups. EdgeScale supports both dynamic groups and static groups, system groups and custom groups.

Device Group Types

System Groups:

Default groups created by EdgeScale

  1. Model: Device group(s) per device model
  2. Customer: Device group(s) per customer
Custom Groups:

Created by users for specific requirements. Users can view, edit, and delete groups.

  1. Static Groups: Manually created by the user by adding specific devices to a group. These groups change only when a user manually changes the devices in the group.
  2. Dynamic Groups: Groups that are dynamically defined by matching user-specified criteria. Devices in the group change based on their changing criteria.

Here are the things users can do with device groups:

  • Create, describe, or delete a static device group.
  • Add device(s) into a static device group.
  • Remove device(s) from a static device group.
  • List the dynamic device groups created by the system and static groups created by the user.
  • List the devices in a group.
  • Add, delete, or update the attributes of a static group.

Bulk Device Management

EdgeScale supports several bulk operations on device groups.

  • Manufacture service could generate config file for a production or sales batch.
  • Bulk provisioning per device group.
  • Bulk deployment per device group.

Bulk device registration

_images/manufacture.png
  • Project name: Input the project name.
  • Model: Select device model.
  • Number: Input the device number of this production or sales batch.
  • Customer: Select customer name.

Each manufacture project provides a general config file per device batch. This file needs to be saved to the filesystem of the device during factory manufacture.

For example:

api: https://api.edgescale.org/v1
mft:
  keyID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  oemID: "xxx"
  key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

You can perform the following actions on user’s historical manufacturing projects:

  1. Check the project details.
  2. Download the config file.
  3. Delete the project.
_images/manufacture-detail.png

When the devices with the config file embedded in the file system are powered on, they will be registered automatically to EdgeScale.

Create a Device Group

Click Devices -> Device Group -> Create

_images/device-group-create.png

After clicking Submit button, there will be a new group item in the list.

_images/device-group-list.png

Check Group Detail Information

Click group id and the page will link to the group detail page.

_images/device-group-detail.png

Bind and Remove Devices

Click Add button to bind devices to the current device group.

_images/device-group-bind.png

Click Bind to Group to bind all devices selected to the current group. On Group List page, select devices, and remove button can be used. Click it to remove all selected devices from the current group.

Deploy SW to device group

Click deploy icon (red box content), and a deploy dialog will show up:

_images/device-group-deploy.png
On deploy dialog, customers can select to deploy app or solution. Select the target app or solution.
  • Click deploy button, target apps or solution will be deployed to device in this group, and a task will be created.
  • Click Save as template button, current deploy setting will be saved as a template, and a template will be created.