B.2 IEEE 2030.5 package

‌B.2 IEEE 2030.5 package‌

B.2.1 Introduction

The IEEE 2030.5 model is organized into function sets, represented by sub-packages. However, all structures are defined inside a single namespace.

class Version Information IEEE 2030.5

tags

defaultNamespace = urn:ieee:std:2030.5:ns elementFormDefault = qualified

schemaLocation = sep.xsd

targetNamespace = urn:ieee:std:2030.5:ns trace_id =

version = 2.1.0

Figure B.1—Version information

B.2.2 DeviceCapability package

Contains definition of the objects used to convey the resources that are implemented by the publishing host.

class DeviceCapability

DeviceCapability

class DeviceCapability

DeviceCapability

class DeviceCapability

DeviceCapability

ListLink

EndDeviceListLink

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

0..1

ListLink

MirrorUsagePointListLink

ListLink

MirrorUsagePointListLink

ListLink

MirrorUsagePointListLink

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

Making DeviceCapability

inherit from FunctionSetAssignments allows those group

resources to be published with or without use of FunctionSetAssignments.

Making DeviceCapability

inherit from FunctionSetAssignments allows those group

resources to be published with or without use of FunctionSetAssignments.

Making DeviceCapability

inherit from FunctionSetAssignments allows those group

resources to be published with or without use of FunctionSetAssignments.

Link

«XSDattribute»

::Resource

+ href: anyURI [0..1]

«XSDattribute»

::Resource

+ href: anyURI [0..1]

«XSDattribute»

::Resource

+ href: anyURI [0..1]

SelfDeviceLink

Figure B.2—DeviceCapability DeviceCapability object (FunctionSetAssignmentsBase)

Returned by the URI provided by DNS-SD, to allow clients to find the URIs to the resources in which they are interested.

pollRate attribute (UInt32) [0..1] «XSDattribute»

The default polling rate for this function set (this resource and all resources below), in seconds. If not specified, a default of 900 seconds (15 minutes) is used. It is RECOMMENDED that a client poll the resources of this function set every pollRate seconds.

B.2.3 Common package

B.2.3.1 Introduction

This package contains objects that are used in multiple function sets.

B.2.3.2 Identification package

Contains super-classes that define the attributes common to categories of objects.

class Identification

Resource

List

Link

ListLink

«XSDattribute»

+ href: anyURI [0..1]

«XSDattribute»

+ href: anyURI [0..1]

«XSDattribute»

+ href: anyURI [0..1]

«XSDattribute»

+ all: UInt32

+ results: UInt32

«XSDattribute»

+ all: UInt32

+ results: UInt32

«XSDattribute»

+ all: UInt32

+ results: UInt32

«XSDattribute»

+ href: anyURI

«XSDattribute»

+ href: anyURI

«XSDattribute»

+ href: anyURI

«XSDattribute»

+ all: UInt32 [0..1]

«XSDattribute»

+ all: UInt32 [0..1]

«XSDattribute»

+ all: UInt32 [0..1]

IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

SubscribableIdentifiedObject

SubscribableList

RespondableIdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

+ all: UInt32

+ results: UInt32

«XSDattribute»

+ all: UInt32

+ results: UInt32

«XSDattribute»

+ all: UInt32

+ results: UInt32

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

RespondableSubscribableIdentifiedObject

«XSDattribute»

+ replyTo: anyURI [0..1]

+ responseRequired: HexBinary8 [0..1] = 00

«XSDattribute»

+ replyTo: anyURI [0..1]

+ responseRequired: HexBinary8 [0..1] = 00

«XSDattribute»

+ replyTo: anyURI [0..1]

+ responseRequired: HexBinary8 [0..1] = 00

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

RespondableResource

SubscribableResource

Figure B.3—Identification IdentifiedObject object (Resource)

This is a root class to provide common naming attributes for all classes needing naming attributes.

description attribute (String32) [0..1]

The description is a human-readable text describing or naming the object.

mRID attribute (mRIDType)

The global identifier of the object.

version attribute (VersionType) [0..1]

Contains the version number of the object. See the type definition for details.

Link object ()

Links provide a reference, via URI, to another resource.

href attribute (anyURI) «XSDattribute»

A URI reference.

List Object (Resource)

Container to hold a collection of object instances or references. See Clause 4 (design pattern) for additional details.

all attribute (UInt32) «XSDattribute»

The number specifying “all” of the items in the list. Required on a response to a GET, ignored otherwise.

results attribute (UInt32) «XSDattribute»

Indicates the number of items in this page of results.

ListLink Object (Link)

ListLinks provide a reference, via URI, to a List.

all attribute (UInt32) [0..1] «XSDattribute»

Indicates the total number of items in the referenced list. This attribute SHALL be present if the href is a local or relative URI. This attribute SHOULD NOT be present if the href is a remote or absolute URI, as the server may be unaware of changes to the value.

Resource object ()

A resource is an addressable unit of information, either a collection (List) or instance of an object (identifiedObject, or simply, Resource).

href attribute (anyURI) [0..1] «XSDattribute»

A reference to the resource address (URI). Required in a response to a GET, ignored otherwise.

RespondableIdentifiedObject object (RespondableResource)

An IdentifiedObject to which a Response can be requested.

description attribute (String32) [0..1]

The description is a human-readable text describing or naming the object.

mRID attribute (mRIDType)

The global identifier of the object.

version attribute (VersionType) [0..1]

Contains the version number of the object. See the type definition for details.

RespondableResource object (Resource)

A Resource to which a Response can be requested.

replyTo attribute (anyURI) [0..1] «XSDattribute»

A reference to the response resource address (URI). Required on a response to a GET if responseRequired is “true.”

responseRequired attribute (HexBinary8) [0..1] «XSDattribute»

Indicates whether or not a response is required upon receipt, creation, or update of this resource. Responses shall be posted to the collection specified in “replyTo.”

If the resource has a deviceCategory field, devices that match one or more of the device types indicated in deviceCategory SHALL respond according to the rules listed below. If the category does not match, the device SHALL NOT respond. If the resource does not have a deviceCategory field, a device receiving the resource SHALL respond according to the rules listed below.

Value encoded as hex according to the following bit assignments, any combination is possible. See Table 27 for the list of appropriate response status codes to be sent for these purposes.

 0 = End device shall indicate that message was received

 1 = End device shall indicate specific response

 2 = End user/customer response is required All other values reserved.

RespondableSubscribableIdentifiedObject object (RespondableResource)

An IdentifiedObject to which a Response can be requested.

description attribute (String32) [0..1]

The description is a human-readable text describing or naming the object.

mRID attribute (mRIDType)

The global identifier of the object.

subscribable attribute (SubscribableType) [0..1] «XSDattribute»

Indicates whether or not subscriptions are supported for this resource, and whether or not conditional (thresholds) are supported. If not specified, is “not subscribable” (0).

version attribute (VersionType) [0..1]

Contains the version number of the object. See the type definition for details.

SubscribableIdentifiedObject object (SubscribableResource)

An IdentifiedObject to which a Subscription can be requested.

description attribute (String32) [0..1]

The description is a human-readable text describing or naming the object.

mRID attribute (mRIDType)

The global identifier of the object.

version attribute (VersionType) [0..1]

Contains the version number of the object. See the type definition for details.

SubscribableList object (SubscribableResource)

A List to which a Subscription can be requested.

all attribute (UInt32) «XSDattribute»

The number specifying “all” of the items in the list. Required on GET, ignored otherwise.

results attribute (UInt32) «XSDattribute»

Indicates the number of items in this page of results.

SubscribableResource object (Resource)

A Resource to which a Subscription can be requested.

subscribable attribute (SubscribableType) [0..1] «XSDattribute»

Indicates whether or not subscriptions are supported for this resource, and whether or not conditional (thresholds) are supported. If not specified, is “not subscribable” (0).

B.2.3.3 Objects package

Contains definitions of objects used by multiple function sets.

class Events

RespondableResource

RespondableSubscribableIdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

RespondableResource

RespondableSubscribableIdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

RespondableResource

RespondableSubscribableIdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

EventStatus

RandomizableEvent

Event

+ currentStatus: UInt8

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

+ creationTime: TimeType

+ interval: DateTimeInterval

+ creationTime: TimeType

+ interval: DateTimeInterval

+ creationTime: TimeType

+ interval: DateTimeInterval

+ dateTime: TimeType

+ potentiallySuperseded: boolean

+ potentiallySupersededTime: TimeType [0..1]

+ reason: String192 [0..1]

+ potentiallySuperseded: boolean

+ potentiallySupersededTime: TimeType [0..1]

+ reason: String192 [0..1]

+ potentiallySuperseded: boolean

+ potentiallySupersededTime: TimeType [0..1]

+ reason: String192 [0..1]

TimeTariffInterval

DERControl

TextMessage

+ touTier: TOUType

+ deviceCategory: DeviceCategoryType [0..1]

+ originator: String20 [0..1]

+ priority: PriorityType

+ textMessage: string

+ originator: String20 [0..1]

+ priority: PriorityType

+ textMessage: string

+ originator: String20 [0..1]

+ priority: PriorityType

+ textMessage: string

EndDeviceControl

+ deviceCategory: DeviceCategoryType

+ drProgramMandatory: boolean

+ loadShiftForward: boolean

+ overrideDuration: UInt16 [0..1] = 0

EndDeviceControl

+ deviceCategory: DeviceCategoryType

+ drProgramMandatory: boolean

+ loadShiftForward: boolean

+ overrideDuration: UInt16 [0..1] = 0

EndDeviceControl

+ deviceCategory: DeviceCategoryType

+ drProgramMandatory: boolean

+ loadShiftForward: boolean

+ overrideDuration: UInt16 [0..1] = 0

Figure B.4—Events

class Programs

IdentifiedObject

UInt8

DemandResponseProgram PrimacyType

+ availabilityUpdatePercentChangeThreshold: PerCent [0..1] = 0

+ availabilityUpdatePowerChangeThreshold: ActivePower [0..1] = 0

+ primacy: PrimacyType

DemandResponseProgram PrimacyType

+ availabilityUpdatePercentChangeThreshold: PerCent [0..1] = 0

+ availabilityUpdatePowerChangeThreshold: ActivePower [0..1] = 0

+ primacy: PrimacyType

DemandResponseProgram PrimacyType

+ availabilityUpdatePercentChangeThreshold: PerCent [0..1] = 0

+ availabilityUpdatePowerChangeThreshold: ActivePower [0..1] = 0

+ primacy: PrimacyType

IdentifiedObject

TariffProfile

notes

Values possible for indication of "Primary" provider: 0: In home energy management system

1: Contracted premises service provider 2: Non-contractual service provider

3 - 64: Reserved

65 - 191: User-defined

192 - 255: Reserved

notes

Values possible for indication of "Primary" provider: 0: In home energy management system

1: Contracted premises service provider 2: Non-contractual service provider

3 - 64: Reserved

65 - 191: User-defined

192 - 255: Reserved

notes

Values possible for indication of "Primary" provider: 0: In home energy management system

1: Contracted premises service provider 2: Non-contractual service provider

3 - 64: Reserved

65 - 191: User-defined

192 - 255: Reserved

+ currency: CurrencyCode [0..1]

+ pricePowerOfTenMultiplier: PowerOfTenMultiplierType [0..1]

+ primacy: PrimacyType

+ rateCode: String20 [0..1]

+ serviceCategoryKind: ServiceKind

+ currency: CurrencyCode [0..1]

+ pricePowerOfTenMultiplier: PowerOfTenMultiplierType [0..1]

+ primacy: PrimacyType

+ rateCode: String20 [0..1]

+ serviceCategoryKind: ServiceKind

+ currency: CurrencyCode [0..1]

+ pricePowerOfTenMultiplier: PowerOfTenMultiplierType [0..1]

+ primacy: PrimacyType

+ rateCode: String20 [0..1]

+ serviceCategoryKind: ServiceKind

Lower numbers indicate higher priority.

UInt8

PriorityType

Lower numbers indicate higher priority.

UInt8

PriorityType

Lower numbers indicate higher priority.

UInt8

PriorityType

SubscribableIdentifiedObject

MessagingProgram

SubscribableIdentifiedObject

MessagingProgram

SubscribableIdentifiedObject

MessagingProgram

locale: LocaleType

primacy: PrimacyType

locale: LocaleType

primacy: PrimacyType

locale: LocaleType

primacy: PrimacyType

Event

TextMessage

SubscribableIdentifiedObject

DERProgram

SubscribableIdentifiedObject

DERProgram

SubscribableIdentifiedObject

DERProgram

+ originator: String20 [0..1]

+ priority: PriorityType

+ textMessage: string

+ originator: String20 [0..1]

+ priority: PriorityType

+ textMessage: string

+ originator: String20 [0..1]

+ priority: PriorityType

+ textMessage: string

notes

Indicates the priority of a message:

0 - Low

1 - Normal

2 - High

3 - Critical

All other values reserved.

notes

Indicates the priority of a message:

0 - Low

1 - Normal

2 - High

3 - Critical

All other values reserved.

notes

Indicates the priority of a message:

0 - Low

1 - Normal

2 - High

3 - Critical

All other values reserved.

+ primacy: PrimacyType

Figure B.5—Programs

class Error

reasonCode

Code indicating the reason for failure.

0 - Invalid request format

1 - Invalid request values (e.g. invalid threshold values)

2 - Resource limit reached

3 - Conditional subscription field not supported

4 - Maximum request frequency exceeded All other values reserved

reasonCode

Code indicating the reason for failure.

0 - Invalid request format

1 - Invalid request values (e.g. invalid threshold values)

2 - Resource limit reached

3 - Conditional subscription field not supported

4 - Maximum request frequency exceeded All other values reserved

reasonCode

Code indicating the reason for failure.

0 - Invalid request format

1 - Invalid request values (e.g. invalid threshold values)

2 - Resource limit reached

3 - Conditional subscription field not supported

4 - Maximum request frequency exceeded All other values reserved

+ maxRetryDuration: UInt16 [0..1]

+ reasonCode: UInt16

+ maxRetryDuration: UInt16 [0..1]

+ reasonCode: UInt16

+ maxRetryDuration: UInt16 [0..1]

+ reasonCode: UInt16

Error

Figure B.6—Error

Error object ()

Contains information about the nature of an error if a request could not be completed successfully.

maxRetryDuration attribute (UInt16) [0..1]

Contains the number of seconds the client SHOULD wait before retrying the request.

reasonCode attribute (UInt16)

Code indicating the reason for failure.

 0 = Invalid request format

 1 = Invalid request values (e.g., invalid threshold values)

 2 = Resource limit reached

 3 = Conditional Subscription field not supported

 4 = Maximum request frequency exceeded All other values reserved.

Event object (RespondableSubscribableIdentifiedObject)

An Event indicates information that applies to a particular period of time. Events SHALL be executed relative to the time of the server, as described in the Time function set, 9.2.

creationTime attribute (TimeType)

The time at which the Event was created.

interval attribute (DateTimeInterval)

The period during which the Event applies.

EventStatus object ()

Current status information relevant to a specific object. The Status object is used to indicate the current status of an Event. Devices can read the containing resource (e.g., TextMessage) to get the most up-to-date status of the event. Devices can also subscribe to a specific resource instance to get updates when any of its attributes change, including the Status object.

currentStatus attribute (UInt8)

Field representing the current status type.

0 = Scheduled

This status indicates that the event has been scheduled and the event has not yet started. The server SHALL set the event to this status when the event is first scheduled and persist until the event has become active or has been cancelled. For events with a start time less than or equal to the current time, this status SHALL never be indicated, the event SHALL start with a status of “Active.”

1 = Active

This status indicates that the event is currently active. The server SHALL set the event to this status when the event reaches its earliest Effective Start Time.

2 = Cancelled

When events are cancelled, the Status.dateTime attribute SHALL be set to the time the cancellation occurred, which cannot be in the future. The server is responsible for maintaining the cancelled event in its collection for the duration of the original event, or until the server has run out of space and needs to store a new event. Client devices SHALL be aware of Cancelled events, determine if the Cancelled event applies to them, and cancel the event immediately if applicable.

3 = Cancelled with Randomization

The server is responsible for maintaining the cancelled event in its collection for the duration of the Effective Scheduled Period. Client devices SHALL be aware of Cancelled with Randomization events, determine if the Cancelled event applies to them, and cancel the event immediately, using the larger of (absolute value of randomizeStart) and (absolute value of randomizeDuration) as the end randomization, in seconds. This Status.type SHALL NOT be used with “regular” Events, only with specializations of RandomizableEvent.

4 = Superseded

Events marked as Superseded by servers are events that may have been replaced by new events from the same program that targets the exact same set of deviceCategory’s (if applicable) and DERControl controls (e.g., opModTargetW) (if applicable), and overlap for a given period of time. Servers SHALL mark an event as Superseded at the earliest Effective Start Time of the overlapping event. Servers are responsible for maintaining the Superseded event in their collection for the duration of the Effective Scheduled Period.

Client devices encountering a Superseded event SHALL terminate execution of the event immediately and commence execution of the new event immediately, unless the current time is within the start randomization window of the superseded event, in which case the client SHALL obey the start randomization of the new event. This Status.type SHALL NOT be used with TextMessage, since multiple text messages can be active.

All other values reserved.

dateTime attribute (TimeType)

The dateTime attribute will provide a timestamp of when the current status was defined. dateTime MUST be set to the time at which the status change occurred, not a time in the future or past.

potentiallySuperseded attribute (boolean)

Set to true by a server of this event if there are events that overlap this event in time and also overlap in some, but not all, deviceCategory’s (if applicable) and DERControl controls (e.g., opModTargetW) (if applicable) in the same function set instance.

potentiallySupersededTime attribute (TimeType) [0..1]

Indicates the time that the potentiallySuperseded flag was set.

reason attribute (String192) [0..1]

