AVARRO 0E-HDMIMX4 API Command Set HDMI Switcher User Guide
- June 11, 2024
- AVARRO
Table of Contents
AVARRO 0E-HDMIMX4 API Command Set HDMI Switcher
RS232 Default Setting
| Parameters | Value |
|---|---|
| Baud Rate | 115200 bps |
| Data bits | 8 bits |
| Parity | None |
| Stop bits | 1 bit |
| Flow control | None |
About Telnet Connection
Before the process of sending the telnet command, shall make telnet connection
to the corresponding device.
The form of telnet command is as follow:
- telnet ip (port)
- ip: The unit’s IP address.
- port: The unit’s port number, this is non-required on some Telnet control tools or platforms. If required, port number is 23 by default.
Example: If the unit’s IP address is 192.168.11.143,
The telnet command is telnet 192.168.11.143
Command
Take Command SET SW in out
- [SET SW] denotes command key words, case insensitive.
- [in out] denotes parameters, case insensitive; incorrect parameters number will not be recognized.
-
denotes a carriage return or a line feed; all commands must be ended up with a carriage return or a line feed.
| No. | Description | Command | Example |
|---|
Normal switch case
| | Command: SET SW in out
| | Return: SW in out
1
| Switch Input for Output| Parameter: in = {hdmiin1, hdmiin2…hdmiin4}; out = {hdmiout1, hdmiout2…hdmiout4};|
Description: Switch input 1 for hdmi output 2
| | Description: SW is short for Switch Switch one input source for one
output sink|
| | Command: SET SW in all
2
|
Switch indicate input for all output
| Return: SW in all
Parameter: in = { hdmiin1, hdmiin2… hdmiin4}; all = {all};
|
Return: SW hdmiin1 all
Description: Switch input1 for all output sink
| | Description: SW is short for Switch Switch one input source for all
output sink|
No.| Description| Command| Example
---|---|---|---
| | Command: GET MP out
3| Get which input mapping to the indicate Output| Return: Mp in
out
Parameter: in = {hdmiin1, hdmiin2…hdmiin4}; out = {hdmiout1, hdmiout2…hdmiout4};
|
Return: MP hdmiin2 hdmiout1
Description: Get which input mapping to output 1
| | Description: MP is short for mapping
Get which input mapping to the indicate Output
|
| | Command: GET MP all
4| Get which output mapping to all input| Return: MP in out
……
Parameter: in = {hdmiin1, hdmiin2…hdmiin4}; out = {hdmiout1, hdmiout2…hdmiout4}; all = {all};
| Return: MP hdmiin1 hdmiout1
……
Description: Get which output mapping to all input
| | Description: MP is short for mapping Get which output mapping to all input|
| No. | Description | Command | Example |
|---|
CEC Control
| | Command: SET CEC_PWR out prm
1
|
Set CEC POWER ON/OFF
| Return: CEC_PWR out prm
Parameter: prm = {on, off}
out = {hdmiout1, hdmiout2…hdmiout4, all}
|
Return: CEC_PWR hdmiout1
on
Description: Set sink hdmi output 1 power on
| | Description: Set sink power on or off|
| | Command:
SET AUTOCEC_FN out prm
| Command: SET AUTOCEC_FN hdmiout1 on
2
|
Set CEC AUTO POWER ON/OFF
| Return: AUTOCEC_FN out prm
Parameter: prm = {on, off} out = {hdmiout1, hdmiout2…hdmiout4};
|
Return: AUTOCEC_FN hdmiout1 on
Description: Set sink hdmi output 1 auto power ON
| | Description: Set sink auto power Function ON or OFF|
No.| Description| Command| Example
---|---|---|---
| | Command: GET AUTOCEC_FN out
| | Return: AUTOCEC_FN out prm
3| Get CEC AUTO POWER ON/OFF
Status
|
Parameter: prm = {on, off} out = {hdmiout1, hdmiout2…hdmiout4};
| Description: Get Sink auto power status, and the status is ON.
| | Description: Get Sink auto power Function ON or OFF Status.
Default: Off
|
| | Command: SET AUTOCEC_D out prm
4| Set CEC POWER Delay Time| Return: AUTOCEC_D out prm
Parameter: out = {hdmiout1,hdmiout2…hd miout4}; prm = {1,2,3…,}// according to the actual time counter,1 means 1 minute ,2 means 2 minutes, Default wait time is 2 minutes, Max wait time is 30 minutes.
| Return: AUTOCEC_D hdmiout1 2
Description: when no active signal to hdmi1, 2 minutes later, the unit will auto power off.
| | Description: AUTOCEC_D is short for CEC auto Power Delay Timing|
No.| Description| Command| Example
---|---|---|---
| | Command: GET AUTOCEC_D out
| Command: GET AUTOCEC_D hdmiout1
| | Return: AUTOCEC_D out prm
{hdmiout1,hdmiout2…hd miout4};
prm = {1,2,3…,}// according to the actual time counter,1 means 1 minute, 2
means 2 minutes, Default wait time is 2 minutes, Max wait time is 30 minutes.
|
Description:
Get hdmi1 auto power delay time, the result is 2 minutes
| | Description: AUTOCEC_D is short for CEC auto Power Delay Timing|
| | Default: 2|
| No. | Description | Command | Example |
|---|
HDCP
| | Command: SET HDCP_S in prm
SET HDCP_S hdmiin1 on
1| Set Input HDCP support ON/OFF| Return: HDCP_S in prm
Parameter: prm = {on, off} in = {hdmiin1, hdmiin2…hdmiin4}
|
Return: HDCP_S hdmiin1 on
Description: Set hdmi input 1 hdcp support on
| | Description: HDCP_S will control source hdcp support on or off|
| | Command: GET HDCP_S in
| | Return: HDCP_S in prm
2
| Get Input HDCP support ON/OFF Status| Parameter: prm = {on, off} in =
{hdmiin1, hdmiin2…hdmiin4}| Description: Get hdmi1 hdcp support on or off
status, and the result is on
| | Description: HDCP_S is short for HDCP support|
| | Default: on|
| No. | Description | Command | Example |
|---|
EDID
1| Set Input EDID| Command:
SET EDID in prm
Return:
EDID in prm
Parameter:
in = {hdmiin1, hdmiin2…hdmiin4}; prm = {1 ~12}
01: Copy form output 1
02: Copy form output 2
03: Copy form output 3
04: Copy form output 4 05 : 4K@60Hz 5.1ch
audio With HDR
06: 4K@60Hz 2.0ch
audio With HDR
07: 4K@30Hz 7.1ch
audio With HDR
08: 4K@30Hz 5.1ch
audio With HDR
09: 4K@30Hz 2.0ch
audio With HDR
10: 4K@30Hz/8bit only 2.0ch audio Without HDR
11: 1080P@60Hz
2.0ch
audio …
12: Smart EDID
| Command: SET EDID hdmiin1 10
Return: EDID hdmiin1 10
Description: Set in1 EDID Fix 4K@30Hz/8bit only 2.0ch audio Without HDR
| |
Description: Set Input EDID
|
No.| Description| Command| Example
---|---|---|---
2| Get All Input EDID status| Command: GET EDID all
Return: EDID in prm
……
Parameter: in = {hdmiin1, hdmiin2…hdmiin4}; prm = {1 ~13}
01: Copy form output 1
02: Copy form output 2
03: Copy form output 3
04: Copy form output 4 05 : 4K@60Hz 5.1ch
audio With HDR
06: 4K@60Hz 2.0ch
audio With HDR
07: 4K@30Hz 7.1ch
audio With HDR
08: 4K@30Hz 5.1ch
audio With HDR
09: 4K@30Hz 2.0ch
audio With HDR
10: 4K@30Hz/8bit only 2.0ch audio Without HDR
11: 1080P@60Hz 2.0ch
audio …
12: Smart EDID
13: EDID Write
| Command: GET EDID all
Return: EDID hdmiin1 01
EDID hdmiin2
02
EDID hdmiin3
03
……
Description: Get all input EDID Status
| | Description: Get all input EDID Status|
| | Default: 5|
| No. | Description | Command | Example |
|---|---|---|---|
| 3 | Get one input EDID Status | Command: GET EDID in |
Return: EDID in prm
Parameter: in = {hdmiin1, hdmiin2… hdmiin4}; prm = {1 ~13}
01: Copy form output 1
02: Copy form output 2
03: Copy form output 3
04: Copy form output 4 05 : 4K@60Hz 5.1ch
audio With HDR
06: 4K@60Hz 2.0ch
audio With HDR
07: 4K@30Hz 7.1ch
audio With HDR
08: 4K@30Hz 5.1ch
audio With HDR
09: 4K@30Hz 2.0ch
audio With HDR
10: 4K@30Hz/8bit only 2.0ch audio Without HDR
11: 1080P@60Hz
2.0ch
audio …
12: Smart EDID
13: EDID Write
| Command: GET EDID hdmiin1
Return: EDID hdmiin1
10
Description: Get in1 edid status, and the status is Fix 4K@30Hz/8bit only 2.0ch audio Without HDR
| | Description: Get one input EDID Status|
| | Default: 5|
| No. | Description | Command | Example |
|---|
System Info
| | Command: RESET
1
|
Factory reset
| Return: RESET
ESET
| | Description:
Factory reset
| Description:
Factory reset all board
| | Command: REBOOT
2
|
System reboot
| Return: REBOOT
| | Description: System reboot| Description: System reboot
| | Command: help
3| Get the API list| |
| | Description: Get the API list| Description: Get the API list
| | Command: SET IP MODE pcm
SET IP MODE
dhcp
| | Return: IMODE pcm
4| Set IP Mode| Parameter: pcm= {static, dhcp}| Description: Set IP
mode is dhcp
| | Description: Set IP mode|
| | Default: DHCP|
| No. | Description | Command | Example |
|---|---|---|---|
| Command: GET IP MODE |
Command: GET IP MODE |
||
| Return: IP MODE pcm |
Return: IP MODE dhcp |
||
| 5 | Get IP Mode | Parameter: pcm= {static, dhcp} | Description: IP mode |
is dhcp
| | Description: Get IP mode|
| | Default: DHCP|
| | Command:| Command:
| | SET IPADDR| SET IPADDR
| | xx.xx.xx.xx| 192.168.1.4
| | xx.xx.xx.xx| 255.255.255.0
| | xx.xx.xx.xx
| | | >
| | Return:|
| | IPADDR IP:xx.xx.xx.xx| Return:
6
| SET IP
address
| MASK: xx.xx.xx.xx GATE:
xx.xx.xx.xx
| IPADDR IP:192.168.1.4
MASK:255.255.255.0
| | | GATE:192.168.1.1[<
| | Description:| CR>
| | SET IP address|
| | | Description:
| | | Set IP address is
| | | 192.168.1.4, MASK is
| | | 255.255.255.0,
| | | GATE is 192.168.1.1
| No. | Description | Command | Example |
|---|---|---|---|
| **Command: | |||
| ** GET IPADDR |
**Command: |
GET IPADDR
7| GET IP address|
IPADDR IP:xx.xx.xx.xx MASK: xx.xx.xx.xx GATE: xx.xx.xx.xx
Description:
GET IP address
| Return: IPADDR IP:192.168.1.4
MASK:255.255.255.0 GATE:192.168.1.1
| | | Description:
Get IP address is 192.168.1.4, MASK is 255.255.255.0, GATE is 192.168.1.1
Update info
| | Command:
GET VER
GET VER
1| Get selected target firmware version| Return:
VER prm
Parameter:
prm = {…}// according to actual firmware version
Description:
Get selected target firmware version
| Return: MX0404_N201_000 VER 1.0, ARM VER 1.0
Description: Get all module firmware version
| | Command:
UPG [prm]
UPG MASTER
2| Upgrade module| Return:
UPG [prm]
Parameter:
prm= {MASTER, ARM}
| Return:
UPG MASTER
| | Description:
Upgrade module| Description:
upgrade module
| No. | Description | Command | Example |
|---|
Preset scene
| | Command: SAVE PRESET prm
1
|
Save Preset Scene
| Return:
PRESET prm
PRESET 1
2
|
Restore Preset Scene
| Parameter:
prm = {1,2,3}//
Description:
Restore Preset Scene
| Description:
Restore preset scene
| | Default:
mp hdmiin1 hdmiout1 mp hdmiin2 hdmiout2 mp hdmiin3 hdmiout3 mp hdmiin4
hdmiout4|
| No. | Description | Command | Example |
|---|
Audio
| | Command: SET MUTE out pcm
| | Return: MUTE out pcm
1
|
Set Audio Output mute
| Parameter:
pcm = {on, off};//on means mute; off means unmute
out = {audioout1, audioout2,…audioout4, all};| Description: Set audioout1
mute on
| | Description: Set Audio mute or not mute|
| | Command: GET MUTE out
audioout1
| | Return: MUTE out pcm
2| Get Audio Output mute status| Parameter: pcm = {on, off};;//on means
mute; off means unmute out = {audioout1, audioout2,…audioout4, all};|
Description: Get Audio Output mute status.
| | Description: Get Audio Output mute status|
| | Default: off|
| No. | Description | Command | Example |
|---|
Scaler
| | Command: SET SCALER out pcm
| Set video Output scaler| Return: SCALER out pcm
Parameter: pcm = {on, off};//on means scaler; off means not scaler
out = {hdmiout1, hdmiout2,…hdmiout4, all };
Description:
Set Video scaler or not scaler
|
Return: SCALER hdmiout1 on
Description: Set hdmiout1 scaler on
| | Command: GET SCALER out
| | Return: SCALER out pcm
2
|
Get video Output scaler status
| Parameter:
pcm = {on, off};;//on means mute; off means unmute out = {hdmiout1,hdmiout2,… hdmiout4, all};
| Description: Get video Output scaler status.
| | Description: Get video Output scaler status|
| | Default: on|