You are on page 1of 27

for this setting.

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------

==========================================================================
radioSettingsHelpers
==========================================================================
radioSettingsHelpers.frequencyMasksErrors

Frequency Masks Error


* Returns results of any errors in the frequency mask.

type:string

--------------------------------------------------------------------------

==========================================================================
encryption
==========================================================================
encryption.encryptionMode=AES_CTR

Encryption mode

type:uint32_t default:AES_CTR
options:["AES_CTR","AES_CCM"]
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.activeKey=Off

The active selected key.

type:uint32_t default:Off
options:["Off","Key1","Key2","Key3","Key4",
"Key5","Key6","Key7","Key8","Key9",
"Key10","Key11","Key12","Key13","Key14",
"Key15","Key16"]
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key1=Key has not been set.

Manage Key1
USAGE - Key1=[128 or 256 key in hex]
example 128 bit key : Key1=1234567890abcdef1234567890abcdef
example 256 bit key :
Key1=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key1=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key2=Key has not been set.

Manage Key2
USAGE - Key2=[128 or 256 key in hex]
example 128 bit key : Key2=1234567890abcdef1234567890abcdef
example 256 bit key :
Key2=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key2=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key3=Key has not been set.

Manage Key3
USAGE - Key3=[128 or 256 key in hex]
example 128 bit key : Key3=1234567890abcdef1234567890abcdef
example 256 bit key :
Key3=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key3=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key4=Key has not been set.

Manage Key4
USAGE - Key4=[128 or 256 key in hex]
example 128 bit key : Key4=1234567890abcdef1234567890abcdef
example 256 bit key :
Key4=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key4=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key5=Key has not been set.

Manage Key5
USAGE - Key5=[128 or 256 key in hex]
example 128 bit key : Key5=1234567890abcdef1234567890abcdef
example 256 bit key :
Key5=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key5=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key6=Key has not been set.

Manage Key6
USAGE - Key6=[128 or 256 key in hex]
example 128 bit key : Key6=1234567890abcdef1234567890abcdef
example 256 bit key :
Key6=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key6=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key7=Key has not been set.

Manage Key7
USAGE - Key7=[128 or 256 key in hex]
example 128 bit key : Key7=1234567890abcdef1234567890abcdef
example 256 bit key :
Key7=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key7=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key8=Key has not been set.

Manage Key8
USAGE - Key8=[128 or 256 key in hex]
example 128 bit key : Key8=1234567890abcdef1234567890abcdef
example 256 bit key :
Key8=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key8=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key9=Key has not been set.

Manage Key9
USAGE - Key9=[128 or 256 key in hex]
example 128 bit key : Key9=1234567890abcdef1234567890abcdef
example 256 bit key :
Key9=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key9=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key10=Key has not been set.

Manage Key10
USAGE - Key10=[128 or 256 key in hex]
example 128 bit key : Key10=1234567890abcdef1234567890abcdef
example 256 bit key :
Key10=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key10=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key11=Key has not been set.

Manage Key11
USAGE - Key11=[128 or 256 key in hex]
example 128 bit key : Key11=1234567890abcdef1234567890abcdef
example 256 bit key :
Key11=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key11=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key12=Key has not been set.

Manage Key12
USAGE - Key12=[128 or 256 key in hex]
example 128 bit key : Key12=1234567890abcdef1234567890abcdef
example 256 bit key :
Key12=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key12=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key13=Key has not been set.

Manage Key13
USAGE - Key13=[128 or 256 key in hex]
example 128 bit key : Key13=1234567890abcdef1234567890abcdef
example 256 bit key :
Key13=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key13=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key14=Key has not been set.

Manage Key14
USAGE - Key14=[128 or 256 key in hex]
example 128 bit key : Key14=1234567890abcdef1234567890abcdef
example 256 bit key :
Key14=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key14=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key15=Key has not been set.

Manage Key15
USAGE - Key15=[128 or 256 key in hex]
example 128 bit key : Key15=1234567890abcdef1234567890abcdef
example 256 bit key :
Key15=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key15=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
encryption.Key16=Key has not been set.

Manage Key16
USAGE - Key16=[128 or 256 key in hex]
example 128 bit key : Key16=1234567890abcdef1234567890abcdef
example 256 bit key :
Key16=1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
example clear key : Key16=clear

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------

