ALMA Interface Protocol Usage and Examples

The ALMA interface protocol allows 3rd party products to control Australian Monitor products using
the protocol described below. The full protocol is listed at the end of this document.

Message Format
Operation Section Group Param Sub Ssub value CR

 Message fields are separated with a space character (0x20 in hex)

 Message is terminated with a carriage return character (0x0D in hex)
 Operation is “get”, “set” or “reply”
 Mandatory Fields
o operation, section, group & param
 Optional Fields
o sub & ssub fields are optional
 Value field applies only to “set” & “reply” operations.
 Message field values are specified in the table at the end of this document or the
accompanying excel file

Example,

Description Command
Set output 1 volume to -40dB set active out1 vol -40CR

*Extended examples are shown on the next page

Notes

 For “reply” operation, in case of success, value field will contain the requested/updated item
 For “reply” operation, in case of failure, value field will contain the text “error”.
 Wildcard “all” is available for message fields param, sub or ssub to provide access to first-
level object members only.

Australian Monitor Pty Ltd

Unit 1, 2 Daydream Street, Warriewood, NSW 2102, Australia
+61 2 9998 7600
ABN 86 003 231 187
 Extended Examples

operation section group param sub ssub value Carriage Return

Set input 1 volume of preset 1 to
-20dB set preset1 in1 vol -20.0 CR
CR
reply preset1 in1 vol -20.0
CR
Set output 1 volume to -40dB set active out1 vol -40
CR
reply active out1 vol -40
CR
Mute output 4 set active out4 mute true
CR
reply active out4 mute true
Set output 1 to use input 4 mixout1in CR
source set active 4 source true
mixout1in CR
reply active 4 source true
Get the fault status of output 3 CR
amplifier get active out3 amp status fault
CR
reply active out3 amp status fault false
Save current configuration to CR
preset 1 set device preset save 1
CR
reply device preset save 1
CR
Recall preset 1 set device preset recall 1
CR
reply device preset recall 1
CR
Enter standby mode set device mode standby true
CR
reply device mode standby true
CR
Get product serial number get device version serial
nsnu1807dja000 CR
reply device version serial 01
Set input 1 volume of preset 1 to CR
-20dB set preset1 in1 vol -20
CR
reply preset1 in1 vol -20
CR
Set the username to “admin” set device security user1 name admin
CR
reply device security user1 name admin
Log in with username and CR
password “admin” set device security login admin,admin
CR
reply device security login admin,admin
CR
Reset the device set device mode reset true
CR
reply device mode reset true

Australian Monitor Pty Ltd

Unit 1, 2 Daydream Street, Warriewood, NSW 2102, Australia
+61 2 9998 7600
ABN 86 003 231 187
 Version 2.0.1 operation Used in
ALMA Interface Protocol Specification for Australian Monitor products permission Product Flag
30/07/2020
Name Value Type set get

HSxxP
operation

No access

ISxxP

TBA

TBA
section

param
Description Comment
group

ssub
Unsecure

