Download
Share
Print this page
SCT xml1000 User Manual
  1. Manuals
  2. Brands
  3. SCT Manuals
  4. Server
  5. xml1000
  6. User manual

SCT xml1000 User Manual

Serial i/o server
Hide thumbs

Advertisement

Quick Links

Download this manual
SimpleComTools, LLC
XML1000 – User Manual
User Manual
&
Command Reference Guide
xml1000
Serial I/O Server
March 2006
SimpleComTools, LLC
1

Advertisement

loading
Need help?

Need help?

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

Questions and answers

Summary of Contents for SCT xml1000

  • Page 1 SimpleComTools, LLC XML1000 – User Manual User Manual & Command Reference Guide xml1000 Serial I/O Server March 2006 SimpleComTools, LLC...
  • Page 2 Users must take full responsibility for their applications of any products specified in this document. The information in this document is proprietary to SimpleComTools, LLC. Trademarks SimpleComTools, the SimpleComTools logo, COM1000, XML1000, and the COM1000 and XML1000 logos are trademarks of Simple Com Tools, LLC. Statement of conditions In the interest of improving internal design, operational function, and/or reliability, SimpleComTools, LLC reserves the right to make changes to the products described in this document without notice.

  • Page 3: Table Of Contents

    BASICS OF XML ............COMMUNICATING WITH THE XML1000 ........

  • Page 4: Introduction

    The XML1000 I/O Server is another member of the Simple Com Tools M2M appliance family. Designed to serve as both a partner to the COM1000 and a stand-alone device, the XML1000 is also an important device servicing the M2M market. Simplistic in both its design and feature set, the XML1000 serves a virtually un- addressed niche in the M2M market –...
  • Page 5 SimpleComTools, LLC XML1000 – User Manual Interfaces The XML1000 provides the following hardware interfaces: • (8) Digital Inputs • (8) Analog Inputs • (2) Relay Outputs • (2) Analog Outputs • (1) RS232 DB9 Serial Port DIGITAL INPUT SIDE ANALOG INPUT SIDE...
  • Page 6 XML1000 – User Manual Connecting Sensors, Switches, or Devices The following describes how to wire sensors, switches or controls to the XML1000 inputs. The RELAY is designed to switch currents (120VAC/2A, 24VDC/5A). In a sense, the RELAY can act as a contact closure or switch for any external device.
  • Page 7 SimpleComTools, LLC XML1000 – User Manual Hardware Dimensions The XML1000 I/O Server is approximately 4.5” x 4.5” x 1” in size. Exact dimensions are as follows: Serial Side View Terminal Side View Top View SimpleComTools, LLC...
  • Page 8 (2) Outputs OI/4-20 2A at 120 VAC Inputs at 4-20 mA at 0-5 VDC 5A at 24 VDC Determining Device Type The XML1000 provides labeling on the bottom of the device that indicates the device specifications and type. SimpleComTools, LLC...

  • Page 9: Getting Started

    Before you begin This guide is intended for qualified service personnel who are installing the XML1000 for the first time or who need to install a switch, gauge, modem, or other device to an existing XML1000. However, before you install anything related to the XML1000, make sure that the proper cables have been selected and/or the required network cabling has been installed using standard cable system practices.

  • Page 10: Basics Of Operation

    Hayes-style AT Commands. Integration with SCADA applications Since the XMl1000 I/O server presents I/O data in an open format, it is easily integrated into existing SCADA, telemetry, or meter reading applications. Applications configured to read I/O from the XML1000 can post the data to a local or remote database, or expose the data points to industrial automation and SCADA client applications using automation industry standard protocols, such as OPC and DDE.

  • Page 11: Basics Of Xml

    SimpleComTools, LLC XML1000 – User Manual Basics of XML Basics of XML XML (Extensible Markup Language) is a simple, flexible text format similar to HTML. Originally designed to meet the challenges of electronic publishing and electronic data exchange requirements, XML is now also playing an increasingly important role in the exchange of a wide variety of data on the Web, including Telemetry, SCADA, and M2M applications.
  • Page 12 SimpleComTools, LLC XML1000 – User Manual Reading an XML Document At its base level, all information displays as readable text, interspersed with markup tags that indicate the information's logical separation into a hierarchy. That hierarchy has container-like elements, followed by the relevant data.
  • Page 13 (eXtensible Stylesheet Languages) to format the data. Several web-browsers including Internet Explorer, Firefox, and Mozilla support transformation of XML to HTML. Therefore if you are using a browser to view the data from an XML1000, you would want to use the optional XML declaration. Elements The remainder of the XML document consists of nested elements, some of which have other nested elements and/or content.
  • Page 14 XML, as well as the requirements of the schema (in this case, the correct values required to interrogate and configure the XML1000). It is therefore possible that documents could be well-formed but not valid. Conversely, documents could conform to the correct schema, but may not be formatted properly (well-formed).

  • Page 15: Communicating With The Xml1000

    Connection Examples Ethernet Network Connection To connect an XML1000 to an Ethernet LAN, simply use a Serial Device Server such as the Digi One SP or the Lantronix UDS-10. COM1000 connected to a serial device server Wireless Network Connection (802.11)
  • Page 16 XML1000 – User Manual Wireless Network Connection (Cellular) To connect an XML1000 to an Ethernet LAN, simply use a Serial Device Server such as the Digi One SP or the Lantronix UDS-10. COM1000 connected to a serial cellular data modem...
  • Page 17 XML1000 – User Manual Querying the Entire Device Configuration As shown above, sending either <XML1000></XML1000> or <XML1000/> will query the root element. The device will respond with all its element values, including general configuration values and live data values. Querying Specific Values To query a specific value, the command will have to include the root element followed by the sub element start and ending tags.
  • Page 18 </XML1000> Error Messages As mentioned earlier, when an invalid message is sent to the XML1000, the device will return an <ERROR> element, along with the child element describing the type of effort and the offending data if present. The following described the (5) types of errors: <BADFORMAT>...
  • Page 19 SimpleComTools, LLC XML1000 – User Manual DESCRIPTION DATA TYPE PARENT XML1000 Root element None Parent for CFG elements XML1000 Unique Device ID string Firmware Version string Include UID in data responses and RBX integer Include XML declaration in output integer...
  • Page 20 SimpleComTools, LLC XML1000 – User Manual XML1000 Example Output ‘Document’ <?xml version="1.0" encoding="UTF-8"?> <XML1000> <ID>TEST1</ID> <CFG> <UID>TEST1</UI <VER>XML1000 1.3.002.A</VER> <EID>1</EID> <XSL>1</XSL> <RBX>1</RBX> <RBXTMR>1</RBXTMR> <RBXCNT>0</RBXCNT> <AUNITS>0</AUNITS> </CFG> <DIN> <D1>1</D1> <D2>1</D2> <D3>1</D3> <D4>1</D4> <D5>1</D5> <D6>1</D6> <D7>1</D7> <D8>1</D8> </DIN> <DCNT> <C1>000000001</C1> <C2>000000001</C2> <C3>000000001</C3>...
  • Page 21 • <AIN><A1>data</A1></AIN> <A4>0.0</A4> <A5>0.0</A5> <A6>0.0</A6> <A7>0.0</A7> • Analog output STATUS <A8>0.7</A8> • <AOUT><AO1>data</AO1></AOUT> </AIN> <AOUT> <AO1>5.0</AO1> <AO2>3.5</AO2> • Relay output STATUS </AOUT> • <RELAY><R1>data</R1></RELAY> <RELAY> <R1>0</R1> <R2>0</R2> • ‘</XML1000>’ is the closing tag for the ‘document’ </RELAY> </XML1000> SimpleComTools, LLC...

  • Page 22: Using The Configuration Utility

    Configuration Utility Connection Steps Step 1: Connect your PC to the XML1000 RS232 interface using a standard RS232 cable and null adapter or a null RS232 cable. The XML1000 interface is a DTE port, so a standard serial cable alone will not work.
  • Page 23 Take note of the ‘Sent’ section. When you select Get All Parameters, you will see what is being sent to the device. In this case, the application sends <XML1000/> - which is XML short notation for the command <XML1000></XMl1000> SimpleComTools, LLC...
  • Page 24 SimpleComTools, LLC XML1000 – User Manual Take note of the values Take note of the values Take note of the located on the status tab. located on the tab. ‘Received’ section. This tab displays COM These values will be This will show you the...
  • Page 25 Received window. Saving the settings as a template The XML1000 configuration utility has a TEMPLATE function. This feature is designed to provide the ability to save a device configuration for future use or application to another device. Here...

  • Page 26: Using 'At' Commands

    XML1000 – User Manual Using ‘AT’ Commands As mentioned earlier, the XML1000 AT Commands are a format similar to traditional Hayes-Compatible AT Commands, but because the device is not a modem, the similarities are modest. In order to configure the...
  • Page 27 SimpleComTools, LLC XML1000 – User Manual Configuration Using AT Commands The XML1000 Serial I/O Server supports two communications protocols: XML and AT Commands. The following is a list of the AT Commands listed by category: Basic Device Configuration Parameters AT Command Description Description: Returns state of all device registers.
  • Page 28 = Up to 32 alphanumeric characters. Description: Current Firmware Version. Query AT*VER Returns current XML1000 firmware version. Description: XSL Header setting. Enables/disables the XML header for facilitating the presentation of XML data in an XML tree format when using a browser.
  • Page 29 SimpleComTools, LLC XML1000 – User Manual Analog Inputs AT Command Description Description: Analog Input Status. Query AT*An Query the state of any Analog Input. Options: n = (1 – 8) Response value is contingent upon the status of the AUNITS register.
  • Page 30 SimpleComTools, LLC XML1000 – User Manual Description: Analog Input Minimum Setpoint. The LOW setpoint for exception reporting. Query AT*AnMNSP Query the MINIMUM (LOW) SETPOINT of the analog input. Response value will be in either VOLTAGE or DECIMAL format, whichever one is selected in the AUNITS register.
  • Page 31 SimpleComTools, LLC XML1000 – User Manual Description: Analog Input Maximum Setpoint. The HIGH setpoint for exception reporting. Query AT*AnMXSP Query the MINIMUM (LOW) SETPOINT of the analog input. Response value will be in either VOLTAGE or DECIMAL format, whichever one is selected in the AUNITS register.
  • Page 32 SimpleComTools, LLC XML1000 – User Manual Digital Inputs (Counts) AT Command Description Description: Digital Input Counts. Response value will be a 9 digit value between 0 and 999999999. Query AT*Cn Query the accumulated COUNT value of a Digital Input. Options: n = (1 –...
  • Page 33 SimpleComTools, LLC XML1000 – User Manual Analog Outputs AT Command Description Description: Analog Output value. Query AT*A0n Query the state of an Analog Output. Options: n = (1 or 2) Response value is contingent upon the status of the AUNITS register.