Skip to content

Class: EndDeviceEvent

Event detected by a device function associated with the end device.

URI: cim:EndDeviceEvent

 classDiagram
    class EndDeviceEvent
      ActivityRecord <|-- EndDeviceEvent

      EndDeviceEvent : alias_name

      EndDeviceEvent : assets

          EndDeviceEvent --> Asset : assets

      EndDeviceEvent : author

          EndDeviceEvent --> Author : author

      EndDeviceEvent : created_date_time

      EndDeviceEvent : description

      EndDeviceEvent : diagram_objects

          EndDeviceEvent --> DiagramObject : diagram_objects

      EndDeviceEvent : document

          EndDeviceEvent --> Document : document

      EndDeviceEvent : end_device

          EndDeviceEvent --> EndDevice : end_device

      EndDeviceEvent : end_device_event_details

          EndDeviceEvent --> EndDeviceEventDetail : end_device_event_details

      EndDeviceEvent : end_device_event_type

          EndDeviceEvent --> EndDeviceEventType : end_device_event_type

      EndDeviceEvent : instance_set

          EndDeviceEvent --> InstanceSet : instance_set

      EndDeviceEvent : issuer_id

      EndDeviceEvent : issuer_tracking_id

      EndDeviceEvent : m_rid

      EndDeviceEvent : meter_reading

          EndDeviceEvent --> MeterReading : meter_reading

      EndDeviceEvent : names

          EndDeviceEvent --> Name : names

      EndDeviceEvent : properties_cimdata_object

          EndDeviceEvent --> ChangeSetMember : properties_cimdata_object

      EndDeviceEvent : reason

      EndDeviceEvent : severity

      EndDeviceEvent : status

          EndDeviceEvent --> Status : status

      EndDeviceEvent : targeting_cimdata_object

          EndDeviceEvent --> ChangeSetMember : targeting_cimdata_object

      EndDeviceEvent : type

      EndDeviceEvent : usage_point

          EndDeviceEvent --> UsagePoint : usage_point

      EndDeviceEvent : user_id

Inheritance

Slots

