Skip to content

Class: EndDeviceGroup

Abstraction for management of group communications within a two-way AMR system or the data for a group of related end devices. Commands can be issued to all of the end devices that belong to the group using a defined group address and the underlying AMR communication infrastructure. A DERGroup and a PANDeviceGroup is an EndDeviceGroup.

URI: cim:EndDeviceGroup

 classDiagram
    class EndDeviceGroup
      IdentifiedObject <|-- EndDeviceGroup

      EndDeviceGroup : alias_name

      EndDeviceGroup : demand_response_programs

          EndDeviceGroup --> DemandResponseProgram : demand_response_programs

      EndDeviceGroup : der_function

          EndDeviceGroup --> DERFunction : der_function

      EndDeviceGroup : derfunction

          EndDeviceGroup --> DERFunction : derfunction

      EndDeviceGroup : dergroup_dispatch

          EndDeviceGroup --> DERGroupDispatch : dergroup_dispatch

      EndDeviceGroup : dergroup_forecast

          EndDeviceGroup --> DERGroupForecast : dergroup_forecast

      EndDeviceGroup : dermonitorable_parameter

          EndDeviceGroup --> DERMonitorableParameter : dermonitorable_parameter

      EndDeviceGroup : description

      EndDeviceGroup : diagram_objects

          EndDeviceGroup --> DiagramObject : diagram_objects

      EndDeviceGroup : end_device_controls

          EndDeviceGroup --> EndDeviceControl : end_device_controls

      EndDeviceGroup : end_devices

          EndDeviceGroup --> EndDevice : end_devices

      EndDeviceGroup : instance_set

          EndDeviceGroup --> InstanceSet : instance_set

      EndDeviceGroup : m_rid

      EndDeviceGroup : meter_read_schedule

          EndDeviceGroup --> MeterReadSchedule : meter_read_schedule

      EndDeviceGroup : names

          EndDeviceGroup --> Name : names

      EndDeviceGroup : properties_cimdata_object

          EndDeviceGroup --> ChangeSetMember : properties_cimdata_object

      EndDeviceGroup : status

          EndDeviceGroup --> Status : status

      EndDeviceGroup : targeting_cimdata_object

          EndDeviceGroup --> ChangeSetMember : targeting_cimdata_object

      EndDeviceGroup : type

      EndDeviceGroup : version

          EndDeviceGroup --> Version : version

Inheritance

Slots

Name Cardinality and Range Description Inheritance
status 0..1
Status		 Current status information relevant to a group direct
type 0..1
String		 Type of this group direct
version 0..1
Version		 version of this group direct
dergroup_dispatch 0..*
DERGroupDispatch		 An individual dispatch for a DER Group direct
end_device_controls 0..*
EndDeviceControl		 All end device controls sending commands to this end device group direct
dermonitorable_parameter 0..*
DERMonitorableParameter		 The DER monitorable parameters associated with a DER Group direct
der_function 0..*
DERFunction		 The DER functions that are applied to the DER Group direct
end_devices 0..*
EndDevice		 All end devices this end device group refers to direct
meter_read_schedule 0..1
MeterReadSchedule		 Meter read schedule that applies to the end device group direct
demand_response_programs 0..*
DemandResponseProgram		 All demand response programs this group of end devices is enrolled in direct
derfunction 0..1
DERFunction		 Functions supported by the DER Group direct
dergroup_forecast 1..*
DERGroupForecast		 An individual forecast for a DER Group direct
alias_name 0..1
String		 The aliasName is free text human readable name of the object alternative to I... IdentifiedObject
description 0..1
String		 The description is a free human readable text describing or naming the object IdentifiedObject
m_rid 0..1
String		 Master resource identifier issued by a model authority IdentifiedObject
diagram_objects 0..*
DiagramObject		 The diagram objects that are associated with the domain object IdentifiedObject
instance_set 1..1
InstanceSet		 Dataset containing the data objects IdentifiedObject
names 0..*
Name		 All names of this identified object IdentifiedObject
properties_cimdata_object 0..1
ChangeSetMember		 The single CIM data object in the appropriate dataset context IdentifiedObject
targeting_cimdata_object 0..*
ChangeSetMember		 Data objects registered IdentifiedObject

Usages

