Aurora HT Series User manual

HT Series Protocol Guide v1.0.0
HT Series
Protocol Guide
v 1.0.0

HT Series Protocol Guide v1.0.0
Revision History
Version
Number
Revision
Date
Description of Changes
1.0.0
12 - 8 - 2019
Initial Version.

HT Series Protocol Guide v1.0.0
Contents
1. Customer Commands......................................................................................................5
1.1 Serial commands.......................................................................................................5
1.2 Serial Query Commands ..........................................................................................8
1.3 RPC Commands......................................................................................................10
1.3.1 GetApiVersion......................................................................................................... 10
1.3.2 GetFirmwareVersion.............................................................................................. 11
1.3.3 GetSerialNumber.................................................................................................... 11
1.3.4 Reboot....................................................................................................................... 11
1.3.5 EnterUpdateMode................................................................................................... 12
1.3.6 SetDefaultConfig .................................................................................................... 12
1.3.7 Net_GetIPAddress.................................................................................................. 13
1.3.8 Net_GetSubnetMask.............................................................................................. 13
1.3.9 Net_GetMac.............................................................................................................. 13
1.3.10 Serial_Send.............................................................................................................. 14
1.3.11 Serial_Read.............................................................................................................. 14
1.3.12 Serial_ClearReadBuffer ........................................................................................ 15
1.3.13 Serial_ReadBufferCount....................................................................................... 15
1.3.14 Serial_GetSettings ................................................................................................. 15
1.3.15 Serial_SetSettings.................................................................................................. 16
1.3.16 Serial_SetPortCount.............................................................................................. 17
1.3.17 Serial_SetManualMode ......................................................................................... 17
1.3.18 Serial_SetExtenderMode...................................................................................... 18
1.3.19 Serial_SetPushPortMode...................................................................................... 18
1.3.20 Serial_SetPushVarMode....................................................................................... 19
1.3.21 Serial_SetTelnetClientMode................................................................................. 20
1.3.22 Serial_SetTelnetServerMode............................................................................... 21
2. Non - Customer Commands..........................................................................................23
2.1 Serial commands.....................................................................................................23
2.2 RPC commands.......................................................................................................24
2.2.1 HTW_UpdateEdid ................................................................................................... 24
3. Miscellaneous.................................................................................................................25
3.1 Device firmware update..........................................................................................25

HT Series Protocol Guide v1.0.0

HT Series Protocol Guide v1.0.0
1. Customer Commands
These commands can be released to the customer.
API command version: 1.0.0
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 !30.
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>
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>

HT Series Protocol Guide v1.0.0
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.
!**IR_CARRIER_STRIPx<cr>
X = 0 or 1
1 - Removes carrier.
0 - Disabled.
Example: !**IR_CARRIER_STRIP1<cr>
Response:
~**IR_CARRIER_STRIP1<cr>
IR carrier inversal.
!**IR_INVERSEx<cr>
X = 0 or 1
1 - Inverts carrier.
0 - Disabled.

HT Series Protocol Guide v1.0.0
Example: !**IR_INVERSE1<cr>
Response: ~**IR_INVERSE1<cr>
Audio Routing
!**AUD<input_from>,<output_to>
Input From
Linein - 1, Dante - 2, HDMI - 3,
RemoteAudio - 4, ARC - 5, None - 0
Output To
Lineout - 1, Dante - 2, HDMI - 3, Remote
Audio- 4
Audio insertion will work only in HTE TX
Example usages
Linein to Lineout
!**AUD1,1
Linein to Dante
!**AUD1,2
Linein to HDMI(Only in TX)
!**AUD1,3
Linein to Remote Audio
!**AUD1,4
Video Routing
!20VID_SRCx<cr>
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

HT Series Protocol Guide v1.0.0
Password = admin
Button Lock = Disabled
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.
Table 1. Serial commands (Customer)
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<lf>
Web Server Subnet
Mask
?**SM<cr>
X = 000 - 255
Response: ~**SMxxx:xxx:xxx:xxx<lf>
Web Server
Gateway
?**GW<cr>
X = 000 - 255
Response: ~**GWxxx:xxx:xxx:xxx<lf>
Web Server MAC
Address
?**WSMAC<cr>
x = web server MAC (xx:xx:xx:xx:xx:xx)
Response: ~**WSMAC:x<lf>

