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!   ⚠️

Startup Settings (Omega, Ultra, and MaxColor Series)

Omega and Ultra Series startup settings command reference

Overview

Startup settings determine how a device behaves after it boots. These settings are stored in non-volatile memory and remain active after the device is power cycled.

This article covers Omega Series, Ultra Series, and MaxColor Series devices running the latest firmware for their series. Before using these settings, 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.

Most startup settings are configured through the Command Line Interface (CLI) using the astparam utility. Series-specific and model-specific requirements are identified in the relevant sections. Features that require USB, RS232, or other hardware apply only to models equipped with that hardware.

Applying changes: After modifying an astparam startup setting, execute astparam save and reboot the device. Rebooting temporarily interrupts device operation. When chaining commands, include sleep 1 between saving and rebooting.

For commands that change device behavior immediately, refer to CLI Commands (Omega, Ultra, and MaxColor Series).

Before You Begin

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.
  • RS232 debug port: Connect using a Just Add Power debug cable with the following settings:
    • 115200 baud
    • 8 data bits
    • No parity
    • 1 stop bit

The debug connection settings are separate from the RS232 endpoint-control settings described later in this article.

For help locating or connecting to a device, refer to:

Command notation: Setting names and values are case-sensitive. Replace variables such as $parameter and $value with appropriate values before executing a command. Completed examples contain literal values that can be changed to suit the installation.

Command Reference

Use the following commands to view, modify, save, and remove startup settings.

Action Command Description
View all settings astparam dump Display stored startup settings and their current values.
View one setting astparam g $parameter Display the current value of the specified setting.
Set a value astparam s $parameter $value Assign a value to the specified setting.
Remove a setting astparam s $parameter Remove the specified setting so its default behavior is used after saving and rebooting.
Save settings astparam save Write the current startup settings to permanent storage.
Wait one second sleep 1 Allow settings to finish saving before rebooting when chaining commands.
Reboot reboot Restart the device and apply the saved settings.

Apply and Verify Settings

Execute each command individually in the following order:

  1. View the current setting.
  2. Assign the new value.
  3. Save the settings.
  4. Reboot the device.
  5. Reconnect and verify the setting and resulting behavior.

Example: Change the IP assignment mode to static. Configure the IP address, subnet mask, and gateway before rebooting if they have not already been assigned.

astparam g ip_modeastparam s ip_mode staticastparam savereboot

After the device reboots, reconnect and execute astparam g ip_mode to verify the setting.

Examples in the settings tables assign a value only unless saving and rebooting are explicitly included. Complete the save, reboot, and verification steps after making changes.

Chain Commands

Only chain commands when using PuTTY or Windows Telnet. Never chain commands in the webUI CLI; execute each command individually. This restriction applies to all chained examples in this article.

Separate commands with a semicolon (;) to execute multiple commands on one line. When chaining commands, include sleep 1 between astparam save and reboot. This delay is not required when executing commands individually.

Example: Assign a complete static network configuration and reboot.

astparam s ip_mode static;astparam s ipaddr 10.0.0.2;astparam s netmask 255.0.0.0;astparam s gatewayip 10.0.0.1;astparam save;sleep 1;reboot

Network Settings

IP Address Settings

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

Setting Parameter Value Behavior
IP assignment mode ip_mode autoip Assign an address in the 169.254.x.x range.
static Use a consistent IP address. Also configure ipaddr, netmask, and gatewayip.
dhcp Request an IP address from a DHCP server.
IP address ipaddr $ip_address IP address used when ip_mode is set to static.
Subnet mask netmask $subnet_mask Subnet mask used when ip_mode is set to static.
Default gateway gatewayip $gateway_address Default gateway used when ip_mode is set to static.

Changing network settings may change how the device is accessed. Record the new address before applying the settings.

Command:

astparam s ip_mode static;astparam s ipaddr $ip_address;astparam s netmask $subnet_mask;astparam s gatewayip $gateway_address;astparam save;sleep 1;reboot
  • $ip_address is the static IP address assigned to the device.
  • $subnet_mask is the subnet mask for the Device Network.
  • $gateway_address is the default gateway address.

Example: Configure the device with IP address 10.0.0.2, subnet mask 255.0.0.0, and default gateway 10.0.0.1. These are example values, not a prescribed system addressing scheme.

astparam s ip_mode static;astparam s ipaddr 10.0.0.2;astparam s netmask 255.0.0.0;astparam s gatewayip 10.0.0.1;astparam save;sleep 1;reboot

Device Name

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

Assign a descriptive name to the device. Enclose names containing spaces in quotation marks.

Parameter Value Description
webname $device_name Name assigned to the device.

Command:

astparam s webname "$device_name";astparam save;sleep 1;reboot

Example: Name the device Master Bedroom.

astparam s webname "Master Bedroom";astparam save;sleep 1;reboot

Decoder DHCP Server

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

Allow a Decoder to provide IP addresses to third-party devices connected through the Decoder Switchport. The DHCP server assigns addresses from x.x.x.200 through x.x.x.249.

Important: Enable the DHCP server on only one Decoder in a system. Multiple DHCP servers may cause address conflicts or unpredictable network behavior.

