Instruction manual

ManualsBrandsConvia ManualsHome building and DecorType 3

Driver Version:

1.01

Document Revision:

A Sierra Monitor Company

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after March 2010

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8707-11 Convia XML

Summary of content (16 pages)

PAGE 1
A Sierra Monitor Company Driver Manual (Supplement to the FieldServer Instruction Manual) FS-8707-11 Convia XML APPLICABILITY & EFFECTIVITY Effective for all systems manufactured after March 2010 Driver Version: Document Revision: 1.
PAGE 2
FS-8707-11 Convia XML Manual Table of Contents TABLE OF CONTENTS 1 Convia XML Description ................................................................................................................................. 3 2 Driver Scope of Supply ................................................................................................................................... 3 2.1 Supplied by FieldServer Technologies for this driver .....................................................................
PAGE 3
FS-8707-11 Convia XML Manual 1 Page 3 of 16 CONVIA XML DESCRIPTION The Convia driver uses XML syntax to communicate with the Convia Global Gateway device. As a Client the Convia driver reads specified data points from the Convia gateway and stores the data in the FieldServer Data Arrays. The Client driver achieves this by using XML element and attribute syntax.
PAGE 4
FS-8707-11 Convia XML Manual 3 Page 4 of 16 HARDWARE CONNECTIONS The FieldServer is connected to the Convia Global Gateway as shown in connection drawing. Configure the Convia Global Gateway according to manufacturer’s instructions Convia Global Gateway Hub/Router FieldServer Part # 8915-10 UTP cable Connect to an Ethernet Port on the FieldServer 8 1 FieldServer N1 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldserver.
PAGE 5
FS-8707-11 Convia XML Manual 4 Page 5 of 16 DATA ARRAY PARAMETERS Data Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It is necessary to declare the data format of each of the Data Arrays to facilitate correct storage of the relevant data. Section Title Data_Arrays Column Title Function Data_Array_Name Provide name for Data Array Data_Array_Format Data_Array_Length Provide data format. Each Data Array can only take on one format.
PAGE 6
FS-8707-11 Convia XML Manual 5 Page 6 of 16 CONFIGURING THE FIELDSERVER AS A CONVIA XML CLIENT For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer (See “.csv” sample files provided with the FieldServer).
PAGE 7
FS-8707-11 Convia XML Manual Page 7 of 16 Example // Client Side Nodes Nodes Node_Name Gateway_1 5.3 , Node_ID, ,1 , Protocol , XML_Convia , Connection , N1 Client Side Map Descriptors 5.3.
PAGE 8
FS-8707-11 Convia XML Manual 5.4 Page 8 of 16 Map Descriptor Example. At least one Client Side Map Descriptor needs to be defined to select the actual XML page containing Attributes and Elements relating to the XML data on the Remote Gateway device. Multiple Map Descriptors can be configured to fetch different XML pages.
PAGE 9
FS-8707-11 Convia XML Manual 6 Page 9 of 16 CONFIGURING THE FIELDSERVER AS A CONVIA XML SERVER For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer (See “.csv” sample files provided with the FieldServer).
PAGE 10
FS-8707-11 Convia XML Manual 6.4 Page 10 of 16 FieldServer XML Schema The FieldServer XML schema is arranged as a tree structure consisting of a Root Element, multiple Child Elements which define the Data_Arrays in the FieldServer , and one Sub-Child element per Child Element which define the Data in the Data Arrays as well as the attributes of the data (e.g. validity). Attributes are used to specify the parameters of the Elements in the tree. Note that the Element Name is ALWAYS in lowercase.
PAGE 11
FS-8707-11 Convia XML Manual Page 11 of 16 6.4.2 Child Elements Element Name Function Data_Array Defines the Data Arrays present in the FieldServer. Attributes NAME Function Name of Data Array FORMAT Data Format of the Data Array LENGTH Number of data items in this Data Array Identifies the maximum number of Data_Arrays on the FieldServer. Identifies the Data Array number. The first Data Array will be and Index of 1. The last Data Array will have an index of Max_Index.
PAGE 12
FS-8707-11 Convia XML Manual 6.5 Page 12 of 16 Using HTTP-GET to Read FieldServer Data The HTTP-GET command is used to request data XML data from the FieldServer. The filename specified must be data_arrays.xml. Multiple sets of parameters can be specified using the ? separator character. The Name, offset and length parameters are optional. data_arrays.xml?NAME=data_array_name:length.
PAGE 13
FS-8707-11 Convia XML Manual 6.6 Page 13 of 16 Using HTTP-POST to Write Data to the FieldServer The HTTP-POST command is used to write XML data to the FieldServer Data Arrays. The format of the HTTP comand is described below. NAME=data_array_name&OFFSET=offset&VALUE=value Parameter Data_Array_Name* Offset* Value Description Specify the name of the Data Array Starting location in Data Array Specify the Value to write Legal Values One of the Data Array names from Data Array section.
PAGE 14
FS-8707-11 Convia XML Manual Page 14 of 16 Appendix A. REFERENCE Appendix A.1. Sending Commands to the Gateway Appendix A.1.1. Sending Device Commands The format for sending commands to control devices in the gateway is as follows: /cgi-bin/tscontrol?Command=Control&What=&Value=&dataitem=& Where: Is the command to send to control a device. A list of available controls is provided in Is the value to send with some commands.
PAGE 15
FS-8707-11 Convia XML Manual Page 15 of 16 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.
PAGE 16
FS-8707-11 Convia XML Manual Appendix A.3.2. Attributes Attribute name room type icon idnumber onstatusname offstatusname brightstatusname dimstatusname volume coolsetpoint heatsetpoint currenttemp hvacmode hvacfan hvachold indexnumber Appendix A.3.3. Device Class Dimmable Switch Status HVAC HVACSingle Camera Remote Audio Scene4 Event Unknown Appendix A.3.4. Mode HEAT: COOL: AUTO: OFF: Page 16 of 16 Description The name that is used to describe the device.