Aurora HT Series User manual

HT Series Protocol Guide v1.2.4
HT Series Protocol Guide v 1.2.4

HT Series Protocol Guide v1.2.4
Revision History
Version
Number
Revision
Date
Description of Changes
1.0.0 12 - 8 - 2019 Initial Version.
1.2.0 9 - 9 - 2019 Button Modes
Audio routing Commands
Audio Volume Commands
TCP Commands
Updated Internal Commands
1.2.1 17 - 9 - 2019
Updated RPC command SetExtenderMode.
Updated TCP command set_remote_session.
Added new IR commands (!**VS_* and ?**VS_*).
Response for all serial commands has been modified to
terminate with <cr> (\r or 0x0D).
1.2.2 8-11-2019
Added RPC, Serial and Telnet Commands for all pending
commands
This document is compatible with firmware with command API
version 1.2.4
1.2.3 11-6-2021
Add HDCP capability commands.
This document is compatible with firmware with command API
version 1.2.5.
1.2.4 7-8-2022
Cleaned up RPC and TCP commands, added RPC URL
Improved wording of public commands
Fix in section 1.1

HT Series Protocol Guide v1.2.4
Contents
1 Control Commands 4
1.1 Serial commands 4
1.2 Serial Query Commands 12
1.3 RPC Commands 18
1.4 TCP Commands 31
2 Miscellaneous Error! Bookmark not defined.
2.1 Device firmware update. Error! Bookmark not defined.
2.2 File-System & FTP Server. Error! Bookmark not defined.

HT Series Protocol Guide v1.2.4
1. Control Commands
Min API command version: 1.2.5
1.1 Serial commands
The serial command can be issued by the user via the local serial port of the device. !**
is the command header used to specify the device. If !** is given as !20, then the command is
intended for the TX/HTW devices. If the header !** is given as !30, then the command is
intended for RX devices.
These commands are mainly used to control/configure the device. To query the device status/
configuration, refer Serial Query Commands.
If both TX and RX devices are connected, then the user can send serial commands from TX
to RX by providing the serial header as !30. The TX will ignore the command and send it to
the remote device. The remote RX will process the command and send the response back to
the TX. The TX will output this response to the user. Similar is the case when !20 commands
are issued to RX.
Note:
●By default, the configuration of the local serial port is Baud = 115200, Data bits = 8,
Parity = None, Stop bits = 1.
Serial
Command String Format Information
Reboot !**REBOOT
Reboots the i.mx RT processor. Response:
~**REBOOT
Bootloader
Update !**BOOTUPDATE
Enable the bootloader update. Response:
~**BOOTUPDATE
Firmware
Update. !**WSUPDATE
Enter firmware update mode. Response:
~**WSUPDATE
Set Web
Server IP
Address
!**IPxxx:xxx:xxx:xxx<cr>
xxx = 000 – 255
Example: !**IP192.168.001.150<cr>
Response: ~**IP192.168.001.150<cr>
Set Web
Server
Gateway
!**GWxxx:xxx:xxx:xxx<cr>
xxx = 000 – 255
Example: !**GW192.168.001.001<cr>
Response: ~**GW192.168.001.001<cr>

HT Series Protocol Guide v1.2.4
Set Web
Server
Subnet
Mask
!**SMxxx:xxx:xxx:xxx<cr>
xxx = 000 – 255
Example: !**SM255.255.255.000<cr>
Response: ~**SM255.255.255.000<cr>
Debug Web
Server
Processor
!**DEBUGWSx<cr>
X = 0 or 1
0 = Off
1 = On
Example: !**DEBUGWS1
Response: ~**DEBUGWS1<cr>
Debug Web
Video
Processor
!**DEBUGMPx<cr>
X = 0 or 1
0 = Off
1 = On
Example: !**DEBUGMP1
Response: ~**DEBUGMP1<cr>
Serial Port
Settings for
external
port
!**SP1,b,d,p,s<cr>
b = Baud Rate 1200, 2400, 4800, 9600, 19200,
38400, 57600, 115200
d = Data Size 7 or 8
p = Parity N, E, O (None, Even, Odd)
s = Stop Bits 1 or 2
Example: !**SP1,115200,8,N,1<cr>
Response: ~**SP1,115200,8,N,1<cr>
Front Panel
Lock !**LOCKx<cr>
X = 0 or 1
0 = Lock is disabled.
1 = Lock is enabled(Front buttons do not work).
Example: !**LOCK1<cr>
Response: ~**LOCK1<cr>
IP mode
change. !**DHCPx<cr>
X = 0,1 or 2.
0 - DHCP mode.
1 - Static IP mode.
2 - AutoIP mode.
Example: !**DHCP1<cr>
Response: ~**DHCP1<cr>
IR carrier
removal at
receiver
side.
!**IR_CARRIER_STRIPx<cr>
Removes the carrier from the IR signal from the
HDBT and outputs to external IR Transmitter.
X = 0 or 1
1 - Removes carrier.
0 - Disabled.