HT Series Protocol Guide v1.0.0
Serial Port Settings
?**SP1<cr>
Response: ~**SP1,b,d,p,s<lf>
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<lf>
Serial Number
?**SNUM<cr>
x = serial number
Response: ~**SNUMx<lf>
Debug Web Server
Processor
?**DEBUGWS<cr>
X = 0 or 1
0 - Off
1 - On
Response: ~**DEBUGWS<lf>
IP mode query
?**DHCP<cr>
Response: ~**DHCPx<lf>
x = 0, 1 or 2
0 - DHCP
1 - Static
2 - AutoIP
Front panel lock
query
?**LOCK<cr>
Response: ~**LOCKx<lf>
X = 0 or 1
0 - Unlocked.
1 - Locked.
Application version
?**VER1<cr>
Response: ~**VER1:a.b.c<lf>
Version is ‘a.b.c’.
Explore version
?**VER2<cr>
Response: ~**VER2:a<lf>
Version is ‘a’.
Note: Only for HTE-RX board.
Protocol API version
?**VER3<cr>
Response: ~**VER3:a.b.c<lf>
Version is ‘a.b.c’.
For current document, it will be 1.0.0.
Bootloader presence
?**BOOTAVAIL<cr>
Response: ~**BOOTAVAILx<cr>
x = 0 or 1
0 - Absent
1 - Present
IR Inverse
?**IR_INVERSE<cr>
Response:
~**IR_INVERSEx<lf>

HT Series Protocol Guide v1.0.0
x = 0 or 1
0 - Not Inverted
1 = Inverted IR
IR Carrier
?**IR_CARRIER_STRIP<cr>
Response:
~**IR_CARRIER_STRIPx<lf>
x = 0 or 1
0 - Carrier present
1 = Carrier absent
Video Source for
HTE - TX / HTW
?20VID_SRC<cr>
Response:
~20VID_SRCx<lf>
x = 0 or 1 or 2
Table 2. Serial Query Commands (Customer)
1.3 RPC Commands
The user can issue RPC commands to control the device. The RPC command will
have the following format:
method=<function_name>&param1=<parameter1>&param2=< parameter1>…
•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.
1.3.1 GetApiVersion
Command:
GetApiVersion
Parameters:
Nil
Response:
Success:
status=1&response1=a.b.c
a.b.c is the api version.
It will be 1.0.0 for the devices following this document.

HT Series Protocol Guide v1.0.0
1.3.2 GetFirmwareVersion
Command:
GetFirmwareVersion
Parameters:
Nil
Response:
Success:
status=1&response1=a.b.c
a.b.c is the version.
a - Major.
b - Minor.
c –SubMinor.
1.3.3 GetSerialNumber
Command:
GetSerialNumber
Parameters:
Nil
Response:
Success:
status=1&response1=X
X is an 8-digit number.
1.3.4 Reboot
Command:
Reboot
Parameters:
Nil
Response:
Success:
status=1
If success, then device will perform soft reboot.
Failure: System busy.
status=0&faultCode=1&Invalid_state system busy
If factory default is in progress, then device won't reboot.
Failure: Event queue full/failed to create event.
status=0&faultCode=2&Invalid_*
FaultCode 2 implies that internal event queue is full. If internal
event queue is full, then device won't accept any event. Please
try again after some time.

HT Series Protocol Guide v1.0.0
1.3.5 EnterUpdateMode
Command:
EnterUpdateMode
Parameters:
Nil
Response:
Success:
status=1
If success, then device will enter to update mode. RPC
commands can't be used now.
Failure: System busy.
status=0&faultCode=1&Invalid_state system busy
If factory default is in progress, then device won't enter update
mode.
Failure: Event queue full/failed to create event.
status=0&faultCode=2&Invalid_*
FaultCode 2 implies that internal event queue is full. If internal
event queue is full, then device won't accept any event. Please
try again after some time.
1.3.6 SetDefaultConfig
Command:
SetDefaultConfig
Parameters:
Nil
Response:
Success:
status=1
On success, device will perform factory default. All the device
configuration will be set to default. After factory default, device
will reboot.
Failure: Event queue full/failed to create event.
status=0&faultCode=2&Invalid_*
FaultCode 2 implies that internal event queue is full. If internal
event queue is full, then device won't accept any event. Please
try again after some time.

