You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
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!   ⚠️

CLI Commands (Omega, Ultra, and MaxColor Series)

Device command-line interface example

Overview

CLI commands change the live behavior of a Just Add Power device. Commands execute immediately without saving or rebooting, but the resulting changes may not persist through a reboot.

This article covers Omega Series, Ultra Series, and MaxColor Series devices running the latest firmware for their series. Before using these commands, confirm that the system is running the current release:

If an update is needed, follow How to Update Firmware on a Device to maintain firmware compatibility across the system.

For settings that determine device behavior after a reboot, see Startup Settings (Omega, Ultra, and MaxColor Series).

Access the CLI

Access the device CLI using one of the following methods:

  • webUI CLI: Open the device webUI and select the CLI. Execute each command individually.
  • Telnet: Connect to the device IP address on TCP port 23. See How to Telnet to a Device for instructions.
  • RS232 debug port: Connect a Just Add Power debug cable to the white, 3-pin Molex debug connector on the device. Use 115200-8n1: 115200 baud, 8 data bits, no parity, and 1 stop bit. Contact Just Add Power Technical Support if you need a debug cable.

Command notation: Commands and values are case-sensitive. Replace $STATE with a value listed in the corresponding table. Completed examples show the selected value in place of the variable.

Service interruption: Commands that disable an input, output, or network stream interrupt the associated video or services. Confirm that you are connected to the intended Encoder or Decoder before executing a command.

Commands

USB

Applies to: USB-equipped Omega Series, Ultra Series, and MaxColor Series Decoders connected to compatible USB-equipped Encoders.

Execute these commands on the Decoder to establish or disconnect a KVM Pass-through connection.

Command Behavior
usb connect Establish the USB connection between the Decoder and Encoder.
usb stop Disconnect the active USB connection.

Example: Establish the USB connection.

usb connect

To disconnect the USB connection, execute:

usb stop

On MaxColor Series, usb connect connects USB control to the Encoder the Decoder is currently viewing. To control a different Encoder, first switch the Decoder to view that Encoder, then execute usb connect again.

Verify the connection by testing the attached USB peripheral with the source computer.

For series-specific connection behavior, supported peripherals, USB limits, and firmware differences, see:

Decoder Video Control

Applies to: Omega Series, Ultra Series, and MaxColor Series Decoders.

Command:

video $STATE
Value Behavior Example
mute Output black video and mute HDMI audio. Execute video play to restore video and audio. video mute
off Disable HDMI output. The display detects no HDMI signal from the Decoder. video off
on Enable HDMI output after video off. video on
pause Freeze the last video frame on the display. video pause
play Resume video after video pause or video mute. video play
stop Stop network services and show the debug screen. video stop
start Enable network services after video stop. video start

Example: Output black video and mute HDMI audio.

video mute

To restore video and audio, execute:

video play

Example: Freeze the last video frame on the display.

video pause

To resume video, execute:

video play

Verify the result on the connected display. Use the restore command corresponding to the action performed: video play, video on, and video start perform different functions.

On Omega Series and Ultra Series Decoders, rebooting or power-cycling also restores normal video after video mute or video pause.

To configure automatic HDMI output behavior when video is lost, see Decoder HDMI Output in Startup Settings.

Encoder HDMI Input Control

Applies to: Omega Series, Ultra Series, and MaxColor Series Encoders with an HDMI input.

Command:

video $STATE
Value Behavior Example
off Disable the HDMI input. The Encoder behaves as if no source is connected. video off
on Enable the HDMI input after video off. video on

Example: Disable the Encoder HDMI input.

video off

To enable the HDMI input again, execute:

video on

Verify that source video returns on a Decoder watching the Encoder.

Encoder Network Services

Applies to: Omega Series, Ultra Series, and MaxColor Series Encoders.

Execute stop or start without the video prefix to control the Encoder multicast network stream.

Command Behavior
stop Disable the Encoder multicast network stream.
start Enable the Encoder multicast network stream after stop.

Example: Stop the Encoder multicast network stream.

stop

To restart the stream, execute:

start

Verify that video returns on Decoders watching the Encoder.