ZentriOS Commands

This page lists the ZentriOS Command API with a full description of how to use each command. ZentriOS Variables, which are used to configure ZentriOS, are accessed using the get and set commands.

Nav Tips for Humans

The ZentriOS Command API is friendly for humans too. Use the following tips and you'll be an expert ZentriOS terminal jockey in no time flat!

Tip	Description
Tab complete	Type part of a command or variable name then hit the tab key. The command completes or partially completes, just like a terminal in the linux or DOS world.
History	Up to 5 commands of history are available. Press the up-arrow key to access recently entered commands.
Edit	The left-arrow, home, end and backspace keys may be used to edit or navigate commands already present on the command line.

Shortcuts

A shortcut is assigned to each command. Common sense dictates the rules for shortcuts. Commands that are already short do not need a shortcut other than their name, shortcuts for longer commands sometimes take the first three letters of the command name, and other times take the first letter of the name plus several other letters contained in the name. Shortcuts are no longer than six characters and are easy to guess, the ultimate reference however is command help and the documentation on this page.

Documentation Format

Many of the ZentriOS responses shown in the examples on this page were captured with system.print_level = all, and system.cmd.header_enabled = true. These settings are provided to make it easy for a host microcontroller to parse responses by examining response headers. Information about machine parsing is available in Serial Interface, MCU Config.

Documentation for each command is provided in the format shown below.

command

Abbreviation

cmd

Description

A description of how to use the command with, together with notes about available options and arguments.

Syntax

Formal command syntax with a listing of all available options and arguments.

Example

One or more examples demonstrating how the command is used.

Commands by Group

File System and Flash
Faults and SafeMode
Network Management
GPIOs and Peripherals
Variable and Configuration Management
- get
- set
- load
- save
DMS and OTA
- dms
- ota
Serial Bus Mode
- exit
Streams
HTTP Files
- http_download
- http_upload
Ping
- ping
TCP
- tcp_client
- tcp_server
UART
- uart_update
UDP
- udp_client
Device System and Power Management

Description of Commands

dms

dms

Description

Perform activities with the DMS, including:

Claim current device, associating it with your DMS account
Activate a product with the current device.

This command requires the device to have access to the Internet, so network credentials wlan.ssid and wlan.passkey must be set. See Getting Started.

Syntax

Claim

dms claim <dms_username> <dms_password>

Claims the current device, associating it with your DMS account.

dms claim <product-code> <activation-token>

Claims the device using an activation token. See DMS Production Workflow, Use an Activation Token. This is a production manufacturing procedure, available for production products only.

Activate

dms activate <product code>

Activates the current device to the specified product.

Supported Platforms

Example

> dms claim my_dms_username my_dms_pw
Success

> dms activate MY_PRODUCTCODE
Success

exit

Abbreviation

exit

Description

Exits command mode immediately and returns to stream mode. Only valid when stream mode is operational.

Syntax

> exit

Supported Platforms

Example

> exit
Command Mode Stop

factory_reset

Abbreviation

fac

Description

Reset the application configuration to factory default values. The WLAN MAC address wlan.mac must be provided as an argument to avoid accidental factory reset.

Note: The application may also be factory reset by asserting GPIO0 for 10 seconds through a module reset as described in Update and Recovery, Factory Reset.

Syntax

> factory_reset <MAC address>

Properties

available in Safe Mode

Supported Platforms

Example

> get wl m
R000019
4C:55:CC:10:03:44
> fac 4C:55:CC:10:03:44
Success

faults_print

Abbreviation

faup

Description

List system faults. After 8 faults, the system enters Safe Mode. See Update and Recovery, Safe Mode.

Syntax

> faults_print

Properties

available in Safe Mode

Supported Platforms

Example

> faup
Success

faults_reset

Abbreviation

faur

Description

Reset system fault counter. See Update and Recovery, Safe Mode.

Syntax

> faults_reset

Properties

available in Safe Mode

Supported Platforms

Example

> faur
Success

file_create

Abbreviation

fcr

Description

Create a new file <size> bytes in length. After the command is issued, the ensuing <size> number of bytes is written to the file system.

Files can be written in chunks smaller than the specified length, using the -o option.

Additional options include a version, file type and CRC, or checksum.

See File System, Writing Files.

Syntax

> file_create [-[e][u]] [-o] <filename> <size> [<version> [<type> [<crc>]]]

Option	Description
`-e`	Optional flag, must be first argument if used. Specifies that the file is essential and must not be deleted during an OTA. Default: Off Specified together with `-u` flag (i.e. `-eu` for both. Flags can occur in any order). Note: Files are deleted during OTA only if space is required. OTA may fail if files marked essential leave insufficient space.
`-u`	Optional flag. Set HTTP Server unprotect flag for file. Default: Off Specified together with `-e` flag (i.e. `-eu` for both. Flags can occur in any order). See HTTP Server Security and Authorization.
`-o`	Optional. Leave file open for writing. Default: Off If the `-o` option is not specified, then all the file data must come immediately after the command. If the `-o` option is specified, the file can be written in chunks. A stream handle is returned after the command. The write command is used to write data to the file. The stream closes automatically after the specified `<size>` bytes of data is written. The file is not considered 'valid' until it automatically closes. If the module is rebooted or the close command is issued before all data is written, the file data is lost. It is not possible to restart writing the file after the stream is manually closed. See Networking and Security, Network Connections and Streams.
`filename`	Name of file to be written.
`size`	Length of file in bytes. After the command is issued, write the file content to the serial interface.
`version`	Specify version number. Default `1.0.0`
`type`	The file type, in hex format1. See File System, File Types Default: `FE` (`MISC_FIX_LEN`)
`crc`	optional, CRC16-CCITT checksum of the file data, in hex format1. See File System, Checksum