Name Cardinality and Range Description Inheritance
issuer_id 0..1
String		 Unique identifier of the business entity originating an end device control direct
issuer_tracking_id 0..1
String		 Identifier assigned by the initiator (e direct
user_id 0..1
String		 (if user initiated) ID of user who initiated this end device event direct
end_device 0..1
EndDevice		 End device that reported this end device event direct
end_device_event_details 0..*
EndDeviceEventDetail		 All details of this end device event direct
end_device_event_type 1..1
EndDeviceEventType		 Type of this end device event direct
usage_point 0..1
UsagePoint		 Usage point for which this end device event is reported direct
meter_reading 0..1
MeterReading		 Set of measured values to which this event applies direct
created_date_time 0..1
date		 Date and time this activity record has been created (different from the 'stat... ActivityRecord
reason 0..1
String		 Reason for event resulting in this activity record, typically supplied when u... ActivityRecord
severity 0..1
String		 Severity level of event resulting in this activity record ActivityRecord
status 0..1
Status		 Information on consequence of event resulting in this activity record ActivityRecord
type 0..1
String		 Type of event resulting in this activity record ActivityRecord
document 0..1
Document		 The document having associated activity records ActivityRecord
author 0..1
Author		 Author of this activity record ActivityRecord
assets 0..*
Asset		 All assets for which this activity record has been created ActivityRecord
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
UsagePoint end_device_events range EndDeviceEvent
MeterReading end_device_events range EndDeviceEvent
Meter end_device_events range EndDeviceEvent
EndDevice end_device_events range EndDeviceEvent
EndDeviceEventDetail end_device_event range EndDeviceEvent
EndDeviceEventType end_device_events range EndDeviceEvent
MarketEvaluationPoint end_device_events range EndDeviceEvent

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: EndDeviceEvent
description: Event detected by a device function associated with the end device.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ActivityRecord
attributes:
  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
    rank: 1000
    slot_uri: cim:EndDeviceEvent.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
    rank: 1000
    slot_uri: cim:EndDeviceEvent.issuerTrackingID
    multivalued: false
    domain_of:
    - EndDeviceEvent
    - EndDeviceControl
    range: string
    required: false
  user_id:
    name: user_id
    description: (if user initiated) ID of user who initiated this end device event.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceEvent.userID
    multivalued: false
    domain_of:
    - ElectronicAddress
    - EndDeviceEvent
    - MarketPerson
    range: string
    required: false
  end_device:
    name: end_device
    description: End device that reported this end device event.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceEvent.EndDevice
    multivalued: false
    domain_of:
    - MeterReadSchedule
    - EndDeviceEvent
    - EndDeviceFunction
    range: EndDevice
    required: false
  end_device_event_details:
    name: end_device_event_details
    description: All details of this end device event.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceEvent.EndDeviceEventDetails
    multivalued: true
    domain_of:
    - EndDeviceEvent
    range: EndDeviceEventDetail
    required: false
  end_device_event_type:
    name: end_device_event_type
    description: Type of this end device event.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceEvent.EndDeviceEventType
    multivalued: false
    domain_of:
    - EndDeviceEvent
    range: EndDeviceEventType
    required: true
  usage_point:
    name: usage_point
    description: Usage point for which this end device event is reported.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceEvent.UsagePoint
    multivalued: false
    domain_of:
    - MeterReadSchedule
    - MeterReading
    - EndDevice
    - EndDeviceEvent
    - Register
    - MeterWorkTask
    - PlannedOutageNotification
    - EnvironmentalMonitoringStation
    - ServiceMultiplier
    range: UsagePoint
    required: false
  meter_reading:
    name: meter_reading
    description: Set of measured values to which this event applies.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceEvent.MeterReading
    multivalued: false
    domain_of:
    - IntervalBlock
    - EndDeviceEvent
    range: MeterReading
    required: false
class_uri: cim:EndDeviceEvent

Induced

name: EndDeviceEvent
description: Event detected by a device function associated with the end device.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ActivityRecord
attributes:
  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
    rank: 1000
    slot_uri: cim:EndDeviceEvent.issuerID
    multivalued: false
    alias: issuer_id
    owner: EndDeviceEvent
    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
    rank: 1000
    slot_uri: cim:EndDeviceEvent.issuerTrackingID
    multivalued: false
    alias: issuer_tracking_id
    owner: EndDeviceEvent
    domain_of:
    - EndDeviceEvent
    - EndDeviceControl
    range: string
    required: false
  user_id:
    name: user_id
    description: (if user initiated) ID of user who initiated this end device event.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceEvent.userID
    multivalued: false
    alias: user_id
    owner: EndDeviceEvent
    domain_of:
    - ElectronicAddress
    - EndDeviceEvent
    - MarketPerson
    range: string
    required: false
  end_device:
    name: end_device
    description: End device that reported this end device event.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceEvent.EndDevice
    multivalued: false
    alias: end_device
    owner: EndDeviceEvent
    domain_of:
    - MeterReadSchedule
    - EndDeviceEvent
    - EndDeviceFunction
    range: EndDevice
    required: false
  end_device_event_details:
    name: end_device_event_details
    description: All details of this end device event.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceEvent.EndDeviceEventDetails
    multivalued: true
    alias: end_device_event_details
    owner: EndDeviceEvent
    domain_of:
    - EndDeviceEvent
    range: EndDeviceEventDetail
    required: false
  end_device_event_type:
    name: end_device_event_type
    description: Type of this end device event.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceEvent.EndDeviceEventType
    multivalued: false
    alias: end_device_event_type
    owner: EndDeviceEvent
    domain_of:
    - EndDeviceEvent
    range: EndDeviceEventType
    required: true
  usage_point:
    name: usage_point
    description: Usage point for which this end device event is reported.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceEvent.UsagePoint
    multivalued: false
    alias: usage_point
    owner: EndDeviceEvent
    domain_of:
    - MeterReadSchedule
    - MeterReading
    - EndDevice
    - EndDeviceEvent
    - Register
    - MeterWorkTask
    - PlannedOutageNotification
    - EnvironmentalMonitoringStation
    - ServiceMultiplier
    range: UsagePoint
    required: false
  meter_reading:
    name: meter_reading
    description: Set of measured values to which this event applies.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceEvent.MeterReading
    multivalued: false
    alias: meter_reading
    owner: EndDeviceEvent
    domain_of:
    - IntervalBlock
    - EndDeviceEvent
    range: MeterReading
    required: false
  created_date_time:
    name: created_date_time
    description: "Date and time this activity record has been created (different from\
      \ the 'status.dateTime', which is the time of a status change of the associated\
      \ object, if applicable).\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ActivityRecord.createdDateTime
    multivalued: false
    alias: created_date_time
    owner: EndDeviceEvent
    domain_of:
    - Document
    - ActivityRecord
    range: date
    required: false
  reason:
    name: reason
    description: Reason for event resulting in this activity record, typically supplied
      when user initiated.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ActivityRecord.reason
    multivalued: false
    alias: reason
    owner: EndDeviceEvent
    domain_of:
    - Status
    - PlannedOutage
    - ActivityRecord
    - AccountMovement
    - Reading
    - EndDeviceControl
    - MetrologyRequirement
    - TimeSeries
    - MarketDocument
    - Point
    - RegisteredResource
    - EnergyTransaction
    - Period
    range: string
    required: false
  severity:
    name: severity
    description: Severity level of event resulting in this activity record.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ActivityRecord.severity
    multivalued: false
    alias: severity
    owner: EndDeviceEvent
    domain_of:
    - ActivityRecord
    range: string
    required: false
  status:
    name: status
    description: Information on consequence of event resulting in this activity record.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ActivityRecord.status
    multivalued: false
    alias: status
    owner: EndDeviceEvent
    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 event resulting in this activity record.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ActivityRecord.type
    multivalued: false
    alias: type
    owner: EndDeviceEvent
    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
  document:
    name: document
    description: The document having associated activity records
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ActivityRecord.Document
    multivalued: false
    alias: document
    owner: EndDeviceEvent
    domain_of:
    - ActivityRecord
    range: Document
    required: false
  author:
    name: author
    description: Author of this activity record.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ActivityRecord.Author
    multivalued: false
    alias: author
    owner: EndDeviceEvent
    domain_of:
    - Document
    - ActivityRecord
    range: Author
    required: false
  assets:
    name: assets
    description: All assets for which this activity record has been created.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ActivityRecord.Assets
    multivalued: true
    alias: assets
    owner: EndDeviceEvent
    domain_of:
    - PowerSystemResource
    - AssetInfo
    - Location
    - WorkTask
    - ErpRecDelvLineItem
    - AssetContainer
    - ActivityRecord
    - Procedure
    - ReliabilityInfo
    - AssetPropertyCurve
    - AssetOrganisationRole
    - ScheduledEvent
    range: Asset
    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: EndDeviceEvent
    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: EndDeviceEvent
    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: EndDeviceEvent
    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: EndDeviceEvent
    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: EndDeviceEvent
    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: EndDeviceEvent
    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: EndDeviceEvent
    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: EndDeviceEvent
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:EndDeviceEvent