used by used in type used
MeterReadSchedule end_device_group range EndDeviceGroup
Meter end_device_groups range EndDeviceGroup
EndDevice end_device_groups range EndDeviceGroup
EndDeviceControl end_device_groups range EndDeviceGroup
DemandResponseProgram end_device_groups range EndDeviceGroup
DERFunction end_device_group range EndDeviceGroup
DERGroupForecast end_device_group range EndDeviceGroup
DERGroupDispatch end_device_group range EndDeviceGroup
DERMonitorableParameter end_device_group range EndDeviceGroup

Identifier and Mapping Information

Schema Source

  • from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type Mapped Value
self cim:EndDeviceGroup
native cim:EndDeviceGroup

LinkML Source

Direct

name: EndDeviceGroup
description: Abstraction for management of group communications within a two-way AMR
  system or the data for a group of related end devices. Commands can be issued to
  all of the end devices that belong to the group using a defined group address and
  the underlying AMR communication infrastructure. A DERGroup and a PANDeviceGroup
  is an EndDeviceGroup.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  status:
    name: status
    description: Current status information relevant to a group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.status
    multivalued: false
    domain_of:
    - Asset
    - Document
    - Customer
    - StreetAddress
    - Location
    - ErpQuoteLineItem
    - CostType
    - ErpJournalEntry
    - ErpRecLineItem
    - ErpPayableLineItem
    - ContractorItem
    - Capability
    - Craft
    - OldPerson
    - ErpPersonnel
    - LaborItem
    - DesignLocationCU
    - DesignLocation
    - ConditionFactor
    - MiscCostItem
    - CUGroup
    - WorkFlowStep
    - ErpTimeEntry
    - OverheadCost
    - PropertyUnit
    - CUMaterialItem
    - ErpIssueInventory
    - ErpReqLineItem
    - ErpRecDelvLineItem
    - Role
    - LandProperty
    - ErpSiteLevelData
    - Crew
    - ActivityRecord
    - ErpLedgerEntry
    - ErpLedBudLineItem
    - TransformerObservation
    - BushingInsulationPF
    - WindingInsulation
    - CULaborItem
    - CULaborCode
    - EndDeviceGroup
    - Hazard
    - CUWorkEquipmentItem
    - ShiftPattern
    - Route
    - Usage
    - CUContractorItem
    - CUAllowableAction
    - TypeAssetCatalogue
    - AssetModelCatalogue
    - Market
    - CRROrgRole
    - MarketScheduledEvent
    - MarketLedgerEntry
    - MarketPerson
    - MarketQualificationRequirement
    - ResourceGroup
    - ResourceAwardInstruction
    - ExPostResourceResults
    - MarketObjectStatus
    - TimePoint
    - ErpItemMaster
    - ScheduledEvent
    - ScheduledEventData
    - ErpInventory
    - ErpInventoryCount
    - RedLine
    - BusinessRole
    - BidTimeSeries
    range: Status
    required: false
  type:
    name: type
    description: Type of this group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.type
    multivalued: false
    domain_of:
    - Asset
    - AcceptanceTest
    - Document
    - StreetDetail
    - Location
    - Priority
    - CatalogAssetType
    - Capability
    - Craft
    - OldPerson
    - Role
    - ActivityRecord
    - EndDeviceEventType
    - EndDeviceGroup
    - DemandResponseProgram
    - UsagePointGroup
    - EndDeviceControlType
    - Hazard
    - OldCrew
    - Route
    - ConstraintDuration
    - AceTariffType
    - ControlArea
    - SynchronousMachine
    - ChargeProfile
    - ChargeComponent
    - MarketRole
    - ResourceGroup
    - Quantity
    - ResourceCertification
    - Auction
    - ScheduledEvent
    - PotentialTransformer
    - BusinessRole
    range: string
    required: false
  version:
    name: version
    description: version of this group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.version
    multivalued: false
    domain_of:
    - IEC61970CIMVersion
    - NetworkModelProjectComponent2
    - EndDeviceGroup
    - TimeSeries
    - AlertTypeList
    - IEC61968CIMVersion
    - IEC62325CIMVersion
    - PackageDependenciesCIMVersion
    range: Version
    required: false
  dergroup_dispatch:
    name: dergroup_dispatch
    description: An individual dispatch for a DER Group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DERGroupDispatch
    multivalued: true
    domain_of:
    - EndDeviceGroup
    range: DERGroupDispatch
    required: false
  end_device_controls:
    name: end_device_controls
    description: All end device controls sending commands to this end device group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.EndDeviceControls
    multivalued: true
    domain_of:
    - UsagePoint
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    - EndDeviceControlType
    range: EndDeviceControl
    required: false
  dermonitorable_parameter:
    name: dermonitorable_parameter
    description: The DER monitorable parameters associated with a DER Group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DERMonitorableParameter
    multivalued: true
    domain_of:
    - EndDeviceGroup
    - DERCurveData
    - DispatchSchedule
    range: DERMonitorableParameter
    required: false
  der_function:
    name: der_function
    description: The DER functions that are applied to the DER Group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DER%20Function
    multivalued: true
    domain_of:
    - EndDeviceGroup
    range: DERFunction
    required: false
  end_devices:
    name: end_devices
    description: All end devices this end device group refers to.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.EndDevices
    multivalued: true
    domain_of:
    - Customer
    - UsagePoint
    - EndDeviceControl
    - EndDeviceGroup
    - ServiceLocation
    - EndDeviceInfo
    range: EndDevice
    required: false
  meter_read_schedule:
    name: meter_read_schedule
    description: Meter read schedule that applies to the end device group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.MeterReadSchedule
    multivalued: false
    domain_of:
    - TimeSchedule
    - UsagePoint
    - CustomerAgreement
    - CustomerAccount
    - ReadingType
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    range: MeterReadSchedule
    required: false
  demand_response_programs:
    name: demand_response_programs
    description: All demand response programs this group of end devices is enrolled
      in.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.DemandResponsePrograms
    multivalued: true
    domain_of:
    - CustomerAgreement
    - EndDeviceGroup
    - UsagePointGroup
    range: DemandResponseProgram
    required: false
  derfunction:
    name: derfunction
    description: Functions supported by the DER Group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DERFunction
    multivalued: false
    domain_of:
    - EndDeviceGroup
    range: DERFunction
    required: false
  dergroup_forecast:
    name: dergroup_forecast
    description: An individual forecast for a DER Group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DERGroupForecast
    multivalued: true
    domain_of:
    - EndDeviceGroup
    range: DERGroupForecast
    required: true
