EnergyKit records electricity-consumption events for HVAC systems and managed devices so that venues gain insight into their energy usage and receive clean-energy guidance. You report load events such as ElectricHVACLoadEvent, ElectricVehicleLoadEvent, and ElectricVehicleStatusEvent against an EnergyVenue and its ElectricalLoadDevice instances, conforming custom events to ElectricalLoadEventProtocol. Using the ElectricityInsightService actor, you run an ElectricityInsightQuery to retrieve ElectricityInsightRecord results and ElectricityGuidance, with types such as ElectricityFlowDirection and ElectricVehicleChargingReason describing how energy moves and why charging occurs.
Essentials 2
Model the venue and electrical devices that anchor energy reporting and insight queries.
- StEnergyVenueA physical site that uses or produces electricity at that location.
- StElectricalLoadDeviceRepresents an electrical load device for event submission.
Reporting Load Events 4
Record electricity-consumption events for HVAC systems and electric vehicles.
- PrElectricalLoadEventProtocolA protocol that custom electricity-consumption events adopt so they can be reported as electrical load events.
- StElectricHVACLoadEventA measurement of the electricity consumed by an HVAC system.
- StElectricVehicleLoadEventA measurement of the electricity consumed or generated by an electric vehicle while connected to a charger.
- StElectricVehicleStatusEventAn event representing the status of an electric vehicle while connected to a charger.
Electricity Insights 5
Query consumption history and receive clean-energy guidance for a venue.
- AcElectricityInsightServiceA service for retrieving insights about electricity consumption.
- StElectricityInsightQueryA structure describing a query that you use to obtain environmental impact
- StElectricityInsightRecordA structure that represents displayable environmental impact information
- PrElectricityInsightMeasureA protocol for values that quantify an aspect of electricity usage in an insight query.
- StElectricityGuidanceA data model that provides guidance on when electricity is cleaner and less expensive.
Energy Classification 2
Describe how energy flows and why vehicle charging occurs.
- EnElectricityFlowDirectionInformation about which direction the electricity moves.
- EnElectricVehicleChargingReasonReasons that explain electric vehicle charging state transitions
Errors 1
Conditions reported when EnergyKit operations fail.
- EnEnergyKitErrorA specialized error that provides localized messages describing the error and why it occurred.