sub
Value Type Value Range
Secure
Admin
object will contain section,
operation to update group & param fields, sub & Y
set object config data ssub are optional - - Y
object will contain section,
operation to retrieve group & param fields, sub & Y
get object config data ssub are optional - - Y
object will contain section,
operation to reply to a group & param fields, sub & Y
reply object 'get' or 'set' operation ssub are optional - - Y
device object Device Section - - Y Y
version object Version group - - Y Y
see AM-TS-140414 Product
Y
serial string Serial Number Serial Numbering Standard N U Y
array[3], unsigned 8- Application firmware
Y
app bit number 0..255 version format: major.minor.build N U Y
array[3], unsigned 8- Bootloader firmware
Y
boot bit number 0..255 version format: major.minor.build N U Y
array[3], unsigned 8-
Y
dsp bit number 0..255 DSP firmware version format: major.minor.build N U Y
array[6], unsigned 8-
N
mac bit number 0..255 MAC Address N U Y
array[3], unsigned 8- JSON Interface Protocol
Y
json bit number 0..255 Specification version format: major.minor.build N U Y
Hardware ID
unsigned 8-bit (deprecated, use Y
hardware number 1..32 parameter 'pcbrev') PCB ID N U N
Amplifier ID
unsigned 8-bit (deprecated, use Y
amp number 1..32 parameter 'pcbrev') PCB ID N U N
Amplifier Model
N
model string 8 bytes, UTF-8 Number N U Y
array[numpcbrev], Array of PCB revision
unsigned 8-bit numbers. Value 255 indicates Y
pcbrev number 0..99 PCB revision array PCB not detected N U Y
config object Configuration Group - - Y Y
unsigned 8-bit For RS485 & daisy chained
N
id number 0..255 Device ID devices S S N
name string 32 bytes, UTF-8 Device name default to serial number S S Y Y
unsigned 8-bit
Y
numinput number 0..255 Total Number of inputs N S Y
 unsigned 8-bit Total Number of
Y
numoutput number 0..255 outputs N S Y
unsigned 8-bit Number of microphone
N
nummic number 0..255 inputs N S N
unsigned 8-bit
N
numline number 0..255 Number of line inputs N S N
unsigned 8-bit Number of paging
N
numpaging number 0..255 inputs N S N
unsigned 8-bit Number of stereo
N
numstereo number 0..255 inputs N S N
unsigned 8-bit Number of Media Only one Media Player input
N
nummp number 0..255 Player inputs per device N S N
unsigned 8-bit Number of Pink Noise
N
numpink number 0..255 inputs N S N
unsigned 8-bit Number of White Noise Only one White Noise input
N
numwhite number 0..255 inputs per device N S N
unsigned 8-bit Number of Sine wave Only one Sine wave Test Tone
N
numtesttone number 0..255 Test Tone inputs input per device N S N
unsigned 8-bit Number of mono
N
numoutm number 0..255 outputs N S Y
unsigned 8-bit Number of stereo
N
numouts number 0..255 outputs N S N
unsigned 8-bit Number of filters per
N
numfilterin number 0..255 input N S N
unsigned 8-bit Number of filters per
Y
numfilterout number 0..255 output N S Y
unsigned 8-bit Number of tones per
N
numtone number 0..255 output N S N
unsigned 8-bit
Y
numpreset number 0..255 Number of Presets N S Y
unsigned 8-bit Number of Security
Y
numuser number 0..255 Users N S Y
unsigned 8-bit
N
numntpaddr number 0..255 Number of NTP Servers N S N
unsigned 8-bit Number of PCB revision
Y
numpcbrev number 0..255 numbers N S Y
unsigned 8-bit Number of Control Port
N
numcontrol number 0..255 pins N S Y
mode object Mode Group - - Y Y
reset action may disconnect
Y
reset bool true Reset device action flag browser S N Y
Factory Reset device
action: all, current reset action may disconnect Y
factory char a, c, p config, presets browser S N Y
Standby mode action
Y
standby bool true/false flag enter / exit Standby Mode S S Y
Wake on LAN action
N
wakelan bool true/false flag S S Y
Auto standby mode enable / disable Auto Standby
Y
autostandby bool true/false action flag Mode S S Y
 unsigned 16-bit
