EnergyKit · IOS API REFERENCE

ElectricityGuidance

struct · iOS 26.0+ · SDK 27.1

struct ElectricityGuidance

A data model that provides guidance on when electricity is cleaner and less expensive. `ElectricityGuidance` provides information on grid quality and electricity cost, if cost information is available. You can use `ElectricityGuidance` to adjust the electricity consumption of your managed devices to times when electricity is cleaner, and optionally reduce the overall electricity consumption or cost of your managed devices.

Members (7)

get · iOS 26.0+

energyVenueID

TypeScript

get energyVenueID(): string

Swift declaration

let energyVenueID: UUID

An identifier for the physical location to which the guidance applies.

get · iOS 26.0+

guidanceToken

TypeScript

get guidanceToken(): string

Swift declaration

let guidanceToken: UUID

A unique token for the guidance that you use to create an electrical load event. Use the unique token to create an ``ElectricalLoadEvent``.

get · iOS 26.0+

sharedService

TypeScript

static get sharedService(): ElectricityGuidance_Service

Swift declaration

static let sharedService: ElectricityGuidance.Service

A single, shared guidance service object. Use this object to interact with guidance services in your app.

get · iOS 26.0+

suggestedAction

TypeScript

get suggestedAction(): ElectricityGuidance_SuggestedAction

Swift declaration

let suggestedAction: ElectricityGuidance.SuggestedAction

A property that describes how the electrical load uses the guidance. An example of suggested actions for the load could be shift-able or reduce-able.

get · iOS 26.0+

values

TypeScript

get values(): Array<ElectricityGuidance_Value>

Swift declaration

let values: [ElectricityGuidance.Value]

A series of weighted values for intervals of time, describing when to shift or reduce electricity use.

get · iOS 26.0+

options

TypeScript

get options(): Array<ElectricityGuidance_Options>

Swift declaration

let options: Set<ElectricityGuidance.Options>

The additional factors that influence the weight of a value. A person's utility rate plan is an example of an additional factor that influences the weight of the value.

get · iOS 26.0+

interval

TypeScript

get interval(): _Foundation_DateInterval

Swift declaration

let interval: DateInterval

The time range to which the guidance applies.

Skipped declarations

No declarations were skipped in this snapshot.

All EnergyKit types →