HT Series Protocol Guide v1.2.4
Example: !**IR_CARRIER_STRIP1<cr>
Response: ~**IR_CARRIER_STRIP1<cr>
Note: A device can have IR carrier removal
enabled either at transmitter or at the receiver
side. But not both. So, enabling at TX disables at
RX and vice versa.
IR carrier
inversal at
receiver
side.
!**IR_INVERSEx<cr>
Inverts the IR signal from the HDBT and outputs
to external IR Transmitter.
X = 0 or 1
1 - Inverts carrier.
0 - Disabled.
Example: !**IR_INVERSE1<cr>
Response: ~**IR_INVERSE1<cr>
IR carrier
removal at
transmitter
side.
!**VS_CARRIER_STRIPx<cr>
Removes the carrier in the IR signal from the IR
Remote and outputs to HDBT.
X = 0 or 1
1 - Removes carrier.
0 - Disabled.
Example: !**VS_CARRIER_STRIP1<cr>
Response: ~**VS_CARRIER_STRIP1<cr>
Note: A device can have IR carrier removal
enabled either at transmitter or at the receiver
side. But not both. So, enabling at TX disables at
RX and vice versa.
IR carrier
inversal at
transmitter
side.
!**VS_INVERSEx<cr>
Inverts the IR signal from the IR Remote and
outputs to HDBT.
X = 0 or 1
1 - Inverts carrier.
0 - Disabled.
Note: It is enabled by default.
Example: !**VS_INVERSE1<cr>
Response: ~**VS_INVERSE1<cr>
Audio
Routing !**AUD<route_from>,<route_to> These settings will be saved against the
video source that is currently in selection.

HT Series Protocol Guide v1.2.4
Route From
Linein – 1, Dante – 2, Selected HDMI – 3,
RemoteAudio - 4, ARC - 5, None - 0
Route To
Lineout - 1, Dante - 2, Stream Audio - 3, Remote
Audio- 4
Note: Audio insertion will work only in HTE TX
Example usages
Linein to Lineout
!**AUD1,1
Linein to Dante
!**AUD1,2
Linein to Stream Audio(Only in TX)
!**AUD1,3
Linein to Remote Audio
!**AUD1,4
Video
Routing
!20VID_SRCx<c
r>
X = 0 or 1 or 2
0 and 1 - HDMI.
2 - VGA (Only for HTE - wallplate).
Example: !20VID_SRC1<cr>
Response: ~20VID_SRC1<cr>
Note: Only for HTE-TX and HTW board.
Format the
File system !**FILESYS_DFLT<cr>
Defaults the file system. After defaulting, the
device will reboot with /IR and /wwwpub
directories present.
Example: !**FILESYS_DFLT<cr>
Response: ~**FILESYS_DFLT<cr>
Factory
default
HTE/HTW.
!**WPROC_DFLT<cr>
Factory defaults the HTE/HTW to default
configuration.
The default configuration is:
IP mode = Auto-IP
Static ip = 192.168.1.10
Static netmask = 255.255.255.0
Static gw = 192.168.1.1
Serial conf = 115200-8n1
Password = admin
Button Lock = Disabled

