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.