1: hex format: upper or lower case, with or without leading 0x, e.g. 0xFE, fe, 0xe1c8

Supported Platforms

Examples

Create a file with no special options

In the example below, the file content , Hello World! is 12 bytes in length and is entered or sent by the user.

> fcr myfile.txt 12
Hello World!
File created

Check result:

> ls -l
!  # Type  Flags  Hnd    Size       Version  Filename
...
#  6 e-FE   0021  104      12       1.0.0.0  myfile.txt

The associated file handle (Hnd) may vary.

Flags 0021: Valid User

Create an unprotected file that can be downloaded even when HTTP Server authorization in force

(see HTTP Server Security and Authorization)

> fcr -u myfile.txt 12
Hello World!
File created

Check result:

> ls -l
!  # Type  Flags  Hnd    Size       Version  Filename
...
#  6 e-FE   0121  104      12       1.0.0.0  myfile.txt

Flags 0121: Valid User Unprotected

Create an essential file that is not deleted during an OTA update

> fcr -e myfile.txt 12
Hello World!
File created

Check result:

> ls -l
!  # Type  Flags  Hnd    Size       Version  Filename
...
#  6 e-FE   0061  104      12       1.0.0.0  myfile.txt

Flags 0061: Valid User Essential

Create a file with specified version and user type

(See File System, File Types)

> fcr myfile.txt 12 1.1.0.1 AB
Hello World!
File created

Check result:

> ls -l
!  # Type  Flags  Hnd    Size       Version  Filename
...
#  6 e-AB   0021  104      12       1.1.0.1  myfile.txt

Create file for writing in chunks

> file_create -o my_file.txt 100
3
> write 3 50
... <50 bytes of data> ...
> write 3 50
... <50 bytes of data> ...
File created

Check result:

!  # Type  Flags  Hnd    Size       Version  Filename
...
#  6 e-FE   0021  107     100       1.0.0.0  my_file.txt

file_delete

Abbreviation

fde

Description

Delete a file from the file system.

Syntax

> file_delete <filename> | <memory>-<handle> where

<filename> is the name of the file
<memory>-<handle> can be used to distinguish between files with the same name:
- <memory> is the memory type, which may be one of the following:
  - i - internal memory
  - e - extended memory
  - b - bulk memory
- <handle> is the file handle on the memory. This appears under the Hnd column of the file listing

Note: <memory>-<handle> overrides <filename> - for example, if there exist both a file in extended flash with file handle 234, and a file named e-234, then the command file_delete e-234 deletes the file with memory-handle e-234, rather than the file named e-234.

Properties

available in Safe Mode

Supported Platforms

Example

> fde myfile.txt
L000014
File deleted
R000009
Success

Example

To delete the file with handle 234 on extended flash:

> file_delete e-234
L000014
File deleted
R000009
Success

file_open

Abbreviation

fop

Description

Open a file and return a file stream handle if successful. Once open, the file contents may be read with the stream_read command.

See Networking and Security, Network Connections and Streams.

Syntax

where:

<filename> is the name of the file
<memory>-<handle> can be used to distinguish between files with the same name:
- <memory> is the memory type, which may be one of the following:
  - i - internal memory
  - e - extended memory
  - b - bulk memory
- <handle> is the file handle on the memory. This appears under the Hnd column of the file listing

Note: <memory>-<handle> overrides <filename> - for example, if there exist both a file in extended flash with file handle 234, and a file named e-234, then the command file_open e-234 opens the file with memory-handle e-234, rather than the file named e-234.

Supported Platforms

Example

> fop myfile.txt
R000003
0

Example

To open the file with handle 234 on extended flash:

> file_open e-234
R000003
0

file_stat

Abbreviation

fst

Description

Display file statistics for the specified file.

Statistics are displayed in a comma separated list, in the order:

size,CRC,long version,storage type,file type,flags,handle

#	Stat	Comment	Reference
1	size	file size, displayed in decimal format
2	CRC	CRC is calculated from the unencrypted file data. Displayed in hex format, with no `0x` prefix.	File System, File Checksum
3	long version		File System, File Version
4	storage type	i - MCU internal flash e - extended flash b - bulk serial flash	File System, Flash Storage
5	file type		File System, File Types
6	flags		File System, File Flags
7	handle	Listed in the 'Hnd' column in ls -l output	A unique ID assigned to each file

The ls -v (verbose file listing) command displays all of these properties except the CRC.

Syntax

> file_stat <filename>/<memory type>-<handle> where:

<memory type> is the letter at the start of the Type column in the ls -l listing of a file:
- e:extended
- i:internal
- b:bulk.
  See File System, File Types.
<handle> is the file ID number listed in the Hnd column in the ls -l listing of a file.
The handle must be prefixed by the memory type followed by a dash, e.g e- for extended flash.

Supported Platforms

Example

> file_stat geotrust_ca.pem
1236,6E5A,3.0.0.11,e,3,1,8
> file_stat e-8
1236,6E5A,3.0.0.11,e,3,1,8

force_safemode

Abbreviation

force_safemode

Description

Force the module into safe mode. This command is used by a host to test recovery procedures if the module enters safe mode. See Application Notes, Recovery from Safe Mode for further information.

This is a hidden command that does not appear in the list of commands returned by help commands.

Syntax

> force_safemode <module MAC address>

Supported Platforms

Example

> force_safemode 4C:55:CC:10:10:98
Forcing safemode...
Rebooting
[Disassociated]
ZentriOS-2.1.0.9, Built:2015-01-25 15:58:14 for AMW004.3, Board:AMW004-E03.3

