User guide

17
User Guide
IP Commands
TCP/RPC Commands
Remote procedure calls (RPCs) are used to control the DXE-CAT-S2L from any device with a web
browser (PC, iPad, touch panel, etc.), an external control system, or another web-enabled device. RPCs
can be used to send serial and IR commands, receive serial data, and retrieve system information.
RPCs can be sent in the form of an HTTP POST (used for web based control pages or control from a
Aurora WACI series controller) or TCP commands (used for control from an external control system).
Calls to the RPC server using HTTP POST are done through the /rpc virtual directory, e.g.
http://ip-address/rpc. Use this directory as part of the URL when creating the address for the HTTP POST
transaction. TCP commands are structured the same way as the HTTP POST, but sent over a raw TCP
connection without any HTTP headers.
Command
Description
GetFirmwareVersion ( )
Returns the firmware version
GetSerialNumber ( )
Returns the serial number
Net_GetIPAddress ( )
Returns the IP address
Net_GetSubnetMask ( )
Returns the subnet mask
Net_GetNetCardCount ( )
Returns the number of network ports on the unit
Serial_GetSettings ( Port )
Returns the settings of a specific serial port
1
Serial_Send ( Port, Msg, MaxWaitMS )
Sends a serial command to a specific port
1 2
MaxWaitMS = The number of milliseconds allowed to complete the sending of the
serial data before timing out
GetWebFileNames ( )
Returns the names of the web files
GetIRFileNames ( )
Returns the names of the IR files
Serial_Read ( Port )
Reads the serial buffer for a specific serial port
1 2
Serial_ClearReadBuffer ( Port )
Clears the serial buffer for a specific port
1
Serial_ReadBufferCount ( Port )
Reads the buffer count for a specific port
1
Serial_GetPortCount ( )
Returns the total number of available serial ports (2)
1
IR_GetPortCount ( )
Returns the total number of available IR ports (2)
1
IR_SendCommand ( Port, Group, Command )
Sends an IR command from the specified port
1
Group = The IR file name
Command = The IR command name
IR_ListAllGroups ( )
Returns all loaded IR groups (files)
IR_ListAllCommandsInGroup ( Group )
Returns all IR commands in a specific group
GetMachineType ( )
Returns the ID of the DXE-CAT-S2L controller (used for
communication with other Aurora controllers)
SetDefaultConfig ( )
Resets the DXE-CAT-S2L settings to factory default
1
Serial port 1 / IR port 1 is located on the DXE-CAT-S2L TX unit, serial port 2 / IR port 2 is located on the RX unit
2
Hexadecimal data is represented with a percent sign preceding the 2-byte hex code (e.g. %0D for carriage return)