Y
autotime number 0..maxTime (s) Auto standby time display as minutes & seconds S S Y
only used in HSP. Auto
Auto standby threshold standby moved to inX section Y
autolevel signed 8-bit number minVol..maxVol (dB) level for other products S S N
output volumes ramp up over
unsigned 16-bit soft start period after power Y
softstart number 0..65535 (ms) Audio soft start period up or exit standby S S Y
array[numcontrol], Control Port pin feature
N
control string assignment array - - Y
… as per controlX - - N Y
Control Port pin feature
assignment where X = N
controlX string 5 bytes, UTF-8 1..numcontrol S S Y
Device Mode Status
Y
status object information - - Y
Standby mode status Standby Mode may have
Y
standby bool true/false flag multiple triggers N S Y
array[numoutput],
failover object Failover Param array
… as per failoverX - - N Y
Config for failover X
where X =
failoverX object 1..numoutput
unsigned 8-bit
N
id number 1..numuser User ID index N A Y
unsigned 8-bit Monitored input to
N
inputlost number 1..255 trigger failover S S Y
unsigned 8-bit Fallback input when
N
switchoverinput number 1..255 monitored input lost S S Y
Threshold to start
N
threshold float (32-bit) number minVal..maxVal (dB) failover action S S Y
unsigned 16-bit Delay before switchover
N
delay number 0..65535 (ms) actioned S S Y
Switchover input
N
vol float (32-bit) number minVol..maxVol (dB) volume S S Y
enable bool true/false Enable failover flag S S N Y
Failover status
N
status object information N S Y
unsigned 8-bit
Y
id number 1..numuser User ID index N A Y
activated bool true/false Failover activated flag N S N Y
0=turn all front panel
leds off for ten seconds,
N
unsigned 8-bit 1=turn all front panel
led number 0-255 leds On for ten seconds S S Y
preset object Preset Group - - Y Y
unsigned 8-bit Save active audio
Y
save number 1..numpreset configuration to Preset S N Y
 Recall audio
unsigned 8-bit configuration from Y
recall number 1..numpreset Preset S N Y
array[numpreset],
Y
name string Preset name array - - Y
… as per nameX - - Y Y
Preset name where X =
Y
nameX string 32 bytes, UTF-8 1..numpreset S S Y
network object Network Group - - N Y
default: AusMonitor (NETBIOS
N
name string 15 bytes, UTF-8 Network domain name / DNS friendly name) S S Y
array[6], unsigned 8- same data as
N
mac bit number 0..255 MAC Address device,version,mac S S Y
array[4], unsigned 8- Used when DHCP client is
N
ipaddr bit number 0..255 IPv4 Address disabled S S Y
array[4], unsigned 8- Used when DHCP client is
N
subnet bit number 0..255 Subnet Mask disabled S S Y
array[4], unsigned 8- Default Gateway Used when DHCP client is
N
gateway bit number 0..255 Address disabled S S Y
When disabled, use the
specified ipaddr, subnet & N
dhcp bool true/false DHCP Client enable flag gateway S S Y
proxy bool true/false Proxy Server enable flag S S N N
array[4], unsigned 8-
N
proxyaddr bit number 0..255 Proxy Address S S N
unsigned 16-bit
N
proxyport number 0..65535 Proxy Port S S N
NTP Server Address
ntpaddr array[numntp], string array - - N Y
… as per ntpX - - N Y
NTP Server Address
N
ntpaddrX string 32 bytes, UTF-8 where X = 1..numntp S S Y
Network Status
N
status object information - - Y
Link established status
N
link bool true/false flag N S Y
Connection established
N
connect bool true/false status flag N S Y
tcpserver S S N Y
enable bool true/false Enable failover flag S S N Y
unsigned 16-bit
N
port number 0..65535 tcpserver port number S S Y
udpserver S S N Y
enable bool true/false Enable failover flag S S N Y
unsigned 16-bit
N
port number 0..65535 udpserver port number S S Y
security object Security Group - - Y Y
enable bool true/false Security enable flag default: false A U Y Y
 No space or comma in
