SCT xml1000 User Manual Download

Page: 1 / 33

SimpleComTools, LLC

XML1000 – User Manual

SimpleComTools, LLC

User Manual

Command Reference Guide

xml

1000

Serial I/O Server

March 2006

Summary of Contents for xml1000

Page 1: ...SimpleComTools LLC XML1000 User Manual SimpleComTools LLC 1 User Manual Command Reference Guide xml1000 Serial I O Server March 2006 ...

Page 2: ...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 cau...

Page 3: ...1000 User Manual SimpleComTools LLC 3 Table of Contents Page INTRODUCTION 4 GETTING STARTED 9 BASICS OF OPERATION 10 BASICS OF XML 11 COMMUNICATING WITH THE XML1000 15 USING THE CONFIGURATION UTILITY 22 USING AT COMMANDS 26 ...

Page 4: ...ed 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 X...

Page 5: ...UT SIDE ANALOG INPUT SIDE Relay Outputs Digital Inputs Analog Inputs Analog Outputs Power Input This interface is used to connect a device that you want to turn on and off This interface is used to connect simple contact closure switches This interface is used to connect simple analog measurement gauges This interface is used to provide variable 0 5vdc analog output This interface is used to conne...

Page 6: ...cuit to be OPEN when the relay is ACTIVATED 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 as commons and are where you connect the second switch wire Th...

Page 7: ...mTools LLC XML1000 User Manual SimpleComTools LLC 7 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 ...

Page 8: ...s 2 SPDT Relays 2A at 120 VAC 5A at 24 VDC 8 Inputs at 0 30 VDC 2 Outputs at 0 5 VDC C CC 4 20 8 Contact Closure Inputs 2 SPDT Relays 2A at 120 VAC 5A at 24 VDC 8 Inputs at 4 20 mA 2 Outputs at 0 5 VDC D OI 0 5 8 Optically Isolated Inputs 2 SPDT Relays 2A at 120 VAC 5A at 24 VDC 8 Inputs at 0 5 VDC 2 Outputs at 0 5 VDC E OI 0 30 8 Optically Isolated Inputs 2 SPDT Relays 2A at 120 VAC 5A at 24 VDC ...

Page 9: ...er 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 access hole of the insert plug and tighten the retaining screw Next insert the ground wire into the right side ac...

Page 10: ...inks 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 ...

Page 11: ...efits 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 sim...

Page 12: ...ing 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 iii Data 3 b Section 2 i Data 1 ii Data 2 iii Data 3 c Section 3 Operating System Hierarchy Example C WINDOWS system32 drivers etc C WINDOWS system32 drivers etc XML1000 Example Output Document xml version 1 0 encoding UTF 8 XML1000 DIN D1 1 ...

Page 13: ...rnet 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 The...

Page 14: ...1 The document may have only one root element 2 Non empty elements must have both opening and closing tags 3 Empty elements may be marked with an empty element self closing tag such as EMPTY 4 All attribute values are quoted either single or double quotes 5 Single quotes close a single quote and double quotes close a double quote 6 Tags may be nested but must not overlap 7 Each non root element mu...

Page 15: ...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 Connection Examples Ethernet Network Connection To connect an XML1000 ...

Page 16: ... be both well formed and valid If a command does not meet those rules the XML1000 will return a document with the ERROR element 2 Messages face parsing time limitations XML formatted commands are processed by the XML1000 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...

Page 17: ...neral Config Values XML1000 CFG CFG XML1000 or XML1000 CFG XML1000 xml version 1 0 encoding UTF 8 XML1000 CFG UID TEST1 UID VER XML1000 1 3 002 A VER EID 0 EID XSL 1 XSL RBX 1 RBX RBXTMR 1 RBXTMR RBXCNT 0 RBXCNT AUNITS 0 AUNITS CFG XML1000 Query for Digital Input Values XML1000 DIN DIN XML1000 or XML1000 DIN XML1000 xml version 1 0 encoding UTF 8 XML1000 DIN D1 1 D1 D2 1 D2 D3 1 D3 D4 1 D4 D5 1 D5...

Page 18: ...ng to WRITE an invalid value to any element Ex writing ABC to analog output OUTOFRANGE This occurs when attempting to WRITE an unsupported value to any element Ex writing a 2 to relay output SYNTAX General 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 ...