HT Series Protocol Guide v1.2.4
IR Carrier removal = Disabled
IR Carrier reversal = Disabled
Port Processing mode = Extender mode
USB mode (TX/HTW) = Host
USB mode (RX) = Device
Example: !**WPROC_DFLT<cr>
Response: ~**WPROC_DFLT<cr>
USB mode
change. !**USBx<cr>
Change USB mode.
X = 0 or 1.
0 - Host.
1 - Device.
Example: !**USB1<cr>
Response: ~**USB1<cr>
Note:
If a video stream is in progress, then it will be
stopped for a moment.
Note:
Whenever the USB mode is changed, there
will be a ‘0x00’ character in the UART.
Line in
volume !**LINEIN_VOL<0-100><cr>
~**LINEIN_VOL<0-100><cr>
Example: !**LINEIN_VOL88<cr>
Line Out
volume !**LINEOUT_VOL<0-100><cr>
~**LINEOUT_VOL<0-100><cr>
Example: !**LINEOUT_VOL88<cr>
Response: ~**LINEOUT_VOL88<cr>
Linein Mute !**LINEIN_MUTE<cr>
Mutes the Linein
Example: !**LINEIN_MUTE<cr>
Response: ~**LINEIN_MUTE<cr>
Lineout
Mute !**LINEOUT_MUTE<cr>
Mutes the Line out
Example: !**LINEOUT_MUTE<cr>
Response: ~**LINEOUT_MUTE<cr>
Button
Push !**BTN_PUSH<button_num><cr>
Simulates a button push
Example: !**BTN_PUSH1<cr>
Response: ~**BTN_PUSH1<cr>

HT Series Protocol Guide v1.2.4
Button
release !**BTN_REL<button_num><cr>
Simulates a button release
Example: !**BTN_REL1<cr>
Response: ~**BTN_REL1<cr>
Set button
led
!**BTN_LED<button_num>,<press_mo
de>,<color><cr>
Button_num: 1,2, 3
press_mode : press, release
color: r,g,b,y,c,m,w, n
corresponding to red ,green, blue, yellow,cyan,
magenta, white, none
Example/Response:
Example: !**BTN_LED1,p,r
Response: ~**BTN_LED1,p,r
Set button
mode
!**SET_BTN_MODE<button_num>,
<press_mode>,<button_mode><cr>
Button_num: 1,2, 3
press_mode : press, release
button_mode: 1,2,3 corresponding to default,
serial, tcp
Example/Response:
!**SET_BTN_MODE1,p,1
~**SET_BTN_MODE1,p,1
Clear
button
mode
!**CLR_BTN_MODE<button_num>,
<press_mode>,<button_mode><cr>
Button_num: 1,2, 3
press_mode : press, release
button_mode: 1,2,3 corresponding to default,
serial, tcp
Example/Response:
!**CLR_BTN_MODE1,p,1
~**CLR_BTN_MODE1,p,1

HT Series Protocol Guide v1.2.4
Set Button
parameters
!**BTN_PARAM<button_num>,<press_
mode>,<command_mode>,<command
_string>,<port/ip_addr>,<telnet_port><
cr>
Button num 1/2/3(wallplate)
PressMode: p(press) or (release)
Command_mode: t(tcp)/s(serial)
Command_string: string to be send on button
press(500 char max)
Port: (1/2) serial port in case of serial mode
Ip: ip address in case of tcp
Telnet port: in case of TCP mode
!20BTN_PARAM1,P,T,abc123,192.168.1.10,600
0
!20BTN_PARAM1,P,S,abc123,1
Set Serial
Port
Processing
method
!**REMOTE_SESSION<session_identi
fier>,<ip/extender_mode>,<port/var><c
r>
Session Identifier- TC, PP, PV, TS, EX, MN
TC- Telnet client
PP- Push to port
PV- push to var
TS- Telnet Server
EX- Extender
MN- Manual Method
Extender mode has 2 options : default or mirror
!**REMOTE_SESSIONPV,192.168.1.10 var1
!**REMOTE_SESSIONEX,default
Send IR !**SEND_IR<filename>,<Command
name><cr>
Filename: name of the ir file
command name: Name of the command inside
the ir file
Example/Response:
!**SEND_IRsony.wir,ON
~**SEND_IR