==========================================================================
dataPath
==========================================================================
dataPath.compressionEnabled=true

If compression is enabled out going packets will be sent compressed if the


compressed packet is smaller.

type:bool default:true
** Savable Configuration Item **
--------------------------------------------------------------------------
dataPath.otaMaxFragmentSize=1000

OTA Max Fragment Size


This is the max fragment size that will be sent over the
air. A larger number can increase throughput, but smaller
numbers may give better performance in a high interference
environment.

type:uint32_t min:64 max:1000 default:1000


** Savable Configuration Item **
--------------------------------------------------------------------------
dataPath.fecRate=RATE_1_1

Sets the FEC (Forward Error Correction) rate.


FEC increases the reliability of the data transferred over the
air at the cost of some transmission throughput.

RATE_1_1 - Disables FEC.


RATE_7_8 - Enables FEC with a packet overhead of about 13%,
but improves sensitivity and adds resilience in noisy
environments.

type:uint32_t default:RATE_1_1
options:["RATE_1_1","RATE_7_8"]
** Savable Configuration Item **
--------------------------------------------------------------------------
dataPath.aggregateEnabled=false

Enables the aggregation of smaller packets to enhance throughput.

type:bool default:false
** Savable Configuration Item **
--------------------------------------------------------------------------
dataPath.routeMinSignalMarginThresh=10

The radio route minimum signal level threshold in dB.


When repeaters are enabled, the packets will take the path
through the radio network with the minimum number of hops. This
threshold sets the minimum signal margin that a next hop should
have to be considered as part of the packet route. By
increasing this value, the possible routes can be reduced to
allow a particular routing path to be preferred.

Note: This value should be at least 4 dB lower than the


reported link margin to the next hop.

type:int min:-5 max:60 default:10


** Savable Configuration Item **
--------------------------------------------------------------------------
dataPath.MacTableEntryAgeTimeout=120
The number of seconds before an inactive entry in the MAC Table ages out and
becomes expired.
The radio network learns the MAC address of devices connected
to particular radio nodes and stores them in a MAC table. As
traffic passes between the nodes, the entries in the MAC table
are updated. If packets have not been sent or received to a
MAC address within the MacTableEntryAgeTimeout period, then the
entry in the table will be marked as expired. Expired entries
must be relearned and will generate some extra traffic on the
network until the radio node associated with the MAC address is
learned. This value can be optimized in the case of parallel
repeaters to allow for fail over. This timeout will affect the
time it takes to learn the new path.

Setting this value too small such that normal traffic does not
keep the MAC table entry from expiring may generate excess
network traffic. It is recommended that this timeout is longer
than the polling rate on the network.

Entries will not use the new timeout value until they are updated
when a packet transfer.

See MacTableShow to view the current entries.

Note: This is a Beta feature, not recommended for production deployment.

type:int min:30 max:86400 default:120


** Savable Configuration Item **
--------------------------------------------------------------------------

==========================================================================
localDiagnostics
==========================================================================
localDiagnostics.signalLevel=-128

Signal Level
Signal Level in dBm of last RX packet. Shows -128 if no packet has
been received since the stats were cleared.

type:int

--------------------------------------------------------------------------
localDiagnostics.signalMargin=-29

Signal Margin
* The amount of link margin in dB the last received packet experienced.

type:int

--------------------------------------------------------------------------
localDiagnostics.NoiseLevel=-119

Noise Level
* The amount of link noise measured in dB before the last packet was
transmitted.

type:int
--------------------------------------------------------------------------
localDiagnostics.VSWR=35

VSWR
This value is proportional to the VSWR (Voltage Standing Wave
Ratio) measured from the last packet transmitted. The value
can range from 1 to 2 for an excellent match, 2 to 10 for a
good match and it will be > 100 for a poor match on the antenna
port. A value of 0 indicates the VSWR reading is not up to
date or cannot be determined.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.TxSuccess=100

Transmit Success Percentage


* Percentage of packets that were transmitted with a successful ACK received.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.TxAvailability=100

Transmit Availability Percentage


* Percentage of packets that were transmitted without back-off.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RxSuccess=100

Receive Success Percentage


* Percentage of packets correctly received for this node.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.timestamp=3873

Diagnostics Time Stamp


* This is the time at which the Diagnostics Information was collected by the
device.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioTx=2