*** Max faults exceeded. Entering Safe Mode.
SAFEMODE>

format_flash

Abbreviation

format

Description

Format (i.e. erase all contents) of bulk or extended flash chip. If the extended flash is specified, ALL files BUT the wifi_fw.bin file are erased.

For details on enabling and using bulk flash, see File System, Flash Storage.

Syntax

> format_flash <bulk/extended> <module MAC address>

Properties

available in Safe Mode

Supported Platforms

Example

> format bulk 4C:55:CC:10:10:98
Formatting flash...

get

Abbreviation

get

Description

Get the value of a ZentriOS variable or group of variables.

Syntax

> get <[variable name] / [variable group]> [options]

Properties

available in Safe Mode

Supported Platforms

Example 1

> get time.rtc utc
R000029
2014-03-23T23:54:33.021464Z

Example 2

> get bus
R000166
bus.data_bus: uart0
bus.log_bus: uart0
bus.mode: command
bus.stream.cmd_gpio: 0
bus.stream.cmd_seq: $$$
bus.stream.flush_count: 1500
bus.stream.flush_time: 20

gpio_dir

Abbreviation

gdi

Description

Set the direction of a general purpose I/O pin. To deregister the GPIO, set the direction to either -1 or none.

Note : This is a run-time only setting: the value is not saved with the save command. To set the direction of a GPIO after a reboot, set the variable gpio_init. See Peripherals, Setting GPIO Function.

Syntax

> gpio_dir <GPIO#> <direction name/enum> [0/1]

where:

<GPIO#> is the number of the GPIO. See Peripherals and GPIOs for your platform.
<direction name/enum> - see table below
<0/1> - initial value of the GPIO. The value is set before the direction is changed, to prevent glitches on the GPIO line.

For each I/O type there is a name and ab enum values. The <direction name/enum> argument can specify either a name or an enum value:

I/O Type Description	Direction Name	Enum Value
Input, pull-up	ipu	0
Input, pull-down	ipd	1
Input, high-impedance	in	2
Output, push-pull	out	3
Output, open-drain no-pull	ood	4
Output, open-drain pull-up	oodpu	5
Deregister the GPIO	none	-1

Supported Platforms

Example

> gdi 12 in
R000008
Set OK

gpio_get

Abbreviation

gge

Description

Get the current value of a general purpose I/O pin.

Syntax

> gpio_get <GPIO#>

Supported Platforms

Example

> gge 12
R000003
0

gpio_set

Abbreviation

gse

Description

Immediately set the value of a general purpose I/O pin. When setting a GPIO, the GPIO direction must be also correctly set using the command gpio_dir or the command will fail.

Syntax

> gpio_set <GPIO#> <value>

Supported Platforms

Example

> gse 12 1
L000032
GPIO not configured for output
R100016
Command failed

gpios_get

Abbreviation

gges

Description

Get the current value of all general purpose I/O pins.

The value of standard GPIOs is returned as either 0 or 1. Other GPIO types not configured for GPIO access (such as UART pins or system indicators) are returned as X. GPIO values are in GPIO number order, increasing from left to right, with value for GPIO0 at left.

Syntax

> gpios_get

Supported Platforms

Example

> gpios_get
R000031
0XX00X0000000XX10XXX000000000

help

Abbreviation

help, ?

Description

Return a list of commands or variables; or return help for a specific command or variable.

Syntax

> help [all/commands/variables/<command>/<variable>]

Supported Platforms

Example

> help
Usage   : help [all/commands/variables/<command>/<variable>]
Shortcut: help
Brief   : Return a list of commands or variables; or return
          help for a specific command, variable or group of
          variables.

http_download

Abbreviation

hdo

Description

Download one or more files from a remote HTTP server and save to the extended or bulk flash.

Timeout is determined by tcp.client.connect_timeout.

Note: The remote HTTP server must return the Content-length header in the HTTP response. The file system must have the size of the file before creating it.

Syntax

Download a Single File

> http_download [-i <wlan/softap>] [-m <json_size>] [-d] [-[e][u][s][y]] [-c <CRC>] <url>
  [<flash_file_name> [<version> [<type> [<cert_filename>  ] ] ] ]

where parameters are as follows:

Option	Description

`-i`	Optional - Specify interface, MUST come first. If omitted uses network.default_interface.
`-m <json_size>`	Optional - Download multiple files with a json specification of size `<json_size>`. MUST come first if `-i` option not used. No other parameters are valid with `-m` option. See Downloading Multiple Files below for more information.
`-d`	Don't delete duplicate files. By default all duplicate file names are overwritten; with this option the command will fail on duplicates.
`-e`	Optional flag - Indicates file is essential. Specified together with `-u` flag (i.e. `-eu` for both. Flags can appear in any order).
`-u`	Optional flag - Set HTTP Server unprotected flag for file. Specified together with `-e` flag (i.e. `-eu` for both. Flags can appear in any order). See HTTP Server Security and Authorization.
`-c <CRC>`	Optional, CRC for file, in hex format*. On download, the file CRC is calculated and compared against this value. The file is not set 'valid' unless the CRCs match. See File System, File Checksum.
`<url>`	Full path to a file on a http server. See below for more info about URL.
`<flash_file_name>`	Optional - name to save file as. Use url filename if omitted
`<version>`	Optional - default 1.0.0 if omitted, set to `0` to use default
`<type>`	Optional - the type of file, default: miscellaneous text file, `0xFE`. See File System, File Types
`<cert_filename>`	Optional - TLS certificate filename