HT Series Protocol Guide v1.0.0
1.3.7 Net_GetIPAddress
Command:
Net_GetIPAddress
Parameters:
Nil
Response:
Success:
status=1&response1=a.b.c.d
Returns IP address represented in dot-decimal notation,
consisting of four decimal numbers, each ranging from 0 to 255,
separated by dots. e.g. 172.16.254.1
1.3.8 Net_GetSubnetMask
Command:
Net_GetSubnetMask
Parameters:
Nil
Response:
Success:
status=1&response1=a.b.c.d
Returns subnet mask represented in dot-decimal notation,
consisting of four decimal numbers, each ranging from 0 to 255,
separated by dots. e.g. 225.225.0.0
1.3.9 Net_GetMac
Command:
Net_GetMac
Parameters:
Nil
Response:
Success:
status=1&response1=a.b.c.d.e.f
Returns the mac id of the device.

HT Series Protocol Guide v1.0.0
1.3.10 Serial_Send
Command:
Serial_Send
Parameters:
param1: <Serial Port>
Can be 1 or 2.
1 - Local Port.
2 - Extender port.
param2: <Serial Data>
Serial data to send.
param3: <timeout>
Not used.
Response:
Success:
status=1
Serial data has been sent.
Failure: No response at all.
Try reducing the string length.
1.3.11 Serial_Read
Command:
Serial_Read
Parameters:
param1: <Serial Port>
Can be only 1.
1 - Local Port.
Response:
Success:
status=1&response1=<Serial Data>
Note: If no data is present, then response will be
'status=1&response1='.
Serial_ReadBufferCount can be used to get the number/count of
the remaining data.

HT Series Protocol Guide v1.0.0
1.3.12 Serial_ClearReadBuffer
Command:
Serial_ClearReadBuffer
Parameters:
param1: <Serial Port>
Can be only 1.
1 - Local Port.
Response:
Success:
status=1
The buffer has been cleared.
1.3.13 Serial_ReadBufferCount
Command:
Serial_ReadBufferCount
Parameters:
param1: <Serial Port>
Can be only 1.
1 - Local Port.
Response:
Success:
status=1&response1=<Count>
Count represents the no of characters yet to be read using
Serial_Read,present in the buffer.
1.3.14 Serial_GetSettings
Command:
Serial_GetSettings
Parameters:
Nil
Response:
Success
status=1&response1==<baud_rate>,<data_bits><parity><stop_bits>
The field <parity> will be "Odd", "Even" or "None".
Example response:
status=1&response1=115200,8,None,1
Note:

HT Series Protocol Guide v1.0.0
This is the serial configuration of the local port of the device. The
serial configuration of the extender port is fixed to
* Baud rate: 115200
* Data bits : 8
* Parity : None
* Stop bits : 1
1.3.15 Serial_SetSettings
Command:
Serial_SetSettings
Parameters:
param1: <Baud_Rate>,<data_bits>,<parity>,<stop_bits>
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).
Valid stop bits: 1, 2.
Response:
Success
status=1&response1==<baud_rate>,<data_bits><parity><stop_bits>
The field <parity> will be "O", "E" or "N".
Example response:
status=1&response1=115200,8,N,1
Note:
This is the serial configuration of the local port of the device. The
serial configuration of the extender port is fixed to
* Baud rate: 115200
* Data bits : 8
* Parity : None
* Stop bits : 1
Failure: Event queue full/failed to create event.
status=0&faultCode=2&Invalid_*
FaultCode 2 implies that internal event queue is full. If internal
event queue is full, then device won't accept any event. Please
try again after some time.

HT Series Protocol Guide v1.0.0
1.3.16 Serial_SetPortCount
Command:
Serial_SetPortCount
Parameters:
Nil
Response:
Success:
status=1&response1=2
HTE/HTW has 2 serial ports –local and remote (which will be
another HTE/HTW).
1.3.17 Serial_SetManualMode
Command:
Serial_SetManualMode
Parameters:
Nil
Response:
Success:
status=1
Device has been set to manual mode.
Failure: System busy.
status=0&faultCode=1&Invalid_state system busy
If a mode change for remote session was requested and that
request is still in progress, then this error -system busy- will be
returned. Please try again after some time.
Failure: Event queue full/failed to create event.
status=0&faultCode=2&Invalid_*
FaultCode 2 implies that internal event queue is full. If internal
event queue is full, then device won't accept any event. Please
try again after some time.
Note: Only local serial port (1) is supported in manual mode.

