IOServer XML interface
XML Data Server to service read and write requests from web pages. All read data are timestamped and have quality information. Captures all read events for transmission to the client.
IOServer XML Server Settings
| Root Directory | Root directory for HTTP/XML Server. The HTTP Server is disabled if this is not a valid directory, |
|---|---|
| Port | TCP/IP port for HTTP/XML Server |
| Read Password | Password for read access. The read request will be rejected if the passWord is not the same as this password. |
| Write Password | Password for write access. The write request will be rejected if the passWord is not the same as this password. |
| Dead band | Default Deadband in percent. This deadband value will be used if the addGroup request does not specify the deadband. |
| Update Rate | Default update rate in milliseconds. This update rate will be used if the addGroup request does not specify the updateRate. |
| Log to file | Log to ios.log |
| Read Only | Read only access. All write requests will be rejected if this option is checked. |
IOServer XML Server Requests and Responses
| Request | Response | Action |
|---|---|---|
| <addGroup>
<upDateRate>upDateRate</upDateRate> <deadBand>deadBand</deadBand> <item> <itemID>Master.40001</itemID> <active>1</active> </item> </addGroup> |
<addGroup>
<handle>groupHandle</handle> <item> <itemHandle>itemHandle</itemHandle> <status>x</status> </item> </addGroup> |
Create a group with the specified updateRate, deadband, and list of items. The groupHandle is a hexadecimal number for use in read and write requests. The returned itemHandle is a decimal for use in read and write requests. The return status should be zero if the item is added successfully. The itemHandle starts numbering from zero for successfully added items. |
| <read>
<passWord>readpassword</passWord> <handle>groupHandle</handle> </read> |
<read>
<handle>groupHandle</handle> <item> <itemHandle>itemHandle</itemHandle> <value>value</value> <quality>quality</quality> <time>utctime</time> </item> </read> |
Issue a read request for groupHandle. The readpassword is not required if no read password is configured at the server. The server will return all items that have changed. The server will wait for up to 10 * updateRate for new items before responding with an empty list. The server will close the connection if they are no activities for more than 100 * updateRate. utctime is milliseconds since 1 January 1970 UTC. |
| <write>
<passWord>writepassword</passWord> <handle>groupHandle</handle> <writeItem> <itemHandle>itemHandle</itemHandle> <data>data</data> </writeItem> </write> |
<write>
<handle>groupHandle</handle> <writeItem> <itemHandle>itemHandle</itemHandle> <status>x</status> </writeItem> </write> |
Write to groupHandle the list of writeItem. The writepassword is not required if no write password is configured at the server. itemHandle identifies which item to write to with the data. The return status should be zero if the item is written to successfully. |
IOServer XML Server Clients
List of XML client connections
| Handle | Address, port, html port and handle of XML client |
|---|---|
| Items | Number of items requested |
| Reads | Reads performed |
| Writes | Writes performed |
| Pending | Events waiting to be sent |
| Last accessed (ms) | Milliseconds since last accessed |
| Age | Time since connection was started |
| Update Rate (ms) | Read update rate of items in this connection |
| Dead Band (%) | Only changes greater than the dead band are reported for items that specified their low and high raw values |
IOServer XML Client Demo
Install iosdoc.exe
Run IOServer with the configuration file C:\IOServer\Doc\mbtcp.io
Point your web browser to http://127.0.0.1:81/xmlscada.html
OPC Quality Code
| QQSSSSLL | QQ000000 Quality
QQSSSS00 Status
LL Limit
|
|---|
| © Copyright IOServer Pty Ltd. All rights reserved. |
| ✉ sales@ioserver.com 📞+61 2 9805 0356 (Australia) |
|
Last updated: Thu, 16 Jun 2022 08:02:03 GMT |