Class: EndDeviceControl

name: EndDeviceControl
description: "Instructs an end device (or an end device group) to perform a specified\
  \ action.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  dr_program_level:
    name: dr_program_level
    description: '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).'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.drProgramLevel
    multivalued: false
    domain_of:
    - EndDeviceControl
    range: integer
    required: false
  dr_program_mandatory:
    name: dr_program_mandatory
    description: '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).'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.drProgramMandatory
    multivalued: false
    domain_of:
    - EndDeviceControl
    range: boolean
    required: false
  issuer_id:
    name: issuer_id
    description: "Unique identifier of the business entity originating an end device\
      \ control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.issuerID
    multivalued: false
    domain_of:
    - EndDeviceEvent
    - EndDeviceControl
    range: string
    required: false
  issuer_tracking_id:
    name: issuer_tracking_id
    description: "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.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.issuerTrackingID
    multivalued: false
    domain_of:
    - EndDeviceEvent
    - EndDeviceControl
    range: string
    required: false
  price_signal:
    name: price_signal
    description: (if applicable) Price signal used as parameter for this end device
      control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.priceSignal
    multivalued: false
    domain_of:
    - EndDeviceControl
    range: float
    required: false
  primary_device_timing:
    name: primary_device_timing
    description: "Timing for the control actions performed on the device identified\
      \ in the end device control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.primaryDeviceTiming
    multivalued: false
    domain_of:
    - EndDeviceControl
    range: EndDeviceTiming
    required: false
  reason:
    name: reason
    description: 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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.reason
    multivalued: false
    domain_of:
    - Status
    - PlannedOutage
    - ActivityRecord
    - AccountMovement
    - Reading
    - EndDeviceControl
    - MetrologyRequirement
    - TimeSeries
    - MarketDocument
    - Point
    - RegisteredResource
    - EnergyTransaction
    - Period
    range: string
    required: false
  scheduled_interval:
    name: scheduled_interval
    description: (if control has scheduled duration) Date and time interval the control
      has been scheduled to execute within.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.scheduledInterval
    multivalued: false
    domain_of:
    - EndDeviceControl
    range: DateTimeInterval
    required: false
  secondary_device_timing:
    name: secondary_device_timing
    description: "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.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.secondaryDeviceTiming
    multivalued: false
    domain_of:
    - EndDeviceControl
    range: EndDeviceTiming
    required: false
  end_device_action:
    name: end_device_action
    description: End device action issued by this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.EndDeviceAction
    multivalued: false
    domain_of:
    - EndDeviceControl
    range: EndDeviceAction
    required: false
  end_devices:
    name: end_devices
    description: All end devices receiving commands from this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.EndDevices
    multivalued: true
    domain_of:
    - Customer
    - UsagePoint
    - EndDeviceControl
    - EndDeviceGroup
    - ServiceLocation
    - EndDeviceInfo
    range: EndDevice
    required: false
  usage_points:
    name: usage_points
    description: All usage points receiving commands from this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.UsagePoints
    multivalued: true
    domain_of:
    - Equipment
    - CustomerAgreement
    - ServiceCategory
    - PricingStructure
    - EndDeviceControl
    - UsagePointGroup
    - ServiceLocation
    - MetrologyRequirement
    - ServiceSupplier
    - UsagePointLocation
    range: UsagePoint
    required: false
  usage_point_groups:
    name: usage_point_groups
    description: All usage point groups receiving commands from this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.UsagePointGroups
    multivalued: true
    domain_of:
    - UsagePoint
    - EndDeviceControl
    - DemandResponseProgram
    range: UsagePointGroup
    required: false
  end_device_control_type:
    name: end_device_control_type
    description: Type of this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.EndDeviceControlType
    multivalued: false
    domain_of:
    - EndDeviceControl
    range: EndDeviceControlType
    required: true
  end_device_groups:
    name: end_device_groups
    description: All end device groups receiving commands from this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.EndDeviceGroups
    multivalued: true
    domain_of:
    - EndDevice
    - EndDeviceControl
    - DemandResponseProgram
    range: EndDeviceGroup
    required: false
class_uri: cim:EndDeviceControl

