XML Reference

configgroup Access Point

The XML 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.

configitem 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.

configitem 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.

configitem 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.

configitem Auto Channel Scan Interval

value

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

configitem Suite

value

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

configitem Encryption

value

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

configitem Passphrase

value

Passphrase may contain up to 63 characters.

configitem Mode

value

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

"Always Up" brings ap0 up unconditionally.

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

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

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

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

configitem 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.

configgroup Clock

These settings pertain to the Clock settings for keeping time.

configitem Source

value

Source may be "Manual" or "NTP".

configitem 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".

configgroup CPM

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.

configitem Role

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

"Device CTS" is active while rx buffers are available.

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

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

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

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

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

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

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

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

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

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

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

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

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

"WLAN Active" is active while wlan0 is up.

value CP

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

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

value State

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.

value Assert

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.

configgroup Ethernet

The XML 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.

configitem PHY Address Mode

value

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

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

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

configitem Speed

value

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

configitem Duplex

value

Duplex may be "Half" or "Full".

configgroup HTTP Server

These settings pertain to the HTTP Server. Changes will take effect after reboot.

configitem 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.

configitem Port

value

Enter 0 for "<None>".

The default Port can be overridden.

configitem Secure Port

value

Enter 0 for "<None>".

The default Secure Port (TLS) can be overridden.

configitem 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.

configitem Authentication Timeout

value

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

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

configgroup HTTP Server Security

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

configitem Access Control

The XML instance may range from 1 to 9.

value URI

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

value AuthType

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

"None" provides no authentication.

"Basic" encodes passwords using Base64.

"Digest" hashes passwords using MD5.

"TLS" encrypts data but provides no authentication.

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

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

value User Level

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.

value Zones

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)

configitem Config

The XML instance may range from 1 to 9.

value Group

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.

value User Level

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.

value Zones

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

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

configitem Status

The XML instance may range from 1 to 9.

value Group

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.

value Optional Item

Optional Item may contain up to 30 characters.

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

value Optional Action

Optional Action may contain up to 30 characters.

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

value User Level

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.

value Zones

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

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

configgroup Interface

The XML 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.)

configitem State

value

State may be "Enabled" or "Disabled".

"Enabled" allows the Interface to operate.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configgroup Line

The XML instance may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the Serial Line. Changes take effect immediately.

configitem Name

value

Name may contain up to 25 characters.

The Name is for display purposes only.

configitem Interface

value

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

configitem 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.

configitem State

value

State may be "Enabled" or "Disabled".

"Enabled" allows the Serial Line to operate.

configitem Protocol

value

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

Protocol selects the application to connect to the Line.

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

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

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

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

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

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

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

"Modem Emulation" implements legacy AT commands.

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

"None" enables Line action commands.

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

"SLIP" provides a network interface.

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

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

configitem 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.

configitem Parity

value

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

configitem Data Bits

value

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

configitem Stop Bits

value

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

configitem Flow Control

value

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

configitem 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)

configitem 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)

configitem 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.

configitem Threshold

value

Threshold has units of bytes.

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

configitem 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.

configgroup Radio

These settings pertain to the Radio.

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

configitem 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.

configitem 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.

configitem Antenna 1 Supports

value

Antenna 1 Supports must be "WiFi".

configitem 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.

configitem 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.

configitem 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.

configitem Event Log

value

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

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

configitem Roaming

value State

State may be "Enabled" or "Disabled".

RSSI Floor is allowed to have negative values.

RSSI Floor has units of dBm.

When scanning, any signal below the RSSI Floor is omitted.

configgroup User

These settings pertain to each User on the device.

configitem Password

value

Password may contain up to 32 characters.

configitem 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".

configitem Allow Tech A to change password

value

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

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

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

configitem 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)

configgroup WLAN Profile

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.

configitem Basic

value Network Name

Network Name may contain up to 32 characters.

value State

State may be "Enabled" or "Disabled".

"Enabled" allows this profile to be used.

"Disabled" prevents this profile form being used.

configitem Security

value Suite

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

value WPAx Authentication

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

value WPAx Passphrase

Passphrase may contain up to 63 characters.

value WPAx IEEE 80211w

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

value WPAx Username

Username may contain up to 63 characters.

value WPAx Password

Password may contain up to 63 characters.

value WPAx Credentials

Credentials may contain up to 30 characters.

value WPAx EAP-TTLS Option

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

value WPAx PEAP ver

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

value WPAx PEAP Option

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

value WPAx PEAP Credentials

PEAP Credentials may contain up to 30 characters.

configitem Advanced

value Power Management

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

value PM Interval

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

configgroup BLE

These settings pertain to BLE.

configitem State

value

State may be "Enabled" or "Disabled".

"Disabled" turns BLE off.

"Enabled" turns BLE on.

configgroup BLE Beacon Scanner

The XML instance must be "1".

These settings pertain to the BLE Beacon Scanner line protocol.

configitem Type

value

Type may contain combinations of "iBeacon".

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configgroup Bridge

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.

configitem 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.

configitem Allow All Multicast

value

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

configitem IGMP

The XML instance may range from 1 to 6.

value IP Address

IP Address may contain up to 15 characters.

configgroup CLI Server

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

configitem 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.

configitem Telnet

value Mode

Mode may be "Enabled" or "Disabled".

value Interface

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

value Port

The CLI Server listens on this port for incoming Telnet connections.

configgroup Discovery

The XML 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).

configitem Query Port

value State

State may be "Enabled" or "Disabled".

"Enabled" allows the device to be discovered.

