Instruction manual

FS-8707-11 Convia XML Manual Page 15 of 16
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]
Appendix A.2. Reading Device Data File
This file contains a list of devices and their current status.
There are currently two commands that can be used to read this file.
GetFieldServerXML
GetZoneDeviceListXML
Appendix A.2.1. Using GetFieldServerXML
This command returns all the data for the FieldServer in one read. No parameters need to be defined.
The format to be used to read the file is as follows:
/cgi-bin/tscontrol?Command=GetFieldServerXML&
Appendix A.2.2. Using GetZoneDeviceListXML
This command is used to receive the relevant information for devices in a selected zone based on USERID.
The format to be used to read the file is as follows:
/cgi-bin/tscontrol?Command=GetZoneDeviceListXML&ZoneNum=<CURRENTZONEID>&UserID=<USERID>&
Where:
<CURRENTZONEID>
Is the ID number of the Zone containing the required data. If 0 is inserted, the gateway
will go to the root zone for the user based on the USERID.
<USERID>
Is the user ID number and determines which zones this user has access to.
Appendix A.3. Interpreting Read Data
Appendix A.3.1. Typical results from Read:
<devices>
<device name="Remote" room="/Top Level/Remote" type="Remote" icon="default.gif" idnumber="219"
onstatusname="On" offstatusname="Off" brightstatusname="Bright" dimstatusname="Dim" volume="0"
coolsetpoint="80" heatsetpoint="0" currenttemp="0" hvacmode="HEAT" hvacfan="0" hvachold="0"
indexnumber="1"/>
</devices>