Skip to content

Class: PanDemandResponse

_PAN control used to issue action/command to PAN devices during a demand response/load control event. _

__

URI: cim:PanDemandResponse

 classDiagram
    class PanDemandResponse
      EndDeviceAction <|-- PanDemandResponse

      PanDemandResponse : appliance

          PanDemandResponse --> ControlledAppliance : appliance

      PanDemandResponse : avg_load_adjustment

          PanDemandResponse --> PerCent : avg_load_adjustment

      PanDemandResponse : cancel_control_mode

      PanDemandResponse : cancel_date_time

      PanDemandResponse : cancel_now

      PanDemandResponse : command

      PanDemandResponse : cooling_offset

          PanDemandResponse --> Temperature : cooling_offset

      PanDemandResponse : cooling_setpoint

          PanDemandResponse --> Temperature : cooling_setpoint

      PanDemandResponse : criticality_level

      PanDemandResponse : duration

          PanDemandResponse --> Minutes : duration

      PanDemandResponse : duration_indefinite

      PanDemandResponse : duty_cycle

          PanDemandResponse --> PerCent : duty_cycle

      PanDemandResponse : end_device_control

          PanDemandResponse --> EndDeviceControl : end_device_control

      PanDemandResponse : enrollment_group

      PanDemandResponse : heating_offset

          PanDemandResponse --> Temperature : heating_offset

      PanDemandResponse : heating_setpoint

          PanDemandResponse --> Temperature : heating_setpoint

      PanDemandResponse : start_date_time

Inheritance

Slots

Name Cardinality and Range Description Inheritance
appliance 0..1
ControlledAppliance		 Appliance being controlled direct
avg_load_adjustment 0..1
PerCent		 Used to define a maximum energy usage limit as a percentage of the client imp... direct
cancel_control_mode 0..1
String		 Encoding of cancel control direct
cancel_date_time 0..1
date		 Timestamp when a canceling of the event is scheduled to start direct
cancel_now 0..1
Boolean		 If true, a canceling of the event should start immediately direct
cooling_offset 0..1
Temperature		 Requested offset to apply to the normal cooling setpoint at the time of the s... direct
cooling_setpoint 0..1
Temperature		 Requested cooling set point direct
criticality_level 0..1
String		 Level of criticality for the action of this control direct
duty_cycle 0..1
PerCent		 Maximum "on" state duty cycle as a percentage of time direct
enrollment_group 0..1
String		 Provides a mechanism to direct load control actions to groups of PAN devices direct
heating_offset 0..1
Temperature		 Requested offset to apply to the normal heating setpoint at the time of the s... direct
heating_setpoint 0..1
Temperature		 Requested heating set point direct
command 0..1
String		 Command text EndDeviceAction
duration 0..1
Minutes		 Amount of time the action of this control is to remain active EndDeviceAction
duration_indefinite 0..1
Boolean		 True if the action of this control is indefinite EndDeviceAction
start_date_time 0..1
date		 Start date and time for action of this control EndDeviceAction
end_device_control 0..1
EndDeviceControl		 End device control issuing this end device action EndDeviceAction

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: PanDemandResponse
description: "PAN control used to issue action/command to PAN devices during a demand\
  \ response/load control event.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: EndDeviceAction