"Disabled" prevents discovery from finding the device.

configgroup Percepxion Device

These settings pertain to the Percepxion management platform.

configitem State

value

State may be "Enabled" or "Disabled".

configitem 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).

configitem 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).

configitem Apply Firmware Updates

value

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

configitem 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.

configitem 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.

configitem 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.

configitem Device Description

value

Device Description may contain up to 63 characters.

The Device Description is optional.

configitem Additional Logging

value

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

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

configitem Active Connection

value

Active Connection may be "<numbe>>".

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

configitem Connection

The XML 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.

value Domain

Domain may contain up to 63 characters.

The Domain specifies the Percepxion cloud host.

value Local Port

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.

configitem 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.

value MQTT Domain

MQTT Domain may contain up to 63 characters.

The MQTT Domain specifies the Percepxion MQTT cloud host.

value MQTT Local Port

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.

configgroup Percepxion Line

The XML instance may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the Percepxion management platform.

configitem State

value

State may be "Enabled" or "Disabled".

configitem Project Tag

value

Project Tag may contain up to 63 characters.

configitem 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).

configitem 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).

configgroup LPD

The XML instance must be "1".

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

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem Queue Name

value

Queue Name may contain up to 32 characters.

A Queue Name may not contain white space.

configgroup Modbus

The XML instance may be "1", "Virtual_1" or "Virtual_2".

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

configitem TCP Server State

value

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

"Disabled" turns Modbus off.

"Enabled" turns Modbus on.

configitem Port

value

Enter 0 for "<None>".

Port is required for the Modbus to accept a connection.

configitem Response Timeout

value

Response Timeout has units of milliseconds.

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

configgroup Modem Emulation

The XML instance may be "1", "Virtual_1" or "Virtual_2".

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

configitem Listen Port

value

Blank the value for "<None>".

Specify a Listen Port to accept connections on.

configitem 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.

configitem 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.

configitem 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.

configitem Verbose Response

value

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

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

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configgroup NTP

These configurables are for Simple NTP (SNTP).

configitem Server Hostname

value

Server Hostname may contain up to 128 characters.

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

configitem 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.

configgroup SNMP

These configurables are for Simple Network Management Protocol version 2 (SNMPv2) Agent.

configitem State

value

State may be "Enabled" or "Disabled".

By default this is disabled, This enables the SNMPv2 agent on the listen network.

configitem Listen Interface

value

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

configitem Community Read

value

Community Read may contain up to 64 characters.

A string value to read the SNMP variables, By default this is set public.

configitem Community Write

value

Community Write may contain up to 64 characters.

A string value to read the SNMP variables, By default this is set private.

configitem System Contact

value

System Contact may contain up to 64 characters.

configitem System Name

value

System Name may contain up to 64 characters.

configitem System Description

value

System Description may contain up to 64 characters.

configitem System Location

value

System Location may contain up to 64 characters.

configitem Traps

value State

State may be "Enabled" or "Disabled".

By default this is disabled, This enables to send the predefined traps to specified destinations.

value Primary Destination

Primary Destination may contain up to 64 characters.

value Secondary Destination

Secondary Destination may contain up to 64 characters.

configgroup TLS Credential

Manages certificates for TLS clients and servers.

NOTE: Minimum accepted RSA key size is 1024 bits and ECDSA curve 256 and 384.

configitem Protocols

value

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

However only these combinations are accepted:

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

configitem Private Key

value

Private Key may contain up to 4000 characters.

The Private Key is input and stored in PEM format.

configitem Certificate

value

Certificate may contain up to 4000 characters.

The Certificate is input and stored in PEM format.

configitem Higher Authority

The XML instance may range from 1 to 3.

value Certificate

Certificate may contain up to 4000 characters.

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.

configitem Trusted Authority

The XML instance may range from 1 to 5.

value Certificate

Certificate may contain up to 4000 characters.

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.

configgroup Tunnel Accept

The XML instance may be "1", "Virtual_1" or "Virtual_2".

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

configitem 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.

configitem Local Port

value

Blank the value for "<None>".

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

configitem 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.

configitem Protocol

value

Protocol may be "TCP" or "TLS".

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem Password

value

Password may contain up to 31 characters.

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.

configitem Prompt for Password

value

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

configgroup Tunnel Line

The XML instance may be "1", "Virtual_1" or "Virtual_2".

The Line Configuration applies to the Serial Line interface.

configitem 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.

configgroup Tunnel Connect

The XML instance may be "1", "Virtual_1" or "Virtual_2".

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

configitem 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.

configitem 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.

configitem 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.

configitem Host

The XML instance may range from 1 to 4.

value Address

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").

value Port

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.

value Protocol

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

value Credential

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.

value Initial Send

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.

value Reception

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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configitem 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.

configgroup Tunnel Disconnect

The XML instance may be "1", "Virtual_1" or "Virtual_2".

These settings relate to Disconnecting a Tunnel.

configitem 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>.

configitem 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.

configitem 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.

configitem Flush Line

value

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

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

configitem Exclusive

value

Exclusive may be "Enabled" or "Disabled".

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

configgroup Tunnel Packing

The XML instance may be "1", "Virtual_1" or "Virtual_2".

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

configitem 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.

configitem 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.

configitem 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.

configitem Flush While Unconnected

value

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

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

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

configitem 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.

configitem 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.

configitem 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>.

configgroup USB Device

configitem State

value

State may be "Enabled" or "Disabled".

configgroup Custom

User custom configuration values are stored under this group.

configitem 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.