Shell API

Shell uses a UART interface that can also work in binary mode. The binary mode is used to read API commands in TLV format. DWM starts by default in binary mode after reset. The shell mode can be switched to by pressing ENTER twice within 1 second. The binary mode can be switched to by executing the command “quit” in shell mode. The shell mode and the binary mode can be switched back and forth. Press Enter in shell mode to repeat the last command. The following text provides an overview of the shell commands.


The following table gives an overview of the availability of the shell commands on the ethernet gateway and the edge node.

Command

Description

DWM1001

Gateway

?

this help

YES

YES

help

this help

YES

YES

quit

quit

YES

YES

gc

GPIO clear

YES

YES

gg

GPIO get

YES

YES

gs

GPIO set

YES

YES

gt

GPIO toggle

YES

YES

f

Show free memory on the heap

YES

YES

reset

Reboot the system

YES

YES

si

System info

YES

YES

ut

Show device uptime

YES

YES

frst

Factory reset

YES

YES

twi

General purpose TWI read

YES

NO

aid

Read ACC device ID

YES

NO

av

Read ACC values

YES

NO

scs

Stationary config set

YES

NO

scg

Stationary config get

YES

NO

les

Show meas. and pos.

YES

NO

lec

Show meas. and pos. in CSV

YES

NO

lep

Show pos. in CSV

YES

NO

utpg

Get TxPwr

YES

NO

utps

Set TxPwr

YES

NO

nmg

Get node mode

YES

YES

nmp

Set UWB mode to passive

YES

NO

nmo

Set UWB mode to off

YES

YES

nma

Set mode to AN

YES

NO

nmi

Set mode to ANI

YES

NO

nmt

Set mode to TN

YES

NO

nmtl

Set mode to TN-LP

YES

NO

nmb

Set mode to BN

YES

YES

la

Show AN list

YES

NO

lb

Show BN list

YES

NO

nis

Set Network ID

YES

YES

nls

Set node label

YES

YES

udi

Show incoming IoT data

YES

NO

uui

Send IoT data

YES

NO

stg

Get stats

YES

YES

stc

Clear stats

YES

YES

tlv

Send TLV frame

YES

YES

aurs

Set upd rate

YES

NO

aurg

Get upd rate

YES

NO

apg

Get pos

YES

NO

aps

Set pos

YES

NO

acas

Set anchor config

YES

NO

acts

Set tag config

YES

NO

aks

Set encryption key

YES

NO

akc

Clear encryption key

YES

NO

ans

Set NVM usr data

YES

NO

anc (not found example)

Clear NVM usr data

YES

NO

ang

Get NVM usr data

YES

NO

amls

Set MAC addr list once

YES

NO

amlg

Get MAC addr list

YES

NO

ahs

Set HW version once

YES

NO

ana

Set MAC address

YES

NO

acs

Configure node

NO

YES

ums

Set default UART mode

NO

YES

nif

Print interfaces

NO

YES

ipv4

Set local IPv4

NO

YES

dns

Set DNS server IP address list

NO

YES