RUTX11 Serial Utilities

Wiki mirrorView source
The information in this page is updated in accordance with firmware version RUTX_R_00.07.22.1.

Summary

The Serial Utilities page is used to make serial communication configurations of different types. This manual page provides an overview of the Serial Utilities page in RUTX11 devices.

Modem Control

The Modem serial type is used to manage modem functionality which could be accessed using shell interface. For this purpose you may want use CR/LF (Carriage Return, Line Feed) capable applications like PuTTY on Windows and microcom, minicom, cutecom or similar applications on Linux.

Status

General settings

FieldValueDescription
Enableoff | on; default: offTurns the instance on or off.
Namestring; default: noneInstance name, generated by the user when first creating the configuration.
DeviceUSB RS232 interface; default: USB RS232 interfaceSpecifies which serial port will be used for serial communication.
Baud rate (USB)integer [300..4000000]; default:9600Data rate for serial data transmission (in bits per second (bps)).
Data bits8; default: 8Number of data bits for each character.
Stop bits1 | 2; default: 1Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.
ParityNone | Odd | Even | Mark | Space; default: NoneIn serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
  • None (N) - no parity method is used.
  • Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.
  • Even (E) - the parity bit is set so that the number of "logical ones (1s)" has to be even.
Flow controlNone; default: NoneIn many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.
ModePartial control | Full control; default: Partial controlSpecifies modem control mode.
  • Partial control- enables modem control with AT commands, mobile connection will be controlled by RUTOS.
  • Full control- enables modem control with AT commands, mobile connection will be controlled by user.

Advanced settings

FieldValueDescription
Start up messagestring; default: nonePrints message to serial device when modem control is ready.
Canonical modeoff | on; default: offForwards data to modem only when new line symbol ('\n') is detected.

Console

Console mode requires no further configuration than the settings above and is used as a direct-access method to the device's shell interface. For this purpose you may want use such applications as PuTTY on Windows and microcom, minicom, picocom or similar applications on Linux.

Status

General settings

FieldValueDescription
Enableoff | on; default: offTurns the instance on or off.
Namestring; default: noneInstance name, generated by the user when first creating the configuration.
DeviceUSB RS232 interface; default: USB RS232 interfaceSpecifies which serial port will be used for serial communication.
Baud rate (USB)integer [300..4000000]; default:9600Data rate for serial data transmission (in bits per second (bps)).
Data bits8; default: 8Number of data bits for each character.
Stop bits1 | 2; default: 1Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronize with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.
ParityNone | Odd | Even | Mark | Space; default: NoneIn serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
  • None (N) - no parity method is used.
  • Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.
  • Even (E) - the parity bit is set so that the number of "logical ones (1s)" has to be even.
Flow controlNone; default: NoneIn many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.

Over IP

The Over IP serial type is used to manage serial connections over a TCP/IP network.

Instance Example

Here's an example demonstrating Over IP in action, running in Client + Server Mode.

Serial Device Configuration

Configure serial port communication parameters in the Serial Device Configuration section.
FieldValueDescription
Enableoff | on; default: offTurns the instance on or off.
Namestring; default: noneInstance name, generated by the user when first creating the configuration.
DeviceUSB RS232 interface; default: USB RS232 interfaceSpecifies which serial port will be used for serial communication.
Baud rate (USB)integer [300..4000000]; default:9600Data rate for serial data transmission (in bits per second (bps)).
Data bits8; default: 8Number of data bits for each character.
Stop bits1 | 2; default: 1Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.
ParityNone | Odd | Even | Mark | Space; default: NoneIn serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check.
  • None (N) - no parity method is used.
  • Odd (O) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.
  • Even (E) - the parity bit is set so that the number of "logical ones (1s)" has to be even.
Flow controlNone; default: NoneIn many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking.

Over IP Configuration Settings

You can configure network related parameters of the serial connection in the Over IP Configuration secion.
FieldValueDescription
ModeServer | Client | Client + server | Bidirect; default: ServerThis device's role in the connection:
  • Server - the device waits for incoming connections.
  • Client - the device initiates the connection.
  • Client + server - launches service in server and client(s) mode simultaneously.
  • Bidirect - acts as client by default but waits for incoming connections at the same time.
ProtocolTCP | UDP; default: TCPProtocol used in the communication process.
Client: Destination addressIP | Port; default: emptySpecify server address and port for client to connect to. E.g first field for address second for port. 16 destination addresses are allowed.
Server: UDP: Predefined addressesIP | Port; default: emptySet predefined IP and port for UDP connection. E.g first field for address second for port.
Listening port[1..65535]; default: emptyWhen enabled, all data will be transmitted transparently.
FieldValueDescription
Use TLS/SSLoff | on; default: offMark to use TLS/SSL for connection.
TLS versionSupport all | tlsv1.0 | tlsv1.1 | tlsv1.2 | tlsv1.3; default: Support allMinimum TLS version allowed to be used.
TLS typeCertificate based | Pre-Shared-Key based; default: Certificate basedSelect the type of TLS encryption.
Require certificateoff | on; default: onDemand certificate and key from peer and verify them against certificate authority.
Verify hostoff | on; default: offCheck if the server certificates Common Name (CN) matches hostname to which client is connecting.
Certificate files from deviceoff | on; default: offChoose this option if you want to select certificate files from device.
Certificate files can be generated <a class=link href="/system/admin/certificates/generation">here</a>.
Certificate file.crt file; default: noneUpload certificate file.
Key file.key file; default: noneUpload key file.
CA file.ca file; default: noneUpload CA file.
Pre-Shared-Keystring; default: noneThe pre-shared-key in hex format with no leading “0x”.
Identifystring; default: noneSpecify the identity.
FieldValueDescription
Raw modeoff | on; default: onWhen enabled, all data will be transmitted transparently.
Remove all zerosoff | on; default: offWhen checked, indicates that the first hex zeros should be skipped.
Inactivity timeoutinteger [0..36000]; default: 300Specifies period of time in seconds, where server connection must be inactive, to disconnect client. To disable timeout input 0.
Serial timeoutinteger [0..1000]; default: noneSpecifies the maximum milliseconds to wait for serial data.
Max clientsinteger [1..32]; default: 4Specify how many clients are allowed to connect simultaneously.
TCP echoon | off; default: offEnable software TCP echo.
Close connectionson | off; default: offClose TCP connections everytime data is sent or received (might result in serial data loss).
Keep aliveon | off; default: offEnable keep alive.
Keep alive timeinteger [0..32000]; default: 0Close TCP connections everytime data is sent or received (might result in serial data loss).
Keep alive intervalinteger [0..32000]; default: 0The interval between subsequential keepalive probes.
Keep alive probesinteger [0..32000]; default: 0The number of unacknowledged probes.

IP Filter

The IP Filter section is used for configuring which network is allowed to communicate with the device. You may add a new instance by selecting the Interface and pressing Add.
Then enter the IP address and save.