IO State API is for third-party systems that only need real-time values. It is built into the HQControl main service and uses the same web port (default 8080); there is no separate service port. Configure third parties using the actual address shown on the IO State API page, with an access key.
IO State API is for third-party systems that only need real-time values. It is built into the HQControl main service and uses the same web port (default 8080); there is no separate service port. Configure third parties using the actual address shown on the IO State API page, with an access key.
On the IO State API page (Key management), give each third party its own key and limit what it can read. Authorize by device first; the groups (function group, device-name group) are then bound to a specific device, written as "device-code.group-code"; the same scope format menus and alarm sound use. A key then only reads the groups under the devices it is authorized for, and never the same-named group on other devices. Tick "allow all IO State" to open everything at once.
WebSocket clients should subscribe by tag, device, or grouping filters. Do not push all values to every browser.
Integration Script runs Python scripts and provides ReadTag, ReadTags, and WriteTag for HQControl data. Scripts can call HTTP services, write SQL, publish MQTT messages, or perform scheduled tasks. Its runner runs only on the local machine and is managed by HQControl, not exposed as a public integration endpoint. Use permissions and logs to keep operations traceable. To read one bit of a tag, use bracket syntax; e.g. ReadTagBoolean("DK.StatusWord[3]", False); the index is a 0-based bit (BYTE 0-7, WORD 0-15, DWORD 0-31), returns a boolean, and is read-only.
Script output should preserve case and original text. The demo account is allowed to run scripts, but this permission must not leak into unrelated operations.
