struct · iOS 26.0+ · SDK 27.1
struct ElectricHVACLoadEventA measurement of the electricity consumed by an HVAC system. Submit events representing electricity consumption to provide insights about electricity usage and their managed devices’ adherence to ``ElectricityGuidance``. These events, called ``ElectricHVACLoadEvent``s are data points recorded at specific points in time for a given ``EnergyVenue`` that allow the venue to determine when the device used electricity and its cleanliness based on historical `ElectricityGuidance`. Additionally, relative cost can be determined using the rate plan at the `EnergyVenue`, if available. You can submit ``ElectricHVACLoadEvent``s as your managed devices consume electricity. You can request insights based on submitted ``ElectricHVACLoadEvent``s . Insights are only available upon your submission of ``ElectricHVACLoadEvent``s . ### Submit ElectricHVACLoadEvent Save data to the ``ElectricHVACLoadEvent`` with a sampling rate that's proportional to the rate of change of electrical quantities such a heating or cooling stage, or relative power. Generally, one sample every 15 minutes (at 0, 15, 30, and 45-minute marks) is sufficient when the device's session is active and no significant changes occur to its power state. Significant changes may include: * A person initiated an action. * A pause in power consumption such as going idle. * The heating or cooling stage changed. Idle devices between heating or cooling cycles don’t generate events. The device that requested ``ElectricityGuidance`` must submit the corresponding load events. Load events for an ``EnergyVenue`` are accessible to all people that use the Home app.
get deviceName(): stringvar deviceName: String { get }A human-readable name for the device. The max length is `250 UTF-16` characters. Names that violate these rules are automatically sanitized: - Isn't empty, and less than or equal to 250 characters. - Contains only alphanumeric, whitespace, punctuation, or symbol characters.
get measurement(): ElectricHVACLoadEvent_ElectricalMeasurementlet measurement: ElectricHVACLoadEvent.ElectricalMeasurementThe electricity consumption of a device.
get id(): stringlet id: UUIDThe unique identifier of the electrical load event.
get session(): ElectricHVACLoadEvent_Sessionlet session: ElectricHVACLoadEvent.SessionThe session information. An HVAC system between its cooling or heating cycles can be idling and load events must not be generated
get deviceID(): stringlet deviceID: StringThe device's unique stable identifier. The max length is `64 UTF-8` bytes. UUID strings are permitted. The following are enforced as preconditions: - Isn't empty, and less than or equal to 64 UTF-8 bytes. - Uses only alphanumeric, space, hyphen, and apostrophe characters. - Starts and ends with an alphanumeric character.
get timestamp(): globalThis.Datelet timestamp: DateThe timestamp for when the event occurred.
static initTimestampMeasurementSessionDevice(timestamp: globalThis.Date, measurement: ElectricHVACLoadEvent_ElectricalMeasurement, session: ElectricHVACLoadEvent_Session, device: ElectricalLoadDevice): ElectricHVACLoadEventinit(timestamp: Date, measurement: ElectricHVACLoadEvent.ElectricalMeasurement, session: ElectricHVACLoadEvent.Session, device: ElectricalLoadDevice)Creates an electric HVAC load event. - Parameters: - timestamp: The timestamp for when the event occurred. - measurement: The electricity consumption of a device. - session: The session information - device: The electrical load device that generated this event.
static initTimestampMeasurementSessionDeviceID(timestamp: globalThis.Date, measurement: ElectricHVACLoadEvent_ElectricalMeasurement, session: ElectricHVACLoadEvent_Session, deviceID: string): ElectricHVACLoadEventinit(timestamp: Date, measurement: ElectricHVACLoadEvent.ElectricalMeasurement, session: ElectricHVACLoadEvent.Session, deviceID: String)Creates an ``ElectricHVACLoadEvent`` - Parameters: - timestamp: The timestamp for when the event occurred. - measurement: The electricity consumption of a device. - session: The session information - deviceID: The device's unique stable identifier. - Throws: ``EnergyKit.invalidDeviceID``
No declarations were skipped in this snapshot.