The Reason attribute allows a Service provider to provide a textual explanation of the status.

RandomizableEvent object (Event)

An Event that can indicate time ranges over which the start time and duration SHALL be randomized.

randomizeDuration attribute (OneHourRangeType) [0..1]

Number of seconds boundary inside which a random value must be selected to be applied to the associated interval duration, to avoid sudden synchronized demand changes. If related to price level changes, sign may be ignored. Valid range is −3600 to 3600. If not specified, 0 is the default.

randomizeStart attribute (OneHourRangeType) [0..1]

Number of seconds boundary inside which a random value must be selected to be applied to the associated interval start time, to avoid sudden synchronized demand changes. If related to price level changes, sign may be ignored. Valid range is −3600 to 3600. If not specified, 0 is the default.

B.2.3.4 Types package

Contains definitions of reusable data types.

class Types

UnitType

unsignedByte

«XSDsimple...

UInt8

unsignedByte

«XSDsimple...

UInt8

unsignedByte

«XSDsimple...

UInt8

byte

«XSDsimpleType»

SubscribableType

«XSDsimpleType»

SubscribableType

«XSDsimpleType»

SubscribableType

«XSDsimple...

Int8

«XSDsimple...

Int8

«XSDsimple...

Int8

PowerOfTenMultiplierType

PriorityType

PerCent

UomType

unsignedShort

short

SignedPerCent

KindType

«XSDsimple...

UInt16

«XSDsimple...

UInt16

«XSDsimple...

UInt16

CurrencyCode

«XSDsimple...

Int16

«XSDsimple...

Int16

«XSDsimple...

Int16

OneHourRangeType

AccumulationBehaviourType

VersionType

DataQualifierType

unsignedInt

int

«XSDsimple...

UInt32 PINType

«XSDsimple...

UInt32 PINType

«XSDsimple...

UInt32 PINType

«XSDsimple...

Int32

«XSDsimple...

Int32

«XSDsimple...

Int32

TimeOffsetType

FlowDirectionType

ConsumptionBlockType PENType

FlowDirectionType

ConsumptionBlockType PENType

FlowDirectionType

ConsumptionBlockType PENType

TOUType

unsignedLong

«XSDsimple...

UInt40

unsignedLong

«XSDsimple...

UInt40

unsignedLong

«XSDsimple...

UInt40

SFDIType

long

«XSDsimple...

Int64

long

«XSDsimple...

Int64

long

«XSDsimple...

Int64

TimeType

CommodityType

PhaseCode

CommodityType

PhaseCode

CommodityType

PhaseCode

hexBinary

«XSDsimple...

HexBinary16

hexBinary

«XSDsimple...

HexBinary16

hexBinary

«XSDsimple...

HexBinary16

RoleFlagsType

ServiceKind

DERControlType

ChargeKind

hexBinary

string

DERType

«XSDsimple...

HexBinary32

«XSDsimple...

HexBinary32

«XSDsimple...

HexBinary32

DeviceCategoryType

«XSDsimple...

String42

«XSDsimple...

String42

«XSDsimple...

String42

LocaleType

DstRuleType

DERCurveType

hexBinary

ApplianceLoadReductionType

«XSDsimple...

HexBinary128

«XSDsimple...

HexBinary128

«XSDsimple...

HexBinary128

mRIDType

Figure B.7—Types

AccumulationBehaviourType object (UInt8)

0 = Not Applicable (default, if not specified) 3 = Cumulative

The sum of the previous billing period values. Note: “Cumulative” is commonly used in conjunction with “demand.” Each demand reset causes the maximum demand value for the present billing period (since the last demand reset) to accumulate as an accumulative total of all maximum demands. So instead of “zeroing” the demand register, a demand reset has the affect of adding the present maximum demand to this accumulating total.

4 = DeltaData

The difference between the value at the end of the prescribed interval and the beginning of the interval. This is used for incremental interval data.

Note: One common application would be for load profile data; another use might be to report the number of events within an interval (such as the number of equipment energizations within the specified period of time).

6 = Indicating

As if a needle is swung out on the meter face to a value to indicate the current value. (Note: An “indicating” value is typically measured over hundreds of milliseconds or greater, or may imply a “pusher” mechanism to capture a value. Compare this to “instantaneous” which is measured over a shorter period of time.)

9 = Summation

A form of accumulation which is selective with respect to time.

NOTE—“Summation” could be considered a specialization of “Bulk Quantity” according to the rules of inheritance where “Summation” selectively accumulates pulses over a timing pattern, and “BulkQuantity” accumulates pulses all of the time.

12 = Instantaneous