attributes:
  appliance:
    name: appliance
    description: "Appliance being controlled.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.appliance
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: ControlledAppliance
    required: false
  avg_load_adjustment:
    name: avg_load_adjustment
    description: "Used to define a maximum energy usage limit as a percentage of the\
      \ client implementations specific average energy usage. The load adjustment\
      \ percentage is added to 100% creating a percentage limit applied to the client\
      \ implementations specific average energy usage. A -10% load adjustment percentage\
      \ will establish an energy usage limit equal to 90% of the client implementations\
      \ specific average energy usage. Each load adjustment percentage is referenced\
      \ to the client implementations specific average energy usage. There are no\
      \ cumulative effects.\r\nThe range of this field is -100% to +100% with a resolution\
      \ of 1. A -100% value equals a total load shed. A +100% value will limit the\
      \ energy usage to the client implementations specific average energy usage."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.avgLoadAdjustment
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: PerCent
    required: false
  cancel_control_mode:
    name: cancel_control_mode
    description: "Encoding of cancel control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.cancelControlMode
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: string
    required: false
  cancel_date_time:
    name: cancel_date_time
    description: "Timestamp when a canceling of the event is scheduled to start.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.cancelDateTime
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: date
    required: false
  cancel_now:
    name: cancel_now
    description: "If true, a canceling of the event should start immediately.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.cancelNow
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: boolean
    required: false
  cooling_offset:
    name: cooling_offset
    description: "Requested offset to apply to the normal cooling setpoint at the\
      \ time of the start of the event. It represents a temperature change that will\
      \ be applied to the associated cooling set point. The temperature offsets will\
      \ be calculated per the local temperature in the thermostat. The calculated\
      \ temperature will be interpreted as the number of degrees to be added to the\
      \ cooling set point. Sequential demand response events are not cumulative. The\
      \ offset shall be applied to the normal setpoint.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.coolingOffset
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: Temperature
    required: false
  cooling_setpoint:
    name: cooling_setpoint
    description: "Requested cooling set point. Temperature set point is typically\
      \ defined and calculated based on local temperature.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.coolingSetpoint
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: Temperature
    required: false
  criticality_level:
    name: criticality_level
    description: Level of criticality for the action of this control. The action taken
      by load control devices for an event can be solely based on this value, or in
      combination with other load control event fields supported by the device.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.criticalityLevel
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: string
    required: false
  duty_cycle:
    name: duty_cycle
    description: Maximum "on" state duty cycle as a percentage of time. For example,
      if the value is 80, the device would be in an "on" state for 80% of the time
      for the duration of the action.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.dutyCycle
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: PerCent
    required: false
  enrollment_group:
    name: enrollment_group
    description: "Provides a mechanism to direct load control actions to groups of\
      \ PAN devices. It can be used in conjunction with the PAN device types.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.enrollmentGroup
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: string
    required: false
  heating_offset:
    name: heating_offset
    description: "Requested offset to apply to the normal heating setpoint at the\
      \ time of the start of the event. It represents a temperature change that will\
      \ be applied to the associated heating set point. The temperature offsets will\
      \ be calculated per the local temperature in the thermostat. The calculated\
      \ temperature will be interpreted as the number of degrees to be subtracted\
      \ from the heating set point. Sequential demand response events are not cumulative.\
      \ The offset shall be applied to the normal setpoint.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.heatingOffset
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: Temperature
    required: false
  heating_setpoint:
    name: heating_setpoint
    description: "Requested heating set point. Temperature set point is typically\
      \ defined and calculated based on local temperature.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.heatingSetpoint
    multivalued: false
    domain_of:
    - PanDemandResponse
    range: Temperature
    required: false
class_uri: cim:PanDemandResponse

Induced

name: PanDemandResponse
description: "PAN control used to issue action/command to PAN devices during a demand\
  \ response/load control event.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: EndDeviceAction
