ZentriOS Commands

This page lists the ZentriOS Command API with a full description of how to use each command.

There are several interfaces for issuing commands. See Serial Interface, Issuing Commands and Streaming Data. For command format, see Serial Interface, Command Protocol.

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!

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
  • file_create
  • file_delete
  • file_open
  • file_stat
  • format_flash
  • ls
• Faults and SafeMode
  • faults_print
  • faults_reset
  • force_safemode
• Network Management
  • network_down
  • network_lookup
  • network_flush
  • network_restart
  • network_up
  • network_verify
  • setup
  • softap_get_rssi
  • wlan_get_rssi
  • wlan_scan
  • wps
• GPIOs and Peripherals
  • adc_take_sample
  • dac_set_level
  • gpio_dir
  • gpio_get
  • gpio_set
  • gpios_dir
  • gpios_get
  • gpios_set
  • pwm_update
• Variable and Configuration Management
  • get
  • set
  • load
  • save
• Discovery
  • mdns_discover
• DMS and OTA
  • dms
  • ota
• I2C
  • i2c_master_config
  • i2c_master_open
• SPI
  • spi_master_config
  • spi_master_open
• Serial Bus Mode
  • exit
• Streams
  • read
  • stream_close
  • stream_list
  • stream_poll
  • stream_read
  • stream_write
  • write
• HTTP Methods
  • http_add_header
  • http_get
  • http_head
  • http_post
  • http_read_status
• HTTP Files
  • http_download
  • http_upload
• Ping
  • ping
• SMTP
  • smtp_send
• TCP
  • tcp_client
  • tcp_server
  • tls_client
  • tls_server
• UART
  • uart_update
• UDP
  • udp_client
  • udp_server
• WebSocket
  • websocket_client
• Device System and Power Management
  • factory_reset
  • ?
  • help
  • reboot
  • sleep
  • version

Description of Commands

adc_take_sample

Abbreviation

adc

Description

Take an analog sample of a pin using an onboard Analog-Digital Converter.

To set the ADC reference voltage, see system.adc.vref.

Syntax

> adc_take_sample <gpio#> [<gain>] [-v]|[-l]/[<LUT Filename.csv>]

• <gain> - optional, defaults to 1 if not specified. The valid values for the adc gain are 1, 2, 4.
• <-v> - optional, return ADC value as a voltage in mV. Do NOT use with the LUT parameter, as subsequent arguments are ignored.
• <-l> - (lower-case L) optional, return ADC value from cached LUT. Requires a prior read of the LUT from file.
• <LUT Filename.csv> - optional, filename of Lookup Table (LUT) to use for converting ADC values. See Peripherals, ADC Lookup Tables for details. Note that if using <LUT Filename.csv> argument:
  • the <gain> argument is required to establish the argument position
  • no options should be used.

Note:

• The ADC LUT is cached on first use. To read and cache a different LUT from file, a reboot is required.
• Thermistors may vary. For precise temperature readings, create a LUT calibrated for your thermistor. See Temperature versus ADC value for a sample LUT.

The ADC value can be read in three formats:

• to read a numeric hex value, use no option.
• to read in mV, use the -v option.
• to use the LUT from cache, use the -l option. Requires a prior read of LUT from file, as described above.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> adc 1 1
R000007
0x805
> adc 7 1 therm_celsius_lut.csv
R000009
23.4474
> adc 7 -l
R000009
27.5129
> adc 7
R000007
0x78F
> adc 7 -v
R000006
1559

dac_set_level

Abbreviation

dac

Description

Set the output level of a DAC. The DAC output voltage level is set to 3.3V x <level>/4096.

Supported hardware: GPIO 0 on AMW004 (Wallaby).

Syntax

> dac_set_level <level>

Supported Platforms

• AMW004

Example

> dac 0 2048
Success

dms

Abbreviation

dms

Description

Perform activities with the DMS, including:

• Claim current device, associating it with your DMS account
• Activate a product with the current device.
• Post telemetry information to the DMS.

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.

Update

dms update

The dms update command performs a DMS claim and/or activate operation as well as OTA update. Syntax is:

dms update [-b <bundle version>] <username> <password> [<product code>] / [-b <bundle version>] <product code>

where:

• <bundle version> - Specific bundle version to update
• <username> - DMS username
• <password> - DMS password or token
• <product code> - DMS product code

The following command options are supported:

Claim and OTA update the device:

dms update <username> <password>

The device is updated to the device's 'origin product'.

This is similar to using the commands:

> dms claim <username> <password>
> ota

Activate and OTA update the device

dms update <product code>

