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.
Support will be closed on Friday July 3rd in observance of Independence Day.
Home > Device Configuration > Omega & Ultra Series > CLI Settings for Omega & Ultra Series Devices
CLI Settings for Omega & Ultra Series Devices
print icon

Overview

This article applies to Omega Series and Ultra Series devices running justOS firmware version B1.0.0 or later.

Startup settings modify how a device behaves after it boots. Unlike runtime commands, startup settings are stored in non-volatile memory and remain active after power cycles.

Most startup settings are configured through the Command Line Interface (CLI) using the astparam utility.

Important: Changes made using astparam do not take effect immediately. After modifying a startup setting, save the configuration and reboot the device.

Omega and Ultra Series devices use the same firmware platform and support the same startup setting structure.

For commands that change device behavior immediately without requiring a reboot, refer to CLI Commands for Omega & Ultra Series Devices.

Before You Begin

Startup settings are configured through the Command Line Interface (CLI) using either Telnet or the RS232 debug port.

  • Telnet to the device IP address on TCP port 23.

  • Connect to the RS232 debug port using a Just Add Power debug cable.

RS232 debug connection settings:

  • 115200 baud

  • 8 data bits

  • No parity

  • 1 stop bit

If the device IP address is unknown, refer to:

Note: All startup setting names and values are case-sensitive.

Placeholder Key: Values shown in red brackets, such as [parameter] or [value], must be replaced with the appropriate setting name or value. Values shown as $A, $B, $C, or $x also represent user-supplied values.

Command Reference

The following commands are used to view, modify, save, and remove startup settings.

View All Settings

astparam dump

View Individual Setting

astparam g [parameter]

Set Individual Setting

astparam s [parameter] [value]

Remove a Setting

astparam s [parameter]

Save Settings

astparam save

Delay One Second

sleep 1

Reboot Device

reboot

Chaining Commands

Multiple startup settings can be applied in a single command by separating each command with a semicolon (;).

After saving settings, include a one-second delay before rebooting to allow sufficient time for the configuration to be written to permanent storage.

Example:

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

Typical Workflow

  1. View the current setting value.

  2. Modify the setting.

  3. Save the configuration.

  4. Wait one second.

  5. Reboot the device.

  6. Verify the setting after reboot.

Example:


astparam g ip_mode
astparam s ip_mode static
astparam save
sleep 1
reboot

Network Settings

IP

Name Parameter Value(s) Description Applicable Units Example
Mode ip_mode autoip Device defaults to 169.254.x.x. All Omega & Ultra Series devices astparam s ip_mode static
static Assign a consistent IP address. Must also assign ipaddr, netmask, and gatewayip.
dhcp Get an IP address from a DHCP server. If no DHCP server is available, the device will continue looking for one after reboot.
IP Address ipaddr $A.$B.$C.$D IP address used when ip_mode is set to static. All Omega & Ultra Series devices astparam s ipaddr 10.0.0.2
Subnet Mask netmask $A.$B.$C.$D Subnet mask used when ip_mode is set to static. All Omega & Ultra Series devices astparam s netmask 255.0.0.0
Default Gateway gatewayip $A.$B.$C.$D Default gateway used when ip_mode is set to static. All Omega & Ultra Series devices astparam s gatewayip 10.0.0.1

DHCP Server

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.

Name Parameter Value(s) Description Applicable Units Example
DHCP Server dhcp_server_enable n Default. Disable DHCP server. All Omega & Ultra Series Decoders astparam s dhcp_server_enable y
y Enable DHCP server.

Webname

Assign a name to the device.

Name Parameter Value(s) Description Applicable Units Example
Webname webname $A $A = Name for the device. Use quotes if the name contains more than one word. All Omega & Ultra Series devices astparam s webname "Master Bedroom"

Audio Settings

Encoder Audio

Modify how Encoder audio services are processed.

