XML1000 – User Manual
Contents
1. Ralay The DIGITAL INPUT interfaces are designed to connect to up to either dry contact closures or voltage pulses The interface provides two 6 wire inputs 4 switch inputs and 2 grounds GND Switches are connected across any of the inputs labeled with numbers 1 8 The grounds labeled with GND are used digital commons and are where you connect the second switch wire The reasons 4 GND 2 3 GNO 4 for only 4 commons is because you can share the GND inputs between EN switches the switches The following is a wiring example Other Switches Switch TU The ANALOG INPUT interface has the ability to interface with any analog sensor with the following voltage output ranges 0 5 VDC 0 30 VDC 4 20mA The following is a sensor wiring example analog 1 2 3 GND 4 ANALOG is External Power Source if applicable External Analog Sensor Sensor Output The ANALOG OUTPUT interface is designed to provide a variable voltage output of 0 5VDC ANALOG RIU PLC 0 5 GND uu SimpleComTools LLC 6 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 lt SES BS E E43 E34 iy J L E SimpleComTools LLC 7 SimpleComTools LLC XML1000 User Manual Options Th2. lt D1 gt 1 lt D1 gt lt D2 gt 1 lt D2 gt lt D3 gt 1 lt D3 gt lt D4 gt 1 lt D4 gt lt D5 gt 1 lt D5 gt lt D6 gt 1 lt D6 gt lt D7 gt 1 lt D7 gt lt D8 gt 1 lt D8 gt lt DIN gt lt DCNT gt lt C1 gt 000000001 lt C1 gt lt C2 gt 000000001 lt C2 gt lt C3 gt 000000001 lt C3 gt lt C4 gt 000000001 lt C4 gt lt C5 gt 000000001 lt C5 gt lt C6 gt 000000001 lt C6 gt lt C7 gt 000000001 lt C7 gt lt C8 gt 00000000 lt DCNT gt lt AIN gt lt A1 gt 0 0 lt A1 gt lt A2 gt 0 0 lt A2 gt lt A3 gt 0 0 lt A3 gt lt A4 gt 0 0 lt A4 gt lt A5 gt 0 0 lt A5 gt lt A6 gt 0 0 lt A6 gt lt A7 gt 0 0 lt A7 gt lt A8 gt 0 7 lt A8 gt lt AIN gt lt AOUT gt lt 1 gt 5 0 lt 1 gt lt 2 gt 3 5 lt 2 gt lt AOUT gt lt RELAY gt lt R1 gt 0 lt R1 gt lt R2 gt 0 lt R2 gt lt RELAY gt lt XML1000 gt SimpleComTools LLC 20 SimpleComTools LLC XML1000 User Manual XML1000 Example Output Document lt xml version 1 0 encoding UTF 8 gt lt XML1000 gt lt UID gt TEST1 lt UID gt lt CFG gt lt UID gt TEST1 lt UI E 5 d VER XML1000 1 3 002 A VER ach lower data element IS Wrapped in container XML 1000 is the ROOT top hierarchal element Main container for all other elements amp data Equivalent to the MAIN C drive of your PC lt EID gt 1 lt EID gt Equivalent to a folder or sub directory
3. lt XML1000 gt lt AIN gt Query for Analog Input Values lt A1 gt 0 0 lt A1 gt lt A2 gt 0 0 lt A2 gt lt A3 gt 0 0 lt A3 gt lt A4 gt 0 0 lt A4 gt lt A5 gt 0 0 lt A5 gt lt A6 gt 0 0 lt A6 gt lt A7 gt 0 0 lt A7 gt lt A8 gt 0 7 lt A8 gt lt AIN gt lt XML1000 gt lt XML1000 gt lt AIN gt lt AIN gt lt XML1000 gt or lt XML1000 gt lt AIN gt lt XML1000 gt Query for Relay Status lt xml version 1 0 encoding UTF 8 gt lt XML1000 gt lt RELAY gt lt R1 gt 0 lt R1 gt lt R2 gt 0 lt R2 gt lt RELAY gt lt XML1000 gt lt XML1000 gt lt RELAY gt lt RELAY gt lt XML1000 gt or lt XML1000 gt lt RELAY gt lt XML1000 gt Error Messages As mentioned earlier when an invalid message is sent to the XML1000 the device will return an lt ERROR gt 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 lt BADFORMAT gt This will usually happen if the 5 second inter character timeout happens and there is garbage in buffer lt READONLY gt This occurs when attempting to WRITE data to a READ ONLY element lt DATATYPE gt This occurs when attempting to WRITE an invalid value to any element Ex writing ABC to analog output lt OUTOFRANGE gt This occurs when attempting to WRITE an unsupported value to any element Ex writing a 2 to relay output lt SYNTAX gt Gene
4. lt VER gt ML1000 1 3 002 A EID EID 51 gt 1 lt lt 51 gt lt RBX gt 1 lt RBX gt RBXTMR 1 RBXTMR RBXCNT O RBXCNT AUNITS 0 AUNITS CFG DIN lt D1 gt 1 lt D1 gt D2 1 D2 lt D3 gt 1 lt D3 gt lt D4 gt 1 lt D4 gt lt D5 gt 1 lt D5 gt lt D6 gt 1 lt DB gt v 3 10 2006 12 08 56 PM ww SimpleComT ools com Take note of the Received section This will show you the exact XML data returned from the device Sent M s sct Received 3 11 2006 12 19 04 www SimpleComT aols com SimpleComTools LLC XML1000 User Manual Reading and making changes to the device Reading any individual value is done by using the Get Enable ID Disabled Get set button Changes can be made by using either the drop down menu or entering the desired value in the text box Enable XSL Enabled Get Bel and hitting the Set button Report by Exception Enabled Cet All changes are immediately written to the device Reporting Interval Timer 1 et There is need to save any set changes Reporting Ret Court Get Set Clearing existing values ZEE its Volts v Get Set In the case of numeric values clearing is simply done by SSIES Mi i i entering a zero In the case of text values clicking on the Alk CLA E Set button with empty text field will clear
5. Conformity is declared by the application of EN 55 022 Class B CISPR 22 Canada requirements only Canadian Department of Communications Radio Interference Regulations This digital apparatus does not exceed the Class B limits for radio noise emissions from digital apparatus as set out in the Radio Interference Regulations of the Canadian Department of Communications Reglement sur le brouillage radio lectrique du ministere des Communications Cet appareil num rique respecte les limites de bruits radio lectriques visant les appareils num riques de classe B prescrites dans le R glement sur le brouillage radio lectrique du minist re des Communications du Canada SimpleComTools LLC 2 SimpleComTools LLC XML1000 User Manual Table of contents Page INTRODUCTION eins iae P ees nanos TCU 4 GETTING STARTED s ot oed ee PU 9 BASICS OF OPERATION eU Rb ET 10 BASICS OF XME n ie e eot once Ded pm were dpi e 11 COMMUNICATING WITH THE 1000 15 USING THE CONFIGURATION UTILITY 22 USING AT COMMANDS ER eR eR LR DER OPES 26 SimpleComTools LLC 3 SimpleComTools LLC XML1000 User Manual 1 Introduction Preface The XML1000 I O Server is another member of the Simple Com Tools M2M appliance family Designed to s
6. lt XML1000 gt lt CFG gt Query for General Config Values lt UID gt TEST1 lt UID gt lt VER gt XML1000 1 3 002 A lt VER gt lt EID gt 0 lt EID gt lt XSL gt 1 lt XSL gt lt RBX gt 1 lt RBX gt lt RBXTMR gt 1 lt RBXTMR gt lt RBXCNT gt 0 lt RBXCNT gt lt AUNITS gt 0 lt AUNITS gt lt CFG gt lt XML1000 gt lt XML1000 gt lt CFG gt lt CFG gt lt XML1000 gt or lt XML1000 gt lt CFG gt lt XML1000 gt lt xml version 1 0 encoding UTF 8 gt lt XML1000 gt Query for Digital Input Values ae lt D2 gt 1 lt D2 gt lt D3 gt 1 lt D3 gt lt D4 gt 1 lt D4 gt lt D5 gt 1 lt D5 gt lt D6 gt 1 lt D6 gt lt 07 gt 1 lt 07 gt lt D8 gt 1 lt D8 gt lt DIN gt lt XML1000 gt lt XML1000 gt lt DIN gt lt DIN gt lt XML1000 gt Or lt XML1000 gt lt DIN gt lt XML1000 gt lt xml version 1 0 encoding UTF 8 gt lt XML1000 gt Query for Digital Input Counts ss gt 000000000 lt 1 gt lt 2 gt 000000000 lt 2 gt lt C3 gt 000000000 lt C3 gt lt C4 gt 000000000 lt C4 gt lt C5 gt 000000000 lt C5 gt lt 6 gt 000000000 lt 6 gt lt C7 gt 000000000 lt C7 gt lt C8 gt 000000000 lt C8 gt lt DCNT gt lt XML1000 gt lt XML1000 gt lt DCNT gt lt DCNT gt lt XML1000 gt or lt XML1000 gt lt DCNT gt lt XML1000 gt SimpleComTools LLC 17 SimpleComTools LLC XML1000 User Manual lt xml version 1 0 encoding UTF 8 gt
7. 1 Analog Outputs RS232 DB9 Serial Port DIGITAL INPUT SIDE Relay 2 Relay 1 Digital Inputs 5 8 Digital Inputs 1 4 Wad eat Yd rad EER SES AT ash ES m Analog Inputs 1 4 Analog Inputs 5 8 Analog Outputs Pwr YT Ys Relay Analog Outputs Outputs relay digital analog HO COM NC ES E 1 2 3 GND 4 This interface is This interface is This interface is This interface is used to This interface is used to used to connect a P sS CODICI SIBI RAI used to provide used to connect to device that you want 9 variable 0 5vdc a 9 30 VDC closure switches measurement gauges to turn on and off analog output power source SimpleComTools LLC 5 SimpleComTools LLC 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 The relay connections are labeled as Normally Open NO Common COM and Normally Closed NC When wiring connect your wires to the NO relay and COM if you want the switched circuit to be CLOSED when the relay is ACTIVATED Connect your wires to NC and COM if you want the switched Pid circuit to be OPEN when the relay is ACTIVATED RFI RTU PLC Lamp HD GON NG
8. 1023 when AUNITS 1 Configuration AT AnMNSP y Command to set the MAXIMUM HIGH SETPOINT for the analog input New value must be in the same format selected in the AUNITS register Options n 1 8 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 4 00 20 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS71 y y y Description Digital Input TYPE Adjusts the value of the input between Normally Open and Normally Closed Query AT Tn Query the state of a Digital Input Options n 1 8 Configuration AT Tn y Options 1 8 0 or 1 0 Normally Open 1 Normally Closed n y y y Description Current state of the Digital Input Response value will indicate the state of the switch displayed as a 0 or 1 Query AT Dn Query the state of a Digital Input Options n 1 8 31 SimpleComTools LLC XML1000 User Manual Digital Inputs Counts 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 8 Configuration Reset Command to reset the COUNT value of a Digital Input Option is given to set the counter to any value between 0 and 999999999 Options n 1 8 y 0 999999999 Sets the counter any desired value Relay Outputs Descri
9. PM wvm SimpleComT com Clink on Get All Parameters to read device XML1000 Test Tool 1 6 File Edit Options Help Connection Type Disconnect Status Port Opened General Digital Inputs Analog Inputs Relay Dutput Analog Output Sent lt 1000 it ID Get Unit ID Ge Parameters Version Get s Scl Device Configuration Received Enable ID Enable XSL Take note of the Sent section Report by Exception When you select Get Reporting Interval Timer Parameters you Will see what 15 Reporting Retry Count being sent to the device In this case the application sends lt XML1000 gt which is XML short notation for the command lt XML1000 gt lt XMI1000 gt Analog Units All COM Settings 115200 n 8 1 Bytes Sent 1D Received 0 Selected Bytes 3 10 2006 12 08 23 www SimpleComT ools com SimpleComTools LLC 23 SimpleComTools LLC XML1000 User Manual XML1000 Test Tool 1 6 File Edit Options Help Connection Type Disconnect Status Port Opened General Digital Inputs Analog Inputs Relay Dutput Analog Output it ID Unit ID ITESTT e Get Al Parameters Version ML1000 1 3 002 4 Get Device Configuration Enable ID Disabled Get Set Enable XSL Enabled Get se Report by Exception Enabled Get Set Reporting Interva
10. lt D6 gt lt 07 gt 1 lt 07 gt lt D8 gt 1 lt D8 gt lt DIN gt lt AOUT gt lt 1 gt 5 0 lt 1 gt lt 2 gt 3 5 lt 2 gt lt gt lt RELAY gt lt R1 gt 0 lt R1 gt lt R2 gt 0 lt R2 gt lt RELAY gt lt XML1000 gt SimpleComTools LLC 12 SimpleComTools LLC XML1000 User Manual XML Syntax Overview Data being returned from the XML100 is in a structured format called a document Each XML document has both a logical and a physical structure Physically the document is composed of units called entities An entity may be stored or dynamic data or may refer to other entities to cause their inclusion in the document Documents are composed of declarations elements comments character references and processing instructions all of which are indicated in the document by explicit markup tags In order to understand a document and discern the relevant data being provided you will need to have a detailed description of each component of the document and instructions on how to use it This is called a syntax description XML Declaration The first line in an XML document is the XML declaration Example lt xml version 1 0 encoding UTF 8 gt This is an optional line stating what version of XML is in use normally version 1 0 and may also contain information about character encoding and external dependencies It is not often necessary unless using XSL eXtensible Stylesheet Languages t
11. not overlap Each non root element must be completely contained in another element Document elements match required case sensitivity Example the tag lt Sample gt is not the same as lt SAMPLE gt The document complies to its character set definition c pe Iw Valid Documents Valid document have data that conforms to defined content rules or XML schema Below are some examples of those rules for valid documents 1 Elements must have the correct data type 2 Elements required to contain a numeric value may not contain text 3 Elements required to contain a text may only not contain a numeric as part of the string 4 Elements that are numeric must be displayed as the correct type integer or decimal SimpleComTools LLC 14 SimpleComTools LLC XML1000 User Manual communicating with the XML1000 The following section provides the basic tools needed to begin communicating with the XML1000 using XML Communicating to the XML1000 Serial I O Server Communicating with the XMI1000 Serial I O Server is done thru a DB9 male connector RS232 The port is configured as a DTE terminal port with a baud rate of 115200 8N1 No flow control is used as this is a 3 wire device TX RX and GND All flow control signals are Looped Back for your convenience Therefore in order to connect to the XML1000 from a PC you will need to use either a standard serial cable and a null adapter or a null serial cable P
12. to using XML Here are just a few of the benefits of using XML to manage data Simplicity Information coded in XML is easy to read and understand plus it can be processed easily by computers Extensibility There is no fixed set of tags New tags can be created as they are needed Open Standard XML has quite a few benefits when it comes to deployment in M2M applications First XML is a standard simple self describing way of presenting data That means the content can be processed with relatively little development effort and exchanged across diverse hardware operating systems and applications and can be used with a wide range of development tools and utilities Vendor Neutrality XML is vendor neutral which means by using XML in communications protocols and managing their data in XML formats companies can maximize the lifetime of their investment and enjoy flexibility in the choices they will be able to make in future products and solutions separation of the content from the presentation XML tags describe meaning of the data and not the presentation This allows the presentation of the data to be changed without touching the original data Making it easy to create innumerable variations of querying or presenting the same data Extensive Support There are a number of companies that have extensive support for XML including companies such as Software AG IBM Sun Microsoft Netscape DataChannel SAP and many others In additi
13. C Connects to the XML1000 Terminal Port using a NULL RS232 cable 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 Ethernet D Internet 2 gt Serial Device I 2 Server Wireless Network Connection 802 11 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 wireless serial device server Ethernet LAN Wireless Access Point Serial Device Server SimpleComTools LLC 15 SimpleComTools LLC 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 Serial Wireless Carrier Configuring and Querying the device When sending XML formatted commands to the XML 1000 it is important know some basic rules 1 Messages send to the device are XML documents When you format an XML based command to configure or query the XML 1000 all the rules that pertain to document presentation apply That means that commands must be both well formed and valid If a command does not meet those rules the XML 1000 will return a
14. EMENT 1 gt Test Data lt NESTEDELEMENT 12 lt NESTEDELEMENT2 gt Test Data lt NESTEDELEMENT2 gt lt PARENT 1 gt lt PARENT2 gt lt NESTEDELEMENT1 gt Test Data lt NESTEDELEMENT 1 gt lt PARENT2 gt lt DATA gt SimpleComTools LLC 13 SimpleComTools LLC XML1000 User Manual Document Correctness For an XML document to be correct it must be both well formed and valid That means that the document conforms both to the rules of 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 It is essential that both factors are present in order for XML to work properly Well Formed Documents A well formed document conforms to all of the W3C XML syntax rules For more info on well formed documents refer to the W3C website at http www w3 org XML Below are some examples of those rules for well formed documents 1 The document may have only one root element Non empty elements must have both opening and closing tags Empty elements may be marked with an empty element self closing tag such as lt EMPTY gt All attribute values are quoted either single 9 or double quotes Single quotes close a single quote and double quotes close a double quote Tags may be nested but must
15. SimpleComTools LLC XML1000 User Manual User Manual amp Command Reference Guide xmil000 Serial Server s sct March 2006 SimpleComTools LLC 1 SimpleComTools LLC XML1000 User Manual Copyright 2005 2006 SimpleComTools LLC All rights reserved January 2006 The information in this document is subject to change without notice The statements configurations technical data and recommendations in this document are believed to be accurate and reliable but are presented without express or implied warranty 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 XML 1000 and the COM1000 and XML 1000 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 SimpleComTools LLC does not assume any liability that may occur due to the use or application of the product s or circuit layout s described herein USA requirements only Federal Communications Commission FCC Compliance Notice Radio Frequency Notice This device complies with Part 15 of the FCC Rules Operation is subject to the following two conditions
16. You should OK as the response To view ALL the current register settings enter AT amp V XML1000 HyperTerminal Fie Edit Call Transfer Help Du 8 at lt KML1000 gt UID RBCDEFGHIJKLMNOPQRSTUVWAVZ012345 UID lt VER gt XML1000 Betal 2 002 VER EID 0 EID lt KSL gt O lt XSL gt lt RBK gt lt RBK gt lt RBKTMR gt 1 lt RBRTMR gt lt RBKCNT gt lt DTYPE gt lt DTYPE gt lt AUNITS gt lt AUNITS gt lt D1 gt 1 lt D1 gt lt D2 gt 1 lt D2 gt lt D3 gt 1 lt D3 gt lt D4 gt 1 lt D4 gt lt D5 gt 1 lt D5 gt lt D6 gt 1 lt D6 gt lt D8 gt 1 lt D8 gt lt DIN gt lt DCNT gt C1 000000000 C1 C2 000000000 C2 C3 000000000 C3 C4 000000000 C4 C5 000000000 C5 Disconnected Auto detect 115200 8 N 1 Step 4 Once you have successfully gained access to the command prompt you can view or edit any of the XML1000 application registers The following pages detail the available commands SimpleComTools LLC 26 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 Description Returns state of all device registers Query 2 AT amp V Returns entire device configuration showing all registers Description Ana
17. access hole of the insert plug and tighten the retaining screw Next insert the ground wire into the right side access hole of the terminal strip and tighten the second retaining screw Plug the terminal strip plug into the XML1000 power interface Finally connect the other end of the wire or the power supply to your power source Do NOT insert live power leads directly into the Analog Digital and Relay inputs as this may severely damage the XML1000 Failure to comply with this warning will void any and all existing product warranties or service agreements The XML1000 is NOT water resistant waterproof or weatherproof Installation should include an enclosure to protect electronics a 7 Preferably a NMEA 4 type enclosure to ensure protection from a water and humidity 4 d SimpleComTools LLC XML1000 User Manual Basics of operation Overview The XML1000 is a compact XML based hardware serial I O server The term I O server is more commonly used with software based applications running on a PC or server They allow you to control or monitor PLCs or RTUs using various communication protocols such as DNP Modbus etc In contrast the XML1000 Serial server is a hardware appliance that monitors 20 points of I O locally allowing you to monitor and control the I O using XML as the communications protocol The physical interface is RS232 DB9 port which allows for a network agnostic commun
18. ation Applications XML Interface or Report Tools Client 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 XML provides a text based means to describe and apply a tree based structure to information Since XML is based on ASCII text an XML document may be viewed or created using any text based editor such as Notepad or even word processors such as Microsoft Word This one factor alone has facilitated the rapid expansion of XML as a document authoring and integration tool Prior to the advent of XML there were very few data description languages that were general purpose Internet protocol friendly and very easy to learn and author In fact most data interchange formats were proprietary special purpose binary formats based on bit sequences rather than characters This is a fact that remains true for most SCADA and telemetry devices and applications However as processing power and memory resources increase in the world of embedded hardware XML will likely emerge as a preferred way of presenting I O status and historical data Benefits
19. ay output STATUS lt AOUT gt e lt RELAY gt lt R1 gt data lt R1 gt lt RELAY gt lt RELAY gt lt R1 gt 0 lt R1 gt lt RELAY gt lt XML1000 gt is the closing tag for the document lt XML1000 gt SimpleComTools LLC 21 SimpleComTools LLC XML1000 User Manual using the xmhooao configuration utility The XML1000 Configuration Utility is provides a desktop style GUI to allow you to read and configure the XML1000 using simple select boxes and buttons The utility is also designed to present the end user or developer with the ability to see the actual XML code being sent to and received from the device in real time Configuration Utility Layout The utility is broken down into various sections and functional blocks The layout and explanation of the functions is as follows e CONNECTION Enables connection to the device over Com Port or TCP IP connection e GENERAL Displays and sets Unit ID value and displays current firmware version e DEVICE CONFIGURATION Displays and configures global display and reporting behaviors e DIGITAL INPUTS Displays Digital Input states e DIGITAL COUNTS Displays and sets Digital Input counts e ANALOG INPUTS Displays and sets Analog Input values e RELAY OUTPUTS Displays sets Relay Output states e ANALOG OUTPUTS Displays and sets Analog Output values e SENT Displays the XML code most recently sent to the device e RECEIVED Displays the XML code most recently rece
20. bles the XML header for XSL facilitating the presentation of XML data in an XML tree format when using a browser Query AT XSL Configuration AT XSL n Options Disabled Default 1 Enabled SimpleComTools LLC 28 SimpleComTools LLC XML1000 User Manual Analog Inputs 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 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 0 00 16 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS71 Description Analog Input Minimum LOWEST value attained since the last read request Query AT AnMN Query the LOWEST attained value for the analog input Response value will be in either VOLTAGE or DECIMAL format whichever one is selected in the AUNITS register Options n 1 8 Response value is contingent upon the status of the AUNITS register 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 0 00 20 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS 1 AnMN Configuration AT AnMN y Command to reset the LOWEST reached value for the analog input New value must be in the same format selected in the AUNITS register Options 1 8 0 00 5 00 for units
21. document with the ERROR element 2 Messages face parsing time limitations XML formatted commands are processed by the XML 1000 parser as a complete message Therefore typing an XML formatted message one character at a time will not work There is not way to type commands fast enough to send commands by hand 3 Support for short abbreviated notation XML formatted commands may be either normal or abbreviated notation For example when querying the device using the ROOT element you can send either XML 1000 XML 1000 Long Notation Or XML 1000 Abbreviated Notation XML1000 HyperTerminal SEE File Edit View Call Transfer Help lt KML1000 gt Sample of communicating with an XML1000 using HyperTerminal over TCP IP Sending the ROOT element to the device can be done using the Copy Paste command Connected 0 00 06 Auto detect TCP IP SimpleComTools LLC 16 SimpleComTools LLC XML1000 User Manual Querying the Entire Device Configuration As shown above sending either lt XML1000 gt lt XML1000 gt or lt XML1000 gt 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 Here are some examples lt xml version 1 0 encoding UTF 8 gt
22. e This device may not cause harmful interference e his device must accept any interference received including interference that may cause undesired operation Note This equipment has been tested and found to comply with the limits for a Class B digital device pursuant to Part 15 of the FCC Rules These limits are designed to provide reasonable protection against harmful interference in a residential installation This equipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instructions may cause harmful interference to radio communications However there is no guarantee that interference will not occur in a particular installation If this equipment does cause harmful interference to radio or television reception which can be determined by turning the equipment off and on the user is encouraged to try to correct the interference by one or more of the following measures e Reorient or relocate the receiving antenna e Increase the separation between the equipment and receiver e Connect the equipment into an outlet on a circuit different from that to which the receiver is connected e Consult the dealer or an experienced radio TV technician for help European requirements only EN 55 022 statement This is to certify that the SimpleComTools COM1000 is shielded against the generation of radio interference in accordance with the application of Council Directive 89 336 EEC Article 4a
23. e XML1000 provides the following hardware interfaces 8 Digital Inputs 8 Analog Inputs e 2 Relay Outputs 2 Analog Outputs The following describes the potential configuration options available for purchase EM Digital Inputs Relay Outputs Analog Inputs Analog Outputs 8 Contact Closure V or RERS 8 Inputs 2 Outputs Inputs zd ee at 0 5 VDC 12 at 24 VDC CC 0 30 8 Contact Closure 2 8 Inputs 2 Outputs Inputs at 24 VDC at 0 30 VDC at 0 5 VDC CC 4 20 8 Contact Closure 8 Inputs 2 Outputs Inputs at 24 VDC at 4 20 mA at 0 5 VDC Ol 0 5 8 Optically Isolated PT 8 Inputs 2 Outputs Inputs at 24 VDC at 0 5 VDC at 0 5 VDC O1 0 30 8 Optically Isolated 2 8 Inputs 2 Outputs Inputs at 24 VDC at 0 30 VDC at 0 5 VDC Ol 4 20 8 Optically Isolated 8 Inputs 2 Outputs Inputs at 24 VDC at 4 20 mA at 0 5 VDC Determining Device Type The XML1000 provides labeling on the bottom of the device that indicates the device specifications and type SimpleComTools LLC XML1000 XML I O Server 69 oct FCC This device complies with Part 15 of the FCC Rules Operation is subject to the following two conditions 1 this device may not cause harmful interference and 2 this device must accept any interference received including interference that may cause undesired operation Industry Canada This Class A digital apparatus complies with Canadian ICES 003 Cet ap
24. erve 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 the low cost standards based open source hardware appliance for capturing and reporting digital and analog I O events As its name implies the XML1000 serves the status and changes to its digital and analog interfaces via an XML format 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 The XML1000 comes with three different interface options RS232 RS485 and Ethernet This manual is dedicated to the RS232 version only Serial RS232 version of XML 1000 D1GNDD2D3GNDD4 D5 GNDD6D7GNDD8 NC C NO NC C NO digital in relay 1 relay2 mimm serial 1 0 server www simplecomtools com analog in analog in analog out pwr A1GNDA2A3GNDA4 A5 GNDA6A 7 GND A8 AO1GND AO2 GND SimpleComTools LLC 4 SimpleComTools LLC XML1000 User Manual Interfaces The XML1000 provides the following hardware interfaces e 8 Digital Inputs 8 Analog Inputs 2 Relay Outputs 2
25. ications transport Communicating to the XML100 can be done over serial links leased lines dialup or via TCP IP using IP to Ethernet device servers Architecture The XML1000 is architected to offer an alternative to the traditionally complex means of communicating with hardware I O It provides a plain ASCII text based XML interface for capturing and reporting digital and analog I O events To facilitate the integration of the XML1000 with applications or devices that do not have the ability to format or parse XML data the XMI1000 also supports a set of Hayes style AT Commands Integration with SCADA applications XML1000 Block Diagram Digital Analog Analog Relay Inputs Inputs Outputs Inputs Interface Layer XML AT Command Interface Layer Interface Layer Hardware Interface Layer RS232 Since the XMI1000 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 Device Server SimpleComTools LLC Leased line Dialup Devi Meter Ethernet xiu Reading Driver cae Application Application pi Cellular Service Providers Historical Industrial Autom
26. ived from the device Configuration Utility Connection Steps Step 1 Connect your PC to the XML1000 5232 interface using a standard RS232 cable and null adapter or a null RS232 cable XML1000 interface is a DTE port so a standard serial cable alone will not work Step 2 Launch the XML1000 Configuration Utility Select the correct COM Port on your PC from the Connection Type drop down menu and click on CONNECT You will be able to view the status of the connection in the Status window Step 3 Once you have successfully gained access to the device you can view or edit any of the XML 1000 application registers To view ALL the current register settings click on the Get All Parameters button SimpleComTools LLC 22 SimpleComTools LLC XML1000 User Manual Select your communications method XML100N Tart Tanl 1 6 Edit Options Help Connection Type w Connect tatus Port Closed COM3 COM6 Gener TCP IP ts Analog Inputs flay Output Analog Output _Get se Ves s Scl Device Configuration Received Enable ID set EnablexSL v set Report by Exception se Reporting Interval Timer 5 Reporting Retry Count Ge se Analog Units _ set All Se Settings 115200 n 8 1 Sent 0 BytesReceived 0 Selected BytezO 3 10 2006 12 07 54
27. l Timer DL tT Get Set Reporting Retry Count 0 Get Set Analog Units vots v Get Set All CLR Get Set COM Settings 115200 n 8 1 Bytes Sent 10 Bytes Received 0 Selected Bytes 0 Take note of the values located on the status tab This tab displays COM setting as well as the number of bytes sent and received XML1000 Test Tool 1 6 File Edit Options Help Beneral Digital Inputs Analog Inputs Relay Output Analog Output Unit IDs Selecting TCP IP will allow you to connect to the device over IP Device Configuration Enable ID set Enable SL _ Get 5 Report by Exception z _set Reporting Interval Timer 5 Reporting Retry Count ca _set Analog Units Ge set All 5 Enter the IP address and port into the appropriate boxes and select CONNECT COM Settings 115200 n 8 1 Bytes Sent 0 Bytes Received 0 SimpleComTools LLC 24 Take note of the values located on the tab These values will be populated when the values are returned from the device Connection Connect Status Idle IP Address Name 192 168 1200 Port 12345 Selected Bytes 0 SEN fi Sent lt 11000 s Sct Received lt xml versionz 1 0 encoding UTF 8 gt Send lt ML1000 gt lt CFG gt UID ABCDEFGHIJKLMNOPORSTUMwXYZ 12345 LID
28. log Input Units sets values to be either raw voltage or decimal Query AT AUNITS AUNITS Configuration AT AUNITS n Options Raw Voltage Value Default 1 Decimal Value 0 1023 Description Choose to include the UID in every report and response Query AT EID Configuration AT EID n Options Disabled Default 1 Enabled Description Report By Exception enables automatic reporting of changes in I O or passing analog set point thresholds Query AT RBX RBX Configuration AT RBX n Options 0 Disabled Default 1 Report only the specific INPUT value that has changed 2 Report the entire GROUP when any of the group changes 3 Report the entire DEVICE when any inputs has changed SimpleComTools LLC 2 SimpleComTools LLC XML1000 User Manual Description Report By Exception number of repeat RBX reports Query AT RBXNUM RBXNUM Configuration AT RBXNUM n Options n 0 Never Reports n 1 255 Description Report By Exception timer Time between RBX reports in MIN Query AT RBXTMR RBXTMR Configuration AT RBXTMR n Options n 0 255 Note Setting the value to 0 means RBX will never repeat Description Reads or sets the Unique Device ID UID Query AT UID Configuration AT UID xxxxx Options x Up to 32 alphanumeric characters Description Current Firmware Version VER Query AT VER Returns current XML1000 firmware version Description XSL Header setting Enables disa
29. o 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 An element typically consists of two tags surrounding other elements or data These tags are called the start and end tags or tag sets The start tag consists of a name surrounded by angle brackets such as sample tag gt The end tag consists of the same name surrounded by angle brackets but with a forward slash preceding the name such as lt sample tag gt The element s content is everything that appears between the start tag and the end tag including other child elements and actual data When there is another set of element tags inside a tag set the outer tag set is referred to as the parent tag The inner tag set that surrounds the data content are called child tags The following is a complete XML element with start tag text content and end tag lt ELEMENT 1 gt Test Data lt ELEMENT 1 gt The following samples show several XML elements with start tags nested elements and data lt START gt lt PARENT 1 gt NESTEDELEMENT1 Test Data lt NESTEDELEMENT 1 gt lt PARENT 1 gt lt START gt lt DATA gt lt 1 gt lt NESTEDEL
30. on both Microsoft s and Netscape s Web browsers support XML and Microsoft now uses XML as the data exchange format for Microsoft Office SimpleComTools LLC 11 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 In this respect browsing through an XML document is similar to looking at the outline of a textbook or browsing through a PC operating system such as MS Windows Book Outline Example 1 Chapter 1 a Section 1 i Data 1 ii Data 2 Data 3 b Section 2 i Data 1 ii Data 2 Data 5 Section 3 File Edit View Favorites Tools Help Back 4 Search z Address lia CHWINDOWS sysbem32driverstete Operating System Hierarchy Example C WINDOWS system32 drivers etc C WINDOWS Folders system32 2 Desktop drivers amp 1 My Documents etc 3 4 Computer i Gat Local Disk C E E WINDOWS XML1000 Example Output Document El system32 5 drivers lt xml version 1 0 encoding UTF 8 gt C disdn erc XML 1000 DIN lt D1 gt 1 lt D1 gt Familiar example of a data lt D2 gt 1 lt D2 gt presented in TREE format lt D3 gt 1 lt D3 gt lt D4 gt 1 lt D4 gt lt D5 gt 1 lt D5 gt lt D6 gt 1
31. on your PC lt XSL gt 1 lt XSL gt Data array is wrapped with a start and closing tag lt RBX gt 1 lt RBX gt lt RBXTMR gt 1 lt RBXTMR gt lt RBXCNT gt 0 lt RBXCNT gt lt AUNITS gt 0 lt AUNITS gt e General configuration values CFG lt CFG gt e Includes UID VER EID XSL RBX and more lt DIN gt lt D1 gt 1 lt D1 gt lt D2 gt 1 lt D2 gt lt D3 gt 1 lt D3 gt e Digital input STATUS data lt D4 gt 1 lt D4 gt lt DIN gt lt D1 gt data lt D1 gt lt DIN gt lt D5 gt 1 lt D5 gt lt D6 gt 1 lt D6 gt D7 1 D7 lt D8 gt 1 lt D8 gt lt DIN gt lt DCNT gt lt C1 gt 000000001 lt C1 gt lt C2 gt 000000001 lt C2 gt mE lt C3 gt 000000001 lt C3 gt e Digital input COUNT data lt 4 gt 000000001 lt 4 gt e DCNT is the parent container lt 5 gt 000000001 lt 5 gt Each COUNT has it s own container as well lt lt 6 gt 000000001 lt 6 gt lt DCNT gt lt C1 gt data lt C1 gt lt DCNT gt lt C7 gt 000000001 lt C7 gt lt C8 gt 00000000 lt DCNT gt lt AIN gt lt A1 gt 0 0 lt A1 gt lt A2 gt 0 0 lt A2 gt lt A3 gt 0 0 lt A3 gt e Analog input STATUS lt A4 gt 0 0 lt A4 gt lt AIN gt lt A1 gt data lt A1 gt lt AIN gt lt A5 gt 0 0 lt A5 gt lt A6 gt 0 0 lt A6 gt 2 Analog output STATUS lt gt lt AOUT gt lt AO1 gt data lt AO1 gt lt AOUT gt lt AOUT gt lt 1 gt 5 0 lt 1 gt lt 2 gt 3 5 lt 2 gt e Rel
32. pareil num rique de la classe A est conforme la norme NMB 003 du Canada Power Input 9 30VDC Max 120mA at 12VDC Contact support simplecomtools com Made in U S A PN XML1000 LBL SimpleComTools LLC 8 SimpleComTools LLC XML1000 User Manual 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 Installation Requirements and Instructions Mounting Power Environment o SimpleComTools LLC The XML1000 has 4 slotted mounting holes and 2 oval mounting holes for easy mounting and installation You can use either wood or sheet metal screens hooks or other common fasteners to mount or hang the device The XML1000 will accept 9 30VDC For locations with 110VAC power you will need to provide a 100 12VDC power transformer Tthe XML1000 The power interface is a standard 2 wire and terminal strip Disconnect the 2 lead terminal strip insert plug from the XML1000 power interface With a power adapter or wire that is not yet connected to a power supply insert the positive wire into the left side
33. ption Relay Output state Response value displayed as a 0 or 1 Query AT Rn Query the state of the Relay Output Options n 1 8 Configuration AT Rn y Changes the state of the Relay Output Options n 1 or 2 y or 1 y 0 De energized y 1 Energized SimpleComTools LLC 32 SimpleComTools LLC XML1000 User Manual Analog Outputs Description Analog Output value Query AT AOn Query the state of an Analog Output Options n 1 or 2 Response value is contingent upon the status of the AUNITS register 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 0 00 20 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS71 Configuration Output Send AT AOn y Command to set the voltage OUTPUT for an Analog output Options n 1 or 2 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 4 00 20 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS 1 y y y y SimpleComTools LLC 33
34. ral error response XML1000 Element Naming Convention Descriptions The chosen names for XML elements are what convey the meaning of data in the markup document This increases human readability while retaining the structure for parsing The goal is to choose names that imply the meaning of the elements and data to a human reader without requiring a reference manual However because being too descriptive can lead to verbose element names and thus have an impact of processing power and use of network bandwidth it may be necessary to have tags that are abbreviated Having tags that accomplish the goal of readership without being too verbose is the ideal goal The XML1000 element names were designed for just that reason While they may seem a little bit cryptic at first their meanings becoming quite clear once they are defined The following table details each tag and its relationship to the parent element SimpleComTools LLC 18 SimpleComTools LLC XML1000 User Manual SimpleComTools LLC 19 SimpleComTools LLC XML1000 User Manual XML1000 Example Output Document lt xml version 1 0 encoding UTF 8 gt lt XML1000 gt lt ID gt TEST1 lt ID gt lt CFG gt lt UID gt TEST1 lt UI VER XML1000 1 3 002 A lt VER gt lt EID gt 1 lt EID gt lt XSL gt 1 lt XSL gt lt RBX gt 1 lt RBX gt lt RBXTMR gt 1 lt RBXTMR gt lt RBXCNT gt 0 lt RBXCNT gt lt AUNITS gt 0 lt AUNITS gt lt CFG gt lt DIN gt
35. rmat whichever one is selected in the AUNITS register Options n 1 8 Response value is contingent upon the status of the AUNITS register 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0O 30VDC inputs when AUNITS 0 0 00 20 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS71 AnMX Configuration Command to reset the HIGHEST reached value for the analog input New value must be in the same format selected in the AUNITS register Options 1 8 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 4 00 20 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS 1 n Y y y SimpleComTools LLC 30 SimpleComTools LLC XML1000 User Manual AnMXSP Digital Inputs States SimpleComTools LLC 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 Options n 1 8 Response value is contingent upon the status of the AUNITS register 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 0 00 20 00 for units with 4 20mA inputs when AUNITS 0 0
36. s designed to provide the ability to save a device configuration for future use or application to another device Options Help are the basic options Saving a configuration Save Select the File Save and give the file a name and save it with either a txt or xml extension Digital Inputs Reading a configuration Select File Open and select the configuration file you want to use When opened the settings will populate Edit values if appropriate and click on any individual Set button or the Set button next to the ALL heading SimpleComTools LLC 25 SimpleComTools LLC 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 device using AT Commands follow these directions 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 PC Connects to the XML1000 Terminal Port using a NULL RS232 cable Step 2 Open a connection using any Terminal program such as HyperTerminal or TeraTerm The default setup for the port is 1152000 8 None and 1 Step 3 Once connected enter and hit the RETURN or ENTER key
37. the value from the device Making manual changes to commands being sent to the device While it is possible to change what commands are being sent to the device using the provided Get and Set buttons the utility also provides you the ability to manually edit the SENT commands inside the Sent window XML1000 Test Tool 1 6 BEES This allows you to test File Edit Options Help your understanding of Connection 4 Type Disconnect Status Port Opened XM L syntax Si m ply change the command General Digital Inputs Analog Inputs Relay Dutput Analog Dutput lt XML1000 gt lt CFG gt lt UID gt TEST1 lt UID gt lt CFG gt lt XML1000 gt being sent to what you Unit ID TESTI Get Set T would like to test and Version XMLT000 1 3 002 Get mtt then click on the Send button Device Configuration oy nable ID isabled el e E oo E o What you see in the Sent Enable XSL Enabled w Get Set Report by Exception Enabled v Get Set Reporting Interval Timer 1 Get Set response will appear in eporting Retry Count Se MN EE the refreshed Received Analog Units Volts v et et window window will now be sent to the device The new Settings 115200 n 8 1 Bytes Sent 56 Bytes Received 0 Selected Bytes 3 10 2006 12 03 11 PM www SimpleComT ools com Saving the settings as a template The XML 1000 configuration utility has a TEMPLATE function This ML_1000 Test Tool 1 6 feature i
38. with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 4 00 20 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS 1 y y y SimpleComTools LLC 29 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 Options n 1 8 Response value is contingent upon the status of the AUNITS register 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 0 00 20 00 for units with 4 20mA inputs when AUNITS 0 0 1023 when AUNITS 1 AnMNSP Configuration AT AnMNSP y Command to set the MINIMUM LOW SETPOINT for the analog input New value must be in the same format selected in the AUNITS register Options n 1 8 y 0 00 5 00 for units with O 5VDC inputs when AUNITS 0 y 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 y 4 00 20 00 for units with 4 20mA inputs when AUNITS 0 y 0 1023 when AUNITS 1 Description Analog Input Maximum HIGHEST value attained since the last read request Query AT AnMX Query the HIGHEST attained value for the analog input Response value will be in either VOLTAGE or DECIMAL fo
Download Pdf Manuals
Related Search