Parameter Value Behavior Example
dhcp_server_enable n Default. Disable the DHCP server. astparam s dhcp_server_enable y
y Enable the DHCP server.

Audio Settings

Encoder Audio Handling

Applies to: Omega Series, Ultra Series, and MaxColor Series Encoders. AVP-specific values apply only to AVP models.

Parameter Value Behavior Example
v_rx_drv_option 0 Default for non-AVP Encoders. Preserve the source audio sampling rate. astparam s v_rx_drv_option 0
2 Default for AVP Encoders. Convert audio to 48kHz.
4 Enable audio services without a video signal on non-AVP Encoders.
6 Enable audio services without a video signal on AVP Encoders.

AVP Startup Audio

Applies to: UL-718AVP Encoders only.

Enable or mute individual audio paths when the Encoder starts.

Note: These settings use justOS API commands instead of the astparam utility.

Audio Path Command Value Behavior
HDMI input POST /settings/audio/dsp/hdmi $state on Enable HDMI input audio at startup.
mute Mute HDMI input audio at startup.
Line input POST /settings/audio/dsp/line $state on Enable line input audio at startup.
mute Mute line input audio at startup.
Microphone input POST /settings/audio/dsp/mic $state on Enable microphone input audio at startup.
mute Mute microphone input audio at startup.

Command:

POST /settings/audio/dsp/$audio_path $state
  • $audio_path is hdmi, line, or mic.
  • $state is on to enable the audio path or mute to mute it.

Example: Enable the HDMI audio path at startup.

POST /settings/audio/dsp/hdmi on

Video Settings

Encoder Bandwidth Control

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

Reduce Encoder output bandwidth by reducing the framerate or resolution. These settings affect video quality and should not replace correcting a faulty network connection.

Setting Parameter Value Behavior Example
Framerate reduction v_frame_rate $frame_rate_value Preserve the input resolution and set the output framerate to $frame_rate_value/60 of the input framerate. The maximum value is 60. astparam s v_frame_rate 1
Resolution reduction profile 200M Preserve the input framerate and reduce the resolution to fit within 200Mbps. astparam s profile 200M
150M Preserve the input framerate and reduce the resolution to fit within 150Mbps.
100M Preserve the input framerate and reduce the resolution to fit within 100Mbps.

HDR Pass-Through

Applies to: HDR-capable Ultra Series and MaxColor Series Decoders.

Parameter Value Behavior Example
v_hdmi_hdr_mode 0 Default. Enable HDR pass-through. astparam s v_hdmi_hdr_mode 1
1 Disable HDR pass-through. This may be necessary when an HLG source is connected to a non-HDR display.

Encoder HDCP Handling

Applies to: Omega Series, Ultra Series, and MaxColor Series Encoders, subject to the HDCP capabilities of the model.

Important: Only one of the following HDCP settings may be set to y at a time. A setting does not add support for an HDCP version that the hardware does not support.

Parameter Value Behavior Example
v_reject_hdcp n Default. Handle HDCP according to the device hardware. astparam s v_reject_hdcp y
y Report the Encoder as an HDCP non-compliant device.
hdcp_always_on n Default. Handle HDCP according to the device hardware. astparam s hdcp_always_on y
y Report the Encoder as HDCP 1.4 compliant regardless of source settings.
hdcp_always_on_22 n Default. Handle HDCP according to the device hardware. astparam s hdcp_always_on_22 y
y Report a supported Encoder as HDCP 2.2 compliant regardless of source settings.

Decoder HDMI Output

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

Configure HDMI output behavior when the Decoder loses video.

Setting Parameter Value Behavior Example
HDMI output when video is lost v_turn_off_screen_on_pwr_save n Default. Continue HDMI output and show the debug screen. astparam s v_turn_off_screen_on_pwr_save y
y Stop HDMI output after video is lost. The delay is determined by v_src_unavailable_timeout.
Video-loss timeout v_src_unavailable_timeout $milliseconds Set the delay before HDMI output stops. 1000 milliseconds equals one second. astparam s v_src_unavailable_timeout 5000

Command:

astparam s v_turn_off_screen_on_pwr_save $state;astparam s v_src_unavailable_timeout $milliseconds;astparam save;sleep 1;reboot
  • $state is y to stop HDMI output after video is lost or n to continue showing the debug screen.
  • $milliseconds is the time to wait after video is lost before stopping HDMI output.

Example: Stop HDMI output five seconds after video is lost.

astparam s v_turn_off_screen_on_pwr_save y;astparam s v_src_unavailable_timeout 5000;astparam save;sleep 1;reboot

Decoder Debug Screen

Applies to: Omega Series, Ultra Series, and MaxColor Series Decoders. Select a resolution supported by the Decoder and connected display. The 3840x2160@30 option does not apply to Omega Series.

