General light circuits
Here, common lighting circuits can be defined that shall be monitored by the NETx LaMPS Module.
| parameter | type | optional/mandatory | description | default |
|---|---|---|---|---|
| Name | string | M | Name of circuit. | |
| Path | string | O | Path used for structure within NETx BMS Platform. | |
| OnOff ItemId | ItemID | M | ItemID that is used to turn on and off the circuit. If a separate status item is not used, this item also provides the status for calculating the operating hours. | |
| OnOff Status ItemId | ItemID | O | ItemID that provides the on/off status for this circuit. This status is also used for calculating the operating hours. If not used, the OnOff ItemID is used instead. | not used |
| Operating Time Warning Threshold | number | O | Warning threshold for operating hours. If exceeded, the warning alarm item will turn to true. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Operating Time Alarm Threshold | number | O | Alarm threshold for operating hours. If exceeded, the alarm alarm item will turn to true. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Brightness ItemId | ItemID | O | ItemID that can be used to change the brightness of a dimmable light. | not used |
| Brightness Status ItemId | ItemID | O | ItemID that provides the current brightness value of a dimmable light. | not used |
| Brightness Scale Factor | number | O | Scale factor for the brightness value. | 1 |
| Current ItemId | ItemID | O | If available the used current can be provided by this item. | not used |
| Current Scale Factor | number | O | Scale factor for the current. | 1 |
| Current Lower Warning Threshold | number | O | Here a lower warning threshold for monitoring the current can be specified. The current threshold can also be changed during runtime via the corresponding item. | not used |
Current Lower Alarm Threshold | number | O | Here a lower alarm threshold for monitoring the current can be specified. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Current Higher Alarm Threshold | number | O | Here a higher warning threshold for monitoring the current can be specified. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Current Higher Warning Threshold | number | O | Here a higher alarm threshold for monitoring the current can be specified. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Voltage ItemId | ItemID | O | If availale the current voltage can be provided by this item. | not used |
| Voltage Scale Factor | number | O | Scale factor for the voltage. | 1 |
| Voltage Lower Warning Threshold | number | O | Here a lower warning threshold for monitoring the voltage can be specified. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Voltage Lower Alarm Threshold | number | O | Here a lower alarm threshold for monitoring the voltage can be specified. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Voltage Higher Warning Threshold | number | O | Here a higher warning threshold for monitoring the voltage can be specified. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Voltage Higher Alarm Threshold | number | O | Here a higher alarm threshold for monitoring the voltage can be specified. The current threshold can also be changed during runtime via the corresponding item. | not used |
| Power ItemId | ItemID | O | If availabe the current power value can be provided by this item. | not used |
| Power Scale Factor | number | O | Scale factor for the power value. | 1 |
| Power Approximate | bool | O | If enabled, an estimated power value based on the current and voltage is calculated. Note that this is calculation is only a rough estimation since the accuracy depends sending or polling interval of the current and voltage values. | false |
| Energy ItemId | ItemID | O | If availabe the current energy value can be provided by this item. | not used |
| Energy Scale Factor | number | O | Scale factor for the energy value. | 1 |
| Energy Approximate | bool | O | If enabled, an estimated energy value based on the current and voltage is calculated. Note that this is calculation is only a rough estimation since the accuracy depends sending or polling interval of the current and voltage values. | false |
| Persistent | bool | O | If set to true, all items are set to persistent i.e. the last values are restored after server startup. | false |
| Historical | bool | O | If set to true, all values are stored within the historical database (only for NETx BMS Server 2.0). | false |
| Redundant | bool | O | If set to true, all items are synchronized with the backup server if available. | true |