No event pending
Event pending in the far future. The exact definition of how far in the future this refers is dependent upon the market context, but typically means the next day.
Event pending in the near future. The exact definition of how near in the future the pending event is active is dependent on the market context.
The event has been initiated and is currently active.
The event has completed.
The event has been canceled.
Pattern used for extending string enumeration, where allowed.
An ID value that identifies a specific DR event instance.
Incremented each time an event is modified.
Fully qualified event ID includes the eventID and the modificationNumber.
The VEN should receive the DR event payload prior to dtstart minus this duration.
A duration before or after the event start time during which load shed should transit.
A duration before or after the event end time during which load shed should transit.
The payloadFloat value of the event interval currently executing.
Base for information in signal / baseline / report payloads
Data point value for event signals or for reporting current or historical values.
This is the payload for signals that require a quantity.
A 3 digit response code
Similar to HTTP 1.1 Error Pattern, 1st digit sufficient for most error processing
- 1xx: Informational - Request received, continuing process
- 2xx: Success - The action was successfully received, understood, and accepted
- 3xx: Pending - Further action must be taken in order to complete the request
- 4xx: Requester Error - The request contains bad syntax or cannot be fulfilled
- 5xx: Responder Error - The responder failed to fulfill an apparently valid request
xx is used for defining more fine grained errors
Narrative description of response status
optIn or optOut of an event
Indicate whether received payload is acceptable
optIn or optOut responses for received events
Time frames relevant to the overall event
An enumerated value describing the type of signal such as level or price
SignalTypeEnumerated lists the pre-defined types used to specify the payload types and conformance in a stream
Signal indicates the amount to change from what one would have used without the signal.
Signal indicates a program level.
Signal indicates a multiplier applied to the current rate of delivery or usage from what one would have used without the signal.
Signal indicates the price.
Signal indicates the price multiplier. Extended price is the computed price value multiplied by the number of units.
Signal indicates the relative price.
Signal indicates a target amount of units.
This is an instruction for the load controller to operate at a level that is some percentage of its maximum load consumption capacity. This can be mapped to specific load controllers to do things like duty cycling. Note that 1.0 refers to 100% consumption. In the case of simple ON/OFF type devices then 0 = OFF and 1 = ON.
Discrete integer levels that are relative to normal operations where 0 is normal operations.
Percentage change from normal load control operations.
Load controller set points.
Collection of Responses. When a service operation regards multiple referenceable items, each referenced item may have its own response. Always accompanied by an overall Response Type.
Information about the event
When an event is modified
Why an event was modified
The priority of the event in relation to other events (The lower the number higher the priority. A value of zero (0) indicates no priority, which is the lowest priority by default).
An indication of the event state: far, near, active, canceled, completed
Anything other than false indicates a test event
Any text
Signal values for events and baselines
The dateTime the payload was created
Identifies the resources associated with the logical VEN interface. For events, the values specified are the target for the event
Optionally identifies the device class associated with the signal. Only the endDeviceAsset subelement is used
Descriptive name for signal.
unique Identifier for a specific event signal
This is the unit of the signal.
Signal name.
Simple levels (OpenADR 2.0a compliant)
depreciated - for backwards compatibility with A profile
This is the cost of electricity
This is the cost of energy
This is the demand charge
This is the price that was bid by the resource
This is the amount of load that was bid by a resource into a program
This is the amount of energy from a resource that was bid into a program
State of energy storage resource
This is used to dispatch load
Set load output to relative values
Interval data for one or more event signals and/or baselines
Interval data for an event
Interval data for a baseline
B profile
Unique ID for a specific baseline
Descriptive name for baseline
This is the unit of the signal.
Opts are used by the VEN to temporarily override the pre-existing agreement. For example, a VEN may opt in to events during the evening, or opt out from events during the world series.
Enumerated value for the opt reason such as x-schedule
Reason for opting.
Enumerated reasons for opting.
Identifier for an opt interaction
Reference ID for a report
Identifier for a particular report request
Identifier for a particular Metadata report specification
Optional name for a report.
ReferenceID for this data point
Device Class target - use only endDeviceAsset.
Sources for data in this report. Examples include meters or submeters. For example, if a meter is capable of providing two different types of measurements, then each measurement stream would be separately identified.
Date and time this artifact references.
An enumerated value that gives the type of report being provided.
Enumerated report types
Report indicates a reading, as from a meter. Readings are moments in time-changes over time can be computed from the difference between successive readings. Payload type is float
Report indicates an amount of units (denominated in ItemBase or in the EMIX Product) over a period. Payload type is Quantity. A typical ItemBase is Real Energy.
Report indicates an amount of units (denominated in ItemBase or in the EMIX Product). Payload type is Quantity. A typical ItemBase is Real Power.
Report indicates the amount (denominated in ItemBase or in the EMIX Product) currently set. May be a confirmation/return of the setpoint control value sent from the VTN. Payload type is Quantity. A typical ItemBase is Real Power.
Change in usage as compared to the baseline. See usage for more information
Changes in setpoint from previous schedule.
Change in demand as compared to the baseline. See demand for more information
Can be demand or usage, as indicated by ItemBase. Indicates what [measurement] would be if not for the event or regulation. Report is of the format Baseline.
Difference between some instruction and actual state.
Average usage over the duration indicated by the Granularity. See usage for more information.
Average usage over the duration indicated by the Granularity. See demand for more information.
Generalized state of a resource such as on/off, occupancy of building, etc. No ItemBase is relevant. Requires an Application Specific Payload Extension.
Up Regulation capacity available for dispatch, expressed in EMIX Real Power. Payload is always expressed as positive Quantity.
Down Regulation capacity available for dispatch, expressed in EMIX Real Power. Payload is always expressed as positive Quantity.
Regulation setpoint as instructed as part of regulation services
Stored Energy is expressed as Real Energy and Payload is expressed as a Quantity.
Target Energy is expressed as Real Energy and Payload is expressed as a Quantity.
Capacity available for further energy storage, perhaps to get to Target Energy Storage
Price per ItemBase at each Interval
Simple level from market at each Interval. Itembase is not relevant.
Power factor for the resource.
Percentage of usage.
Percentage of demand
Percentage of demand
Metadata about the Readings, such as mean or derived
Type of Reading.
Reading is read from a device that increases monotonically, and usage must be computed from pairs of start and stop readings.
Meter or [resource] prepares its own calculation of total use over time.
Meter covers several [resources] and usage is inferred through some sort of pro data computation.
Used when a reading is absent in a series in which most readings are present.
Several meters together provide the reading for this [resource]. This is specifically a different than aggregated, which refers to multiple [resources] in the same payload. See also Hybrid.
Usage is inferred through knowledge of run-time, normal operation, etc.
Reading is the mean value over the period indicated in Granularity
Reading is Peak (highest) value over the period indicated in granularity. For some measurements, it may make more sense as the lowest value. May not be consistent with aggregate readings. Only valid for flow-rate Item Bases, i.e., Power not Energy.
If aggregated, refers to different reading types in the aggregate number.
Indicates reading is pro forma, i.e., is reported at agreed upon rates
Indicates reading is in the future, and has not yet been measured.
Root Mean Square
Not Applicable
Number is in same units as the payload variable for an Interval. When present with Confidence, indicates the likely variability of the prediction. When present with ReadingType, indicates likely error of Reading.
Report Payload for use in Reports, snaps, and projections.
A reference to a metadata data point description
Likely variability of prediction: 0-100
Accuracy in same units as interval payload value
Specify data points desired in a particular report instance
Parameters that define the content of a Report Stream
How frequently the [measurement] is to be recorded.
Report back with the Report-To-Date for each passing of this Duration.
This is the overall period of reporting.
Payload for use in Report Specifiers.
What is measured or tracked in this report (Units).
Identifier for Registration transaction. Not included in response to query registration unless already registered
Reference ID for a particular instance, transmittal, or artifact. Note: not the same as the native ID of the object being transmitted or shared.
Unique Identifier