One Logo Pool Ball
App Frameworks · IOS API REFERENCE

EnergyKit

Provide grid forecasts and energy insights to help people optimize their electricity usage.

49 types

113 callable entries

17 skipped

87% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

ElectricalLoadDevice

struct · iOS 27.0+

ElectricalLoadDevice.DeviceType

enum · iOS 27.0+

ElectricalLoadDevice.DeviceType.RawValue

typealias · iOS 27.0+

ElectricalLoadEventProtocol

protocol · iOS 26.0+

ElectricHVACLoadEvent

struct · iOS 26.0+

ElectricHVACLoadEvent.ElectricalMeasurement

struct · iOS 26.0+

ElectricHVACLoadEvent.ID

typealias · iOS 26.0+

ElectricHVACLoadEvent.Session

struct · iOS 26.0+

ElectricHVACLoadEvent.Session.GuidanceState

struct · iOS 26.0+

ElectricHVACLoadEvent.Session.State

enum · iOS 26.0+

ElectricityFlowDirection

enum · iOS 26.0+

ElectricityGuidance

struct · iOS 26.0+

ElectricityGuidance.Options

enum · iOS 26.0+

ElectricityGuidance.Options.AllCases

typealias · iOS 26.0+

ElectricityGuidance.Query

struct · iOS 26.0+

ElectricityGuidance.Service

class · iOS 26.0+

ElectricityGuidance.SuggestedAction

enum · iOS 26.0+

ElectricityGuidance.Value

struct · iOS 26.0+

ElectricityInsightMeasure

protocol · iOS 26.0+

ElectricityInsightQuery

struct · iOS 26.0+

ElectricityInsightQuery.Granularity

enum · iOS 26.0+

ElectricityInsightQuery.Options

struct · iOS 26.0+

ElectricityInsightQuery.Options.ArrayLiteralElement

typealias · iOS 26.0+

ElectricityInsightQuery.Options.Element

typealias · iOS 26.0+

ElectricityInsightQuery.Options.RawValue

typealias · iOS 26.0+

ElectricityInsightRecord

struct · iOS 26.0+

ElectricityInsightRecord.GridCleanliness

struct · iOS 26.1+

ElectricityInsightRecord.TariffPeak

struct · iOS 26.0+

ElectricityInsightService

class · iOS 26.0+

ElectricVehicleChargingReason

enum · iOS 27.0+

ElectricVehicleChargingReason.ActiveReason

enum · iOS 27.0+

ElectricVehicleChargingReason.ActiveReason.AllCases

typealias · iOS 27.0+

ElectricVehicleChargingReason.IdleReason

enum · iOS 27.0+

ElectricVehicleChargingReason.IdleReason.AllCases

typealias · iOS 27.0+

ElectricVehicleLoadEvent

struct · iOS 26.0+

ElectricVehicleLoadEvent.ElectricalMeasurement

struct · iOS 26.0+

ElectricVehicleLoadEvent.ElectricalMeasurement.PerformanceMetrics

struct · iOS 27.0+

ElectricVehicleLoadEvent.ID

typealias · iOS 26.0+

ElectricVehicleLoadEvent.Session

struct · iOS 26.0+

ElectricVehicleLoadEvent.Session.GuidanceState

struct · iOS 26.0+

ElectricVehicleLoadEvent.Session.State

enum · iOS 26.0+

ElectricVehicleStatusEvent

struct · iOS 27.0+

ElectricVehicleStatusEvent.ChargingTarget

struct · iOS 27.0+

ElectricVehicleStatusEvent.ID

typealias · iOS 27.0+

ElectricVehicleStatusEvent.Status

enum · iOS 27.0+

EnergyKitError

enum · iOS 26.0+

EnergyVenue

struct · iOS 26.0+

EnergyVenue.ID

typealias · iOS 26.0+

UnitEnergy.EnergyKit

class · iOS 26.0+

Functions and constants

get · iOS 26.0+

totalEnergy

TypeScript
get totalEnergy(): (_Foundation_Measurement<_Foundation_UnitEnergy>) | null
Swift declaration
var totalEnergy: Measurement<UnitEnergy>?