The device is updated to the activated product.

Note: The device must have been previously claimed.

This is similar to:

> dms activate <product code>
> ota

Claim, activate and OTA update the device

dms update <username> <password> <product code>

The device is claimed, then updated to the activated product.

This is similar to:

> dms claim <username> <password>
> dms activate <product code>
> ota

OTA update the device to the most recent 'release' bundle

dms update

This is the same as:

> ota

OTA update the device to a specific bundle

dms update -b <bundle version>

This is the exact same as:

> ota -b <version>

Note: The device must first be claimed and/or activated. If this operation passes then the device boots into the Kernel to perform the OTA update. This is available only for a development device. See the note for the ota -b option.

Telemetry

dms telemetry

Causes the device to immediately post its telemetry information to the DMS.

Details of the telemetry are set with the following variables:

• dms.telemetry.adc_mask
• dms.telemetry.data_mask
• dms.telemetry.gpio_mask

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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.

ZentriOS writes the file to extended flash or bulk flash, depending on the --extended or --bulk options. If neither option is specified, ZentriOS writes to bulk flash if available, otherwise to extended flash.

See File System, Writing Files.

Syntax

> file_create [-[e][u][s][y]] [-o] [--extended/--bulk] <filename> <size> [<version> [<type> [<crc>]]]

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

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

Encryption example

Create file encrypted on creation with system.security_key, which must be pre-set with a user key.

In ls output, note file length is 32 bytes more than data content, and bit 10, User Encrypted flag, is set.

This example also demonstrates opening the file with the security key. See file_open.

> set system.security_key f12ca2a9dae8bdb48d959e65ec54f6da
User key set
Set OK
> file_create -s my_file.txt 100
Here is a test file encrypted with system.security_key
using the file_create -s option. Note flags
File created
> ls -l
!  # Type  Flags  Hnd    Size       Version  Filename
...
#  6 e-FE   0421   97     132       1.0.0.0  my_file.txt
...
file_open my_file.txt
[Opened: 0]
0
> read 0 100
J¡@õk_WRA7WFJÙSG...(without key, output is not decrypted)
> file_open my_file.txt f12ca2a9dae8bdb48d959e65ec54f6da
[Opened: 1]
1
> read 1 100
Here is a test file encrypted with system.security_key
using the file_create -s option. Note flags
[Closed: 1]

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

> file_open <filename> | <memory>-<handle> [<security key>]

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
• <security key>: 32 char hex string key. If the file has the User Encrypted file flag set, decrypt with the supplied key, which must match the system.security_key. The system.security_key variable must be set. If no key is supplied, an encrypted file is read as encrypted.

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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. See also the system.bflash.cs_gpio variable.

Syntax

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

Properties

• available in Safe Mode

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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:

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

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

gpios_dir

Abbreviation

gdis

Description

Set the direction of all general purpose I/O pins. A direction for all GPIOs must be provided with the direction of GPIO 0 in the first (left-most) position in the array.

Note : This is a run-time only setting: the direction values are 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

> gpios_dir <direction array> where a <direction array> element may be one of the values in the following table.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> gdis 10011011333530011000222226622
R000008
Set OK

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> gpios_get
R000031
0XX00X0000000XX10XXX000000000

gpios_set

Abbreviation

gses

Description

Immediately set the value of all general purpose I/O pins. When setting a GPIO, the GPIO direction must be also correctly set using gpio_dir or gpios_dir or the command will fail. The value for all GPIOs must be provided, with the value of GPIO 0 in the first (left-most) position in the array.

Syntax

> gpios_set <GPIO value array>

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

The examples shown below are for the AMW004 Wallaby module which has 29 GPIOs, the first example command failed because the GPIO value array contained less than 29 values.

> gses 100110100101101001001011
L000022
Must supply 29 gpios
R700018
Invalid argument

> gses 10011011001011110100100101111
R000008
Set OK

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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_add_header

Abbreviation

had

Description

Add a custom HTTP header to the HTTP stream specified by <handle>.

See Networking and Security, HTTP Client.

Syntax

> http_add_header <handle> <key> <value> where:

