Download
Share
Print this page
  1. Manuals
  2. Brands
  3. Aurora Manuals
  4. Transmitter
  5. HT Series
  6. Protocol manual

Aurora HT Series Protocol Manual

Hide thumbs Also See for HT Series:

Advertisement

Quick Links

Download this manual
HT Series Protocol Guide v1.2.4
HT Series Protocol Guide v 1.2.4

Advertisement

loading
Need help?

Need help?

Do you have a question about the HT Series and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Aurora HT Series

Summary of Contents for Aurora HT Series

  • Page 1 HT Series Protocol Guide v1.2.4 HT Series Protocol Guide v 1.2.4...
  • Page 2 HT Series Protocol Guide v1.2.4 Revision History Version Revision Description of Changes Number Date 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 Updated RPC command SetExtenderMode.

  • Page 3: Table Of Contents

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

  • Page 4: Control Commands

    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.
  • Page 5 HT Series Protocol Guide v1.2.4 Set Web xxx = 000 – 255 Server !**SMxxx:xxx:xxx:xxx<cr> Example: !**SM255.255.255.000<cr> Subnet Response: ~**SM255.255.255.000<cr> Mask X = 0 or 1 0 = Off Debug Web 1 = On Server !**DEBUGWSx<cr> Processor Example: !**DEBUGWS1 Response: ~**DEBUGWS1<cr>...
  • Page 6 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. Inverts the IR signal from the HDBT and outputs to external IR Transmitter.
  • Page 7 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...
  • Page 8 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> Change USB mode. X = 0 or 1.
  • Page 9 HT Series Protocol Guide v1.2.4 Simulates a button release Button !**BTN_REL<button_num><cr> Example: !**BTN_REL1<cr> release Response: ~**BTN_REL1<cr> Button_num: 1,2, 3 press_mode : press, release color: r,g,b,y,c,m,w, n Set button !**BTN_LED<button_num>,<press_mo corresponding to red ,green, blue, yellow,cyan, de>,<color><cr> magenta, white, none Example/Response:...
  • Page 10 HT Series Protocol Guide v1.2.4 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) !**BTN_PARAM<button_num>,<press_ Set Button mode>,<command_mode>,<command Port: (1/2) serial port in case of serial mode parameters _string>,<port/ip_addr>,<telnet_port>< cr>...
  • Page 11 HT Series Protocol Guide v1.2.4 Reads the string stored in the internal buffer Applicable only in Manual Method of serial port processing Read Serial !**SERIAL_READ<port><cr> Port<1 or 2> Example/Response: !**SERIAL_READ<cr> ~**SERIAL_READ<port>:<string> Clears the serial read buffer Applicable only in Serial port processing manual method.

  • Page 12: Serial Query Commands

    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 String Format Information Command X = 000 - 255 Web Server IP ?**IP<cr>...
  • Page 13 HT Series Protocol Guide v1.2.4 1 - Static 2 – AutoIP Response: ~**LOCKx<cr> Front panel X = 0 or 1 lock ?**LOCK<cr> 0 - Unlocked. query 1 - Locked. Application Response: ~**VER1:a.b.c<cr> ?**VER1<cr> version Version is ‘a.b.c’. Response: ~**VER2:a<cr> Explore Version is ‘a’.
  • Page 14 HT Series Protocol Guide v1.2.4 Response: ~**VS_INVERSEx<cr> IR Inverse at transmitter ?**VS_INVERSE<cr> x = 0 or 1 side 0 - Not Inverted 1 = Inverted IR Response: ~**VS_CARRIER_STRIPx<cr> IR Carrier at transmitter ?**VS_CARRIER_STRIP<cr> x = 0 or 1 side 0 - Carrier present...
  • Page 15 HT Series Protocol Guide v1.2.4 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), Button LED ?**BTN_LED<button_num><press_mode> c(cyan), g(green), m(magenta), Colour <cr>...
  • Page 16 HT Series Protocol Guide v1.2.4 Returns the static ip of the device <cr> ?**STATICIP Response: Static IP ?**STATICIP<cr> ~20STATICIP<ip>,NM<netmask > ip: ip address netmask : netmask button number: 1,2,3 press mode : p, r P- press R- release mode: T,S...
  • Page 17 HT Series Protocol Guide v1.2.4 Returns the used length of internal serial buffer. Applicable only in serial port processing manual method Used Serial Response: ?**SERIAL_COUNT<port_num><cr> buffer ~**SERIAL_COUNT<port_num><x <cr> > port_num: portnum (1 or 2) x- length of buffer used Returns the total serial ports in...

  • Page 18: Rpc Commands

    HT Series Protocol Guide v1.2.4 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=<...
  • Page 19 HT Series Protocol Guide v1.2.4 Enables and disables the button lock method=ButtonLock&Param1=<en ButtonLock able/disable> method=ButtonLock&Para m1=enable Enter the DHCP mode Net_SetDHCP method=Net_SetDHCP method=Net_SetDHCP Enters the Auto IP mode Net_SetAutoIP method=Net_SetAutoIP method=Net_SetAutoIP Controls the IR carrier Strip Removes the carrier from the...
  • Page 20 HT Series Protocol Guide v1.2.4 method=IR_HDBTCarrierS trip&Param1=<enable/di sable> Inverts the IR signal from the IR Remote and outputs to HDBT. method=IR_HDBTCarrierInverse IR_HDBTCarrierInverse Note: It is enabled by &param1=<enable/disable> default. method=IR_HDBTCarrierI nverse &param1=enable <input> :linein, dante,hdmi remote_audio, arc <output> lineout, dante,stream_audio, remote_audio method=SetAudioRoute&Param1=...
  • Page 21 HT Series Protocol Guide v1.2.4 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 IR Carrier removal = Disabled...
  • Page 22 HT Series Protocol Guide v1.2.4 Simulates a button press. method=ButtonPress&Param1=<b param1 = 1, 2, 3(wallplate) ButtonPress utton_no> method=ButtonPress&P aram1=2 Simulates a button Release. method=ButtonRelease&Param1= param1 = 1, 2, 3(wallplate) ButtonRelease <button_num> method=ButtonRelease&P aram1=2 Sets the button color. Only applicable for wallplate.
  • Page 23 HT Series Protocol Guide v1.2.4 default mode is applicable only for release mode. Default mode is video source selection. method=ClearButtonMode &Param1=2&Param2=Press &Param3=Serial param1=1,2,3(wallplate) param2=press/release param3=tcp,serial,default param4=string in quotes param5= serial port num eg 1 in case serial mode and ip SetButtonParam&Param1=<button...
  • Page 24 HT Series Protocol Guide v1.2.4 method= Serial_SetExtenderMode &param1=0 Serial data will be push ed to port of the device with the set ip address param1=ip address Serial_SetPushPortMode Serial_SetPushPortMode param2 = serial_port number method= Serial_ SetPushPortMode &Param1=192.168.1.100& Param2=1 Serial data will be stored in the...
  • Page 25 HT Series Protocol Guide v1.2.4 method=Serial_SetTelne tServerMode&param1=500 Send the ir command stored in the filename in the internal IR_SendIR&Param1=<filename> filesystem. IR_SendIR &Param2=<command_name> method=IR_SendIR&Param 1=sony.wir &Param2=ON List all the ir files in the device IR_ListIRGroups IR_ListIRGroups method=IR_ListIRGroups Lists all the commands in the queried filename.
  • Page 26 HT Series Protocol Guide v1.2.4 param1=1,2, 3 (wallplate) param2=press, release GetButtonMode&Param1= param3=tcp, serial GetButtonMode <button_num>&Param2=<press_m ode>&Param3=<press_mode> method=GetButtonMode&P aram1=1&Param2=press&P aram3=tcp 3 commands to get ip, subnet, gateway Net_GetIPAddress method= Net_GetIPAddress, method= Net_GetSubnetMask, method=Net_GetSubnetMask Net_GetIPAddress method=Net_GetSubnetMa Net_GetGateway method= Net_GetGateway method= Net_GetGateway Returns the last set static ip of...
  • Page 27 HT Series Protocol Guide v1.2.4 Returns the mac id Net_GetMac Net_GetMac method= Net_GetMac Returns the serial settings method= Serial_GetSettings Serial_GetSettings Serial_GetSettings Response: status=1&response1=115 200,8,N,1 Returns the current USB Mode GetUSBMode GetUSBMode method=GetUSBMode Returns the serial number of the device GetSerialNumber...
  • Page 28 HT Series Protocol Guide v1.2.4 method= GetBootloaderPresence Returns the IR inverse value IR_GetInverse IR_GetInverse method= IR_GetInverse Returns the IR carrier strip value IR_GetCarrierStrip IR_GetCarrierStrip method= IR_GetCarrierStrip Returns the IR HDBT carrier inverse value. IR_GetHDBTCarrierInverse IR_GetHDBTCarrierInverse method=IR_GetHDBTCarri erInverse Returns the HDBT carrier strip...
  • Page 29 HT Series Protocol Guide v1.2.4 method= Serial_ReadBufferCount Returns the total number of serial ports in the device Serial_GetPortCount Serial_GetPortCount method=Serial_GetPortC ount Returns the autosense status Applicable only in HTE TX GetAutoSense GetAutoSense Devices method=GetAutoSense Sets the auto sense Applicable only in HTE TX SetAutoSense&Param1=...
  • Page 30 HT Series Protocol Guide v1.2.4 param1=source num method=GetVideoSourceP riority&Param1=1 Returns the HDCP capability of the device. Applicable only in HTE TX Devices param1= ‘all‘ or ‘none’ SetHDCPCapability&Param1=<cap SetHDCPCapability > all : HDCP is enabled. None : HDCP is disabled. method= SetHDCPCapability &Param1=all...

  • Page 31: Tcp Commands

    HT Series Protocol Guide v1.2.4 1.4 TCP Commands The device parameters can be controlled by TCP commands. A TCP server is running at the port 6970 which listens for the TCP command and responds in JSON format accordingly. TCP Command...
  • Page 32 HT Series Protocol Guide v1.2.4 Command_name: Name of the ir command Send_ir sony.wir PLAY Lists the IR files stored in the device; list_ir_groups list_ir_groups list_ir_groups Lists the IR commands listed in an IR File. list_ircmds list_ircmds <file_name> list_ircmds sony.wir Displays the full info of the Audio routing in the...
  • Page 33 HT Series Protocol Guide v1.2.4 Configures the button mode to send serial, tcp commands and default functionality all in a single press/release or any combination button_number: 1,2,3 (only for wallplate) press_mode: press, release set_button_mode <button_number> set_button_mode button_mode: tcp, serial, default <press_mode>...
  • Page 34 HT Series Protocol Guide v1.2.4 Set the button parameters that is used when a button is pressed or released corresponding to the mode set against that button. Button_num: 1,2,3 press_mode; press, release command_mode: serial, tcp set_button_param command_string: string with length of max 256 <button_number>...
  • Page 35 HT Series Protocol Guide v1.2.4 Configures the port processing method for the device. Mode: Remote session mode. telnet_client, telnet_server, extender, manual, push_to_port, push_to_var Param1: Mode specific. telnet_client, push_to_port, push_to_var – IP address. telnet_server – Server port. manual – Not needed.
  • Page 36 HT Series Protocol Guide v1.2.4 Returns the mac id of the device get_mac get_mac get_mac Returns the rs232 configuration values get_rs232 get_rs232 <port_num> port_num: 1 or 2 get_rs232 1 Returns the serial buffer when in manual method serial_read serial_read <port_num>...
  • Page 37 HT Series Protocol Guide v1.2.4 Enters the bootloader mode to receive the new firmware via tftp. After timeout, if no firmware is update_firmware update_firmware received, the previous firmware is loaded. update_firmware Controls the button lock button_lock button_lock <enable/disable> button_lock disable...
  • Page 38 HT Series Protocol Guide v1.2.4 Defaults the file system. After defaulting, the device will reboot with /IR and /wwwpub filesystem_default filesystem_default directories present. filesystem_default 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...
  • Page 39 HT Series Protocol Guide v1.2.4 Returns the current usb mode get_usb_mode get_usb_mode get_usb_mode Returns the serial number of device get_serial_number get_serial_number get_serial_number Returns the button lock status get_button_lock get_button_lock get_button_lock Returns the firmware version get_fw_version get_fw_version get_fw_version Returns the explore firmware version...

  • Page 40: Miscellaneous

    HT Series Protocol Guide v1.2.4 Sets the hdcp capability of the device. Only for TX device. <cap>: all or none set_hdcp_capability set_hdcp_capability <cap> ‘all’ : HDCP enabled. ‘none’ : HCDP disabled. set_hdcp_capability all Returns the hdcp capability of the device.

This manual is also suitable for:

Ht-tx1-wp2