DMS Settings

dms.auto_start_enabled

Abbreviation

dm a

Access

get/set

Description

The dms.auto_start_enabled variable automatically starts the DMS websocket when the configured DMS interface is brought up. This is useful for SDK applications that need to use the DMS APIs but do not require other DMS plugins such as Command or Telemetry.

Note: This variable is not required if another DMS plugin is enabled such as dms.cmd.enabled or dms.telemetry.interval.

Arguments

1/0

Default

0

Get example

> get dm a
0

Set example

> set dms.auto_start_enabled 1
Set OK

dms.bundle_id

Abbreviation

dm b

Access

get

Description

Displays the DMS bundle ID of the firmware bundle currently loaded onto the device.

Arguments

None

Default

None

Gecko OS Kernel Plugin

• kernel

Get example

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

dms.cmd.enabled

Abbreviation

dm c e

Access

get/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 Gecko OS 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
[2019-01-01 | 06:17:20: Disassociated]
[Ready]
SILABS-WGM160P-4.0.0, Gecko_OS-STANDARD-4.0.12-1198, WGM160P
> [Associating to SLA]
> Obtaining IPv4 address via DHCP
IPv4 address: 10.5.6.74
[Associated]
> Resolving host: dfu.zentri.com
Connecting (WS): 52.65.215.174:80
DMS stream opened

Arguments

0/1

Default

0 - not enabled

Properties

• takes effect immediately

Gecko OS Kernel Plugin

• dms.command_console

Get example

> get dm c e
0

Set example

> set dm c e 1
Set OK

dms.connection.host

Abbreviation

dm c h

Access

get

Description

Return the DMS host name the device users to connect to the DMS. This value can be updated only with an appropriately configured DFU package.

Arguments

?

Default

None

Gecko OS Kernel Plugin

• kernel

Get example

> get dm c h
dms.zentri.com

dms.connection.port

Abbreviation

dm c p

Access

get/set

Description

Get or set the DMS socket port.

Arguments

<1-65534>

Default

443

Gecko OS Kernel Plugin

• kernel

Get example

> get dm c p 
443

Set example

> set dm c p 8004
Set OK

dms.connection.timeout

Abbreviation

dm c t

Access

get/set

Description

Specifies the amount of time in seconds the device waits for DMS data before timing out.

This is useful for devices that have a poor connection to the DMS

Notes

This persists through factory resets.

Arguments

<seconds>

Range: <7 -120>

Default

20

Gecko OS Kernel Plugin

• kernel

Get example

> get dm c h
dms.zentri.com

dms.interface

Abbreviation

dm i

Access

get/set

Description

Get or set the network interface to use when connecting to the DMS.

Arguments

-

Default

wlan

where options are:

• wlan
• ethernet - if available for device

Gecko OS Kernel Plugin

• kernel

Get example

> get dm i
wlan

Set example

> set dm i wlan
Set OK

dms.product_id

Abbreviation

dm p

Access

get

Description

Get the ID for the product to which the device is currently activated.

Arguments

-

Default

-

Get example

> get dm p
1

dms.telemetry.adc_mask

Abbreviation

dm t a

Access

get/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

• takes effect immediately

Gecko OS Kernel Plugin

• dms.telemetry

Get example

> get dms.telemetry.adc_mask
0x0

Set example

> set dm t a 0x1
Set OK

dms.telemetry.data_mask

Abbreviation

dm t d

Access

get/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:

Default

0x3FF

Properties

• takes effect immediately

Gecko OS Kernel Plugin

• dms.telemetry

Get example

> get dms.telemetry.data_mask
0x3FF

Set example

> set dm t a 0x211
Set OK

dms.telemetry.gpio_mask

Abbreviation

dm t g

Access

get/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

• takes effect immediately

Gecko OS Kernel Plugin

• dms.telemetry

Get example

> get dms.telemetry.gpio_mask
0x0

Set example

> set dm t g 0x31
Set OK

dms.telemetry.interval

Abbreviation

dm t i

Access

get/set

Description

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

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

Arguments

<seconds>

Default

0

Properties

• takes effect immediately

Gecko OS Kernel Plugin

• dms.telemetry

Get example

> get dm g i
0

Set example

> set dms.telemetry.interval 10
Set OK