SMC Networks FieldServer Driver Manual

Fs-8704-15 xml over http driver

Advertisement

Quick Links

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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the FieldServer and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for SMC Networks FieldServer

  • Page 1 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...
  • Page 2 XML over HTTP Driver Manual 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: +1 408 262-6611 +1 800 727-4377 Email: support@sierramonitor.com...
  • Page 3: Table Of Contents

    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.
  • Page 4: Http Xml Driver Description

    XML over HTTP Driver Manual 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.
  • Page 5: Hardware Connections

    XML over HTTP Driver Manual HARDWARE CONNECTIONS The FieldServer is connected to the network as shown in connection drawing. WAN / LAN Network Switch/Router FieldServer Part # 8915-10 UTP cable Connect to an Ethernet Port on the FieldServer FieldServer 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.
  • Page 6: Data Array Parameters

    XML over HTTP Driver Manual 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.
  • Page 7: Configuring The Fieldserver As A Http Xml Driver Client

    XML server running over a web server on port 80. The configuration file tells the FieldServer about its target XML data, and the decoding of data required. In order to enable the FieldServer as an XML client, the driver independent FieldServer buffers need to be declared in the “Data Arrays”...
  • Page 8: Client Side Node Parameters

    IP_Address to use. Any valid host name. Otherwise the configured IP_Address will be used. The FieldServer will try to resolve the host name again before starting the node recovery process to get latest IP_Address. If the host name can't be resolved, the last known IP_address is used.
  • Page 9: Client Side Map Descriptor Parameters

    XML over HTTP Driver Manual Client Side Map Descriptor Parameters 5.3.1 FieldServer Specific Map Descriptor Parameters Column Title Function Legal Values Map_Descriptor_Name Name of this Map Descriptor. Up to 32 alphanumeric characters. Name of Data Array where data is to...
  • Page 10: 5.3.3 Timing Parameters

    , Scan_Interval CMD_WR_UINT16a , WRBC , DA_UINT16_WR , FS_WEB_01 , 10 , 2s , Method , XML-URL , Write_Command , POST , post.cgi , "DA_UINT16.0=<DA_UINT16_WR.0>&DA_UINT16.1=<DA_UINT16_WR.1>" URL and payload of a regular POST command generated by the FieldServer. Page 10 of 19...
  • Page 11: Configuring The Fieldserver As A Http Xml Driver Server

    XML over HTTP Driver Manual CONFIGURING THE FIELDSERVER AS A HTTP XML DRIVER SERVER For detailed information on FieldServer configuration, 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”...
  • Page 12: Server Side Requests And Responses Supported

    XML over HTTP Driver Manual Server Side Requests and Responses Supported Request: http://192.168.1.5/data_arrays.xml Response: <DATA_ARRAYS FST_XML_VERSION="1.00" MAX_INDEX="5" BRIDGE_TITLE="Lonworks Server"> <DATA_ARRAY NAME="DA_Group" FORMAT="Byte" LENGTH="99" INDEX="1"> <DATA OFFSET="0" DATA_AGE="3:00:39:36.736s" STATUS="0">0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0</DATA>...
  • Page 13: Appendix A. Xml Server Schema

    XML over HTTP Driver Manual APPENDIX A. XML SERVER SCHEMA Below is the XML schema used for server responses to the data_Arrays.xml request. <xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="DATA_ARRYS"> <xs:attribute name="FST_XML_VERSION" type="xs:string" /> <xs:attribute name="MAX_INDEX" type="xs:string" /> <xs:attribute name="BRIDGE_TITLE" type="xs:string" /> <xs:complexType>...
  • Page 14: Appendix B. Status Parameter Bits Table

    XML over HTTP Driver Manual APPENDIX B. STATUS PARAMETER BITS TABLE Data Status Hex Value Description Data considered invalid due to one or multiple reasons. DATA_BAD 0x0002 For example: a bad sensor, out of range analog input, trouble, reliability, etc. DATA_VALID 0x0010 Data valid...
  • Page 15: Appendix C. Setting The Format Of The Data Array Age

    'D:HH:MM:SS.SSS' accordingly. The Disp_Time_Format defines if the time format follows H:MM:SS.SSS or D:HH:MM:SS.SSS. Section Title Bridge Parameter Function Legal Values Title Allows user to specify the title of the FieldServer. Title Text HH:MM:SS.SSS, Disp_Time_Format Time format of the data array age. D:HH:MM:SS.SSS Example //================================================================================...
  • Page 16: Appendix D. Use Of Ssl/Tls For Secture Connection

    , TLS_Port , Modbus/TCP , 1502 This configuration sets the FieldServer to accept any incoming connection but will not request a client’s certificate for verification. This means that the FieldServer end point communication will be encrypted but not authenticated. The FieldServer will send an embedded self-signed certificate if one is requested by a connecting client.
  • Page 17: Appendix D.1.2. Limiting Client Access

    By default, this means the FieldServer will only accept connections from other FieldServers. In order to load an authority file so that the FieldServer will accept connections from a chosen list of remote clients, configure the FieldServer with the following connection settings:...
  • Page 18: Appendix D.1.4. Certificate Validation Options

    , Yes , my_authorized_clients.pem , SMC The configuration above tells the FieldServer to only accept connections that have the correct certification and is coming from the specified host. The Check_Remote_Host value is synonymously known as common name, host name or domain etc.
  • Page 19: Appendix D.2. Configuring Fieldserver As Ssl/Tls Client

    The authority file is a collection of server certificates in PEM format. This file can be edited using any text file editor (such as notepad). When the file has all required certificates, paste it into the PEM formatted server certificate. Now the FieldServer will connect to a server if it can find the server’s certificate in the authority file.

Table of Contents