Commands; Responses; Methodnames; Security - Martin Audio Ikon IK81 User Manual

iK81 / iK42
In an RS485 network, the user will need to ensure that there are no duplicate DeviceNames on the network.


Commands

A command tells the connected device what general action is to be performed

Defined commands are:

1. SET This tells a receiving device that it should set the value of the specified parameter to a particular value.
Example: $SET Out2/Gain 3.5dB<CR> 5.2.2.
GET This requests the value of the specified parameter. The receiving device will return a "NOTIFY" command,
2.
appended with the value of that parameter.
Example: $GET Out8/Eq2Freq<CR>.
Response: $NOTIFY Out8Eq2Freq 330Hz<CR>
Note that since parameter values are quantised in the device, the value returned in any subsequent GET response
may not be exactly the same as the value in a SET command. For example, $SET Out1/Gain -22.415dB<CR> might
set the parameter value to -22.42dB. Similarly, if a SET or CHANGE command attempts to set a parameter to a
value outside of its permitted range, a subsequent GET command will return the permitted value.
3. NOTIFY Used to respond to a GET
4. VERSION This requests the version of the scripting protocol, which may be enhanced from time to time. There are
no further parameters for this command.
Example: $VERSION<CR>
The response is similar to a GET; i.e. $NOTIFY VERSION 1.28<CR>
5. ERROR. This is returned when the message was erroneous. Error responses will return the original message,
prepended with ERROR and appended with a brief error description and an error number. Examples of error
responses are:
A message is badly formed: $ERROR <original message> BadCommand 06<CR>
The Method was not supported in the device: $ERROR <original message> UnsupportedMethod 09<CR>

Responses

There are several types of response:
1. ERROR (when the message is erroneous)
2. NOTIFY (when a device sends back a parameter value in response to a Get: $NOTIFY Out2/Eq3Gain 2.6dB<CR>

MethodNames

For each type of device, a list of compatible MethodNames is published. Please refer to the documentation for the specific device.

Security

Not all the published MethodNames will be accessible; some of these might have been 'locked' by the vendor.

Parameter Values

Parameter Values are stated in 'natural' units of measure (e.g. Hz, dB etc) in decimal format with any desired precision (although
this will be truncated to the precision the device is capable of interpreting).
Although not necessary, for convenience, a suffix may be added after the value to indicate units of measure (without a space).
Examples are:
Hz //Freq type

Oct //Bandwidth type

dB //dB type

ms //Time type

X //multiplier type

:1 //Ratio type

W //Power type

R //resistance type (Ohms) (e.g. 4.2R)

Min //minutes type

C //temperature type

V //voltage type

iK81 / iK42 User Guide V2.3
USER GUIDE
(e.g. 650.3Hz)
(e.g. 0.32Oct)
(e.g. -3.4dB)
(e.g. 120.3ms)
(e.g. 3.2X)
(e.g. 4:1)
(e.g. 452.3W)
(e.g. 122.5Min)
(e.g. 34.5C)
(e.g. 233.6V)
40