HT Series Protocol Guide v1.2.4
Read Serial !**SERIAL_READ<port><cr>
Reads the string stored in the internal buffer
Applicable only in Manual Method of serial port
processing
Port<1 or 2>
Example/Response:
!**SERIAL_READ<cr>
~**SERIAL_READ<port>:<string>
Clear serial
Buffer !**SERIAL_CLR_BUFFER<port><cr>
Clears the serial read buffer
Applicable only in Serial port processing manual
method.
Example/Response:
!**SERIAL_CLR_BUFFER
~**SERIAL_CLR_BUFFER1
Set HDCP
capability !**HDCP_EN<cap>
Sets the HDCP capability of the device.
Applicable only in TX.
<cap> : 0 or 1
0 – HDCP disabled
1 – HDCP enabled
Example/Response:
!**HDCP_EN1<cr>
~**HDCP_EN1<cr>
Table 1. Serial commands (Customer)

HT Series Protocol Guide v1.2.4
1.2 Serial Query Commands
These serial commands are used to query the device status/configuration. The headers used
are the same as that in Serial commands.
Serial Query
Command String Format Information
Web Server IP
Address ?**IP<cr>
X = 000 - 255
Response:
~**IPxxx:xxx:xxx:xxx<cr>
Web Server
Subnet Mask ?**SM<cr>
X = 000 - 255
Response:
~**SMxxx:xxx:xxx:xxx<cr>
Web Server
Gateway ?**GW<cr>
X = 000 - 255
Response:
~**GWxxx:xxx:xxx:xxx<cr>
Web Server
MAC Address ?**WSMAC<cr>
x = web server MAC
(xx:xx:xx:xx:xx:xx)
Response: ~**WSMAC:x<cr>
Serial Port
Settings ?**SP1<cr>
Response: ~**SP1,b,d,p,s<cr>
b = Baud Rate 1200, 2400, 4800,
9600,
19200, 38400, 57600, 115200
d = Data Size 7 or 8
p = Parity N, E, O (None, Even,
Odd)
s = Stop Bits 1 or 2
USB Mode ?**USBx<cr>
x = 0 or 1 (0 = Host TX, 1 = Device)
Response: ~**USBx<cr>
Serial Number ?**SNUM<cr>
x = serial number
Response: ~**SNUMx<cr>
Debug Web
Server
Processor
?**DEBUGWS<cr>
X = 0 or 1
0 - Off
1 - On
Response: ~**DEBUGWS<cr>
IP mode query ?**DHCP<cr>
Response: ~**DHCPx<cr>
x = 0, 1 or 2
0 - DHCP

HT Series Protocol Guide v1.2.4
1 - Static
2 – AutoIP
Front panel
lock
query
?**LOCK<cr>
Response: ~**LOCKx<cr>
X = 0 or 1
0 - Unlocked.
1 - Locked.
Application
version ?**VER1<cr>
Response: ~**VER1:a.b.c<cr>
Version is ‘a.b.c’.
Explore
version ?**VER2<cr>
Response: ~**VER2:a<cr>
Version is ‘a’.
Note: Only for HTE-RX board.
Protocol API
version ?**VER3<cr>
Response: ~**VER3:a.b.c<cr>
Version is ‘a.b.c’.
For current document, it will be
1.2.1.
VGA
processor
version
?**VER4<cr>
Response: ~**VER4:a<cr>
Version is ‘a’.
Note: Only for HTW board.
Bootloader
presence ?**BOOTAVAIL<cr>
Response: ~**BOOTAVAILx<cr>
x = 0 or 1
0 - Absent
1 – Present
IR Inverse at
receiver side ?**IR_INVERSE<cr>
Response:
~**IR_INVERSEx<cr>
x = 0 or 1
0 - Not Inverted
1 = Inverted IR
IR Carrier at
receiver side ?**IR_CARRIER_STRIP<cr>
Response:
~**IR_CARRIER_STRIPx<cr>
x = 0 or 1
0 - Carrier present
1 = Carrier absent

