Controls Datum Source¶
SolarNode can generate a datum stream from SolarNode control values, either on a fixed schedule or in response to changes to control values.
The datum generated by this component will use the control's ID value for the datum source ID. For
the control value, if the control defines a specific property name the generated datum will have a
status property with the same name. Otherwise the generated datum will have a status property val,
and if the control has a number value an instantaneous property v will also be created.
Note
Some controls return more complex values and may generate other datum property values that are captured by this component. Consult the documentation for the control you are using for more information.
Use¶
Once installed, a new Control Datum Source component will appear on the Settings > Components page on your SolarNode. Click on the Manage button to configure components.
This component is included in the solarnode-app-control-core package in SolarNodeOS. You can install this package on the System > Packages page in SolarNode.
Settings¶
Each component configuration contains the following settings:
| Setting | Description |
|---|---|
| Service Name | A unique name to identify this data source with. |
| Service Group | A group name to associate this data source with. |
| Control ID | A regular expression to match against control ID values, where matching control IDs will be turned into datum. Leave blank to generate datum for all available control IDs. |
| Event Mode | The Event Mode to use. |
| Persist Mode | The Persist Mode to use. |
Event Mode¶
The Event Mode setting allows you to configure which control events are turned into datum objects. This can be useful for controls that publish events outside of being polled explicitly.
| Mode | Description |
|---|---|
| Polled Only | Datum are generated only via the Schedule setting on this component. |
| Sampled | Emitted when some plugin reads (samples) a control value. |
| Changed | Emitted when a plugin writes (changes) a control value. |
| Sampled and changed | Generate datum from both Sampled and Changed control events. |
Persist Mode¶
The Persist Mode settings configures which datum are persisted in SolarNetwork.
| Mode | Description |
|---|---|
| Poll | Persist only polled control values. Datum generated via events will not be persisted. |
| Poll and event | Persist polled and event-based datum. |