Name Parameter Value(s) Description Applicable Units Example
Encoder Audio Handling v_rx_drv_option 0 Default on non-AVP Encoders. Preserve audio sampling. All Omega & Ultra Series Encoders astparam s v_rx_drv_option 0
2 Default on AVP Encoders. Convert audio to 48kHz.
4 Enable audio services without video present. Applicable to non-AVP Encoders.
6 Enable audio services without video present. Applicable to AVP Encoders.

AVP Audio

Note: AVP audio settings are configured using justOS API commands rather than the astparam utility used by most startup settings.

Enable or mute startup audio paths on supported AVP Encoders.

Name Parameter Value(s) Description Applicable Units Example
HDMI Audio POST /settings/audio/dsp/hdmi $x on Enable HDMI audio on startup. UL-718AVP Encoder
justOS firmware Bx.x.x
POST /settings/audio/dsp/hdmi on
mute Disable HDMI audio on startup.
Line Audio POST /settings/audio/dsp/line $x on Enable line input audio on startup. UL-718AVP Encoder
justOS firmware Bx.x.x
POST /settings/audio/dsp/line on
mute Disable line input audio on startup.
Mic Audio POST /settings/audio/dsp/mic $x on Enable mic input audio on startup. UL-718AVP Encoder
justOS firmware Bx.x.x
POST /settings/audio/dsp/mic on
mute Disable mic input audio on startup.

Video Settings

Bandwidth Control

Adjust the bandwidth output of an Encoder for situations where the network cannot support Encoders at full capacity.

Name Parameter Value(s) Description Applicable Units Example
Adjust Framerate v_frame_rate $A Keep the resolution the same. Set framerate to $A/60 of the input framerate. Maximum value is 60. All Omega & Ultra Series Encoders astparam s v_frame_rate 1
Adjust Resolution profile 200M Keep framerate the same. Lower resolution to fit 200Mbps bandwidth. All Omega & Ultra Series Encoders astparam s profile 200M
150M Keep framerate the same. Lower resolution to fit 150Mbps bandwidth.
100M Keep framerate the same. Lower resolution to fit 100Mbps bandwidth.

HDR

Name Parameter Value(s) Description Applicable Units Example
HDR Pass-Through v_hdmi_hdr_mode 0 Default. Enable HDR pass-through. All Omega & Ultra Series Decoders astparam s v_hdmi_hdr_mode 1
1 Disable HDR pass-through. This may be necessary for HLG sources going to non-HDR displays.

HDCP and Debug Output

Name Parameter Value(s) Description Applicable Units Example
HDCP Handling
Only one of these settings can be set to y.
v_reject_hdcp n Default. Handle HDCP according to device hardware. All Omega & Ultra Series Encoders astparam s v_reject_hdcp y
y Report as an HDCP non-compliant device.
hdcp_always_on n Default. Handle HDCP according to device hardware. astparam s hdcp_always_on y
y Report as HDCP 1.4 compliant regardless of source settings.
hdcp_always_on_22 n Default. Handle HDCP according to device hardware. astparam s hdcp_always_on_22 y
y Report as HDCP 2.2 compliant regardless of source settings.
Disable Decoder HDMI when video is lost v_turn_off_screen_on_pwr_save n Default. Show debug screen when video is lost. All Omega & Ultra Series Decoders astparam s v_turn_off_screen_on_pwr_save y
y Stop HDMI output when video is lost. Timing is based on the v_src_unavailable_timeout value.
v_src_unavailable_timeout $A $A = Time in milliseconds before HDMI output stops. 1000ms = 1 second. All Omega & Ultra Series Decoders astparam s v_src_unavailable_timeout 5000
Debug Text ui_show_text y Default. Show text on debug screen. All Omega & Ultra Series Decoders astparam s ui_show_text n
n Hide text on debug screen. This may make troubleshooting more difficult.
Debug Screen Resolution ui_default_res 640x480@60 Set debug screen resolution to 480p. All Omega & Ultra Series Decoders astparam s ui_default_res 1280x720@60
1280x720@60 Default. Set debug screen resolution to 720p.
1920x1080@60 Set debug screen resolution to 1080p.
3840x2160@30 Set debug screen resolution to 2160p.