hex format: upper or lower case, with or without leading 0x, e.g. 0xFE, fe, 0xe1c8

Downloading Multiple Files > http_download -m <json_size>

Immediately after issuing this command, send <json size> bytes of a JSON formatted manifest file. An example of the manifest file is as follows:

{
   "path"  : "https://myserver.com/path/to/my/files/",
   "cert"  : "mycert.pem",
   "files" : [
                {
                    "remote"  : "name_of_remote_file.html",
                    "local"   : "name_of_flash_file.html",
                    "version" : "1.0.0",
                    "type"    : 150,
                    "flags"   : "eu",
                    "crc"     : 23423
                },
                { ... }
              ]
}

Notes:

Only the "remote" parameter is mandatory. The other parameters are optional.
In the manifest, the file type and crc are expressed in decimal, not hex, unlike in the -c parameter.
The file type 150 (hex 0x96) is a custom user type.

String Replacement

ZentriOS allows string replacement in the URL of the file for download, using a C-like or pythonesque syntax.

If the url contains %s, then the supplied filename is substituted for %s.

Example: hdo 192.168.1.110:50007?id=%s&action=download my_file.txt generates the URL: http://192.168.1.110:50007?id=my_file.txt&action=download and creates the file: my_file.txt in the module file system.

String replacement is also available in the manifest. For example:

{
   "path" : "http://myserver.com?file=%s&user=name&pass=1234",
   "cert" : "mycert.pem",
   "files" : [
                {
                    "remote" : "my_file1.txt",
                },
                {
                    "remote" : "my_file2.txt",
                },
              ]
}

generates the following URLs for download:

http://myserver.com?file=my_file1.txt&user=name&pass=1234
http://myserver.com?file=my_file2.txt&user=name&pass=1234

Supported Platforms

Example

Save page at example.com to file test.html:

> hdo http://example.com test.html
Downloading: test.html to flash file system
Request GET /
Connecting (http): example.com:80
HTTP response: 200
Success
> ls -v
!  # Type  Flags  Hnd    Size    Version  Filename
...
#  8 e-FE   0021  108    1270       1.0.0.0  test.html
...

http_upload

Abbreviation

hup

Description

Upload file(s) from the device flash to a remote HTTP server using HTTP POST and file upload.

Timeout is determined by tcp.client.connect_timeout.

See the http_upload application note.

Syntax

Upload a Single File

> http_upload [-i <softap/wlan>] <url>  <local filename>
  [<remote filename> [<content type>]]

where:

-i - optional, specify interface, value 'wlan' or 'softap' MUST come first. If omitted uses network.default_interface.
<url> - URL of remote HTTP server
<local filename> - name of file on sflash to upload
<remote filename> - optional, name of file on remote server, use local filename if omitted.
<content type> - optional, HTTP header content-type, e.g. image/jpeg

Upload Multiple Files using JSON Manifest > http_upload [-i <softap/wlan>] -m <json size> where:

-i - optional, specify interface, value 'wlan' or 'softap' MUST come first
-m - use JSON manifest for multi-file upload. MUST come first if -i option not used

The manifest must be input directly after the command is issued. Manifest format:

{
  "path" : "https://myserver.com/path/to/save/files",
  "cert" : "mycert.pem",
  "files" : [ {
    "local"  : "my_file_to_load.txt",
    "remote" : "file_name_on_server.txt",
    "name"   : "file",
    "type"   : "application/octet-stream",
    },
    { ... }
  ]
}

The manifest cannot contain javascript style commments.

If provided, the cert must be the name of an existing file in the device sflash.

The following optional properties are given the specified default values only if the properties are completely omitted from the manifest. Leaving them blank results in blank values, not default values.

Property	Description	Default
`remote`	Name of file on remote system	`local` value - the name of the file on the module file system.
`name`	Appears in the form-data "name" field	`"file"`
`type`	Mime-type of file content	`"application/octet-stream"`

For examples, see the http_upload application note.

Supported Platforms

Example

> hup http://myserver.com/uploadpage ghm_capabilities.json testfile.json
Uploading: ghm_capabilities.json to server
Request POST /uploadpage
Connecting (http): myserver.com:80
HTTP response: 200
Success

The file is saved on the upload server at myserver.com:80 as testfile.json

ls

Abbreviation

Description

Return a list of available files located in internal, extended and bulk flash.

Use the -v (or equivalent -l) option for full details.

The -m, -b and -c support paging and limiting the output, for use when there are many files.

Syntax

> ls [-v/-l] [-m <i|e|b>] [-b <base sector>] [-c <max file count>] where:

-m the memory type to search. This is a concatenation of one or more of the following types:
- i - internal
- e - extended
- b - bulk
-b the lowest number file handle (Hnd) at which to begin searching for files on the given memories.
-c the max file count to return

Properties

available in Safe Mode

Supported Platforms

Example

Long listing, showing Type, Flags, and Handles (Hnd)

> ls -l
!  # Type  Flags  Hnd    Size       Version  Filename
#  0 e-FE   0041   54    7590       3.3.2.6  .recovery.html
#  1 e-FB   0001   85   44560       3.0.0.6  command_help.csv
#  2 e-FD   0001   62     135       3.0.0.6  default_setup.script
#  3 e-FE   0001   96    5430       3.3.2.6  favicon.ico.gz
#  4 e-03   0001   63    1216       3.0.0.6  geotrust_ca.pem
#  5 i-00   001B  170  327424       3.3.2.6  sys/kernel.bin
#  6 e-84   0005   52     820       3.2.0.0  sys/safemode.bin
#  7 i-81   001B    0  166096       3.3.2.6  sys/services.bin
#  8 e-01   0001    0  210412   5.26.230.12  sys/wifi_fw.bin
#  9 e-FE   0021   97     684       1.0.0.0  test1.html
# 10 e-FE   0001   53    1995       3.3.2.6  webapp/index.html
# 11 e-FE   0001   64    9530       3.3.2.6  webapp/unauthorized.html
# 12 e-FE   0001   56   22720       3.3.2.6  webapp/zentrios.css.gz
# 13 e-FE   0001   67   72947       3.3.2.6  webapp/zentrios.js.gz