Radio Tx Data Packets


* Number data of packets scheduled to be transmitted.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioRx=0

Radio Rx Data Packets


* Number of data packets correctly received for this node.
type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioReliableTx=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioReliableRx=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioRexmit=0

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioAckTx=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioNoAckTx=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioTimedOut=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioBadAckRx=0

Radio Bad ACK Received


* Number of received ACKs missed in unicast transmissions.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioTooLong=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioTooShort=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioBadSync=0

Radio Bad Synchronization


Number of times beacons were lost such that the Endpoint needed
to re-synchronize with the Gateway when radioHoppingMode=True.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioBadCRC=0

Radio Bad CRC on RX packets.


* Number of radio packets received with data corruption.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioContentionDrop=0

Radio Contention Drop


* Number of times a transmission was backed-off due to contention on the RF
channel.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioSendingDrop=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioLLTx=1

Radio Low Level Transmit


* Number of packets transmitted over the air.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.RadioLLRx=0

Radio Low Level Receive


* Number of packets received over the air without data corruption.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.cntSTX=76
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.cntETX=76
* For internal use only.

type:uint32_t
--------------------------------------------------------------------------
localDiagnostics.cntBadSync=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.cntBadBCC=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.interfaceDataTx=12
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.interfaceDataRx=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.interfaceBytesTx=4092
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.interfaceBytesRx=4006
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.resetsDetected=2
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.resetsSent=0
* For internal use only.

type:uint32_t

--------------------------------------------------------------------------
localDiagnostics.resetStats

Reset Statistics
* Reset localDiagnostic counters.

type:execute
options:["Now"]

--------------------------------------------------------------------------
localDiagnostics.getStats
Get Statistics
* Retrieve the localDiagnostics from the radio now.

type:execute *Read Only

--------------------------------------------------------------------------
localDiagnostics.monitoredNode=64206

Monitor Node
Set this parameter to the node id of a device to monitor the
signal level. Use the showNodeDiags command to view the
received signal level (RSSI) of this node.

type:uint16_t min:1 max:65533 default:64206


** Savable Configuration Item **
--------------------------------------------------------------------------
localDiagnostics.showChannelDiags

Show Channel Diagnostics


Display the received signal level (RSSI)and node ID of the last
packet received on the displayed frequencies.

type:execute *Read Only

--------------------------------------------------------------------------
localDiagnostics.showNodeDiags

Show Monitored Node Diagnostics


Display the received signal level (RSSI) and node ID of the last
packet received on the displayed frequencies for the
monitored node.

type:execute *Read Only

--------------------------------------------------------------------------
localDiagnostics.MacTableShow

Show the MAC to nodeId mapping table.

type:execute

--------------------------------------------------------------------------
localDiagnostics.MacTableClear

Clear the MAC to nodeId mapping table and force routes to be relearned.

type:execute
options:["Now"]

--------------------------------------------------------------------------
localDiagnostics.SupplyVoltage

Supply Voltage
The supply voltage to this radio in units of V.
Radios that do not support this measurement will report 0 V.

type:float
--------------------------------------------------------------------------

==========================================================================
config
==========================================================================
config.reset

type:execute
options:["Idle","Now","Reboot","Reset"]

--------------------------------------------------------------------------
config.factoryDefaults

type:execute
options:["Idle","Set"]

--------------------------------------------------------------------------
config.save

type:execute
options:["Now"]

--------------------------------------------------------------------------
config.restore

type:execute
options:["Now"]

--------------------------------------------------------------------------
config.licenseState

type:execute

--------------------------------------------------------------------------

==========================================================================
services
==========================================================================
services.timeOutCli=900

The number of seconds of idle before cli connection will be closed.

type:uint32_t min:0 max:3600 default:900


** Savable Configuration Item **
--------------------------------------------------------------------------

==========================================================================
network
==========================================================================
network.mac_address=00:1d:e3:01:04:a3

type:mac *Read Only

--------------------------------------------------------------------------
network.ip_address=192.168.111.100

IP address of unit when DHCP is disabled.

type:address default:192.168.111.100
** Savable Configuration Item **
--------------------------------------------------------------------------
network.netmask=255.255.255.0

Netmask of unit when DHCP is disabled.

type:address default:255.255.255.0
** Savable Configuration Item **
--------------------------------------------------------------------------
network.gateway=192.168.111.1