Wallplate Encoder Settings

This section contains startup settings for Wallplate Encoders, including HDMI input, VGA input, and line-in audio behavior.

Name Parameter Value(s) Description Applicable Units Example
Audio Input Selection a_io_select auto_2 Default. Use audio from the active source. All Ultra Series Wallplate Encoders astparam s a_io_select analog
auto_1 Use line-in audio if attached. Otherwise, use HDMI audio.
auto Use line-in audio if attached. Otherwise, use audio from the active video source.
analog Use line-in audio only.
hdmi Use HDMI audio only.
Input Switching Behavior v_input_select auto Default. Dipswitch determines input. All Ultra Series Wallplate Encoders astparam s v_input_select fixed
detect_sync Source switches when an unplug event is detected.
fixed Dipswitch and unplug detection are disabled. Source switching is only possible through a Telnet command.
Select Startup Source v_type   Default. Select dipswitch source on startup. All Ultra Series Wallplate Encoders astparam s v_type hdmi
0 Select VGA source on startup.
2 Select HDMI source on startup.

Control and Peripheral Settings

Serial/RS232

Send RS232 commands to endpoint devices using the RS232 port on any Just Add Power device.

Name Parameter Value(s) Description Applicable Units Examples
Set Baudrate s0_baudrate $A-8n1 $A = baudrate. Default is 9600. All Omega & Ultra Series devices astparam s s0_baudrate 9600-8n1
astparam s s0_baudrate 38400-8n1
astparam s s0_baudrate 115200-8n1

Serial Modes

Mode Usage Setting
Passive Input: serial to Encoder
Output: serial from every Decoder watching that Encoder.
astparam s soip_type2 y;astparam s soip_guest_on n;astparam save;sleep 1;reboot
Direct Two-direction with feedback
Input: network connection to IP port 6752
Output: serial from the device with that IP address.
astparam s soip_type2 y;astparam s soip_guest_on y;astparam save;sleep 1;reboot
API One-direction, no feedback
Input: network connection to IP port 23
Output: serial from the device with that IP address.
astparam s soip_type2 n;astparam s soip_guest_on y;astparam save;sleep 1;reboot

USB

Name Parameter Value(s) Description Applicable Units Example
Touchscreen Enable no_kmoip y Default. Touchscreen support is enabled. Mouse movement may be less smooth. All Omega & Ultra Series devices astparam s no_kmoip n
n Touchscreen support is disabled. Mouse movement may be smoother.

IR

Name Parameter Value(s) Description Applicable Units Example
Flux Capacitor
IR Dongle Version
flux v1 Set RS232 to communicate with Dongle v1 attached to the device. All Omega & Ultra Series devices astparam s flux v1
v2 Set RS232 to communicate with Dongle v2 attached to the device.

System Settings

LED Behavior

All devices have a Power LED and a Data LED that are diagnostically relevant when determining the current device status.

The LEDs can be disabled or their behavior can be altered to fit different installation requirements.

Name Parameter Value(s) Description Applicable Units Example
LED Behavior leds   Default. LEDs behave according to device status. All Omega & Ultra Series devices astparam s leds always_off
always_off LEDs are always off.
only_on_video Both LEDs are on when video is present. Both LEDs are off when video is absent.

Image Pull

Note: Image Pull generates additional network and processing overhead. Enable only when image snapshots are required.

Capture a snapshot of the video on an Encoder or Decoder. The snapshot can be accessed by devices on the network.

Name Parameter Value(s) Description Applicable Units Example
Image Pull pull_on_boot n Default. Disable Image Pull. All Omega & Ultra Series devices astparam s pull_on_boot 320_1_1
$A_$B_$C $A = Image size. Supported values are 160, 320, and 640.
$B = Priority. 1 sets Image Pull to a lower priority than video.
$C = Image Pull frequency. 0 means 10fps. 1 means 1fps.
scroll to top icon