Typically measured over the fastest period of time allowed by the definition of the metric (usually milliseconds or tens of milliseconds). (Note: “Instantaneous” was moved to attribute #3 in 61968-9Ed2 from attribute #1 in 61968-9Ed1.)

All other values reserved.

ApplianceLoadReductionType object (UInt8)

0 = Delay Appliance Load

Parameter requesting the appliance to respond by providing a moderate load reduction for the duration of a delay period. Typically referring to a “non-emergency” event in which appliances can continue operating if already in a load-consuming period.

1 = Temporary appliance load reduction

Parameter requesting the appliance to respond by providing an aggressive load reduction for a short time period. Typically referring to an “emergency/spinning reserve” event in which an appliance should start shedding load if currently in a load-consuming period.

Full definition of how appliances react when receiving each parameter is document in the EPA document, ENERGY STAR® Program Requirements, Product Specification for Residential Refrigerators and Freezers, Eligibility Criteria 5, Draft 2 Version 5.0.

All other values reserved.

CommodityType object (UInt8)

0 = Not applicable (default, if not specified)

1 = Electricity secondary metered value (a premises meter is typically on the low voltage, or secondary, side of a service transformer)

2 = Electricity primary metered value (measured on the high voltage, or primary, side of the service transformer)

4 = Air

7 = NaturalGas

8 = Propane

9 = PotableWater

10 = Steam

11 = WasteWater

12 = HeatingFluid

13 = CoolingFluid

All other values reserved.

ConsumptionBlockType object (UInt8)

0 = Not Applicable (default, if not specified)

1 = Block 1

2 = Block 2

3 = Block 3

4 = Block 4

5 = Block 5

6 = Block 6

7 = Block 7

8 = Block 8

9 = Block 9

10 = Block 10

11 = Block 11

12 = Block 12

13 = Block 13

14 = Block 14

15 = Block 15

16 = Block 16

All other values reserved.

CurrencyCode object (UInt16)

Follows codes defined in ISO 4217.

0 = Not applicable (default, if not specified) 36 = Australian dollar

124 = Canadian dollar 840 = U.S. dollar

978 = Euro

This is not a complete list.

DataQualifierType object (UInt8)

0 = Not applicable (default, if not specified) 2 = Average

8 = Maximum

9 = Minimum

12 = Normal

29 = Standard deviation of a population (typically indicated by a lower case sigma)

30 = Standard deviation of a sample drawn from a population (typically indicated by a lower case “s”) All other values reserved.

DateTimeInterval object «Compound» ()

Interval of date and time.

duration attribute (UInt32)

Duration of the interval, in seconds.

start attribute (TimeType)

Date and time of the start of the interval.

DeviceCategoryType object (HexBinary32)

The Device category types defined.

Bit positions SHALL be defined as follows:

0 = Programmable communicating thermostat

1 = Strip heaters

2 = Baseboard heaters

3 = Water heater

4 = Pool pump

5 = Sauna

6 = Hot tub

7 = Smart appliance

8 = Irrigation pump

9 = Managed commercial and industrial (C&I) loads

10 = Simple misc. (residential on/off) loads

11 = Exterior lighting

12 = Interior lighting

13 = Load control switch

14 = Energy management system

15 = Smart energy module

16 = Electric vehicle

17 = Electric vehicle supply equipment (EVSE)

18 = Virtual or mixed DER

19 = Reciprocating engine

20 = Fuel cell

21 = Photovoltaic system

22 = Combined heat and power

23 = Combined PV and storage

24 = Other generation system

25 = Other storage system All other values reserved.

DstRuleType object (HexBinary32)

Bit map encoded rule from which is calculated the start or end time, within the current year, to which daylight savings time offset must be applied.

The rule encoding:

Bits 0 to 11: seconds 0 to 3599

Bits 12 to 16: hours 0 to 23

Bits 17 to 19: day of the week 0 = not applicable, 1 to 7 (Monday = 1)

Bits 20 to 24: day of the month 0 = not applicable, 1 to 31 Bits 25 to 27: operator (detailed below)

Bits 28 to 31: month 1 to 12

Rule value of 0xFFFFFFFF means rule processing/DST correction is disabled. The operators:

0: DST starts/ends on the Day of the Month

1: DST starts/ends on the Day of the Week that is on or after the Day of the Month 2: DST starts/ends on the first occurrence of the Day of the Week in a month

3: DST starts/ends on the second occurrence of the Day of the Week in a month 4: DST starts/ends on the third occurrence of the Day of the Week in a month 5: DST starts/ends on the forth occurrence of the Day of the Week in a month 6: DST starts/ends on the fifth occurrence of the Day of the Week in a month

7: DST starts/ends on the last occurrence of the Day of the Week in a month

An example: DST starts on the third Friday in March at 1:45 AM. The rule... Seconds: 2700

Hours: 1

Day of week: 5 Day of month: 0 Operator: 4

Month: 3

FlowDirectionType object (UInt8)

0 = Not applicable (default, if not specified)

1 = Forward (delivered to customer) 19 = Reverse (received from customer) All other values reserved.

GPSLocationType object «Compound» ()

Specifies a GPS location, expressed in WGS 84 coordinates.

lat attribute (String32)

Specifies the latitude from equator. −90 (south) to +90 (north) in decimal degrees.

lon attribute (String32)

Specifies the longitude from Greenwich Meridian. −180 (west) to +180 (east) in decimal degrees.

KindType object (UInt8)

0 = Not applicable (default, if not specified) 3 = Currency

8 = Demand

12 = Energy

37 = Power

All other values reserved.

LocaleType object (String42)

IETF RFC 4646 identifier of a language-region.

mRIDType object (HexBinary128)

A master resource identifier. The IANA Private Enterprise Number (PEN) provider ID SHALL be specified in bits 0 to 31, the least-significant bits, and objects created by that provider SHALL be assigned unique IDs with the remaining 96 bits.

0xFFFFFFFFFFFFFFFFFFFFFFFF[XXXXXXXX], where [XXXXXXXX] is the PEN, is reserved for a object that is being created (e.g., a ReadingSet for the current time that is still accumulating).

Except for this special reserved identifier, each modification of an object (resource) representation MUST have a different “version.”

OneHourRangeType object (Int16)

A signed time offset, typically applied to a Time value, expressed in seconds, with range −3600 to 3600.

PENType object (UInt32)

IANA Private Enterprise Number (PEN).

PerCent object (UInt16)

Used for percentages, specified in hundredths of a percent, 0 to 10 000. (10 000 = 100%)

PhaseCode object (UInt8)

0 = Not applicable (default, if not specified)

32 = Phase C (and S2)

33 = Phase CN (and S2N) 40 = Phase CA

64 = Phase B

65 = Phase BN

66 = Phase BC

128 = Phase A (and S1)

129 = Phase AN (and S1N) 132 = Phase AB

224 = Phase ABC

All other values reserved.

PINType object (UInt32)

Six digit unsigned decimal integer (0 to 999999).

(Note that this only requires 20 bits, if it can be allocated.)

PowerOfTenMultiplierType object (Int8)

−9 = Nano 109

−6 = Micro 106

−3 = Milli 103

0 = None = 1 (default, if not specified)

1 = Deca 10

2 = Hecto 100

3 = Kilo 1000

6 = Mega 106

9 = Giga 109

This is not a complete list. Any integer between −9 and 9 SHALL be supported, indicating the power of ten multiplier for the units.

PrimacyType object (UInt8)

Values possible for indication of “Primary” provider:

0 = In-home energy management system

1 = Contracted premises service provider

2 = Non-contractual service provider

3 to 64 -= Reserved

65 to 191 = User-defined

192 to 255 = Reserved

Lower numbers indicate higher priority.

RealEnergy object ()

Real electrical energy.

multiplier attribute (PowerOfTenMultiplierType)

Multiplier for “unit.”

value attribute (UInt48)

Value of the energy in watt-hours (uom 72).

RoleFlagsType object (HexBinary16)

Specifies the roles that apply to a usage point.

Bit 0—isMirror—SHALL be set if the server is not the measurement device

Bit 1—isPremisesAggregationPoint—SHALL be set if the UsagePoint is the point of delivery for a premises

Bit 2—isPEV—SHALL be set if the usage applies to an electric vehicle

Bit 3—isDER—SHALL be set if the usage applies to a distributed energy resource, capable of delivering power to the grid

Bit 4—isRevenueQuality—SHALL be set if usage was measured by a device certified as revenue quality Bit 5—isDC—SHALL be set if the usage point measures direct current

Bit 6—isSubmeter—SHALL be set if the usage point is not a premises aggregation point Bit 7 to 15—Reserved

ServiceKind object (UInt8)

Service kind:

0 = Electricity

1 = Gas

2 = Water

3 = Time

4 = Pressure

5 = Heat

6 = Cooling

All other values reserved.

SFDIType object (UInt40)

Unsigned integer, maximum inclusive 687194767359, which is 236 1 (68 719 476 735), with added check digit. See 8.4.2 for check digit calculation.

SignedPerCent object (Int16)

Used for signed percentages, specified in hundredths of a percent, −10 000 to 10 000. (10 000 = 100%)

SignedRealEnergy object ()

Real electrical energy, signed.

multiplier attribute (PowerOfTenMultiplierType)

Multiplier for “unit.”

value attribute (Int48)

Value of the energy in watt-hours (uom 72).

SubscribableType object «XSDsimpleType» (UInt8)

The subscribable values.

0 = Resource does not support subscriptions

1 = Resource supports non-conditional subscriptions

2 = Resource supports conditional subscriptions

3 = Resource supports both conditional and non-conditional subscriptions All other values reserved.

TimeOffsetType object (Int32)

A signed time offset, typically applied to a Time value, expressed in seconds.

TimeType object (Int64)

Time is a signed 64-bit value representing the number of seconds since 0 hours, 0 minutes, 0 seconds, on 1 January 1970, in UTC, not counting leap seconds.

TOUType object (UInt8)

0 = Not applicable (default, if not specified)

1 = TOU A

2 = TOU B

3 = TOU C

4 = TOU D

5 = TOU E

6 = TOU F

7 = TOU G

8 = TOU H

9 = TOU I

10 = TOU J

11 = TOU K

12 = TOU L

13 = TOU M

14 = TOU N

15 = TOU O

All other values reserved.

UnitType object (UInt8)

The unit types defined for end device control target reductions.

0 = kWh

1 = kW

2 = Watts

3 = Cubic meters

4 = Cubic feet

5 = U.S. gallons

6 = Imperial gallons

7 = British thermal units (BTUs)

8 = Liters

9 = kPA (gauge)

10 = kPA (absolute)

11 = Megajoule

12 = Unitless

All other values reserved.

UnitValueType object ()

Type for specification of a specific value, with units and power of ten multiplier.

multiplier attribute (PowerOfTenMultiplierType)

Multiplier for “unit.”

unit attribute (UomType)

Unit in symbol.

value attribute (Int32)

Value in units specified.

UomType object (UInt8)

The following values are recommended values sourced from the unit of measure enumeration in IEC 61968-9. Other values from the unit of measure enumeration in IEC 61968-9 MAY be used.

0 = Not applicable (default, if not specified)

5 = A (current in amperes [rms])

6 = Kelvin (temperature)

23 = Degrees Celsius (relative temperature) 29 = Voltage

31 = J (energy joule) 33 = Hz (frequency)

38 = W (real power in watts) 42 = m3 (cubic meter)

61 = VA (apparent power) 63 = var (reactive power)

65 = CosTheta (displacement power factor) 67 = V2 (volts squared)

69 = A2 (amp squared)

71 = VAh (apparent energy)

72 = Wh (real energy in watt-hours)

73 = varh (reactive energy)

106 = Ah (ampere-hours/available charge) 119 = ft3 (cubic feet)

122 = ft3/h (cubic feet per hour)

125 = m3/h (cubic meter per hour)

128 = U.S. gallons

129 = U.S. gal/h (U.S. gallons per hour)

130 = Imperial gallons

131 = IMP gal/h (Imperial gallons per hour)

132 = BTU

133 = BTU/h

134 = Liter

137 = L/h (liters per hour) 140 = PA (gauge)

155 = PA (absolute) 169 = Therm

VersionType object (UInt16)

Version SHALL indicate a distinct identifier for each revision of an IdentifiedObject. If not specified, a default version of “0” (initial version) SHALL be assumed. Upon modification of any IdentifiedObject, the mRID SHALL remain the same, but the version SHALL be incremented. Servers MAY NOT modify objects that they did not create, unless they were notified of the change from the entity controlling the object’s PEN.

B.2.3.5 Primitive types package

Contains definitions of primitive data types based on XML Schema primitives.

class Primitive Types

unsignedByte

«XSDsimple...

UInt8

class Primitive Types

unsignedByte

«XSDsimple...

UInt8

class Primitive Types

unsignedByte

«XSDsimple...

UInt8

unsignedShort

«XSDsimple...

UInt16

unsignedShort

«XSDsimple...

UInt16

unsignedShort

«XSDsimple...

UInt16

unsignedInt

«XSDsimple...

UInt32

unsignedInt

«XSDsimple...

UInt32

unsignedInt

«XSDsimple...

UInt32

unsignedLong

«XSDsimple...

UInt40

unsignedLong

«XSDsimple...

UInt40

unsignedLong

«XSDsimple...

UInt40

unsignedLong

«XSDsimple...

UInt48

unsignedLong

«XSDsimple...

UInt48

unsignedLong

«XSDsimple...

UInt48

unsignedLong

«XSDsimple...

UInt64

unsignedLong

«XSDsimple...

UInt64

unsignedLong

«XSDsimple...

UInt64

byte

«XSDsimple...

Int8

byte

«XSDsimple...

Int8

byte

«XSDsimple...

Int8

short

«XSDsimple...

Int16

short

«XSDsimple...

Int16

short

«XSDsimple...

Int16

int

«XSDsimple...

Int32

int

«XSDsimple...

Int32

int

«XSDsimple...

Int32

long

«XSDsimple...

Int48

long

«XSDsimple...

Int48

long

«XSDsimple...

Int48

long

«XSDsimple...

Int64

long

«XSDsimple...

Int64

long

«XSDsimple...

Int64

string

«XSDsimple...

String6

string

«XSDsimple...

String6

string

«XSDsimple...

String6

string

«XSDsimple...

String20

string

«XSDsimple...

String20

string

«XSDsimple...

String20

string

«XSDsimple...

String16

string

«XSDsimple...

String16

string

«XSDsimple...

String16

string

«XSDsimple...

String32

string

«XSDsimple...

String32

string

«XSDsimple...

String32

string

«XSDsimple...

String42

string

«XSDsimple...

String42

string

«XSDsimple...

String42

string

«XSDsimple...

String192

string

«XSDsimple...

String192

string

«XSDsimple...

String192

hexBinary

«XSDsimple...

HexBinary8

hexBinary

«XSDsimple...

HexBinary8

hexBinary

«XSDsimple...

HexBinary8

hexBinary

«XSDsimple...

HexBinary16

hexBinary

«XSDsimple...

HexBinary16

hexBinary

«XSDsimple...

HexBinary16

hexBinary

«XSDsimple...

HexBinary32

hexBinary

«XSDsimple...

HexBinary32

hexBinary

«XSDsimple...

HexBinary32

hexBinary

«XSDsimple...

HexBinary48

hexBinary

«XSDsimple...

HexBinary48

hexBinary

«XSDsimple...

HexBinary48

hexBinary

«XSDsimple...

HexBinary64

hexBinary

«XSDsimple...

HexBinary64

hexBinary

«XSDsimple...

HexBinary64

hexBinary

«XSDsimple...

HexBinary128

hexBinary

«XSDsimple...

HexBinary128

hexBinary

«XSDsimple...

HexBinary128

hexBinary

«XSDsimple...

HexBinary160

hexBinary

«XSDsimple...

HexBinary160

hexBinary

«XSDsimple...

HexBinary160

Figure B.8—Primitive types

HexBinary8 object «XSDsimpleType» (hexBinary)

An 8-bit field encoded as a hex string (2 hex characters). Where applicable, bit 0, or the least significant bit, goes on the right. Note that hexBinary requires pairs of hex characters, so an odd number of characters requires a leading “0”.

HexBinary16 object «XSDsimpleType» (hexBinary)

A 16-bit field encoded as a hex string (4 hex characters maximum). Where applicable, bit 0, or the least significant bit, goes on the right. Note that hexBinary requires pairs of hex characters, so an odd number of characters requires a leading “0”.

HexBinary32 object «XSDsimpleType» (hexBinary)

A 32-bit field encoded as a hex string (8 hex characters maximum). Where applicable, bit 0, or the least significant bit, goes on the right. Note that hexBinary requires pairs of hex characters, so an odd number of characters requires a leading “0”.

HexBinary48 object «XSDsimpleType» (hexBinary)

A 48-bit field encoded as a hex string (12 hex characters maximum). Where applicable, bit 0, or the least significant bit, goes on the right. Note that hexBinary requires pairs of hex characters, so an odd number of characters requires a leading “0”.

HexBinary64 object «XSDsimpleType» (hexBinary)

A 64-bit field encoded as a hex string (16 hex characters maximum). Where applicable, bit 0, or the least significant bit, goes on the right. Note that hexBinary requires pairs of hex characters, so an odd number of characters requires a leading “0”.

HexBinary128 object «XSDsimpleType» (hexBinary)

A 128-bit field encoded as a hex string (32 hex characters maximum). Where applicable, bit 0, or the least significant bit, goes on the right. Note that hexBinary requires pairs of hex characters, so an odd number of characters requires a leading “0”.

HexBinary160 object «XSDsimpleType» (hexBinary)

A 160-bit field encoded as a hex string (40 hex characters maximum). Where applicable, bit 0, or the least significant bit, goes on the right. Note that hexBinary requires pairs of hex characters, so an odd number of characters requires a leading “0”.

String6 object «XSDsimpleType» (string)

Character string of maximum length 6. In order to limit internal storage, implementations SHALL reduce the length of strings using multi-byte characters so that the string may be stored using “maxLength” octets in the given encoding.

String16 object «XSDsimpleType» (string)

Character string of maximum length 16. In order to limit internal storage, implementations SHALL reduce the length of strings using multi-byte characters so that the string may be stored using “maxLength” octets in the given encoding.

String20 object «XSDsimpleType» (string)

Character string of maximum length 20. In order to limit internal storage, implementations SHALL reduce the length of strings using multi-byte characters so that the string may be stored using “maxLength” octets in the given encoding.

String32 object «XSDsimpleType» (string)

Character string of maximum length 32. In order to limit internal storage, implementations SHALL reduce the length of strings using multi-byte characters so that the string may be stored using “maxLength” octets in the given encoding.

String42 object «XSDsimpleType» (string)

Character string of maximum length 42. In order to limit internal storage, implementations SHALL reduce the length of strings using multi-byte characters so that the string may be stored using “maxLength” octets in the given encoding.

String192 object «XSDsimpleType» (string)

Character string of maximum length 192. For all string types, in order to limit internal storage, implementations SHALL reduce the length of strings using multi-byte characters so that the string may be stored using “maxLength” octets in the given encoding.

UInt8 object «XSDsimpleType» (unsignedByte)

Unsigned integer, maximum inclusive 255 ( 28 1 ).

UInt16 object «XSDsimpleType» (unsignedShort)

Unsigned integer, maximum inclusive 65 535 ( 216 1 ).

UInt32 object «XSDsimpleType» (unsignedInt)

Unsigned integer, maximum inclusive 4 294 967 295 ( 232 1 ).

UInt40 object «XSDsimpleType» (unsignedLong)

Unsigned integer, maximum inclusive 1 099 511 627 775 ( 240 1).

UInt48 object «XSDsimpleType» (unsignedLong)

Unsigned integer, maximum inclusive 281 474 976 710 655 ( 248 1 ).

UInt64 object «XSDsimpleType» (unsignedLong)

Unsigned integer, maximum inclusive 18 446 744 073 709 551 615 ( 264 1 ).

Int8 object «XSDsimpleType» (byte)

Signed integer, minimum −128, maximum 127.

Int16 object «XSDsimpleType» (short)

Signed integer, minimum −32 768, maximum 32 767.

Int32 object «XSDsimpleType» (int)

Signed integer, maximum inclusive 2 147 483 647 ( 231 ), minimum inclusive −2 147 483 647 (same as xs:int).

Int48 object «XSDsimpleType» (long)

Signed integer, maximum inclusive 140 737 488 355 328 ( 247 ), minimum inclusive −140 737 488 355 328.

Int64 object «XSDsimpleType» (long)

Signed integer, maximum inclusive 9 223 372 036 854 775 807 ( 263 ), minimum inclusive −9 223 372 036

854 775 808 (same as xs:long).

B.2.4 EndDevice package

class SelfDevice

FunctionSetAssignmentsBase

Link

DeviceCapability

ConfigurationLink

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

Link

DeviceInformationLink

Link

DeviceInformationLink

Link

DeviceInformationLink

0....1

Link

ListLink

FunctionSetAssignmentsListLink

ListLink

FunctionSetAssignmentsListLink

ListLink

FunctionSetAssignmentsListLink

DeviceStatusLink

Link

ListLink

Link

ListLink

IPInterfaceListLink

ListLink

IPInterfaceListLink

ListLink

IPInterfaceListLink

SelfDeviceLink

EndDeviceListLink

RegistrationLink

SelfDevice

SubscribableList

ListLink

LoadShedAvailabilityListLink

ListLink

LoadShedAvailabilityListLink

ListLink

LoadShedAvailabilityListLink

EndDeviceList

SubscriptionListLink

ListLink

LogEventListLink

ListLink

LogEventListLink

ListLink

LogEventListLink

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

ListLink

FlowReservationRequestListLink

ListLink

FlowReservationRequestListLink

ListLink

FlowReservationRequestListLink

0..*

Link

EndDevice

PowerStatusLink

0..1

ListLink

FlowReservationResponseListLink

ListLink

FlowReservationResponseListLink

ListLink

FlowReservationResponseListLink

Link

FileStatusLink

SubscribableResource

ListLink

AbstractDevice

DERListLink

0..1

+ deviceCategory: DeviceCategoryType [0..1]

+ lFDI: HexBinary160 [0..1]

+ sFDI: SFDIType

+ deviceCategory: DeviceCategoryType [0..1]

+ lFDI: HexBinary160 [0..1]

+ sFDI: SFDIType

+ deviceCategory: DeviceCategoryType [0..1]

+ lFDI: HexBinary160 [0..1]

+ sFDI: SFDIType

Figure B.9—SelfDevice

class EndDevice

SubscribableResource

EndDevice

AbstractDevice

+ deviceCategory: DeviceCategoryType [0..1]

+ lFDI: HexBinary160 [0..1]

+ sFDI: SFDIType

AbstractDevice

+ deviceCategory: DeviceCategoryType [0..1]

+ lFDI: HexBinary160 [0..1]

+ sFDI: SFDIType

AbstractDevice

+ deviceCategory: DeviceCategoryType [0..1]

+ lFDI: HexBinary160 [0..1]

+ sFDI: SFDIType

+ changedTime: TimeType

+ enabled: boolean [0..1] = true

+ postRate: UInt32 [0..1]

00...1... 1

+ changedTime: TimeType

+ enabled: boolean [0..1] = true

+ postRate: UInt32 [0..1]

00...1... 1

+ changedTime: TimeType

+ enabled: boolean [0..1] = true

+ postRate: UInt32 [0..1]

00...1... 1

0..1

Link

DeviceStatusLink RegistrationLink

ListLink

FunctionSetAssignmentsListLink

ListLink

FunctionSetAssignmentsListLink

ListLink

FunctionSetAssignmentsListLink

ListLink

SubscriptionListLink

Resource

Registration

SubscribableList

FunctionSetAssignmentsList

SubscribableList

FunctionSetAssignmentsList

SubscribableList

FunctionSetAssignmentsList

List

DeviceStatus

SubscriptionList

+ changedTime: TimeType

+ onCount: UInt16 [0..1]

+ opState: UInt8 [0..1] = 0

+ opTime: UInt32 [0..1]

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ changedTime: TimeType

+ onCount: UInt16 [0..1]

+ opState: UInt8 [0..1] = 0

+ opTime: UInt32 [0..1]

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ changedTime: TimeType

+ onCount: UInt16 [0..1]

+ opState: UInt8 [0..1] = 0

+ opTime: UInt32 [0..1]

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ dateTimeRegistered: TimeType

+ pIN: PINType

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ dateTimeRegistered: TimeType

+ pIN: PINType

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ dateTimeRegistered: TimeType

+ pIN: PINType

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

0..*

FunctionSetAssignments

SubscriptionBase

Subscription

SubscriptionBase

Subscription

SubscriptionBase

Subscription

+ description: String32 [0..1]

+ mRID: mRIDType + encoding: UInt8

+ version: VersionType [0..1] = 0 + level: String16

«XSDattribute» + limit: UInt32

+ subscribable: SubscribableType [0..1] = 0 + notificationURI: anyURI

+ description: String32 [0..1]

+ mRID: mRIDType + encoding: UInt8

+ version: VersionType [0..1] = 0 + level: String16

«XSDattribute» + limit: UInt32

+ subscribable: SubscribableType [0..1] = 0 + notificationURI: anyURI

+ description: String32 [0..1]

+ mRID: mRIDType + encoding: UInt8

+ version: VersionType [0..1] = 0 + level: String16

«XSDattribute» + limit: UInt32

+ subscribable: SubscribableType [0..1] = 0 + notificationURI: anyURI

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

0..1

0..*

subject

The subject of the temperature measurement

0 - Enclosure

1 - Transformer

2 - HeatSink

subject

The subject of the temperature measurement

0 - Enclosure

1 - Transformer

2 - HeatSink

subject

The subject of the temperature measurement

0 - Enclosure

1 - Transformer

2 - HeatSink

0..1

Temperature

+ multiplier: PowerOfTenMultiplierType

+ subject: UInt8

+ value: Int16

Temperature

+ multiplier: PowerOfTenMultiplierType

+ subject: UInt8

+ value: Int16

Temperature

+ multiplier: PowerOfTenMultiplierType

+ subject: UInt8

+ value: Int16

Link

TimeLink

Figure B.10—EndDevice AbstractDevice object (SubscribableResource)

The EndDevice providing the resources available within the DeviceCapabilities.

deviceCategory attribute (DeviceCategoryType) [0..1]

This field is for use in devices that can adjust energy usage (e.g., demand response, distributed energy resources). For devices that do not respond to EndDeviceControls or DERControls (for instance, an energy services interface [ESI]), this field should not have any bits set.

lFDI attribute (HexBinary160) [0..1]

Long form of device identifier. See Clause 6 (security) for additional details.

sFDI attribute (SFDIType)

Short form of device identifier, WITH the checksum digit. See Clause 6 (security) for additional details.

DeviceStatus object (Resource)

Status of device.

changedTime attribute (TimeType)

The time at which the reported values were recorded.

onCount attribute (UInt16) [0..1]

The number of times that the device has been turned on: Count of “device on” times since the last time the counter was reset.

opState attribute (UInt8) [0..1]

Device operational state:

0 = Not applicable/Unknown

1 = Not operating

2 = Operating

3 = Starting up

4 = Shutting down

5 = At disconnect level

6 = kW ramping

7 = kVar ramping

opTime attribute (UInt32) [0..1]

Total time device has operated: re-settable: Accumulated time in seconds since the last time the counter was reset.

pollRate attribute (UInt32) [0..1] «XSDattribute»

EndDevice object (AbstractDevice)

Asset container that performs one or more end device functions. Contains information about individual devices in the network.

changedTime attribute (TimeType)

The time at which this resource was last modified or created.

enabled attribute (boolean) [0..1]

This attribute indicates whether or not an EndDevice is enabled, or registered, on the server. If a server sets this attribute to false, the device is no longer registered. It should be noted that servers can delete EndDevice instances, but using this attribute for some time is more convenient for clients.

postRate attribute (UInt32) [0..1]

POST rate, or how often EndDevice and subordinate resources should be POSTed, in seconds. A client MAY indicate a preferred postRate when POSTing EndDevice. A server MAY add or modify postRate to indicate its preferred posting rate.

EndDeviceList object (SubscribableList)

A List element to hold EndDevice objects.

pollRate attribute (UInt32) [0..1] «XSDattribute»

Registration object (Resource)

Registration represents an authorization to access the resources on a host.

dateTimeRegistered attribute (TimeType)

Contains the time at which this registration was created, by which clients MAY prioritize information providers with the most recent registrations, when no additional direction from the consumer is available.

pIN attribute (PINType)

Contains the registration personal identification number (PIN) associated with the device, including the checksum digit.

pollRate attribute (UInt32) [0..1] «XSDattribute»

SelfDevice object (AbstractDevice)

The EndDevice providing the resources available within the DeviceCapabilities.

pollRate attribute (UInt32) [0..1] «XSDattribute»

Temperature object ()

Specification of a temperature.

multiplier attribute (PowerOfTenMultiplierType)

Multiplier for “unit.”

subject attribute (UInt8)

The subject of the temperature measurement:

0 = Enclosure

1 = Transformer

2 = HeatSink

value attribute (Int16)

Value in degrees Celsius (uom 23).

B.2.5 FunctionSetAssignments package

class FunctionSetAssignments

AbstractDevice

EndDevice

+ changedTime: TimeType

+ enabled: boolean [0..1] = true

+ postRate: UInt32 [0..1]

0..1

AbstractDevice

EndDevice

+ changedTime: TimeType

+ enabled: boolean [0..1] = true

+ postRate: UInt32 [0..1]

0..1

AbstractDevice

EndDevice

+ changedTime: TimeType

+ enabled: boolean [0..1] = true

+ postRate: UInt32 [0..1]

0..1

Link

ListLink

TimeLink

FunctionSetAssignmentsListLink

UsagePointListLink

SubscribableList

FunctionSetAssignmentsList

SubscribableList

FunctionSetAssignmentsList

SubscribableList

FunctionSetAssignmentsList

ListLink

DemandResponseProgramListLink

ListLink

DemandResponseProgramListLink

ListLink

DemandResponseProgramListLink

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

ListLink

DERProgramListLink

0..*

ListLink

TariffProfileListLink

FunctionSetAssignments

CustomerAccountListLink

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

ListLink

MessagingProgramListLink

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

PrepaymentListLink

ListLink

FileListLink

0..1

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

0..1

ResponseSetListLink

Figure B.11—FunctionSetAssignments FunctionSetAssignmentsBase object (Resource)

Defines a collection of function set instances that are to be used by one or more devices as indicated by the EndDevice object(s) of the server.

FunctionSetAssignments object (FunctionSetAssignmentsBase)

Provides an identifiable, subscribable collection of resources for a particular device to consume.

description attribute (String32) [0..1]

The description is a human-readable text describing or naming the object.

mRID attribute (mRIDType)

The global identifier of the object.

subscribable attribute (SubscribableType) [0..1] «XSDattribute»

Indicates whether or not subscriptions are supported for this resource, and whether or not conditional (thresholds) are supported. If not specified, is “not subscribable” (0).

version attribute (VersionType) [0..1]

Contains the version number of the object. See the type definition for details.

FunctionSetAssignmentsList object (SubscribableList)

A List element to hold FunctionSetAssignments objects.

pollRate attribute (UInt32) [0..1] «XSDattribute»

B.2.6 Pub-Sub package

Contains resource definitions used to allow subscriptions and notifications of publications.

AbstractDevice

EndDevice

0..1

ListLink

SubscriptionListLink

class Pub-Sub

0..*

0..1

attributeIdentifier

0 = Reading value 1-255 = Reserved

attributeIdentifier

0 = Reading value 1-255 = Reserved

attributeIdentifier

0 = Reading value 1-255 = Reserved

status

0 = Default Status

1 = Subscription canceled, no additional information

2 = Subscription canceled, resource moved

3 = Subscription canceled, resource definition changed (e.g., a new version of IEEE 2030.5)

4 = Subscription canceled, resource deleted All other values reserved.

status

0 = Default Status

1 = Subscription canceled, no additional information

2 = Subscription canceled, resource moved

3 = Subscription canceled, resource definition changed (e.g., a new version of IEEE 2030.5)

4 = Subscription canceled, resource deleted All other values reserved.

status

0 = Default Status

1 = Subscription canceled, no additional information

2 = Subscription canceled, resource moved

3 = Subscription canceled, resource definition changed (e.g., a new version of IEEE 2030.5)

4 = Subscription canceled, resource deleted All other values reserved.

+ attributeIdentifier: UInt8

+ lowerThreshold: Int48

+ upperThreshold: Int48

+ attributeIdentifier: UInt8

+ lowerThreshold: Int48

+ upperThreshold: Int48

+ attributeIdentifier: UInt8

+ lowerThreshold: Int48

+ upperThreshold: Int48

Condition

+ encoding: UInt8

+ level: String16

+ limit: UInt32

+ notificationURI: anyURI

+ encoding: UInt8

+ level: String16

+ limit: UInt32

+ notificationURI: anyURI

+ encoding: UInt8

+ level: String16

+ limit: UInt32

+ notificationURI: anyURI

Resource

Subscription

+ subscribedResource: anyURI

«XSDattribute»

::Resource

+ href: anyURI [0..1]

+ subscribedResource: anyURI

«XSDattribute»

::Resource

+ href: anyURI [0..1]

+ subscribedResource: anyURI

«XSDattribute»

::Resource

+ href: anyURI [0..1]

+ newResourceURI: anyURI [0..1]

+ status: UInt8

+ subscriptionURI: anyURI

+ newResourceURI: anyURI [0..1]

+ status: UInt8

+ subscriptionURI: anyURI

+ newResourceURI: anyURI [0..1]

+ status: UInt8

+ subscriptionURI: anyURI

SubscriptionBase

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

Notification

SubscriptionList

List

NotificationList

List

ListLink

NotificationListLink

ListLink

NotificationListLink

ListLink

NotificationListLink

Figure B.12—Pub-Sub

Condition object ()

Indicates a condition that must be satisfied for the Notification to be triggered.

attributeIdentifier attribute (UInt8)

0 = Reading value

1 to 255 = Reserved

lowerThreshold attribute (Int48)

The value of the lower threshold.

upperThreshold attribute (Int48)

The value of the upper threshold.

SubscriptionBase object (Resource)

Holds the information related to a client Subscription to receive updates to a resource automatically. The actual resources may be passed in the Notification by specifying a specific xsi:type for the Resource and passing the full representation.

subscribedResource attribute (anyURI)

The resource for which the Subscription applies. Query string parameters SHALL NOT be specified when subscribing to list resources. Should a query string parameter be specified, servers SHALL ignore them.

Subscription object (SubscriptionBase)

Holds the information related to a client Subscription to receive updates to a resource automatically.

encoding attribute (UInt8)

0 = application/sep+xml

1 = application/sep-exi

2 to 255 = Reserved

level attribute (String16)

Contains the preferred schema and extensibility level indication such as “+S1”.

limit attribute (UInt32)

This element is used to indicate the maximum number of list items that should be included in a Notification when the subscribed resource changes. This limit is meant to be functionally equivalent to the “limit” query string parameter, but applies to both list resources as well as other resources. For list resources, if a limit of 0 is specified, then Notifications SHALL contain a list resource with results = 0 (equivalent to a simple change Notification). For list resources, if a limit greater than 0 is specified, then Notifications SHALL contain a list resource with results equal to the limit specified (or less, should the list contain fewer items than the limit specified or should the server be unable to provide the requested number of items for any reason) and follow the same rules for list resources (e.g., ordering). For non-list resources, if a limit of 0 is specified, then Notifications SHALL NOT contain a resource representation (equivalent to a simple change Notification). For non-list resources, if a limit greater than 0 is specified, then Notifications SHALL contain the representation of the changed resource.

notificationURI attribute (anyURI)

The resource to which to post the Notifications about the requested subscribed resource. Because this URI will exist on a server other than the one being POSTed to, this attribute SHALL be a fully-qualified absolute URI, not a relative reference.

SubscriptionList object (List)

A List element to hold Subscription objects.

pollRate attribute (UInt32) [0..1] «XSDattribute»

Notification object (SubscriptionBase)

newResourceURI attribute (anyURI) [0..1]

The new location of the resource, if moved. This attribute SHALL be a fully-qualified absolute URI, not a relative reference.

status attribute (UInt8)

0 = Default status

1 = Subscription canceled, no additional information

2 = Subscription canceled, resource moved

3 = Subscription canceled, resource definition changed (e.g., a new version of IEEE Std 2030.5)

4 = Subscription canceled, resource deleted All other values reserved.

subscriptionURI attribute (anyURI)

The Subscription from which this Notification was triggered. This attribute SHALL be a fully-qualified absolute URI, not a relative reference.

NotificationList object (List)

A List element to hold Notification objects.

B.2.7 Response package

Contains definitions of objects enabling responses to be sent back to suppliers and providers.

class Response

Resource

FunctionSetAssignmentsBase

0..1

ListLink

ResponseSetListLink

List

class Response

Resource

FunctionSetAssignmentsBase

0..1

ListLink

ResponseSetListLink

List

class Response

Resource

FunctionSetAssignmentsBase

0..1

ListLink

ResponseSetListLink

List

DutyCycle

ResponseSetList

+ normalValue: UInt8

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

Offset

0..*

IdentifiedObject

ResponseSet

0..*

IdentifiedObject

ResponseSet

0..*

IdentifiedObject

ResponseSet

DERControlResponse

+ coolingOffset: UInt8 [0..1]

+ heatingOffset: UInt8 [0..1]

+ loadAdjustmentPercentageOffset: PerCent [0..1]

+ coolingOffset: UInt8 [0..1]

+ heatingOffset: UInt8 [0..1]

+ loadAdjustmentPercentageOffset: PerCent [0..1]

+ coolingOffset: UInt8 [0..1]

+ heatingOffset: UInt8 [0..1]

+ loadAdjustmentPercentageOffset: PerCent [0..1]

0..1

FlowReservationResponseResponse

SetPoint

ListLink

ResponseListLink

ListLink

ResponseListLink

ListLink

ResponseListLink

+ coolingSetpoint: Int16 [0..1]

+ heatingSetpoint: Int16 [0..1]

+ coolingSetpoint: Int16 [0..1]

+ heatingSetpoint: Int16 [0..1]

+ coolingSetpoint: Int16 [0..1]

+ heatingSetpoint: Int16 [0..1]

List

PriceResponse

ResponseList

AppliedTargetReduction

0..*

TextResponse

+ type: UnitType

+ value: UInt16

+ type: UnitType

+ value: UInt16

+ type: UnitType

+ value: UInt16

Resource

Response

+ createdDateTime: TimeType [0..1]

+ endDeviceLFDI: HexBinary160

+ status: UInt8 [0..1]

+ subject: mRIDType

Resource

Response

+ createdDateTime: TimeType [0..1]

+ endDeviceLFDI: HexBinary160

+ status: UInt8 [0..1]

+ subject: mRIDType

Resource

Response

+ createdDateTime: TimeType [0..1]

+ endDeviceLFDI: HexBinary160

+ status: UInt8 [0..1]

+ subject: mRIDType

DrResponse

ApplianceLoadReduction

+ overrideDuration: UInt16 [0..1]

0..1

+ type: ApplianceLoadReductionType

Figure B.13—Response DERControlResponse object (Response)

A response to a DERControl.

FlowReservationResponseResponse object (Response)

A response to a FlowReservationResponse.

AppliedTargetReduction object ()

Specifies the value of the TargetReduction applied by the device.

type attribute (UnitType)

Enumerated field representing the type of reduction requested.

value attribute (UInt16)

Indicates the requested amount of the relevant commodity to be reduced.

DrResponse object (Response)

A response to a Demand Response Load Control (EndDeviceControl) message.

overrideDuration attribute (UInt16) [0..1]

Indicates the amount of time, in seconds, that the client partially opts-out during the demand response event. When overriding within the allowed override duration, the client SHALL send a partial opt-out (response status code 8) for partial opt-out upon completion, with the total time the event was overridden (this attribute) populated. The client SHALL send a no participation status response (status type 10) if the user partially opts-out for longer than EndDeviceControl.overrideDuration.

PriceResponse object (Response)

A response related to a price message.

Response object (Resource)

The Response object is the generic response data repository which is extended for specific function sets.

createdDateTime attribute (TimeType) [0..1]

The createdDateTime field contains the date and time when the acknowledgement/status occurred in the client. The client will provide the timestamp to ensure the proper time is captured in case the response is delayed in reaching the server (server receipt time would not be the same as the actual confirmation time). The time reported from the client should be relative to the time server indicated by the FunctionSetAssignment that also indicated the event resource; if no FunctionSetAssignment exists, the time of the server where the event resource was hosted.

endDeviceLFDI attribute (HexBinary160)

Contains the long-form device identifier (LFDI) of the device providing the response.

status attribute (UInt8) [0..1]

The status field contains the acknowledgement or status. Each event type (DRLC, DER, Price, or Text) can return different status information (e.g., an Acknowledge will be returned for a Price event where a Demand Response Load Control (DRLC) event can return Event Received, Event Started, and Event Completed). The status field value definitions are defined in Table 27.

subject attribute (mRIDType)

The subject field provides a method to match the response with the originating event. It is populated with the mRID of the original object.

ResponseList object (List)

A List element to hold Response objects.

ResponseSet object (IdentifiedObject)

A container for a ResponseList.

ResponseSetList object (List)

A List element to hold ResponseSet objects.

pollRate attribute (UInt32) [0..1] «XSDattribute»

TextResponse object (Response)

A response to a text message.

B.2.8 Time package

class Time

Int64

TimeType

0..1

notes

Time is a signed 64 bit value representing the number of seconds since 0 hours, 0 minutes, 0 seconds, on the 1st of January, 1970, in UTC, not counting leap seconds.

notes

Time is a signed 64 bit value representing the number of seconds since 0 hours, 0 minutes, 0 seconds, on the 1st of January, 1970, in UTC, not counting leap seconds.

notes

Time is a signed 64 bit value representing the number of seconds since 0 hours, 0 minutes, 0 seconds, on the 1st of January, 1970, in UTC, not counting leap seconds.

Link

TimeLink

Resource

Time

quality

+ currentTime: TimeType Metric indicating the quality of the time source from which the service

+ dstEndTime: TimeType acquired time. Lower (smaller) quality enumeration values are assumed

+ dstOffset: TimeOffsetType to be more accurate.

+ dstStartTime: TimeType 3 - time obtained from external authoritative source such as NTP

+ localTime: TimeType [0..1] 4 - time obtained from level 3 source

+ quality: UInt8 5 - time manually set or obtained from level 4 source

+ tzOffset: TimeOffsetType 6 - time obtained from level 5 source

«XSDattribute» 7 - time intentionally uncoordinated

+ pollRate: UInt32 [0..1] = 900 All other values are reserved for future use.

Link

TimeLink

Resource

Time

quality

+ currentTime: TimeType Metric indicating the quality of the time source from which the service

+ dstEndTime: TimeType acquired time. Lower (smaller) quality enumeration values are assumed

+ dstOffset: TimeOffsetType to be more accurate.

+ dstStartTime: TimeType 3 - time obtained from external authoritative source such as NTP

+ localTime: TimeType [0..1] 4 - time obtained from level 3 source

+ quality: UInt8 5 - time manually set or obtained from level 4 source

+ tzOffset: TimeOffsetType 6 - time obtained from level 5 source

«XSDattribute» 7 - time intentionally uncoordinated

+ pollRate: UInt32 [0..1] = 900 All other values are reserved for future use.

Link

TimeLink

Resource

Time

quality

+ currentTime: TimeType Metric indicating the quality of the time source from which the service

+ dstEndTime: TimeType acquired time. Lower (smaller) quality enumeration values are assumed

+ dstOffset: TimeOffsetType to be more accurate.

+ dstStartTime: TimeType 3 - time obtained from external authoritative source such as NTP

+ localTime: TimeType [0..1] 4 - time obtained from level 3 source

+ quality: UInt8 5 - time manually set or obtained from level 4 source

+ tzOffset: TimeOffsetType 6 - time obtained from level 5 source

«XSDattribute» 7 - time intentionally uncoordinated

+ pollRate: UInt32 [0..1] = 900 All other values are reserved for future use.

Resource

DeviceStatus

Resource

DeviceStatus

Resource

DeviceStatus

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

Figure B.14—Time

Time object (Resource)

Contains the representation of time, constantly updated.

currentTime attribute (TimeType)

The current time, in the format defined by TimeType.

dstEndTime attribute (TimeType)

Time at which daylight savings ends (dstOffset no longer applied). Result of dstEndRule calculation.

dstOffset attribute (TimeOffsetType)

Daylight savings time offset from local standard time. A typical practice is advancing clocks one hour when daylight savings time is in effect, which would result in a positive dstOffset.

dstStartTime attribute (TimeType)

Time at which daylight savings begins (apply dstOffset). Result of dstStartRule calculation.

localTime attribute (TimeType) [0..1]

Local time: localTime = currentTime + tzOffset (+ dstOffset when in effect).

pollRate attribute (UInt32) [0..1] «XSDattribute»

quality attribute (UInt8)

Metric indicating the quality of the time source from which the service acquired time. Lower (smaller) quality enumeration values are assumed to be more accurate.

3 = Time obtained from external authoritative source such as NTP

4 = Time obtained from level 3 source

5 = Time manually set or obtained from level 4 source

6 = Time obtained from level 5 source

7 = Time intentionally uncoordinated

All other values are reserved for future use.

tzOffset attribute (TimeOffsetType)

Local time zone offset from currentTime. Does not include any daylight savings time offsets. For American time zones, a negative tzOffset SHALL be used (e.g., EST = GMT −5 which is −18 000).

B.2.9 DeviceInformation package

Contains general information about devices.

class DeviceInformation

SubscribableResource

AbstractDevice

class DeviceInformation

SubscribableResource

AbstractDevice

class DeviceInformation

SubscribableResource

AbstractDevice

UInt8

PowerSourceType

UInt8

PowerSourceType

UInt8

PowerSourceType

0..1

Link

DeviceInformationLink

0..1

Link

DeviceInformationLink

0..1

Link

DeviceInformationLink

Resource

DeviceInformation

notes

0 - none

1 - mains

2 - battery

3 - local generation

4 - emergency

5 - unknown

All other values reserved.

notes

0 - none

1 - mains

2 - battery

3 - local generation

4 - emergency

5 - unknown

All other values reserved.

notes

0 - none

1 - mains

2 - battery

3 - local generation

4 - emergency

5 - unknown

All other values reserved.

+ functionsImplemented: HexBinary64 [0..1]

+ gpsLocation: GPSLocationType [0..1]

+ lFDI: HexBinary160

+ mfDate: TimeType

+ mfHwVer: String32

+ mfID: PENType

+ mfInfo: String32 [0..1]

+ mfModel: String32

+ mfSerNum: String32

+ primaryPower: PowerSourceType

+ secondaryPower: PowerSourceType

+ swActTime: TimeType

+ swVer: String32

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ functionsImplemented: HexBinary64 [0..1]

+ gpsLocation: GPSLocationType [0..1]

+ lFDI: HexBinary160

+ mfDate: TimeType

+ mfHwVer: String32

+ mfID: PENType

+ mfInfo: String32 [0..1]

+ mfModel: String32

+ mfSerNum: String32

+ primaryPower: PowerSourceType

+ secondaryPower: PowerSourceType

+ swActTime: TimeType

+ swVer: String32

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ functionsImplemented: HexBinary64 [0..1]

+ gpsLocation: GPSLocationType [0..1]

+ lFDI: HexBinary160

+ mfDate: TimeType

+ mfHwVer: String32

+ mfID: PENType

+ mfInfo: String32 [0..1]

+ mfModel: String32

+ mfSerNum: String32

+ primaryPower: PowerSourceType

+ secondaryPower: PowerSourceType

+ swActTime: TimeType

+ swVer: String32

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

functionsImplemented

Bitmap indicating the function sets used by the device as a client.

0 - Device Capability

1 - Self Device Resource

2 - End Device Resource

3 - Function Set Assignments

4 - Subscription/Notification Mechanism

5 - Response

6 - Time

7 - Device Information

8 - Power Status

9 - Network Status

10 - Log Event

functionsImplemented

Bitmap indicating the function sets used by the device as a client.

0 - Device Capability

1 - Self Device Resource

2 - End Device Resource

3 - Function Set Assignments

4 - Subscription/Notification Mechanism

5 - Response

6 - Time

7 - Device Information

8 - Power Status

9 - Network Status

10 - Log Event

functionsImplemented

Bitmap indicating the function sets used by the device as a client.

0 - Device Capability

1 - Self Device Resource

2 - End Device Resource

3 - Function Set Assignments

4 - Subscription/Notification Mechanism

5 - Response

6 - Time

7 - Device Information

8 - Power Status

9 - Network Status

10 - Log Event

11 - Configuration Resource

12 - Software Download

13 - DRLC

14 - Metering

15 - Pricing

11 - Configuration Resource

12 - Software Download

13 - DRLC

14 - Metering

15 - Pricing

11 - Configuration Resource

12 - Software Download

13 - DRLC

14 - Metering

15 - Pricing

0..1

16 - Messaging

17 - Billing

18 - Prepayment

19 - Flow Reservation

20 - DER Control

16 - Messaging

17 - Billing

18 - Prepayment

19 - Flow Reservation

20 - DER Control

16 - Messaging

17 - Billing

18 - Prepayment

19 - Flow Reservation

20 - DER Control

0..1

DRLCCapabilities

ListLink

SupportedLocaleListLink

ListLink

SupportedLocaleListLink

ListLink

SupportedLocaleListLink

+ averageEnergy: RealEnergy

+ maxDemand: ActivePower

+ optionsImplemented: HexBinary32

+ averageEnergy: RealEnergy

+ maxDemand: ActivePower

+ optionsImplemented: HexBinary32

+ averageEnergy: RealEnergy

+ maxDemand: ActivePower

+ optionsImplemented: HexBinary32

optionsImplemented

Bitmap indicating the DRLC options implemented by the device.

0 - Target reduction (kWh)

1 - Target reduction (kW)

2 - Target reduction (Watts)

3 - Target reduction (Cubic Meters)

4 - Target reduction (Cubic Feet)

5 - Target reduction (US Gallons)

6 - Target reduction (Imperial Gallons)

7 - Target reduction (BTUs)

8 - Target reduction (Liters)

9 - Target reduction (kPA (gauge))

10 - Target reduction (kPA (absolute))

11 - Target reduction (Mega Joule)

12 - Target reduction (Unitless) 13-15 - Reserved

16 - Temperature set point

17 - Temperature offset

18 - Duty cycle

19 - Load adjustment percentage

20 - Appliance load reduction 21-31 - Reserved

optionsImplemented

Bitmap indicating the DRLC options implemented by the device.

0 - Target reduction (kWh)

1 - Target reduction (kW)

2 - Target reduction (Watts)

3 - Target reduction (Cubic Meters)

4 - Target reduction (Cubic Feet)

5 - Target reduction (US Gallons)

6 - Target reduction (Imperial Gallons)

7 - Target reduction (BTUs)

8 - Target reduction (Liters)

9 - Target reduction (kPA (gauge))

10 - Target reduction (kPA (absolute))

11 - Target reduction (Mega Joule)

12 - Target reduction (Unitless) 13-15 - Reserved

16 - Temperature set point

17 - Temperature offset

18 - Duty cycle

19 - Load adjustment percentage

20 - Appliance load reduction 21-31 - Reserved

optionsImplemented

Bitmap indicating the DRLC options implemented by the device.

0 - Target reduction (kWh)

1 - Target reduction (kW)

2 - Target reduction (Watts)

3 - Target reduction (Cubic Meters)

4 - Target reduction (Cubic Feet)

5 - Target reduction (US Gallons)

6 - Target reduction (Imperial Gallons)

7 - Target reduction (BTUs)

8 - Target reduction (Liters)

9 - Target reduction (kPA (gauge))

10 - Target reduction (kPA (absolute))

11 - Target reduction (Mega Joule)

12 - Target reduction (Unitless) 13-15 - Reserved

16 - Temperature set point

17 - Temperature offset

18 - Duty cycle

19 - Load adjustment percentage

20 - Appliance load reduction 21-31 - Reserved

List

SupportedLocaleList

0..*

String42

LocaleType

String42

LocaleType

String42

LocaleType

Resource

SupportedLocale

Resource

SupportedLocale

Resource

SupportedLocale

notes

[RFC 4646] identifier of a language-region

notes

[RFC 4646] identifier of a language-region

notes

[RFC 4646] identifier of a language-region

RealEnergy

+ locale: LocaleType

+ multiplier: PowerOfTenMultiplierType

+ value: UInt48

+ multiplier: PowerOfTenMultiplierType

+ value: UInt48

+ multiplier: PowerOfTenMultiplierType

+ value: UInt48

Figure B.15—DeviceInformation DeviceInformation object (Resource)

Contains identification and other information about the device that changes very infrequently, typically only when updates are applied, if ever.

functionsImplemented attribute (HexBinary64) [0..1]

Bitmap indicating the function sets used by the device as a client.

0 = Device capability

1 = SelfDevice resource

2 = EndDevice resource

3 = Function set assignments

4 = Subscription/Notification mechanism

5 = Response

6 = Time

7 = Device information

8 = Power status

9 = Network status

10 = Log event

11 = Configuration resource

12 = Software download

13 = DRLC

14 = Metering

15 = Pricing

16 = Messaging

17 = Billing

18 = Prepayment

19 = Flow reservation

20 = DER control

gpsLocation attribute (GPSLocationType) [0..1]

GPS location of this device.

lFDI attribute (HexBinary160)

Long form device identifier. See Clause 6 (security) for full details.

mfDate attribute (TimeType)

Date/time of manufacture.

mfHwVer attribute (String32)

Manufacturer hardware version.

mfID attribute (PENType)

The manufacturer’s IANA Enterprise Number.

mfInfo attribute (String32) [0..1]

Manufacturer dependent information related to the manufacture of this device.

mfModel attribute (String32)

Manufacturer’s model number.

mfSerNum attribute (String32)

Manufacturer assigned serial number.

pollRate attribute (UInt32) [0..1] «XSDattribute»

primaryPower attribute (PowerSourceType)

Primary source of power.

secondaryPower attribute (PowerSourceType)

Secondary source of power.

swActTime attribute (TimeType)

Activation date/time of currently running software.

swVer attribute (String32)

Currently running software version.

DRLCCapabilities object ()

Contains information about the static capabilities of the device, to allow service providers to know what types of functions are supported, what the normal operating ranges and limits are, and other similar information, in order to provide better suggestions of applicable programs to receive the maximum benefit.

averageEnergy attribute (RealEnergy)

The average hourly energy usage when in normal operating mode.

maxDemand attribute (ActivePower)

The maximum demand rating of this end device.

optionsImplemented attribute (HexBinary32)

Bitmap indicating the DRLC options implemented by the device.

0 = Target reduction (kWh)

1 = Target reduction (kW)

2 = Target reduction (watts)

3 = Target reduction (cubic meters)

4 = Target reduction (cubic feet)

5 = Target reduction (U.S. gallons)

6 = Target reduction (Imperial gallons)

7 = Target reduction (BTUs)

8 = Target reduction (liters)

9 = Target reduction (kPA [gauge])

10 = Target reduction (kPA [absolute])

11 = Target reduction (megajoule)

12 = Target reduction (unitless)

13 to 15 = Reserved

16 = Temperature set point

17 = Temperature offset

18 = Duty cycle

19 = Load adjustment percentage

20 = Appliance load reduction

21 to 31 = Reserved

SupportedLocale object (Resource)

Specifies a locale that is supported.

locale attribute (LocaleType)

The code for a locale that is supported.

SupportedLocaleList object (List)

A List element to hold SupportedLocale objects.

B.2.10 PowerStatus package

class PowerStatus

SubscribableResource

AbstractDevice

class PowerStatus

SubscribableResource

AbstractDevice

class PowerStatus

SubscribableResource

AbstractDevice

0..1

Link

PowerStatusLink

Resource

PowerStatus

UInt8

PowerSourceType

UInt8

PowerSourceType

UInt8

PowerSourceType

batteryStatus: UInt8

changedTime: TimeType currentPowerSource: PowerSourceType

estimatedChargeRemaining: PerCent [0..1] estimatedTimeRemaining: UInt32 [0..1]

sessionTimeOnBattery: UInt32 [0..1] totalTimeOnBattery: UInt32 [0..1]

«XSDattribute»

batteryStatus: UInt8

changedTime: TimeType currentPowerSource: PowerSourceType

estimatedChargeRemaining: PerCent [0..1] estimatedTimeRemaining: UInt32 [0..1]

sessionTimeOnBattery: UInt32 [0..1] totalTimeOnBattery: UInt32 [0..1]

«XSDattribute»

batteryStatus: UInt8

changedTime: TimeType currentPowerSource: PowerSourceType

estimatedChargeRemaining: PerCent [0..1] estimatedTimeRemaining: UInt32 [0..1]

sessionTimeOnBattery: UInt32 [0..1] totalTimeOnBattery: UInt32 [0..1]

«XSDattribute»

PEVInfo

notes

+ pollRate: UInt32 [0..1] = 900

0..1 +

chargingPowerNow: ActivePower

energyRequestNow: RealEnergy maxForwardPower: ActivePower minimumChargingDuration: UInt32 targetStateOfCharge: PerCent timeChargeIsNeeded: TimeType timeChargingStatusPEV: TimeType

chargingPowerNow: ActivePower

energyRequestNow: RealEnergy maxForwardPower: ActivePower minimumChargingDuration: UInt32 targetStateOfCharge: PerCent timeChargeIsNeeded: TimeType timeChargingStatusPEV: TimeType

chargingPowerNow: ActivePower

energyRequestNow: RealEnergy maxForwardPower: ActivePower minimumChargingDuration: UInt32 targetStateOfCharge: PerCent timeChargeIsNeeded: TimeType timeChargingStatusPEV: TimeType

0 - none

1 - mains

2 - battery

3 - local generation

4 - emergency

5 - unknown

All other values reserved.

0 - none

1 - mains

2 - battery

3 - local generation

4 - emergency

5 - unknown

All other values reserved.

0 - none

1 - mains

2 - battery

3 - local generation

4 - emergency

5 - unknown

All other values reserved.

Figure B.16—PowerStatus

PowerStatus object (Resource)

Contains the status of the device’s power sources.

batteryStatus attribute (UInt8)

Battery system status:

0 = Unknown

1 = Normal (more than LowChargeThreshold remaining)

2 = Low (less than LowChargeThreshold remaining)

3 = Depleted (0% charge remaining)

4 = Not applicable (mains powered only)

changedTime attribute (TimeType)

The time at which the reported values were recorded.

currentPowerSource attribute (PowerSourceType)

This value will be fixed for devices powered by a single source. This value may change for devices able to transition between multiple power sources (mains to battery backup, etc.).

estimatedChargeRemaining attribute (PerCent) [0..1]

Estimate of remaining battery charge as a percent of full charge.

estimatedTimeRemaining attribute (UInt32) [0..1]

Estimated time (in seconds) to total battery charge depletion (undercurrent load).

pollRate attribute (UInt32) [0..1] «XSDattribute»

sessionTimeOnBattery attribute (UInt32) [0..1]

If the device has a battery, this is the time since the device last switched to battery power, or the time since the device was restarted, whichever is less, in seconds.

totalTimeOnBattery attribute (UInt32) [0..1]

If the device has a battery, this is the total time the device has been on battery power, in seconds. It may be reset when the battery is replaced.

PowerSourceType object (UInt8)

0 = None

1 = Mains

2 = Battery

3 = Local generation

4 = Emergency

5 = Unknown

All other values reserved.

PEVInfo object ()

Contains attributes that can be exposed by PEVs and other devices that have charging requirements.

chargingPowerNow attribute (ActivePower)

This is the actual power flow in or out of the charger or inverter. This is calculated by the vehicle based on actual measurements. This number is positive for charging.

energyRequestNow attribute (RealEnergy)

This is the amount of energy that must be transferred from the grid to EVSE and PEV to achieve the target state of charge allowing for charger efficiency and any vehicle and EVSE parasitic loads. This is calculated

by the vehicle and changes throughout the connection as forward or reverse power flow change the battery state of charge. This number is positive for charging.

maxForwardPower attribute (ActivePower)

This is the maximum power transfer capability that could be used for charging the PEV to perform the requested energy transfer. It is the lower of the vehicle or EVSE physical power limitations. It is not based on economic considerations. The vehicle may draw less power than this value based on its charging cycle. The vehicle defines this parameter. This number is positive for charging power flow.

minimumChargingDuration attribute (UInt32)

This is computed by the PEV based on the charging profile to complete the energy transfer if the maximum power is authorized. The value will never be smaller than the ratio of the energy request to the power request because the charging profile may not allow the maximum power to be used throughout the transfer. This is a critical parameter for determining whether any slack time exists in the charging cycle between the current time and the Time Charge Is Needed (TCIN).

targetStateOfCharge attribute (PerCent)

This is the target state of charge that is to be achieved during charging before the time of departure (TCIN). The default value is 100%. The value cannot be set to a value less than the actual state of charge.

timeChargeIsNeeded attribute (TimeType)

Time Charge Is Needed (TCIN) is the time that the PEV is expected to depart. The value is manually entered using controls and displays in the vehicle, or on the EVSE, or using a mobile device. It is authenticated and saved by the PEV. This value may be updated during a charging session.

timeChargingStatusPEV attribute (TimeType)

This is the time that the parameters are updated, except for changes to TCIN.

B.2.11 NetworkStatus package

class NetworkStatus

SubscribableResource

AbstractDevice

0..1

ListLink

IPInterfaceListLink

class NetworkStatus

SubscribableResource

AbstractDevice

0..1

ListLink

IPInterfaceListLink

class NetworkStatus

SubscribableResource

AbstractDevice

0..1

ListLink

IPInterfaceListLink

ListLink

List

IPAddrListLink

ListLink

RPLInstanceListLink

ListLink

RPLInstanceListLink

ListLink

RPLInstanceListLink

ListLink

RPLSourceRoutesListLink

ListLink

RPLSourceRoutesListLink

ListLink

RPLSourceRoutesListLink

IPInterfaceList

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

IPInterfaceList

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

IPInterfaceList

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

List

IPAddrList

List

RPLInstanceList

List

RPLInstanceList

List

RPLInstanceList

List

RPLSourceRoutesList

List

RPLSourceRoutesList

List

RPLSourceRoutesList

0..*

Resource Resource Resource Resource

IPInterface IPAddr RPLInstance RPLSourceRoutes

Resource Resource Resource Resource

IPInterface IPAddr RPLInstance RPLSourceRoutes

Resource Resource Resource Resource

IPInterface IPAddr RPLInstance RPLSourceRoutes

+ ifDescr: String192 [0..1]

+ ifHighSpeed: UInt32 [0..1]

+ ifInBroadcastPkts: UInt32 [0..1]

+ ifIndex: UInt32 [0..1]

+ ifInDiscards: UInt32 [0..1]

+ ifInErrors: UInt32 [0..1]

+ ifInMulticastPkts: UInt32 [0..1]

+ ifInOctets: UInt32 [0..1]

+ ifInUcastPkts: UInt32 [0..1]

+ ifInUnknownProtos: UInt32 [0..1]

+ ifMtu: UInt32 [0..1]

+ ifName: String16 [0..1]

+ ifOperStatus: UInt8 [0..1]

+ ifOutBroadcastPkts: UInt32 [0..1]

+ ifOutDiscards: UInt32 [0..1]

+ ifOutErrors: UInt32 [0..1]

+ ifOutMulticastPkts: UInt32 [0..1]

+ ifOutOctets: UInt32 [0..1]

+ ifOutUcastPkts: UInt32 [0..1]

+ ifPromiscuousMode: boolean [0..1]

+ ifSpeed: UInt32 [0..1]

+ ifType: UInt16 [0..1]

+ lastResetTime: Int64 [0..1]

+ lastUpdatedTime: Int64 [0..1]

+ ifDescr: String192 [0..1]

+ ifHighSpeed: UInt32 [0..1]

+ ifInBroadcastPkts: UInt32 [0..1]

+ ifIndex: UInt32 [0..1]

+ ifInDiscards: UInt32 [0..1]

+ ifInErrors: UInt32 [0..1]

+ ifInMulticastPkts: UInt32 [0..1]

+ ifInOctets: UInt32 [0..1]

+ ifInUcastPkts: UInt32 [0..1]

+ ifInUnknownProtos: UInt32 [0..1]

+ ifMtu: UInt32 [0..1]

+ ifName: String16 [0..1]

+ ifOperStatus: UInt8 [0..1]

+ ifOutBroadcastPkts: UInt32 [0..1]

+ ifOutDiscards: UInt32 [0..1]

+ ifOutErrors: UInt32 [0..1]

+ ifOutMulticastPkts: UInt32 [0..1]

+ ifOutOctets: UInt32 [0..1]

+ ifOutUcastPkts: UInt32 [0..1]

+ ifPromiscuousMode: boolean [0..1]

+ ifSpeed: UInt32 [0..1]

+ ifType: UInt16 [0..1]

+ lastResetTime: Int64 [0..1]

+ lastUpdatedTime: Int64 [0..1]

+ ifDescr: String192 [0..1]

+ ifHighSpeed: UInt32 [0..1]

+ ifInBroadcastPkts: UInt32 [0..1]

+ ifIndex: UInt32 [0..1]

+ ifInDiscards: UInt32 [0..1]

+ ifInErrors: UInt32 [0..1]

+ ifInMulticastPkts: UInt32 [0..1]

+ ifInOctets: UInt32 [0..1]

+ ifInUcastPkts: UInt32 [0..1]

+ ifInUnknownProtos: UInt32 [0..1]

+ ifMtu: UInt32 [0..1]

+ ifName: String16 [0..1]

+ ifOperStatus: UInt8 [0..1]

+ ifOutBroadcastPkts: UInt32 [0..1]

+ ifOutDiscards: UInt32 [0..1]

+ ifOutErrors: UInt32 [0..1]

+ ifOutMulticastPkts: UInt32 [0..1]

+ ifOutOctets: UInt32 [0..1]

+ ifOutUcastPkts: UInt32 [0..1]

+ ifPromiscuousMode: boolean [0..1]

+ ifSpeed: UInt32 [0..1]

+ ifType: UInt16 [0..1]

+ lastResetTime: Int64 [0..1]

+ lastUpdatedTime: Int64 [0..1]

+ address: HexBinary128

0..1

+ DODAGid: UInt8

+ DODAGroot: boolean

+ flags: UInt8

+ groundedFlag: boolean 0..1

+ MOP: UInt8

+ PRF: UInt8

+ rank: UInt16

+ RPLInstanceID: UInt8

+ versionNumber: UInt8

+ DODAGid: UInt8

+ DODAGroot: boolean

+ flags: UInt8

+ groundedFlag: boolean 0..1

+ MOP: UInt8

+ PRF: UInt8

+ rank: UInt16

+ RPLInstanceID: UInt8

+ versionNumber: UInt8

+ DODAGid: UInt8

+ DODAGroot: boolean

+ flags: UInt8

+ groundedFlag: boolean 0..1

+ MOP: UInt8

+ PRF: UInt8

+ rank: UInt16

+ RPLInstanceID: UInt8

+ versionNumber: UInt8

+ DestAddress: HexBinary128

+ SourceRoute: HexBinary128

+ DestAddress: HexBinary128

+ SourceRoute: HexBinary128

+ DestAddress: HexBinary128

+ SourceRoute: HexBinary128

0..1

ListLink

LLInterfaceListLink

ListLink

LLInterfaceListLink

ListLink

LLInterfaceListLink

List

LLInterfaceList

0..*

List

LLInterfaceList

0..*

List

LLInterfaceList

0..*

Resource

LLInterface

+ CRCerrors: UInt32

+ EUI64: HexBinary64

+ linkLayerType: UInt8

+ LLAckNotRx: UInt32 [0..1]

+ LLCSMAFail: UInt32 [0..1]

+ LLFramesDropRx: UInt32 [0..1]

+ LLFramesDropTx: UInt32 [0..1]

+ LLFramesRx: UInt32 [0..1]

+ LLFramesTx: UInt32 [0..1]

+ LLMediaAccessFail: UInt32 [0..1]

+ LLOctetsRx: UInt32 [0..1]

+ LLOctetsTx: UInt32 [0..1]

+ LLRetryCount: UInt32 [0..1]

+ LLSecurityErrorRx: UInt32 [0..1]

+ CRCerrors: UInt32

+ EUI64: HexBinary64

+ linkLayerType: UInt8

+ LLAckNotRx: UInt32 [0..1]

+ LLCSMAFail: UInt32 [0..1]

+ LLFramesDropRx: UInt32 [0..1]

+ LLFramesDropTx: UInt32 [0..1]

+ LLFramesRx: UInt32 [0..1]

+ LLFramesTx: UInt32 [0..1]

+ LLMediaAccessFail: UInt32 [0..1]

+ LLOctetsRx: UInt32 [0..1]

+ LLOctetsTx: UInt32 [0..1]

+ LLRetryCount: UInt32 [0..1]

+ LLSecurityErrorRx: UInt32 [0..1]

+ CRCerrors: UInt32

+ EUI64: HexBinary64

+ linkLayerType: UInt8

+ LLAckNotRx: UInt32 [0..1]

+ LLCSMAFail: UInt32 [0..1]

+ LLFramesDropRx: UInt32 [0..1]

+ LLFramesDropTx: UInt32 [0..1]

+ LLFramesRx: UInt32 [0..1]

+ LLFramesTx: UInt32 [0..1]

+ LLMediaAccessFail: UInt32 [0..1]

+ LLOctetsRx: UInt32 [0..1]

+ LLOctetsTx: UInt32 [0..1]

+ LLRetryCount: UInt32 [0..1]

+ LLSecurityErrorRx: UInt32 [0..1]

linkLayerType

Specifies the type of link layer interface associated with the IPInterface. Values are below.

0 = Unspecified

1 = IEEE 802.3 (Ethernet)

2 = IEEE 802.11 (WLAN)

3 = IEEE 802.15 (PAN)

4 = IEEE 1901 (PLC)

All other values reserved.

linkLayerType

Specifies the type of link layer interface associated with the IPInterface. Values are below.

0 = Unspecified

1 = IEEE 802.3 (Ethernet)

2 = IEEE 802.11 (WLAN)

3 = IEEE 802.15 (PAN)

4 = IEEE 1901 (PLC)

All other values reserved.

linkLayerType

Specifies the type of link layer interface associated with the IPInterface. Values are below.

0 = Unspecified

1 = IEEE 802.3 (Ethernet)

2 = IEEE 802.11 (WLAN)

3 = IEEE 802.15 (PAN)

4 = IEEE 1901 (PLC)

All other values reserved.

IEEE_802_15_4

+ capabilityInfo: HexBinary8

0..1

IEEE_802_15_4

+ capabilityInfo: HexBinary8

0..1

IEEE_802_15_4

+ capabilityInfo: HexBinary8

0..1

ListLink

NeighborListLink

ListLink

NeighborListLink

ListLink

NeighborListLink

+ shortAddress: UInt16

0..1

List

NeighborList

List

NeighborList

List

NeighborList

0..*

loWPAN

Resource

0..1 + octetsRx: UInt32 [0..1]

+ octetsTx: UInt32 [0..1]

+ packetsRx: UInt32

+ packetsTx: UInt32

+ rxFragError: UInt32

0..1 + octetsRx: UInt32 [0..1]

+ octetsTx: UInt32 [0..1]

+ packetsRx: UInt32

+ packetsTx: UInt32

+ rxFragError: UInt32

0..1 + octetsRx: UInt32 [0..1]

+ octetsTx: UInt32 [0..1]

+ packetsRx: UInt32

+ packetsTx: UInt32

+ rxFragError: UInt32

Neighbor

+ isChild: boolean

+ linkQuality: UInt8

+ shortAddress: UInt16

+ isChild: boolean

+ linkQuality: UInt8

+ shortAddress: UInt16

+ isChild: boolean

+ linkQuality: UInt8

+ shortAddress: UInt16

Figure B.17—NetworkStatus

IEEE_802_15_4 object ()

Contains 802.15.4 link layer specific attributes.

capabilityInfo attribute (HexBinary8)

As defined by IEEE Std 802.15.4.

shortAddress attribute (UInt16)

As defined by IEEE Std 802.15.4.

IPAddr object (Resource)

An Internet Protocol (IP) address object.

address attribute (HexBinary128)

An IP address value.

IPAddrList object (List)

List of IPAddr instances.

IPInterface object (Resource)

Specific IPInterface resource. This resource may be thought of as network status information for a specific network (IP) layer interface.

ifDescr attribute (String192) [0..1]

Use rules from IETF RFC 2863.

ifHighSpeed attribute (UInt32) [0..1]

Use rules from IETF RFC 2863.

ifInBroadcastPkts attribute (UInt32) [0..1]

Use rules from IETF RFC 2863.

ifIndex attribute (UInt32) [0..1]

Use rules from IETF RFC 2863.

ifInDiscards attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Input Datagrams Discarded.

ifInErrors attribute (UInt32) [0..1]

Use rules from IETF RFC 2863.

ifInMulticastPkts attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Multicast Datagrams Received.

ifInOctets attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Bytes Received.

ifInUcastPkts attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Datagrams Received.

ifInUnknownProtos attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Datagrams with Unknown Protocol Received.

ifMtu attribute (UInt32) [0..1]

Use rules from IETF RFC 2863.

ifName attribute (String16) [0..1]

Use rules from IETF RFC 2863.

ifOperStatus attribute (UInt8) [0..1]

Use rules and assignments from IETF RFC 2863.

ifOutBroadcastPkts attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Broadcast Datagrams Sent.

ifOutDiscards attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Output Datagrams Discarded.

ifOutErrors attribute (UInt32) [0..1]

Use rules from IETF RFC 2863.

ifOutMulticastPkts attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Multicast Datagrams Sent.

ifOutOctets attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Bytes Sent.

ifOutUcastPkts attribute (UInt32) [0..1]

Use rules from IETF RFC 2863. Can be thought of as Datagrams Sent.

ifPromiscuousMode attribute (boolean) [0..1]

Use rules from IETF RFC 2863.

ifSpeed attribute (UInt32) [0..1]

Use rules from IETF RFC 2863.

ifType attribute (UInt16) [0..1]

Use rules and assignments from IETF RFC 2863.

lastResetTime attribute (Int64) [0..1]

Similar to ifLastChange in IETF RFC 2863.

lastUpdatedTime attribute (Int64) [0..1]

The date/time of the reported status.

IPInterfaceList object (List)

List of IPInterface instances.

pollRate attribute (UInt32) [0..1] «XSDattribute»

LLInterface object (Resource)

A link-layer interface object.

CRCerrors attribute (UInt32)

Contains the number of CRC errors since reset.

EUI64 attribute (HexBinary64)

Contains the EUI-64 of the link layer interface. 48-bit MAC addresses SHALL be changed into an EUI-64 using the method defined in IETF RFC 4291, Appendix A. (The method is to insert “0xFFFE” as described in the reference.)

linkLayerType attribute (UInt8)

Specifies the type of link layer interface associated with the IPInterface. Values are below.

0 = Unspecified

1 = IEEE 802.3 (Ethernet)

2 = IEEE 802.11 (WLAN)

3 = IEEE 802.15 (PAN)

4 = IEEE 1901 (PLC)

All other values reserved.

LLAckNotRx attribute (UInt32) [0..1]

Number of times an ACK was not received for a frame transmitted (when ACK was requested).

LLCSMAFail attribute (UInt32) [0..1]

Number of times CSMA failed.

LLFramesDropRx attribute (UInt32) [0..1]

Number of dropped receive frames.

LLFramesDropTx attribute (UInt32) [0..1]

Number of dropped transmit frames.

LLFramesRx attribute (UInt32) [0..1]

Number of link layer frames received.

LLFramesTx attribute (UInt32) [0..1]

Number of link layer frames transmitted.

LLMediaAccessFail attribute (UInt32) [0..1]

Number of times access to media failed.

LLOctetsRx attribute (UInt32) [0..1]

Number of bytes received.

LLOctetsTx attribute (UInt32) [0..1]

Number of bytes transmitted.

LLRetryCount attribute (UInt32) [0..1]

Number of MAC transmit retries.

LLSecurityErrorRx attribute (UInt32) [0..1]

Number of receive security errors.

LLInterfaceList Object (List)

List of LLInterface instances.

loWPAN Object ()

Contains information specific to 6LoWPAN.

octetsRx attribute (UInt32) [0..1]

Number of bytes received.

octetsTx attribute (UInt32) [0..1]

Number of bytes transmitted.

packetsRx attribute (UInt32)

Number of packets received.

packetsTx attribute (UInt32)

Number of packets transmitted.

rxFragError attribute (UInt32)

Number of errors receiving fragments.

Neighbor object (Resource)

Contains 802.15.4 link layer specific attributes.

isChild attribute (boolean)

True if the neighbor is a child.

linkQuality attribute (UInt8)

The quality of the link, as defined by IEEE Std 802.15.4.

shortAddress attribute (UInt16)

As defined by IEEE Std 802.15.4.

NeighborList object (List)

List of 802.15.4 neighbors.

RPLInstance object (Resource)

Specific RPLInstance resource. This resource may be thought of as network status information for a specific RPL instance associated with IPInterface.

DODAGid attribute (UInt8)

See IETF RFC 6550.

DODAGroot attribute (boolean)

See IETF RFC 6550.

flags attribute (UInt8)

See IETF RFC 6550.

groundedFlag attribute (boolean)

See IETF RFC 6550.

MOP attribute (UInt8)

See IETF RFC 6550.

PRF attribute (UInt8)

See IETF RFC 6550.

rank attribute (UInt16)

See IETF RFC 6550.

RPLInstanceID attribute (UInt8)

See IETF RFC 6550.

versionNumber attribute (UInt8)

See IETF RFC 6550.

RPLInstanceList object (List)

List of RPLInstances associated with the IPInterface.

RPLSourceRoutes object (Resource)

A RPL source routes object.

DestAddress attribute (HexBinary128)

See IETF RFC 6554.

SourceRoute attribute (HexBinary128)

See IETF RFC 6554.

RPLSourceRoutesList object (List)

List of RPL source routes if the hosting device is the DODAGroot.

B.2.12 LogEvents package

SubscribableResource

AbstractDevice

0..1

ListLink

LogEventListLink

SubscribableList

LogEventList

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

0..*

Resource

LogEvent

+ createdDateTime: TimeType

+ details: String32 [0..1]

+ extendedData: UInt32 [0..1]

+ functionSet: UInt8

+ logEventCode: UInt8

+ logEventID: UInt16

+ logEventPEN: PENType

+ profileID: UInt8

class LogEvents

Figure B.18—LogEvents

LogEvent object (Resource)

A time-stamped instance of a significant event detected by the device.

createdDateTime attribute (TimeType)

The date and time that the event occurred.

details attribute (String32) [0..1]

Human-readable text that MAY be used to transmit additional details about the event. A host MAY remove this field when received.

extendedData attribute (UInt32) [0..1]

May be used to transmit additional details about the event.

functionSet attribute (UInt8)

If the profileID indicates this is IEEE 2030.5, the functionSet is defined by IEEE Std 2030.5 and SHALL be one of the values from the list below (IEEE 2030.5 function set identifiers). If the profileID is anything else, the functionSet is defined by the identified profile.

0 = General (not specific to a function set)

1 = Publish and subscribe

2 = End device

3 = Function set assignment

4 = Response

5 = Demand response and load control

6 = Metering

7 = Pricing

8 = Messaging

9 = Billing

10 = Prepayment

11 = Distributed energy resources

12 = Time

13 = Software download

14 = Device information

15 = Power status

16 = Network status

17 = Log event list

18 = Configuration

19 = Security

All other values are reserved.

logEventCode attribute (UInt8)

An 8-bit unsigned integer. logEventCodes are scoped to a profile and a function set. If the profile is IEEE 2030.5, the logEventCode is defined by IEEE Std 2030.5 within one of the function sets of IEEE Std 2030.5. If the profile is anything else, the logEventCode is defined by the specified profile.

logEventID attribute (UInt16)

This 16-bit value, combined with createdDateTime, profileID, and logEventPEN, should provide a reasonable level of uniqueness.

logEventPEN attribute (PENType)

The Private Enterprise Number (PEN) of the entity that defined the profileID, functionSet, and logEventCode of the logEvent. IEEE Std 2030.5-assigned logEventCodes SHALL use the IEEE 2030.5 PEN. Combinations of profileID, functionSet, and logEventCode SHALL have unique meaning within a logEventPEN and are defined by the owner of the PEN.

profileID attribute (UInt8)

The profileID identifies which profile (HA, BA, SE, etc.) defines the following event information.

0 = Not profile specific

1 = Vendor defined

2 = IEEE 2030.5

3 = Home automation

4 = Building automation

All other values are reserved.

LogEventList object (SubscribableList)

A List element to hold LogEvent objects.

pollRate attribute (UInt32) [0..1] «XSDattribute»

B.2.13 Configuration package

class Configuration

SubscribableResource

AbstractDevice

0..1

Link

ConfigurationLink

SubscribableResource

Configuration

class Configuration

SubscribableResource

AbstractDevice

0..1

Link

ConfigurationLink

SubscribableResource

Configuration

class Configuration

SubscribableResource

AbstractDevice

0..1

Link

ConfigurationLink

SubscribableResource

Configuration

ListLink

+ currentLocale: LocaleType

+ userDeviceName: String32

«XSDattribute»

+ currentLocale: LocaleType

+ userDeviceName: String32

«XSDattribute»

+ currentLocale: LocaleType

+ userDeviceName: String32

«XSDattribute»

0..1

PriceResponseCfgListLink

List

+ pollRate: UInt32 [0..1] = 900

PriceResponseCfgList

0..*

PriceResponseCfgList

0..*

PriceResponseCfgList

0..*

0..1

Resource

PriceResponseCfg

+ consumeThreshold: Int32

+ maxReductionThreshold: Int32

Resource

PriceResponseCfg

+ consumeThreshold: Int32

+ maxReductionThreshold: Int32

Resource

PriceResponseCfg

+ consumeThreshold: Int32

+ maxReductionThreshold: Int32

TimeConfiguration

PowerConfiguration

dstEndRule: DstRuleType

dstOffset: TimeOffsetType dstStartRule: DstRuleType tzOffset: TimeOffsetType

dstEndRule: DstRuleType

dstOffset: TimeOffsetType dstStartRule: DstRuleType tzOffset: TimeOffsetType

dstEndRule: DstRuleType

dstOffset: TimeOffsetType dstStartRule: DstRuleType tzOffset: TimeOffsetType

+ batteryInstallTime: TimeType [0..1]

+ lowChargeThreshold: UInt32 [0..1]

+ batteryInstallTime: TimeType [0..1]

+ lowChargeThreshold: UInt32 [0..1]

+ batteryInstallTime: TimeType [0..1]

+ lowChargeThreshold: UInt32 [0..1]

Link

RateComponentLink

Link

RateComponentLink

Link

RateComponentLink

Figure B.19—Configuration Configuration object (SubscribableResource)

This resource contains various settings to control the operation of the device.

currentLocale attribute (LocaleType)

IETF RFC 4646 identifier of the language-region currently in use.

pollRate attribute (UInt32) [0..1] «XSDattribute»

userDeviceName attribute (String32)

User assigned, convenience name used for network browsing displays, etc. For example, “My Thermostat.”

PowerConfiguration object ()

Contains configuration related to the device’s power sources.

batteryInstallTime attribute (TimeType) [0..1]

Time/Date at which battery was installed.

lowChargeThreshold attribute (UInt32) [0..1]

In context of the PowerStatus resource, this is the value of EstimatedTimeRemaining below which BatteryStatus “low” is indicated and the PS_LOW_BATTERY is raised.

PriceResponseCfg object (Resource)

Configuration data that specifies how price-responsive devices SHOULD respond to price changes while acting upon a given RateComponent.

consumeThreshold attribute (Int32)

Price-responsive clients acting upon the associated RateComponent SHOULD consume the associated commodity while the price is less than this threshold.

maxReductionThreshold attribute (Int32)

Price-responsive clients acting upon the associated RateComponent SHOULD reduce consumption to the maximum extent possible while the price is greater than this threshold.

PriceResponseCfgList object (List)

A List element to hold PriceResponseCfg objects.

TimeConfiguration object ()

Contains attributes related to the configuration of the time service.

dstEndRule attribute (DstRuleType)

Rule to calculate end of daylight savings time in the current year. Result of dstEndRule must be greater than result of dstStartRule.

dstOffset attribute (TimeOffsetType)

Daylight savings time offset from local standard time.

dstStartRule attribute (DstRuleType)

Rule to calculate start of daylight savings time in the current year. Result of dstEndRule must be greater than result of dstStartRule.

tzOffset attribute (TimeOffsetType)

Local time zone offset from UTCTime. Does not include any daylight savings time offsets.

B.2.14 SoftwareDownload package

class Files

Resource

FunctionSetAssignmentsBase

class Files

Resource

FunctionSetAssignmentsBase

class Files

Resource

FunctionSetAssignmentsBase

SubscribableResource

AbstractDevice

SubscribableResource

AbstractDevice

SubscribableResource

AbstractDevice

0..1 0..1

ListLink Link

FileListLink FileStatusLink

0..1 0..1

ListLink Link

FileListLink FileStatusLink

0..1 0..1

ListLink Link

FileListLink FileStatusLink

List

Resource

FileList

type

A value indicating the type of the file. MUST be one of the following values: 00 = Software Image

01 = Security Credential 02 = Configuration

03 = Log

04–7FFF = reserved

8000-FFFF = Manufacturer defined

type

A value indicating the type of the file. MUST be one of the following values: 00 = Software Image

01 = Security Credential 02 = Configuration

03 = Log

04–7FFF = reserved

8000-FFFF = Manufacturer defined

type

A value indicating the type of the file. MUST be one of the following values: 00 = Software Image

01 = Security Credential 02 = Configuration

03 = Log

04–7FFF = reserved

8000-FFFF = Manufacturer defined

FileStatus

Link

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ activateTime: TimeType [0..1]

+ loadPercent: UInt8

+ nextRequestAttempt: TimeType

+ request503Count: UInt16

+ requestFailCount: UInt16

+ status: UInt8

+ statusTime: TimeType

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ activateTime: TimeType [0..1]

+ loadPercent: UInt8

+ nextRequestAttempt: TimeType

+ request503Count: UInt16

+ requestFailCount: UInt16

+ status: UInt8

+ statusTime: TimeType

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

+ activateTime: TimeType [0..1]

+ loadPercent: UInt8

+ nextRequestAttempt: TimeType

+ request503Count: UInt16

+ requestFailCount: UInt16

+ status: UInt8

+ statusTime: TimeType

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

0..1

FileLink

0..*

Resource

File

+ activateTime: TimeType [0..1]

+ fileURI: anyURI

+ lFDI: HexBinary160 [0..1]

+ mfHwVer: String32 [0..1]

+ mfID: PENType

+ mfModel: String32

+ mfSerNum: String32 [0..1]

+ mfVer: String16

+ size: UInt32

+ type: HexBinary16

+ activateTime: TimeType [0..1]

+ fileURI: anyURI

+ lFDI: HexBinary160 [0..1]

+ mfHwVer: String32 [0..1]

+ mfID: PENType

+ mfModel: String32

+ mfSerNum: String32 [0..1]

+ mfVer: String16

+ size: UInt32

+ type: HexBinary16

+ activateTime: TimeType [0..1]

+ fileURI: anyURI

+ lFDI: HexBinary160 [0..1]

+ mfHwVer: String32 [0..1]

+ mfID: PENType

+ mfModel: String32

+ mfSerNum: String32 [0..1]

+ mfVer: String16

+ size: UInt32

+ type: HexBinary16

status

Current loading status of the file indicated by FileLink. This element MUST be set to one of the following values:

0 - No load operation in progress

1 - File load in progress (first request for file content has been issued by LD)

2 - File load failed

3 - File loaded successfully (full content of file has been received by the LD), signature verification in progress

4 - File signature verification failed

5 - File signature verified, waiting to activate file.

6 - File activation failed

7 - File activation in progress

8 - File activated successfully (this state may not be reached/persisted through an image activation) 9-255 - Reserved for future use.

status

Current loading status of the file indicated by FileLink. This element MUST be set to one of the following values:

0 - No load operation in progress

1 - File load in progress (first request for file content has been issued by LD)

2 - File load failed

3 - File loaded successfully (full content of file has been received by the LD), signature verification in progress

4 - File signature verification failed

5 - File signature verified, waiting to activate file.

6 - File activation failed

7 - File activation in progress

8 - File activated successfully (this state may not be reached/persisted through an image activation) 9-255 - Reserved for future use.

status

Current loading status of the file indicated by FileLink. This element MUST be set to one of the following values:

0 - No load operation in progress

1 - File load in progress (first request for file content has been issued by LD)

2 - File load failed

3 - File loaded successfully (full content of file has been received by the LD), signature verification in progress

4 - File signature verification failed

5 - File signature verified, waiting to activate file.

6 - File activation failed

7 - File activation in progress

8 - File activated successfully (this state may not be reached/persisted through an image activation) 9-255 - Reserved for future use.

Figure B.20—Files

File object (Resource)

This resource contains various meta-data describing a file’s characteristics. The meta-data provides general file information and also is used to support filtered queries of file lists.

activateTime attribute (TimeType) [0..1]

This element MUST be set to the date/time at which this file is activated. If the activation time is less than or equal to current time, the LD MUST immediately place the file into the activated state (in the case of a firmware file, the file is now the running image). If the activation time is greater than the current time, the LD MUST wait until the specified activation time is reached, then MUST place the file into the activated state. Omission of this element means that the LD MUST NOT take any action to activate the file until a subsequent GET to this File resource provides an activateTime.

fileURI attribute (anyURI)

This element MUST be set to the URI location of the file binary artifact. This is the binary large object (BLOB) that is actually loaded by the LD.

lFDI attribute (HexBinary160) [0..1]

This element MUST be set to the LFDI of the device for which this file in targeted.

mfHwVer attribute (String32) [0..1]

This element MUST be set to the hardware version for which this file is targeted.

mfID attribute (PENType)

This element MUST be set to the manufacturer’s Private Enterprise Number (assigned by IANA).

mfModel attribute (String32)

This element MUST be set to the manufacturer model number for which this file is targeted. The syntax and semantics are left to the manufacturer.

mfSerNum attribute (String32) [0..1]

This element MUST be set to the manufacturer serial number for which this file is targeted. The syntax and semantics are left to the manufacturer.

mfVer attribute (String16)

This element MUST be set to the software version information for this file. The syntax and semantics are left to the manufacturer.

size attribute (UInt32)

This element MUST be set to the total size (in bytes) of the file referenced by fileURI.

type attribute (HexBinary16)

A value indicating the type of the file. MUST be one of the following values: 00 = Software image

01 = Security credential 02 = Configuration

03 = Log

04 to 7FFF = reserved

8000 to FFFF = Manufacturer defined

FileList object (List)

A List element to hold File objects.

pollRate attribute (UInt32) [0..1] «XSDattribute»

FileStatus object (Resource)

This object provides status of device file load and activation operations.

activateTime attribute (TimeType) [0..1]

Date/time at which this File, referred to by FileLink, will be activated. Omission of, or presence and value of, this element MUST exactly match omission or presence and value of the activateTime element from the File resource.

loadPercent attribute (UInt8)

This element MUST be set to the percentage of the file, indicated by FileLink, that was loaded during the latest load attempt. This value MUST be reset to 0 each time a load attempt is started for the File indicated by FileLink. This value MUST be increased when an LD receives HTTP response containing file content. This value MUST be set to 100 when the full content of the file has been received by the LD.

nextRequestAttempt attribute (TimeType)

This element MUST be set to the time at which the LD will issue its next GET request for file content from the File indicated by FileLink.

pollRate attribute (UInt32) [0..1] «XSDattribute»

request503Count attribute (UInt16)

This value MUST be reset to 0 when FileLink is first pointed at a new File. This value MUST be incremented each time an LD receives a 503 error from the FS.

requestFailCount attribute (UInt16)

This value MUST be reset to 0 when FileLink is first pointed at a new File. This value MUST be incremented each time a GET request for file content fails. 503 errors MUST be excluded from this counter.

status attribute (UInt8)

Current loading status of the file indicated by FileLink. This element MUST be set to one of the following values:

0 = No load operation in progress

1 = File load in progress (first request for file content has been issued by LD)

2 = File load failed

3 = File loaded successfully (full content of file has been received by the LD), signature verification in progress

4 = File signature verification failed

5 = File signature verified, waiting to activate file

6 = File activation failed

7 = File activation in progress

8 = File activated successfully (this state may not be reached/persisted through an image activation)

9 to 255 = Reserved for future use

statusTime attribute (TimeType)

This element MUST be set to the time at which file status transitioned to the value indicated in the status element.

B.2.15 DRLC package

Contains definitions for Demand Response Load Control functionality.

ListLink

DemandResponseProgramListLink

ListLink

DemandResponseProgramListLink

ListLink

DemandResponseProgramListLink

DRLC Event

EventStatus

RespondableSubscribableIdentifiedObject

Event

RespondableSubscribableIdentifiedObject

Event

RespondableSubscribableIdentifiedObject

Event

+ currentStatus: UInt8

+ dateTime: TimeType

+ potentiallySuperseded: boolean

+ potentiallySupersededTime: TimeType [0..1]

+ reason: String192 [0..1]

+ currentStatus: UInt8

+ dateTime: TimeType

+ potentiallySuperseded: boolean

+ potentiallySupersededTime: TimeType [0..1]

+ reason: String192 [0..1]

+ currentStatus: UInt8

+ dateTime: TimeType

+ potentiallySuperseded: boolean

+ potentiallySupersededTime: TimeType [0..1]

+ reason: String192 [0..1]

+ creationTime: TimeType

+ interval: DateTimeInterval

+ creationTime: TimeType

+ interval: DateTimeInterval

+ creationTime: TimeType

+ interval: DateTimeInterval

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

Resource

FunctionSetAssignmentsBase

RandomizableEvent

0..1

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

IdentifiedObject

ListLink

ActiveEndDeviceControlListLink

ListLink

ActiveEndDeviceControlListLink

ListLink

ActiveEndDeviceControlListLink

DemandResponseProgram

+ availabilityUpdatePercentChangeThreshold: PerCent [0..1] = 0

+ availabilityUpdatePowerChangeThreshold: ActivePower [0..1] = 0

+ primacy: PrimacyType

::IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::Resource

+ href: anyURI [0..1]

+ availabilityUpdatePercentChangeThreshold: PerCent [0..1] = 0

+ availabilityUpdatePowerChangeThreshold: ActivePower [0..1] = 0

+ primacy: PrimacyType

::IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::Resource

+ href: anyURI [0..1]

+ availabilityUpdatePercentChangeThreshold: PerCent [0..1] = 0

+ availabilityUpdatePowerChangeThreshold: ActivePower [0..1] = 0

+ primacy: PrimacyType

::IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::Resource

+ href: anyURI [0..1]

0..1

ListLink

EndDeviceControlListLink

ListLink

EndDeviceControlListLink

ListLink

EndDeviceControlListLink

0..1

EndDeviceControl

HexBinary32

DeviceCategoryType

notes

The Device category types defined.

Bit positions SHALL be defined as follows:

0 - Programmable Communicating Thermostat

1 - Strip Heaters

2 - Baseboard Heaters

3 - Water Heater

4 - Pool Pump

5 - Sauna

6 - Hot Tub

7 - Smart Appliance

8 - Irrigation Pump

9 - Managed Commercial and Industrial (C&I) Loads

10 - Simple Misc. (Residential On/Off) Loads

11 - Exterior Lighting

12 - Interior Lighting

13 - Load Control Switch

14 - Energy Management System

15 - Smart Energy Module

16 - Electric Vehicle

17 - EVSE

18 - Virtual or Mixed DER

19 - Reciprocating Engine

20 - Fuel Cell

21 - Photovoltaic System

22 - Combined Heat and Power

23 - Combined PV and Storage

24 - Other Generation System

25 - Other Storage System All other values reserved.

HexBinary32

DeviceCategoryType

notes

The Device category types defined.

Bit positions SHALL be defined as follows:

0 - Programmable Communicating Thermostat

1 - Strip Heaters

2 - Baseboard Heaters

3 - Water Heater

4 - Pool Pump

5 - Sauna

6 - Hot Tub

7 - Smart Appliance

8 - Irrigation Pump

9 - Managed Commercial and Industrial (C&I) Loads

10 - Simple Misc. (Residential On/Off) Loads

11 - Exterior Lighting

12 - Interior Lighting

13 - Load Control Switch

14 - Energy Management System

15 - Smart Energy Module

16 - Electric Vehicle

17 - EVSE

18 - Virtual or Mixed DER

19 - Reciprocating Engine

20 - Fuel Cell

21 - Photovoltaic System

22 - Combined Heat and Power

23 - Combined PV and Storage

24 - Other Generation System

25 - Other Storage System All other values reserved.

HexBinary32

DeviceCategoryType

notes

The Device category types defined.

Bit positions SHALL be defined as follows:

0 - Programmable Communicating Thermostat

1 - Strip Heaters

2 - Baseboard Heaters

3 - Water Heater

4 - Pool Pump

5 - Sauna

6 - Hot Tub

7 - Smart Appliance

8 - Irrigation Pump

9 - Managed Commercial and Industrial (C&I) Loads

10 - Simple Misc. (Residential On/Off) Loads

11 - Exterior Lighting

12 - Interior Lighting

13 - Load Control Switch

14 - Energy Management System

15 - Smart Energy Module

16 - Electric Vehicle

17 - EVSE

18 - Virtual or Mixed DER

19 - Reciprocating Engine

20 - Fuel Cell

21 - Photovoltaic System

22 - Combined Heat and Power

23 - Combined PV and Storage

24 - Other Generation System

25 - Other Storage System All other values reserved.

+ deviceCategory: DeviceCategoryType

+ drProgramMandatory: boolean

+ loadShiftForward: boolean

+ overrideDuration: UInt16 [0..1] = 0

::RandomizableEvent

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

::Event

+ creationTime: TimeType 0..1 + interval: DateTimeInterval

::RespondableSubscribableIdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::RespondableSubscribableIdentifiedObject

+ subscribable: SubscribableType [0..1] = 0

::RespondableResource

+ replyTo: anyURI [0..1]

+ responseRequired: HexBinary8 [0..1] = 00

::Resource

+ href: anyURI [0..1]

DutyCycle

+ normalValue: UInt8

+ deviceCategory: DeviceCategoryType

+ drProgramMandatory: boolean

+ loadShiftForward: boolean

+ overrideDuration: UInt16 [0..1] = 0

::RandomizableEvent

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

::Event

+ creationTime: TimeType 0..1 + interval: DateTimeInterval

::RespondableSubscribableIdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::RespondableSubscribableIdentifiedObject

+ subscribable: SubscribableType [0..1] = 0

::RespondableResource

+ replyTo: anyURI [0..1]

+ responseRequired: HexBinary8 [0..1] = 00

::Resource

+ href: anyURI [0..1]

DutyCycle

+ normalValue: UInt8

+ deviceCategory: DeviceCategoryType

+ drProgramMandatory: boolean

+ loadShiftForward: boolean

+ overrideDuration: UInt16 [0..1] = 0

::RandomizableEvent

+ randomizeDuration: OneHourRangeType [0..1] = 0

+ randomizeStart: OneHourRangeType [0..1] = 0

::Event

+ creationTime: TimeType 0..1 + interval: DateTimeInterval

::RespondableSubscribableIdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::RespondableSubscribableIdentifiedObject

+ subscribable: SubscribableType [0..1] = 0

::RespondableResource

+ replyTo: anyURI [0..1]

+ responseRequired: HexBinary8 [0..1] = 00

::Resource

+ href: anyURI [0..1]

DutyCycle

+ normalValue: UInt8

Offset

+ coolingOffset: UInt8 [0..1]

+ heatingOffset: UInt8 [0..1]

+ loadAdjustmentPercentageOffset: PerCent [0..1]

SetPoint

+ coolingOffset: UInt8 [0..1]

+ heatingOffset: UInt8 [0..1]

+ loadAdjustmentPercentageOffset: PerCent [0..1]

SetPoint

+ coolingOffset: UInt8 [0..1]

+ heatingOffset: UInt8 [0..1]

+ loadAdjustmentPercentageOffset: PerCent [0..1]

SetPoint

+ coolingSetpoint: Int16 [0..1]

+ heatingSetpoint: Int16 [0..1]

+ coolingSetpoint: Int16 [0..1]

+ heatingSetpoint: Int16 [0..1]

+ coolingSetpoint: Int16 [0..1]

+ heatingSetpoint: Int16 [0..1]

TargetReduction

+ type: UnitType

+ value: UInt16

+ type: UnitType

+ value: UInt16

+ type: UnitType

+ value: UInt16

ApplianceLoadReduction

+ type: ApplianceLoadReductionType

ApplianceLoadReduction

+ type: ApplianceLoadReductionType

ApplianceLoadReduction

+ type: ApplianceLoadReductionType

Figure B.21—DRLC event

SubscribableResource

AbstractDevice

0..1

ListLink

LoadShedAvailabilityListLink

class Load Shed Availability

0..*

0..1

Link

DemandResponseProgramLink

Link

DemandResponseProgramLink

Link

DemandResponseProgramLink

+ availabilityDuration: UInt32 [0..1]

+ sheddablePercent: PerCent [0..1]

+ sheddablePower: ActivePower [0..1]

«XSDattribute»

::Resource

+ href: anyURI [0..1]

+ availabilityDuration: UInt32 [0..1]

+ sheddablePercent: PerCent [0..1]

+ sheddablePower: ActivePower [0..1]

«XSDattribute»

::Resource

+ href: anyURI [0..1]

+ availabilityDuration: UInt32 [0..1]

+ sheddablePercent: PerCent [0..1]

+ sheddablePower: ActivePower [0..1]

«XSDattribute»

::Resource

+ href: anyURI [0..1]

LoadShedAvailability

Resource

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

LoadShedAvailabilityList

List

Figure B.22—LoadShedAvailability LoadShedAvailabilityList Object (List)

A List element to hold LoadShedAvailability objects.

pollRate attribute (UInt32) [0..1] «XSDattribute»

ApplianceLoadReduction Object ()

The ApplianceLoadReduction object is used by a Demand Response service provider to provide signals for Energy Star–compliant appliances. See the definition of ApplianceLoadReductionType for more information.

type attribute (ApplianceLoadReductionType)

Indicates the type of appliance load reduction requested.

DemandResponseProgram Object (IdentifiedObject)

Demand response program.

availabilityUpdatePercentChangeThreshold attribute (PerCent) [0..1]

This attribute allows program providers to specify the requested granularity of updates to LoadShedAvailability sheddablePercent. If not present, or set to 0, then updates to LoadShedAvailability SHALL NOT be provided. If present and greater than zero, then clients SHALL provide their LoadShedAvailability if it has not previously been provided, and thereafter if the difference between the previously provided value and the current value of LoadShedAvailability sheddablePercent is greater than availabilityUpdatePercentChangeThreshold.

availabilityUpdatePowerChangeThreshold attribute (ActivePower) [0..1]

This attribute allows program providers to specify the requested granularity of updates to LoadShedAvailability sheddablePower. If not present, or set to 0, then updates to LoadShedAvailability SHALL NOT be provided. If present and greater than zero, then clients SHALL provide their LoadShedAvailability if it has not previously been provided, and thereafter if the difference between the previously provided value and the current value of LoadShedAvailability sheddablePower is greater than availabilityUpdatePowerChangeThreshold.

primacy attribute (PrimacyType)

Indicates the relative primacy of the provider of this program.

DemandResponseProgramList Object (SubscribableList)

A List element to hold DemandResponseProgram objects.

pollRate attribute (UInt32) [0..1] «XSDattribute»

DutyCycle Object ()

Duty cycle control is a device specific issue and is managed by the device. The duty cycle of the device under control should span the shortest practical time period in accordance with the nature of the device under control and the intent of the request for demand reduction. The default factory setting SHOULD be three minutes for each 10% of duty cycle. This indicates that the default time period over which a duty cycle is applied is 30 minutes, meaning a 10% duty cycle would cause a device to be on for 3 minutes. The “off state” SHALL precede the “on state.”

normalValue attribute (UInt8)

Contains the maximum on state duty cycle applied by the end device, as a percentage of time. The field not present indicates that this field has not been used by the end device.

EndDeviceControl Object (RandomizableEvent)

Instructs an EndDevice to perform a specified action.

deviceCategory attribute (DeviceCategoryType)

Specifies the bitmap indicating the categories of devices that SHOULD respond. Devices SHOULD ignore events that do not indicate their device category.

drProgramMandatory attribute (boolean)

A flag to indicate if the EndDeviceControl is considered a mandatory event as defined by the service provider issuing the EndDeviceControl. The drProgramMandatory flag alerts the client/user that they will be subject to penalty or ineligibility based on the service provider’s program rules for that deviceCategory.

loadShiftForward attribute (boolean)

Indicates that the event intends to increase consumption. A value of true indicates the intention to increase usage value, and a value of false indicates the intention to decrease usage.

overrideDuration attribute (UInt16) [0..1]

The overrideDuration attribute provides a duration, in seconds, for which a client device is allowed to override this EndDeviceControl and still meet the contractual agreement with a service provider without opting out. If overrideDuration is not specified, then it SHALL default to 0.

EndDeviceControlList Object (SubscribableList)

A List element to hold EndDeviceControl objects.

LoadShedAvailability Object (Resource)

Indicates current consumption status and ability to shed load.

availabilityDuration attribute (UInt32) [0..1]

Indicates for how many seconds the consuming device will be able to reduce consumption at the maximum response level.

sheddablePercent attribute (PerCent) [0..1]

Maximum percent of current operating load that is estimated to be sheddable.

sheddablePower attribute (ActivePower) [0..1]

Maximum amount of current operating load that is estimated to be sheddable, in watts.

Association object ()

Offset object ()

If a temperature offset is sent that causes the heating or cooling temperature set point to exceed the limit boundaries that are programmed into the device, the device SHALL respond by setting the temperature at the limit.

If an end device control (EDC) is being targeted at multiple devices or to a device that controls multiple devices (e.g., energy management system [EMS]), it can provide multiple Offset types within one EDC. For events with multiple Offset types, a client SHALL select the Offset that best fits their operating function.

Alternatively, an event with a single Offset type can be targeted at an EMS in order to request a percentage load reduction on the average energy usage of the entire premise. An EMS SHOULD use the Metering function set to determine the initial load in the premise, reduce energy consumption by controlling devices at its disposal, and at the conclusion of the event, once again use the Metering function set to determine if the desired load reduction was achieved.

coolingOffset attribute (UInt8) [0..1]

The value change requested for the cooling offset, in °C/10. The value should be added to the normal set point for cooling, or if loadShiftForward is true, then the value should be subtracted from the normal set point.

heatingOffset attribute (UInt8) [0..1]

The value change requested for the heating offset, in °C/10. The value should be subtracted for heating, or if loadShiftForward is true, then the value should be added to the normal set point.

loadAdjustmentPercentageOffset attribute (PerCent) [0..1]

The value change requested for the load adjustment percentage. The value should be subtracted from the normal setting, or if loadShiftForward is true, then the value should be added to the normal setting.

SetPoint object ()

The SetPoint object is used to apply specific temperature set points to a temperature control device. The values of the heatingSetpoint and coolingSetpoint attributes SHALL be calculated as follows:

Cooling/Heating Temperature Set Point 100

= temperature in °C where −273.15 °C  temperature  327.67 °C,

corresponding to a Cooling and/or Heating Temperature Set Point. The maximum resolution this format allows is 0.01 °C.

The field not present in a Response indicates that this field has not been used by the end device.

If a temperature is sent that exceeds the temperature limit boundaries that are programmed into the device, the device SHALL respond by setting the temperature at the limit.

coolingSetpoint attribute (Int16) [0..1]

This attribute represents the cooling temperature set point in °C /100 (hundredths of a degree Celsius).

heatingSetpoint attribute (Int16) [0..1]

This attribute represents the heating temperature set point in °C/100 (hundredths of a degree Celsius).

TargetReduction Object ()

The TargetReduction object is used by a Demand Response service provider to provide a RECOMMENDED threshold that a device/premises should maintain its consumption below. For example, a service provider can provide a RECOMMENDED threshold of some kWh for a 3-hour event. This means that the device/premises would maintain its consumption below the specified limit for the specified period.

type attribute (UnitType)

Indicates the type of reduction requested.

value attribute (UInt16)

Indicates the requested amount of the relevant commodity to be reduced.

B.2.16 Metering package

Contains definitions related to measurements of energy at usage points.

Metering Data

SubscribableList

UsagePointList

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

Metering Data

SubscribableList

UsagePointList

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

Metering Data

SubscribableList

UsagePointList

«XSDattribute»

+ pollRate: UInt32 [0..1] = 900

ListLink

0..1 RateComponentListLink

ListLink

0..1 RateComponentListLink

ListLink

0..1 RateComponentListLink

0..*

ListLink

UsagePoint 0..1 MeterReadingListLink

0..*

ListLink

UsagePoint 0..1 MeterReadingListLink

0..*

ListLink

UsagePoint 0..1 MeterReadingListLink

+ deviceLFDI: HexBinary160 [0..1]

MeterReadingBase

MeterReading

MeterReadingBase

MeterReading

MeterReadingBase

MeterReading

Link

ReadingTypeLink

Resource

IdentifiedObject

UsagePointBase

IdentifiedObject

UsagePointBase

IdentifiedObject

UsagePointBase

UInt8

ServiceKind

UInt8

ServiceKind

UInt8

ServiceKind

+ roleFlags: RoleFlagsType

+ serviceCategoryKind: ServiceKind

+ status: UInt8

+ roleFlags: RoleFlagsType

+ serviceCategoryKind: ServiceKind

+ status: UInt8

+ roleFlags: RoleFlagsType

+ serviceCategoryKind: ServiceKind

+ status: UInt8

notes

Service kind

0 - electricity

1 - gas

2 - water

3 - time

4 - pressure

5 - heat

6 - cooling

All other values reserved.

notes

Service kind

0 - electricity

1 - gas

2 - water

3 - time

4 - pressure

5 - heat

6 - cooling

All other values reserved.

notes

Service kind

0 - electricity

1 - gas

2 - water

3 - time

4 - pressure

5 - heat

6 - cooling

All other values reserved.

::IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::Resource

+ href: anyURI [0..1]

::IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::Resource

+ href: anyURI [0..1]

::IdentifiedObject

+ description: String32 [0..1]

+ mRID: mRIDType

+ version: VersionType [0..1] = 0

«XSDattribute»

::Resource

+ href: anyURI [0..1]

ReadingType

0..1

status

Specifies the current status of the service at this usage point.

0 = off

1 = on

status

Specifies the current status of the service at this usage point.

0 = off

1 = on

status

Specifies the current status of the service at this usage point.

0 = off

1 = on

ListLink

roleFlags

Specifies the roles that

apply to the usage point.

roleFlags

Specifies the roles that

apply to the usage point.

roleFlags

Specifies the roles that

apply to the usage point.

ReadingSetListLink

ReadingSetBase

ReadingSet

ReadingSetBase

ReadingSet

ReadingSetBase

ReadingSet

+ accumulationBehaviour: AccumulationBehaviourType [0..1] = 0

+ calorificValue: UnitValueType [0..1]

+ commodity: CommodityType [0..1] = 0

+ conversionFactor: UnitValueType [0..1] = 1

+ dataQualifier: DataQualifierType [0..1] = 0

+ flowDirection: FlowDirectionType [0..1] = 0

+ intervalLength: UInt32 [0..1]

+ kind: KindType [0..1] = 0

+ maxNumberOfIntervals: UInt8 [0..1]

+ numberOfConsumptionBlocks: UInt8 [0..1] = 0

+ numberOfTouTiers: UInt8 [0..1] = 0

+ phase: PhaseCode [0..1] = 0

+ powerOfTenMultiplier: PowerOfTenMultiplierType [0..1] = 0

+ subIntervalLength: UInt32 [0..1]

+ supplyLimit: UInt48 [0..1]

+ tieredConsumptionBlocks: boolean [0..1] = false

+ uom: UomType [0..1] = 0

+ accumulationBehaviour: AccumulationBehaviourType [0..1] = 0

+ calorificValue: UnitValueType [0..1]

+ commodity: CommodityType [0..1] = 0

+ conversionFactor: UnitValueType [0..1] = 1

+ dataQualifier: DataQualifierType [0..1] = 0

+ flowDirection: FlowDirectionType [0..1] = 0

+ intervalLength: UInt32 [0..1]

+ kind: KindType [0..1] = 0

+ maxNumberOfIntervals: UInt8 [0..1]

+ numberOfConsumptionBlocks: UInt8 [0..1] = 0

+ numberOfTouTiers: UInt8 [0..1] = 0

+ phase: PhaseCode [0..1] = 0

+ powerOfTenMultiplier: PowerOfTenMultiplierType [0..1] = 0

+ subIntervalLength: UInt32 [0..1]

+ supplyLimit: UInt48 [0..1]

+ tieredConsumptionBlocks: boolean [0..1] = false

+ uom: UomType [0..1] = 0

+ accumulationBehaviour: AccumulationBehaviourType [0..1] = 0

+ calorificValue: UnitValueType [0..1]

+ commodity: CommodityType [0..1] = 0

+ conversionFactor: UnitValueType [0..1] = 1

+ dataQualifier: DataQualifierType [0..1] = 0

+ flowDirection: FlowDirectionType [0..1] = 0

+ intervalLength: UInt32 [0..1]

+ kind: KindType [0..1] = 0

+ maxNumberOfIntervals: UInt8 [0..1]

+ numberOfConsumptionBlocks: UInt8 [0..1] = 0

+ numberOfTouTiers: UInt8 [0..1] = 0

+ phase: PhaseCode [0..1] = 0

+ powerOfTenMultiplier: PowerOfTenMultiplierType [0..1] = 0

+ subIntervalLength: UInt32 [0..1]

+ supplyLimit: UInt48 [0..1]

+ tieredConsumptionBlocks: boolean [0..1] = false

+ uom: UomType [0..1] = 0

0..1

ListLink

ReadingListLink

0..1

ListLink

ReadingListLink

0..1

ListLink

ReadingListLink

0..1

HexBinary16

Link

RoleFlagsType

ReadingLink

notes

Specifies the roles that apply to a usage point.

Bit 0 - isMirror - SHALL be set if the server is not the measurement device

Bit 1 - isPremisesAggregationPoint - SHALL be set if the UsagePoint is the point of delivery for a premises

Bit 2 - isPEV - SHALL be set if the usage applies to an electric vehicle Bit 3 - isDER - SHALL be set if the usage applies to a distributed energy resource, capable of delivering power to the grid.

Bit 4 - isRevenueQuality - SHALL be set if usage was measured by a device certified as revenue quality

Bit 5 - isDC - SHALL be set if the usage point measures direct current Bit 6 - isSubmeter - SHALL be set if the usage point is not a premises aggregation point

Bit 7-15 - Reserved

notes

Specifies the roles that apply to a usage point.

Bit 0 - isMirror - SHALL be set if the server is not the measurement device

Bit 1 - isPremisesAggregationPoint - SHALL be set if the UsagePoint is the point of delivery for a premises

Bit 2 - isPEV - SHALL be set if the usage applies to an electric vehicle Bit 3 - isDER - SHALL be set if the usage applies to a distributed energy resource, capable of delivering power to the grid.

Bit 4 - isRevenueQuality - SHALL be set if usage was measured by a device certified as revenue quality

Bit 5 - isDC - SHALL be set if the usage point measures direct current Bit 6 - isSubmeter - SHALL be set if the usage point is not a premises aggregation point

Bit 7-15 - Reserved

notes

Specifies the roles that apply to a usage point.

Bit 0 - isMirror - SHALL be set if the server is not the measurement device

Bit 1 - isPremisesAggregationPoint - SHALL be set if the UsagePoint is the point of delivery for a premises

Bit 2 - isPEV - SHALL be set if the usage applies to an electric vehicle Bit 3 - isDER - SHALL be set if the usage applies to a distributed energy resource, capable of delivering power to the grid.

Bit 4 - isRevenueQuality - SHALL be set if usage was measured by a device certified as revenue quality

Bit 5 - isDC - SHALL be set if the usage point measures direct current Bit 6 - isSubmeter - SHALL be set if the usage point is not a premises aggregation point

Bit 7-15 - Reserved

qualityFlags

List of codes indicating the quality of the reading, using specification:

qualityFlags

List of codes indicating the quality of the reading, using specification:

qualityFlags

List of codes indicating the quality of the reading, using specification:

ReadingBase

Reading

+ localID: HexBinary16 [0..1]

::ReadingBase

+ consumptionBlock: ConsumptionBlockType [0..1] = 0

+ qualityFlags: HexBinary16 [0..1] = 00

+ timePeriod: DateTimeInterval [0..1]

+ touTier: TOUType [0..1] = 0

+ value: Int48 [0..1]

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

::Resource

+ href: anyURI [0..1]

ReadingBase

Reading

+ localID: HexBinary16 [0..1]

::ReadingBase

+ consumptionBlock: ConsumptionBlockType [0..1] = 0

+ qualityFlags: HexBinary16 [0..1] = 00

+ timePeriod: DateTimeInterval [0..1]

+ touTier: TOUType [0..1] = 0

+ value: Int48 [0..1]

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

::Resource

+ href: anyURI [0..1]

ReadingBase

Reading

+ localID: HexBinary16 [0..1]

::ReadingBase

+ consumptionBlock: ConsumptionBlockType [0..1] = 0

+ qualityFlags: HexBinary16 [0..1] = 00

+ timePeriod: DateTimeInterval [0..1]

+ touTier: TOUType [0..1] = 0

+ value: Int48 [0..1]

«XSDattribute»

+ subscribable: SubscribableType [0..1] = 0

::Resource

+ href: anyURI [0..1]

Bit 0 - valid: data that has gone through all required validation

checks and either passed them all or has been verified Bit 1 - manually edited: Replaced or approved by a human

Bit 2 - estimated using reference day: data value was replaced by a machine computed value based on analysis of historical data using the same type of measurement.

Bit 3 - estimated using linear interpolation: data value was computed using linear interpolation based on the readings before and after it

Bit 4 - questionable: data that has failed one or more checks Bit 5 - derived: data that has been calculated (using logic or mathematical operations), not necessarily measured directly Bit 6 - projected (forecast): data that has been calculated as a projection or forecast of future readings