Gateway of unit when DHCP is disabled.

type:address default:192.168.111.1
** Savable Configuration Item **
--------------------------------------------------------------------------
network.stpEnabled=false

Spanning tree protocol is enabled or disabled.

type:bool default:false
** Savable Configuration Item **
--------------------------------------------------------------------------
network.txqueuelen=25

Sets the Ethernet transmit packet queue length.


The parameter sets how many Ethernet packets to hold in the transmit queue
before sending them over the radio link. Large numbers can increase latency
if the packets are arriving at the Ethernet interface at an average rate that
is above the capacity of the radio link. If the queue size is too small in
Ethernet network with a high rate of small packets, then packets could be lost.

type:uint32_t min:1 max:1000 default:25


** Savable Configuration Item **
--------------------------------------------------------------------------
network.mtu=1500

Sets the MTU frame size for the unit.


The MTU size effects communications that originate or terminate on this
device, such as the web services or the Terminal Servers. All other traffic
passing through the radio network is also affected by this setting and the
value will
need to be increased to support jumbo size frames that exceed the normal 1500
byte MTU.

type:uint32_t min:100 max:1994 default:1500


** Savable Configuration Item **
--------------------------------------------------------------------------
network.nameserver_address1=8.8.8.8

DNS for name-to-address resolution.

type:address default:8.8.8.8
** Savable Configuration Item **
--------------------------------------------------------------------------
network.nameserver_address2=8.8.4.4

DNS for name-to-address resolution.


type:address default:8.8.4.4
** Savable Configuration Item **
--------------------------------------------------------------------------
network.netmaskFilterEnabled=false

Enable or disable bridge firewall.


Enable a bridge firewall to restrict network communication to current IPv4
subnet.
This will limit only IPv4 communication that is in the netmask parameter
to enter into the radio network.

type:bool default:false
** Savable Configuration Item **
--------------------------------------------------------------------------
network.arpFilterEnabled=false

Enable or disable ARP filtering in bridge firewall.


Switch for the bridge firewall to allow only ARP communication
that is in the netmask parameter to enter into the radio network.

type:bool default:false
** Savable Configuration Item **
--------------------------------------------------------------------------
network.vlanMgmt=0

Management VLAN ID for the device


If the Management VLAN ID is set, users can only access the device from
the same VLAN ID. If the vlanTag is set on a specific ethernet port,
that port cannot be used to access the Management VLAN ID. Management VLAN
ID needs to be different from any of the vlanTag ID. Set the value to 0
to disable Management VLAN.

type:uint32_t min:0 max:4094 default:0


** Savable Configuration Item **
--------------------------------------------------------------------------
network.vlanTag=0

VLAN Tag ID for the Ethernet port


The VLAN Tag ID is used to strip off VLAN Tag ID for egress traffic for
the Ethernet port and to add VLAN Tag ID for ingress traffic for the
Ethernet port. Set the value to 0 to disable VLAN tagging for the Ethernet
port and allow VLAN tags to pass unchanged through the device.

type:uint32_t min:0 max:4094 default:0


** Savable Configuration Item **
--------------------------------------------------------------------------

==========================================================================
networkStats
==========================================================================
networkStats.rx_bytes=0

Number bytes of Ethernet packets received from the radio network.

type:uint32_t

--------------------------------------------------------------------------
networkStats.rx_packets=0
Number of Ethernet packets received from the radio network.

type:uint32_t

--------------------------------------------------------------------------
networkStats.rx_dropped=0

Number of Ethernet packets received from the radio network that were dropped at
the Ethernet interface.

type:uint32_t

--------------------------------------------------------------------------
networkStats.rx_errors=0

Number of Ethernet packets received from the radio network that were had Ethernet
errors.

type:uint32_t

--------------------------------------------------------------------------
networkStats.tx_bytes=896

Number bytes of Ethernet packets received from the Ethernet port and sent over
the radio network.

type:uint32_t

--------------------------------------------------------------------------
networkStats.tx_packets=12

Number Ethernet packets received from the Ethernet port and sent over the radio
network.

type:uint32_t

--------------------------------------------------------------------------
networkStats.tx_dropped=0

Number Ethernet packets received from the Ethernet port but dropped because the
txqueue was full.
An increase of this counter may indicate that increasing the txqueuelen
parameter may improve
overall network performance.

