Wyrestorm EX-SW-0301-H2 - Configuring the Serial Port and Command Structure; Serial Port Properties; Serial Port Data Type; Serial Command End Character

© Copyright 2018 WyreStorm Technologies | WyreStorm.com
EX-SW-0301-H2 API | 180619-1616
8 of 13
North America: 844.280.WYRE (9973) | UK/EMEA: +44 (0) 1793 230 343
Email: Support@WyreStorm.com
4.6 Configuring the Serial Port and Command Structure
Note: Conditions on sending commands exist based on how the devices will be used in a system.
• When used together as a TX and RX commands can only be sent to the RX.
• When TX is used with a different HDBT receiver commands can only be sent to the TX.
Serial Port Properties
Set Serial Port Properties
SET UART_INFO [Prm] dev<CR><LF>
Response: UART_INFO SET [Prm] dev<CR><LF>
Example: SET UART_INFO 115200 tx<CR><LF>
Response: UART_INFO SET 115200 tx<CR><LF>
Query Serial Port Properties
GET UART_INFO rx<CR><LF>
Response: UART_INFO GET [Prm] rx<CR><LF>
Example: GET UART_INFO rx<CR><LF>
Response: UART_INFO GET 115200 rx<CR><LF>
[Prm] = 9600 | 38400 | 57600 | 115200
//[PRM] is the baudrate.
Serial Port Data Type
Set Serial Data Type
SET UART_DATATYPE [Prm] rx<CR><LF>
Response: SET UART_DATATYPE [Prm] rx<CR><LF>
Example: SET UART_DATATYPE str rx<CR><LF>
Response: UART_DATATYPE SET str rx<CR><LF>
Query Serial Data Type
GET UART_DATATYPE rx<CR><LF>
Response: UART_DATATYPE GET [Prm] rx<CR><LF>
Example: GET UART_DATATYPE rx<CR><LF>
Response: UART_DATATYPE GET str rx<CR><LF>
[Prm] = str | hex
//str in [Prm] = ASCII string
Serial Command End Character
Set Serial Command End Character
SET UART_E [Prm] rx<CR><LF>
Response: UART_E SET [Prm] rx<CR><LF>
Example: SET UART_E crlf rx<CR><LF>
Response: UART_E SET crlf rx<CR><LF>
Query Serial Command End Character
GET UART_E rx<CR><LF>
Response: UART_E GET [Prm] rx<CR><LF>
Example: GET UART_E rx<CR><LF>
Response: UART_E GET crlf rx<CR><LF>
[Prm] = null | cr | lf | crlf
cr: carriage Response, ascii code is 0x0D.
lf: line feed, ascii code is 0x0A.
Edit Serial Command in ASCII String
Set Serial Command ASCII String
SET UART_STR [Prm1] [Prm2]<CR><LF>
Response: UART_STR SET [Prm1] [Prm2]<CR><LF>
Example: SET UART_STR on xxxx<CR><LF>
Response: UART_STR SET on xxxx<CR><LF>
Query Serial Command ASCII String
GET UART_STR [Prm1]<CR><LF>
Response: UART_STR GET [Prm1] [Prm2]<CR><LF>
Example: GET UART_STR on<CR><LF>
Response: UART_STR GET on xxxx<CR><LF>
[Prm1] = on | off
[Prm2] = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
//PRM2 is the original command according to device
guidelines
Edit Serial Command in HEX String
Set Serial Command HEX String
SET UART_HEX [Prm] [Hex String]<CR><LF>
Response: UART_HEX SET [Prm] [Hex String] <CR><LF>
Example: SET UART_HEX on 31 32 33 34 35 36<CR><LF>
Response: UART_HEX SET on 31 32 33 34 35 36<CR><LF>
Query Serial Command HEX String
GET UART_HEX [Prm1]<CR><LF>
Response: UART_HEX GET [Prm1] [Hex1] [Hex2] hex3 …. <CR><LF>
Example: GET UART_HEX on<CR><LF>
Response: UART_HEX GET on xx xx xx xx ….<CR><LF>
[Prm] = on | off
[Hex String] = Hex string up to 64bytes
// [Hex1] | [Hex2] | … is ascii string of hex value. For
example, string "123", convert to correct format string
is“31 32 33”.