name: EndDeviceControl
description: "Instructs an end device (or an end device group) to perform a specified\
  \ action.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  dr_program_level:
    name: dr_program_level
    description: '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).'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.drProgramLevel
    multivalued: false
    alias: dr_program_level
    owner: EndDeviceControl
    domain_of:
    - EndDeviceControl
    range: integer
    required: false
  dr_program_mandatory:
    name: dr_program_mandatory
    description: '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).'
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.drProgramMandatory
    multivalued: false
    alias: dr_program_mandatory
    owner: EndDeviceControl
    domain_of:
    - EndDeviceControl
    range: boolean
    required: false
  issuer_id:
    name: issuer_id
    description: "Unique identifier of the business entity originating an end device\
      \ control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.issuerID
    multivalued: false
    alias: issuer_id
    owner: EndDeviceControl
    domain_of:
    - EndDeviceEvent
    - EndDeviceControl
    range: string
    required: false
  issuer_tracking_id:
    name: issuer_tracking_id
    description: "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.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.issuerTrackingID
    multivalued: false
    alias: issuer_tracking_id
    owner: EndDeviceControl
    domain_of:
    - EndDeviceEvent
    - EndDeviceControl
    range: string
    required: false
  price_signal:
    name: price_signal
    description: (if applicable) Price signal used as parameter for this end device
      control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.priceSignal
    multivalued: false
    alias: price_signal
    owner: EndDeviceControl
    domain_of:
    - EndDeviceControl
    range: float
    required: false
  primary_device_timing:
    name: primary_device_timing
    description: "Timing for the control actions performed on the device identified\
      \ in the end device control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.primaryDeviceTiming
    multivalued: false
    alias: primary_device_timing
    owner: EndDeviceControl
    domain_of:
    - EndDeviceControl
    range: EndDeviceTiming
    required: false
  reason:
    name: reason
    description: 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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.reason
    multivalued: false
    alias: reason
    owner: EndDeviceControl
    domain_of:
    - Status
    - PlannedOutage
    - ActivityRecord
    - AccountMovement
    - Reading
    - EndDeviceControl
    - MetrologyRequirement
    - TimeSeries
    - MarketDocument
    - Point
    - RegisteredResource
    - EnergyTransaction
    - Period
    range: string
    required: false
  scheduled_interval:
    name: scheduled_interval
    description: (if control has scheduled duration) Date and time interval the control
      has been scheduled to execute within.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.scheduledInterval
    multivalued: false
    alias: scheduled_interval
    owner: EndDeviceControl
    domain_of:
    - EndDeviceControl
    range: DateTimeInterval
    required: false
  secondary_device_timing:
    name: secondary_device_timing
    description: "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.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.secondaryDeviceTiming
    multivalued: false
    alias: secondary_device_timing
    owner: EndDeviceControl
    domain_of:
    - EndDeviceControl
    range: EndDeviceTiming
    required: false
  end_device_action:
    name: end_device_action
    description: End device action issued by this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.EndDeviceAction
    multivalued: false
    alias: end_device_action
    owner: EndDeviceControl
    domain_of:
    - EndDeviceControl
    range: EndDeviceAction
    required: false
  end_devices:
    name: end_devices
    description: All end devices receiving commands from this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.EndDevices
    multivalued: true
    alias: end_devices
    owner: EndDeviceControl
    domain_of:
    - Customer
    - UsagePoint
    - EndDeviceControl
    - EndDeviceGroup
    - ServiceLocation
    - EndDeviceInfo
    range: EndDevice
    required: false
  usage_points:
    name: usage_points
    description: All usage points receiving commands from this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.UsagePoints
    multivalued: true
    alias: usage_points
    owner: EndDeviceControl
    domain_of:
    - Equipment
    - CustomerAgreement
    - ServiceCategory
    - PricingStructure
    - EndDeviceControl
    - UsagePointGroup
    - ServiceLocation
    - MetrologyRequirement
    - ServiceSupplier
    - UsagePointLocation
    range: UsagePoint
    required: false
  usage_point_groups:
    name: usage_point_groups
    description: All usage point groups receiving commands from this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.UsagePointGroups
    multivalued: true
    alias: usage_point_groups
    owner: EndDeviceControl
    domain_of:
    - UsagePoint
    - EndDeviceControl
    - DemandResponseProgram
    range: UsagePointGroup
    required: false
  end_device_control_type:
    name: end_device_control_type
    description: Type of this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceControl.EndDeviceControlType
    multivalued: false
    alias: end_device_control_type
    owner: EndDeviceControl
    domain_of:
    - EndDeviceControl
    range: EndDeviceControlType
    required: true
  end_device_groups:
    name: end_device_groups
    description: All end device groups receiving commands from this end device control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControl.EndDeviceGroups
    multivalued: true
    alias: end_device_groups
    owner: EndDeviceControl
    domain_of:
    - EndDevice
    - EndDeviceControl
    - DemandResponseProgram
    range: EndDeviceGroup
    required: false
  alias_name:
    name: alias_name
    description: "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.\r\nThe 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.\r\
      \n\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.aliasName
    multivalued: false
    alias: alias_name
    owner: EndDeviceControl
    domain_of:
    - IdentifiedObject
    range: string
    required: false
  description:
    name: description
    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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.description
    multivalued: false
    alias: description
    owner: EndDeviceControl
    domain_of:
    - IdentifiedObject
    - NameType
    - NameTypeAuthority
    - DataSet
    - SwitchingStepGroup
    - AreaReserveSpec
    range: string
    required: false
  m_rid:
    name: m_rid
    description: "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.\r\nFor 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."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.mRID
    multivalued: false
    alias: m_rid
    owner: EndDeviceControl
    domain_of:
    - IdentifiedObject
    - DataSet
    range: string
    required: false
  diagram_objects:
    name: diagram_objects
    description: The diagram objects that are associated with the domain object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.DiagramObjects
    multivalued: true
    alias: diagram_objects
    owner: EndDeviceControl
    domain_of:
    - IdentifiedObject
    range: DiagramObject
    required: false
  instance_set:
    name: instance_set
    description: Dataset containing the data objects.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.InstanceSet
    multivalued: false
    alias: instance_set
    owner: EndDeviceControl
    domain_of:
    - IdentifiedObject
    range: InstanceSet
    required: true
  names:
    name: names
    description: All names of this identified object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.Names
    multivalued: true
    alias: names
    owner: EndDeviceControl
    domain_of:
    - IdentifiedObject
    - NameType
    range: Name
    required: false
  properties_cimdata_object:
    name: properties_cimdata_object
    description: The single CIM data object in the appropriate dataset context.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
    multivalued: false
    alias: properties_cimdata_object
    owner: EndDeviceControl
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
  targeting_cimdata_object:
    name: targeting_cimdata_object
    description: Data objects registered.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
    multivalued: true
    alias: targeting_cimdata_object
    owner: EndDeviceControl
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:EndDeviceControl