Example

Listing showing extended memory files only, starting at file handle 56, count limited to 5 files:

> ls -l -m e -b 56 -c 5
!  # Type  Flags  Hnd    Size       Version  Filename
#  0 e-FE   0001   56   22720       3.3.2.6  webapp/zentrios.css.gz
#  1 e-FD   0001   62     135       3.0.0.6  default_setup.script
#  2 e-03   0001   63    1216       3.0.0.6  geotrust_ca.pem
#  3 e-FE   0001   64    9530       3.3.2.6  webapp/unauthorized.html
#  4 e-FE   0001   67   72947       3.3.2.6  webapp/zentrios.js.gz
>

load

Abbreviation

load

Description

Load a configuration from a file previously saved by the save command.

Syntax

> load <config_file>

Supported Platforms

Example

> load config1.cfg
> Configuration successfully loaded

network_down

Abbreviation

ndo

Description

Bring down a network interface. If provided, the network interface overrides the default specified by the variable network.default_interface. All open streams on the interface will be closed.

Syntax

> network_down [-i <wlan/softap>]

Supported Platforms

Example

> ndo
L000040
[2014-03-24 | 00:08:48: Disassociated]
R000009
Success

network_lookup

Abbreviation

nlo

Description

Perform a DNS lookup for a domain using the specified interface.

Syntax

> network_lookup [-i <wlan/eth/default>] <domain>

where:

-i: optionally specify the network interface:
- wlan: WLAN
- eth: Ethernet (available only on Ethernet capable devices)

Supported Platforms

Example

> nlo google.com
R000016
216.58.220.142

network_restart

Abbreviation

nre

Description

Restart the network. This command is equivalent to issuing the network_down command followed by the network_up command.

Note: This command is blocking. It does not return until the network has been brought up (or has failed to be brought up).

Syntax

> network_restart [-i <softap/wlan>]

where the -i option specifies the network interface to be restarted.

Supported Platforms

Example

The response shown is an example. Response varies depending on the network settings, time and date and other factors.

> nre
[2015-03-23 | 03:02:53: Disassociated]
[2015-03-23 | 03:02:53: Associating to Zentri]
Obtaining IPv4 address via DHCP
IPv4 address: 10.5.6.55
[2015-03-23 | 03:02:54: Associated]
Success

network_up

Abbreviation

nup

Description

Start the process to bring up a network interface.

The -s option prompts the user to select from a list of available APs and supply a passkey. If the -s option is used, ZentriOS automatically saves the credentials entered.

The -i option overrides the default network interface specified by network.default_interface.

NOTE! Every command that needs access to the network will automatically bring up the network interface. The network_up command is non-blocking (except when the -s option is used) and provided for convenience only.

Syntax

> network_up [<-s> / <-i [wlan]/[softap]>]

Supported Platforms

Example

> network_up -s
Scanning for networks...
! 3 networks found
!  # Ch RSSI MAC (BSSID)       Network (SSID)
#  0  6  -27 84:1B:5E:29:9D:F7 Take the blue pill
#  1 11  -68 EC:1A:59:36:5B:6C button_xt
#  2 11  -70 2C:B0:5D:31:6F:6A button

Type the number # that matches your Network: 0
Type the password for your Network         : welcome-to-kansas
[Associating to Take the blue pill]
In progress
[Associated]

ota

Abbreviation

ota

Description

Initiate a secure over-the-air update. The secure OTA protocol uses industry standard TLS/HTTPS security with both client-side and server-side certificate verification.

As an additional measure of security, the server authenticates each device using the universally unique system.uuid embedded inside the hardware of each device.

Downloaded bundle files overwrite local files only if the bundle file has a later version. To ensure that bundle files overwrite local files regardless of version, force an update with the -f option.

Download a specific firmware bundle version with the -b option. Specifying a bundle forces an update. Bundle files overwrite local files regardless of version.

To activate a module to receive custom firmware and files, use the -a option along with your activation code and password. All modules are activated and licensed for standard ZentriOS firmware, so when updating to standard firmware no activation code is required.

If you have firmware customised by Zentri for your application, or you would like Zentri to manage your host firmware or host application files on our secure servers, please contact Zentri to receive an activation code and password.

To maintain a saved configuration through an OTA update, save the configuration as default_config.csv. See save.

Syntax

> ota [-f] [-b <full version>]

-f : force update. Bundle files overwrite local files, regardless of version.
-b : download a specified bundle, for example a previous version. For a ZentriOS bundle, specify only the full version number, e.g. ota -b 3.1.0.8. For full versions of ZentriOS by platform, see Edition Platform Support, Edition Versions by Platform or see DMS Products. For full versions of custom product bundles, refer to the DMS Products list for that product.
- Note: the -b option is available only when you are updating a development product. From the moment you load a production product on your device, the device can ota only to the most recent release of the product, corresponding to the device's product release type (alpha, beta or release). See:
  - DMS Production Workflow, A Production Product Cannot be Activated to Another Product
  - DMS GUI, Tagging Bundle Release Type

Properties

available in Safe Mode