username or password. Y
login array[2], string 32 bytes, UTF-8 Login array Format: username,password U N Y
logout string 32 bytes, UTF-8 username S N N Y
array[numuser],
Y
user object User array - - Y
… as per userX - - Y Y
User X where X =
Y
userX object 1..numuser - - Y
unsigned 8-bit
Y
id number 1..numuser User ID index N A Y
name string 32 bytes, UTF-8 Username default: admin A A Y Y
password string 32 bytes, UTF-8 Password default: admin A A Y Y
email string 32 bytes, UTF-8 Email address A A N Y
active bool true/false User active flag A A N Y
admin bool true/false Admin permission flag A A Y Y
Operation 'get' requires
N
get bool true/false secure access flag A A Y
Operation 'set' requires
N
set bool true/false secure access flag A A Y
unsigned 16-bit display as hours, minutes &
Y
timeout number 10..65535 (s) Login active time period seconds A A Y
rtc object Real Time Clock Group - - N N
date array[3], number Date array - - N N
unsigned 16-bit
N N
year number 0..65535 Year no epoch S S
unsigned 8-bit
N N
month number 1..12 Month S S
unsigned 8-bit
N N
date number 1..31 Date S S
time array[3], number Time array - - N N
unsigned 8-bit
N N
hour number 0..23 Hour S S
unsigned 8-bit
N N
min number 0..59 Minute S S
unsigned 8-bit
N N
sec number 0..59 Second S S
datetime array[6], number Date & Time array - - N N
unsigned 16-bit
N N
year number 0..65535 Year no epoch S S
unsigned 8-bit
N N
month number 1..12 Month S S
unsigned 8-bit
N N
date number 1..31 Date S S
unsigned 8-bit
N N
hour number 0..23 Hour S S
unsigned 8-bit
N N
min number 0..59 Minute S S
unsigned 8-bit
N N
sec number 0..59 Second S S
 log object Log Request Group - - N Y
enable object Log Request flags - - N Y
error bool true/false All Error logs S S N Y
warn bool true/false All Warning logs S S N Y
info bool true/false All Information logs S S N Y
Next Error logged
N
nexterror bool true/false (subscribe while true) S S Y
Next Warning logged
N
nextwarn bool true/false (subscribe while true) S S Y
Next Information
logged (subscribe while N
nextinfo bool true/false true) S S Y
error array[...], string Error Log (reply only) N S N Y
Warning Log (reply
N
warn array[...], string only) N S Y
Information Log (reply
N
info array[...], string only) N S Y
Active Audio Processing
Y
active object Section - - Y
array[numexpansion],
expansion object Expansion Group array - - N Y
… as per expansionX - - Y
Config for Expansion X
where X =
expansionX object 1..numexpansion - - N Y
unsigned 8-bit
N
id number 1..numexpansion Expansion ID index N S Y
do we have comms with
N
heartbeat bool true/false the expansion board N S Y
type N Y
array[numinput],
in object Input Group array - - Y Y
… as per inX - - Y Y
Config for Input X
inX object where X = 1..numinput - - Y Y
unsigned 8-bit
Y
id number 1..numinput Input ID index N S Y
surround name with " ", e.g.
Y
name string 32 bytes, UTF-8 Input name set active in1 "Input 1" S S Y
Input mode: mic, line,
paging, stereo, MP, pink
Y
noise, white noise, test Attenuation only applies to
mode char m, l, p, s, 3, n, w, t, a tone, attenuation analog expansion (-6dB) S S Y
disable bool true/false Input disable flag S S N N
invert bool true/false Invert enable flag S S N N
mute bool true/false Mute enable flag S S N N
gnd bool true/false Ground Lift enable flag S S N N
PTT switch enable flag
N
ptt bool true/false (mode = p) S S N
 Phantom power enable