Setting Parameter Value Behavior Example
Debug text ui_show_text y Default. Show diagnostic text on the debug screen. astparam s ui_show_text n
n Hide diagnostic text. This may make troubleshooting more difficult.
Debug screen resolution ui_default_res 640x480@60 Set the debug screen resolution to 480p. astparam s ui_default_res 1280x720@60
1280x720@60 Default. Set the debug screen resolution to 720p.
1920x1080@60 Set the debug screen resolution to 1080p.
3840x2160@30 Set the debug screen resolution to 2160p on supported Ultra Series and MaxColor Series Decoders.

Wallplate Encoder Settings

Applies to: Applicable Ultra Series Wallplate Encoders only. These settings do not apply to MaxColor Series.

Configure the audio input, video switching behavior, and startup source. Use only the settings corresponding to the inputs and controls available on the Wallplate model.

Audio Input

Parameter Value Behavior Example
a_io_select auto_2 Default. Use audio from the active video source. astparam s a_io_select analog
auto_1 Use line-in audio when connected. Otherwise, use HDMI audio.
auto Use line-in audio when connected. Otherwise, use audio from the active video source.
analog Use line-in audio only.
hdmi Use HDMI audio only.

Input Switching Behavior

Parameter Value Behavior Example
v_input_select auto Default. Use the dipswitch to determine the active input. astparam s v_input_select fixed
detect_sync Switch the source when an unplug event is detected.
fixed Disable dipswitch and unplug-event switching. The source can be changed only through a runtime command.

Startup Source

Parameter Value Behavior Example
v_type Not set Default. Select the dipswitch source at startup. astparam s v_type 2
0 Select the VGA input at startup.
2 Select the HDMI input at startup.

Control and Peripheral Settings

Serial/RS232

Applies to: Omega Series, Ultra Series, and MaxColor Series devices equipped with an RS232 endpoint-control port.

Configure the RS232 port to communicate with a connected endpoint device.

Baud Rate

Parameter Value Default by Series Example Baud Rates
s0_baudrate $baud_rate-8n1
  • Omega Series and Ultra Series: 9600-8n1
  • MaxColor Series: 115200-8n1
9600
38400
115200

Replace $baud_rate with the baud rate required by the connected endpoint device. The suffix -8n1 specifies 8 data bits, no parity, and 1 stop bit.

Command:

astparam s s0_baudrate $baud_rate-8n1;astparam save;sleep 1;reboot

Example: Configure the RS232 port for 38400 baud, 8 data bits, no parity, and 1 stop bit.

astparam s s0_baudrate 38400-8n1;astparam save;sleep 1;reboot

Serial Modes

Mode Usage Startup Settings
Passive Send serial data into an Encoder and output it from every Decoder watching that Encoder. astparam s soip_type2 y;astparam s soip_guest_on n;astparam save;sleep 1;reboot
Direct Provide two-way communication with feedback. Connect to TCP port 6752 at the IP address of the device that will output the serial data. astparam s soip_type2 y;astparam s soip_guest_on y;astparam save;sleep 1;reboot
API Provide one-way communication without feedback. Connect to TCP port 23 at the IP address of the device that will output the serial data. astparam s soip_type2 n;astparam s soip_guest_on y;astparam save;sleep 1;reboot

USB

Applies to: USB-equipped Omega Series, Ultra Series, and MaxColor Series devices.

Configure touchscreen support and mouse behavior.

Parameter Value Behavior Example
no_kmoip y Default. Enable touchscreen support. Mouse movement may be less smooth. astparam s no_kmoip n
n Disable touchscreen support. Mouse movement may be smoother.

Flux Capacitor IR Dongle

Applies to: Applicable Omega Series and Ultra Series devices only. The flux setting does not apply to MaxColor Series.

Select the Flux Capacitor IR Dongle version attached to the device RS232 port.

Parameter Value Behavior Example
flux v1 Configure the RS232 port for Flux Capacitor Dongle v1. astparam s flux v1
v2 Configure the RS232 port for Flux Capacitor Dongle v2.

System Settings

LED Behavior

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

The Power and Data LEDs provide diagnostic information about device status. Their behavior can be changed to accommodate installation requirements.

Parameter Value Behavior Example
leds Not set Default. Operate the LEDs according to the current device status. astparam s leds always_off
always_off Keep both LEDs off.
only_on_video Turn on both LEDs when video is present and turn them off when video is absent.

Restore default LED behavior before using the LEDs for troubleshooting. See How to Manage Power and Data LEDs for immediate commands and instructions to remove a saved LED setting.

Image Pull

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

Capture video snapshots that can be accessed over the network.

Important: Image Pull adds network traffic and processing overhead. Enable it only when snapshots are required.

Parameter Value Behavior Example
pull_on_boot n Default. Disable Image Pull. astparam s pull_on_boot 320_1_1
$size_$priority_$frequency Enable Image Pull using the specified image width, processing priority, and capture frequency.

Command:

astparam s pull_on_boot $size_$priority_$frequency;astparam save;sleep 1;reboot
  • $size is the image width: 160, 320, or 640.
  • $priority is 1 to give Image Pull a lower priority than video.
  • $frequency is 0 for 10fps or 1 for 1fps.

Example: Enable 320-pixel Image Pull at a lower priority than video and capture one image per second.

astparam s pull_on_boot 320_1_1;astparam save;sleep 1;reboot