Supported Platforms

Example

> ota
Connecting to network
Request POST /ota/05b300df003134534e394b8330393232323a3533/0
Connecting (HTTP): ota.zentri.com:443
Starting TLS
HTTP response: 200
Downloading new firmware...
Bundle version: ZentriOS-1.0.0.1, Built:2015-11-11 02:23:15 for AMW004.3
Downloading: command_help.csv-1.0.0.1 (25822, 0xFB, 0x1)
Downloading: default_setup.script-1.0.0.1 (189, 0xFD, 0x9)
Downloading: /setup/index.html-1.0.0.1 (9266, 0xFE, 0x1)
Downloading: /setup/images.png-1.0.0.1 (18067, 0xFE, 0x1)
Downloading: /sys/kernel.bin-1.0.0.1 (352804, 0x0, 0x801F)
Downloading: wifi_fw.bin-1.0.0.1 (191677, 0x1, 0x8009)
Downloading: /sys/services.bin-1.0.0.1 (83848, 0x80, 0x801F)
Downloading: geotrust_ca.pem-1.0.0.1 (1162, 0x3, 0x9)
Downloading: /favicon.ico.gz-1.0.0.1 (1853, 0xFE, 0x1)
Downloading: /setup/index.css.gz-1.0.0.1 (10539, 0xFE, 0x1)
Downloading: /setup/index.js.gz-1.0.0.1 (38771, 0xFE, 0x1)
Updating kernel to version: 1.0.0.1
Updating firmware files...
Updating file: wifi_fw.bin to version: 1.0.0.1
Updating file: /sys/services.bin to version: 1.0.0.1
Found new bootable app: /sys/services.bin (47), booting to it now!
OTA completed successfully
[Ready]

ping

Abbreviation

ping

Description

Send one or more ICMP pings to an IP address or the network gateway using the -g option. If provided, the network interface overrides the default specified by the variable network.default_interface. Options must be provided in the order shown.

Syntax

