-
Couldn't load subscription status.
- Fork 20
Glossary
A device in the microgrid. For example, inverter, battery, meter, etc.
A way to identify a particular instance of a component. It is always a int.
For example: Battery with component ID 5.
A measurable characteristic of a component.
For example: the capacity of a battery.
An individual value measured from a component instance metric. It is always float but it is expressed in some particular unit.
In the context of a Sample (see below) this is usually referred to as a sample value.
For example: A measurement of the capacity of battery with component ID 5 can be 400. The unit is typically Watt-hour (Wh).
A point in time. It is always a datetime.
A measurement taken at a particular point in time: a tuple (timestamp, measurement), or simply (timestamp, value).
For example: Getting the measurement of 400 from the capacity of a battery at 2022-01-01 22:00:00.000 UTC would be a sample (2022-01-01 22:00:00.000 UTC, 400).
State of Charge of a battery usually expressed in percentage.
Unless otherwise specified, we use float with a value range of [0 .. 1].
A sequence of Samples. Normally time series should be sorted by timestamp and timestamps should be separated at regular intervals, but there can be also irregular (event-based) time series (in this case there could even possibly be multiple values with the same timestamp).
For example: Getting the measurement from the capacity of a battery at 2022-01-01 22:00:00.000 UTC every 1 second for 5 seconds would be a timeseries like:
(2022-01-01 22:00:00.000 UTC, 400)
(2022-01-01 22:00:01.000 UTC, 401)
(2022-01-01 22:00:02.000 UTC, 403)
(2022-01-01 22:00:03.000 UTC, 402)
(2022-01-01 22:00:04.000 UTC, 403)
A way to identify a component's metric. Usually a str.
For example, the metric ID of the capacity of a battery is just capacity.
A way to identify a timeseries that comes from a metric of a particular component instance. Usually a str, but coming from the tuple (component ID, metric ID) for components.
For example: A timeseries for the capacity of battery with component ID 5 has ID (component_id, metric_id) (or f"{component_id}_{metric_id}").