HT Series Protocol Guide v1.0.0
1.3.18 Serial_SetExtenderMode
Command:
Serial_SetExtenderMode
Parameters:
Nil
Response:
Success:
status=1
Device has been set to extender mode.
Failure: System busy.
status=0&faultCode=1&Invalid_state system busy
If a mode change for remote session was requested and that
request is still in progress, then this error -system busy- will be
returned. Please try again after some time.
Failure: Event queue full/failed to create event.
status=0&faultCode=2&Invalid_*
FaultCode 2 implies that internal event queue is full. If internal
event queue is full, then device won't accept any event. Please
try again after some time.
1.3.19 Serial_SetPushPortMode
Command:
Serial_SetPushPortMode
Parameters:
param1: <Remote IP>
The <Remote IP> should be in dot-decimal notation, consisting
of four decimal numbers, each ranging from 0 to 255, separated
by dots.
e.g. 172.16.254.1
param2: <Remote Serial Port>
Port number of the remote device.
Valid range: 1 <= Remote serial port <= 12.
Response:
Success:
status=1
Device has been set to Push to Port mode.
Failure: System busy.
status=0&faultCode=1&Invalid_state system busy

HT Series Protocol Guide v1.0.0
If a mode change for remote session was requested and that
request is still in progress, then this error -system busy- will be
returned. Please try again after some time.
Failure: Event queue full/failed to create event.
status=0&faultCode=2&Invalid_*
FaultCode 2 implies that internal event queue is full. If internal
event queue is full, then device won't accept any event. Please
try again after some time.
Failure: Invalid request.
status=0&faultCode=1&Invalid_request
The no. of parameters passed is not correct. The command
needs 2 parameters.
Eg:
method=Serial_SetPushPortMode&param1=192.168.1.10&para
m2=5
Failure: Invalid parameter.
status=0&faultCode=1&Invalid_parameter
Invalid parameters were passed. Either IP address is invalid or
<remote_serial_port> value is out of range.
1.3.20 Serial_SetPushVarMode
Command:
Serial_SetPushVarMode
Parameters:
param1: <Remote IP>
The <Remote IP> should be in dot-decimal notation, consisting
of four decimal numbers, each ranging from 0 to 255, separated
by dots.
e.g. 172.16.254.1
param2: <Variable name>
Name of variable in the remote device.
Valid range: 1 <= length of variable name <= 16.
Response:
Success:
status=1
Device has been set to Push to Variable mode.
Failure: System busy.
status=0&faultCode=1&Invalid_state system busy

HT Series Protocol Guide v1.0.0
If a mode change for remote session was requested and that
request is still in progress, then this error -system busy- will be
returned. Please try again after some time.
Failure: Event queue full/failed to create event.
status=0&faultCode=2&Invalid_*
FaultCode 2 implies that internal event queue is full. If internal
event queue is full, then device won't accept any event. Please
try again after some time.
Failure: Invalid request.
status=0&faultCode=1&Invalid_request
The no. of parameters passed is not correct. The command
needs 2 parameters.
Eg:
method=Serial_SetPushVarMode&param1=192.168.1.10&para
m2=tempVariable
Failure: Invalid parameter.
status=0&faultCode=1&Invalid_parameter
Invalid parameters were passed. Either IP address is invalid or
length of the variable is greater than 16 or no variable name was
passed at all.
1.3.21 Serial_SetTelnetClientMode
Command:
Serial_SetTelnetClientMode
Parameters:
param1: <Remote IP>
The <Remote IP> should be in dot-decimal notation, consisting
of four decimal numbers, each ranging from 0 to 255, separated
by dots.
e.g. 172.16.254.1
param2: <Remote Socket Port>
The remote port for the client to connect (where the telnet server
is listening for incoming connections).
0 < remote socket port < 65536.
param3: <timeout>
Not used.
Response:
Success:
status=1
Device has been set to Telnet Client mode.