> ping [-i <wlan/softap>] <[IP address]/[-g]> [# retries]

Supported Platforms

Example

> ping example.com 3
R000021
Ping reply in 183ms
R000021
Ping reply in 178ms
R000021
Ping reply in 177ms

reboot

Abbreviation

reboot

Description

Reboot the application.

Note: the response displayed on reboot depends on the system.cmd.mode setting.

In human command mode, the response is similar to:

Rebooting
[2015-08-05 | 00:38:19: Disassociated]
ZentriOS-2.3.1.2, Built:2015-07-21 09:16:43 for AMW004.3, Board:AMW004-E03.3
[Ready]

There may be other messages depending on system settings.

In machine command mode, the response to the reboot command, followed by the reboot and a CR-LF sequence, is similar to:

R000079
ZentriOS-2.3.1.2, Built:2015-07-21 09:16:43 for AMW004.3, Board:AMW004-E03.3

Syntax

> reboot

Properties

available in Safe Mode

Supported Platforms

Example

> reboot
Rebooting
[2015-08-05 | 00:38:19: Disassociated]
ZentriOS-2.3.1.2, Built:2015-07-21 09:16:43 for AMW004.3, Board:AMW004-E03.3
[Ready]

save

Abbreviation

save

Description

Save all ZentriOS variables to non-volatile flash memory.

If a file name is supplied, the saved configuration can be restored with the load command.

Save as default_config.csv to create a default settings file. If a file of this name is found, ZentriOS loads the configuration in default_config.csv after a successful OTA or if the factory reset GPIO is asserted for more than 5 seconds but less than 10 seconds. See Update and Recovery, Factory Reset.

Note: During the save operation, interrupts are disabled. In particular, the UART rx interrupt may not be serviced during save. To ensure the save operation is completed, wait for the save command response before issuing further commands via the UART.

Syntax

> save [<config_file>]

where parameters are as follows:

Option	Description
`<config_file>`	Optional. Name of the configuration file to be saved

Properties

available in Safe Mode

Supported Platforms

Example

> save
L000007
Saved
R000009
Success

Example 2

save config1.cfg
R000009
Success
ls
!  #   Size   Version  Filename
...
#  5   3868     1.0.0  config1.cfg
...

set

Abbreviation

set

Description

Set the value of a ZentriOS variable.

Syntax

> set <variable> <args>

Note: The set command displays the Too many args error only if the number of space-separated arguments exceeds the maximum for all variables (5). However the number of arguments for the set command depends on the variable being set, and the form in which the variable is specified: abbreviations for variables vary from one to three arguments in length, and variable settings may require one or two arguments. If you specify too many arguments when setting a specific variable, surplus arguments are ignored. Refer to the variable documentation for the number of arguments for a specific variable.

Properties

available in Safe Mode

Supported Platforms

Example

> set wlan.ssid "My Home Network"
R000008
Set OK

setup

Abbreviation

setup

Description

The setup command simplifies the process of connecting a ZentriOS device to a Wi-Fi network.

It can be run automatically on boot or in response to asserting a GPIO. It also allows for setup from the ZentriOS terminal.

The setup command allows for setting up network credentials via a web browser. See Configuration and Setup, Setup with a Web Browser.

Syntax

> setup <web/status/stop>

Option	Description
`web`	When called with the `web` option, setup starts a Wi-Fi Access Point and a web server, the Wi-Fi AP credentials are configured using the variables `setup.web.ssid` and `setup.web.passkey`. Once connected to the ZentriOS Setup AP, a Wi-Fi client uses a web browser to setup ZentriOS variables and connect to your local Wi-Fi network. Web setup is non-blocking. The root of the web app is configured with the setup.web.root_filename variable.
`status`	The `status` option allows an MCU host to determine whether setup is in-progress. Response is `1` if setup is in progress, otherwise `0`.
`stop`	The `stop` option terminates any in-progress setup activity.

Supported Platforms

Example

Setup via Soft AP and Web App

> setup web
In progress
Rebooting
ZENTRI-AMW007-1.0.0.4, 2016-08-18T05:32:24Z, ZentriOS-WL-1.0.0.4, Board:AMW007-E03.2

While In progress is displayed, connect a computer or mobile device to Soft AP, enter password (default password), in web browser go to web setup DNS (default setup.com), choose network from scan list and enter network password. See

sleep

Abbreviation

sleep

Description

Put the application into a low-power sleep state. The application sleeps until the wakeup timeout (system.wakeup.timeout) expires.

Syntax

> sleep

Supported Platforms

Example

> set system.wakeup.events uart0|gpio5
Set OK
> set system.wakeup.timeout 10
Set OK
> sleep

... wait 10 seconds ...

ZentriOS-1.1.1.0, Built:2014-04-02 02:23:15 for AMW004.3, Board:AMW004.3-E03.1

stream_close

Abbreviation

close

Description

Close an open network or file stream specified by [handle], or alternatively close all open streams.

See Networking and Security, Network Connections and Streams.

Syntax

> stream_close <[handle]/[all]>

Supported Platforms

Example

> close all
[2014-04-02 | 13:32:04: Disconnected: 0]
[2014-04-02 | 13:32:04: Disconnected: 1]
Success

stream_list

Abbreviation

list

Description

Return a list of open streams.

See Networking and Security, Network Connections and Streams.

Syntax

> stream_list

Supported Platforms

Example

> list
!# Type  Info
#0 TCPC  google.com:80 (32288)
#1 HTTP  example.com:80 (37289)

stream_poll

Abbreviation

poll

Description

Poll a stream to check if data is available. Returns 0 if open with no data to read, 1 if data is available and 2 if the stream has been closed remotely. Use the all option to return the status of all open streams. To avoid polling, use a GPIO (may be assigned when the stream is opened) as an interrupt line to the host.

Determine the number of RX or TX bytes that can be buffered with the -r or -t arguments.

Syntax

> stream_poll [all] <handle> [[-r][t]] where:

-c - Deprecated - response includes number of Rx bytes available. Use -r instead.
-r - response includes number of Rx bytes available: the number of bytes that can be immediately returned by the read command
-t - response includes number of Tx bytes available: the number of bytes that can be immediately written with the write command

If -r and/or -t argument is included in the command, the response format is as follows:

Poll specific connection

> poll 0 -r
<status>,<Rx bytes available>

> poll 0 -t
<status>,<Tx bytes available>

> poll 0 -rt
<status>,<Rx bytes available>,<Tx bytes available>

Poll all connections

> poll all -r
<handle>,<status>,<Rx bytes available>|<handle>,<status>,<Rx bytes available>|...

> poll all -t
<handle>,<status>,<Tx bytes available>|<handle>,<status>,<Tx bytes available>|...

> poll all -rt
<handle>,<status>,<Rx bytes available>,<Tx bytes available>|<handle>,<status>,<Rx bytes available>,<Tx bytes available>|...

where:

<handle> - stream handle
<status> -
- 0 - no data available
- 1 - data available
- 2 - remote closed connection
<bytes available> - the total number of bytes that can be buffered

Supported Platforms

Example

> poll 0
1
> read 0 100
hello!
> poll 0
0
> poll all
0,0|2,1|3,1

stream_read

Abbreviation

read

Description

Read up to <size> bytes from a network or file stream. Returns data immediately (if available), does not wait to receive data. For network streams, ZentriOS may buffer up to seven packets with each packet containing up to 1460 (MTU) data bytes. To avoid receiving data fragmented across packets, <size> should be set to 1460 bytes. To check for data, use the stream_poll command or the GPIO (assigned when the stream was opened) as an interrupt line to the host. For file streams, the file is automatically closed if the end of file is reached.

The number of bytes returned in the response to the stream_read command is determined as follows:

bytes_returned = MIN(Max packet size, <size arg>, poll -r)

i.e. the number of bytes returned is the minimum of:

Max packet size = 1460
<size> = number of bytes requested in the <size> argument of the stream_read command
poll -r = number of RX bytes currently buffered (i.e. the output of the stream_poll -r command)

See Networking and Security, Network Connections and Streams.

Syntax

> stream_read <handle> <size>

where

<handle> is the stream handle number returned by the command that opened the stream
<size> is the bytes to read. See above for how to determine the actual bytes returned

Supported Platforms

Example

> read 0 200
R000202
<!doctype html><html itemscope="" itemtype="http://schema.org/WebPage"
 lang="en-AU"><head><meta content="/images/google_favicon_128.png"
itemprop="image"><title>Google</title><script>(function(){
wind

stream_write

Abbreviation

write

Description

Write data to a network or file stream. As described in Serial Interface, Command Protocol, the command must be terminated by \r\n.

If no option is specified, ZentriOS waits for <size> number of data bytes then immediately sends the data to the stream before returning a response.

If the -f (flush) option is specified, then the written data is buffered to the maximum packet size before being automatically flushed to the remote side. The -f option can be used for the following stream types:

TCP client/server
TLS client/server
Websocket client/server

For TCP and TLS streams, the maximum packet size is an MTU (1460 bytes).

For WebSocket client/server streams, data is not locally buffered, however 'continuation' frames are used. When the -f option is specified, each written data chunk is sent as a continuation frame. If -f is not specified, then the 'final frame' flag is set.

For WebSocket client/server streams, you can use the -p option to send a WebSocket ping frame as a keepalive.

See Networking and Security, Network Connections and Streams.

Syntax

> stream_write <handle> <size> [-p] [-f] where:

<handle> : previously opened stream handle
<size> : the size of the data to be written to the stream
-p : optional. Issue WebSocket ping frame - available only for WebSocket client/server stream handles. In the case of a WebSocket ping frame sent, <size> is limited to a maximum of 1024.
-f : optional. Buffer to maximum packet size before flushing, as described above.

Supported Platforms

Example

> write 3 10
Success

tcp_client

Abbreviation

tcpc

Description

Open a TCP stream to a remote server at the specified network location.

Timeout is determined by tcp.client.connect_timeout.

See Networking and Security, Network Connections and Streams.

Syntax

> tcp_client [-i <wlan/softap>] [-l <local port>] <host> <port>

where:

-i - specify interface. MUST come first. If omitted uses network.default_interface.
-l - optionally specify <local port>. If not specified local port is random unused port
host - specify the remote host. If value is 0, or host omitted, use the host value in tcp.client.remote_host.
port - specify the remote port. If value is 0, or port omitted, use the port value in tcp.client.remote_port.

Options must be provided in the order shown.

Supported Platforms

Example

> tcpc google.com 80
L000028
Resolving host: google.com
L000052
[2014-03-24 | 01:07:12: Connecting: google.com:80]
L000036
Connecting (TCP): 74.125.237.96:80
L000039
[2014-03-24 | 01:07:12: Connected: 0]
R000003
0

tcp_server

Abbreviation

tcps

Description

Start/stop a TCP server specified by the variables tcp.server.*. If provided, the network interface and port override defaults specified by the variables network.default_interface and tcp.server.port respectively.

Syntax

> tcp_server [-i <wlan/softap>] <start/stop> [port]

where:

-i - specify interface. MUST come first. If omitted uses network.default_interface.
start/stop
- start - start the server
- stop - stop the server
port: (optional) Specify port. If value is 0, or port omitted, use the port value in tcp.server.port.

Options must be provided in the order shown.

See Networking and Security, Network Connections and Streams.

Supported Platforms

Example

> tcps start
L000036
TCP server listening on port: 3000
R000009
Success

uart_update

Abbreviation

uartu

Description

Update the UART to the current UART variable settings without rebooting the device.

For this command to have an effect, the values of one or more of the uart variables must first be changed:

Syntax

> uart_update <uart#>

Supported Platforms

Example

> uart_update 0
Success

udp_client

Abbreviation

udpc

Description

Open a UDP stream to a remote server at the network location <host>:<port>. If provided, the network interface overrides the default specified by the variable network.default_interface.

The [local port] may also be provided if desired. Options must be provided in the order shown.

See Networking and Security, Network Connections and Streams.

Syntax

> udp_client [-i wlan/softap] <host> <remote port> [local port]

Supported Platforms

Example

> udpc 192.168.45.67 3000
L000057
[2014-03-24 | 01:16:40: Connecting: 192.168.45.67:3000]
L000031
Resolving host: 192.168.45.67
L000032
Connecting: 192.168.45.67:3000
L000039
[2014-03-24 | 01:16:40: Connected: 2]
R000003
2

version

Abbreviation

ver

Description

Returns the ZentriOS firmware bundle version. This is a convenience command that is equivalent to reading the system.version variable.

Syntax

version

Properties

available in Safe Mode

Supported Platforms

Example

> ver
R000069
ZentriOS-W-3.0.0.0, Built:Dec 09 2015 for AMW004.3-E03.1

wlan_get_rssi

Abbreviation

rssi

Description

Get the received signal level (RSSI, in dBm) of the Access Point the wlan interface is connected to. The value is averaged to improve accuracy by setting the variable wlan.rssi_average.

Syntax

> wlan_get_rssi

Supported Platforms

Example

> rssi
R000005
-47

wlan_scan

Abbreviation

scan

Description

Initiate a Wi-Fi scan and return results; optionally specify a channel and AP SSID to scan for. For verbose scans, -v must be the first argument. Information returned by scan results is described in the following table.

Name	Description
Ch	The WLAN radio channel the AP is operating on
RSSI	Signal strength of the AP in units of dBm
BSSID	MAC address of the AP
Rate	The maximum data rate supported by the AP in kilobits/s
	e.g. 54000 = 54Mbit/s
Security	Security type used by the AP e.g. Open, WPA2-AES, etc.
Mode	AP mode. Inf = Infrastructure, Ad = Ad-hoc
Len	Number of characters in the SSID
SSID	AP name. APs with a hidden SSID are displayed as

Verbose scans return all columns of data. Non-verbose scans return only columns:# Ch RSSI MAC (BSSID) Network (SSID)

Syntax

> wlan_scan [-v] [<channel-spec> [ssid]] where:

-v: verbose scan - must be first argument
<channel-spec> - can be one of the following:
- channel list: a comma-separated list of channels, e.g. scan 1,5,6
- channel mask: a hex bitmask of channels. Must be preceded by 0x, e.g. scan -v 0x143
- all: all channels, e.g. scan -v all

Supported Platforms

Example

> scan -v
R000196
! 2 found
! # Ch RSSI BSSID              Rate Security Mode Len SSID
# 0 01  -24 EC:1A:59:36:5B:6C 144.4 Open      Inf  13 Ch1_Nearby_AP
# 1 06  -85 84:1B:5E:29:9D:F7 450.0 WPA2-AES   Ad  14 Ch6_Distant_AP