Simultaneity
The simultaneity module serves, as a time series, how well a community’s energy production and consumption match up. 100% means that, at that moment, consumption matches production. Below 100%, members use less than is produced; above 100%, they need more than is produced.
Install: pip install "cofy-api[simultaneity]", plus the extra of the source you use.
Settings
Section titled “Settings”| Field | What it is |
|---|---|
source |
Where the percentages come from. Required. |
formats |
json and csv, the defaults. |
And the settings every module has.
Sources
Section titled “Sources”| Source | Percentages |
|---|---|
simultaneity |
Calculated from the net volume of the community’s connections, below |
demo_ratio |
Generated percentages, to try things out |
The simultaneity source
Section titled “The simultaneity source”The simultaneity source adds up the net volume of a set of connections: what each one takes from the grid, positive, or puts on it, negative. For every moment it divides all consumption by all production.
| Field | What it is |
|---|---|
sources |
One or more net volume sources, such as acc_forecast. Required. |
cache |
How to cache the result. Optional. |
- When there is neither consumption nor production, simultaneity is 100%.
- It supports the resolutions all its sources support, and its data stays valid as long as that of its shortest-lived source.
Because the result is a number, the simultaneity source also fits a directive, to tell members when to use energy.
Example
Section titled “Example”type: simultaneityname: pilotsource: type: simultaneity sources: - type: acc_forecast ean: "541234567890123456" credentials: { type: secret, name: evo_credentials } cache: { max_age: PT15M }