ClearOne StreamNet Integration - Manual (Page 21)

Chapter 3: ASCII Overview 15
#REPORT mESSAGES
The primary mechanism for a StreamNet service to convey its current state and status is by sending #REPORT
ASCII messages. #REPORT messages may be sent in response to a #qUERy command or they may be
sent unsolicited.
A #REPORT sent in response to a #qUERy will be routed as an ordinary ASCII message. However, an
unsolicited #REPORT will not be routed as an ASCII command.
The “FromAddress” of the #REPORT message will indicate which service sent the #REPORT. Usually, the
FromAddress will have the subnode address, “~STATUS” attached to it.
The payload of a #REPORT message is XML-like, populated with label/value pairs of the form,
.
#@ToAddress:FromAddress~STATUS#REPORT {{LAbEL2=”VALUE” LAbEL3=”VALUE”/>}}
The reportType field should not be used for any purpose. Only the FromAddress and the label/value pairs are
significant. The label/value pairs may be in any order. A particular #REPORT may omit some label/value pairs
or new label/value pairs may be added at any time. Any unrecognized label/value pairs should be ignored.
Some special characters in the #REPORT message will be “escaped”, using HTML style escape sequences.
For example, the VALUE field cannot contain a quotation mark, so every quotation mark that is part of the
VALUE field will be replaced with " or "
Example:
or
(See Character Escape Sequences section for more information).
Label/value pairs will differ from device type to device type or service type to service type (See the documentation
for each device/service for specific label/value pairs supported.
#qUERy/#REPORT messages
Upon receiving a #qUERy message, a StreamNet service will send a #REPORT message with the requested
information. The solicited #REPORT message will addressed to the “FromAddress” of #qUERy message.
The the response may be split into multiple #REPORT messages. No message may exceed the 1000 char-
acter limit.
---------------------------------------------------------------------------------------
#qUERy/#REPORT Example
The “Touchpanel” service sends:
#@Kitchen Player:Touchpanel#qUERy current_source
The “Kitchen Player” service responds with:
#@Touchpanel:Kitchen Player#REPORT {{currentSourceIP=”10.15.96.149” permId=”mLA10105151001161008019_1” />}}
---------------------------------------------------------------------------------------