Ericsson Device and Data Management

Last modified: Jun 5, 2019 @ 06:02

Release Notes

This document describes all the new features, enhancements, and changes included in this release of the Device and Data Management (DDM) service. For detailed information about using the DDM features, see the online documentation in the DDM documentation portal.

To find out what versions you have installed, check the information in the About window in your DDM Admin dashboard.

Release Version: DDM 19A3

Release Date: w20

Note:

  • DMM 19A3 covers DDM Core 2.3, DDM Core UM 1.1.0, LwM2M Gateway 1.5, LwM2M BSS 1.1, BSSi 1.1, MQTT Gateway 2.2.0, and HTTP Gateway 1.0.0.
  • This Release Note covers DDM Core 2.3, DDM Core UM 1.1.0, MQTT Gateway 2.2.0, and HTTP Gateway 1.0.0.

Contents

Main End User Improvements

Additional information is found in section Release Details.

New Features
Usage Metrics – Additional attributes added to the report.
FOTA – Allow external image servers.
HTTP Gateways for DDM.
HTTP Gateways – Downlink implementation.
HTTP Uplink data.
HTTP device register.
New Web Admin API Endpoints
Nothing for this release.
New Southbound Commands
POST /api/v1/register
POST /api/v1/senml
Other End User Improvements
Improved Authentication for MQTT Gateway.
Customer Issues Solved
Nothing for this release.

Release Details

Features

New Features

Details for New Features – From Web Admin API and GUI Perspective (Northbound Interface)
Feature Description Documentation
Usage Metrics – Additional attributes added to the report. The additional attributes contain the peak value of Device metrics, report generated based on UTC/GMT time zone, and mapping the Device Network name with Device Network Id. See Usage Metrics Collected in the DDM Documentation Portal.
FOTA – Allow external image servers. This feature allows the user to configure external URI (the location of the firmware package file). See Device and Add a Firmware Package to a Device Type in the DDM Documentation Portal.
HTTP Gateways for DDM. HTTP Gateway for DDM includes the following functionalities:
1. HTTPS communication handling on the south bound from devices.

2. New APIs introduction for uplink Senml format data from devices.

3. TLS 1.2 Mutual Authentication.

4. Authorization support.

See HTTP Gateway in the DDM Documentation Portal.
HTTP Gateways – Downlink implementation. Implementation of Downlink support for HTTP Gateway includes the following functionalities:

1. Applications can send data to the known devices by using DDM Northbound APIs.

2. Devices can explicitly register to HTTP Gateway in case they have the server running with different port or URI path, by using register API.

See HTTP Gateway in the DDM Documentation Portal.
Details for New Features – From Device Perspective (Southbound Interface)
Feature Description Documentation
HTTP Uplink data Devices can send SenML format data to DDM via HTTPs. See HTTP Gateway in the DDM Documentation Portal.
HTTP device register
Devices can register in DDM by calling the API and can receive data from the applications.
The device can also be registered by the uplink message.
See HTTP Gateway in the DDM Documentation Portal.

Web Admin API

New API Endpoints

API documentation:

  • If you are using DDM standalone, see swagger.
  • If you are using Ericsson IoT Accelerator, see apidoc.
    Note: Open this link with Google Chrome.

For details, see Overview of APIs in the DDM documentation portal.

Web Admin API – New API Endpoint
Nothing for this release.

Changed API Endpoints

API documentation:

  • If you are using DDM standalone, see swagger.
  • If you are using Ericsson IoT Accelerator, see apidoc.
    Note: Open this link with Google Chrome.

For details, see Overview of APIs in the DDM documentation portal.

 

Web Admin API – Changed API Endpoint
Description Change Description
POST/api/v3/firmwarepackages
Creates a new FirmwarePackage entity. Changed request parameters:

Added new attribute
FirmwarePackageListResponse.Uri

This attribute specifies the firmware external package URI.

GET /api/v3/firmwarepackages
Returns a list of all FirmwarePackages. Changed request parameters:

Added new attribute FirmwarePackageListResponse.Uri

This attribute specifies the firmware external package URI.

Added new attribute
FirmwarePackageListResponse.FileName

This attribute specifies the firmware package file name.

GET/api/v3/firmwarepackages/{id}
Returns a single Firmwarepackage entity. Changed request parameters:

Modified attribute
FirmwarePackageResponse.Uri

The attribute may contain firmware package’s internal or external URI.

GET /api/v3/devicetypes/{id}/firmwarepackages
Returns a list of all FirmwarePackages for the DeviceType. Changed request parameters:

Added new attribute FirmwarePackageListResponse.Uri

