Common Keys (common.*)
Common fields in the body of every object (channel/device/tag). Property names match the industry standard one to one (interop).
common.ALLTYPES_NAME | Object name (required). Channel/device/tag name. |
common.ALLTYPES_DESCRIPTION | Description (optional). |
PROJECT_ID | Optimistic concurrency stamp. Returned in every GET response; sent back in PUT. 409 on mismatch. |
FORCE_UPDATE | true → the PROJECT_ID check is skipped (force write). Used by DataExchanger-type clients. |
Note servermain.CHANNEL_UNIQUE_ID, servermain.DEVICE_UNIQUE_ID, servermain.DEVICE_CHANNEL_ASSIGNMENT, PROJECT_ID are server-managed (read-only) — even if you send them in POST/PUT, the server decides them.
Channel Properties
servermain.MULTIPLE_TYPES_DEVICE_DRIVER | Driver name (see Driver Names). Once per channel. |
servermain.CHANNEL_UNIQUE_ID | Automatic unique ID (read-only). |
servermain.CHANNEL_WRITE_OPTIMIZATIONS_METHOD | Write optimization method (drop duplicates / write latest only). |
servermain.CHANNEL_WRITE_OPTIMIZATIONS_DUTY_CYCLE | Maximum number of writes per cycle. |
servermain.CHANNEL_NON_NORMALIZED_FLOATING_POINT_HANDLING | NaN/Inf float handling (e.g. replace with zero). |
Example — create a channel
POST /config/v1/project/channels
{
"common.ALLTYPES_NAME": "Modbus_1",
"servermain.MULTIPLE_TYPES_DEVICE_DRIVER": "Modbus TCP/IP Ethernet"
}
Device Properties
servermain.DEVICE_ID_STRING | Device address/ID — driver-specific (see Driver Names). |
servermain.DEVICE_MODEL | Model (driver-specific; e.g. S7-1200). |
servermain.DEVICE_DATA_COLLECTION | true/false — turn device scanning on/off. |
servermain.DEVICE_SIMULATED | true → synthetic data (no hardware). |
servermain.DEVICE_SCAN_MODE / ..._RATE_MS | Scan mode + rate (ms). |
servermain.DEVICE_REQUEST_TIMEOUT_MILLISECONDS | Request timeout (ms). |
servermain.DEVICE_RETRY_ATTEMPTS | Attempts before timeout (connection+request). |
servermain.DEVICE_INTER_REQUEST_DELAY_MILLISECONDS | Delay between requests (ms). |
servermain.DEVICE_AUTO_DEMOTION_* | Back-off on failure: ENABLE / DEMOTE_AFTER_SUCCESSIVE_TIMEOUTS / PERIOD_MS / DISCARD_WRITES. |
servermain.DEVICE_TAG_GENERATION_* | Automatic tag generation: ON_STARTUP / DUPLICATE_HANDLING / GROUP / ALLOW_SUB_GROUPS. |
Example — create a device
POST /config/v1/project/channels/Modbus_1/devices
{
"common.ALLTYPES_NAME": "1001",
"servermain.MULTIPLE_TYPES_DEVICE_DRIVER": "Modbus TCP/IP Ethernet",
"servermain.DEVICE_ID_STRING": "192.168.1.50.1",
"servermain.DEVICE_DATA_COLLECTION": true,
"servermain.DEVICE_REQUEST_TIMEOUT_MILLISECONDS": 1000,
"servermain.DEVICE_RETRY_ATTEMPTS": 3
}
Tag Properties & Scaling
servermain.TAG_ADDRESS | Device address (driver-specific; e.g. Modbus 400001). |
servermain.TAG_DATA_TYPE | Data type (Boolean/Word/Short/DWord/Long/Float/Double/String…). |
servermain.TAG_READ_WRITE_ACCESS | 0 = Read Only, 1 = Read/Write. |
servermain.TAG_SCAN_RATE_MILLISECONDS | Tag scan rate (ms). |
servermain.TAG_SCALING_TYPE | 0=none, 1=linear, 2=square root… |
..._RAW_LOW / _RAW_HIGH | Raw device range. |
..._SCALED_LOW / _SCALED_HIGH | Engineering range. |
..._SCALED_DATA_TYPE / _CLAMP_LOW / _CLAMP_HIGH / _NEGATE_VALUE | Scaled type, clamping, negation. |
Example — add tags (batch, array)
POST /config/v1/project/channels/Modbus_1/devices/1001/tags
[
{ "common.ALLTYPES_NAME": "Basinc", "servermain.TAG_ADDRESS": "400001",
"servermain.TAG_DATA_TYPE": "Float", "servermain.TAG_READ_WRITE_ACCESS": 0 },
{ "common.ALLTYPES_NAME": "Setpoint", "servermain.TAG_ADDRESS": "400010",
"servermain.TAG_DATA_TYPE": "Float", "servermain.TAG_READ_WRITE_ACCESS": 1 }
]
Warning Do not reverse TAG_READ_WRITE_ACCESS: 0=RO, 1=RW. A wrong value makes setpoints read-only and blocks writing.
Driver Names & DEVICE_ID_STRING
Values for the channel MULTIPLE_TYPES_DEVICE_DRIVER and the device DEVICE_ID_STRING:
| Modbus TCP/IP Ethernet | <IP>.unit e.g. 192.168.1.50.1; without a unit <192.168.1.50> |
| Modbus RTU Serial / Modbus ASCII Serial | COM port + unit (channel serial settings). |
| Siemens S7 TCP/IP | IP; Rack/Slot in the model/ID. E.g. 10.0.0.5 |
| OMRON FINS Ethernet | IP (+FINS SA1/DA1 settings). |
| OMRON NJ Ethernet | IP (EtherNet/IP CIP symbolic). |
| Allen-Bradley ControlLogix Ethernet | IP,1,slot e.g. 192.168.1.10,1,0; IP only on Micro800. |
| Fatek FBs | Station number (e.g. 1); IP and port are in the device Ethernet settings. |
| KNXnet/IP | No ID required; interface IP / port (3671) are on the channel. |
| BACnet/IP | Device Instance (e.g. 1001); the IP is in bacnet.DEVICE_IP_ADDRESS, found with Who-Is when empty. |
| DNP Client Ethernet | IP:port,masterAddr,slaveAddr |
| IEC 60870-5-104 Client | IP:2404,commonAddr |
| IEC 61850 MMS Client | IP:102 |
| MQTT Client | broker host/port. |
| Simulator | No ID required. |
Batch Operations & Status Codes
If tags are POSTed as an array, they are processed as a batch. The HTTP status code depends on the result:
| 201 Created | All succeeded. |
| 207 Multi-Status | Partial — some succeeded, some failed (individual results in the body). |
| 400 Bad Request | All failed. When creating a channel/device, 400 is also returned if the driver limit is full (property + description). |
| 409 Conflict | PROJECT_ID mismatch (bypassed with FORCE_UPDATE). |
Tip Invalid tags are skipped (lenient import); the reason for skipped ones is reported in the response/event log. Real exports (thousands of tags) can be imported in a single request.