Page 19: ...N A XML1000 Tn Sets Digital Inputs to NO or NC integer DTYPE DCNT Parent for Digital Input Counts N A XML1000 Cn Digital Input counts integer DCNT AIN Parent for Analog Inputs N A XML1000 An Analog Input values decimal AIN AMINVAL Parent for Analog Input Min Values N A XML1000 AnMN Lowest value since last request decimal AMINVAL AMAXVAL Parent for Digital Input elements N A XML1000 AnMX Highest va...

Page 20: ...X 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 C4 000000001 C4 C5 000000001 C5 C6 000000001 C6 C7 000000001 C7 C8 00000000 DCNT AIN A1 0 0 A1 A2 0 0 A2 A3 0 0 A3 A4 0 0 A4 A5 0 0 A5 A6 0 0 A6 A7 0 0 A7 A8 0 7 A8 AIN AOUT AO1 5 0 AO1 AO2 3 5 AO2 AOUT RELAY R1 0 R1 R2 0...

Page 21: ...A8 AIN AOUT AO1 5 0 AO1 AO2 3 5 AO2 AOUT RELAY R1 0 R1 R2 0 R2 RELAY XML1000 XML1000 is the ROOT top hierarchal element Main container for all other elements data Equivalent to the MAIN C drive of your PC Each lower data element is wrapped in a container Equivalent to a folder or sub directory on your PC Data array is wrapped with a start and closing tag Digital input COUNT data DCNT is the parent...

Page 22: ...plays Digital Input states DIGITAL COUNTS Displays and sets Digital Input counts ANALOG INPUTS Displays and sets Analog Input values RELAY OUTPUTS Displays and sets Relay Output states ANALOG OUTPUTS Displays and sets Analog Output values SENT Displays the XML code most recently sent to the device RECEIVED Displays the XML code most recently received from the device Configuration Utility Connectio...

Page 23: ...mmunications method Clink on Get All Parameters to read device 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 ...

Page 24: ... device Take note of the Received section This will show you the exact XML data returned from the device 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 Selecting TCP IP will allow you to connect to the device over IP Enter the IP address and port into the appropriate boxes and select CONNECT ...

Page 25: ...lity also provides you the ability to manually edit the SENT commands inside the Sent window This allows you to test your understanding of XML syntax Simply change the command being sent to what you would like to test and then click on the Send button What you see in the Sent window will now be sent to the device The new response will appear in the refreshed Received window Saving the settings as ...

Page 26: ...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 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 AT and hit the RETURN or ENTER key You should OK as the response To view ALL the curre...

Page 27: ...nput Units sets values to be either raw voltage or decimal Query AT AUNITS Configuration AT AUNITS n Options 0 Raw Voltage Value Default 1 Decimal Value 0 1023 EID Description Choose to include the UID in every report and response Query AT EID Configuration AT EID n Options 0 Disabled Default 1 Enabled RBX Description Report By Exception enables automatic reporting of changes in I O or passing ana...

Page 28: ...ons n 0 255 Note Setting the value to 0 means RBX will never repeat UID Description Reads or sets the Unique Device ID UID Query AT UID Configuration AT UID xxxxx Options x Up to 32 alphanumeric characters VER Description Current Firmware Version Query AT VER Returns current XML1000 firmware version XSL Description XSL Header setting Enables disables the XML header for facilitating the presentatio...

Page 29: ...ttained 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 A...

Page 30: ...0 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 AnMX 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 format whichever one is selected in the AUNITS register Opti...

Page 31: ... 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 y 0 00 5 00 for units with 0 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 Digital Inputs States AT Command Description Tn Description Dig...

Page 32: ...ation Reset AT Cn y 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 AT Command Description Rn Description 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 C...

Page 33: ...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 Configuration Output Send AT A0n y Command to set the voltage OUTPUT for an Analog output Options n 1 or 2 y 0 00 5 00 for units with 0 5VDC inputs when AUNITS 0 y 0 00 30 00 for units with 0 30VDC inputs when AUNITS 0 y 4...

Search results

Summary of Contents for xml1000

Reviews:

Related manuals for xml1000

Brands by name

Popular brands

SCT xml1000, User Manual

Search results

Summary of Contents for xml1000

Reviews:

Related manuals for xml1000

Brands by name

Popular brands