Generating status reports – ClearOne Writing StreamNet User Manual

Page 27

7-1

Main +1 512.977-9393 / fax +1 512.977.9398 / Toll Free Technical Support +1 866-353-3496

3600 W. Parmer Lane, Suite 100; Austin, TX 78727 /

www.netstreams.com.

Chapter

Generating Status Reports

In almost all cases, the generation of the status reports used by the User Interface is
automated. A status report takes the form of a #report ASCII command:

#report {{field=value…}}

To update the generated status report is to update the responsible status object with the
appropriate field/value pairs. The status report is then generated and transmitted.

As examples, if the base device needs to generate status reports with a time stamp
field, include the code:

setStatus(“timeStamp”, os.uptime())

Care is automatically taken to insure that excessive status reports are not generated,
rather they are specifically only generated as the status itself is modified.

As another example, if a subNode needs to report a status containing a temperature
field, include the code:

zone:setStatus(“temperature”,

zone.currentTemperature)

NOTE:

When a subNode is modifying its status variables it should use the “:” notation
to insure that the zone is passed to the setStatus routine.