attributes:
  appliance:
    name: appliance
    description: "Appliance being controlled.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.appliance
    multivalued: false
    alias: appliance
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: ControlledAppliance
    required: false
  avg_load_adjustment:
    name: avg_load_adjustment
    description: "Used to define a maximum energy usage limit as a percentage of the\
      \ client implementations specific average energy usage. The load adjustment\
      \ percentage is added to 100% creating a percentage limit applied to the client\
      \ implementations specific average energy usage. A -10% load adjustment percentage\
      \ will establish an energy usage limit equal to 90% of the client implementations\
      \ specific average energy usage. Each load adjustment percentage is referenced\
      \ to the client implementations specific average energy usage. There are no\
      \ cumulative effects.\r\nThe range of this field is -100% to +100% with a resolution\
      \ of 1. A -100% value equals a total load shed. A +100% value will limit the\
      \ energy usage to the client implementations specific average energy usage."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.avgLoadAdjustment
    multivalued: false
    alias: avg_load_adjustment
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: PerCent
    required: false
  cancel_control_mode:
    name: cancel_control_mode
    description: "Encoding of cancel control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.cancelControlMode
    multivalued: false
    alias: cancel_control_mode
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: string
    required: false
  cancel_date_time:
    name: cancel_date_time
    description: "Timestamp when a canceling of the event is scheduled to start.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.cancelDateTime
    multivalued: false
    alias: cancel_date_time
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: date
    required: false
  cancel_now:
    name: cancel_now
    description: "If true, a canceling of the event should start immediately.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.cancelNow
    multivalued: false
    alias: cancel_now
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: boolean
    required: false
  cooling_offset:
    name: cooling_offset
    description: "Requested offset to apply to the normal cooling setpoint at the\
      \ time of the start of the event. It represents a temperature change that will\
      \ be applied to the associated cooling set point. The temperature offsets will\
      \ be calculated per the local temperature in the thermostat. The calculated\
      \ temperature will be interpreted as the number of degrees to be added to the\
      \ cooling set point. Sequential demand response events are not cumulative. The\
      \ offset shall be applied to the normal setpoint.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.coolingOffset
    multivalued: false
    alias: cooling_offset
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: Temperature
    required: false
  cooling_setpoint:
    name: cooling_setpoint
    description: "Requested cooling set point. Temperature set point is typically\
      \ defined and calculated based on local temperature.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.coolingSetpoint
    multivalued: false
    alias: cooling_setpoint
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: Temperature
    required: false
  criticality_level:
    name: criticality_level
    description: Level of criticality for the action of this control. The action taken
      by load control devices for an event can be solely based on this value, or in
      combination with other load control event fields supported by the device.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.criticalityLevel
    multivalued: false
    alias: criticality_level
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: string
    required: false
  duty_cycle:
    name: duty_cycle
    description: Maximum "on" state duty cycle as a percentage of time. For example,
      if the value is 80, the device would be in an "on" state for 80% of the time
      for the duration of the action.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.dutyCycle
    multivalued: false
    alias: duty_cycle
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: PerCent
    required: false
  enrollment_group:
    name: enrollment_group
    description: "Provides a mechanism to direct load control actions to groups of\
      \ PAN devices. It can be used in conjunction with the PAN device types.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.enrollmentGroup
    multivalued: false
    alias: enrollment_group
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: string
    required: false
  heating_offset:
    name: heating_offset
    description: "Requested offset to apply to the normal heating setpoint at the\
      \ time of the start of the event. It represents a temperature change that will\
      \ be applied to the associated heating set point. The temperature offsets will\
      \ be calculated per the local temperature in the thermostat. The calculated\
      \ temperature will be interpreted as the number of degrees to be subtracted\
      \ from the heating set point. Sequential demand response events are not cumulative.\
      \ The offset shall be applied to the normal setpoint.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.heatingOffset
    multivalued: false
    alias: heating_offset
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: Temperature
    required: false
  heating_setpoint:
    name: heating_setpoint
    description: "Requested heating set point. Temperature set point is typically\
      \ defined and calculated based on local temperature.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDemandResponse.heatingSetpoint
    multivalued: false
    alias: heating_setpoint
    owner: PanDemandResponse
    domain_of:
    - PanDemandResponse
    range: Temperature
    required: false
  command:
    name: command
    description: "Command text.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceAction.command
    multivalued: false
    alias: command
    owner: PanDemandResponse
    domain_of:
    - EndDeviceAction
    - DiscreteValue
    range: string
    required: false
  duration:
    name: duration
    description: "Amount of time the action of this control is to remain active.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceAction.duration
    multivalued: false
    alias: duration
    owner: PanDemandResponse
    domain_of:
    - GateInputPin
    - EndDeviceTiming
    - EndDeviceAction
    - ConstraintDuration
    - MarketScheduledEvent
    - ClassificationCondition
    - ScheduledEvent
    range: Minutes
    required: false
  duration_indefinite:
    name: duration_indefinite
    description: "True if the action of this control is indefinite.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceAction.durationIndefinite
    multivalued: false
    alias: duration_indefinite
    owner: PanDemandResponse
    domain_of:
    - EndDeviceTiming
    - EndDeviceAction
    range: boolean
    required: false
  start_date_time:
    name: start_date_time
    description: "Start date and time for action of this control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceAction.startDateTime
    multivalued: false
    alias: start_date_time
    owner: PanDemandResponse
    domain_of:
    - EndDeviceAction
    - CRRSegment
    - ProfileData
    range: date
    required: false
  end_device_control:
    name: end_device_control
    description: End device control issuing this end device action.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceAction.EndDeviceControl
    multivalued: false
    alias: end_device_control
    owner: PanDemandResponse
    domain_of:
    - EndDeviceAction
    range: EndDeviceControl
    required: false
class_uri: cim:PanDemandResponse