type:uint32_t

--------------------------------------------------------------------------
networkStats.tx_errors=0

Number Ethernet packets received from the Ethernet port that were in error.

type:uint32_t

--------------------------------------------------------------------------

==========================================================================
ntp
==========================================================================
ntp.ntpReference=NETWORK_TIME_SERVER

Clock reference for NTP.


* NETWORK_TIME_SERVER - The reference will come from other systems on the
network.
* REFCLK_LOCALCLOCK - The reference will be generated by the local clock.

Ntp is always running. This setting determines if the time corrections are
comming
from the local clock or if thay are comming over the network. If no server
address
is set then the reference will fallback to local clock,

If any of the addresses ntp_address1-ntp_address5 are valid then at startup and


whenever ntp restarts the system clock will be set form the ntp servers over
the
network.

type:uint32_t default:NETWORK_TIME_SERVER
options:["NETWORK_TIME_SERVER","REFCLK_LOCALCLOCK"]
** Savable Configuration Item **
--------------------------------------------------------------------------
ntp.ntpRestart

Cause the ntp system to restart.


If any of the addresses ntp_address1-ntp_address5 are valid then
the system clock will be set form the ntp servers over the network
at the time command is ran.

type:execute
options:["Now"]

--------------------------------------------------------------------------
ntp.ntpDate

Set the local time from other NTP servers on the network.
This command will set the local clock with the time from the NTP
servers specified in ntp_address1-ntp_address5. The server with
the best clock, as defined by the NTP protocol will be used.

type:execute
options:["Now"]

--------------------------------------------------------------------------
ntp.ntp_address1

Server to be used for syncing time. Use 0.0.0.0 to skip this server.
This can be a server such as time.nist.gov time1.google.com or it can be
the IP address of another radio in the network.
A common usecase is to have all of the endpoints and repeaters use
the IP address of the gateway radio then the entire network will stay
synced to the gateway time.

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
ntp.ntp_address2

Server to be used for syncing time. Use 0.0.0.0 to skip this server.
type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
ntp.ntp_address3

Server to be used for syncing time. Use 0.0.0.0 to skip this server.

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
ntp.ntp_address4

Server to be used for syncing time. Use 0.0.0.0 to skip this server.

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------
ntp.ntp_address5

Server to be used for syncing time. Use 0.0.0.0 to skip this server.

type:string
** Savable Configuration Item **
--------------------------------------------------------------------------

==========================================================================
Com1
==========================================================================
Com1.mode=RS232

Com port mode


* RS232 or RS485 mode

