Skip to content

Devices & Frames

Device List

A device represents a physical or logical unit on a connection. There can be multiple devices under a single connection.

Menu: Runtime → Connections → Select Connection → Devices → New Device

FieldRequiredDescription
NameYesDevice name
DescriptionNoDescription
Scan TimeYesRead period (ms)
Scan TypeYesRead type (Periodic, OnDemand)
{
"id": 453,
"name": "Energy-Device",
"connectionId": 153,
"dsc": "Energy monitoring simulated device",
"scanTime": 2000,
"scanType": "Periodic"
}
FieldDescription
scanTimeRead period in milliseconds. 2000 = reads every 2 seconds
scanTypePeriodic = continuous reading, OnDemand = reads only when requested
ScenarioRecommended Scan Time
Fast-changing data (power, current)1000 - 2000 ms
Medium-speed data (temperature, pressure)3000 - 5000 ms
Slow-changing data (energy meter)5000 - 10000 ms
Status information (on/off)1000 - 3000 ms

A frame is a data block read from a device. Each frame defines a specific address range. Variables reside within frames.

Menu: Runtime → Connections → Connection → Device → Frames → New Frame

FieldRequiredDescription
NameYesFrame name
DescriptionNoDescription
ReadableYesIs this frame readable
WritableYesCan variables in this frame be written to
Scan Time FactorNoDevice scan time multiplier
Minutes OffsetNoTiming offset (minutes)
{
"id": 703,
"name": "Energy-Frame",
"deviceId": 453,
"dsc": "Energy monitoring frame",
"isReadable": true,
"isWritable": true,
"scanTimeFactor": null,
"minutesOffset": null
}
SettingDescription
Readable = trueFrame is read periodically (monitoring)
Writable = trueValues can be written to variables in this frame (control)
Both = trueBoth read and write (most common)
Readable = falseWrite-only frame (setpoint sending)

Sets the frame’s read period as a multiple of the device scan time:

  • Device scan time = 2000ms, Frame scan time factor = 3 → Frame is read every 6000ms
  • null or 1 → Read at the same period as the device scan time

Connection: LOCAL-Energy (LOCAL, 127.0.0.1)
└── Device: Energy-Device (scanTime: 2000ms, Periodic)
└── Frame: Energy-Frame (readable + writable)
├── ActivePower_kW (Float, kW)
├── ReactivePower_kVAR (Float, kVAR)
├── Voltage_V (Float, V)
├── Current_A (Float, A)
├── Frequency_Hz (Float, Hz)
├── PowerFactor (Float)
├── Energy_kWh (Float, kWh)
├── Temperature_C (Float, °C)
├── Demand_kW (Float, kW)
└── GridStatus (Boolean)

This structure is the same for a MODBUS connection — the only difference is that protocol-specific parameters (slave ID, start address, register count, etc.) are added.