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:
Table of Contents

Advertisement

Quick Links

Download this manual
HT Series Protocol Guide v1.0.0
HT Series
Protocol Guide
v 1.0.0

Advertisement

Table of Contents
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.0.0 HT Series Protocol Guide v 1.0.0...
  • Page 2 HT Series Protocol Guide v1.0.0 Revision History Version Revision Description of Changes Number Date 1.0.0 12 - 8 - 2019 Initial Version.

  • Page 3: Table Of Contents

    HT Series Protocol Guide v1.0.0 Contents Customer Commands ...................... 5 Serial commands....................... 5 Serial Query Commands ..................8 RPC Commands ...................... 10 1.3.1 GetApiVersion ......................10 1.3.2 GetFirmwareVersion ....................11 GetSerialNumber ....................11 1.3.3 Reboot ........................11 1.3.4 1.3.5 EnterUpdateMode ....................12 1.3.6...
  • Page 4 HT Series Protocol Guide v1.0.0...

  • Page 5: Customer Commands

    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.
  • Page 6 HT Series Protocol Guide v1.0.0 X = 0 or 1 0 = Off Debug Web 1 = On Server !**DEBUGWSx<cr> Processor Example: !**DEBUGWS1 Response: ~**DEBUGWS1<cr> X = 0 or 1 0 = Off Debug Web 1 = On Video !**DEBUGMPx<cr>...
  • Page 7 HT Series Protocol Guide v1.0.0 Example: !**IR_INVERSE1<cr> Response: ~**IR_INVERSE1<cr> Input From Linein - 1, Dante - 2, HDMI - 3, RemoteAudio - 4, ARC - 5, None - 0 Output To Lineout - 1, Dante - 2, HDMI - 3, Remote...

  • Page 8: Serial Query Commands

    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>...
  • Page 9 HT Series Protocol Guide v1.0.0 Response: ~**SP1,b,d,p,s<lf> b = Baud Rate 1200, 2400, 4800, 9600, Serial Port Settings ?**SP1<cr> 19200, 38400, 57600, 115200 d = Data Size 7 or 8 p = Parity N, E, O (None, Even, Odd) s = Stop Bits 1 or 2...

  • Page 10: Rpc Commands

    HT Series Protocol Guide v1.0.0 x = 0 or 1 0 - Not Inverted 1 = Inverted IR Response: ~**IR_CARRIER_STRIPx<lf> IR Carrier ?**IR_CARRIER_STRIP<cr> x = 0 or 1 0 - Carrier present 1 = Carrier absent Response: Video Source for ~20VID_SRCx<lf>...

  • Page 11: Getfirmwareversion

    HT Series Protocol Guide v1.0.0 1.3.2 GetFirmwareVersion Command: GetFirmwareVersion Parameters: 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: Response: Success: status=1&response1=X X is an 8-digit number. 1.3.4 Reboot...

  • Page 12: Enterupdatemode

    HT Series Protocol Guide v1.0.0 1.3.5 EnterUpdateMode Command: EnterUpdateMode Parameters: 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.

  • Page 13: Net_Getipaddress

    HT Series Protocol Guide v1.0.0 1.3.7 Net_GetIPAddress Command: Net_GetIPAddress Parameters: 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...

  • Page 14: Serial_Send

    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.

  • Page 15: Serial_Clearreadbuffer

    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.

  • Page 16: Serial_Setsettings

    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 : * Parity None * Stop bits : 1.3.15 Serial_SetSettings...

  • Page 17: Serial_Setportcount

    HT Series Protocol Guide v1.0.0 1.3.16 Serial_SetPortCount Command: Serial_SetPortCount Parameters: 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: Response: Success: status=1 Device has been set to manual mode.

  • Page 18: Serial_Setextendermode

    HT Series Protocol Guide v1.0.0 1.3.18 Serial_SetExtenderMode Command: Serial_SetExtenderMode Parameters: 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.

  • Page 19: Serial_Setpushvarmode

    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.

  • Page 20: Serial_Settelnetclientmode

    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.

  • Page 21: Serial_Settelnetservermode

    HT Series Protocol Guide v1.0.0 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.
  • Page 22 HT Series Protocol Guide v1.0.0 Device has been set to Telnet Server 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.

  • Page 23: Non - Customer Commands

    HT Series Protocol Guide v1.0.0 2. Non - Customer Commands These commands should not be released to the customer. 2.1 Serial commands Serial String Format Information Command X = 0 or 1 or X 0 - Explore in normal mode.

  • Page 24: Rpc Commands

    HT Series Protocol Guide v1.0.0 Only for debugging Purposes. Enable/Disable automatic explore ICP update on boot. X = 0 or 1. 0 - Disabled. Explore ICP !**EP_ICPx<cr> 1 - Enabled. update. Example: !**EP_ICP1<cr> Response: ~**EP_ICP1<cr> Only for debugging Purposes. Updates the VGA EDID in the EEPROM chip of wallplate(HTW).

  • Page 25: Miscellaneous

    HT Series Protocol Guide v1.0.0 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. 3. Miscellaneous 3.1 Device firmware update.

Table of Contents