EndDeviceControl

Instructs an end device (or an end device group) to perform a specified action.

Type

Class

URI

cim:EndDeviceControl

CIM standard (perspective)

IEC61968 (Enterprise)

Class hierarchy

Slots

Associated classes
Figure 1. Associated classes
Name Cardinality Type Description

EndDeviceControlType

1

EndDeviceControlType

Type of this end device control.

InstanceSet

1

InstanceSet

Dataset containing the data objects.

EndDeviceAction

0..1

EndDeviceAction

End device action issued by this end device control.

drProgramLevel

0..1

integer

Level of a demand response program request, where 0=emergency. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).

drProgramMandatory

0..1

boolean

Whether a demand response program request is mandatory. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).

issuerID

0..1

string

Unique identifier of the business entity originating an end device control.

issuerTrackingID

0..1

string

Identifier assigned by the initiator (e.g. retail electric provider) of an end device control action to uniquely identify the demand response event, text message, or other subject of the control action. Can be used when cancelling an event or text message request or to identify the originating event or text message in a consequential end device event.

priceSignal

0..1

float

(if applicable) Price signal used as parameter for this end device control.

primaryDeviceTiming

0..1

EndDeviceTiming

Timing for the control actions performed on the device identified in the end device control.

reason

0..1

string

Reason for the control action that allows to determine how to continue processing. For example, disconnect meter command may require different processing by the receiving system if it has been issued for a network-related reason (protection) or for a payment-related reason.

scheduledInterval

0..1

DateTimeInterval

(if control has scheduled duration) Date and time interval the control has been scheduled to execute within.

secondaryDeviceTiming

0..1

EndDeviceTiming

Timing for the control actions performed by devices that are responding to event related information sent to the primary device indicated in the end device control. For example, load control actions performed by a PAN device in response to demand response event information sent to a PAN gateway server.

EndDeviceGroups

0..*

EndDeviceGroup

All end device groups receiving commands from this end device control.

EndDevices

0..*

EndDevice

All end devices receiving commands from this end device control.

UsagePointGroups

0..*

UsagePointGroup

All usage point groups receiving commands from this end device control.

UsagePoints

0..*

UsagePoint

All usage points receiving commands from this end device control.

PropertiesCIMDataObject

0..1

ChangeSetMember

The single CIM data object in the appropriate dataset context.

aliasName

0..1

string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy. The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

description

0..1

string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

mRID

0..1

string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

name

0..1

string

The name is any free human readable and possibly non unique text naming the object.

DiagramObjects

0..*

DiagramObject

The diagram objects that are associated with the domain object.

Names

0..*

Name

All names of this identified object.

TargetingCIMDataObject

0..*

ChangeSetMember

Data objects registered.


aliasName

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy. The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

URI

cim:IdentifiedObject.aliasName

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

description

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

URI

cim:IdentifiedObject.description

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

DiagramObjects

The diagram objects that are associated with the domain object.

URI

cim:IdentifiedObject.DiagramObjects

Cardinality

0..*

Type

DiagramObject

Inherited from

IdentifiedObject

drProgramLevel

Level of a demand response program request, where 0=emergency. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).

URI

cim:EndDeviceControl.drProgramLevel

Cardinality

0..1

Type

integer

drProgramMandatory

Whether a demand response program request is mandatory. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).

URI

cim:EndDeviceControl.drProgramMandatory

Cardinality

0..1

Type

boolean

EndDeviceAction

End device action issued by this end device control.

URI

cim:EndDeviceControl.EndDeviceAction

Cardinality

0..1

Type

EndDeviceAction

EndDeviceControlType

Type of this end device control.

URI

cim:EndDeviceControl.EndDeviceControlType

Cardinality

1

Type

EndDeviceControlType

EndDeviceGroups

All end device groups receiving commands from this end device control.

URI

cim:EndDeviceControl.EndDeviceGroups

Cardinality

0..*

Type

EndDeviceGroup

EndDevices

All end devices receiving commands from this end device control.

URI

cim:EndDeviceControl.EndDevices

Cardinality

0..*

Type

EndDevice

InstanceSet

Dataset containing the data objects.

URI

cim:IdentifiedObject.InstanceSet

Cardinality

1

Type

InstanceSet

Inherited from

IdentifiedObject

issuerID

Unique identifier of the business entity originating an end device control.

URI

cim:EndDeviceControl.issuerID

Cardinality

0..1

Type

string

issuerTrackingID

Identifier assigned by the initiator (e.g. retail electric provider) of an end device control action to uniquely identify the demand response event, text message, or other subject of the control action. Can be used when cancelling an event or text message request or to identify the originating event or text message in a consequential end device event.

URI

cim:EndDeviceControl.issuerTrackingID

Cardinality

0..1

Type

string

mRID

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

URI

cim:IdentifiedObject.mRID

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

name

The name is any free human readable and possibly non unique text naming the object.

URI

cim:IdentifiedObject.name

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

Names

All names of this identified object.

URI

cim:IdentifiedObject.Names

Cardinality

0..*

Type

Name

Inherited from

IdentifiedObject

priceSignal

(if applicable) Price signal used as parameter for this end device control.

URI

cim:EndDeviceControl.priceSignal

Cardinality

0..1

Type

float

primaryDeviceTiming

Timing for the control actions performed on the device identified in the end device control.

URI

cim:EndDeviceControl.primaryDeviceTiming

Cardinality

0..1

Type

EndDeviceTiming

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

reason

Reason for the control action that allows to determine how to continue processing. For example, disconnect meter command may require different processing by the receiving system if it has been issued for a network-related reason (protection) or for a payment-related reason.

URI

cim:EndDeviceControl.reason

Cardinality

0..1

Type

string

scheduledInterval

(if control has scheduled duration) Date and time interval the control has been scheduled to execute within.

URI

cim:EndDeviceControl.scheduledInterval

Cardinality

0..1

Type

DateTimeInterval

secondaryDeviceTiming

Timing for the control actions performed by devices that are responding to event related information sent to the primary device indicated in the end device control. For example, load control actions performed by a PAN device in response to demand response event information sent to a PAN gateway server.

URI

cim:EndDeviceControl.secondaryDeviceTiming

Cardinality

0..1

Type

EndDeviceTiming

TargetingCIMDataObject

Data objects registered.

URI

cim:IdentifiedObject.TargetingCIMDataObject

Cardinality

0..*

Type

ChangeSetMember

Inherited from

IdentifiedObject

UsagePointGroups

All usage point groups receiving commands from this end device control.

URI

cim:EndDeviceControl.UsagePointGroups

Cardinality

0..*

Type

UsagePointGroup

UsagePoints

All usage points receiving commands from this end device control.

URI

cim:EndDeviceControl.UsagePoints

Cardinality

0..*

Type

UsagePoint