DMS Settings

dms.bundle_id

Abbreviationdm b
Accessget

Description

Displays the bundle ID of the firmware bundle most recently returned by OTA.

Arguments

-

Default

-

Supported Platforms

Get example

> get dm b
bc19d591-e96b-4017-9ac3-0459cb480706

dms.cmd.enabled

Abbreviationdm c e
Accessget/set

Description

Enable support for issuing commands to the device from the DMS. When enabled, the device opens a secure websocket. With the websocket, asynchronous ZentriOS external commands can be sent to the device.

Note: The device must be claimed/activated for this feature to work.

To use this feature, set up the device with credentials for a WLAN connected to the Internet, set dms.cmd.enabled to 1, and reboot.

On rebooting the device opens a Websocket connection to the DMS. Log into the DMS as the user who has claimed the device, select the device, and in the Device Details page select the Console tab. The tab should display device connected. You can now issue commands to the device via the DMS device console.

> set dms.cmd.enabled 1
Set OK
> save
Saved
Success
> reboot
Rebooting
[2017-08-30 | 06:17:20: Disassociated]
JTAG debug enabled
ZENTRI-AMW106_ZAP-3.4.0.2, 2017-08-01T08:35:32Z, ZentriOS-WZ-3.4.0.2, Board:AMW106-E03.3
[Ready]
> [Associating to SLA]
> Obtaining IPv4 address via DHCP
IPv4 address: 10.5.6.74
[Associated]
> Resolving host: ota.zentri.com
Connecting (WS): 52.65.215.174:80
DMS stream opened

Arguments

0/1

Default

0 - not enabled

Properties

Supported Platforms

Get example

> get dm c e
0

Set example

> set dm c e 1
Set OK

dms.geolocate.interval

Abbreviationdm g i
Accessget/set

Description

Not yet available

The period in seconds to post local scan results to the DMS. When the device joins the WLAN network ZentriOS scans for local Wi-Fi networks and posts the results to the DMS. The DMS uses the results to determine the device's geo-location. ZentriOS posts a subsequent scan every dms.geolocate.interval seconds.

Additionally, if this feature is enabled, scan results are posted immediately following a successful OTA. This enables the DMS to determine exactly where the device was updated.

There is an option to post scan results only after an OTA (not periodically afterwards).

See also dms geolocate.

Note: When a scan is in progress, data streaming is paused temporarily.

Arguments

<seconds>

Default

0

Where:

Properties

Supported Platforms

Get example

> get dm g i

Set example

> set dm g i

dms.ota_host

Abbreviationdm h
Accessget

Return the DMS host domain the device is pointed towards.

This may only be updated by the DMS during an OTA. The DMS updates the value by modifying the device's TLS certificates. The DMS host is determined from the device TLS certificates.

Arguments

-

Default

``

Supported Platforms

Get example

> get dm h
ota.zentri.com

dms.ota_result

Abbreviationdm o
Accessget

Description

Returns the result of the most recent OTA since the last power cycle. See the ota command.

Issuing repeatedly returns the same code until the next OTA or the device is power-cycled.

The returned result is one of the following codes:

CodeDescription
0No OTA performed. This is the default value after a power-cycle
1Firmware successfully updated
2No firmware update required
3General failure
4No SSID/password set
5Failed to join network
6Failed to connect to DMS
7DMS returned Authorized error code (403)
8DMS returned bad request error code (400)
9DMS returned Not Found error code (404)

Arguments

-

Default

0

The default value is returned after a power cycle before any OTA is performed.

Supported Platforms

Get example

> get dm o
2

dms.telemetry.adc_mask

Abbreviationdm t a
Accessget/set

Description

Bitmask of ADCs to include in posted telemetry message to DMS.

Arguments

<bitmask>

where <bitmask> is a 32bit hex string. Each bit maps to an ADC number. e.g. 0x15 maps to ADCs 0, 2, 4.

Default

0x00

Properties

Supported Platforms

Get example

> get dms.telemetry.adc_mask
0x0

Set example

> set dm t a 0x1
Set OK

dms.telemetry.data_mask

Abbreviationdm t d
Accessget/set

Description

Bitmask of data to include in posted telemetry message to DMS.

Arguments

<bitmask>

where <bitmask> is a 32bit hex string with the following flags:

Flag BitDescription
0x0001WLAN SSID
0x0002WLAN BSSID
0x0004WLAN channel
0x0008WLAN RSSI
0x0010WLAN IP address
0x0020remote terminal port
0x0040firmware version
0x0080uptime
0x0100current time
0x0200system faults

Default

0x3FF

Properties

Supported Platforms

Get example

> get dms.telemetry.data_mask
0x3FF

Set example

> set dm t a 0x211
Set OK

dms.telemetry.gpio_mask

Abbreviationdm t g
Accessget/set

Description

Bitmask of GPIOs to include in posted telemetry message to DMS.

Arguments

<bitmask>

where <bitmask> is a 32bit hex string. Each bit maps to a GPIO number. e.g. 0x15 maps to GPIOs 0, 2, 4.

Default

0x00

Properties

Supported Platforms

Get example

> get dms.telemetry.gpio_mask
0x0

Set example

> set dm t g 0x31
Set OK

dms.telemetry.interval

Abbreviationdm t i
Accessget/set

Description

The period in seconds to post telemetry messages to the DMS.

When the device joins the WLAN network, ZentriOS posts a telemetry message immediately. ZentriOS posts a subsequent message every dms.telemetry.interval seconds.

Arguments

<seconds>

Default

0

Properties

Supported Platforms

Get example

> get dm g i
0

Set example

> set dms.telemetry.interval 10
Set OK

dms.token

Abbreviationdm t
Accessget

Description

Not yet available

Arguments

Default

Get example