Gateway

Last modified: Jun 20, 2019 @ 11:33

Contents

Gateway Types

Introduction

Gateway Types determine the properties used when creating Gateways.

Access Gateway Types

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

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

Create/Edit Gateway Type

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

  1. Is legacy: If this option is enabled, the Gateway will use the SDK instead of LwM2M.
  2. Internal Device Type: Gateways can have internal Devices that send data about the Gateway itself, for example battery status or signal quality. This option determines the Device Type for such Devices.

Gateway Templates

Contents

Introduction

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

Access Gateway Templates

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

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

Create/Edit Gateway Template

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

  1. Gateway Type: Choose the Gateway Type to be used as the basis for the template.
  2. Internal Device Type: Defined in the Gateway Type and not directly editable here.
  3. Internal Device Template: Gateways can have internal Devices that send data about the Gateway itself, for example battery status or signal quality. This option determines the Device Template for such Devices.
  4. Contact Lost Threshold: This option is defunct and will be removed.
  5. Setting Categories: Defined in the Gateway Type, though you can edit any fields not set to Read-only in the Settings Category.

Gateways

Contents

Introduction

Gateways enable Devices, which can send data via numerous protocols, to speak with DDM.

Like Devices, Gateways are registered to Locations. Gateways run outside of DDM and can be hardware or software. An IP channel is needed to send data to DDM. The platform is agnostic to the connectivity channel: cellular, LAN, Wi-Fi etc.

Access Gateways

Navigation: Settings -> Gateways

The Gateways page has a list of all Gateways in the currently active Device Network. You can filter the displayed Gateways by name and blacklist status.

Gateways can be deleted on this page, but you cannot delete Gateways that have Devices registered to them. To delete a Gateway, you need to delete all of its Devices first.

Register Gateway

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

Navigation option 2: Settings -> Locations -> a Location

Gateways are registered in the Gateways panel on a Location:

Edit Gateway

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

Navigation option 2: Settings -> Gateways -> a Gateway

A Gateway page has the following features:

Actions Button

Note: The Show Logs GUI has been removed and this has no customer impact.

  • Download Ticket: downloads a Gateway ticket in the form of a .json file.
  • Show Tickets: shows ticket information.
  • Refresh Status: refreshes the Gateway status.
  • Blacklist: blacklists the Gateway. This is used to isolate from DDM a Gateway that has been compromised or is malfunctioning. Data from a blacklisted Gateway is blocked from reaching DDM.
    When a Gateway is blacklisted, the name of this action changes to Remove Blacklist. Click it to undo the blacklisting.
    The name of a blacklisted Gateway is displayed as crossed out in the Dashboard.

Note:

The user can still read the existing data about a Device, including measurements via the APIs on DDM, but no new values will be coming in as long as the Gateway is blocked.

The user can still send commands to a Device and/or the Gateway, since the blacklist only affects the incoming measurements.

  • Add Setting Category: opens the window for adding a Setting Category.

Gateway Panel

In the Gateway panel, you can edit the basic properties of the Gateway:

Name: Enter a name for the Gateway. The name must be unique for the Data Center of DDM. However, there are further restrictions, for example, in Bootstrap Server.

It is recommended that the gateway Name complies with the following conventions:

For LwM2M,

      • Length of the gateway name: No more than 57 characters. No built-in verification is provided. Therefore no guarantee on the length of the Gateway name.
      • The name for a LwM2M Gateway must match the regular expression ^[a-z][a-z0-9-]{1,55}[a-z0-9]$. If it does not, Gateway provisioning fails and the Activity Log displays an error message.

For HTTP and MQTT,

      • Ericsson Operations creates the gateway and the Gateway name will be a set of 10 random characters (for examplece7a111823). The prefix used in the URL will be the same as that of the gateway name.
  • For example,
        • Gateway name: ce7a111823
        • Domain: ddm.iot-accelerator.ericsson.net
        • FQDN Format: <10_digit_random_characters>.ddm.iot-accelerator.ericsson.net
        • Domain: ce7a111823.ddm.iot-accelerator.ericsson.net

Note: The naming convention is common for the HTTP and MQTT gateways of DDM (will be followed in LwM2M in future). Ericsson Operations creates the HTTP and MQTT gateway based on a service request and after creation, communicates the gateway name and the URL to the customer. Later, the customer can modify the gateway name in DDM if required.

External ID: This is an optional setting, not used by DDM. It can be used as an external reference, for example a MAC address or reference number.

Status Panel

Last seen: This option is defunct and will be removed.

Devices Panel

The Devices panel has a list of Devices registered to the Gateway:

Smart Objects Panel

The Smart Objects panel has a list of Smart Objects belonging to internal Gateway Devices, if such Devices have been configured:

Activity Log Panel

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

Information Panel

The Information Panel contains basic details about the Gateway:

The Refresh Status action requests from the Gateway the following information, which is then displayed in this panel:

      • Hardware version
      • Firmware version
      • Software version

Note: LwM2M Gateways do not send this information.

Drawing Panel

The Drawing panel shows drawings that have been added to the Gateway: