Clockaudio TIM-1000, Руководство пользователя

Страница: 34 / 44

Page 26 of 35 V1.4 2019-09
11 Programming using UDP commands
UDP commands are the preferred method of communication between a control system (Crestron,
AMX, etc.) or DSP and Clockaudio’s TIM-1000 product. The section below defines a comprehensive
list of all UDP commands that TIM-1000 supports for configuration and management.
UDP commands are sent as ASCII character string with spaces used to delimit fields within a
command. The entire command is delimited with a Carriage Return. Whenever a command is sent
to the device, all acknowledged commands are returned with the command data with the string
“ACK” inserted preceding the command data.
If the device could not process a command then the command is returned with a “NACK” followed
by the string of data that was sent. NACKs are always returned for unknown commands, commands
with fewer parameters than expected or commands with invalid parameters.
The following sections describe the UDP command handling and the commands that are available
for TIM-1000. The default port number utilised for the UDP command is set to 49494.
All commands shall follow the following rule:
<COMMAND><Space><PARAM 1><Space><PARAM 2><Space>…<PARAM 6><CR>
Where: <COMMAND> is the actual command sent to the device
<Space> is a space character (20H from the ASCII Table) sent to the device
<PARAM 1> is the first parameter sent to the device
<PARAM 2> is the second parameter sent to the device
:
<PARAM 6> is the sixth parameter sent to the device
<CR> is the carriage return character (0DH from the ASCII Table) sent to the device
NOTES:
1. It is important that only a single space character is inserted between <COMMAND> and
<PARAM 1> as well as between each parameters.
2. An invalid <COMMAND>, value of any <PARAM x> and/or additional spaces inserted shall
result in the entire command being rejected. In that case a “NACK” followed by the string
sent shall be returned from the device.
3. Depending upon command syntax, a carriage return shall immediately follow the
<COMMAND> or the final parameter for the command.
4. Transmission of insufficient parameters for the command shall result in the entire
command being rejected. In that case a “NACK” followed by the string sent shall be
returned from the device.
5. It shall be acceptable to have either no space or a single space character at the end of a
completed UDP command; more than one space shall result in command being rejected
and a “NACK” returned.