This attribute specifies the firmware external package URI.

Added new attribute
FirmwarePackageListResponse.FileName

This attribute specifies the firmware package file name.

POST /api/v3/smartobjects
Creates a SmartObject with the resources belonging to the specified SmartObjectType. The SmartObject is added to the device specified in the request. Changed request parameters:

Deleted Attribute
smartObject.ID

This attribute specifies the Smart Object identifier.

PUT /api/v3/smartobjects/{id}
Updates a SmartObject. Changed request parameters:

Deleted Attribute
smartObject.InstanceNumber

This attribute specifies the instance number of the Smart Object.

Cannot be changed on a PUT request.

Example: [SmartObjectType]/[InstanceNumber]/[ResourceType]

Deleted Attribute
smartObject.DeviceID

This attribute is the Identifier of the device to which the Smart Object is connected.

Deleted Attribute
smartObject.SmartObjectTypeID.

This attribute is the Identifier of the Smart Object Type for the Smart Object.

GET /api/v3/locations/list
Returns a list of all Locations in the DeviceNetwork. API is deprecated and will be removed after December 2019.

Replaced by GET /api/v3/locations.

 

GET /api/v3/locations/list/{id}/positions
Returns a list of the Locations in current positions on other LocationResources. This API endpoint requires the Position read permission. API endpoint is deprecated and will be removed after December 2019.

Replaced by GET /api/v3/locations/{id}/positions.

GET /api/v3/locations/list/{id}/locationresources
Returns a list of LocationResources positioned on this location. API endpoint is deprecated and will be removed after December 2019.

Replaced by GET /api/v3/locations/{id}/locationresources.

Removed API Endpoints

API documentation:

  • If you are using DDM standalone, see swagger.
  • If you are using Ericsson IoT Accelerator, see apidoc.
    Note: Open this link with Google Chrome.

For details, see Overview of APIs in the DDM documentation portal.

Web Admin API Removed API Endpoints
Description Replaced with API endpoint
POST /api/v3/locations/{id}/settingcategories/{settingCategoryId}/settings
Adds setting to a Location in a specific SettingCategory. PUT api/v3/locations/{id}/settingValues
GET /api/v3/devices/datacollectorinternal/{dataCollectorId}
Returns the Gateway’s Internal Device. Use api/v3/devices/{id}/ with InternalDeviceId property from GET api/v3/datacollectors/{id}/
POST /api/v3/barcode
Parses Sens Barcode data into Hardware Type, Mac Address and checks if the device is registered in the DeviceNetwork. No replacement.
POST /api/v3/dataCollectors/{id}/downloadregistrationTicket
Returns the DataCollectors Registration tickets. This API endpoint needs the RegistrationTicket permission. No replacement.

 

 

DELETE /api/v3/deviceNetworks/{id}
Removes a DeviceNetwork. No replacement.
GET /api/v3/kpi/{resourceId}/{dimension}/since/{start}/untilNow
Returns a list of raw measurements for a resource from the specified start time untilnow. No replacement.

 

POST /api/v3/measurements/advanced
Advanced Measurement/KPI query. No replacement.
PUT /api/v3/networkSettings/{id}
Updates a NetworkSetting. No replacement.
GET/api/v3/networkSettings/{id}
Removes a single NetworkSetting. No replacement.
DELETE /api/v3/networkSettings/{id}
Removes a NetworkSetting. No replacement.
GET /api/v3/networkSettings
Returns a paged list of NetworkSettings in the DeviceNetwork. No replacement.
POST /api/v3/networkSettings
Creates a new NetworkSetting. No replacement.
GET /api/v3/user/thumbnail
Downloads the current users thumbnail image from Azure AD. No replacement.

Southbound HTTP Commands

HTTP GW Interface
Description
POST /api/v1/register
Register device to HTTP Gateway.
POST /api/v1/senml
Send telemetry data to DDM in SenML format.

Known Limitations

Known Limitations
When the certificates are added/removed from the Settings Category, the MQTT Gateway application is restarted. This results in disconnection of the clients from the gateway. The clients should connect to the application, once again.
Downlink for HTTP Gateway only works asynchronous.
HTTP Gateway deployment must be manually done by Service Operator.
HTTP Gateway only accepts SenML format data for Uplink and Downlink.
HTTP Gateway does not store the messages for downlink, in case it has not reached the device.
HTTP Gateway only supports certificates with .pem format.
HTTP Gateway cannot perform downlink until device communicates to the Gateway.
HTTP Gateway does not update the Device status in DDM.

Known Issues

Known Issues
Nothing for this release.