Chapter 3: ascii overview, Ascii message syntax, Ddress – ClearOne StreamNet Integration User Manual
Page 15: Toaddress, Node
Chapter 3: ASCII Overview
9
Chapter 3: ASCII Overview
The basic mechanism for control and status reporting of the services in StreamNet is the ASCII protocol.
This protocol consists of various command messages and their parameters represented by strings of ASCII
characters. Messages also have associated routing and administrative information which informs recipients of
the destination and origin of the messages or provides other supplemental information.
ASCII mESSAGE SyNTAX
ASCII messages have the following syntax:
#@toAddress:fromAddress%modifier%modifier#keyword arg1, arg2, ... argN /0
A # symbol is required at the beginning of all messages.
•
ASCII messages must not exceed 1000 characters in length.
•
The various fields must be in the order shown above.
•
The fields after the first # are the administrative fields, addresses and other control functions. The
•
fields after the second # are the actual command.
@toAddress
Specifies the name of the Service, Group, or Room to which the message is sent. The @ symbol precedes all
toAddress fields. The address field may consist of two parts: the Node Address and the Subnode Address.
The Node Address specifies the Service, Group, or Room the message is addressed to. The Subnode Address
can be used to address a subordinate module within the destination service or to invoke other special routing
functions. The Subnode Address follows the Node Address and is separated by a tilde (~).
Example: @nodeAddress~subnodeAddress
NOTE
f
: When no service address is provided, the address defaults to the Root Service of that
device.
The device reacts only if the command is a valid Root Service command.
Messages without a toAddress will be ignored if they are sent multicast or broadcast.
Node
A Node Address is the main part of an ASCII command address and can be part of the TO or FROM address.
A node address is either a Service Name, a Service Unique ID (UID), a Room Name or a Group Name.