N
phantom bool true/false flag (mode = m) S S N
Auto standby mode enable / disable input for Auto
N
autostandby bool true/false action flag Standby Mode S S Y
enable/disable 10db
Auto standby input attenuator for the auto N
autolevelatt bool true/false attenuation action flag standby signal detector S S N
Auto standby threshold
Y
autolevel signed 8-bit number minVol..maxVol (dB) level for inX S S Y
unsigned 16-bit
Y
freq number 1..20000 (Hz) Frequency (mode = t) Sine wave test tone frequency S S Y
gainana float (32-bit) number minVol..maxVol (dB) Analogue gain S S N Y
Digital gain used for Dante
N
gaindig float (32-bit) number minVol..maxVol (dB) Digital gain modules S S Y
For mode = s, value type will
be array of left & right Y
vol float (32-bit) number minVol..maxVol (dB) Volume channels S S N
Increase volume by For mode = s, value will be
specified value (update applied to both left & right Y
up float (32-bit) number > 0.0 (dB) only) channels S N N
Decrease volume by For mode = s, value will be
specified value (update applied to both left & right Y
down float (32-bit) number > 0.0 (dB) only) channels S N N
Input Status
Y
status object information - - Y
For mode = s, value type will
be array of left & right Y
leveli signed 8-bit number -128..127 (dB) Level in meter status channels N S Y
For mode = s, value type will
be array of left & right Y
levelo signed 8-bit number -128..127 (dB) Level out meter status channels N S N
For mode = s, value type will
be array of left & right N
clipi bool true/false Clip in status channels N S N
For mode = s, value type will
be array of left & right N
clipo bool true/false Clip out status channels N S N
PTT switch status (mode
N
ptt bool true/false = p) N S N
array[numfilterin],
filter object Filter array - - N N
… as per filterX - - N N
Filter X where X =
filterX object 1..numfilterin - - N N
unsigned 8-bit
N
id number 1..numfilter Filter ID index N S N
enable bool true/false Enable flag S S N N
Filter type: hi-pass, all-
pass, lo-pass, hi-shelf, N
type string hp, lp, ap, hs, ls, eq, no lo-shelf, eq (bell), notch Two byte string S S N
 unsigned 16-bit
N
freq number 1..22000 (Hz) Cut-off frequency S S N
gain float (32-bit) number minGain..maxGain (dB) Gain (cut / boost) For type = hp, lp, ap, hs, ls, eq S S N N
q float (32-bit) number 0.00..20.00 Quality parameter For type = ap, eq S S N N
Filter family:
butterworth, bessel, N
family char b, s, l linkwitz–riley For type = hp, lp S S N
unsigned 8-bit Slope of filter in 6dB
N
slope number 6..48 (dB) steps For type = hp, lp S S N
agc object Auto Gain Control block - - N N
enable bool true/false Enable flag S S N N
Theshold activation
N
threshold float (32-bit) number minVol..maxVol (dB) level S S N
ratio float (32-bit) number 1.0..∞ Gain Ratio (X:1) S S N N
target float (32-bit) number minVol..maxVol (dB) Target level S S N N
unsigned 16-bit
N
attack number 1..5000 (ms) Attack time S S N
unsigned 16-bit
N
release number 1..5000 (ms) Release Time S S N
status object Status information - - N N
For mode = s, value type will
be array of left & right N
leveli signed 8-bit number -128..127 (dB) Level in meter status channels N S N
For mode = s, value type will
be array of left & right N
levelo signed 8-bit number -128..127 (dB) Level out meter status channels N S N
Gain reduction meter
N
gr signed 8-bit number -128..127 (dB) status N S N
above bool true/false Signal above threshold S S N N
compressor object Compressor block May be used as Limiter - - N N
enable bool true/false Enable flag S S N N
Theshold activation
N
threshold float (32-bit) number minVol..maxVol (dB) level S S N
Make-up compensation
gain level (post N
makeup float (32-bit) number minGain..maxGain (dB) compressor) S S N
Compressor generally < 20:1.
N
ratio float (32-bit) number 1.0..∞ Compression Ratio (X:1) Limiter generally ∞:1 S S N
unsigned 8-bit Knee width (in steps of Limiter has hard knee (0dB
N
knee number 0..48 (dB) 6dB) witdh) S S N
unsigned 16-bit
N
attack number 1..maxTime (ms) Attack time Limiter has zero attack time S S N
unsigned 16-bit
N
hold number 0..maxTime (ms) Hold Time S S N
unsigned 16-bit
N
release number 1..maxTime (ms) Release Time S S N
status object Status information - - N N
For mode = s, value type will
be array of left & right N
leveli signed 8-bit number -128..127 (dB) Level in meter status channels N S N
 For mode = s, value type will
