Setpoints¶
Any number of setpoint providing entities can be configured.
All Setpoints¶
The following properties are available for configuration on all setpoint devices:
Name- Unique identifier of a setpoint providing entity. This will be used by the plugin to tag journal entries and recorded data streams.
Read interval [ms]-
This sets the speed at which the setpoint source will be queried for data in milliseconds.
Important
This parameter affects system load and control behavior!
Data stream interval [s]-
The data steaming interval defines how often captured data is being recorded for transmission into Ardexa cloud. The unit is seconds. When this is set to 0 no data is being streamed to the Ardexa cloud.
Important
This parameter affects system load and control behavior!
Enable active power setpoint- When this parameter is switched to true, this entities active power setpoint will be taken into consideration by the control core. When set to false, the active power setpoint will still be recorded in data streams but be ignored by the control core.
Enable power factor setpoint- When this parameter is switched to true, this entities power factor setpoint will be taken into consideration by the control core. When set to false, the power factor setpoint will still be recorded in data streams but be ignored by the control core.
Setpoint type- A setpoint entity can be of different types. This property defines it. The available types are being described in the following sections:
Fixed Setpoint¶
A fixed setpoint providing entity does always provide the setpoints which have been configured. This can be used e.g. for static export limitation.
The following additional properties are available for configuration:
Fixed active power setpoint [%, W, kW or MW]- A permanent active power setpoint. The variable is of type string. To set a value relative to the nominal active power, add the '%' suffix e.g. "90%", For absolute values add the 'kW' suffix e.g. "1000kW". When no suffix is used it defaults to '%'.
Fixed power factor setpoint- Reflects a permanent power factor setpoint. See Power Factor for reference.
Manual Setpoint¶
A manual setpoint is a dynamic setpoint which can be changed by utilizing an Ardexa cloud API or an Ardexa dashboard. The Name property is being used in combination with the Ardexa device name and the plugin service name to address a manual setpoint e.g. inside an Ardexa dashboard.
There are no additional properties to configure.
The writeable variables created by this entity are:
setpoint-<name of setpoint entity>::setpoint_activepower- Reflects a manual active power setpoint. The variable type is string. To set a value relative to the nominal active power, add the '%' suffix e.g. "90%", For absolute values add the 'kW' suffix e.g. "1000kW". When no suffix is used it defaults to '%'.
setpoint-<name of setpoint entity>::setpoint_cosphi- Reflects a manual power factor setpoint. The variable type is number. See Power Factor for reference.
The variables can be altered by utilizing the valuedb command.
Schedule¶
A schedule setpoint is a dynamic setpoint which schedule defined in a file. The file can be uploaded with the Ardexa cloud file transfer functions.
File format JSON¶
The file format is json. The order of entries is not relevant. The number of entries is not limited. There are the following top level fields: * version (number) defines the file format version. The latest version is 1. * user_id (string) can be set to a user defined string for reference purposes. * entries (array) is an array of scheduler commands.
Each element of entries consists of the following fields: * path (string) defines which value to change. * value (string|number) defines what to change the value referred to by path to. * datetime (string) defines a point in time starting the validity of value for path.
Each file can contain entries for different path.
{
"version": 1,
"user_id": "test schedule 01",
"entries": [
{
"path": "setpoint_activepower",
"value": "99",
"utc_datetime": "2021-06-04T09:50:00.000000Z"
},
{
"path": "setpoint_activepower",
"value": "100",
"utc_datetime": "2021-06-04T10:05:00.000000Z"
}
]
}
File format CSV¶
The file format is CSV. The order of entries is not relevant. The number of entries is not limited. There first line in file has to contain the fields: * path (string) defines which value to change. * value (string|number) defines what to change the value referred to by path to. * datetime (string) defines a point in time starting the validity of value for path.
Each file can contain lines for different path.
path,value,datetime,description
"setpoint_activepower","100","2021-05-24T00:00:00.000000Z",""
"setpoint_activepower","80","2021-05-24T01:00:00.000000Z",""
"setpoint_activepower","30","2021-05-24T02:00:00.000000Z",""
"setpoint_activepower","100","2021-05-24T03:00:00.000000Z",""
Active power setpoint¶
!!! important
Only available if option `Enable active power setpoint` is enabled.
Active power setpoints are set according the provided schedule file. The path is setpoint_activepower. To set a value relative to the nominal active power, add the '%' suffix e.g. "90%", For absolute values add the 'kW' suffix e.g. "1000kW". When no suffix is used it defaults to '%'.
Power factor setpoint¶
!!! important
Only available if option `Enable power factor setpoint` is enabled.
Power factor setpoints are set according to the provided schedule file. The path is setpoint_cosphi. The variable type is number. See Power Factor for reference.
datetime field¶
The datetime field has to filled with ISO-8601 datetime strings. It can contain fractional seconds and time zone offset.
2021-05-24T00:00:00.000000Z
2021-05-24T00:00:00Z
2021-05-24T00:00:00+01:00
2021-05-24T00:00:00-0100
2021-05-24T00:00:00+01
2021-05-24T00:00:00.000000+01:00
2021-05-24T00:00:00 (local time of device is assumed)
DIO Device¶
The DIO Device is a dynamic setpoint to use with a digital input device. Digital contacts are used to control the setpoint value. The limitation values can be configured separately.
Fallback active power setpoint [%, W, kW or MW]- When no valid active power setpoint is available for any reason, this default setpoint is being used. The variable is of type string. To set a value relative to the nominal active power, add the '%' suffix e.g. '90 %', For absolute values add the 'W', 'kW' or 'MW' suffix e.g. '1000 kW'. When no suffix is used it defaults to '%'.
Active power step configuration¶
Configure a step for every needed setpoint value.
High DI- Add all input channels which have to be high for a step. If there is more than one channel all channels have to be high at the same time.
Low DI- Add all input channels which have to be low for a step. If there is more than one channel all channels have to be low at the same time.
Step setpoint [%, W, kW or MW]- Step setpoint value. The variable is of type string. To set a value relative to the nominal active power, add the '%' suffix e.g. '90 %', For absolute values add the 'W', 'kW' or 'MW' suffix e.g. '1000 kW'. When no suffix is used it defaults to '%'.
Device Settings¶
The following properties are available for configuration on all dio devices:
Name- Unique identifier of a setpoint providing entity. This will be used by the plugin to tag journal entries and recorded data streams.
Read interval [ms]-
This sets the speed at which the setpoint source will be queried for data in milliseconds.
Important
This parameter affects system load and control behavior!
Read timeout [ms]- This sets max age of for device data in milliseconds. After this time device is assumed as offline.
Data stream interval [s]-
The data steaming interval defines how often captured data is being recorded for transmission into Ardexa cloud. The unit is seconds. When this is set to 0 no data is being streamed to the Ardexa cloud.
Important
This parameter affects system load and control behavior!
Moxa IOLogik E1210¶
Channels DI0 to DI15 are available on this device.
See Modbus TCP
Moxa IOLogik E1214¶
Channels DI0 to DI5 are available on this device.
See Modbus TCP