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.
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.
Device¶
Enters the "config Device" Command level.
Restore default "Buffers" value by setting it blank.
After saving Device settings, a Reboot is required for them to take effect.
Bridge performance depends heavily on the number of buffers in the "Receive" Buffer Pool.
NOTE: Increasing the buffers will consume RAM. If the device has insufficient RAM for all of the configured applications, the device may not be able to operate normally; in this case, use serial recovery and erase Flash to back out the settings.
HINT: First complete all of your other settings, save, reboot, and run your applications for a while. Then, without rebooting, adjust the Buffers here in Device configuration.
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.
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. (Only 5 if wlan0 is enabled.)
Line_registration¶
Enters the "config Line_registration" Command level.
Line <instance>¶
Enters the selected "config Line" Command level.
<instance> may be "1", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "Virtual_1" or "Virtual_2".
These settings pertain to the Serial Line. Changes take effect immediately.
Power¶
Enters the "config Power" Command level.
These settings pertain to Power levels required by the device. Changes take effect immediately.
Radio¶
Enters the "config Radio" Command level.
These settings pertain to the Radio.
Any change to these settings requires a reboot to take effect.
SPI¶
Enters the "config SPI" Command level.
These settings pertain to the Serial Peripheral Interface (SPI) Bus Master device.
Most changes take effect immediately. However, if the device State has been "Enabled", then changing its Protocol or State may require a reboot.
NOTE: High speeds are only available when CS Active is "Low", Idle Clock Level is "Low", and Clock Edge is "First".
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.
IPv6 <instance>¶
Enters the selected "config IPv6" Command level.
<instance> may be "ap0", "eth0" or "wlan0".
AES Credential <instance>¶
Enters the selected "config AES Credential" Command level.
Creates <instance> if it does not already exist.
Each AES Credential holds a secret Encrypt Key and Decrypt Key for secure communication.
Azure¶
Enters the "config Azure" Command level.
These settings pertain to Azure IoT connection information.
Only one line can be assigned to the Azure IoT protocol.
Bluetooth¶
Enters the "config Bluetooth" Command level.
These settings pertain to Bluetooth.
Bluetooth_SPP¶
Enters the "config Bluetooth_SPP" Command level.
BLE Beacon Scanner <instance>¶
Enters the selected "config BLE Beacon Scanner" Command level.
<instance> may be "1", "SPP_1", "SPP_2", "SPP_3", "Virtual_1" or "Virtual_2".
These settings pertain to the BLE Beacon Scanner line protocol.
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.
Percepxion¶
Enters the "config Percepxion" Command level.
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).
GATT Server¶
Enters the "config GATT Server" Command level.
LPD <instance>¶
Enters the selected "config LPD" Command level.
<instance> must be "1".
These configurables are for the Line Printer Daemon (LPD).
Modbus <instance>¶
Enters the selected "config Modbus" Command level.
<instance> may be "1", "SPP_1", "SPP_2", "SPP_3", "HOST_CDC_ACM", "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", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "Virtual_1" or "Virtual_2".
Connections can be initiated and accepted using Modem "AT" commands incoming from the Serial Line.
Monitor¶
Enters the "config Monitor" Command level.
NTP¶
Enters the "config NTP" Command level.
These configurables are for Simple NTP (SNTP).
SNMP¶
Enters the "config SNMP" Command level.
These configurables are for Simple Network Management Protocol version 2 (SNMPv2) Agent.
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.
NOTE: Minimum accepted RSA key size is 2048 bits.
Tunnel <instance>¶
Enters the selected "config Tunnel" Command level.
<instance> may be "1", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "Virtual_1" or "Virtual_2".
USB Device¶
Enters the "config USB Device" Command level.
USB Host¶
Enters the "config USB Host" 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", "WPA" or "WPA2".
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.
Mode <value>¶
Mode may be "Always Up", "Triggered", "Initial Trigger" or "Initially Up".
"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.
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 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" or "Initial Trigger".
"GSPI Slave Interrupt" signals new data or space available.
"Ethernet Link" is Link UP while eth0 is up.
"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".
"Keep AWAKE" Input keep AWAKE CP role.
"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".
"SPI.CS" pin is used when SPI State is "Enabled".
"SPI.MISO" pin is used when SPI State is "Enabled".
"SPI.MOSI" pin is used when SPI State is "Enabled".
"SPI.SCK" pin is used when SPI State is "Enabled".
"USB Host Overcurrent" pin is used when USB Host State is "Enabled".
"USB Host Power Enabled" output active to enable power output to USB device.
"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" or "Initial Trigger".
"GSPI Slave Interrupt" signals new data or space available.
"Ethernet Link" is Link UP while eth0 is up.
"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".
"Keep AWAKE" Input keep AWAKE CP role.
"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".
"SPI.CS" pin is used when SPI State is "Enabled".
"SPI.MISO" pin is used when SPI State is "Enabled".
"SPI.MOSI" pin is used when SPI State is "Enabled".
"SPI.SCK" pin is used when SPI State is "Enabled".
"USB Host Overcurrent" pin is used when USB Host State is "Enabled".
"USB Host Power Enabled" output active to enable power output to USB device.
"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.
Mode <value>¶
Mode may be "Push-Pull" or "Weak Pullup".
For a high impedance input, select "Push-Pull".
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.
RMII Mode <value>¶
RMII Mode may be "PHY" or "Switch".
RMII Mode specifies what type of external device is attached to the RMII interface.
When in PHY mode, the RMII interface is connected to an external PHY. The PHY is managed over the MDIO bus, and the user can specify settings such as Speed and Duplex.
When in Switch mode, the RMII interface is connected to a port of an external switch chip in a MAC-to-MAC configuration. The RMII interface is forced to 100 Mbps with Full Duplex, and the MDIO bus is not used. The switch chip must have its side of the RMII interface strapped to 100 Mbps with Full Duplex.
PHY Address <value>¶
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.
Speed <value>¶
Speed may be "Auto", "10" or "100".
Duplex <value>¶
Duplex may be "Half" or "Full".
MDIO Logging <value>¶
MDIO Logging may be "Enabled" or "Disabled".
MDIO Logging is useful for debugging PHY configuration issues.
When Enabled, each access to PHY registers over the MDIO bus will be logged. Also, it will dump the first 32 PHY registers to the log every 15 seconds.
EAP Authentication <value>¶
EAP Authentication may be "Enabled" or "Disabled".
IEEE 8021X <value>¶
IEEE 8021X may be "EAP-TLS", "EAP-TTLS", "PEAP" or "FAST".
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", "PAP" or "EAP-MD5".
PEAP ver <value>¶
PEAP ver may be "0" or "1".
PEAP Option <value>¶
PEAP Option may be "EAP-MSCHAPV2", "EAP-MD5" or "EAP-TLS".
PEAP Credentials <value>¶
PEAP Credentials may contain up to 30 characters.
FAST Option <value>¶
FAST Option may be "MD5", "MSCHAPV2" or "GTC".
Config Filter level¶
<instance> may be "ap0", "eth0", "wlan0" or "lo0".
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Mode ¶
Mode may be "Disabled", "Allow listed only" or "Allow all except listed".
Device ¶
Enters the selected "config Filter Device" Command level.
<instance> may range from 1 to 20.
Config Filter Device level¶
<instance> may range from 1 to 20.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
MAC ¶
MAC may contain up to 6 bytes.
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.
Inactivity Timeout <value>¶
Inactivity Timeout has units of seconds, minutes, and/or hours.
The Inactivity Timeout applies only if the Application "HTTP Server" is enabled in the Power settings.
The HTTP Server will hold power on this long after it completes a request.
Access-Control-Allow-Origin <value>¶
Access-Control-Allow-Origin may contain up to 50 characters.
Access-Control-Allow-Origin is a newer security mechanism supported by some browsers. This feature is also referred to as CORS.
When blank (by default), CORS is disabled.
Set a name to enable CORS. Use "*" for wildcard, but beware this exposes the device to Cross-Site Request Forgery (CSRF).
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
"/wm/pkcs12_upload" Web Manager PKCS12 upload
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 "TLS 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. (Only 5 if wlan0 is enabled.)
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. See also Domain which is appended to the Hostname when sending to the remote DHCP Server.
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 and / or Default Gateway 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.
DHCP Server <value>¶
DHCP Server may be "Enabled" or "Disabled".
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.
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.
Domain <value>¶
Domain may contain up to 128 characters.
NOTE: A fully qualified domain name must end with a period, for example, "lantronix.com."; a partial Domain will not have a trailing"." and is not fully qualified.
If DHCP Client is "Enabled", it concatenates the Hostname with Domain and requests the DHCP server to update the DNS A and PTR RRs.
This setting is not applicable to ap0.
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.
IPv6 State <value>¶
IPv6 State may be "Enabled" or "Disabled".
DHCPv6 Client <value>¶
DHCPv6 Client may be "Enabled" or "Disabled".
DHCPv6_Client: Enables the stateful address autoconfiguration of IPv6 When it is enabled, device will start DHCPv6 client service & get the IPv6 address from the DHCPv6 serevr as per RFC-3315. (https://tools.ietf.org/html/rfc3315)
IPv6 Auto Configuration <value>¶
IPv6 Auto Configuration may be "Enabled" or "Disabled".
IPv6 Auto Configuration: Enables the stateless adddress autoconfiguration of IPv6 When it is enabled, device will generate its own IPv6b address from prefix in Router Advertisements & its MAC address as per RFC-4862 (https://tools.ietf.org/html/rfc4862)
IPv6 Address <value>¶
IPv6 Address may contain up to 42 characters.
IPv6 Address: The preferred form is x:x:x:x:x:x:x:x, where the 'x's are one to four hexadecimal digits of the eight 16-bit pieces of the address as per RFC-4291 (https://tools.ietf.org/html/rfc4291)
Examples: ABCD:EF01:2345:6789: ABCD:EF01:2345:6789, 2001:DB8:0:0:8:800:200C:417A
It supports compressed form of IPv6 Addresses
IPv6 Default Gateway <value>¶
IPv6 Default Gateway may contain up to 42 characters.
IPv6 Default Gateway: is used only if DHCPv6 Client is disabled, and provides the IPv6 Address of the router.
This setting is not applicable to ap0.
IPv6 Primary DNS <value>¶
IPv6 Primary DNS may contain up to 42 characters.
IPv6 Primary DNS: is the first choice when performing IPv6 Domain Name lookup.
This setting is not applicable to ap0.
IPv6 Secondary DNS <value>¶
IPv6 Secondary DNS may contain up to 42 characters.
IPv6 Secondary DNS: is the second choice when performing IPv6 Domain Name lookup.
This setting is not applicable to ap0.
DHCP IP Address Range¶
Enters the "config Interface DHCP IP Address Range" Command level.
Config Interface DHCP IP Address Range level¶
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Start <value>¶
Start may contain up to 15 characters.
Start is the lowest IP address that the DHCP server may assign.
End <value>¶
End may contain up to 15 characters.
End is the highest IP address that the DHCP server may assign.
Config Line_registration level¶
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Name <value>¶
Name may contain up to 15 characters.
Config Line level¶
<instance> may be "1", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "Virtual_1" or "Virtual_2".
These settings pertain to the Serial Line. Changes take effect immediately.
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 "Azure IoT", "BLE Beacon Scanner", "Command Line", "LPD", "Percepxion Interface", "Modbus ASCII", "Modbus RTU", "Modem Emulation", "Monitor", "Mux", "None", "Trouble Log" or "Tunnel".
Protocol selects the application to connect to the Line.
"Azure IoT" Azure IoT hub line protocol
"BLE Beacon Scanner" scans for BLE Beacons and outputs them on the 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.
"Percepxion Interface" provides a command interface to the Percepxion serial API.
"LPD" provides a Line Printer Daemon (LPD) serial port.
"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.
"Monitor" captures selected data.
"Mux" provides commands for sending / receiving data on multiple network connections.
"None" enables Line action commands.
"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.
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 Power level¶
These settings pertain to Power levels required by the device. Changes take effect immediately.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Dynamic Power Mode <value>¶
Dynamic Power Mode may be "Disabled" or "Standby".
"Disabled" prevents the device from powering down.
"Standby" powers down as much as is possible, including the CPU. System runtime state is not preserved.
Time Powered Up <value>¶
Time Powered Up has units of seconds, minutes, hours, and/or days.
The device holds power on for Time Powered Up duration.
After the Time Powered Up duration, power might continue to be held on for other reasons:
If WKUP Pin is "Level High", power will be held on as long as the WKUP level is high.
Any enabled Application can hold power on.
Application <instance>¶
Enters the selected "config Power Application" Command level.
If any Application is "Enabled", the application may hold power on longer or wake up sooner. This provides a mechanism to allow an application to be in an appropriate state for graceful shutdown.
"Command Line" holds power on till the last CLI user exits.
"HTTP Server" holds power up during each HTTP client operation and for a configurable time afterward.
"Keep AWAKE CP Role" holds power on till Keep AWAKE CP Role pin goes active.
"Tunnel Accept" holds power up while any Tunnel Accept connection is open.
"Tunnel Connect" holds power up while any Tunnel Connect connection is open.
WKUP Pin <value>¶
WKUP Pin may be "Disabled" or "Falling Edge".
WKUP Pin selects the role of the WKUP pin in powering up or staying up.
"Disabled" means the WKUP Pin is ignored. Power up will happen after Maximum Time Powered Down or earlier if called for by an enabled Application.
"Falling Edge" means the system will power up on the falling edge of WKUP. Power up can also happen after Maximum Time Powered Down or earlier if called for by an enabled Application.
Maximum Time Powered Down <value>¶
Maximum Time Powered Down has units of seconds, minutes, hours, and/or days.
The device wakes up after being down Maximum Time Powered Down.
The device may wake up earlier if WKUP Pin sees a "Falling Edge".
The device may also wake up earlier if called for by an enabled Application.
Config Power Application level¶
If any Application is "Enabled", the application may hold power on longer or wake up sooner. This provides a mechanism to allow an application to be in an appropriate state for graceful shutdown.
"Command Line" holds power on till the last CLI user exits.
"HTTP Server" holds power up during each HTTP client operation and for a configurable time afterward.
"Keep AWAKE CP Role" holds power on till Keep AWAKE CP Role pin goes active.
"Tunnel Accept" holds power up while any Tunnel Accept connection is open.
"Tunnel Connect" holds power up while any Tunnel Connect connection is open.
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 this Application to hold power on.
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.
NOTE: If Radio is disabled or not yet triggered, this inhibits both ap0 and wlan0 from operating.
Band <value>¶
Band may be "Dual", "2.4 GHz Only" or "5 GHz Only".
Selects the band on which the radio will operate.
NOTE: If the configured AP channel is not valid for the radio band, a valid channel will automatically be selected each time the AP is started.
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.
Antenna 1 Supports <value>¶
Antenna 1 Supports may be "WiFi" or "Bluetooth".
Keep Alive <value>¶
Keep Alive may be "Enabled" or "Disabled".
"Enabled" causes a Null-Function Data frame to be sent on wlan0 once per second 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>¶
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.
Scanning¶
Enters the "config Radio Scanning" 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".
Scan Period <value>¶
Scan Period has units of seconds and/or minutes.
Scan Period is the time between scans looking for a roaming candidate.
Band <instance>¶
Enters the selected "config Radio Roaming Band" Command level.
<instance> may be "2.4GHz" or "5GHz".
Config Radio Roaming Band level¶
<instance> may be "2.4GHz" or "5GHz".
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Trigger Delta <value>¶
Trigger Delta has units of dBm.
A device with RSSI Trigger Delta higher than the current Access Point is a roaming candidate.
RSSI Floor <value>¶
RSSI Floor is allowed to have negative values.
RSSI Floor has units of dBm.
When the signal drops below the RSSI Floor, the radio attempts to roam.
Config Radio Scanning level¶
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
RSSI Floor <value>¶
RSSI Floor is allowed to have negative values.
RSSI Floor has units of dBm.
When scanning, any signal below the RSSI Floor is omitted.
NOTE: Roaming will not see the omitted signals.
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 SPI level¶
These settings pertain to the Serial Peripheral Interface (SPI) Bus Master device.
Most changes take effect immediately. However, if the device State has been "Enabled", then changing its Protocol or State may require a reboot.
NOTE: High speeds are only available when CS Active is "Low", Idle Clock Level is "Low", and Clock Edge is "First".
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.
State <value>¶
State may be "Enabled" or "Disabled".
"Enabled" enables the SPI.
"Disabled" disables the SPI.
Changing State from "Enabled" to "Disabled" requires a reboot.
Protocol <value>¶
Protocol may be "Monitor" or "None".
Protocol selects the application to connect to the SPI.
Changing the Protocol of a device requires a reboot only if the device State has been "Enabled" at least once since boot.
"Monitor" captures selected data.
Target Speed <value>¶
Target Speed has units of Hz.
Blank the value for "<Minimum>".
Target Speed selects the target clock speed of the SPI.
The Target Speed may be lowered to the closest Operating Speed capability of the device. If so, a warning will be noted.
CS Active <value>¶
CS Active may be "Low" or "High".
CS Active controls the polarity of the SPI Chip Select.
"Low" means CS will idle at a high level and be active when low.
"High" means CS will idle at a low level and be active when high.
Idle Clock Level <value>¶
Idle Clock Level may be "Low" or "High".
Idle Clock Level, also known as Clock Polarity or CPOL, selects the level of the clock when idle:
"Low" means the idle clock is at a low level. This is equivalent to CPOL=0.
"High" means the idle clock is at a high level. This is equivalent to CPOL=1.
Clock Edge <value>¶
Clock Edge may be "First" or "Second".
Clock Edge, also known as Clock Phase or CPHA, selects the clock edge for latching data:
"First" means each bit is latched on the first edge of the clock. This is equivalent to CPHA=0. When Idle Clock Level is "Low", data is latched on the rising edge. When Idle Clock Level is "High", data is latched on the falling edge.
"Second" means each bit is latched on the second edge of the clock. This is equivalent to CPHA=1. When Idle Clock Level is "Low", data is latched on the falling edge. When Idle Clock Level is "High", data is latched on the rising edge.
Bits Per Word <value>¶
Bits Per Word may be "8" or "16".
Bits Per Word selects the number of bits per word of transfer.
First Transfer <value>¶
First Transfer may be "Most Significant Bit" or "Least Significant Bit".
First Transfer selects the first transfer bit of each word.
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".
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", "WEP", "WPA", "WPA2", or "WPA3".
Suite "WPA3" with Authentication "8021X" (Enterprise) operates in Transition mode only.
WEP¶
Enters the "config WLAN Profile Security WEP" Command level.
WPAx¶
Enters the "config WLAN Profile Security WPAx" Command level.
Config WLAN Profile Security WEP 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.
Key Size <value>¶
Key Size may be "40" or "104".
Key Size is in bits.
TX Key Index <value>¶
TX Key Index may be "1", "2", "3" or "4".
Key <instance>¶
Enters the selected "config WLAN Profile Security WEP Key" Command level.
<instance> may range from 1 to 4.
Config WLAN Profile Security WEP Key level¶
<instance> may range from 1 to 4.
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.
Key <value>¶
Key may contain up to 13 bytes.
Set the Key value in hex, 5 or 13 bytes according to Key Size 40 or 104 bits respectively.
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.
Authentication <value>¶
Authentication may be "PSK" or "8021X".
IEEE 80211r <value>¶
IEEE 80211r may be "Enabled" or "Disabled".
Roam over DS <value>¶
Roam over DS may be "Enabled" or "Disabled".
Key Type <value>¶
Key Type may be "Passphrase" or "Hex".
Passphrase¶
Passphrase may contain up to 63 characters.
The CLI will prompt "Enter Passphrase: ". The value will not be echoed.
Key <value>¶
Key may contain up to 32 bytes.
Set the Key value in hex.
IEEE 8021X <value>¶
IEEE 8021X may be "EAP-TLS", "EAP-TTLS", "PEAP", "FAST" or "LEAP".
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", "PAP" or "EAP-MD5".
PEAP ver <value>¶
PEAP ver may be "0" or "1".
PEAP Option <value>¶
PEAP Option may be "EAP-MSCHAPV2", "EAP-MD5" or "EAP-TLS".
PEAP Credentials <value>¶
PEAP Credentials may contain up to 30 characters.
FAST Option <value>¶
FAST Option may be "MD5", "MSCHAPV2" or "GTC".
Encryption <value>¶
Encryption may contain combinations of "CCMP" or "TKIP".
"WPA" requires "TKIP", and only "TKIP".
"WPA2" requires "CCMP" and/or "TKIP".
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.
TX Power Maximum <value>¶
TX Power Maximum has units of dBm.
TX Power Maximum governs the power output of the WLAN radio.
Power Management <value>¶
Power Management may be "Enabled" or "Disabled".
PM Interval <value>¶
PM Interval has units of beacons (100 ms each).
Config IPv6 level¶
<instance> may be "ap0", "eth0" or "wlan0".
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
DHCPv6 Client State <value>¶
DHCPv6 Client State may contain one byte.
DHCPv6 Client Address <value>¶
DHCPv6 Client Address may contain up to 16 bytes.
Config AES Credential level¶
Each AES Credential holds a secret Encrypt Key and Decrypt Key for secure communication.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
delete¶
Deletes this AES Credential.
Encrypt Key <value>¶
Encrypt Key may contain up to 32 bytes.
The Encrypt Key is used for encrypting outgoing data.
The Key is 16, 24, or 32 bytes in length. Any Key entered that is less than
one of these is padded with zeroes. A byte specification comprises two nibble
specifications with no intervening space. A nibble specification is a single
digit from 0 to 9 or from "a" to "f" (representing 10 through 15).
Example Hexadecimal key:
12 34 56 78 9a bc de f0 01 02 03 04 05 06 07 08
To remove the Key, set it blank.
Note that the Key is a shared secret so it must be known by both sides of the connection and kept secret.
Decrypt Key <value>¶
Decrypt Key may contain up to 32 bytes.
The Decrypt Key is used for decrypting incoming data.
The Key is 16, 24, or 32 bytes in length. Any Key entered that is less than
one of these is padded with zeroes. A byte specification comprises two nibble
specifications with no intervening space. A nibble specification is a single
digit from 0 to 9 or from "a" to "f" (representing 10 through 15).
Example Hexadecimal key:
12 34 56 78 9a bc de f0 01 02 03 04 05 06 07 08
To remove the Key, set it blank.
Note that the Key is a shared secret so it must be known by both sides of the connection and kept secret.
Config Azure level¶
These settings pertain to Azure IoT connection information. Only one line can be assigned to the Azure IoT protocol.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
State <value>¶
State may be "Enabled" or "Disabled".
"Disabled" turns Azure IoT off.
"Enabled" turns Azure IoT on.
Hub Name <value>¶
Hub Name may contain up to 64 characters.
The Hub Name created through the Azure portal.
Device ID <value>¶
Device ID may contain up to 128 characters.
The Device ID of the device.
Security <value>¶
Security may be "Security Keys" or "X.509 Certificate".
The Security type.
SAS Token¶
SAS Token may contain up to 256 characters.
The CLI will prompt "Enter SAS Token, <escape> terminates: ". The value will not be echoed.
SAS Token (Shared Access Signature) is applicable when Security is set to "Security Keys". The SAS Token incorporates all of the information necessary to grant controlled access to a storage resource.
Credential Name <value>¶
Credential Name may contain up to 256 characters.
Credential Name is applicable when Security is set to "X.509 Certificate". It is the name of the credential to be found in TLS Credentials.
MQTT Local Port <value>¶
Blank the value for "<Random>".
Receive Buffer <value>¶
Receive Buffer has units of bytes.
Receive Buffer sets the allowed maximum size of device message that can be received from Azure.
Watch out in the tlog for the critical error message, "MQTT received xxxx bytes, but buffer is yyyy" Set Receive Buffer to have sufficient capacity for your application.
WARNING: Do not make the Receive Buffer larger than needed. The device may become unstable and crash without sufficient memory. Also consider removing unneeded modules.
Reply Buffer <value>¶
Reply Buffer has units of bytes.
Reply Buffer sets the allowed maximum size of the device reply to Azure.
Watch out on the Azure side for an error reply, "Needed xxx bytes; Reply Buffer capacity is yyy bytes." Set Reply Buffer to have sufficient capacity for your application.
WARNING: Do not make the Reply Buffer larger than needed. The device may become unstable and crash without sufficient memory. Also consider removing unneeded modules.
Config Bluetooth level¶
These settings pertain to Bluetooth.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
State <value>¶
State may be "Enabled" or "Disabled".
"Disabled" turns Bluetooth off.
"Enabled" turns Bluetooth on.
Device Name <value>¶
Device Name may contain up to 25 characters.
This is the Device Name provided to other Bluetooth devices through device discovery.
The Device Name defaults to model and serial number, and if made blank, will revert to this default.
NOTE: Changing the Device Name requires a reboot to take effect.
Device Class <value>¶
Device Class may contain up to 3 bytes.
Background Scanning <value>¶
Background Scanning may be "Enabled" or "Disabled".
This setting enables or disables background scanning, including both Bluetooth Low Energy (BLE) scanning and inquiry scanning for BR/EDR (sometimes referred to as classic Bluetooth) devices.
Allow Discovery <value>¶
Allow Discovery may be "No" or "Yes".
This setting determines whether the device will respond to inquiry scans.
Allow Connections <value>¶
Allow Connections may be "No" or "Yes".
This setting determines whether the device will accept connections.
Note: Disabling this setting means that any SDP discovery from another device will fail.
Enable SPP Server <value>¶
Enable SPP Server may be "No" or "Yes".
This setting determines whether the Serial Port Profile (SPP) server is enabled.
SPP Service Channel <value>¶
This setting defines the RFCOMM channel number for the Serial Port Profile (SPP) server. Service Channels can range from 1 to 30.
Enable BLE Peripheral <value>¶
Enable BLE Peripheral may be "No" or "Yes".
This setting enables or disables BLE Peripheral functionality. If enabled, the device will respond to BLE scans, and will run general advertisements.
Lantronix Provisioning Server <value>¶
Lantronix Provisioning Server may be "Enabled" or "Disabled".
This setting enables or disables the Lantronix BLE Provisioning Server.
BLE Peripheral Device Name <value>¶
BLE Peripheral Device Name may contain up to 25 characters.
This setting allows the device name used in BLE advertisements to be configured differently than the device name used for device discovery.
BLE advertisements are used by the Lantronix Provisioning Server.
Like the Device Name used for device discovery, this setting defaults to model and serial number, and if made blank, will revert to this default.
Config Bluetooth_SPP level¶
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Master¶
Enters the "config Bluetooth_SPP Master" Command level.
These settings pertain to the SPP Line configuration with the device server in the Bluetooth master role.
Slave¶
Enters the "config Bluetooth_SPP Slave" Command level.
Choose an SPP Line to connect to the Bluetooth master device. Note that the SPP Line assigned here will always be connected to whichever Bluetooth device is currently bonded as a master device to this slave.
Each SPP Line can only be connected to a single device.
Config Bluetooth_SPP Master level¶
These settings pertain to the SPP Line configuration with the device server in the Bluetooth master role.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Device <instance>¶
Enters the selected "config Bluetooth_SPP Master Device" Command level.
<instance> must be the device address of SPP Line* devices.
Displayed here will be any devices that have been previously assigned to SPP Lines as well as any currently bonded and connected devices.
Each SPP Line can only be connected to a single device.
If a device is assigned to an SPP Line and subsequently forgotten, the line assignment will not be remembered.
Config Bluetooth_SPP Master Device level¶
<instance> must be the device address of SPP Line* devices.
Displayed here will be any devices that have been previously assigned to SPP Lines as well as any currently bonded and connected devices.
Each SPP Line can only be connected to a single device.
If a device is assigned to an SPP Line and subsequently forgotten, the line assignment will not be remembered.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
SPP Line <value>¶
SPP Line may be "Unassigned" or "SPP_<number>".
Select the SPP Line to connect to a particular Bluetooth slave device, or select Unassigned to remove the connection between a previously connected slave device and its SPP Line.
Protocol selection for SPP Lines is available as part of Line configuration.
Config Bluetooth_SPP Slave level¶
Choose an SPP Line to connect to the Bluetooth master device. Note that the SPP Line assigned here will always be connected to whichever Bluetooth device is currently bonded as a master device to this slave.
Each SPP Line can only be connected to a single device.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
SPP Line <value>¶
SPP Line may be "Unassigned" or "SPP_<number>".
Select the SPP Line to connect to the Bluetooth master device, or select Unassigned to remove the connection between the master device and its SPP Line.
Protocol selection for SPP Lines is available as part of Line configuration.
Config BLE Beacon Scanner level¶
<instance> may be "1", "SPP_1", "SPP_2", "SPP_3", "Virtual_1" or "Virtual_2".
These settings pertain to the BLE Beacon Scanner line protocol.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Type <value>¶
Type may contain combinations of "iBeacon".
Transmit Mode <value>¶
Transmit Mode may be "Disable", "Always", "Any Character" or "Start and Stop Characters".
The BLE Beacon Scanner can be configured to transmit depending on various conditions:
- Disable: Never transmit.
- Always: Always transmit.
- Any Character: Start transmitting when any character is read on the line. Transmission will continue until any character is subsequently read on the line.
- Start and Stop Characters: Start transmitting when a specific character is read on the line. Transmission will continue until a specific character is subsequently read on the 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)
The Start Character is a specific value that must be read on the line before transmission can begin.
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)
The Start Character is a specific value that must be read on the line before transmission will stop.
Output Format <value>¶
Output Format may contain up to 53 characters.
The Output Format specifies how the beacon information will be patterned when transmitted on the line.
There are four main portions of the beacon that can be used in the Output Format:
<UUID>: The beacon UUID.
<MAJOR>: The major number of the beacon.
<MINOR>: The minor number of the beacon.
<RSSI>: The RSSI value of the message containing the beacon.
The Output Format must contain at least one of the four beacon portions. In addition, there is some room in the format string for ancillary characters that can be used for separators or other formatting.
To return to the default Output Format, clear this setting.
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.
Ethernet¶
Enters the "config Bridge Ethernet" Command level.
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 Ethernet level¶
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
State <value>¶
State may be "Enabled" or "Disabled".
"Disabled" turns Ethernet ap0 bridging off.
"Enabled" turns Ethernet ap0 bridging on.
Mode <value>¶
Mode may be "Enabled" or "Disabled".
"Disabled" turns Ethernet wlan0 bridging off.
"Enabled" turns Ethernet wlan0 bridging on with networking, supporting up to 20 bridged devices.
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.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Inactivity Timeout <value>¶
Inactivity Timeout has units of minutes, and/or hours.
Enter 0 for "<None>".
After this time period with no activity, the CLI Server will close the connection.
Telnet¶
Enters the "config CLI Server Telnet" Command level.
Config CLI Server Telnet level¶
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Mode <value>¶
Mode may be "Enabled" or "Disabled".
Interface <value>¶
Interface may be "Any", "ap0", "eth0" or "wlan0".
Port <value>¶
The CLI Server listens on this port for incoming Telnet connections.
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", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "Virtual_1" or "Virtual_2".
These settings pertain to the Percepxion management 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 1 minute 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 Configuration Update <value>¶
Reboot After Configuration Update may be "Enabled" or "Disabled".
If enabled, this setting will automatically reboot after a successful configuration upgrade.
The device will always reboot after a successful firmware upgrade.
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 overridden 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¶
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 Domain <value>¶
MQTT Domain may contain up to 63 characters.
The MQTT Domain specifies the Percepxion MQTT cloud host.
MQTT Local Port <value>¶
Blank the value for "<Random>".
The MQTT Local Port is random by default but can be overridden 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", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "Virtual_1" or "Virtual_2".
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".
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 1 minute 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 Discovery 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).
write¶
Writes any unsaved configuration.
exit¶
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 GATT Server level¶
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Custom Service <instance>¶
Enters the selected "config GATT Server Custom Service" Command level.
Creates <instance> if it does not already exist.
These settings pertain to each GATT Custom Service.
Config GATT Server Custom Service level¶
These settings pertain to each GATT Custom Service.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
delete¶
Deletes this GATT Server Custom Service.
Description <value>¶
Description may contain up to 30 characters.
Description is an optional field that can add information to the service instance identifier.
UUID <value>¶
UUID may contain up to 36 characters.
This is the service UUID. The UUID is a 128-bit value specified in a string of 32 hexadecimal bytes.
UUIDs are typically formatted as follows: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Characteristic <instance>¶
Enters the selected "config GATT Server Custom Service Characteristic" Command level. <instance> may range from 1 to 2.
This is a GATT Characteristic for the service. GATT characteristics are what actually communicate data in a GATT service.
Up to 2 characteristics can be defined per service. Characteristics are defined by a UUID and a set of properties.
Advertise <value>¶
Advertise may be "No" or "Yes".
The device can only advertise one BLE service. If the Lantronix Provisioning Server is enabled, then it is the one service that is advertised.
If selected, this setting only applies if the Lantronix Provisioning Server is disabled.
Interface <value>¶
Interface may be "Disabled" or "Line Driver".
This service is not useable unless an interface has been selected.
If selected, the Line Driver interface creates a new Line instance for this service. The Line name will be in the format GATTS_[instance]. The device must be rebooted before the new Line instance can be used.
NOTE: You will likely need to completely refresh the Web Manager in order to see the new Line instance.
Config GATT Server Custom Service Characteristic level¶
<instance> may range from 1 to 2.
This is a GATT Characteristic for the service. GATT characteristics are what actually communicate data in a GATT service.
Up to 2 characteristics can be defined per service. Characteristics are defined by a UUID and a set of properties.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
UUID <value>¶
UUID may contain up to 36 characters.
This is the service characteristic UUID. The UUID is a 128-bit value specified in a string of 32 hexadecimal bytes.
UUIDs are typically formatted as follows: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Properties <value>¶
Properties may contain combinations of "Readable" or "Writable".
Properties define the type of information and access that a characteristic provides. While GATT service characteristics support several different properties, only the "Readable" and "Writable" properties are available here for a custom GATT service.
NOTE: You must selected at least one property in order for service data to be accessible.
Config LPD level¶
<instance> must be "1".
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 <value>¶
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", "SPP_1", "SPP_2", "SPP_3", "HOST_CDC_ACM", "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.
Config Modem Emulation level¶
<instance> may be "1", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "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 Monitor level¶
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Initialization¶
Enters the "config Monitor Initialization" Command level.
These settings pertain to Monitor Initialization in the device.
Monitor will process any initialization message before it starts polling or process any control message. Response captured during initialization will be overwritten by any poll or control response.
Control¶
Enters the "config Monitor Control" Command level.
These settings pertain to Monitor Control in the device.
Control Message will be processed after receiving status action Send. Response will overwrite any response captured during initialization or poll. Response must be read before sending another status action Send or buffer will be reset.
Poll¶
Enters the "config Monitor Poll" Command level.
These settings pertain to Monitor Poll in the device.
Poll Message will be processed periodically. Response will overwrite any response captured during initialization or poll.
Filter¶
Enters the "config Monitor Filter" Command level.
These settings pertain to Monitor Filter in the device.
Filter settings will be applied to all received response. Filter results can be used to feed another filter or use as Data Reference.
Data¶
Enters the "config Monitor Data" Command level.
These settings pertain to Monitor Data in the device.
Data configured here will be accessible through the status of Monitor.
Config Monitor Initialization level¶
These settings pertain to Monitor Initialization in the device.
Monitor will process any initialization message before it starts polling or process any control message. Response captured during initialization will be overwritten by any poll or control response.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Initial Delay <value>¶
Initial Delay has units of milliseconds.
Sets Initial Delay waited before monitor start processing any initialization message.
Message <instance>¶
Enters the selected "config Monitor Initialization Message" Command level.
<instance> may range from 1 to 4.
Config Monitor Initialization Message level¶
<instance> may range from 1 to 4.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Command <value>¶
Command may contain up to 32 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]
Sets the Command in binary format.
Binary format takes printable characters (e.g. 'abc' for characters 'a', 'b' and 'c') or binary string (e.g. [0xa, 0xd] for line feed and carriage return).
End Character <value>¶
End 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)
Sets the End Character to indicate end of response.
Response is ended by any configured End Character, Length OR Timeout.
Length <value>¶
Length has units of bytes.
Sets the Length of response.
Response is ended by any configured End Character, Length OR Timeout.
Timeout <value>¶
Timeout has units of milliseconds.
Blank the value for "<Minimum>".
Sets the Timeout to receive response.
Response is ended by any configured End Character, Length OR Timeout.
Config Monitor Control level¶
These settings pertain to Monitor Control in the device.
Control Message will be processed after receiving status action Send. Response will overwrite any response captured during initialization or poll. Response must be read before sending another status action Send or buffer will be reset.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Message <instance>¶
Enters the selected "config Monitor Control Message" Command level.
<instance> may range from 1 to 4.
Config Monitor Control Message level¶
<instance> may range from 1 to 4.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Command <value>¶
Command may contain up to 32 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]
Sets the Command in binary format.
Binary format takes printable characters (e.g. 'abc' for characters 'a', 'b' and 'c') or binary string (e.g. [0xa, 0xd] for line feed and carriage return).
End Character <value>¶
End 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)
Sets the End Character to indicate end of response.
Response is ended by any configured End Character, Length OR Timeout.
Length <value>¶
Length has units of bytes.
Sets the Length of response.
Response is ended by any configured End Character, Length OR Timeout.
Timeout <value>¶
Timeout has units of milliseconds.
Blank the value for "<Minimum>".
Sets the Timeout to receive response.
Response is ended by any configured End Character, Length OR Timeout.
Config Monitor Poll level¶
These settings pertain to Monitor Poll in the device.
Poll Message will be processed periodically. Response will overwrite any response captured during initialization or poll.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Message <instance>¶
Enters the selected "config Monitor Poll Message" Command level.
<instance> may range from 1 to 4.
Delay <value>¶
Delay has units of seconds, minutes, hours, and/or days.
Sets Delay waited before monitor starts processing all poll messages again. 0 means poll messages are sent only once.
Config Monitor Poll Message level¶
<instance> may range from 1 to 4.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Command <value>¶
Command may contain up to 32 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]
Sets the Command in binary format.
Binary format takes printable characters (e.g. 'abc' for characters 'a', 'b' and 'c') or binary string (e.g. [0xa, 0xd] for line feed and carriage return).
End Character <value>¶
End 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)
Sets the End Character to indicate end of response.
Response is ended by any configured End Character, Length OR Timeout.
Length <value>¶
Length has units of bytes.
Sets the Length of response.
Response is ended by any configured End Character, Length OR Timeout.
Timeout <value>¶
Timeout has units of milliseconds.
Blank the value for "<Minimum>".
Sets the Timeout to receive response.
Response is ended by any configured End Character, Length OR Timeout.
Config Monitor Filter level¶
These settings pertain to Monitor Filter in the device.
Filter settings will be applied to all received response. Filter results can be used to feed another filter or use as Data Reference.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Rule <instance>¶
Enters the selected "config Monitor Filter Rule" Command level.
<instance> may range from 1 to 4.
Config Monitor Filter Rule level¶
<instance> may range from 1 to 4.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Source <value>¶
Source may contain up to 6 characters.
Sets the Source in dot number format.
Source defines the input of a filter. E.g. If the source of this Filter is the second trunk of data created by filter 1, Source must be set to "1.2". A Source of "0" indicates the raw response.
Dot number format could be "0" or two numbers separated by a dot (e.g. "1.2").
Mode <value>¶
Mode may be "All", "Delimiters" or "Binary".
"All" makes filter ouput to be a duplicate of input.
"Delimiters" filter breaks input up to 8 trunks separated by Binary String. Each trunk will not contain the delimiters.
"Binary" filter breaks input into 3 trunks according to Offset and Length.
Delimiter <instance>¶
Enters the selected "config Monitor Filter Rule Delimiter" Command level.
<instance> may range from 1 to 2.
Start Index <value>¶
Sets Start Index to indicate when Delimiters filter starts breaking input into trunks.
Offset <value>¶
Offset has units of bytes.
Sets Offset for the size of the first trunk of data created by Binary Filter.
Length <value>¶
Length has units of bytes.
Sets Length for the size of the second trunk of data created by Binary Filter. The third trunk of data created by Binary Filter will contain the rest of input.
Config Monitor Filter Rule Delimiter level¶
<instance> may range from 1 to 2.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Binary String <value>¶
Binary String may contain up to 6 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]
Sets Binary String delimiter in binary format.
Delimiters break input up to 8 trunks separated by (but not containing) delimiters. A delimiter is recognized if any of the Binary String is completely matched.
Binary format takes printable characters (e.g. 'abc' for characters 'a', 'b' and 'c') or binary string (e.g. [0xa, 0xd] for line feed and carriage return).
Config Monitor Data level¶
These settings pertain to Monitor Data in the device.
Data configured here will be accessible through the status of Monitor.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Selector <instance>¶
Enters the selected "config Monitor Data Selector" Command level.
<instance> may range from 1 to 8.
Config Monitor Data Selector level¶
<instance> may range from 1 to 8.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
Name <value>¶
Name may contain up to 16 characters.
Sets Name to enable the data selector.
Response <value>¶
Blank the value for "<None>".
Sets Response instance to select the source of data. Response instance corresponds to Poll or Control Message instance.
Reference <value>¶
Reference may contain up to 6 characters.
Sets the Reference in dot number format.
Reference selects the output of Monitor Filter. E.g. If data should select the second trunk of data created by filter 1, Reference must be set to "1.2". A Reference of "0" indicates the raw response.
Dot number format could be "0" or two numbers separated by a dot (e.g. "1.2").
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 SNMP level¶
These configurables are for Simple Network Management Protocol version 2 (SNMPv2) Agent.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
State <value>¶
State may be "Enabled" or "Disabled".
By default this is disabled, This enables the SNMPv2 agent on the listen network.
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.
A string value to read the SNMP variables, By default this is set public.
Community Write¶
Community Write may contain up to 64 characters.
The CLI will prompt "Enter Community Write: ". The value will not be echoed.
A string value to read the SNMP variables, By default this is set 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".
By default this is disabled, This enables to send the predefined traps to specified destinations.
Primary Destination <value>¶
Primary Destination may contain up to 64 characters.
Secondary Destination <value>¶
Secondary Destination may contain up to 64 characters.
Config SNMP Extended Agent level¶
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
IP Address <value>¶
IP Address may contain up to 31 characters.
Port <value>¶
Blank the value for "<None>".
Config TLS Credential level¶
Manages certificates for TLS clients and servers.
NOTE: Minimum accepted RSA key size is 2048 bits.
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
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.
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.
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 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.
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.
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 Tunnel level¶
<instance> may be "1", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "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", "SPP_1", "SPP_2", "SPP_3", "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", "SPP_1", "SPP_2", "SPP_3", "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", "SPP_1", "SPP_2", "SPP_3", "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", "SPP_1", "SPP_2", "SPP_3", "Virtual_1" or "Virtual_2".
These settings relate to Disconnecting a Tunnel.
Packing¶
Enters the "config Tunnel Packing" Command level.
<instance> may be "1", "SPP_1", "SPP_2", "SPP_3", "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", "SPP_1", "SPP_2", "SPP_3", "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", "TCP AES", "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.
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", "SPP_1", "SPP_2", "SPP_3", "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", "SPP_1", "SPP_2", "SPP_3", "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.
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. Set to '0' to disable reconnect.
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 ("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", "TCP AES", "TLS", "UDP" or "WebSocket".
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 ¶
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", "SPP_1", "SPP_2", "SPP_3", "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.
Config Tunnel Packing level¶
<instance> may be "1", "SPP_1", "SPP_2", "SPP_3", "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.
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¶
Returns to the previous level.
State ¶
State may be "Enabled" or "Disabled".
Config USB Host level¶
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
State ¶
State may be "Enabled" or "Disabled".
Config Custom level¶
User custom configuration values are stored under this group.
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
delete¶
Deletes this Custom.
Item <instance>¶
Enters the selected "config Custom Item" Command level.
Creates <instance> if it does not already exist.
Config Custom Item level¶
show¶
Shows current configuration.
write¶
Writes any unsaved configuration.
exit¶
Returns to the previous level.
delete¶
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.
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.
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", "wlan0" or "lo0".
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", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "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.
SPI¶
Enters the "status SPI" Command level.
This displays the current status and various statistics for the Serial Peripheral Interface (SPI) Bus Master device.
WLAN¶
Enters the "status WLAN" Command level.
<instance> must be "wlan0".
This shows status of a WLAN Link on the device.
Azure¶
Enters the "status Azure" Command level.
This displays the Azure IoT Status.
Bluetooth¶
Enters the "status Bluetooth" Command level.
Bluetooth_SPP¶
Enters the "status Bluetooth_SPP" Command level.
BLE Beacon Scanner <instance>¶
Enters the selected "status BLE Beacon Scanner" Command level.
<instance> may be "1", "SPP_1", "SPP_2", "SPP_3", "Virtual_1" or "Virtual_2".
This page displays the status of the BLE Beacon Scanner for the specified line.
Bridge¶
Enters the "status Bridge" Command level.
This displays the current Bridge Status.
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.
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.
LPD <instance>¶
Enters the selected "status LPD" Command level.
<instance> must be "1".
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", "SPP_1", "SPP_2", "SPP_3", "HOST_CDC_ACM", "Virtual_1" or "Virtual_2".
This displays the current connection status of the Modbus server listening on the TCP port.
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", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "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.
Monitor¶
Enters the "status Monitor" Command level.
This displays the current status for Monitor.
NTP¶
Enters the "status NTP" Command level.
This shows statistics from the last successful NTP server synchronization.
SNMP¶
Enters the "status SNMP" Command level.
This shows statistics from Simple Network Mnagement Protocol version 2 (SNMPv2) Agent.
TLS Credential <instance>¶
Enters the selected "status TLS Credential" Command level.
SMTP¶
Enters the "status SMTP" Command level.
This displays the SMTP Status.
Tunnel <instance>¶
Enters the selected "status Tunnel" Command level.
<instance> may be "1", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "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.
DHCP Client <instance>¶
Enters the selected "status Access Point DHCP Client" Command level.
Status Access Point DHCP Client 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 Clock 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 hh:mm:ss>¶
The format for setting time is YYYY-MM-DD hh:mm:ss, 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 8.
Status CPM CPs CP level¶
<instance> may range from 1 to 8.
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.
Mode <value>¶
<value> may be "Push-Pull" or "Weak Pullup".
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".
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" or "Initial Trigger".
"GSPI Slave Interrupt" signals new data or space available.
"Ethernet Link" is Link UP while eth0 is up.
"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".
"Keep AWAKE" Input keep AWAKE CP role.
"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".
"SPI.CS" pin is used when SPI State is "Enabled".
"SPI.MISO" pin is used when SPI State is "Enabled".
"SPI.MOSI" pin is used when SPI State is "Enabled".
"SPI.SCK" pin is used when SPI State is "Enabled".
"USB Host Overcurrent" pin is used when USB Host State is "Enabled".
"USB Host Power Enabled" output active to enable power output to USB device.
"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" or "Initial Trigger".
"GSPI Slave Interrupt" signals new data or space available.
"Ethernet Link" is Link UP while eth0 is up.
"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".
"Keep AWAKE" Input keep AWAKE CP role.
"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".
"SPI.CS" pin is used when SPI State is "Enabled".
"SPI.MISO" pin is used when SPI State is "Enabled".
"SPI.MOSI" pin is used when SPI State is "Enabled".
"SPI.SCK" pin is used when SPI State is "Enabled".
"USB Host Overcurrent" pin is used when USB Host State is "Enabled".
"USB Host Power Enabled" output active to enable power output to USB device.
"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.
Buffer Pools¶
Enters the "status Diagnostics Buffer Pools" Command level.
This displays information for each Buffer Pool.
Total is the number of buffers allocated to the pool.
Free is the remaining number of buffers available in the pool.
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.
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¶
Enters the "status Diagnostics Threads" Command level.
This displays current existing Threads and their stack usage.
Status Diagnostics Buffer Pools level¶
This displays information for each Buffer Pool.
Total is the number of buffers allocated to the pool.
Free is the remaining number of buffers available in the pool.
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
Buffer Pool <instance>¶
Enters the selected "status Diagnostics Buffer Pools Buffer Pool" Command level.
Status Diagnostics Buffer Pools Buffer Pool 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 Hardware level¶
This displays Hardware identification and capabilities.
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 Heap level¶
This displays Heap usage, state, and statistics.
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 IP Sockets level¶
This displays information for each IP Socket.
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
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¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
Module <instance>¶
Enters the selected "status Diagnostics Modules Module" Command level.
Status Diagnostics Modules Module 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 Ping level¶
ping <host>[ <timeout seconds>[ <count>]]¶
Pings <host> and displays results; press any key to stop.
exit¶
Returns to the previous level.
Status Diagnostics Ports level¶
This displays current registered Ports and their service.
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 ¶
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¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
Thread <instance>¶
Enters the selected "status Diagnostics Threads Thread" Command level.
Status Diagnostics Threads Thread 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 Ethernet level¶
<instance> must be "eth0".
This shows status of an Ethernet 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.
Receive¶
Enters the "status Ethernet Receive" Command level.
Transmit¶
Enters the "status Ethernet Transmit" Command level.
Status Ethernet Receive 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 Ethernet Transmit 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 File System level¶
This displays various statistics and current usage information of the flash File System.
auto show¶
Shows and updates current status every second. Press any key to stop.
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 HTTP Server level¶
This displays the current status for the HTTP Server.
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 Interface Counters level¶
<instance> may be "ap0", "eth0", "wlan0" or "lo0".
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¶
Enters the "status Interface Counters Receive" Command level.
Transmit¶
Enters the "status Interface Counters Transmit" Command level.
Status Interface Counters Receive 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 Interface Counters Transmit 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 Interface level¶
<instance> may be "ap0", "eth0", "wlan0" or "lo0".
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 Interface 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 Line level¶
<instance> may be "1", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "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.
First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.
Status Line Signals 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 Line Settings 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 Radio level¶
These settings pertain to the Radio.
Any change to these settings requires a reboot to take effect.
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 SPI level¶
This displays the current status and various statistics for the Serial Peripheral Interface (SPI) Bus Master 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 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 Azure level¶
This displays the Azure IoT Status.
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 Bluetooth level¶
exit¶
Returns to the previous level.
Operation¶
Enters the "status Bluetooth Operation" Command level.
This page displays the operation status of Bluetooth.
Nearby Devices¶
Enters the "status Bluetooth Nearby Devices" Command level.
Status Bluetooth Operation level¶
This page displays the operation status of Bluetooth
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
RFCOMM Server <instance>¶
Enters the selected "status Bluetooth Operation RFCOMM Server" Command level.
<instance> may range from 1 to 3.
This displays RFCOMM server details.
RFCOMM Connection <instance>¶
Enters the selected "status Bluetooth Operation RFCOMM Connection" Command level.
<instance> may range from 1 to 4.
This displays RFCOMM connection details.
GATT Server <instance>¶
Enters the selected "status Bluetooth Operation GATT Server" Command level.
<instance> may range from 1 to 3.
This displays GATT server details. A GATT server may also be known as a BLE Peripheral server.
GATT Connection <instance>¶
Enters the selected "status Bluetooth Operation GATT Connection" Command level.
<instance> may range from 1 to 8.
This displays GATT connection details.
Unpair <Device_Address>¶
Removes pairing information for the specified device.
Additional Logging <0|1|2|3|4>¶
Increases or decreases logging verbosity.
Status Bluetooth Operation RFCOMM Server level¶
<instance> may range from 1 to 3.
This displays RFCOMM server details.
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 Bluetooth Operation RFCOMM Connection level¶
<instance> may range from 1 to 4.
This displays RFCOMM connection details.
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
Disconnect¶
Breaks the RFCOMM connection.
Status Bluetooth Operation GATT Server level¶
<instance> may range from 1 to 3.
This displays GATT server details. A GATT server may also be known as a BLE Peripheral server.
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 Bluetooth Operation GATT Connection level¶
<instance> may range from 1 to 8.
This displays GATT connection details.
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
Disconnect¶
Breaks the GATT connection.
Status Bluetooth Nearby Devices 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.
Scan¶
Starts a temporary high-duty scan for Bluetooth Low Energy (BLE) devices and initiates an inquiry scan for BR/EDR (also referred to as classic Bluetooth) devices.
Sort By ["None" | "Rssi" | "Name" | "Address"]¶
Sets the sort option for devices, with RSSI as the default.
Pair <Device_Name | Device_Address> [PIN | "-le"]¶
Attempts to pair with the specified device. By default, pairing will be done with BR/EDR. To initiate a BLE pairing, use the "-le" option.
Unpair <Device_Address>¶
Removes pairing information for the specified device.
Status Bluetooth_SPP 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.
Additional Logging <0|1|2|3|4>¶
<value> may be "0", "1", "2", "3" or "4".
Status BLE Beacon Scanner level¶
<instance> may be "1", "SPP_1", "SPP_2", "SPP_3", "Virtual_1" or "Virtual_2".
This page displays the status of the BLE Beacon Scanner for the specified 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.
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¶
Returns to the previous level.
Inbound¶
Enters the "status Bridge Inbound" Command level.
Outbound¶
Enters the "status Bridge Outbound" Command level.
Configured¶
Enters the "status Bridge Configured" Command level.
Status Bridge Inbound 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 Outbound 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 Configured 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.
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
Telnet¶
Enters the "status CLI Server Telnet" Command level.
Status CLI Server Telnet 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.
Kill¶
The Kill action manually disconnects the active CLI Server connection.
Status Discovery level¶
<instance> may be "ap0", "eth0" or "wlan0".
This shows statistics for the Discovery service on the selected Interface.
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 Percepxion 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.
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¶
Enters the "status Percepxion Status" Command level.
<instance> must be "Detail".
Available Update <instance>¶
Enters the selected "status Percepxion Available Update" Command level.
<instance> may range from 1 to 20.
Status Percepxion Status level¶
<instance> must be "Detail".
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 Percepxion Available Update level¶
<instance> may range from 1 to 20.
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 LPD level¶
<instance> must be "1".
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", "SPP_1", "SPP_2", "SPP_3", "HOST_CDC_ACM", "Virtual_1" or "Virtual_2".
This displays the current connection status of the Modbus server listening on the TCP port.
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.
Connection <instance>¶
Enters the selected "status Modbus Connection" Command level.
<instance> may range from 1 to 6.
Local Slave¶
Enters the "status Modbus Local Slave" 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 Modbus Connection level¶
<instance> may range from 1 to 6.
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 manually disconnects an active Modbus TCP Server connection.
Status Modbus Local Slave 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", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "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.
Current Connection¶
Enters the "status Modem Emulation Current Connection" Command level.
Status Modem Emulation Aggregate 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 Current Connection 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.
Kill¶
The Kill action manually disconnects an active Modem Emulation connection.
Status Monitor level¶
This displays the current status for Monitor.
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
Data <instance>¶
Enters the selected "status Monitor Data" Command level.
Control <instance>¶
Enters the selected "status Monitor Control" Command level.
Status Monitor Data 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 Monitor Control 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.
Send¶
The Send action causes the device to send the associated control message.
Status NTP level¶
This shows statistics from the last successful NTP server synchronization.
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
Returns to the previous level.
Sync¶
The Sync action requests immediate clock synchronization with the NTP server.
Status SNMP level¶
This shows statistics from Simple Network Mnagement Protocol version 2 (SNMPv2) Agent.
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 TLS Credential 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.
Certificate¶
Enters the "status TLS Credential Certificate" Command level.
Higher Authority <instance>¶
Enters the selected "status TLS Credential Higher Authority" Command level.
Trusted Authority <instance>¶
Enters the selected "status TLS Credential Trusted Authority" Command level.
Status TLS Credential Certificate 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 TLS Credential Higher Authority 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 TLS Credential Trusted Authority 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 SMTP level¶
This displays the SMTP Status.
exit¶
Returns to the previous level.
Send <value>¶
The Send action is not available to the web API.
Example usage follows:
Send <ssl server hostname> <username> <password> <from mail address> <first recipient mail address> [optional second recipient mail address] [...] <-- Empty line ends recipient list <subject> <first line of body> [optional second line of body] [...] <-- Empty line ends body
Status Tunnel level¶
<instance> may be "1", "gSPI_1", "gSPI_2", "gSPI_3", "gSPI_4", "SPP_1", "SPP_2", "SPP_3", "CDC_ACM", "HOST_CDC_ACM", "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".
Status Tunnel Aggregate 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 Tunnel Current Connection level¶
Possible instance names are "Accept" and "Connect <n>", where <n> is the Host number, for example "Connect 1".
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 manually disconnects an active Tunnel connection.
Status Custom level¶
Changes counts the number of times any custom group is saved.
auto show¶
Shows and updates current status every second. Press any key to stop.
show¶
Shows current status.
exit¶
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.
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.
exit¶
Returns to the root Command level.