Please read the Control section first for information on how to connect to the A2Z-Link and how to format commands.
For more advanced control systems and
control systems drivers, you may want to dynamically retrieve the
available devices in the system and get their current status. The
following commands can be used to discover all devices, get their
current status, and assigned name and location. The A2Z-Link allows for 2
location parameters to be set on each device, as well as a device name.
This information can be maintained in the A2Z-Link itself, or left off
and maintained by the controller.
Command
Format
Description
Example
Get device status.
gs,[ref]
Returns a comma list of devices. If the ref parameter is
omitted, all devices are returned seperated with a "|", else just information for the
requested ref number. Format of return is:
ref,parent_ref,status,name,location2,location1
Where:
ref = unique reference # of this device, will match request if a specific ref is entered in the request.
parent_ref = unique reference # of parent of this device.
Some devices, such as thermostats, comprise many devices. One device
will be assigned as the parent and is used to note which physical device
this device belongs to. If the device does not have a parent, which
means it is either the root device, or it is a device that has no
children, the value be 0.
name = the name of the device
location2 = location 2 assigned to this device
location1 = location 1 assigned to this device
Note: If the name, location1, or location2 contains a "," it will be escaped and returned as "\,".
Request the status of a light switch with ref 3755, the return might be:
3755,0,off,Lights,First Floor,Kitchen
Notification of updates
If a device changes status, a notification is sent over the open port. The format is:
DC,REF,NEWVAL,OLDVAL
For example, the device with reference # 576 changes from 0 to 1: