You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
You are viewing the article in preview mode. It is not live at the moment.

⚠ JADConfig will reach End of Support on January 1, 2027. View the official notice

Home > Endpoint Control > Serial (RS232) > How to Use Serial over IP (Omega, Ultra, and MaxColor Series)
How to Use Serial over IP (Omega, Ultra, and MaxColor Series)
print icon

Overview

Serial over IP allows a control system to send RS232 commands through a Just Add Power system to control sources, displays, and other endpoint devices connected to an Encoder or Decoder.

Omega, Ultra, and MaxColor Series devices support three Serial Modes:

  • Passive: Extends a physical RS232 connection between an Encoder and the Decoders watching it.
  • Direct: Provides bidirectional access to an Encoder or Decoder serial port through TCP port 6752.
  • API (CLI Access): Sends one-way serial commands by executing a CLI command through Telnet or the HTTP API.

This article applies to Omega, Ultra, and MaxColor Series devices. For legacy hardware, see How to Use Serial over IP with 2G Series.

Choose a Serial Mode

Mode Legacy Name Use Communication
Passive Type 1
Dumb Redirection
Extend a physical RS232 connection through the active Encoder-to-Decoder connection. Bidirectional
Direct Type 2
Guest Mode
Connect a control system directly to an Encoder or Decoder serial port through TCP port 6752. Bidirectional
API (CLI Access) Type 3
CLI Access
Execute a CLI command through Telnet or the HTTP API to write directly to the serial port. One-way

Legacy terminology: Depending on the firmware version, the device webUI may identify the CLI method as API or Type 3. This method uses the device command-line interface and is not part of the Just Add Power HTTP API.

Before You Begin

Gather the following information before configuring Serial over IP:

  • The IP address of the Just Add Power Encoder or Decoder connected to the endpoint device.
  • The RS232 communication settings required by the endpoint device:
    • Baud rate
    • Data bits
    • Parity
    • Stop bits
  • The correct RS232 command and whether it must be sent as ASCII or hexadecimal data.
  • The required serial cable pinout.

If the control system and Just Add Power devices are on different networks, confirm that network routing has been configured and that the control system can reach the target device IP address.

For cabling information, see:

Set the Serial Mode

  1. Access the webUI of the Encoder or Decoder connected to the endpoint device.
  2. Select the Comms tab.
  3. Locate the Serial Settings card.
  4. Select the required mode:
    • Passive (Point-to-Point)
    • Direct (TCP:6752)
    • API for the CLI method
  5. Set the baud rate, data bits, parity, and stop bits to match the endpoint device.
  6. Apply the settings, then save and reboot the device if prompted.

9600 baud, 8 data bits, None parity, and 1 stop bit are common settings. Always use the settings specified by the endpoint device manufacturer.

Serial Mode settings in the Just Add Power webUI

Passive Mode

Passive Mode extends a physical RS232 connection through the Just Add Power system:

  • Serial data entering an Encoder is output from every Decoder currently watching that Encoder.
  • Serial data entering a Decoder is returned through the Encoder that the Decoder is currently watching.

This provides bidirectional communication and allows the Just Add Power system to function as an RS232 extension.

Requirements

  • The Encoder and Decoder must both be configured for Passive Mode.
  • The Encoder, Decoder, control system, and endpoint must use matching serial communication settings.
  • The Encoder and Decoder must be actively linked through source switching.
  • The serial cables and pinouts must match the connected equipment.

Multiple Decoders: Serial commands entering an Encoder are sent to every Decoder watching that Encoder. Use Direct Mode when an individual endpoint must be controlled independently.

Direct Mode

Direct Mode provides bidirectional access to the serial port of an Encoder or Decoder through TCP port 6752.

The control system opens a TCP socket to the IP address of the Just Add Power device:

DEVICE_IP:6752

Serial data sent through the socket is output from the RS232 port exactly as entered. Responses received from the endpoint device are returned to the control system through the same open socket.

Use Direct Mode

  1. Configure the target Encoder or Decoder for Direct Serial Mode.
  2. Confirm that its serial communication settings match the endpoint device.
  3. Open a TCP socket to the device IP address on port 6752.
  4. Send the required serial command through the open socket.
  5. Keep the socket open when feedback from the endpoint device is required.

MaxColor Series: The Encoder and Decoder must be linked before the serial port can be accessed through Direct Mode.

API Mode (CLI Access)

API Mode allows a control system to send one-way serial commands through the HTTP API or device CLI. This method sends commands to the connected endpoint but does not return serial feedback.

Serial Mode Requirement: The device Serial Mode must be set to API (CLI Access) before using any method in this section.

Serial HTTP API

Send a POST request to the endpoint that matches the serial command format:

Command Format Method Endpoint
ASCII POST /command/serial/ascii
Hexadecimal POST /command/serial/hex

Use the ASCII endpoint for text-based serial commands. Use the hexadecimal endpoint when the endpoint requires commands expressed as hexadecimal data.

CLI Command

The serial command can also be written directly to the RS232 port using the device CLI:

stty BAUDRATE -F /dev/ttyS0;printf "SERIAL_CODE_HERE" > /dev/ttyS0

Replace BAUDRATE with the baud rate required by the endpoint and replace SERIAL_CODE_HERE with the serial command.

This CLI command can be executed using either:

  • A POST request to /command/cli
  • Telnet on port 23

Hexadecimal CLI Commands

When sending hexadecimal data with the CLI command, precede each hexadecimal pair with \x.

For example:

stty 9600 -F /dev/ttyS0;printf "\x08\x22\x00\x00\x00\x02\xD4" > /dev/ttyS0

Include any carriage return, line feed, or other termination required by the endpoint device.

Troubleshooting

If the endpoint device does not respond, verify the following:

  • The control system is communicating with the correct Encoder or Decoder IP address.
  • The control system can reach the Just Add Power Device Network.
  • The correct Serial Mode is selected.
  • The baud rate, data bits, parity, and stop bits match the endpoint device.
  • The serial cable uses the correct transmit, receive, and ground pinout.
  • The null modem jumper is in the correct position, when applicable.
  • The command is intended for the exact endpoint model being controlled.
  • The command is formatted correctly as ASCII or hexadecimal data.
  • Any required carriage return or line feed is included.
  • TCP port 6752 is available when using Direct Mode.
  • Telnet port 23 is available and the Telnet server is enabled when using the CLI method.

For additional diagnostic steps, see Serial RS232 Troubleshooting.

scroll to top icon