CLI Reference¶

Editing and Shortcut Keys¶

At the root level, type help to view the editing and shortcut keys for the CLI.

<tab>          fill in possible command
<enter>        run command as edited
*<enter>       show help on matching commands
?              list matching commands
<left arrow>   move cursor left
<right arrow>  move cursor right
<up arrow>     previous command
<down arrow>   later command
<backspace>    delete to left
<delete>       delete to left
<Paste XML>    import configuration

<control>                          <escape>
---------------------------------  ----------------------------------
a  move cursor to begin of line    b        move cursor backward word
d  delete character under cursor   f        move cursor forward word
e  move cursor to end of line      [A       previous command
k  delete to end of line           [B       later command
l  redraw line                     [C       move cursor right
r  redraw line                     [D       move cursor left
u  delete to begin of line         <escape> delete word to left
w  delete word to left

(Root) level¶

config¶

Enters the configuration level.

documentation¶

Dumps help for CLI commands.

file system¶

Enters the file system level.

help¶

Displays command line interface help.

status¶

Enters the status level.

tlog¶

Displays Trouble Log; stop with any character.

wlan scan [network-name]¶

Displays a scan of the wireless devices within range.

xml¶

Enters the XML level.

exit¶

Invites power down if Command Line is a Power Enabled Application.

Config level¶

exit¶

Returns to the root Command level.

wlan apply¶

Applies WLAN settings without yet writing configuration.

wlan connect [network-name]¶

Creates and applies temporary WLAN profile for the designated network. To drop the connection, omit network-name.

wlan scan [network-name]¶

Displays a scan of the wireless devices within range. Optionally provide network-name for a directed scan.

write¶

Writes any unsaved configuration.

Access Point¶

Enters the "config Access Point" Command level.

<instance> must be "ap0".

These settings pertain to the Access Point in the device. Changes take effect immediately. After saving the changes, re-establish any connections to the Access Point.

BLE¶

Enters the "config BLE" Command level.

BLE Beacon Scanner <instance>¶

Enters the selected "config BLE Beacon Scanner" Command level.

<instance> must be "1".

Clock¶

Enters the "config Clock" Command level.

These settings pertain to the Clock settings for keeping time.

CPM¶

Enters the "config CPM" Command level.

These settings pertain to the Configurable Pin Manager (CPM).

NOTE: Changes may take effect immediately or require reboot, so you should reboot after changing CPM Role configurations.

Ethernet¶

Enters the "config Ethernet" Command level.

<instance> must be "eth0".

These settings pertain to the Ethernet link in the device. Changes take effect immediately. After saving the changes, re-establish any connections to the Ethernet link.

Compliance¶

Enters the "config Compliance" Command level.

HTTP Server¶

Enters the "config HTTP Server" Command level.

Interface <instance>¶

Enters the selected "config Interface" Command level.

<instance> may be "ap0", "eth0" or "wlan0".

These settings pertain to the Network Interface on the device. To see the effect of these selections after a reboot, view the corresponding Status. Changes will take effect after reboot or wake from standby.

When ap0 is enabled, DHCP Server will assign IP addresses to ap0's clients. DHCP Server manages up to 6 simultaneous clients.

Line <instance>¶

Enters the selected "config Line" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the Serial Line. Changes take effect immediately except for Line Authentication. Line authentication settings will take effect after the next reboot or by exiting the line using the "exit" command once connected.

Radio¶

Enters the "config Radio" Command level.

These settings pertain to the Radio.

Any change to these settings requires a reboot to take effect.

User <instance>¶

Enters the selected "config User" Command level.

Creates <instance> if it does not already exist.

These settings pertain to each User on the device.

WLAN Profile <instance>¶

Enters the selected "config WLAN Profile" Command level.

Creates <instance> if it does not already exist.

These settings pertain to a WLAN Profile on the device.

If wlan0 connects to an access point on a different wireless channel, a current connection to ap0 may be dropped due to the channel change. Reconnect to ap0 in order to continue access to the device.

Bridge¶

Enters the "config Bridge" Command level.

Bridging allows a "bridged machine" to send and receive frames via wlan0 or ap0.

NOTE: A reboot is required for configuration changes to take effect.

CLI Server¶

Enters the "config CLI Server" Command level.

These settings pertain to the CLI Server. Changes take effect immediately.

Discovery <instance>¶

Enters the selected "config Discovery" Command level.

<instance> may be "ap0", "eth0" or "wlan0".

These settings pertain to Discovery. Changes take effect immediately.

Query Port is a Lantronix discovery protocol server. It implements a simple proprietary discovery service on port 0x77FE (30718).

MQTT <instance>¶

Enters the selected "config MQTT" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to MQTT connection information.

LPD <instance>¶

Enters the selected "config LPD" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

These configurables are for the Line Printer Daemon (LPD).

Modbus <instance>¶

Enters the selected "config Modbus" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to Modbus in the device for the associated line.

Modem Emulation <instance>¶

Enters the selected "config Modem Emulation" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

Connections can be initiated and accepted using Modem "AT" commands incoming from the Serial Line.

NTP¶

Enters the "config NTP" Command level.

These configurables are for Simple NTP (SNTP).

Percepxion¶

Enters the "config Percepxion" Command level.

TLS Credential <instance>¶

Enters the selected "config TLS Credential" Command level.

Creates <instance> if it does not already exist.

Manages certificates for TLS clients and servers.

SNMP¶

Enters the "config SNMP" Command level.

These configurables are for Simple Network Management Protocol (SNMP) Agent which implements SNMPv2c and is compatible with SNMPv1.

Tunnel <instance>¶

Enters the selected "config Tunnel" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

USB Device¶

Enters the "config USB Device" Command level.

Custom <instance>¶

Enters the selected "config Custom" Command level.

Creates <instance> if it does not already exist.

User custom configuration values are stored under this group.

Config Access Point level¶

<instance> must be "ap0".

These settings pertain to the Access Point in the device. Changes take effect immediately. After saving the changes, re-establish any connections to the Access Point.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

SSID <value>¶

SSID may contain up to 32 characters.

SSID may contain one or more Directives of the form %<option>.

Blank the value to restore the default.

Directives:

**%s** (serial number)
**%<n>s** (first <n> characters of serial number)
**%-<n>s** (last <n> characters of serial number)
Other use of % is not supported.

Guest <value>¶

Guest may be "Enabled" or "Disabled".

"Enabled" allows clients to discover our SSID via a passive scan.

"Disabled" causes this device to ignore probe requests with the wildcard SSID.

In either case this device responds to directed scans that contain our SSID.

Channel <value>¶

Blank the value for "<Auto>".

Channel configured here is applicable only if wlan0 is down or disabled.

If wlan0 is up, its associated Access Point will set the channel, and ap0 must also operate on that same channel.

NOTE: If the AP channel is not valid for the configured radio band, a valid channel will automatically be selected when the AP is started.

Auto Channel Scan Interval <value>¶

Auto Channel Scan Interval has units of minutes, hours, and/or days.

Suite <value>¶

Suite may be"None", "WPA2" or "WPA3".

Encryption <value>¶

Encryption may contain combinations of "CCMP" or "TKIP".

Passphrase¶

Passphrase may contain up to 63 characters.

The CLI will prompt "Enter Passphrase: ". The value will not be echoed.

SAE Password¶

SAE Password may contain up to 63 characters.

The CLI will prompt "Enter SAE Password: ". The value will not be echoed.

Mode <value>¶

Mode may be "Always Up", "Triggered", "Initial Trigger", "Initially Up" or "Controlled".

"Always Up" brings ap0 up unconditionally.

"Triggered" waits for CPM Role "AP Trigger" to become active. Then ap0 stays up according to Uptime.

"Initial Trigger" waits for CPM Role "AP Trigger" to become active. Then ap0 stays up indefinitely.

"Initially Up" comes up upon bootup, but only stays up according to Uptime.

"Controlled" waits for CPM Role "AP Trigger" to become active. Then ap0 stays up while "AP Trigger" is active and stays down while "AP Trigger" is inactive.

Uptime <value>¶

Uptime has units of seconds, minutes, and/or hours.

Uptime designates the time that ap0 will remain up after it has been triggered.

DNS Redirect <value>¶

DNS Redirect may contain up to 128 characters.

The DNS Redirect name will map to the IP address of the Interface. It may contain upper case, but note that DNS names are case insensitive.

NOTE: the DNS Redirect will not work if Interface ap0 has either Primary DNS or Secondary DNS configured; these override the device internal simple DNS.

Blank to restore the default.

Config BLE level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

Config BLE Beacon Scanner level¶

<instance> must be "1".

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Type <value>¶

Type may be "iBeacon" or "ELA Beacon".

iBeacon Output Format <value>¶

iBeacon Output Format may contain up to 60 characters.

ELA Beacon Output Format <value>¶

ELA Beacon Output Format may contain up to 150 characters.

Transmit Mode <value>¶

Transmit Mode may be "Disable", "Always", "Any Character" or "Start and Stop Characters".

Start Character <value>¶

Start Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Stop Character <value>¶

Stop Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Config Clock level¶

These settings pertain to the Clock settings for keeping time.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Source <value>¶

Source may be "Manual" or "NTP".

UTC Offset <value>¶

UTC Offset is allowed to have negative values.

UTC Offset has units of minutes.

UTC Offset must be in the range of -1440 to 1440, and be a multiple of 15 minutes.

Lists of common time zones and corresponding UTC Offset can be found at several websites, including "http://www.iana.org/time-zones".

Config CPM level¶

These settings pertain to the Configurable Pin Manager (CPM).

NOTE: Changes may take effect immediately or require reboot, so you should reboot after changing CPM Role configurations.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Role <instance>¶

Enters the selected "config CPM Role" Command level.

"AP Trigger" turns on ap0 if Mode is "Triggered", "Initial Trigger", or "Controlled".

"Ethernet Link" is Link UP while eth0 is up.

"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

"Modbus Input 1" can be read by Modbus TCP.

"Modbus Input 2" can be read by Modbus TCP.

"Modbus Input 3" can be read by Modbus TCP.

"Modbus Input 4" can be read by Modbus TCP.

"Modbus Output 1" can be written by Modbus TCP.

"Modbus Output 2" can be written by Modbus TCP.

"Modbus Output 3" can be written by Modbus TCP.

"Modbus Output 4" can be written by Modbus TCP.

"Radio Trigger" turns on radio if Mode is "Triggered".

"User Data Updated" is active when user data changes, till Acknowledge action.

"WLAN Active" is active while wlan0 is up.

Config CPM Role level¶

"AP Trigger" turns on ap0 if Mode is "Triggered", "Initial Trigger", or "Controlled".

"Ethernet Link" is Link UP while eth0 is up.

"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

"Modbus Input 1" can be read by Modbus TCP.

"Modbus Input 2" can be read by Modbus TCP.

"Modbus Input 3" can be read by Modbus TCP.

"Modbus Input 4" can be read by Modbus TCP.

"Modbus Output 1" can be written by Modbus TCP.

"Modbus Output 2" can be written by Modbus TCP.

"Modbus Output 3" can be written by Modbus TCP.

"Modbus Output 4" can be written by Modbus TCP.

"Radio Trigger" turns on radio if Mode is "Triggered".

"User Data Updated" is active when user data changes, till Acknowledge action.

"WLAN Active" is active while wlan0 is up.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

CP <value>¶

Blank the value for "<No CP Selected>".

This is the number of the Configurable Pin (CP) assigned to the role.

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows the application to use the designated Configurable Pin.

Note that some Roles (those containing a ".") are bundled into a group. Enabling / Disabling any one of them also Enables / Disables the rest of the Roles in the same Group.

Assert <value>¶

Assert may be "High" or "Low".

Assert reflects the logical polarity of this Configurable Pin.

"High" means that a logical "1" corresponds to a voltage high condition on the pin.

"Low" means that a logical "1" corresponds to a voltage low condition on the pin.

Config Ethernet level¶

<instance> must be "eth0".

These settings pertain to the Ethernet link in the device. Changes take effect immediately. After saving the changes, re-establish any connections to the Ethernet link.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

PHY Address Mode <value>¶

PHY Address Mode may be "Auto" or "Manual".

The PHY Address is the address of the external Ethernet PHY device on the MDIO bus. Most PHYs support address 0, but can generally be configured to something else with hardware strapping.

If set to Auto, the MDIO bus will be probed to find the address.

PHY Address <value>¶

PHY Address may be "0" or "<number>".

Speed <value>¶

Speed may be "Auto", "10" or "100".

Duplex <value>¶

Duplex may be "Half" or "Full".

Config Compliance level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

European Union Compliance <value>¶

European Union Compliance may be "Not Selected", "Enabled" or "Disabled".

The "Not Selected" option for European Union Compliance is the default. It cannot be selected again once the option has been enabled or disabled.

The "Enabled" option for European Union Compliance enables EN18031 compliance. This requires change of default Password.

The "Disabled" option for European Union Compliance disables EN18031 compliance.

Config HTTP Server level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disabled", "Enabled" or "Triggered".

"Disabled" prevents HTTP from operating on any port.

"Enabled" allows the HTTP Server to operate.

"Triggered" waits for CPM Role "HTTP Server Trigger" to become active. Then the HTTP Server stays up indefinitely.

Port <value>¶

Enter 0 for "<None>".

The default Port can be overridden.

Secure Port <value>¶

Enter 0 for "<None>".

The default Secure Port (TLS) can be overridden.

Secure Credential <value>¶

Secure Credential may contain up to 30 characters.

The Secure Credential specifies the name of the TLS Server Credential to be used for the secure connection.

Authentication Timeout <value>¶

Authentication Timeout has units of minutes, hours, and/or days.

The Authentication Timeout applies only if Digest authentication is being used.

Security¶

Enters the "config HTTP Server Security" Command level.

These settings pertain to the HTTP Server Security. Changes take effect immediately.

Config HTTP Server Security level¶

These settings pertain to the HTTP Server Security. Changes take effect immediately.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Access Control <instance>¶

Enters the selected "config HTTP Server Security Access Control" Command level.

<instance> may range from 1 to 9.

Config <instance>¶

Enters the selected "config HTTP Server Security Config" Command level.

<instance> may range from 1 to 9.

Status <instance>¶

Enters the selected "config HTTP Server Security Status" Command level.

<instance> may range from 1 to 9.

Config HTTP Server Security Access Control level¶

<instance> may range from 1 to 9.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

URI <value>¶

URI may contain up to 255 characters.

The HTTP Server can be configured with many different authentication directives. The authentication is hierarchical in that any URI can be given an authentication directive in order to override a parent URI authentication directive.

The URI must begin with /.

For example, create URI "/Welcome", then place your "hello.html" file in directory "/http/Welcome/", finally point your browser to "<device IP address>/Welcome/hello.html" to experiment with the authorization levels.

The following URIs are built into the server:

"/action/status" Action Web API

"/ajax" Web Manager helper

"/export/config" Config export Web API

"/export/status" Status export Web API

"/import/config" Config import Web API

"/wm/firmware_upgrade" Web Manager upgrade firmware

"/wm/fs/copy" Web Manager copy file

"/wm/fs/mkdir" Web Manager make directory

"/wm/fs/rename" Web Manager rename file

"/wm/fs/rm" Web Manager remove file

"/wm/fs/rmdir" Web Manager remove directory

"/wm/fs/upload" Web Manager upload file

"/fs" File System Web API

"/logout" Digest authentication

"/mux_http" Mux HTTP listener

"/tlog" Trouble log

"/upgrade" Firmware Upgrade Web API

AuthType <value>¶

AuthType may be "None", "Basic", "Digest", "TLS", "TLS Basic" or "TLS Digest".

"None" provides no authentication.

"Basic" encodes passwords using Base64.

"Digest" hashes passwords using MD5.

"TLS" encrypts data but provides no authentication.

"TLS Basic" encrypts data and encodes passwords using Base64.

"TLS Digest" encrypts data and hashes passwords using MD5.

User Level <value>¶

User Level may be "User", "Tech", "Admin" or "None".

"User" provides access to all users.

"Tech" provides users with Privilege "Tech" access only if one or more of their Zones are configured here. Users with Privilege "Admin" also have access.

"Admin" provides access only to users with Privilege "Admin".

"None" provides access to no users.

Zones <value>¶

Zones may contain combinations of "A", "B", "C", "D" or "E".

Select the Zones to be provided Tech access to this URI.

The meaning of the zones is determined by how you define them here. For example, say you define zones A and B via Access Controls:

/Toasters Tech A
/Blenders Tech B

Then over in Users you may reference zones:

admin Admin (has access to everything)
barry Tech A (has access to Toasters)
cindy Tech B (has access to Blenders)
david Tech A B (has access to Toasters and Blenders)
edwin User (has access to neither)

Config HTTP Server Security Config level¶

<instance> may range from 1 to 9.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Group <value>¶

Group may contain up to 30 characters.

The Group identifies the configuration group to which permissions apply. The authentication is hierarchical, similar to the access control URI.

The wildcard "" in Group* applies to all groups except "User" and "HTTP Server Security" which have their own rules.

User Level <value>¶

User Level may be "User", "Tech", "Admin" or "None".

"User" permits all users to change settings.

"Tech" permits users with Privilege "Tech" to change settings in the Group if one or more of their Zones are configured here. Users with Privilege "Admin" may also change settings.

"Admin" permits users with Privilege "Admin" to change settings in the Group.

"None" denies changes in the Group by any user.

Zones <value>¶

Zones may contain combinations of "A", "B", "C", "D" or "E".

Select the Zones to be provided Tech permission to this Group.

Config HTTP Server Security Status level¶

<instance> may range from 1 to 9.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Group <value>¶

Group may contain up to 30 characters.

The Group identifies the status group to which permissions apply. The authentication is hierarchical, similar to the access control URI.

The wildcard "" in Group* applies to all groups.

Optional Item <value>¶

Optional Item may contain up to 30 characters.

If not blank, the Optional Item name further narrows permissions.

Optional Action <value>¶

Optional Action may contain up to 30 characters.

If not blank, the Optional Action name further narrows permissions.

User Level <value>¶

User Level may be "User", "Tech", "Admin" or "None".

"User" permits all users to perform actions.

"Tech" permits users with Privilege "Tech" to perform actions in the Group if one or more of their Zones are configured here. Users with Privilege "Admin" may also perform actions.

"Admin" permits users with Privilege "Admin" to perform actions in the Group.

"None" denies actions in the Group by any user.

Zones <value>¶

Zones may contain combinations of "A", "B", "C", "D" or "E".

Select the Zones to be provided Tech permission to this Group.

Config Interface level¶

<instance> may be "ap0", "eth0" or "wlan0".

These settings pertain to the Network Interface on the device. To see the effect of these selections after a reboot, view the corresponding Status. ** Changes will take effect after reboot or wake from standby. **

When ap0 is enabled, DHCP Server will assign IP addresses to ap0's clients. DHCP Server manages up to 6 simultaneous clients.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows the Interface to operate.

Hostname <value>¶

Hostname may contain up to 63 characters.

Hostname must begin with a letter or number, continue with letter, number, or hyphen, and must end with a letter or number.

If DHCP Client is "Enabled", the Hostname is sent to the remote DHCP Server and may figure into the address assignment.

This setting is not applicable to ap0.

Priority <value>¶

When performing TCP or UDP connect, the Interface with Priority 1 will be attempted first, 2 will be attempted second, etc.

By default all Interfaces have Priority 1 and Ethernet interfaces are attempted before WLAN.

MSS <value>¶

MSS has units of bytes.

The Maximum Segment Size (MSS) applies to TCP connections on the Interface. This can be useful to avoid fragmentation over the network, which may be required because this device does not perform reassembly.

DHCP Client <value>¶

DHCP Client may be "Enabled" or "Disabled".

When "Enabled", any configured IP Address or Default Gateway will be ignored. DHCP Client will auto-discover and eclipse those configuration items. Hostname is sent to the remote DHCP Server and may figure into the address assignment.

When DHCP Client fails to discover an IP Address, a new address will automatically be generated using AutoIP. This address will be within the 169.254.x.x space.

This setting is not applicable to ap0.

IP Address <value>¶

IP Address may contain up to 31 characters.

IP Address may be entered alone, in CIDR form, or with an explicit mask:
192.168.1.1 (default mask)
192.168.1.1/24 (CIDR)
192.168.1.1 255.255.255.0 (explicit mask)

The IP Address will be displayed always in CIDR, the canonical form.

NOTE: For bridged ap0 only, enter "0.0.0.0" to disable network services including the DHCP server.

Default Gateway <value>¶

Default Gateway may contain up to 15 characters.

For ap0, which has a DHCP Server, the Default Gateway (if present) is placed into DHCP response option 3.

Other interfaces refer to the Default Gateway only if DHCP Client is disabled.

DNS <value>¶

DNS may be "DHCP" or "Static".

Primary DNS <value>¶

Primary DNS may contain up to 15 characters.

For ap0, which has a DHCP Server, the Primary DNS (if present) is placed into DHCP response option 6. If neither the Primary DNS nor Secondary DNS is present in the ap0 configuration, the DHCP Server offers its own simple DNS.

Other interfaces refer to the Primary DNS only if DHCP Client is disabled.

The Primary DNS is the first choice when performing a Domain Name lookup.

Secondary DNS <value>¶

Secondary DNS may contain up to 15 characters.

For ap0, which has a DHCP Server, the Secondary DNS (if present) is placed into DHCP response option 6. If neither the Primary DNS nor Secondary DNS is present in the ap0 configuration, the DHCP Server offers its own simple DNS.

Other interfaces refer to the Secondary DNS only if DHCP Client is disabled.

The Secondary DNS is the second choice when performing a Domain Name lookup.

Config Line level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the Serial Line. Changes take effect immediately except for Line Authentication. Line authentication settings will take effect after the next reboot or by exiting the line using the "exit" command once connected.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Name <value>¶

Name may contain up to 25 characters.

The Name is for display purposes only.

Interface <value>¶

Interface may be "RS232", "RS485 Half-Duplex" or "RS485 Full-Duplex".

Tx to Rx delay <value>¶

Tx to Rx delay has units of milliseconds.

The Tx to Rx delay can be specified for the RS485 Half-Duplex (2 wire) mode. This is the delay after sending the last character out the wire, before switching to receive mode.

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows the Serial Line to operate.

Protocol <value>¶

Protocol may be "BLE Beacon Scanner", "BLE Connect", "Command Line", "LPD", "MQTT", "Modbus ASCII", "Modbus RTU", "Modem Emulation", "Mux", "None", "Percepxion Interface", "SLIP", "Trouble Log" or "Tunnel".

Protocol selects the application to connect to the Line.

"BLE Beacon Scanner" scans for BLE Beacons and outputs them on the line.

"BLE Connect" Outputs BLE connected payload data to line.

"Command Line" sets up a user interface containing commands to show device status and to change configuration. Simply paste in XML configuration to apply its settings to the device.

"LPD" provides a Line Printer Daemon (LPD) serial port.

"MQTT" Buffer characters till newline; send as MQTT publish.

"Modbus ASCII" talks to programmable logic controllers via ASCII with checksum.

"Modbus RTU" talks to programmable logic controllers via binary with CRC.

"Modem Emulation" implements legacy AT commands.

"Mux" provides commands for sending / receiving data on multiple network connections.

"None" enables Line action commands.

"Percepxion Interface" provides a command interface to the Percepxion serial API.

"SLIP" provides a network interface.

"Trouble Log" sets up an output-only message log on the device.

"Tunnel" sets up the Line to work with the Tunnel application. See the Tunnel configuration options for details.

Line Authentication <value>¶

Line Authentication may be "Enabled" or "Disabled".

If Line Authentication is enabled, the serial Line user will be challenged for a username and password prior to entering the CLI. Line authentication settings will take effect after the next reboot or by exiting the line using the "exit" command once connected. It will enable when the region is set to European Union under HTTP Server configuration to comply with EN18031. Otherwise it will disable.

Baud Rate <value>¶

Baud Rate has units of bits per second.

When specifying a Custom baud rate in the Web Manager, select 'Custom' from the drop down list and then enter the desired rate in the text box.

Parity <value>¶

Parity may be "None", "Even" or "Odd".

Data Bits <value>¶

Data Bits may be "7" or "8".

Stop Bits <value>¶

Stop Bits may be "1" or "2".

Flow Control <value>¶

Flow Control may be "None", "Hardware" or "Software".

Xon Char <value>¶

Xon Char may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Xoff Char <value>¶

Xoff Char may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Gap Timer <value>¶

Gap Timer has units of milliseconds.

Blank the value for "<Four Character Periods>".

The driver forwards received serial bytes after the Gap Timer delay from the last character received. By default, the delay is four character periods at the current baud rate (minimum 1 ms) for those Line types that support adjustable baud rates.

Threshold <value>¶

Threshold has units of bytes.

The driver will forward received characters after Threshold bytes have been received.

Push <value>¶

Push may contain up to 2 bytes.

A control character <control>J, for example, counts as one.

If defined, the driver will forward received characters after the Push sequence of characters is received.

Config Radio level¶

These settings pertain to the Radio.

Any change to these settings requires a reboot to take effect.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disabled", "Enabled", "Triggered" or "Initial Delay".

"Disabled" holds the Radio in low power.

"Enabled" allows the Radio to operate.

"Triggered" waits for CPM Role "Radio Trigger" to become active. Then the Radio stays up indefinitely.

"Initial Delay" waits a random time after power on or reset before the Radio operates. The user configures a minimum and maximum delay time.

NOTE: If Radio is disabled or not yet triggered, this inhibits both ap0 and wlan0 from operating.

IEEE 80211ac <value>¶

IEEE 80211ac may be "Enabled" or "Disabled".

Antenna Selection <value>¶

Antenna Selection may be "Auto", "1" or "2".

"Auto" allows the Radio to select the best antenna at any time.

"1" forces the Radio to use only antenna 1.

"2" forces the Radio to use only antenna 2.

WiFi Antenna <value>¶

WiFi Antenna may be "1" or "2".

Keep Alive <value>¶

Keep Alive has units of seconds and/or minutes.

Enter 0 for "Disabled".

If not "Disabled", causes a Null-Function Data frame to be sent on wlan0 periodically to keep the link up.

Max Volley Delay <value>¶

Max Volley Delay has units of seconds and/or minutes.

While wlan0 is Disconnected, it scans in turn for each WLAN Profile. One scan per profile comprises a volley. The intervolley delay is doubled after failure to join, subject to the Max Volley Delay.

WARNING: Short delay will compromise ap0 performance; ap0 cannot communicate while the radio is scanning.

Log <value>¶

Log may be "Enabled" or "Disabled".

"Enabled" causes radio log messages to be placed in the Trouble Log. This facilitates troubleshooting but may compromise performance.

Event Log <value>¶

Event Log may be "Enabled" or "Disabled".

"Enabled" causes radio events to be interpreted and displayed in the Trouble Log. [For diagnostic purposes.]

Roaming¶

Enters the "config Radio Roaming" Command level.

Initial Delay¶

Enters the "config Radio Initial Delay" Command level.

Config Radio Roaming level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

RSSI Floor <value>¶

RSSI Floor is allowed to have negative values.

RSSI Floor has units of dBm.

Config Radio Initial Delay level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Minimum <value>¶

Minimum has units of seconds, minutes, and/or hours.

To avoid many devices communicating at the same time after Power On, set an Initial Delay range. Each device will have a random delay uniformly distributed between Minimum and Maximum.

Maximum <value>¶

Maximum has units of seconds, minutes, and/or hours.

To avoid many devices communicating at the same time after Power On, set an Initial Delay range. Each device will have a random delay uniformly distributed between Minimum and Maximum.

Config User level¶

These settings pertain to each User on the device.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

delete¶

Deletes this User.

Password¶

Password may contain up to 32 characters.

The CLI will prompt "Enter Password: ". The value will not be echoed.

Privilege <value>¶

Privilege may be "User", "Tech" or "Admin".

Sets the user Privilege which governs what they can do.

"User" has access only to areas with User Level set to "User".

"Tech" has access only to areas with User Level set to "User" or with User Level set to "Tech" within the designated Zones.

"Admin" has access to all except areas with User Level set to "None".

Allow Tech A to change password <value>¶

Allow Tech A to change password may be "Enabled" or "Disabled".

"Disabled" allows Admin or self to change the password.

"Enabled" also allows any Tech with Zone A to change the password.

Zones <value>¶

Zones may contain combinations of "A", "B", "C", "D" or "E".

Zones designate areas that a "Tech" has access to.

The meaning of the zones is determined by how you define them over in HTTP Server Security Access Controls. For example, say you define zones A and B via Access Controls:

/Toasters Tech A
/Blenders Tech B

Then here you may reference zones:

admin Admin (has access to everything)
barry Tech A (has access to Toasters)
cindy Tech B (has access to Blenders)
david Tech A B (has access to Toasters and Blenders)
edwin User (has access to neither)

Config WLAN Profile level¶

These settings pertain to a WLAN Profile on the device.

If wlan0 connects to an access point on a different wireless channel, a current connection to ap0 may be dropped due to the channel change. Reconnect to ap0 in order to continue access to the device.

apply¶

Applies settings to wlan0, like "write" but without the save.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

delete¶

Deletes this WLAN Profile.

Basic¶

Enters the "config WLAN Profile Basic" Command level.

Security¶

Enters the "config WLAN Profile Security" Command level.

Advanced¶

Enters the "config WLAN Profile Advanced" Command level.

Config WLAN Profile Basic level¶

show¶

Shows current configuration.

apply¶

Applies settings to wlan0, like "write" but without the save.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Network Name <value>¶

Network Name may contain up to 32 characters.

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows this profile to be used.

"Disabled" prevents this profile form being used.

Config WLAN Profile Security level¶

show¶

Shows current configuration.

apply¶

Applies settings to wlan0, like "write" but without the save.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Suite <value>¶

Suite may be "None", "WPA2" or "WPA3".

Suite "WPA3" with Authentication "8021X" (Enterprise) operates in Transition mode only.

WPAx¶

Enters the "config WLAN Profile Security WPAx" Command level.

Config WLAN Profile Security WPAx level¶

show¶

Shows current configuration.

apply¶

Applies settings to wlan0, like "write" but without the save.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

IEEE 80211w <value>¶

IEEE 80211w may be "Disabled", "Optional" or "Required".

Authentication <value>¶

Authentication may be "PSK" or "8021X".

Passphrase¶

Passphrase may contain up to 63 characters.

The CLI will prompt "Enter Passphrase: ". The value will not be echoed.

SAE Password¶

SAE Password may contain up to 63 characters.

The CLI will prompt "Enter SAE Password: ". The value will not be echoed.

IEEE 8021X <value>¶

IEEE 8021X may be "EAP-TLS", "EAP-TTLS" or "PEAP".

IEEE 8021X At the successful conclusion of EAP-FAST authentication, an access credential (PAC) is allocated to the client device by the RADIUS server. This PAC will be used in subsequent authentications by the client, bypassing the full EAP-FAST exchange.

NOTE: If a change is made to the device configuration which enables Verify Expired CA Cert for EAP-FAST the device must be power-cycled or reset. Otherwise a previously provisioned PAC might be used to establish a connection to the access point, bypassing a full EAP-FAST exchange.

Username <value>¶

Username may contain up to 63 characters.

Password¶

Password may contain up to 63 characters.

The CLI will prompt "Enter Password: ". The value will not be echoed.

Credentials <value>¶

Credentials may contain up to 30 characters.

EAP-TTLS Option <value>¶

EAP-TTLS Option may be "EAP-MSCHAPV2", "MSCHAPV2", "MSCHAP", "CHAP" or "PAP".

PEAP ver <value>¶

PEAP ver may be "0" or "1".

PEAP Option <value>¶

PEAP Option may be "EAP-MSCHAPV2", "EAP-TLS" or "GTC".

PEAP Credentials <value>¶

PEAP Credentials may contain up to 30 characters.

Config WLAN Profile Advanced level¶

show¶

Shows current configuration.

apply¶

Applies settings to wlan0, like "write" but without the save.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Power Management <value>¶

Power Management may be "Enabled" or "Disabled".

PM Interval <value>¶

PM Interval has units of beacons (100 ms each).

Config Bridge level¶

Bridging allows a "bridged machine" to send and receive frames via wlan0 or ap0.

NOTE: A reboot is required for configuration changes to take effect.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Interface <value>¶

Interface may be "Disabled", "wlan0" or "ap0".

"Disabled" turns bridging off.

"wlan0" turns bridging on directed to and from wlan0. Configuration for IP Addressing, Static or Dynamic, must match between the bridged machine and this device.

"ap0" turns bridging on directed to and from ap0. The bridged device has its own distinct MAC and IP addresses.

Wired Interface <value>¶

Wired Interface may be "eth0" or "SLIP".

Allow All Multicast <value>¶

Allow All Multicast may be "Enabled" or "Disabled".

IGMP <instance>¶

Enters the selected "config Bridge IGMP" Command level.

<instance> may range from 1 to 6.

Config Bridge IGMP level¶

<instance> may range from 1 to 6.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

IP Address <value>¶

IP Address may contain up to 15 characters.

Config CLI Server level¶

These settings pertain to the CLI Server. Changes take effect immediately.

show¶

Shows current configuration.

Returns to the previous level.

Query Port¶

Enters the "config Discovery Query Port" Command level.

Config Discovery Query Port level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows the device to be discovered.

"Disabled" prevents discovery from finding the device.

Config MQTT level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to MQTT connection information.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Protocol <value>¶

Protocol may be "TCP", "TLS" or "Websocket".

Broker Address <value>¶

Broker Address may contain up to 50 characters.

Broker Port <value>¶

Blank the value for "<None>".

URL <value>¶

URL may contain up to 256 characters.

Credential Name <value>¶

Credential Name may contain up to 256 characters.

A valid Credential Name is required for secure operation.

Local Port <value>¶

Blank the value for "<Random>".

Device ID <value>¶

Device ID may contain up to 128 characters.

The Device ID is required. It must not match the ID of any other device on the server, else it will be rejected.

User Name <value>¶

User Name may contain up to 256 characters.

A User Name is optional, but may be required by the server security settings.

Auth Token <value>¶

Auth Token may contain up to 256 characters.

An Auth Token is optional, but may be required by the server security settings.

Publish Topic <value>¶

Publish Topic may contain up to 128 characters.

The Publish Topic is required only if this device is to send events to the MQTT server.

Data from the line is buffered until an end of line sequence is detected; then the Publish Topic and buffered data are sent as an event.

The end of line sequence may be

a single carriage return
a single line feed
a carriage return followed by a line feed
a carriage return followed by a NUL
a line feed followed by a carriage return
a line feed followed by a NUL

The buffer size is 1000 characters.

Enters the selected "config MQTT Subscribe" Command level.

<instance> may range from 1 to 6.

Diagnostic Log <value>¶

Diagnostic Log may be "Disabled", "Partial" or "Full".

<instance> may range from 1 to 6.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Topic <value>¶

Topic may contain up to 128 characters.

A Subscribe Topic is required only if this device is to receive events from the MQTT server. Up to 6 Subscribe Topics may be defined. Standard wildcards + and # are supported.

Leading Output <value>¶

Leading Output may be "Nothing", "Topic" or "Prefix".

Received events are sent out on the line. Events contain both a topic and data. You may select what shall be sent first to the line:

**Topic** will send the **Subscribe Topic** itself, followed optionally by the configured **Separator**.
**Prefix** will send only the configured **Prefix**.
**Nothing** will skip this.

Separator <value>¶

Separator may contain up to 3 bytes.

The Separator data is configured in hexadecimal form.

Prefix <value>¶

Prefix may contain up to 10 bytes.

The Prefix data is configured in hexadecimal form.

Data <value>¶

Data may be "Transparent" or "Hexadecimal".

If the selected data format is Hexadecimal, each event data byte will be sent as two bytes in hexadecimal form.

Trailing Output <value>¶

Trailing Output may contain up to 3 bytes.

The Trailing Output data is configured in hexadecimal form.

Config LPD level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

These configurables are for the Line Printer Daemon (LPD).

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Banner may be "Enabled" or "Disabled".

Enabling Banner will force the banner page to be printed even if the incoming print job does not specify to do so.

Binary <value>¶

Binary may be "Enabled" or "Disabled".

Enabling Binary will pass the entire file to the printer without removing any characters. Disabled, only valid ascii and control characters are passed; all others are stripped. Valid control characters include the tab, linefeed, formfeed, backspace, and newline.

SOJ Text <value>¶

SOJ Text may contain up to 100 bytes.

Non-printable characters must be in decimal or hexadecimal form enclosed in square braces and separated by commas. To specify an open square brace, use two in a row. Example: AB[255,0xFF]C[[D] results in this string, where dots hold place of unprintable characters: AB..C[D]

To send a Start Of Job (SOJ) string to the printer, enter the appropriate string.

EOJ Text <value>¶

EOJ Text may contain up to 100 bytes.

Non-printable characters must be in decimal or hexadecimal form enclosed in square braces and separated by commas. To specify an open square brace, use two in a row. Example: AB[255,0xFF]C[[D] results in this string, where dots hold place of unprintable characters: AB..C[D]

To send an End Of Job (EOJ) string to the printer, enter the appropriate string.

Formfeed <value>¶

Formfeed may be "Enabled" or "Disabled".

Enabling Formfeed will force a formfeed to be sent to the printer at the end of each print job.

Convert Newline <value>¶

Convert Newline may be "Enabled" or "Disabled".

Enabling Convert Newline will convert single newlines and single carriage returns into DOS style carriage return + linefeed line endings; if carriage return and linefeed characters are already in the correct DOS line-ending order, they will remain unchanged.

Queue Name <value>¶

Queue Name may contain up to 32 characters.

A Queue Name may not contain white space.

Config Modbus level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to Modbus in the device for the associated line.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

TCP Server State <value>¶

TCP Server State may be "Enabled" or "Disabled".

"Disabled" turns Modbus off.

"Enabled" turns Modbus on.

Port <value>¶

Enter 0 for "<None>".

Port is required for the Modbus to accept a connection.

Response Timeout <value>¶

Response Timeout has units of milliseconds.

Response Timeout is the timeout waiting for a response from slave device.

PDU Size <value>¶

PDU Size has units of bytes.

PDU Size is the maximum RX/TX PDU size accepted by Modbus. Default is 253.

Config Modem Emulation level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

Connections can be initiated and accepted using Modem "AT" commands incoming from the Serial Line.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Listen Port <value>¶

Blank the value for "<None>".

Specify a Listen Port to accept connections on.

Connect Local Port <value>¶

Blank the value for "<Random>".

Optionally specify a Connect Local Port for ATD connections. Note that this is necessary for operation while bridging.

Echo Pluses <value>¶

Echo Pluses may be "Enabled" or "Disabled".

"Enabled" means pluses will be echoed back during a "pause +++ pause" escape sequence on the Serial Line.

Echo Commands <value>¶

Echo Commands may be "Enabled" or "Disabled".

"Enabled" (ATE1) means characters read on the Serial Line will be echoed while the Line is in Modem Command Mode.

Verbose Response <value>¶

Verbose Response may be "Enabled" or "Disabled".

"Enabled" (ATQ0) means Modem Response Codes are sent out on the Serial Line.

Response Type <value>¶

Response Type may be "Text" or "Numeric".

Either "Text" (ATV1) or "Numeric" (ATV0) representation for the Modem Response Codes are sent out on the Serial Line.

Error Unknown Commands <value>¶

Error Unknown Commands may be "Enabled" or "Disabled".

"Enabled" (ATU0) means ERROR is returned on the Serial Line for unrecognized AT commands.

"Disabled" (ATU1) means OK is returned for unrecognized AT commands.

Incoming Connection <value>¶

Incoming Connection may be "Disabled", "Automatic" or "Manual".

"Disabled" (ATS0=0) will refuse to answer.

"Automatic" (ATS0=1) will answer immediately.

"Manual" (ATS0=2 or higher) may be answered via the ATA command after an incoming RING.

Connect String <value>¶

Connect String may contain up to 30 characters.

The Connect String is a customized string that is sent to the Serial Line with the CONNECT Modem Response Code.

Display Remote IP <value>¶

Display Remote IP may be "Enabled" or "Disabled".

"Enabled" means the incoming RING sent on the Serial Line is followed by the IP address of the caller.

Config NTP level¶

These configurables are for Simple NTP (SNTP).

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Server Hostname <value>¶

Server Hostname may contain up to 128 characters.

The Server Hostname is the name or IP address of an NTP server.

Sync Time <value>¶

Sync Time has units of seconds, minutes, and/or hours.

The NTP client waits Sync Time after successful update before querying again.

Config Percepxion level¶

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Device¶

Enters the "config Percepxion Device" Command level.

These settings pertain to the Percepxion management platform.

Line <instance>¶

Enters the selected "config Percepxion Line" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the Percepxion managment platform.

Config Percepxion Device level¶

These settings pertain to the Percepxion management platform.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

Status Update Interval <value>¶

Status Update Interval has units of minutes, hours, and/or days.

The Status Update Interval is the period of time that Percepxion waits between updating device status to the cloud.

The Status Update Interval can be configured between 10 minutes and 1 day (1440 minutes).

Content Check Interval <value>¶

Content Check Interval has units of hours, and/or days.

The Content Check Interval is the period of time that Percepxion waits between checking the cloud for updates to firmware and configuration.

The Content Check Interval can be configured between 1 hour and 90 days (2160 hours).

Apply Firmware Updates <value>¶

Apply Firmware Updates may be "Enabled" or "Disabled".

Apply Configuration Updates <value>¶

Apply Configuration Updates may be "Never", "If Unchanged" or "Always".

If the If Unchanged option is selected, configuration updates will only be applied if the current configuration has not been locally modified.

Reboot After Config Update <value>¶

Reboot After Config Update may be "Enabled" or "Disabled".

Device Name <value>¶

Device Name may contain up to 63 characters.

The Device Name must be at least 2 characters long, and may contain alphanumeric, hyphen, or underscore characters (A-Z,a-z,0-9,-,_) only. The first and last characters must be alphanumeric.

Device Description <value>¶

Device Description may contain up to 63 characters.

The Device Description is optional.

Additional Logging <value>¶

Additional Logging may be "Enabled" or "Disabled".

When enabled, Percepxion will provide more information in the Trouble Log.

Active Connection <value>¶

Active Connection may be "<number>".

The Active Connection specifies which connection parameters will be used in communication with the cloud.

Connection <instance>¶

Enters the selected "config Percepxion Device Connection" Command level.

<instance> may range from 1 to 2.

The Connections define the parameters to use in communication with the cloud.

Up to 2 Connections can be defined, with the Active Connection selecting which will be used.

Config Percepxion Device Connection level¶

<instance> may range from 1 to 2.

The Connections define the parameters to use in communication with the cloud.

Up to 2 Connections can be defined, with the Active Connection selecting which will be used.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Domain <value>¶

Domain may contain up to 63 characters.

The Domain specifies the Percepxion cloud host.

Local Port <value>¶

Blank the value for "<Random>".

The Local Port is random by default but can be overriden here.

Note: If you have bridging enabled, you will need to specify a non-random value here in order for Percepxion to operate correctly.

MQTT State <value>¶

MQTT State may be "Enabled" or "Disabled".

This controls whether Percepxion will use MQTT to communicate with the cloud.

Note: MQTT requires a persistent connection.

MQTT Local Port <value>¶

Blank the value for "<Random>".

The MQTT Local Port is random by default but can be overriden here.

Note: If you have bridging enabled, you will need to specify a non-random value here in order for Percepxion to operate correctly.

Config Percepxion Line level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the Percepxion managment platform.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

Project Tag <value>¶

Project Tag may contain up to 63 characters.

Status Update Interval <value>¶

Status Update Interval has units of minutes, hours, and/or days.

The Status Update Interval is the period of time that Percepxion waits between updating device status to the cloud.

The Status Update Interval can be configured between 10 minutes and 1 day (1440 minutes).

Content Check Interval <value>¶

Content Check Interval has units of hours, and/or days.

The Content Check Interval is the period of time that Percepxion waits between checking the cloud for updates to firmware and configuration.

The Content Check Interval can be configured between 1 hour and 90 days (2160 hours).

Config TLS Credential level¶

Manages certificates for TLS clients and servers.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

delete¶

Deletes this TLS Credential.

Protocols <value>¶

Protocols may contain combinations of "TLS1.0", "TLS1.1" or "TLS1.2".

TLS clients accept the combinations:

TLS1.0
TLS1.1
TLS1.2
TLS1.0, TLS1.1, TLS1.2

TLS servers accept the combinations:

TLS1.0
TLS1.1
TLS1.2
TLS1.1, TLS1.2
TLS1.0, TLS1.1, TLS1.2

Enterprise client accepts the combinations:

TLS1.0
TLS1.0, TLS1.1
TLS1.0, TLS1.1, TLS1.2

Application Layer Protocol <value>¶

Application Layer Protocol may contain up to 255 characters.

TLS clients send this optional Application Layer Protocol (ALP) name to the server in the Client Hello message.

Ciphers¶

Enters the "config TLS Credential Ciphers" Command level.

Private Key¶

Private Key may contain up to 4000 characters.

The CLI will prompt "Enter Private Key, <escape> terminates: ". The value will not be echoed. To remove a configured value, just <escape>.

The Private Key is input and stored in PEM format.

Certificate¶

Certificate may contain up to 4000 characters.

The CLI will prompt "Enter Certificate, <escape> terminates: ". The value will not be echoed. To remove a configured value, just <escape>.

The Certificate is input and stored in PEM format.

Higher Authority <instance>¶

Enters the selected "config TLS Credential Higher Authority" Command level.

<instance> may range from 1 to 3.

Trusted Authority <instance>¶

Enters the selected "config TLS Credential Trusted Authority" Command level.

<instance> may range from 1 to 5.

Config TLS Credential Ciphers level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

TLS ECDHE ECDSA WITH AES 256 GCM SHA384 <value>¶

TLS ECDHE ECDSA WITH AES 256 GCM SHA384 may be "Enabled" or "Disabled".

TLS ECDHE RSA WITH AES 256 GCM SHA384 <value>¶

TLS ECDHE RSA WITH AES 256 GCM SHA384 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 256 CCM16 <value>¶

TLS ECDHE ECDSA WITH AES 256 CCM16 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 256 CBC SHA384 <value>¶

TLS ECDHE ECDSA WITH AES 256 CBC SHA384 may be "Enabled" or "Disabled".

TLS ECDHE RSA WITH AES 256 CBC SHA384 <value>¶

TLS ECDHE RSA WITH AES 256 CBC SHA384 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 256 CBC SHA-1 <value>¶

TLS ECDHE ECDSA WITH AES 256 CBC SHA-1 may be "Enabled" or "Disabled".

TLS ECDHE RSA WITH AES 256 CBC SHA-1 <value>¶

TLS ECDHE RSA WITH AES 256 CBC SHA-1 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 256 CCM8 <value>¶

TLS ECDHE ECDSA WITH AES 256 CCM8 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 128 GCM SHA256 <value>¶

TLS ECDHE ECDSA WITH AES 128 GCM SHA256 may be "Enabled" or "Disabled".

TLS ECDHE RSA WITH AES 128 GCM SHA256 <value>¶

TLS ECDHE RSA WITH AES 128 GCM SHA256 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 128 CCM16 <value>¶

TLS ECDHE ECDSA WITH AES 128 CCM16 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 128 CBC SHA256 <value>¶

TLS ECDHE ECDSA WITH AES 128 CBC SHA256 may be "Enabled" or "Disabled".

TLS ECDHE RSA WITH AES 128 CBC SHA256 <value>¶

TLS ECDHE RSA WITH AES 128 CBC SHA256 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 128 CBC SHA-1 <value>¶

TLS ECDHE ECDSA WITH AES 128 CBC SHA-1 may be "Enabled" or "Disabled".

TLS ECDHE RSA WITH AES 128 CBC SHA-1 <value>¶

TLS ECDHE RSA WITH AES 128 CBC SHA-1 may be "Enabled" or "Disabled".

TLS ECDHE ECDSA WITH AES 128 CCM8 <value>¶

TLS ECDHE ECDSA WITH AES 128 CCM8 may be "Enabled" or "Disabled".

TLS RSA WITH AES 256 GCM SHA384 <value>¶

TLS RSA WITH AES 256 GCM SHA384 may be "Enabled" or "Disabled".

TLS RSA WITH AES 256 CCM16 <value>¶

TLS RSA WITH AES 256 CCM16 may be "Enabled" or "Disabled".

TLS RSA WITH AES 256 CBC SHA256 <value>¶

TLS RSA WITH AES 256 CBC SHA256 may be "Enabled" or "Disabled".

TLS RSA WITH AES 256 CBC SHA-1 <value>¶

TLS RSA WITH AES 256 CBC SHA-1 may be "Enabled" or "Disabled".

TLS ECDH RSA WITH AES 256 GCM SHA384 <value>¶

TLS ECDH RSA WITH AES 256 GCM SHA384 may be "Enabled" or "Disabled".

TLS ECDH RSA WITH AES 256 CBC SHA384 <value>¶

TLS ECDH RSA WITH AES 256 CBC SHA384 may be "Enabled" or "Disabled".

TLS ECDH RSA WITH AES 256 CBC SHA-1 <value>¶

TLS ECDH RSA WITH AES 256 CBC SHA-1 may be "Enabled" or "Disabled".

TLS ECDH ECDSA WITH AES 256 GCM SHA384 <value>¶

TLS ECDH ECDSA WITH AES 256 GCM SHA384 may be "Enabled" or "Disabled".

TLS ECDH ECDSA WITH AES 256 CBC SHA384 <value>¶

TLS ECDH ECDSA WITH AES 256 CBC SHA384 may be "Enabled" or "Disabled".

TLS ECDH ECDSA WITH AES 256 CBC SHA-1 <value>¶

TLS ECDH ECDSA WITH AES 256 CBC SHA-1 may be "Enabled" or "Disabled".

TLS RSA WITH AES 256 CCM8 <value>¶

TLS RSA WITH AES 256 CCM8 may be "Enabled" or "Disabled".

TLS RSA WITH AES 128 GCM SHA256 <value>¶

TLS RSA WITH AES 128 GCM SHA256 may be "Enabled" or "Disabled".

TLS RSA WITH AES 128 CCM16 <value>¶

TLS RSA WITH AES 128 CCM16 may be "Enabled" or "Disabled".

TLS RSA WITH AES 128 CBC SHA256 <value>¶

TLS RSA WITH AES 128 CBC SHA256 may be "Enabled" or "Disabled".

TLS RSA WITH AES 128 CBC SHA-1 <value>¶

TLS RSA WITH AES 128 CBC SHA-1 may be "Enabled" or "Disabled".

TLS ECDH RSA WITH AES 128 GCM SHA256 <value>¶

TLS ECDH RSA WITH AES 128 GCM SHA256 may be "Enabled" or "Disabled".

TLS ECDH RSA WITH AES 128 CBC SHA256 <value>¶

TLS ECDH RSA WITH AES 128 CBC SHA256 may be "Enabled" or "Disabled".

TLS ECDH RSA WITH AES 128 CBC SHA-1 <value>¶

TLS ECDH RSA WITH AES 128 CBC SHA-1 may be "Enabled" or "Disabled".

TLS ECDH ECDSA WITH AES 128 GCM SHA256 <value>¶

TLS ECDH ECDSA WITH AES 128 GCM SHA256 may be "Enabled" or "Disabled".

TLS ECDH ECDSA WITH AES 128 CBC SHA256 <value>¶

TLS ECDH ECDSA WITH AES 128 CBC SHA256 may be "Enabled" or "Disabled".

TLS ECDH ECDSA WITH AES 128 CBC SHA-1 <value>¶

TLS ECDH ECDSA WITH AES 128 CBC SHA-1 may be "Enabled" or "Disabled".

TLS RSA WITH AES 128 CCM8 <value>¶

TLS RSA WITH AES 128 CCM8 may be "Enabled" or "Disabled".

Config TLS Credential Higher Authority level¶

<instance> may range from 1 to 3.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Certificate¶

Certificate may contain up to 4000 characters.

The CLI will prompt "Enter Certificate, <escape> terminates: ". The value will not be echoed. To remove a configured value, just <escape>.

The Certificate is input and stored in PEM format.

When an incoming connection is attempted, the TLS Server will present Higher Authority certificates in its signing chain.

Config TLS Credential Trusted Authority level¶

<instance> may range from 1 to 5.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Certificate¶

Certificate may contain up to 4000 characters.

The CLI will prompt "Enter Certificate, <escape> terminates: ". The value will not be echoed. To remove a configured value, just <escape>.

The Certificate is input and stored in PEM format.

TLS Client will accept a server presenting any of these Trusted Authority certificates.

Mutual Authentication
If any Trusted Authority certificate is present, TLS Server will require clients to match; otherwise clients are unrestricted.

Config SNMP level¶

These configurables are for Simple Network Management Protocol (SNMP) Agent which implements SNMPv2c and is compatible with SNMPv1.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

State, if "Enabled", allows the SNMP agent on the listen network. By default it is set "Disabled".

Listen Interface <value>¶

Listen Interface may be "ap0", "eth0" or "wlan0".

Community Read¶

Community Read may contain up to 64 characters.

The CLI will prompt "Enter Community Read: ". The value will not be echoed.

Community Read is a string value to read the SNMP variables. By default it is set to "public".

Community Write¶

Community Write may contain up to 64 characters.

The CLI will prompt "Enter Community Write: ". The value will not be echoed.

Community Write is a string value to write the SNMP variables. By default it is set to "private".

System Contact <value>¶

System Contact may contain up to 64 characters.

System Name <value>¶

System Name may contain up to 64 characters.

System Description <value>¶

System Description may contain up to 64 characters.

System Location <value>¶

System Location may contain up to 64 characters.

Traps¶

Enters the "config SNMP Traps" Command level.

Extended Agent¶

Enters the "config SNMP Extended Agent" Command level.

Config SNMP Traps level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

Traps State, if "Enabled", allows the SNMP Agent to send predefined traps to specified destinations. By default it is set "Disabled".

Primary Destination <value>¶

Primary Destination may contain up to 64 characters.

Secondary Destination <value>¶

Secondary Destination may contain up to 64 characters.

Config Tunnel level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Accept¶

Enters the "config Tunnel Accept" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

Tunnel Accept controls how a tunnel behaves when a connection attempt originates from the network.

Line¶

Enters the "config Tunnel Line" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

The Line Configuration applies to the Serial Line interface.

Connect¶

Enters the "config Tunnel Connect" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

Tunnel Connect controls how a tunnel behaves when a connection attempt originates locally.

Disconnect¶

Enters the "config Tunnel Disconnect" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings relate to Disconnecting a Tunnel.

Packing¶

Enters the "config Tunnel Packing" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

When Tunneling, instead of sending data on the network immediately after being read on the Serial Line, the data can be Packed (queued) and sent in larger chunks.

Config Tunnel Accept level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

Tunnel Accept controls how a tunnel behaves when a connection attempt originates from the network.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disable", "Always", "Any Character", "Start Character" or "Modem Control Asserted".

An Accept Tunnel can be started in a number of ways, according to its Mode:

"Disabled": never started.

"Always": always started.

"Any Character": started when any character is read on the Serial Line.

"Start Character": started when the Start Character is read on the Serial Line.

"Modem Control Asserted": started when the Modem Control pin is asserted on the Serial Line.

Local Port <value>¶

Blank the value for "<None>".

Local Port is required for the Tunnel to accept a connection.

Multiple Connections <value>¶

Multiple Connections may be "Enabled" or "Disabled".

Enable Multiple Connections to allow up to 4 connections. This can be useful if the network side is only receiving data.

Disable Multiple Connections for applications requiring sequential access. This is normally required if the network side is sending data.

Protocol <value>¶

Protocol may be "TCP" or "TLS".

Credential <value>¶

Credential may contain up to 30 characters.

The Credential named here must belong to the selected Protocol.

Configure the named Credential on its separate page. A Credential typically contains whatever keys, certificates, passwords, or usernames that are required for connection using the selected Protocol.

Start Character <value>¶

Start Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

When the Start Character is received on the Serial Line, it enables the tunnel to listen for a network connection.

Flush Start Character <value>¶

Flush Start Character may be "Enabled" or "Disabled".

"Enabled" prevents forwarding of a start character from the Line into the network.

"Disabled" allows forwarding of a start character from the Line into the network.

Flush Line <value>¶

Flush Line may be "Enabled" or "Disabled".

Flush Line applies at the time when a connection is accepted from the network.

"Enabled" means any buffered characters from the Serial Line will be discarded when a connection is accepted.

"Disabled" means any characters received on the Serial Line will be buffered and sent after a connection is accepted.

Block Line <value>¶

Block Line may be "Enabled" or "Disabled".

"Enabled" (the debug setting) means incoming characters from the Serial Line will NOT be forwarded to the network. Instead, they will be buffered and will eventually flow off the Serial Line if hardware or software flow control is configured.

"Disabled" (the normal setting) means incoming characters from the Serial Line are sent on into the network. Any buffered characters are sent first.

Block Network <value>¶

Block Network may be "Enabled" or "Disabled".

"Enabled" (the debug setting) means incoming characters from the network will NOT be forwarded to the Serial Line. Instead, they will be buffered and will eventually flow off the network side.

"Disabled" (the normal setting) means incoming characters from the network are sent on into the Serial Line. Any buffered characters are sent first.

Password¶

Password may contain up to 31 characters.

The CLI will prompt "Enter Password: ". The value will not be echoed.

The Password must contain only alphanumeric characters and punctuation. When set, clients must send the correct password string to the unit within 30 seconds from opening network connection in order to enable data transmission. The password sent to the unit must be terminated with one of the following:

0A (Line Feed)
00 (Null)
0D 0A (Carriage Return / Line Feed)
0D 00 (Carriage Return / Null)

If Prompt for Password is "Enabled", the user will be prompted for the password upon connection.

Prompt for Password <value>¶

Prompt for Password may be "Enabled" or "Disabled".

Config Tunnel Line level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

The Line Configuration applies to the Serial Line interface.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

DTR <value>¶

DTR may be "Asserted while connected", "Continuously asserted" or "Unasserted".

The DTR options select the conditions in which the Data Terminal Ready control signal on the Serial Line is asserted.

"Asserted while connected" causes DTR to be asserted whenever either a connect or an accept mode tunnel connection is active.

Config Tunnel Connect level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

Tunnel Connect controls how a tunnel behaves when a connection attempt originates locally.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disable", "Always", "Any Character", "Start Character" or "Modem Control Asserted".

A Connect Tunnel can be started in a number of ways, according to its Mode:

"Disabled": never started.

"Always": always started.

"Any Character": started when any character is read on the Serial Line.

"Start Character": started when the Start Character is read on the Serial Line.

"Modem Control Asserted": started when the Modem Control pin is asserted on the Serial Line.

Start Character <value>¶

Start Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

When the Start Character is received on the Serial Line, it connects the tunnel.

Flush Start Character <value>¶

Flush Start Character may be "Enabled" or "Disabled".

"Enabled" prevents forwarding of a start character from the Line into the network.

"Disabled" allows forwarding of a start character from the Line into the network.

Host <instance>¶

Enters the selected "config Tunnel Connect Host" Command level.

<instance> may range from 1 to 4.

Connections <value>¶

Connections may be "Sequential", "Simultaneous" or "Round-Robin".

Connections controls how multiple hosts shall be used with a Connect Tunnel.

"Sequential" means the tunnel will start with host 1 and attempt each host in sequence until a connection is accepted.

"Simultaneous" means the tunnel will connect to all of the hosts that accept a connection.

"Round-Robin" means the tunnel connection attempts start with the host after whichever host had previously connected.

Reconnect Time <value>¶

Reconnect Time has units of seconds, minutes, and/or hours.

Enter 0 for "<Disabled>".

The Reconnect Time specifies how long to wait before trying to reconnect to the remote host after a previous attempt failed or the connection was closed.

Blank the display field to restore the default.

Flush Line <value>¶

Flush Line may be "Enabled" or "Disabled".

Flush Line applies at the time when a connection is established to the network.

"Enabled" means any buffered characters from the Serial Line will be discarded when a connection is established.

"Disabled" means any characters received on the Serial Line will be buffered and sent after a connection is established.

Block Line <value>¶

Block Line may be "Enabled" or "Disabled".

"Enabled" (the debug setting) means incoming characters from the Serial Line will NOT be forwarded to the network. Instead, they will be buffered and will eventually flow off the Serial Line if hardware or software flow control is configured.

"Disabled" (the normal setting) means incoming characters from the Serial Line are sent on into the network. Any buffered characters are sent first.

Block Network <value>¶

Block Network may be "Enabled" or "Disabled".

"Enabled" (the debug setting) means incoming characters from the network will NOT be forwarded to the Serial Line. Instead, they will be buffered and will eventually flow off the network side.

"Disabled" (the normal setting) means incoming characters from the network are sent on into the Serial Line. Any buffered characters are sent first.

Config Tunnel Connect Host level¶

<instance> may range from 1 to 4.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Address <value>¶

Address may contain up to 50 characters.

The Host Address is required to enable a Connect Tunnel.

It designates the address of the remote host to connect to.

Either a DNS address or an IP address may be provided.

If your Protocol is UDP based and you want to listen rather than connect: Leave Host Port set to <None> and set Host Address to the Interface name you want to listen to ("eth0", "ap0" or "wlan0").

Port <value>¶

Blank the value for "<None>".

The Host Port is required to enable a Connect Tunnel.

It designates the TCP or UDP port on the remote host to connect to.

Protocol <value>¶

Protocol may be "TCP", "TLS" or "UDP".

Credential <value>¶

Credential may contain up to 30 characters.

The Credential named here must belong to the selected Protocol.

Configure the named Credential on its seperate page. A Credential typically contains whatever keys, certificates, passwords, or usernames that are required for connection using the selected Protocol.

Initial Send <value>¶

Initial Send may contain up to 32 characters.

The Initial Send string, if present, is sent out the network before any other data when the connection is established.

Local Port <value>¶

Blank the value for "<Random>".

The Local Port is by default random but can be overridden.

Note that a non-random Local Port is required for operation over a bridged interface.

Reception <value>¶

Reception may be "Restricted" or "Unrestricted".

"Restricted" will discard any received UDP packets whose from address and port do not match the designated Host Address and Port. In UDP listen mode, the remote address and port of the first received packet are taken as designated until the socket is closed.

"Unrestricted" accepts any UDP packets directed to the Local Port regardless of where they came from.

Config Tunnel Disconnect level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings relate to Disconnecting a Tunnel.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Stop Character <value>¶

Stop Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

When the Stop Character is received on the Serial Line, it disconnects the tunnel.

Disable the Stop Character by blanking the field to set it to <None>.

Flush Stop Character <value>¶

Flush Stop Character may be "Enabled" or "Disabled".

"Enabled" prevents forwarding of a stop character from the Line into the network.

"Disabled" allows forwarding of a stop character from the Line into the network.

Modem Control <value>¶

Modem Control may be "Enabled" or "Disabled".

"Enabled" means disconnect when the Modem Control pin is not asserted on the Serial Line.

Timeout <value>¶

Timeout has units of milliseconds.

Blank the value for "<Disabled>".

Timeout enables disconnect after the tunnel is idle for a specified number of milliseconds.

Flush Line <value>¶

Flush Line may be "Enabled" or "Disabled".

"Enabled" means flush the Serial Line when the Tunnel is disconnected.

Exclusive <value>¶

Exclusive may be "Enabled" or "Disabled".

When "Enabled", prevents more than one Tunnel connection at a time. This stops Tunnel Accept from listening while a Tunnel Connect is active. Tunnel Connect will not make a connection while a Tunnel Accept is connected.

Config Tunnel Packing level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

When Tunneling, instead of sending data on the network immediately after being read on the Serial Line, the data can be Packed (queued) and sent in larger chunks.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disable", "Timeout" or "Send Character".

"Disable" means data is not packed.

"Timeout" means data is sent only after a timeout occurs.

"Send Character" means data is sent when the Send Character is read on the Serial Line.

Timeout <value>¶

Timeout has units of milliseconds.

If the oldest byte of queued data has been waiting for Timeout milliseconds, the queued data will be sent on the network immediately.

Threshold <value>¶

Threshold has units of bytes.

If the number of bytes of queued data reaches the Threshold, the queued data will be sent on the network immediately.

Flush While Unconnected <value>¶

Flush While Unconnected may be "Enabled" or "Disabled".

"Enabled" keeps the packing buffer empty while there is no network connection.

"Disabled" means characters can accumulate in the packing buffer when there is no network connection.

Send Character <value>¶

Send Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

If used, the Send Character is a single printable character or a control character that, when read on the Serial Line, forces the queued data to be sent on the network immediately.

Flush Send Character <value>¶

Flush Send Character may be "Enabled" or "Disabled".

"Enabled" means the Send Character will NOT be sent from the Serial Line to the network.

"Disabled" means the Send Character WILL be forwarded from the Serial Line to the network.

Trailing Character <value>¶

Trailing Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

The Trailing Character is an optional single printable character or control character that is injected into the outgoing data stream right after the Send Character.

Disable the Trailing Character by blanking the field to set it to <None>.

Config USB Device level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Deletes this Custom Item.

Value <value>¶

Value may contain up to 63 characters.

Sets a custom configurable text Value of an Item. The Item <instance> is the name of this value.

File System level¶

stat [file]¶

Displays file or file system statistics

cat <file>¶

Displays file

cd <path>¶

Changes current directory

cp <source> <destination>¶

Copies a file

hexdump <file>¶

Displays file in hexadecimal format

ls [path]¶

Lists files and directories in specified directory

mkdir <directory>¶

Creates a directory

mv <source> <destination>¶

Renames a file or directory

pwd¶

Prints current working directory

rm <file>¶

Removes a file

rmdir <directory>¶

Removes a directory

tree [path]¶

Shows all files and directories from specified directory down

upload [-a] <filename>¶

Uploads file over CLI; -a appends to existing file

exit¶

Returns to the root Command level.

Status level¶

exit¶

Returns to the root Command level.

Access Point¶

Enters the "status Access Point" Command level.

<instance> must be "ap0".

This shows status of an Access Point on the device.

BLE¶

Enters the "status BLE" Command level.

BLE Beacon Scanner <instance>¶

Enters the selected "status BLE Beacon Scanner" Command level.

<instance> must be "1".

Clock¶

Enters the "status Clock" Command level.

This shows the current time.

If the time source is "Manual", the time can be set here as well.

CPM¶

Enters the "status CPM" Command level.

Device¶

Enters the "status Device" Command level.

This displays the current status of the Device.

Diagnostics¶

Enters the "status Diagnostics" Command level.

Ethernet¶

Enters the "status Ethernet" Command level.

<instance> must be "eth0".

This shows status of an Ethernet link on the device.

File System¶

Enters the "status File System" Command level.

This displays various statistics and current usage information of the flash File System.

Compliance¶

Enters the "status Compliance" Command level.

HTTP Server¶

Enters the "status HTTP Server" Command level.

This displays the current status for the HTTP Server.

Interface Counters <instance>¶

Enters the selected "status Interface Counters" Command level.

<instance> may be "ap0", "eth0" or "wlan0".

Interface <instance>¶

Enters the selected "status Interface" Command level.

<instance> may be "ap0", "eth0" or "wlan0".

This shows the status of the network Interface on the device.

When DHCP fails to discover an IP Address, a new address will automatically be generated using AutoIP. This address will be within the 169.254.x.x space. ap0 will always use the assigned static IP.

Line <instance>¶

Enters the selected "status Line" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the current status and various statistics for the Serial Line.

Radio¶

Enters the "status Radio" Command level.

These settings pertain to the Radio.

Any change to these settings requires a reboot to take effect.

WLAN¶

Enters the "status WLAN" Command level.

<instance> must be "wlan0".

This shows status of a WLAN Link on the device.

Bridge¶

Enters the "status Bridge" Command level.

This displays the current Bridge Status.

Bridged Devices¶

Enters the "status Bridged Devices" Command level.

CLI Server¶

Enters the "status CLI Server" Command level.

This displays current status for the CLI Server.

Discovery <instance>¶

Enters the selected "status Discovery" Command level.

<instance> may be "ap0", "eth0" or "wlan0".

This shows statistics for the Discovery service on the selected Interface.

MQTT <instance>¶

Enters the selected "status MQTT" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the MQTT Status.

LPD <instance>¶

Enters the selected "status LPD" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This shows various statistics and current usage information of the Line Printer Daemon (LPD) subsystem.

When a document is printed, the remote client information is displayed as well as the number of print jobs printed since boot up, and the total number of bytes printed.

Modbus <instance>¶

Enters the selected "status Modbus" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the current connection status of the Modbus server listening on the TCP port.

Local Slave displays PDU counters for Modbus CP pins.

When a connection is active, the remote client information is displayed as well as the number of PDUs that have been sent and received.

Modem Emulation <instance>¶

Enters the selected "status Modem Emulation" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the current Modem Emulation Status.

Though settings are initialized according to their configuration, they may be changed by "AT" commands over the Serial Line.

NTP¶

Enters the "status NTP" Command level.

This shows statistics from the last successful NTP server synchronization.

Percepxion¶

Enters the "status Percepxion" Command level.

This shows the Percepxion status, including the last time that the status was updated, the last time that Percepxion checked for updates to configuration and firmware, and what updates are available.

TLS Credential <instance>¶

Enters the selected "status TLS Credential" Command level.

This displays contents of current certificates in the TLS Credential.

SNMP¶

Enters the "status SNMP" Command level.

This shows statistics from Simple Network Mnagement Protocol (SNMP) Agent which implements SNMPv2c and is compatible with SNMPv1.

Tunnel <instance>¶

Enters the selected "status Tunnel" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays all the Tunnel Status both as an Aggregate and broken down by active Accept and Connect tunnels.

Custom¶

Enters the "status Custom" Command level.

Changes counts the number of times any custom group is saved.

Status Access Point level¶

<instance> must be "ap0".

This shows status of an Access Point on the device.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status BLE level¶

exit¶

Returns to the previous level.

Operation¶

Enters the "status BLE Operation" Command level.

Nearby Devices¶

Enters the "status BLE Nearby Devices" Command level.

Status BLE Operation level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Connected Device <instance>¶

Enters the selected "status BLE Operation Connected Device" Command level.

<instance> may range from 1 to 7.

Disconnect <Device_Address>¶

No help available.

Additional Logging <0|1|2|3|4>¶

No help available.

Status BLE Operation Connected Device level¶

<instance> may range from 1 to 7.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

This shows the current time.

If the time source is "Manual", the time can be set here as well.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Current Time <YYYY-MM-DD hhss>¶

The format for setting time is YYYY-MM-DD hhss, where the hours are in 24-hour format.

Status CPM level¶

exit¶

Returns to the previous level.

CPs¶

Enters the "status CPM CPs" Command level.

This displays the current status of the Configurable Pins.

It also allows control of Configurable Pins that are not active in a Group.

Roles¶

Enters the "status CPM Roles" Command level.

This displays the current status of the Configurable Pin Roles.

Status CPM CPs level¶

This displays the current status of the Configurable Pins.

It also allows control of Configurable Pins that are not active in a Group.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

CP <instance>¶

Enters the selected "status CPM CPs CP" Command level.

<instance> may range from 1 to 12.

Status CPM CPs CP level¶

<instance> may range from 1 to 12.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Usage <value>¶

<value> may be "Input", "Output" or "Unused".

Assert <value>¶

<value> may be "High" or "Low".

Assert reflects the logical polarity of this Configurable Pin.

"High" means that a logical "1" corresponds to a voltage high condition on the pin.

"Low" means that a logical "1" corresponds to a voltage low condition on the pin.

Value <value>¶

<value> may be "0" or "1".

Value is the logical value of the Configurable Pin. Its polarity depends on Assert.

"1" represents the "Asserted" state, "0" represents "Not asserted".

Read¶

No help available.

Status CPM Roles level¶

This displays the current status of the Configurable Pin Roles.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Role <instance>¶

Enters the selected "status CPM Roles Role" Command level.

The available Role instances are as follows:

"AP Trigger" turns on ap0 if Mode is "Triggered", "Initial Trigger", or "Controlled".

"Ethernet Link" is Link UP while eth0 is up.

"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

"Modbus Input 1" can be read by Modbus TCP.

"Modbus Input 2" can be read by Modbus TCP.

"Modbus Input 3" can be read by Modbus TCP.

"Modbus Input 4" can be read by Modbus TCP.

"Modbus Output 1" can be written by Modbus TCP.

"Modbus Output 2" can be written by Modbus TCP.

"Modbus Output 3" can be written by Modbus TCP.

"Modbus Output 4" can be written by Modbus TCP.

"Radio Trigger" turns on radio if Mode is "Triggered".

"User Data Updated" is active when user data changes, till Acknowledge action.

"WLAN Active" is active while wlan0 is up.

Status CPM Roles Role level¶

The available Role instances are as follows:

"AP Trigger" turns on ap0 if Mode is "Triggered", "Initial Trigger", or "Controlled".

"Ethernet Link" is Link UP while eth0 is up.

"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

"Modbus Input 1" can be read by Modbus TCP.

"Modbus Input 2" can be read by Modbus TCP.

"Modbus Input 3" can be read by Modbus TCP.

"Modbus Input 4" can be read by Modbus TCP.

"Modbus Output 1" can be written by Modbus TCP.

"Modbus Output 2" can be written by Modbus TCP.

"Modbus Output 3" can be written by Modbus TCP.

"Modbus Output 4" can be written by Modbus TCP.

"Radio Trigger" turns on radio if Mode is "Triggered".

"User Data Updated" is active when user data changes, till Acknowledge action.

"WLAN Active" is active while wlan0 is up.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

State <value>¶

<value> may be "Inactive" or "Active".

If an input role has no CP assigned, the State may be manipulated via the CLI or Web Manager.

Status Device level¶

This displays the current status of the Device.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

Firmware Upgrade¶

Uploads a firmware image.

exit¶

Returns to the previous level.

Save¶

The Save action works like the "write" command. Any cached configuration changes are committed, so they will apply after a reboot.

Without a Save, any cached configuration changes are lost after a reboot.

Reboot¶

The Reboot action shuts the device down and restarts it. Any cached configuration changes (those which have not been saved) are lost.

Factory Defaults¶

The Factory Defaults action restores the device configuration as it came from the factory. Any user changes to configuration are lost.

Status Diagnostics level¶

exit¶

Returns to the previous level.

Hardware¶

Enters the "status Diagnostics Hardware" Command level.

This displays Hardware identification and capabilities.

Heap¶

Enters the "status Diagnostics Heap" Command level.

This displays Heap usage, state, and statistics.

Kernel Heap¶

Enters the "status Diagnostics Kernel Heap" Command level.

This displays Kernel Heap usage, state, and statistics.

IP Sockets¶

Enters the "status Diagnostics IP Sockets" Command level.

This displays information for each IP Socket.

Modules¶

Enters the "status Diagnostics Modules" Command level.

This displays Modules present on the device and their static memory usage.

Ping¶

Enters the "status Diagnostics Ping" Command level.

Ports¶

Enters the "status Diagnostics Ports" Command level.

This displays current registered Ports and their service.

Threads¶

exit¶

Returns to the previous level.

IP Socket <instance>¶

Enters the selected "status Diagnostics IP Sockets IP Socket" Command level.

<instance> may range from 1 to 50.

Status Diagnostics IP Sockets IP Socket level¶

<instance> may range from 1 to 50.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Diagnostics Modules level¶

This displays Modules present on the device and their static memory usage.

auto show¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Port <instance>¶

Enters the selected "status Diagnostics Ports Port" Command level.

Status Diagnostics Ports Port level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Diagnostics Threads level¶

This displays current existing Threads and their stack usage.

auto show¶

show¶

Shows current status.

exit¶

Returns to the previous level.

Compact¶

Compact reorganizes data on the flash file system, recovering dirty space. File data is retained. Note that this happens automatically when attempting to write and no clean space is available, but dirty space is.

Format¶

Format clears out the flash file system, preserving only system configuration data. Be careful! All other files are destroyed.

Status Interface level¶

<instance> may be "ap0", "eth0" or "wlan0".

This shows the status of the network Interface on the device.

When DHCP fails to discover an IP Address, a new address will automatically be generated using AutoIP. This address will be within the 169.254.x.x space. ap0 will always use the assigned static IP.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Renew¶

The Renew action causes the device to drop its dynamic IP address and request an address from the DHCP server.

Current¶

Enters the "status Interface Current" Command level.

This shows the current Interface settings, which could be different after a reboot.

Status Interface Current level¶

This shows the current Interface settings, which could be different after a reboot.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Line level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the current status and various statistics for the Serial Line.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Command <value>¶

The Command action sends bytes to the Line and picks up bytes in response. The bytes are hex encoded.

Maximum number of characters to read (n) may be specified; default is unlimited.

Milliseconds total time limit (m) may be specified; default is 1000.

Terminating byte (t) may be specified; default is <None>.

Syntax of <value> is:
[n=<decimal number> ][m=<decimal number> ][t=<hex number> ]<hex bytes to send>

First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.

Receiver¶

Enters the "status Line Receiver" Command level.

Transmitter¶

Enters the "status Line Transmitter" Command level.

Signals¶

Enters the "status Line Signals" Command level.

Settings¶

Enters the "status Line Settings" Command level.

Status Line Receiver level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Receive¶

The Receive action picks up characters from the Line.

First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.

Hex Receive¶

The Hex Receive action picks up bytes from the Line.

First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.

Status Line Transmitter level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Transmit <value>¶

The Transmit action sends characters to the Line.

First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.

Hex Transmit <value>¶

The Hex Transmit action sends bytes to the Line.

Shows current status.

exit¶

Returns to the previous level.

Status WLAN level¶

<instance> must be "wlan0".

This shows status of a WLAN Link on the device.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Counters¶

Enters the "status WLAN Counters" Command level.

Directed scan <SSID>¶

Scans for WLAN devices matching the <SSID>.

Broadcast scan¶

Scans for all WLAN devices that allow guests.

Status WLAN Counters level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Bridge level¶

This displays the current Bridge Status.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Device <instance>¶

Enters the selected "status Bridged Devices Device" Command level.

Status Bridged Devices Device level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status CLI Server level¶

This displays current status for the CLI Server.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This shows various statistics and current usage information of the Line Printer Daemon (LPD) subsystem.

When a document is printed, the remote client information is displayed as well as the number of print jobs printed since boot up, and the total number of bytes printed.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Kill¶

The Kill action will force the LPD server to kill (abort) any current, active print jobs.

Test Print <number of lines>¶

The Test Print action queues a job to the LPD line. Parameter <number of lines> specifies the number of test lines to be printed.

Status Modbus level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the current connection status of the Modbus server listening on the TCP port.

Local Slave displays PDU counters for Modbus CP pins.

When a connection is active, the remote client information is displayed as well as the number of PDUs that have been sent and received.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

TCP Server¶

Enters the "status Modbus TCP Server" Command level.

Status Modbus TCP Server level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Modem Emulation level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the current Modem Emulation Status.

Though settings are initialized according to their configuration, they may be changed by "AT" commands over the Serial Line.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Aggregate¶

Enters the "status Modem Emulation Aggregate" Command level.

Returns to the previous level.

Status¶

Enters the "status Percepxion Status" Command level.

<instance> must be "Detail".

Available Update <instance>¶

Status SNMP level¶

This shows statistics from Simple Network Management Protocol (SNMP) Agent which implements SNMPv2c and is compatible with SNMPv1.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Tunnel level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays all the Tunnel Status both as an Aggregate and broken down by active Accept and Connect tunnels.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Aggregate¶

Enters the "status Tunnel Aggregate" Command level.

Current Connection <instance>¶

Enters the selected "status Tunnel Current Connection" Command level.

Possible instance names are "Accept" and "Connect <n>", where <n> is the Host number, for example "Connect 1".

Returns to the previous level.

Acknowledge¶

The Acknowledge action deasserts the "User Data Updated" CP until the next configuration change.

XML level¶

action documentation¶

Dumps help for product actions.

documentation¶

Dumps help for product configurables.

status documentation¶

Dumps help for product status.

xcr dump [group-list]¶

Dumps all XML configuration; stop with any character. Secret fields are shown without their values.

xcr settings [group-list]¶

Dumps only non-default XML configuration; stop with any character. Secret fields are shown without their values.

xsr dump [group-list]¶

Dumps XML status; stop with any character.

status <group>[:<group instance>]|<item>[:<item instance>][|<value name>]¶

Dumps a single selected status value.

exit¶

Returns to the root Command level.