avatar  

Log out

Recently viewed tickets

SiteManager GUI - System & Serial

Normally, the serial port is automatically configured by a suitable vendor-specific serial device agent (see Appendix F for details), or if no such agent is active, it works as a management console to a terminal connected to this port. Using this configuration page, you can enable remote serial port access through the custom serial agent instead.

The remote access makes it possible for a remote client to connect to the serial port using the Telnet protocol so data can be directly transmitted and received on this port. Optionally, the baud rate and other settings of the serial port may also be controlled remotely (according to RFC 2217).

A final general note: If the Serial Port "Protocol" parameter is set to "Vendor Agent Controlled" the Management console mode is automatically re-enabled even though the SiteManager is CONMUTE-enabled. See Escape Character for information on how temporarily re-enable the Management console mode without disabling the Serial Port "Protocol" parameter.

Serial port configuration (on this SiteManager)

  • Protocol
    This is where you enable remote use of the serial port by selecting a protocol. Settings:
    • Vendor Agent Controlled - Remote use of the serial port is controlled by activating a vendor-specific serial agent; in this case, the rest of the fields on this page reflect the actual serial port settings. If no vendor-specific agent is active, the port is used by the SiteManager management console.
    • SMS Modem - Serial Port operates as an SMS Modem.
    • Telnet - Standard telnet protocol with fixed serial port settings.
    • Telnet (RFC2217) - Telnet protocol with RFC2217 extensions to allow remote control over serial port settings.
    • Raw - No higher level protocol; all bytes are forwarded without further interpretation.
    • Raw+Telnet - Opens two ports, one with Raw protocol, and another with Telnet protocol.
    • Raw+Telnet(2217) - Opens two ports, one with Raw protocol, and another with RFC2217 enabled Telnet protocol.


  • Serial Driver
    This parameter selects the basic low-level operating mode for the serial port.
    • Standard - The serial port is configured as unidirectional (telnet to serial only) with no modem signalling.
    • Bidir (DTE) - The serial port is configured as a bi-directional port with DTE-compatible modem signalling.
    • Bidir (DCE) - The serial port is configured as a bi-directional port with DCE-compatible modem signalling.
    • Auto-Relay (DTE) - Like Bidir (DTE), with automatically out-going connection via server relay.
    • Auto-Relay (DCE) - Like Bidir (DCE), with automatically out-going connection via server relay.

    The bi-directional operating modes allow the equipment attached to the serial port to initiate out-going Telnet connections. These modes typically need special protocol support in the attached equipment, as well as using the correct serial cables, so you should consult with your point of purchase before using them.

    The auto-relay operating modes are like the corresponding bi-directional modes, but the SiteManager will automatically try to connect to the internal address 127.0.0.1:123 - assuming that there is a suitable static server relay with this Server Virtual Address forwarding the traffic to a central service (or via a device relay to another SiteManager's serial port).



  • Serial Driver Frame Size
  • Serial Driver Frame Timeout
    When data is received on the serial port, the SiteManager attempts to group multiple bytes into each packet sent over the network, partially to limit network overhead, and to deliver data in packets suitable for the remote peer. The grouping is based on reading a minimum number of bytes from the serial port, and/or waiting a specified number of milli-seconds after the last received byte to detect an inter-frame gap.
    These parameters can be set to a non-zero value to override the default framing parameters on the serial port. Valid sizes are 1 to 255 bytes and valid timeouts are 10 to 2550 milli-seconds.

  • Send Break on Connect
  • Send Break on Disconnect
    When an incoming connection is opened or closed, it is possible to send a break signal on the serial line to notify the attached serial device; these settings specify the duration of the break signal in milli-seconds; a zero value (default) means no break signal is sent to the device.

  • Port Number
    This is the TCP port number used by the remote client to access the serial port. If both Raw and Telnet protocols are opened, the Raw protocol uses this port number, while the Telnet protocol uses this port number plus one.

  • Interface
    Normally the serial port can only be accessed from a LinkManager. If you select the "Any" option, you can also connect directly to the serial port by making a TCP connection to the specified port number via any interface; this includes the UPLINK ports, so be very careful if you use this option.

  • Inactivity Timeout
    Here you specify the timeout for automatic disconnection of the remote client when there is no activity on the serial port. The timeout is the number of seconds to wait after the last byte is received or transmitted on the serial port. A value of 0 disables the automatic disconnect function, so the connection will never timeout.

  • Baud Rate , Parity , Data Bits , Stop Bits
    These parameters specify the corresponding settings on the serial port; if RFC2217 is allowed, they specify the initial settings on the port.

  • Flow Control
    This parameter specifies the flow control method used on the serial port. The default is no flow control, but depending on the device you attach to the serial port, you can choose to use XON/XOFF software handshake or RTS/CTS hardware handshake to guard against data loss on the serial port.

  • Escape Character
    When you the enable remote serial port access, the normal management console on the serial port will be disabled, but if you need to use the management console, you can enable it temporarily by:
    1. connecting a terminal (or PC) to the serial port,
    2. setting the communication parameters of the terminal to match those of the serial port (typically 19200 baud, no parity, 8 data bits, 1 stop bit, no flow control, and no modem control - see note (*) below), and
    3. quickly type the Escape Character (default Ctrl-K) exactly three times (e.g. press K three times while holding down the Ctrl-key).
    The management console is automatically deactivated if you don't enter any commands within one minute.

    (*) If you have set the Serial Driver to Bidir mode DTE or DCE you will have to match the baud rate and all other port settings exactly as you have configured them on the SiteManager.

    To configure the Ctrl-K value in the Escape Character field on the Serial Port page, type "^k" (don't include the quotation marks).

    Leave the Escape Character field blank to completely disable the ability to use the serial port for management.



  • Monitor Buffer Size
    Here you can specify the size of a trace buffer which records the most recent bytes sent and received on the serial port. The value specifies the number of kilo-bytes to store in the buffer; the maximum size of the monitor buffer is 8 KB. A value of 0 disables the line monitor function.

    Note: Only bytes related to an active remote client session are logged in the monitor buffer.
    Warning: If the remote client exchanges passwords or other sensitive information with the attached device, that information is also logged in the monitor buffer.



  • AT Command{Response}...
    When using the serial port as a SMS modem, the connected device may issue certain AT commands which are not supported by the SiteManager. In that case, you can specify those commands and the expected response in this field, in the format (without the AT prefix): CMD1{RSP1}CMD2{RSP2}....
    For example, if the device uses the following commands (with expected results):
    AT+ABC?
    +ABC: READY
    OK
    AT+DEF="111"
    +DEF: ONLINE
    OK
    
    In this case, you can use the following specification:

    Normally each response is followed by a CR NL sequence, and terminated by a separate OK response. If this is not wanted, you can inhibit the CRNL and/or OK by adding \N and/or \O to the response.
    You can also add a CR or NL with the \r and \n escapes. Finally, if you need a \ or } in the response, use \\ and \}.



  • : Use this button to save any changes to the above parameters.
  • : Use this button to view the current port status, and when the monitor buffer is enabled, the most recently recorded data transmitted and received on the serial port. (See picture below)

Creation date: 11/12/2019 13:17 (skr@secomea.com)      Updated: 16/01/2020 10:41 (skr@secomea.com)