class_uri: cim:EndDeviceGroup

Induced

name: EndDeviceGroup
description: Abstraction for management of group communications within a two-way AMR
  system or the data for a group of related end devices. Commands can be issued to
  all of the end devices that belong to the group using a defined group address and
  the underlying AMR communication infrastructure. A DERGroup and a PANDeviceGroup
  is an EndDeviceGroup.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  status:
    name: status
    description: Current status information relevant to a group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.status
    multivalued: false
    alias: status
    owner: EndDeviceGroup
    domain_of:
    - Asset
    - Document
    - Customer
    - StreetAddress
    - Location
    - ErpQuoteLineItem
    - CostType
    - ErpJournalEntry
    - ErpRecLineItem
    - ErpPayableLineItem
    - ContractorItem
    - Capability
    - Craft
    - OldPerson
    - ErpPersonnel
    - LaborItem
    - DesignLocationCU
    - DesignLocation
    - ConditionFactor
    - MiscCostItem
    - CUGroup
    - WorkFlowStep
    - ErpTimeEntry
    - OverheadCost
    - PropertyUnit
    - CUMaterialItem
    - ErpIssueInventory
    - ErpReqLineItem
    - ErpRecDelvLineItem
    - Role
    - LandProperty
    - ErpSiteLevelData
    - Crew
    - ActivityRecord
    - ErpLedgerEntry
    - ErpLedBudLineItem
    - TransformerObservation
    - BushingInsulationPF
    - WindingInsulation
    - CULaborItem
    - CULaborCode
    - EndDeviceGroup
    - Hazard
    - CUWorkEquipmentItem
    - ShiftPattern
    - Route
    - Usage
    - CUContractorItem
    - CUAllowableAction
    - TypeAssetCatalogue
    - AssetModelCatalogue
    - Market
    - CRROrgRole
    - MarketScheduledEvent
    - MarketLedgerEntry
    - MarketPerson
    - MarketQualificationRequirement
    - ResourceGroup
    - ResourceAwardInstruction
    - ExPostResourceResults
    - MarketObjectStatus
    - TimePoint
    - ErpItemMaster
    - ScheduledEvent
    - ScheduledEventData
    - ErpInventory
    - ErpInventoryCount
    - RedLine
    - BusinessRole
    - BidTimeSeries
    range: Status
    required: false
  type:
    name: type
    description: Type of this group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.type
    multivalued: false
    alias: type
    owner: EndDeviceGroup
    domain_of:
    - Asset
    - AcceptanceTest
    - Document
    - StreetDetail
    - Location
    - Priority
    - CatalogAssetType
    - Capability
    - Craft
    - OldPerson
    - Role
    - ActivityRecord
    - EndDeviceEventType
    - EndDeviceGroup
    - DemandResponseProgram
    - UsagePointGroup
    - EndDeviceControlType
    - Hazard
    - OldCrew
    - Route
    - ConstraintDuration
    - AceTariffType
    - ControlArea
    - SynchronousMachine
    - ChargeProfile
    - ChargeComponent
    - MarketRole
    - ResourceGroup
    - Quantity
    - ResourceCertification
    - Auction
    - ScheduledEvent
    - PotentialTransformer
    - BusinessRole
    range: string
    required: false
  version:
    name: version
    description: version of this group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.version
    multivalued: false
    alias: version
    owner: EndDeviceGroup
    domain_of:
    - IEC61970CIMVersion
    - NetworkModelProjectComponent2
    - EndDeviceGroup
    - TimeSeries
    - AlertTypeList
    - IEC61968CIMVersion
    - IEC62325CIMVersion
    - PackageDependenciesCIMVersion
    range: Version
    required: false
  dergroup_dispatch:
    name: dergroup_dispatch
    description: An individual dispatch for a DER Group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DERGroupDispatch
    multivalued: true
    alias: dergroup_dispatch
    owner: EndDeviceGroup
    domain_of:
    - EndDeviceGroup
    range: DERGroupDispatch
    required: false
  end_device_controls:
    name: end_device_controls
    description: All end device controls sending commands to this end device group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.EndDeviceControls
    multivalued: true
    alias: end_device_controls
    owner: EndDeviceGroup
    domain_of:
    - UsagePoint
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    - EndDeviceControlType
    range: EndDeviceControl
    required: false
  dermonitorable_parameter:
    name: dermonitorable_parameter
    description: The DER monitorable parameters associated with a DER Group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DERMonitorableParameter
    multivalued: true
    alias: dermonitorable_parameter
    owner: EndDeviceGroup
    domain_of:
    - EndDeviceGroup
    - DERCurveData
    - DispatchSchedule
    range: DERMonitorableParameter
    required: false
  der_function:
    name: der_function
    description: The DER functions that are applied to the DER Group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DER%20Function
    multivalued: true
    alias: der_function
    owner: EndDeviceGroup
    domain_of:
    - EndDeviceGroup
    range: DERFunction
    required: false
  end_devices:
    name: end_devices
    description: All end devices this end device group refers to.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.EndDevices
    multivalued: true
    alias: end_devices
    owner: EndDeviceGroup
    domain_of:
    - Customer
    - UsagePoint
    - EndDeviceControl
    - EndDeviceGroup
    - ServiceLocation
    - EndDeviceInfo
    range: EndDevice
    required: false
  meter_read_schedule:
    name: meter_read_schedule
    description: Meter read schedule that applies to the end device group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.MeterReadSchedule
    multivalued: false
    alias: meter_read_schedule
    owner: EndDeviceGroup
    domain_of:
    - TimeSchedule
    - UsagePoint
    - CustomerAgreement
    - CustomerAccount
    - ReadingType
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    range: MeterReadSchedule
    required: false
  demand_response_programs:
    name: demand_response_programs
    description: All demand response programs this group of end devices is enrolled
      in.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceGroup.DemandResponsePrograms
    multivalued: true
    alias: demand_response_programs
    owner: EndDeviceGroup
    domain_of:
    - CustomerAgreement
    - EndDeviceGroup
    - UsagePointGroup
    range: DemandResponseProgram
    required: false
  derfunction:
    name: derfunction
    description: Functions supported by the DER Group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DERFunction
    multivalued: false
    alias: derfunction
    owner: EndDeviceGroup
    domain_of:
    - EndDeviceGroup
    range: DERFunction
    required: false
  dergroup_forecast:
    name: dergroup_forecast
    description: An individual forecast for a DER Group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceGroup.DERGroupForecast
    multivalued: true
    alias: dergroup_forecast
    owner: EndDeviceGroup
    domain_of:
    - EndDeviceGroup
    range: DERGroupForecast
    required: true
  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: EndDeviceGroup
    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: EndDeviceGroup
    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: EndDeviceGroup
    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: EndDeviceGroup
    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: EndDeviceGroup
    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: EndDeviceGroup
    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: EndDeviceGroup
    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: EndDeviceGroup
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:EndDeviceGroup