HT Series Protocol Guide v1.2.4
IR Inverse at
transmitter
side
?**VS_INVERSE<cr>
Response:
~**VS_INVERSEx<cr>
x = 0 or 1
0 - Not Inverted
1 = Inverted IR
IR Carrier at
transmitter
side
?**VS_CARRIER_STRIP<cr>
Response:
~**VS_CARRIER_STRIPx<cr>
x = 0 or 1
0 - Carrier present
1 = Carrier absent
Video Source
for HTE - TX /
HTW
?20VID_SRC<cr>
Response:
~20VID_SRCx<cr>
x = 0 or 1 or 2
Audio Routing ?**AUD<cr>
~**AUD-Line_Out-none,Dante-
none,Stream_Source-
video_src_audio,Remote_Audio-
line_in,Line_in_vol-
100,Line_out_vol-92,Line_in_mute-
0,Line_out_mute-0
Button Modes
?**BTN_MODES<button_num>
<press_mode><cr>
Query the button mode set for the
button
Button_num: 1,2,3
Press_mode: P, R (Press,Release)
Response
~**BTN_MODES,<modes>
modes: tcp, serial, default
Example/Response:
!**BTN_MODES1,P
~**BTN_MODES,tcp,serial<cr>

HT Series Protocol Guide v1.2.4
Button LED
Colour
?**BTN_LED<button_num><press_mode>
<cr>
Returns the button led color.
This command is applicable only for
Wallplate
Button Num: 1,2, 3
Press mode, P, R (press, release)
Colors: n (none), r (red), b(blue),
c(cyan), g(green), m(magenta),
y(yellow), w(white),
Response:
~**BTN_LED<button_num>,<button
_mode>,<colors>
Example/Response:
?20BTN_LED1,P
~BTN_LED1,P,n<cr>
IR filenames ?**IR_GROUPS<cr>
List the IR filenames stored inside
the internal filesystem
Example/Response:
?**IR_GROUPS<cr>
~**IR_GROUPS:<filenames>
Filenames will be separated by
comma
IR commands ?**IR_COMMANDS<filename><cr>
Lists the ir commands inside the IR
file specified with the command
?**IR_COMMANDSsony.wir<cr>
Response:
?20IR_COMMANDS:<commands>
commands will be separated by
commas

HT Series Protocol Guide v1.2.4
Static IP ?**STATICIP<cr>
Returns the static ip of the device
?**STATICIP<cr>
Response:
~20STATICIP<ip>,NM<netmask
>
ip: ip address
netmask : netmask
Button string
parameter
?**BTN_PARAM<button_num><press_mo
de><mode><cr>
button number: 1,2,3
press mode : p, r
P- press
R- release
mode: T,S
T- tcp
S-serial
Response:
~**BTN_PARAM1,P,T:string:<str
ing>:ip_port:<ip:port><cr>
or
~**BTN_PARAM1,P,S:string:<st
ring>:ser_port:<ser_port_num><
cr>
<string> saved string.
ser_port _num: saved serial port
number

HT Series Protocol Guide v1.2.4
Used Serial
buffer ?**SERIAL_COUNT<port_num><cr>
Returns the used length of internal
serial buffer.
Applicable only in serial port
processing manual method
Response:
~**SERIAL_COUNT<port_num><x
><cr>
port_num: portnum (1 or 2)
x- length of buffer used
Number of
Serial Ports ?**SERIAL_PORT_COUNT<cr>
Returns the total serial ports in
device
Response
~**SERIAL_PORT_COUNT2<cr>
Auto sense ?**AUTO_SENSE<cr>
Get the status of auto sense
Applicable only in TX
Example/Response:
?**AUTO_SENSE<cr>
~**AUTO_SENSE<x><cr>
x: 0 (Disable) 1(Enable)
Set HDCP
capability ?** HDCP_EN<cr>
Get the HDCP capability status
Applicable only in TX
Example/Response:
?** HDCP_EN<cr>
~**HDCP_EN<x><cr>
x: 0 (HDCP Disable) 1( HDCP
Enable)
Table 2. Serial Query Commands (Customer)