be array of left & right N
levelo signed 8-bit number -128..127 (dB) Level out meter status channels N S N
Gain Reduction meter
N
gr signed 8-bit number -128..127 (dB) status N S N
For mode = s, value type will
Level above threshold be array of left & right N
above bool true/false status flag channels N S N
limiter object Limiter block - - N N
enable bool true/false Enable flag S S N N
Theshold activation
N
threshold float (32-bit) number minVol..maxVol (dB) level S S N
gain float (32-bit) number minGain..maxGain (dB) Gain Reduction S S N N
unsigned 16-bit
N
hold number 0..maxTime (ms) Hold time S S N
unsigned 16-bit
N
release number 1..maxTime (ms) Release time S S N
status object Status information - - N N
For mode = s, value type will
be array of left & right N
leveli signed 8-bit number -128..127 (dB) Level in meter status channels N S N
For mode = s, value type will
be array of left & right N
levelo signed 8-bit number -128..127 (dB) Level out meter status channels N S N
Gain reduction meter
N
gr signed 8-bit number -128..127 (dB) status N S N
For mode = s, value type will
Level above threshold be array of left & right N
above bool true/false status flag channels S S N
noisegate object Noise Gate block - - N N
enable bool true/false Enable flag S S N N
Theshold activation
N
threshold float (32-bit) number minVol..maxVol (dB) level S S N
Range / Depth
N
range float (32-bit) number minGain..maxGain (dB) attenuation level S S N
unsigned 16-bit
N
attack number 1..maxTime (ms) Attack time S S N
unsigned 16-bit
N
hold number 0..maxTime (ms) Hold time S S N
unsigned 16-bit
N
release number 1..maxTime (ms) Release time S S N
status object Status information - - N N
For mode = s, value type will
Level above threshold be array of left & right N
above bool true/false status flag channels N S N
Media Player Control
N
mpctrl object array (mode = 3) - - N
play bool true/false Play track S S N N
pause bool true/false Pause playback S S N N
stop bool true/false Stop playback S S N N
 fwd bool true/false Scroll forward in track S S N N