Options must be provided in the order shown.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> http_get -o example.com
[2014-03-29 | 01:37:17: Connecting: http://example.com]
Request GET /
Connecting (HTTP): example.com:80
[2014-03-29 | 01:37:18: Connected: 0]
0
> had 0 Content-type application/text
Success
> hre 0
HTTP response: 200
200

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.

See Networking and Security, TLS Errors for details of the error response to TLS failure.

See Networking and Security, HTTP Client.

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:

• 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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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_get

Abbreviation

hge

Description

Perform an HTTP(S) GET request and return a network stream handle if successful.

The protocol is assumed to be HTTP unless otherwise specified in the <url> parameter.

For a URL longer than 124 characters the command and url exceed the maximum command line length.

In this case use the --long_url option instead of including the URL as a command argument. Send the long URL, terminated by \r\n, immediately after the terminating \r\n of the command.

To allow custom headers, use the -o option.

Timeout is determined by tcp.client.connect_timeout.

See Networking and Security, TLS Errors for details of the error response to TLS failure.

See:

• Networking and Security, Network Connections and Streams.
• See Networking and Security, HTTP Client

Syntax

> http_get [-i <wlan/softap>] [-g < GPIO#>] [-o] <url> / --long_url [ca_cert_filename]

where:

Options must be provided in the order shown.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> hge https://www.google.com.au
[2014-04-02 | 13:27:20: Connecting: https://www.google.com.au]
Request GET /
Connecting (HTTP): www.google.com.au:443
Starting TLS
[2014-04-02 | 13:27:21: Connected: 0]
HTTP response: 200
Status: 200
0
> hge -o example.com:80
[2014-04-11 | 10:48:25: Opening: example.com:80]
Request GET /
Connecting (HTTP): example.com:80
[2014-04-11 | 10:48:25: Opened: 1]
1

> http_get --long_url
http://example.com/arbitrary_page?param1=abvcedfgssassssdfs&param2=asdfadsfasd&param3=11111111111111
[2016-05-10 | 02:26:50: Opening:http://example.com]
Request GET /arbitrary_page?param1=abvcedfgssassssdfs&param2=asdfadsfasd&param3=11111111111111
Connecting (http): example.com:80
[2016-05-10 | 02:26:50: Opened: 2]
Status: 200
2

http_head

Abbreviation

hhe

Description

Perform an HTTP(S) HEAD request and return a network stream handle if successful.

The protocol is assumed to be HTTP unless otherwise specified in the <url> parameter.

To allow custom headers, use the -o option.

Timeout is determined by tcp.client.connect_timeout.

See:

• Networking and Security, Network Connections and Streams
• Networking and Security, HTTP Client

Syntax

> http_head [-i <wlan/softap>] -o <url> [ca_cert_filename] where:

Options must be provided in the order shown.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> hhe example.com
[2014-04-02 | 13:32:28: Connecting: example.com]
Request HEAD /
Connecting (HTTP): example.com:80
[2014-04-02 | 13:32:29: Connected: 0]
HTTP response: 200
Status: 200
0

http_post

Abbreviation

hpo

Description

Perform an HTTP(S) POST request and return a network stream handle if successful.

The protocol is assumed to be HTTP unless otherwise specified in the <url> parameter.

To allow custom headers, use the -o option.

The HTTP Content-type must be provided.

Timeout is determined by tcp.client.connect_timeout.

See:

• Networking and Security, Network Connections and Streams
• Networking and Security, HTTP Client

Syntax

> http_post [-i <wlan/softap>] [-g < GPIO#>] [-o] [-l <content-length>] <url> / --long_url<url> <content type> [ca_cert_filename] where:

Options must be provided in the order shown.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> hpo http://example.com application/json
[2014-04-02 | 13:35:19: Connecting: http://example.com]
Request POST /
Connecting (HTTP): example.com:80
[2014-04-02 | 13:35:20: Connected: 0]
HTTP response: 411
Status: 411
0
> hpo -o example.com:80 application/json
[2014-04-11 | 10:45:50: Opening: example.com:80]
Request POST /
Connecting (HTTP): example.com:80
[2014-04-11 | 10:45:50: Opened: 1]
1

http_read_status

Abbreviation

hre

Description

Read the HTTP response code returned by the last HTTP transaction on the stream specified by <handle>. If the HTTP request is pending and the transaction is incomplete, http_read_status sends the request and forces completion.

See Networking and Security, HTTP Client.

Syntax

> http_read_status <handle>

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> hre 1
411

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:

• Networking and Security, HTTP Client
• http_upload application note

Syntax

Upload a Single File

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

where:

• -i - optional, specify interface, value 'wlan' or 'softap' MUST come first. If omitted uses network.default_interface.
• -k <security key> - 32 char hex string key. If the file has the User Encrypted file flag set, decrypt with the supplied key, which must match the system.security_key. The system.security_key variable must be set. If no key is supplied, an encrypted file is uploaded as encrypted.
• <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
• <cert filename> - name of certificate on local serial flash

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.

For examples, see the http_upload application note.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

i2c_master_config

Abbreviation

i2cmc

Description

Configure an I2C slave peripheral such as an accelerometer, humidity sensor, light sensor, etc.

Notes:

• This is a run-time only command. The settings are reset upon a reboot/power-cycle
• This command must be issued at least once before issuing the i2c_master_open command
• Issuing this command multiple times for the same <slave address> updates its settings
• Issue this command for each connected slave
• To display the configuration for a previously configured slave, issue this command with only the <slave hex address> argument
• Summary of unsupported features:
  • Clock stretching
  • 10-bit addresses

See Networking and Security, Network Connections and Streams.

Syntax

> i2c_master_config <slave hex address> <clock rate> [<retries> [<config bitmask>]]

where:

• <slave hex address> - the 7bit I2C slave address in hex
• <clock rate> - I2C clock rate, The clock rate may be any value. Several special values are also supported:
  • low - low speed: 10kHz
  • standard - standard speed: 100kHz
  • high - high speed: 400kHz
• <retries> - optional, if specified then a register read/write will be attempted <retries> times before returning the failure code. This settings is only used if <register address> is supplied with a read/write command
• <config bitmask> - slave configuration. Hex string bitmask. See below.

<config bitmask> is a bitmask specifying the various flags for the I2C slave. The bits have the following meanings:

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> i2c_master_config 0x19 standard 0 0x01
Success
> i2c_master_config 0x19
! Addr Clock  Flags Retries
# 0x19 100000 0x01  0

i2c_master_open

Abbreviation

i2cmo

Description

Open an I2C stream for read/write. Optionally specify the size of the read buffer.

The stream can then be used with the stream commands. Stream command behavior is modified for i2c as follows:

Notes:

• This is a run-time only command. The settings are reset upon a reboot/power-cycle
• This command must be issued at least once before issuing the i2c_master_open command
• Issuing this command multiple times for the same <slave hex address> updates its settings
• Issue this command for each connected slave
• To see the configuration for a previously configured slave, issue this command with only the <slave hex address> argument

Syntax

> i2c_master_open [<rx buffer>]

where:

• <rx_buffer> is the maximum number of bytes that may be read using the read command.
  Default: 128 bytes.

I2C Write Command

Once an I2C stream is opened, the write command is used to write data to an I2C slave. The write command has additional arguments to specify the register address and slave address to write. write <handle> <write size> [<flags> [<register address> [<slave address>]]] where:

• <flags> - hex bitmask:
  • 0x01 = continued write: if this bit is set then no stop condition will be sent after the write. This allows for issuing the write command multiple times within the same I2C frame.
• <register address> - if specified then <register address> is first written to the bus, followed by <write size> bytes of data.
• <slave address> - if specified then this slave address along with its corresponding settings are used else the last specified slave address is used.

Notes:

• Only 8bit register addresses are supported for
• Only 7bit slave addresses are supported for

I2C Read Command

Once an I2C stream is opened, the read command is used to read data from an I2C slave. The read command has additional arguments to specify the register address and slave address to read.

read <handle> <read size> [<flags> [<register address> [<slave address>]]] where:

• <flags> - hex bitmask: Reserved for future expansion, leave as 0x00
• <register address> - if specified then <register address> is first written to the bus followed by reading <read size> bytes of data.
• <slave address> - if specified then this slave address along with its corresponding settings are used else the last specified slave address is used.

Notes:

• Only 8bit register addresses are supported for
• Only 7bit slave addresses are supported for

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

The following shows how to read/write the LIS3DH Accelerometer via the I2C bus. The LIS3DH Accelerometer comes with the Seabass and Snapper evaluation boards).

Quick notes about the LIS3DH

Slave address = 0x19

If the MSb of a register address is set then the register address automatically increments for subsequent read/writes. This auto-increment is a feature of the LIS3DH, not of ZentriOS.

>i2c_master_config 0x19 standard 0 0x01
Success
> i2c_master_open
[Opened: 0]
0
> read 0 1 0 0x0F
33
> write 0 2 0x01 0xA0
aa
Success

> write 0 2 0x01
bb
Success
> write 0 2 0x01
cc
Success
> write 0 2
dd
Success
> read 0 4 0 0xA0
AABBCCDD

Configure I2C slave address: 0x19,
  'standard' clock, no retries, and hexify flag
Open an I2C stream


Read register 0x0F (aka Who Am I register)
  should return 0x33
Write CTRL_REG 1-4 (0x20 - 0x23),
  use LIS3DH's register auto-increment feature
  by setting MSb of register address.
  Use 'continued write' flag
Write CTRL_REG2 (0x21)
  (recall we're using 'continued write' flag
  and chip's register auto-increment feature)
Write CTRL_REG3 (0x22)


Write CTRL_REG4 (0x23). This is the last write
  so don't use the 'continued write' flag

Read back registers 0x20-0x23
  Set MSb of register address so the register address
  is automatically incremented

ls

Abbreviation

ls

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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 [-v] <config_file>

where:

• -v: verbose: displays information including the set command for each variable and the corresponding result

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> load config1.cfg
> Configuration successfully loaded

mdns_discover

Abbreviation

mdns

Description

Discover mDNS services on the local network. See variables mdns.enabled, mdns.interface, mdns.name, mdns.service, mdns.ttl

Syntax

> mdns_discover [-v] [<service type>]

where:

• -v - optional, verbosely print the results
• <service type> - optional, a specific service type to discover (e.g. _http._tcp). If omitted, all found services are returned.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> set wlan.ssid Zentri
Set OK
> set wlan.passkey secretkey
Set OK
> set mdns.enabled 1
Set OK
> mdns_discover
[Associating to Zentri]
Security type from probe: WPA2-AES
Obtaining IPv4 address via DHCP
IPv4 address: 10.5.6.115
Starting mDNS
mDNS domain: ZentriOS-102f1a.local
[Associated]
Services found: 4
Service: _csco-api._tcp.local
Name: _jenkins._tcp.local

Service: _https._tcp.local
Name: _workstation._tcp.local

Service: _http._tcp.local
Name: _http._tcp.local

Service: _csco-sb._tcp.local
Name: routera296b6._csco-api._tcp.local
Server: routera296b6._csco-api._tcp.local
Address: 10.5.6.1

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> nlo google.com
R000016
216.58.220.142

network_flush

Abbreviation

nfl

Description

Flush the DNS cache and/or flush the cached DHCP IP and forcibly renew the DHCP lease. DHCP caching depends on wlan.dhcp.cache_enabled.

If no arguments are supplied, the DNS cache is flushed, and the cached DHCP IP is cleared and the DHCP lease is forcibly renewed.

If the dns argument is supplied only the DNS cache is cleared.

If the dhcp argument is supplied the DHCP IP cache is cleared, and the DHCP lease is forcibly renewed.

Note: This command currently supports only the WLAN interface.

Syntax

> network_flush [ dns / dhcp ]

where:

• dns: flush DNS cache
• dhcp: flush DHCP cache and renew DHCP lease

To flush both DNS and DHCP caches, issue the command with no arguments.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> nfl
R000009
Success

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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.

See Procedure for Joining a WLAN Network.

Syntax

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

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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]

network_verify

Abbreviation

nve

Description

Verify the module can connect to a Wi-Fi network with specific network credentials. This command provides a fast way test the network credentials entered by a user are valid when web setup with softAP is operational, see Configuration & Setup, Web Setup. At present, only the Wi-Fi credentials are verified. No attempt is made to verify whether the module can obtain an IP address using DHCP.

The network verify command can also be used to quickly test network credentials at any time, however if the module is already connected to a network on the wlan client interface, it will be automatically disconnected from that network first.

If the verification attempt is unsuccessful, the command responds with Timeout. Verification may be unsuccessful if either the credentials provided are incorrect, or the verification attempt takes longer than 1 second.

Notes

• The wlan_scan -v command returns detailed information (including the BSSID, AP channel and security type) of Wi-Fi APs in range. A relevant subset of this information may be passed to the network_verify command.
• For WPA/WPA2, the PSK/PMK is calculated by applying the PBKDF2 key derivation function to the WPA/WPA2 passphrase using the SSID as the salt and 4096 iterations of HMAC-SHA1, see here for additional information.

Syntax

> network_verify wifi <ssid> <bssid> <ap channel> [<security> <psk>] where:

• <ssid> - the name of the Wi-Fi network
• <bssid> - the MAC address of the Wi-Fi Access Point (colons in the MAC are optional)
• <ap channel> - the radio channel of the AP
• <security> - an enumeration of the security type used by the AP:
  • 1 = WEP
  • 2 = WPA-AES
  • 3 = WPA-TKIP
  • 4 = WPA2-AES
  • 5 = WPA2-Mixed
  • 6 = WPA2-TKIP
• <psk> - 64 hex character pre-shared key (aka PMK) for WPA/WPA2 or WEP key

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example (Open Security)

> network_verify wifi mynetwork 4C55CC102F1A 1
Success

Example (WEP40 Security)

> network_verify wifi mynetwork 4C55CC102F1A 1 1 1122334455
Success

Example (WPA/WPA2 Security)

> network_verify wifi mynetwork 4C55CC102F1A 1 4 1205089613366e362586ee5f9ac8f485188fb0bdab30f2f1c23295eb863122de
Success

ota

Abbreviation

ota

Description

Initiate a secure over-the-air update using the ota server specified by the dms.ota_host variable. The secure OTA protocol uses industry standard TLS/HTTPS security with both client-side and server-side certificate verification.

For details of this process and associated requirements, see Update and Recovery, Secure OTA Update. This process requires you to claim the device using the dms claim command.

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. See the note for the -b option in Syntax below.

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. See also Configuration and Setup, Default Variable Configuration.

See Networking and Security, TLS Errors for details of the error response to TLS failure.

Note: OTA requires a memory-intensive TLS connection, and may fail if memory is low. See Networking and Security, Increasing Available Memory for TLS.

To determine the result of the most recent ota command, see dms.ota_result.

Note: If the ota command fails with the message:

{"result":"fail","message":"device not claimed"}

then you need to claim the device before running the ota command. See Update and Recovery, the Zentri DMS Server.

Syntax

> ota [-q] [-f] [-b <full version>] [-u <user file>]

• -q : query database and return either Up-to-date or bundle version string if newer release available. Must be the only option. Result codes and messages are:
  • 204, Up-to-date
  • 200, <DMS generated bundle string version> e.g. 200,ZENTRI-AMW006-3.0.0.6, 2016-02-09T23:50:37Z, ZentriOS-W-3.0.0.6
  • Message from server
• -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

• -u : download a user file. User files must be stored on the ZentriOS Device Management Server (DMS). Contact Zentri for details.

Properties

• available in Safe Mode

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

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

pwm_update

Abbreviation

pwm

Description

Drive a GPIO with a pulse width modulated signal with duty_cycle in the range 0-100%. The PWM frequency has a module-dependent default and may be optionally set with the frequency option. Use the stop option to turn the PWM off.

See Peripherals, PWMs for frequency defaults and PWM groups for each module. GPIOs in the same PWM group cannot be used independently at the same time.

Syntax

> pwm <GPIO#> <duty_cycle / stop> [frequency] where:

• <duty_cycle> : percentage of time high, expressed as integer between 0 and 100
• <frequency> : Hz, expressed as an integer. Minimum and maximum values are module depedendent.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

Set GPIO 10 to 30% duty cycle:

> pwm_update 10 30
R000009
Success

Blink LED wired to GPIO 21 at 50% duty cycle and frequency of 5Hz:

> pwm 21 50 5

Stop LED blinking - value remains high:

> pwm 21 stop

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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:

• Configuration and Setup, Default Variable Configuration
• Update and Recovery, Factory Reset.

If system.security_key is set, the file is automatically encrypted with that key, and the User Encrypted file flag is set. When ZentriOS reads files for internal use (within the MCU only), it automatically decrypts files encrypted with the system.security_key.

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:

Properties

• available in Safe Mode

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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.

The setup command can also be used to automate device configuration and setup with a configuration script.

See:

• Configuration and Setup, Setup Configuration Script
• Executing a Script on GPIO Assertion or Reboot

Syntax

> setup <web/status/stop/cmd [-v] [<script_file>]>

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

Setup up with cmd option

> setup cmd
> Scan and select a network:
network_up -s
Scanning for networks...
! 4 networks found
! # Ch RSSI MAC (BSSID)       Network (SSID)
# 0 06  -35 84:1B:5E:29:9D:F7 GameOverMan
# 1 06  -88 28:C6:8E:70:93:18 Philips Home Network_EXT
# 2 11  -65 EC:1A:59:36:5B:6C laboite_xt
# 3 11  -73 2C:B0:5D:31:6F:6A laboite

Type the number # that matches your Network: 0
Type the password for your Network         : pullyourselftogetherhicks
[Associating to GameOverMan]
In progress
> Enabling network auto-join
set wlan.auto_join.enabled true
Set OK
> Saving settings
save
Saved
Success
> Security type from probe: WPA2-Mixed
Obtaining IPv4 address via DHCP
IPv4 address: 192.168.0.32
[Associated]
> Exiting Cmd Setup Mode

sleep

Abbreviation

sleep

Description

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

Syntax

> sleep

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

smtp_send

Abbreviation

smtp

Description

Send email to a specified email address. See SMTP variables:

• email.name_address
• email.smtp.host
• email.smtp.password
• email.smtp.port
• email.smtp.username

Syntax

> smtp <to address> <subject> <content length>
[<content length> bytes of data ...]

where:

• <to address> - email address to send email to
• <subject> - the subject of the email, must be enclosed in double-quotes if spaces are used in the subject.
• <content length> - the length in bytes/characters of the email contents.

Immediately after issuing the command, <content length> characters of data should be sent. This is the body of the email.

Note that most SMTP servers require SSL/TLS encryption. Some servers, including gmail, use additional authentication methods like OAUTH by default. These additional authentication methods are not supported and may need to be disabled server-side.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> smtp_send first.last@youremail.com "World greetings" 5
Hello
[Associating to MY_NETWORK]
Security type from probe: WPA2-AES
Obtaining IPv4 address via DHCP
IPv4 address: 10.5.6.59
[Associated]
Success

softap_get_rssi

Abbreviation

srssi

Description

Get the received signal level (RSSI, in dBm) of a SoftAP client. The value is averaged to improve accuracy by setting the variable softap.rssi_average

Syntax

> softap_get_rssi <client MAC>

where:

• <client MAC> is the MAC address of the client

Example

> srssi 11:22:33:44:55:66
R000005
-47

spi_master_config

Abbreviation

spimc

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Description

Configure a SPI slave peripheral such as an accelerometer, humidity sensor, light sensor, etc.

Note: This is a run-time only command. The settings are reset upon a reboot/power-cycle.

This should be issued before using the spi_master_open command to open a SPI stream.

To display the SPI configuration for a previously configured slave-select GPIO, issue the command with only the <slave-select gpio #> argument.

Syntax

> spi_master_config <slave-select gpio #> <config bitmask> [<clock rate>]

where:

• <slave-select gpio #> - the GPIO to use as a slave-select signal
• <config bitmask> - slave configuration. Hex string bitmask. See below.
• <clock rate> - optional, the SPI master clock rate, default is 20MHz if not specified

<config bitmask> is a bitmask specifying the various flags for the SPI slave. The bits have the following meanings:

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> spi_master_config 9 0C
Success
> spimc 9
!  # Flags Clock
#  9 0x0C  2000000
> get gp u
!  # Description
...
#  9 SPI0 CS
...

spi_master_open

Abbreviation

spimo

Description

Open a SPI master stream for read/write. Optionally specify an Rx buffer size.

The stream can then be used with the stream commands. Stream command behavior is modified for SPI as follows:

Before using spi_master_open command, the <slave-select gpio #> must have been previously configured using the spi_master_config command. If no argument is supplied, the most recently specified <slave-select gpio #> is used.

Note: The caller must ensure that the contents of <rx buffer> is cleared before switching <slave-select gpio #>, as data is always read from <rx buffer> before reading from the SPI bus.

See Networking and Security, Network Connections and Streams.

Syntax

> spi_master_open [<rx buffer>]

where:

• <rx buffer> - optionally specify how many bytes of data the stream_write command buffers before the stream_read command must be called (the stream_write command fails if the <rx buffer> is full).
  Default: 128 bytes.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> spi_master_open 256
0
> write 0 10 2
...
> read 0 10

open the SPI master stream with <rx buffer> size of 256 bytes
(return stream handle 0)
write 10 bytes to slave 2 as the slave select to SPI bus
(this simultaneously reads 10 bytes)
read 10 bytes from buffer

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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.

If bus.command.write_check_enabled is set, when writing to a network stream, ZentriOS checks the size of the write (TX) buffer, to ensure that a full stream_write can be completed.

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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 specified by <handle>. Returns data immediately (if available), does not wait to receive data.

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.

Read times out after the period specified in bus.command_read_timeout.

Data Size Returned by stream_read

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.

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. Effective maximum: 1460. See Data Size Returned by stream_read above.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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.

Write times out after the period specified in bus.command.write_timeout.

See Networking and Security, Network Connections and Streams.

If bus.command.write_check_enabled is set, when writing to a network stream, ZentriOS checks the size of the write (TX) buffer, to ensure that a full stream_write can be completed.

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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>] [-g GPIO#] <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
• -g GPIO# - specify a GPIO to indicate buffered data is waiting to be read. Set to -1 to disable
• 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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

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

tls_client

Abbreviation

tlsc

Description

Open a secure TCP stream to a remote server with the specified properties.

Timeout is determined by tcp.client.connect_timeout.

See Networking and Security, TLS Errors for details of the error response to TLS failure.

See Networking and Security, Network Connections and Streams.

Syntax

> tls_client [-i <wlan/softap>] [-l <local_port>] [-g GPIO#] <host> <port> [ca_cert_filename]

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.
• [<ca cert filename>] - if omitted, use network.tls.ca_cert

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> tlsc www.google.com 443
L000032
Resolving host: www.google.com
L000057
[2014-03-24 | 01:15:53: Connecting: www.google.com:443]
L000038
Connecting (TLS): 74.125.237.211:443
L000039
[2014-03-24 | 01:15:55: Connected: 1]
R000003
1

tls_server

Abbreviation

tlss

Description

Start/stop a TLS server on the specified port.

If starting the server and no port is specified, the default is the port specified by tcp_server_port.

The server certificates must be pre-configured. See Networking and Security, TLS Server.

See Networking and Security, Network Connections and Streams.

Syntax

tls_server <start/stop> [port]

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> tlss start 5000

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:

• uart.baud
• uart.data
• uart.flow
• uart.parity
• uart.stop

Syntax

> uart_update <uart#>

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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 option -g GPIO# specifies which GPIO indicates buffered data is waiting to be read. See also system.oob.gpio.

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] [-g GPIO#] <host> <remote port> [local port]

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

udp_server

Abbreviation

udps

Description

Start and stop the UDP server.

When the UDP server is started the read and write sub-commands are available.

When the UDP server is started, it is assigned a stream handle, indicated in the ZentriOS response by Opened: <stream>.

This allows for the equivalent stream read and write commands.

The read command is functionally the same as udps read.

The write command is functionally the same as udps write without the <address> and <port> options. The write command writes to the single UDP server stream, and consequently writes to all clients connected to the UDP server.

See:

• UDP server
• Networking and Security, Network Connections and Streams

Syntax

start, stop

> udp_server <start/stop> [port] Start and stop the UDP server. Port may be optionally specified. If no port is specified the default is udp.server.port.

read

> udp_server read [-q] [<byte_count>] where :

• -q - optionally prepend the client's IP address and port before the data bytes, in a comma-separated list: ip,port,data

• <byte_count> - The number of bytes to read. Note that only a single packet's worth of data is returned
  i.e. data returned = MIN(<byte count>, len(packet))

write

> udp_server write <byte_count> [<address> <port>] where :

• <byte_count> - the number of data bytes to write
• <address>, <port> - optional, the remote client's address and port. If omitted, write to last client whose data has been read.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> udp_server start 5000
[2014-11-28 | 07:14:49: Opened: 0]
0
UDP server listening on port: 5000
> read 0 100
Hello server
> udp_server write 12
Hello client
Success
> udp_server read -q 100
10.5.6.60,52333,Hello again server
> write 0 18
Hello again client
Success
> udps stop
[2014-11-28 | 07:15:31: Closed: 0]
UDP server stopped
Success

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

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

websocket_client

Abbreviation

webc

Description

Opens a client websocket stream to a remote server. Returns a stream handle which may then be used with the read/write/poll/close commands.

The Websocket client connection can be controlled by a GPIO. See the ioconn.protocol web.

Data availability can be determined by an OOB GPIO event. See the system.oob.gpio event websocket.client.data_gpio.

See Networking and Security, Websocket Client.

Websocket Message Format

Websocket data passed between ZentriOS and remote server is sent in messages or frames. These messages start with a header. One element of the header is the message type. ZentriOS supports the 'text' and 'binary' message types. Note that ZentriOS treats all data as binary. The message type is only used by the remote side (for instance so a javascript library can convert the data to the correct format).

For more information see: https://developer.mozilla.org/en-US/docs/WebSockets/Writing_WebSocket_servers

Syntax

> websocket_client [-i <wlan/softap>] [-g <gpio> ] [-f <txt/bin>] <url> [<cert filename>] where:

• -i - specify interface. MUST come first. If omitted uses network.default_interface.
• -g - specify data GPIO for given stream. This gpio is asserted HIGH when the stream has data to be read
• -f - specify the websocket frame or message format. Default is txt if option not specified:
  • txt - text data (or ASCII)
  • bin - binary
• url - the remote server URL. This follows the same conventions as the http_get/http_post commands. Port default depends on URL scheme:
  • URL scheme ws: port defaults to 80
  • URL scheme wss: port defaults to 443
• cert filename - name of TLS certificate filename. If the scheme is https or wss or the cert is specified, then the websocket connection uses TLS. If the scheme is https or wss and no cert is specified, then the variable network.tls.ca_cert is used.

Supported Platforms

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

Example

> websocket_client ws://mywsserver.com
0

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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.

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

• AMW004
• AMW006
• AMW036
• AMW106
• AMW136
• AVN4343

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

wps

Abbreviation

wps

Description

WPS is currently disabled. If you require WPS support, please contact Zentri.