HT Series Protocol Guide v1.2.4
1.3 RPC Commands (HTTP POST)
The user can issue RPC commands (HTTP POST) to control the device.
The RPC command will be sent to the following URL:
http://<ht-series-ip-address>/rpc
The RPC command payload will have the following format:
method=<function_name>&param1=<parameter1>&param2=< parameter2>…
The method field is the RPC function name. The paramX field is the parameter field.
Parameter depends on the function used. The number of parameters will also vary.
X = 0 or 1 or 2… depending on the function.
The following are the RPC commands.
RPC Commands
Structure
Description
Reboot method=Reboot
Reboots the device.
method=Reboot
UpdateBootloader method=UpdateBootloader
Enters the tftp mode and waits
for the bootloader
method=UpdateBootloade
r
Net_SetStaticIP
method=Net_SetStaticIP&param1
=<ip>&param2=<netmask>&param
3=<gateway>
Sets the static ip of the device
method=Net_SetStaticIP
&Param1=192.168.1.10&P
aram2=255.255.255.0&Pa
ram3=192.168.1.1
Serial_SetSettings
method=Serial_SetSettings&Para
m1=<Baud_Rate>,<data_bits>,<pa
rity>,<stop_bits>
Sets the baudrate of the
device
Valid baud rates: 15200,
57600, 38400, 19200, 14400,
9600, 4800, 2400, 1200.
Valid data bits: 8, 7.
Valid parity: O, E, N. (O –
Odd, E – Even, N – None).
method=Serial_SetSetti
ngs&param1=1152008n1

HT Series Protocol Guide v1.2.4
ButtonLock method=ButtonLock&Param1=<en
able/disable>
Enables and disables the
button lock
method=ButtonLock&Para
m1=enable
Net_SetDHCP method=Net_SetDHCP
Enter the DHCP mode
method=Net_SetDHCP
Net_SetAutoIP method=Net_SetAutoIP
Enters the Auto IP mode
method=Net_SetAutoIP
IR_CarrierStrip method=IR_CarrierStrip&Param1=
<enable/disable>
Controls the IR carrier Strip
Removes the carrier from the
IR signal from the HDBT and
outputs to external IR
Transmitter.
Note: A device can have IR
carrier removal enabled either
at transmitter or at the receiver
side. But not both. So,
enabling at TX disables at RX
and vice versa
method=IR_CarrierStrip
&Param1=enable
IR_Inverse method=IR_Inverse&Param1=<en
able/disable>
Inverts the IR signal from the
HDBT and outputs to external
IR Transmitter.
method=IR_Inverse&Para
m1=enable
IR_HDBTCarrierStrip method=IR_HDBTCarrierStrip&Par
am1=<enable/disable>
Removes the carrier from the
IR signal from the HDBT and
outputs to external IR
Transmitter.
Note: A device can have IR
carrier removal enabled either
at transmitter or at the receiver
side. But not both. So,
enabling at TX disables at RX
and vice versa.

HT Series Protocol Guide v1.2.4
method=IR_HDBTCarrierS
trip&Param1=<enable/di
sable>
IR_HDBTCarrierInverse method=IR_HDBTCarrierInverse
&param1=<enable/disable>
Inverts the IR signal from the
IR Remote and outputs to
HDBT.
Note: It is enabled by
default.
method=IR_HDBTCarrierI
nverse &param1=enable
SetAudioRoute method=SetAudioRoute&Param1=
<input>&param2=<output>
<input> :linein, dante,hdmi
remote_audio, arc
<output> lineout,
dante,stream_audio,
remote_audio
Note:
stream_audio is only for TX
and arc is only for RX
method=SetAudioRoute&P
aram1=linein
&Param2=lineout
SetVideoSource method=SetVideoSource&param1
=<src>
Switches to the particular
video source. This command
is applicable only for tx.
<src>: in1, in2 & in3(for
wallplate)
command is meant only for TX
method=SetVideoSource&
Param1=in1
DefaultFileSystem method=DefaultFileSystem
Defaults the file system. After
defaulting, the device will
reboot with /IR and /wwwpub
directories present.
method=DefaultFileSyst
em
SetDefaultConfig
method=SetDefaultConfig
Factory defaults the HTE/HTW
to default configuration.