type:uint32_t default:RS232
options:["RS232"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.handler=TerminalServer

Protocol of the com port


* TerminalServer - The com port will act as a terminal server. The TCP port
number is set by the
com1.TerminalServerPort parameter. The default port number is 5041.
* Cli - A configuration cli is on the com port.
* Trace - A configuration cli with trace is on the com port.
* ModbusRTU - Receive modbus RTU requestes from a serial modbus RTU
device.
* ModbusPassthru - Send out modbus requests to modbus sensors that are received
via modbus TCP or modbus RTU.
* Setup - Setup the com port then free up the port for application
use.
* off - Allow for application use with no setup. Port is never
opened.

type:uint32_t default:TerminalServer
options:["ModbusRTU","TerminalServer","Cli","ModbusPassthru","Trace",
"Setup","off"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.baudrate=115200

Com port baud rate

type:uint32_t default:115200
options:["1200","2400","4800","9600","14400",
"19200","38400","57600","115200","230400",
"460800","921600"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.databits=8

Com port data bits

type:uint32_t default:8
options:["7","8"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.parity=None

Com port parity

type:uint32_t default:None
options:["None","Even","Odd"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.stopbits=1

Com port number of stop bits

type:uint32_t default:1
options:["1","2"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.duplex=Full

Com port is full or half duplex

type:uint32_t default:Full
options:["Full"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.flowControl=Off

Com port hardware flow control is not supported.

type:uint32_t default:Off
options:["Off","Hardware"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.delayBeforeSendMs=0

Com port will delay sending in Ms to allow the other side to switch from tx to rx
mode.

type:uint32_t min:0 max:5000 default:0


** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.breakBeforeSendUs=0

Com port will send a break signal for at least the number of microseconds
specified before sending the data.

type:uint32_t min:0 max:1000 default:0


** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.TerminalServerPort=5041

The TCP port number to use when handler is set to TerminalServer.

type:uint32_t min:0 max:65535 default:5041


** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.TerminalServerTimeOut=300

Terminal Server TimeOut


The amount of time that the Terminal Server connection will remain open without
data being received or transmitted from the network. The value is in seconds.

type:uint32_t min:5 max:3600 default:300


** Savable Configuration Item **
--------------------------------------------------------------------------
Com1.TxBytes=0

The total bytes sent out of the Com port.

type:uint32_t

--------------------------------------------------------------------------
Com1.RxBytes=0

The total bytes received from the Com port.

type:uint32_t

--------------------------------------------------------------------------
Com1.ConnectionDrops=0

The number of terminal server connections dropped due to inactivity.


The number of drops will only increment if a connection is left open and
no data is sent. Connections that are closed by either side before the
time out are not considered a dropped connection.

type:uint32_t

--------------------------------------------------------------------------

==========================================================================
Com2
==========================================================================
Com2.mode=RS232

Com port mode


* RS232 or RS485 mode

type:uint32_t default:RS232
options:["RS232"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.handler=TerminalServer

Protocol of the com port


* TerminalServer - The com port will act as a terminal server. The TCP port
number is set by the
com2.TerminalServerPort parameter. The default port number is 5042.
* Cli - A configuration cli is on the com port.
* Trace - A configuration cli with trace is on the com port.
* ModbusRTU - Receive modbus RTU requestes from a serial modbus RTU
device.
* ModbusPassthru - Send out modbus requests to modbus sensors that are received
via modbus TCP or modbus RTU.
* Setup - Setup the com port then free up the port for application
use.
* off - Allow for application use with no setup. Port is never
opened.

type:uint32_t default:TerminalServer
options:["ModbusRTU","TerminalServer","Cli","ModbusPassthru","Trace",
"Setup","off"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.baudrate=115200

Com port baud rate

type:uint32_t default:115200
options:["1200","2400","4800","9600","14400",
"19200","38400","57600","115200","230400",
"460800","921600"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.databits=8

Com port data bits

type:uint32_t default:8
options:["7","8"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.parity=None

Com port parity

type:uint32_t default:None
options:["None","Even","Odd"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.stopbits=1

Com port number of stop bits

type:uint32_t default:1
options:["1","2"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.duplex=Full
Com port is full or half duplex

type:uint32_t default:Full
options:["Full"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.flowControl=Off

Com port hardware flow control is on or off

type:uint32_t default:Off
options:["Off","Hardware"]
** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.delayBeforeSendMs=0

Com port will delay sending in Ms to allow the other side to switch from tx to rx
mode.

type:uint32_t min:0 max:5000 default:0


** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.breakBeforeSendUs=0

Com port will send a break signal for at least the number of microseconds
specified before sending the data.

type:uint32_t min:0 max:1000 default:0


** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.TerminalServerPort=5042

The TCP port number to use when handler is set to TerminalServer.

type:uint32_t min:0 max:65535 default:5042


** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.TerminalServerTimeOut=300

Terminal Server Time Out


The amount of time that the Terminal Server connection will remain open without
data being received or transmitted from the network. The value is in seconds.

type:uint32_t min:5 max:3600 default:300


** Savable Configuration Item **
--------------------------------------------------------------------------
Com2.TxBytes=0

The total bytes sent out of the Com port.

type:uint32_t

--------------------------------------------------------------------------
Com2.RxBytes=0

The total bytes received from the Com port.

type:uint32_t
--------------------------------------------------------------------------
Com2.ConnectionDrops=0

The number of terminal server connections dropped due to inactivity.


The number of drops will only increment if a connection is left open and
no data is sent. Connections that are closed by either side before the
time out are not considered a dropped connection.

type:uint32_t

--------------------------------------------------------------------------

==========================================================================
TerminalServerRelay
==========================================================================
TerminalServerRelay.termserv_relay_mapping=TERMSERV_RELAY_DISABLED

Options for streaming between serial device servers.


The device supports the transfer of a bidirectional byte stream between
two serial device servers. At this time, the data relay is only supported
between the terminal server on this device and the terminal server on a
separate device on the same IP network. This relay function should only
be enabled on one side of the connection.

For the relay funtion to operate, COM1 must be assigned to port 5041,
and COM2 must be assigned to port 5042 on both the local and remote
terminal servers.

TERMSERV_RELAY_DISABLED
* Data forwarding between local and remote COM ports is disabled.

LOCAL_BOTH_COM_TO_REMOTE_BOTH_COM
* Data is forwarded between the local COM1 and remote COM1 ports.
* Data is forwarded between the local COM2 and remote COM2 ports.

LOCAL_COM1_TO_REMOTE_COM1
* Data is forwarded between the local COM1 and remote COM1 ports.

LOCAL_COM2_TO_REMOTE_COM2
* Data is forwarded between the local COM2 and remote COM2 ports.

LOCAL_BOTH_COM_TO_REMOTE_COM1
* Data is forwarded between the local COM1 and remote COM1 ports.
* Data is forwarded between the local COM2 and remote COM1 ports.

LOCAL_BOTH_COM_TO_REMOTE_COM2
* Data is forwarded between the local COM1 and remote COM2 ports.
* Data is forwarded between the local COM2 and remote COM2 ports.

LOCAL_COM1_TO_REMOTE_BOTH_COM
* Data is forwarded between the local COM1 and remote COM1 ports.
* Data is forwarded between the local COM1 and remote COM2 ports.

LOCAL_COM2_TO_REMOTE_BOTH_COM
* Data is forwarded between the local COM2 and remote COM1 ports.
* Data is forwarded between the local COM2 and remote COM2 ports.

type:uint32_t default:TERMSERV_RELAY_DISABLED
options:
["TERMSERV_RELAY_DISABLED","LOCAL_BOTH_COM_TO_REMOTE_BOTH_COM","LOCAL_COM1_TO_REMOT
E_COM1","LOCAL_COM2_TO_REMOTE_COM2","LOCAL_BOTH_COM_TO_REMOTE_COM1",

"LOCAL_BOTH_COM_TO_REMOTE_COM2","LOCAL_COM1_TO_REMOTE_BOTH_COM","LOCAL_COM2_TO_REMO
TE_BOTH_COM"]
** Savable Configuration Item **
--------------------------------------------------------------------------
TerminalServerRelay.remote_termserv_ip_address=0.0.0.0

IP address of remote terminal server.

type:address default:0.0.0.0
** Savable Configuration Item **
--------------------------------------------------------------------------

==========================================================================
date
==========================================================================
date.upTime=46

The number of seconds since the unit restarted.

type:uint32_t

--------------------------------------------------------------------------
date.upTimeString=Uptime 0Days 00h:00m:46s

The number days, hours:minutes:seconds since the unit restarted.

type:execute

--------------------------------------------------------------------------
date.dcAppUptime=Uptime 0Days 00h:00m:16s

The number of seconds since the main app restarted.

type:uint32_t *Read Only

--------------------------------------------------------------------------
date.dcAppStartTime=01/01/1970 01:04:19

The timestamp of when the main app restarted.

type:uint32_t

--------------------------------------------------------------------------
date.time=3875

The current time in unix timestamp format.

type:uint32_t

--------------------------------------------------------------------------
date.timeString=01/01/1970 01:04:35

The current time.

type:execute
--------------------------------------------------------------------------

==========================================================================
snmp
==========================================================================
snmp.v1Enabled=false

SNMP V1 Enable/Disable
* true enables SNMP V1, false disables SNMP V1

type:bool default:false
** Savable Configuration Item **
--------------------------------------------------------------------------
snmp.v2cEnabled=false

SNMP V2C Enable/Disable


* true enables SNMP V2C, false disables SNMP V2C

type:bool default:false
** Savable Configuration Item **
--------------------------------------------------------------------------
snmp.v3Enabled=false

SNMP V3 Enable/Disable
* true enables SNMP V3, false disables SNMP V3

type:bool default:false
** Savable Configuration Item **
--------------------------------------------------------------------------
snmp.roCommunityName=public

Read-Only Community Name


* Community name string for SNMP V1/V2C read-only access.

type:string default:public
** Savable Configuration Item **
--------------------------------------------------------------------------
snmp.rwCommunityName=private

Read-Write Community String


* Community name string for SNMP V1/V2C read-write access.

type:string default:private
** Savable Configuration Item **
--------------------------------------------------------------------------
snmp.snmpUser
This item manages the SNMP V3 users. These operations are supported:

View All Users:


snmpUser show

Add User:
snmpUser add <username> <ReadOnly or ReadWrite> <MD5 or SHA> <Authentication
Passphrase> <AES or DES> <Encryption Passphrase>

Modify User:
snmpUser modify <username> <ReadOnly or ReadWrite> <MD5 or SHA> <Authentication
Passphrase> <AES or DES> <Encryption Passphrase>
Remove User:
snmpUser remove <username>

Note: The Passphrase has a minimum character length of 8.

type:execute

--------------------------------------------------------------------------

==========================================================================
security
==========================================================================
security.enablePtpInterface=true

Enable PTP interface

This item enables or disables the PTP (drag-and-drop) interface.

When disabled, the device will no longer appear in Windows Explorer


as "xxxxxx-<serialnumber>" when connected to a computer via a
Micro-USB cable. Where xxxxx is the name of the device.
This does NOT disable serial connections through the Micro-USB cable.

Changes to this setting require a reboot to be applied, either by


executing the "reset now" CLI command or powercycling the unit.

type:bool default:true
** Savable Configuration Item **
--------------------------------------------------------------------------
security.enableEthernetLogin=true

Enable SSH logins

This item enables or disables SSH logins.

When disabled, the device will no longer respond to SSH connection


requests. This also disables any SSH-based services, such as SCP.
This does NOT affect website logins.

Changes to this setting require a reboot to be applied, either by


executing the "reset now" CLI command or powercycling the unit.

type:bool default:true
** Savable Configuration Item **
--------------------------------------------------------------------------

==========================================================================
runtimeEnvironment
==========================================================================
runtimeEnvironment.rteReset

Runtime Environment Reset

This item manages the upgrade or reset of the runtime developer


environment for the development user.

"rteReset Hard" completely resets the file system of the runtime


developer environment to match the latest installed developer user
package. ALL USER-GENERATED CONTENT AND SETTINGS WILL BE DELETED
AFTER THE NEXT REBOOT!

The runtime developer environment reset takes place at the time of


next boot. If you change your mind and do not want the reset to
take effect on the next boot, type "rteReset Cancel".

type:execute
options:["Cancel","Hard"]

--------------------------------------------------------------------------
runtimeEnvironment.rteVersion=EB-X1122TP.16

Runtime Environment Version

This item provides the version number for the active developer
environment.

If blank, the developer environment has not yet been initialized.

type:execute

--------------------------------------------------------------------------
runtimeEnvironment.rteTemplateVersion=EB-X1122TP.16

Runtime Template Environment Version

This item provides the version number for the developer environment
template.

This is the developer environment that will be applied when executing


the "rteReset hard" command (see "runtimeEnvironment.rteReset").

type:execute

--------------------------------------------------------------------------
runtimeEnvironment.rteInstalledByAppsVersion=EB-X1122TB.66

Runtime Environment Installed By Apps Version

This item provides the version number of the firmware that was
used to install the runtime developer environment.

Note that the firmware that installed the runtime developer


environment may have a different version than the developer
environment itself.

type:execute

--------------------------------------------------------------------------

==========================================================================
Modbus
==========================================================================
Modbus.modbusDeviceId=1

Modbus Device Identifier

type:uint32_t default:1
** Savable Configuration Item **
--------------------------------------------------------------------------
Modbus.modbusTcp=502

type:uint32_t min:0 max:65535 default:502


** Savable Configuration Item **
--------------------------------------------------------------------------
Modbus.modbusRtuOverTcp=5021

type:uint32_t min:0 max:65535 default:5021


** Savable Configuration Item **
--------------------------------------------------------------------------
Modbus.read

type:execute

--------------------------------------------------------------------------
Modbus.write

type:execute

--------------------------------------------------------------------------
Modbus.readCoils

type:execute

--------------------------------------------------------------------------
Modbus.writeCoils

type:execute

--------------------------------------------------------------------------
Modbus.modbusLayout

type:execute

--------------------------------------------------------------------------

==========================================================================
ioExCom
==========================================================================
ioExCom.ioExDeviceId=100

type:uint32_t min:1 max:247 default:100


** Savable Configuration Item **
--------------------------------------------------------------------------
RESULT:0:OK
>

You might also like