Instruction manual

FS-8707-11 Convia XML Manual Table of Contents
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.com
Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]
TABLE OF CONTENTS
1 Convia XML Description ................................................................................................................................. 3
2 Driver Scope of Supply ................................................................................................................................... 3
2.1 Supplied by FieldServer Technologies for this driver ..................................................................................... 3
2.2 Provided by the Supplier of 3
rd
Party Equipment .......................................................................................... 3
2.2.1 Required 3
rd
Party Hardware ................................................................................................................. 3
3 Hardware Connections ................................................................................................................................... 4
4 Data Array Parameters ................................................................................................................................... 5
5 Configuring the FieldServer as a Convia XML Client ........................................................................................ 6
5.1 Client Side Connection Descriptors ............................................................................................................... 6
5.2 Client Side Node Descriptors ......................................................................................................................... 6
5.3 Client Side Map Descriptors........................................................................................................................... 7
5.3.1 FieldServer Related Map Descriptor Parameters ................................................................................... 7
5.3.2 Driver Related Map Descriptor Parameters ........................................................................................... 7
5.3.3 Timing Parameters ................................................................................................................................. 7
5.4 Map Descriptor Example. .............................................................................................................................. 8
6 Configuring the FieldServer as a Convia XML Server ....................................................................................... 9
6.1 Server Side Connection Descriptors .............................................................................................................. 9
6.2 Server Side Node Descriptors ........................................................................................................................ 9
6.3 Server Side Map Descriptors.......................................................................................................................... 9
6.4 FieldServer XML Schema.............................................................................................................................. 10
6.4.1 Root Element........................................................................................................................................ 10
6.4.2 Child Elements ...................................................................................................................................... 11
6.4.3 Sub-Child Elements .............................................................................................................................. 11
6.5 Using HTTP-GET to Read FieldServer Data................................................................................................... 12
6.6 Using HTTP-POST to Write Data to the FieldServer ..................................................................................... 13
Appendix A. Reference ........................................................................................................................................ 14
Appendix A.1. Sending Commands to the Gateway ................................................................................................ 14
Appendix A.1.1. Sending Device Commands .................................................................................................... 14
Appendix A.1.2. Control Commands ................................................................................................................. 14
Appendix A.2. Reading Device Data File .................................................................................................................. 15
Appendix A.2.1. Using GetFieldServerXML ....................................................................................................... 15
Appendix A.2.2. Using GetZoneDeviceListXML ................................................................................................. 15
Appendix A.3. Interpreting Read Data ..................................................................................................................... 15
Appendix A.3.1. Typical results from Read: ...................................................................................................... 15
Appendix A.3.2. Attributes ............................................................................................................................... 16
Appendix A.3.3. Device Class ............................................................................................................................ 16
Appendix A.3.4. HVAC Modes .......................................................................................................................... 16