back bool true/false Scroll back in track S S N N
next bool true/false Skip to next track S S N N
prev bool true/false Skip to previous track S S N N
Mixer Group array for
array[numinput], Output X where X =
mixoutXin object 1..numoutput - - Y Y
… as per mixoutXinY - - Y Y
Mixer config for Output
X Input Y where X =
mixoutXinY object - - Y
1..numoutput, Y =
1..numinput Y
unsigned 8-bit
Y
idout number 1..numoutput Output ID index N S Y
unsigned 8-bit
Y
idin number 1..numinput Input ID index N S Y
Input source selection for
Output (single Input selection, Y
source bool true Source select no mixing) S S N
invert bool true/false Invert enable flag S S N Y
mute bool true/false Mute enable flag S S N Y
For mode = s, value type will
be array of left & right N
vol float (32-bit) number minVol..maxVol (dB) Volume channels S S Y
For mode = s, value will be
Increase volume by applied to both left & right N
up float (32-bit) number > 0.0 (dB) specified value channels S N Y
For mode = s, value will be
Decrease volume by applied to both left & right N
down float (32-bit) number > 0.0 (dB) specified value channels S N Y
Input Status
N
status object information - - Y
For mode = s, value type will
be array of left & right N
leveli signed 8-bit number -128..127 (dB) Level in meter status channels N S N
For mode = s, value type will
be array of left & right N
levelo signed 8-bit number -128..127 (dB) Level out meter status channels N S Y
For mode = s, value type will
be array of left & right N
clipi bool true/false Clip in status channels N S N
For mode = s, value type will
be array of left & right N
clipo bool true/false Clip out status channels N S N
PTT switch status (mode duplicate of input-inX-status-
N
ptt bool true/false = p) ptt N S N
priority object Priority block - - N N
enable bool true/false Enable flag S S N N
threshold signed 8-bit number minVol..maxVol (dB) Acivation threshold S S N N
 unsigned 8-bit Priority Level (Low,
N
level number 1..4 Med, High, Highest) S S N
unsigned 8-bit
N
release number 0s..maxTime Release time (seconds) S S N
Background Music
Source block (mode =
bgmsrc object m, l, s) - - N N
Only one mic/line/stereo input
can be selected as the BGM N
enable bool true/false Enable flag source S S N
mute bool true/false Mute signal flag S S N N
For mode = s, value type will
be array of left & right N
vol float (32-bit) number minVol..maxVol (dB) Volume channels S S N
status object Status information - - N N
For mode = s, value type will
be array of left & right N
levelo signed 8-bit number -128..127 (dB) Level out meter status channels N S N
For mode = s, value type will
be array of left & right N
clipo bool true/false Clip out status channels N S N
pagecontrol object Paging Control block - - N N
enable bool true/false Enable flag S S N N
Theshold activation applicable when mixer-
N
threshold float (32-bit) number minVol..maxVol (dB) level outXinY-enable-ptt is false S S N
unsigned 8-bit
N
attack number 1..maxTime (ms) Attack time S S N
unsigned 16-bit
N
hold number 0..maxTime (ms) Hold time S S N
unsigned 16-bit
N
release number 1..maxTime (ms) Release time S S N
chimeen bool true/false Chime enable flag S S N N
chimevol float (32-bit) number minVol..maxVol (dB) Chime volume S S N N
Paging Action block
pageaction (mode = m, l, s) - - N N
enable bool true/false Enable flag S S N N
depth float (32-bit) number minVol..maxVol (dB) Duck depth S S N N
array[numoutput],
out object Output Group array - - Y Y
… as per outX - - Y Y
Config for Output X
where X =
outX object 1..numoutput - - Y Y
unsigned 8-bit
Y
id number 1..numoutput Output ID index N S Y
surround name with " ", e.g.
Y
name string 32 bytes, UTF-8 Output name set active out1 "Output 1" S S Y
Output mode: mono,
N
mode char m, s stereo S S N
 unsigned 8-bit Output type: 4Ω, 70V,
Y
type number 4, 70, 100 100V S S Y
disable bool true/false Output disable flag S S N N
invert bool true/false Invert enable flag S S Y Y
mute bool true/false Mute enable flag S S Y Y
External Mute Control Enable/disable external mute
Y
extmute bool true/false enable flag control for this output S S N
gainana float (32-bit) number minVol..maxVol (dB) Analogue gain S S N N
gaindig float (32-bit) number minVol..maxVol (dB) Digital gain S S N Y
For mode = s, value type will
be array of left & right
vol float (32-bit) number minVol..maxVol (dB) Volume channels S S Y Y
For mode = s, value will be
Increase volume by applied to both left & right Y
up float (32-bit) number > 0.0 (dB) specified value channels S N Y
For mode = s, value will be
Decrease volume by applied to both left & right Y
down float (32-bit) number > 0.0 (dB) specified value channels S N Y
Input Status
Y
status object information - - Y
For mode = s, value type will
be array of left & right N
leveli signed 8-bit number -128..127 (dB) Level in meter status channels N S Y
For mode = s, value type will
be array of left & right Y
levelo signed 8-bit number -128..127 (dB) Level out meter status channels N S Y
For mode = s, value type will
be array of left & right N
clipi bool true/false Clip in status channels N S N
For mode = s, value type will
be array of left & right N
clipo bool true/false Clip out status channels N S N
array[numfilterout],
filter object Filter array - - N Y
… as per filterX - - N Y
Filter X where X =
filterX object 1..numfilterout - - Y Y
… as per filterX - - Y Y
agc object Auto Gain Control block - - N N
… as per agc - - N N
compressor object Compressor block - - Y Y
… as per compressor - - Y Y
limiter object Limiter block - - N N
… as per limiter - - N N
noisegate object Noise Gate block - - N N
… as per noisegate - - N N
delay object Delay block S S N Y
enable bool true/false Enable flag S S N Y
 For mode = s, value type will
