Device

Last modified: Sep 10, 2019 @ 06:43

Contents

Device Types

Introduction

Device Types determine the properties used when creating Devices.

Access Device Types

Navigation: Settings -> Hardware Types -> Device Types tab

The Device Types page has a list of all Device Types in the Device Network.

Create/Edit Device Type

Navigation: Settings -> Hardware Types -> Device Types tab: +Create or click a Device

  1. Discover at registration: If this option is enabled, at the first Device registration, the Gateway sends Resource discovery requests, and Devices of this type send data to the Gateway about themselves, for example which Smart Objects they contain. The Gateway SDK onResourceDiscoveryRequest callback is called for each Smart Object instance present in the Device registration request. See Callback: onResourceDiscoveryRequest for more information.
    If the option is disabled, the Gateway assumes a standard model for the Device.

Device Templates

Introduction

Device Templates can be used to create different implementations of a Device Type.

Access Device Templates

Navigation: Settings -> Hardware Templates -> Device Templates tab

The Device Templates page has a list of all Device Templates in the Device Network.

Create/Edit Device Template

Navigation: Settings -> Hardware Templates -> Device Templates tab: +Create or click a Device Template

  1. Device Type: Choose the Device Type to be used as the basis for the template.
  2. Contact Lost Threshold: This option is defunct and will be removed.
  3. Active Smart Objects: Automatically filled in according to the selected Device Type; cannot be edited.
  4. Setting Categories: Defined in the Device Type, though you can edit any fields not set to Read-only in the Settings Category.

Devices

Contents

Introduction

Devices are representations of hardware units. Devices are connected to a Gateway through a wired or wireless channel; both Devices and Gateways are registered to Locations. With wireless connections any kind of connectivity and protocol may be used locally, such as Bluetooth, Z-wave, Zigbee, Wi-Fi, LoRa etc.

Devices are registered using a Device Types that determine which Smart Objects the Device contains and other properties.

Access Devices

Navigation: Settings -> Devices

The Devices page has a list of all Devices in the currently active Device Network:

The Name column has a color indicator to the left of each Device:
  • Green = Device is registered
  • Gray   = Device is unregistered
  • Red     = Device is deregistered

Note:

  • You cannot register Devices on this page, though you can delete them.
  • The LwM2M Gateway implements a “Device Registration Lifetime Grace Period” the value of which is three minutes. In constrained networks such as NB-IoT or when there is large latency, if the registration update from the Device is not received within the given time frame, then the Device gets disconnected. In order to mitigate such issues, the LwM2M server delays the de-registration by three minutes.

Register Device

Navigation 1: Dashboard -> Left-hand sidebar -> a Location

Navigation 2: Settings -> Locations -> a Location

Devices are registered in the Devices panel on a Location:

Click the + Register Device button. The Register Device window is displayed.

  • Name: Enter a name for the Device.
  • Device Identifier (endpoint): This must be unique within the DDM instance.

Note:

  • The name can consist only of characters out of the set “A” to “Z”, “a” to “z”, and “0” to “9”, the minus sign (-), the colon sign (:), and the underscore (_). The name MUST start with a character out of the set “A” to “Z”, “a” to “z”, or “0” to “9”.
  • The device endpoint name should not start with zero (0), if the name consists of numbers only.

For example:

Endpoint Name Acceptable? Reason
0124567AZaz- Yes starts with 0, but contains alphanumeric values, special character
1245670 Yes doesn’t start with 0, and contains only numbers
0124567- Yes starts with 0, but contains numbers and special character
0124567 No starts with 0, and contains only numbers
  • Device Type: Select a suitable Device Type in the dropdown list.
  • Template: Select a suitable Device Template in the dropdown list, or leave it to Default if appropriate.
  • Gateway: Select a Gateway to which the Device will connect.
  • Bootstrap Server: If necessary, select a Bootstrap Server from the dropdown list.
  • Setting Categories: Select a suitable Setting Category from the list.
    Notes: DDM expects PSK information, that is, identity and key, in ASCII format. The PSK must be unique per Gateway. However, no verification of this uniqueness is done on the front-end. The user must make sure that the PSK is unique within the Gateway, and follow LwM2M naming conventions. DO NOT use the “default” values to set the “identity” and “preSharedKey” values in the Setting Category of PSK. It is not secure to use the same PSK value for all gateways and devices.

As an alternative to registering devices one by one in the GUI, it is possible to simultaneously mass-register a number of devices. For more information, see Mass Register Devices.

Edit Device

Navigation 1: Dashboard -> Left-hand sidebar -> a Location -> a Device

Navigation 2: Settings -> Devices -> a Device

A Device page has the following features:

Device Panel

On the Device panel, you can edit the basic properties of a Device:

Information Panel

The Information Panel contains basic details about the Device:

Status Panel

The Status panel shows whether the Device is online or offline.

Request Queue Panel

The Request Queue panel shows outgoing queued requests from the Device to its Gateway:

Activity Log Panel

The Activity Log panel shows activity details for the Device. You can filter activities and choose to show only failed activities:

Smart Objects Panel

The Smart Objects panel has two fields: Device Management and Data Management:

Smart Objects with IDs < 3000 are listed under Device Management, while those with IDs ≥ 3000 are shown under Data Management.

In the Data Management section, Smart Objects marked with a green dot (available) are present in the registration request from the Device.  Smart Objects not present in the registration request from the Device but included in the Device Type definition are marked with a red dot (unavailable).

Setting Category Panel

Setting Category panels show the fields in a Setting Category:

Note that a Device page can have several Setting Category panels. The panels are not named “Setting Category” but rather take on the name given to the Setting Category itself.

Update the Device Firmware

Prerequisite: The Device Type for the Device needs to contain a Firmware Package. See Add a Firmware Package to a Device Type.

  1. Click Actions and select Upgrade firmware.
  2. In the Select firmware version field, select the Firmware Package.
    Note
    : While selecting firmware package, the corresponding package file name or the external URI is displayed.
  3. Click ✓Update.
Firmware package file
External URI

Queue Mode

Queue Mode allows for messages to be queued when devices are offline or unreachable. DDM implements one queue per device. For more information, see Queue Mode in the Platform Description.