schema.nfh.globalSearch schemas…
Home/Schemas/openadr

openadr

v3.1.0deg-main

openadr schema definitions (v3.1.0)

10 schema types · Source: deg-main

interval

A temporal window with an integer id and a list of valuesMap payloads. If intervalPeriod is present it overrides the series-level intervalPeriod for this window only.

3 properties
intervalPeriod

Defines temporal bounds of an interval series or a single interval. start uses RFC 3339 datetime format. duration uses ISO 8601 duration format (e.g. PT1H for one hour). randomizeStart indicates a random offset range that may be applied to start by the client.

3 properties
valuesMap

A typed payload row. type names the signal (e.g. PRICE_PER_KWH, AVAILABLE_QTY, REQUESTED_QTY). values carries one or more data points — most often a single scalar. See enumerations in Definitions for standardised type strings, or use privately defined strings.

2 properties
point

An (x, y) float pair, typically a 2-D grid coordinate.

2 properties
eventPayloadDescriptor

Sidecar metadata for a signal carried in an event or offer (objectType: EVENT_PAYLOAD_DESCRIPTOR). Provides units and currency context for a payloadType string referenced in valuesMap rows.

4 properties
reportPayloadDescriptor

Sidecar metadata for a telemetry signal in a report (objectType: REPORT_PAYLOAD_DESCRIPTOR). Provides units, reading type, accuracy, and confidence context for a payloadType.

6 properties
dateTime

RFC 3339 datetime string.

0 properties
duration

ISO 8601 duration string.

0 properties
units

Unit of measure label (e.g. KWH, KW, STRING, DEGREES).

0 properties
readingType

Reading type qualifier (e.g. DIRECT_READ for real-time meter data). See OpenADR 3.1.0 Definitions for standardised values.

0 properties