unsigned 16-bit be array of left & right N
time number 0..5000 (ms) Delay time channels S S Y
array[numtone],
tone object Tone Generator array - - N N
… as per toneX - - N N
Predefined
Tone Generator X evac/alert/intruder/bell/chime
toneX object where X = 1..numtone tones - - N N
unsigned 8-bit
N
id number 1..numtone Tone ID index N S N
name string 32 bytes, UTF-8 Tone name S S N N
enable bool true/false Enable flag S S N N
unsigned 8-bit Tone priority
N
priority number 1..255 (1=highest) S S N
vol float (32-bit) number minVol..maxVol (dB) Volume S S N N
Amplifier Status
Y
amp object Information - - Y
unsigned 8-bit
N
temp number 0..255 (°C) Temperature N S N
status object Status information - - Y Y
Thermal warm level
Y
tempwarm bool true/false warning N S Y
Thermal hot level
Y
temphot bool true/false warning N S Y
standby bool true/false Standby status N S Y Y
Overtemperature
Y
overtemp bool true/false Shutdown status N S Y
Overload Shutdown
Y
overload bool true/false status N S Y
fault bool true/false Startup fault status N S Y Y
reset bool true/false Reset status N S Y Y
mute bool true/false Mute status N S Y Y
NB: this is an array, not an
Y
astatus array[], bool Status information object - - Y
… as per status - - Y Y
Preset Audio Processing
Section where X = Y
presetX object 1..numpreset - - Y
array[numinput], Preset Input Group
in object array - - Y Y
… as per active inX - - Y Y
Preset Config for Input
Y
inX object X - - Y
… as per active inX - - Y Y
array[numinput], Preset Mixer Group
Y
mixoutXin object array for Output X - - Y
as per active
Y
… mixoutXinY - - Y
 Preset Mixer config for
mixoutXinY object - - Y
Output X Input Y Y
as per active
Y
… mixoutXinY - - Y
array[numoutput], Preset Output Group
Y
out object array - - Y
… as per active outX - - Y Y
Preset Config for
Y
outX object Output X - - Y
… as per active outX - - Y Y
Preset Audio Processing
Section where X = Y
copy object 1..numpreset - - Y
Preset Input Group
outX object array - - Y Y
all - - N Y
unsigned 8-bit
N
to number 1-9 Y
compressor compressor block - - N Y
copies all the
compressor settings to
N
unsigned 8-bit this output from the
to number 1-9 selected output - - Y
delay delay block - - N Y
copies all the delay
settings to this output
N
unsigned 8-bit from the selected
to number 1-4 output - - Y
you are copying a
variable amount of
filters from one output
to another. The values E.g.
used to replace the "?" "dest=3","start=2","count=5" N
must be numbers that and outX=1: In this situation
are within the valid you would be copying 5 filters,
range for the amp/dsp starting at filter 2 from output
filter array[3],string "dest=?","start=?","count=?" being controlled 1 to output 3 - - Y
copies all the filter
settings to this output
N
array[3]:unsigned 8- from the selected
bit number destination,start_filter,qty output - - Y
mix mixer block - - N Y
copies all the mixer
settings to this output
N
unsigned 8-bit from the selected
to number 1-9 output - - Y
type - - N Y
unsigned 8-bit Output type: 4Ω, 70V,
N
number 4, 70, 100 100V Y
 Preset Input Group
presetX object array - - N Y
copies the settings to
unsigned 8-bit this preset from the N
to number 1-10 selected preset - - Y