The total energy either consumed or generated in the date range. Represents the total electrical energy consumed or generated by the device in the date range for devices that report it.

set · iOS 26.0+

totalEnergy

TypeScript
set totalEnergy(value: (_Foundation_Measurement<_Foundation_UnitEnergy>) | null)
Swift declaration
var totalEnergy: Measurement<UnitEnergy>?

The total energy either consumed or generated in the date range. Represents the total electrical energy consumed or generated by the device in the date range for devices that report it.

get · iOS 26.0+

totalRuntime

TypeScript
get totalRuntime(): (SDKHandle) | null
Swift declaration
var totalRuntime: Duration?

Represents the total runtime for the device in the date range.

set · iOS 26.0+

totalRuntime

TypeScript
set totalRuntime(value: (SDKHandle) | null)
Swift declaration
var totalRuntime: Duration?

Represents the total runtime for the device in the date range.

get · iOS 26.0+

dataByTariffPeak

TypeScript
get dataByTariffPeak(): (ElectricityInsightRecord_TariffPeak<SDKHandle>) | null
Swift declaration
var dataByTariffPeak: ElectricityInsightRecord<Measure>.TariffPeak?

The electrical energy consumed or generated, or the runtime duration split out by tariff peaks, if available. The tariff peaks are the times of day when electricity prices are highest.

set · iOS 26.0+

dataByTariffPeak

TypeScript
set dataByTariffPeak(value: (ElectricityInsightRecord_TariffPeak<SDKHandle>) | null)
Swift declaration
var dataByTariffPeak: ElectricityInsightRecord<Measure>.TariffPeak?

The electrical energy consumed or generated, or the runtime duration split out by tariff peaks, if available. The tariff peaks are the times of day when electricity prices are highest.

get · iOS 26.1+

dataByGridCleanliness

TypeScript
get dataByGridCleanliness(): (ElectricityInsightRecord_GridCleanliness<SDKHandle>) | null
Swift declaration
var dataByGridCleanliness: ElectricityInsightRecord<Measure>.GridCleanliness?

The electrical energy consumed or generated, or the runtime duration broken down by levels of cleanliness.

set · iOS 26.1+

dataByGridCleanliness

TypeScript
set dataByGridCleanliness(value: (ElectricityInsightRecord_GridCleanliness<SDKHandle>) | null)
Swift declaration
var dataByGridCleanliness: ElectricityInsightRecord<Measure>.GridCleanliness?

The electrical energy consumed or generated, or the runtime duration broken down by levels of cleanliness.

get · iOS 26.0+

range

TypeScript
get range(): _Foundation_DateInterval
Swift declaration
let range: DateInterval

The date interval for which the system generates the insight.

Skipped declarations

17 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

UnitEnergy.EnergyKit.milliwattHours

The iOS SDK compiler rejected this binding: module 'EnergyKit' has no member named 'UnitEnergy'

UnitEnergy.EnergyKit.init(symbol:)

The iOS SDK compiler rejected this binding: module 'EnergyKit' has no member named 'UnitEnergy'

UnitEnergy.EnergyKit.init(coder:)

The iOS SDK compiler rejected this binding: module 'EnergyKit' has no member named 'UnitEnergy'

ElectricityInsightRecord.GridCleanliness.cleaner

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.GridCleanliness.lessClean

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.GridCleanliness.avoid

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.GridCleanliness.unknown

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.GridCleanliness.init(cleaner:lessClean:avoid:unknown:)

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.TariffPeak.superOffPeak

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.TariffPeak.offPeak

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.TariffPeak.partialPeak

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.TariffPeak.onPeak

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.TariffPeak.criticalPeak

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.TariffPeak.unknown

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

ElectricityInsightRecord.TariffPeak.init(superOffPeak:offPeak:partialPeak:onPeak:criticalPeak:unknown:)

This declaration needs Swift generic type arguments. (no canonical witness for Measure)

EnergyVenue.submitEvents(_:)

This declaration needs Swift generic type arguments. (no canonical witness for Event)

protocol implementation ElectricalLoadEventProtocol

inherited protocol graph unavailable