OSCP enumerated types

This page lists the enumerated types used throughout the SolarUser OSCP API.

Action

Actions represent the names of messages that occur within OSCP.

Value	Description
Heartbeat	A heartbeat posted by a Capacity Provider or Capacity Optimizer.
UpdateGroupCapacityForecast	The capacity forecast posted by a Capacity Provider.

Asset Category

Defines the OSCP category used for assets.

Value	Description
Charging	All EV supply equipment. Could be bi-directional (V2G).
Consumption	Consumption unit with all loads in the group other than charging and storage units.
Generation	All one-way energy generation units. Examples are PV, wind turbines, generators.
Storage	All stationary two-way energy storage units (batteries).

Energy Direction

Defines the direction flow of energy in an asset measurement.

Value	Description
Net	Indicates an energy active net register.
Import	Indicates an energy active import register.
Exoprt	Indicates an energy active export register.

Energy Type

Defines the type of energy in an asset.

Value	Description
Flexible	Energy refers to the flexible load or generation.
NonFlexible	Energy refers to the non-flexible load or generation.
Total	Energy refers to total load or generation.

Forecast Type

Defines the type of forecast, for example in an UpdateGroupCapacityForecast message.

Value	Alias	Description
Consumption	c	The maximum capacity that can be imported by the flexible source.
Generation	g	The maximum capacity that can be exported by the flexible source.
FallbackConsumption	C	The maximum capacity that can be imported by the flexible source when offline.
FallbackGeneration	G	The maximum capacity that can be exported by the flexible source when offline.
Optimum	o	The optimum capacity that should either be imported or exported by the flexible source.

Measurement Period

Defines the frequency at which measurements should be reported to Capacity Provider and Optimizer systems. The periods align to whole hours, for example FifteenMinute means 4 periods per hour, for example starting at midnight: 00:00 - 00:15, 00:15 - 00:30, 00:30 - 00:45, and 00:45 - 01:00.

Value	Description
Minute	Once per minute.
FiveMinute	Every five minutes.
TenMinute	Every ten minutes.
FifteenMinute	Every fifteen minutes.
TwentyMinute	Every twenty minutes.
ThirtyMinute	Every thirty minutes.
Hour	Once per hour.

Measurement Unit

A unit of measure used in asset measurements.

Value	Description
A	Ampere per phase (current).
W	Watt (power).
kW	Kilowatt (power).
Wh	Watt-hours (energy). Represents the State Of Charge in case of measuring a battery.
kWh	Kilowatt-hours (energy). Represents the State Of Charge in case of measuring a battery.

Phase

Defines an AC phase within OSCP.

Value	Alias	Description
Unknown	u	Phase on which is measured is not known or irrelevant.
A	a	Represents measurement on phase 1.
B	b	Represents measurement on phase 2.
C	c	Represents measurement on phase 3.
All	z	Represents the sum or average of all phases (1, 2, and 3).

Role

Defines the type of actor that is performing an action within the OSCP system.

Value	Alias	Description
FlexibilityProvider	fp	The Flexibility Provider (SolarNetwork itself).
CapacityOptimizer	co	A Capacity Optimizer.
CapacityProvider	cp	A Capacity Provider.

Statistic Type

The asset measurement aggregation style.

Value	Description
Average	The average of the property values seen within the aggregate period.
Count	The count of property values that participated in the aggregate value.
Minimum	The minimum property value seen within the aggregate period.
Maximum	The maximum property value seen within the aggregate period.
Start	The first property value seen within the aggregate period.
End	The last property value seen within the aggregate period.
Difference	The difference between the end and start property values within the aggregate period.