SMC Networks FieldServer Driver Manual

FieldServer

FS-8704-15 XML over HTTP Driver

Driver Manual

(Supplement to the FieldServer Instruction Manual)

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after October 2017.

Driver Revision: 1.15

Document Revision: 2.E

XML over HTTP Driver Manual

Contact Information

Technical Support

Please call us for any technical support needs related to the FieldServer product.

Sierra Monitor Corporation
1991 Tarob Court
Milpitas, CA 95035

Website: www.sierramonitor.com

U.S. Support Information:

[phone]
[phone]

Email: [e-mail]

EMEA Support Information:

[phone]

Email: [e-mail]

XML over HTTP Driver Manual

Table of Contents

TABLE OF CONTENTS

HTTP XML Driver Description ............................................................................................................. 4

Driver Scope of Supply ....................................................................................................................... 4

2.1 Supplied by Sierra Monitor for this Driver ....................................................................................... 4

Hardware Connections ........................................................................................................................ 5

Data Array Parameters ........................................................................................................................ 6

Configuring the FieldServer as a HTTP XML Driver Client .............................................................. 7

5.1 Client Side Connection Parameters ............................................................................................... 7

5.2 Client Side Node Parameters ......................................................................................................... 8

5.3 Client Side Map Descriptor Parameters ......................................................................................... 9

5.3.1 FieldServer Specific Map Descriptor Parameters ................................................................... 9

5.3.2 Driver Related Map Descriptor Parameters ............................................................................ 9

5.3.3 Timing Parameters ................................................................................................................ 10

5.3.4 Special Keywords for URL and Write_Command ................................................................. 10

5.4 Map Descriptor Examples ............................................................................................................ 10

Configuring the FieldServer as a HTTP XML Driver Server .......................................................... 11

6.1 Server Side Connection Parameters ............................................................................................ 11

6.2 Server Side Node Parameters ...................................................................................................... 11

6.3 Server Side Map Descriptor Parameters ...................................................................................... 11

6.4 Server Side Requests and Responses Supported ....................................................................... 12

Appendix A. XML Server Schema ........................................................................................................... 13

Appendix B. Status Parameter BITS Table ............................................................................................. 14

Appendix C. Setting the Format of the Data Array Age ........................................................................ 15

Appendix D. Use of SSl/TLS for Secture Connection ........................................................................... 16

Appendix D.1. Configuring FieldServer as a SSL/TLS Server ................................................................ 16

Appendix D.1.1. Simple Secure Server Configuration......................................................................... 16

Appendix D.1.2. Limiting Client Access ............................................................................................... 17

Appendix D.1.3. To Upload the Authority File to the FieldServer ........................................................ 17

Appendix D.1.4. Certificate Validation Options .................................................................................... 18

Appendix D.1.5. Certificate Validation Options .................................................................................... 18

Appendix D.2. Configuring FieldServer as SSL/TLS Client .................................................................... 19

Appendix D.2.1. Simple Secure Client Configuration .......................................................................... 19

Appendix D.2.1. Limit Server Access .................................................................................................. 19

Appendix D.2.2. Certificate Validation Options .................................................................................... 19

Appendix D.2.3. Set up Client Certificate ............................................................................................ 19

XML over HTTP Driver Manual

Page 4 of 19

HTTP XML DRIVER DESCRIPTION

The Ethernet HTTP XML Driver allows the FieldServer to transfer data to and from a device over Ethernet
using the HTTP/XML Driver protocol. The FieldServer can emulate either a server or client.

The XML Driver is built on HTTP web technology (Port 80) and uses pages formatted in XML syntax to
respond to HTTP requests or allows XML responses to be decoded and stored. Both a client and a server
are supported.

The Server Side is an XML formatted response of the internal Data Array structure contained within the
FieldServer, requested from a remote client device to the FieldServer URL.

The Client Side uses a HTTP GET request to a specified URL to request XML data. The driver has the
ability to decode the XML response and store different Elements uniquely identified by some attribute
within the element. The data of the matching Element is stored in the FieldServer Data Arrays the
matching Element is stored in the FieldServer Data Arrays.

FieldServer Mode

Comments

Server

This mode is always enabled within the XML driver, and is requested by “http://<ip

address>/data_arrays.xml” where <ip address> corresponds to the FieldServer IP

Address.

Client

Supports multiple client connections to different URLs, with associated decoding
map descriptors linked to an active GET URL request.

Max Nodes Supported

FieldServer Mode

Nodes

Comments

Client

32

The Driver can establish a connection to several different IP
Addresses.

Server

0

The Server Side is always enabled and defined on the
connection; hence the driver does not allow any server node
selection.

DRIVER SCOPE OF SUPPLY

2.1 Supplied by Sierra Monitor for this Driver

PART #

Description

FS-8915-10

UTP cable (7 foot) for Ethernet connection

XML over HTTP Driver Manual

Page 5 of 19

HARDWARE CONNECTIONS

The FieldServer is connected to the network as shown in connection drawing.

FieldServer

FieldServer Part #

8915-10

UTP cable

Connect to an Ethernet Port

on the FieldServer

N1

19

Switch/Router

WAN / LAN

Network

The Ethernet connection can be achieved using a switch or crossover cable. The driver will support all
Ethernet connections on a local area network (LAN) or wide area network (WAN) including internet
connections and crossover cable connections.

XML over HTTP Driver Manual

Page 6 of 19

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

Legal Values

Data_Array_Name

Provide name for Data Array.

Up to 15 alphanumeric
characters.

Data_Array_Format

Provide data format. Each Data Array can only take on
one format.

Float, Bit, Uint16,
Sint16, Uint32, Sint32,
Byte

Data_Array_Length

Number of Data Objects. Must be larger than the data
storage area required by the Map Descriptors for the
data being placed in this array.

1-10, 000

Example

// Data Arrays

Data_Arrays

Data_Array_Name

, Data_Array_Format

, Data_Array_Length

DA_AI_01

, Float

, 200

DA_AO_01

, Float

, 200

DA_DI_01

, Bit

, 200

DA_DO_01

, Bit

, 200