Matter · IOS API REFERENCE

MTRBaseClusterDeviceEnergyManagement

class · iOS 18.4+ · SDK 27.1

class MTRBaseClusterDeviceEnergyManagement

Members (51)

static · iOS 18.4+

readAttributeAbsMaxPower

TypeScript

static readAttributeAbsMaxPowerWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeAbsMaxPower(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeAbsMinPower

TypeScript

static readAttributeAbsMinPowerWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeAbsMinPower(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeAcceptedCommandList

TypeScript

static readAttributeAcceptedCommandListWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeAcceptedCommandList(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 18.4+

readAttributeAttributeList

TypeScript

static readAttributeAttributeListWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeAttributeList(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 18.4+

readAttributeClusterRevision

TypeScript

static readAttributeClusterRevisionWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeClusterRevision(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeESACanGenerate

TypeScript

static readAttributeESACanGenerateWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeESACanGenerate(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeESAState

TypeScript

static readAttributeESAStateWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeESAState(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeESAType

TypeScript

static readAttributeESATypeWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeESAType(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeFeatureMap

TypeScript

static readAttributeFeatureMapWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeFeatureMap(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributeForecast

TypeScript

static readAttributeForecastWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (MTRDeviceEnergyManagementClusterForecastStruct) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeForecast(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> MTRDeviceEnergyManagementClusterForecastStruct

static · iOS 18.4+

readAttributeGeneratedCommandList

TypeScript

static readAttributeGeneratedCommandListWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeGeneratedCommandList(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> [Any]

static · iOS 18.4+

readAttributeOptOutState

TypeScript

static readAttributeOptOutStateWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributeOptOutState(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> NSNumber

static · iOS 18.4+

readAttributePowerAdjustmentCapability

TypeScript

static readAttributePowerAdjustmentCapabilityWithClusterStateCacheEndpointQueueCompletion(clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue, completion: ((arg0: (MTRDeviceEnergyManagementClusterPowerAdjustCapabilityStruct) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func readAttributePowerAdjustmentCapability(withClusterStateCache clusterStateCacheContainer: MTRClusterStateCacheContainer, endpoint: NSNumber, queue: dispatch_queue_t) async throws -> MTRDeviceEnergyManagementClusterPowerAdjustCapabilityStruct

method · iOS 18.4+

cancelPowerAdjustRequest

TypeScript

cancelPowerAdjustRequestCompletion(completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func cancelPowerAdjustRequest() async throws

method · iOS 18.4+

cancelPowerAdjustRequest

TypeScript

cancelPowerAdjustRequestWithCompletion(params: (MTRDeviceEnergyManagementClusterCancelPowerAdjustRequestParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func cancelPowerAdjustRequest(with params: MTRDeviceEnergyManagementClusterCancelPowerAdjustRequestParams?) async throws

method · iOS 18.4+

cancelRequest

TypeScript

cancelRequestCompletion(completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func cancelRequest() async throws

method · iOS 18.4+

cancelRequest

TypeScript

cancelRequestWithCompletion(params: (MTRDeviceEnergyManagementClusterCancelRequestParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func cancelRequest(with params: MTRDeviceEnergyManagementClusterCancelRequestParams?) async throws

init · iOS 18.4+

init

TypeScript

static init(device: MTRBaseDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRBaseClusterDeviceEnergyManagement) | null

Swift declaration

init?(device: MTRBaseDevice, endpointID: NSNumber, queue: dispatch_queue_t)

method · iOS 18.4+

modifyForecastRequest

TypeScript

modifyForecastRequest(params: MTRDeviceEnergyManagementClusterModifyForecastRequestParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func modifyForecastRequest(with params: MTRDeviceEnergyManagementClusterModifyForecastRequestParams) async throws

method · iOS 18.4+

pauseRequest

TypeScript

pauseRequest(params: MTRDeviceEnergyManagementClusterPauseRequestParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func pauseRequest(with params: MTRDeviceEnergyManagementClusterPauseRequestParams) async throws

method · iOS 18.4+

powerAdjustRequest

TypeScript

powerAdjustRequest(params: MTRDeviceEnergyManagementClusterPowerAdjustRequestParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func powerAdjustRequest(with params: MTRDeviceEnergyManagementClusterPowerAdjustRequestParams) async throws

method · iOS 18.4+

readAttributeAbsMaxPower

TypeScript

readAttributeAbsMaxPowerCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeAbsMaxPower() async throws -> NSNumber

method · iOS 18.4+

readAttributeAbsMinPower

TypeScript

readAttributeAbsMinPowerCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeAbsMinPower() async throws -> NSNumber

method · iOS 18.4+

readAttributeAcceptedCommandList

TypeScript

readAttributeAcceptedCommandListCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeAcceptedCommandList() async throws -> [Any]

method · iOS 18.4+

readAttributeAttributeList

TypeScript

readAttributeAttributeListCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeAttributeList() async throws -> [Any]

method · iOS 18.4+

readAttributeClusterRevision

TypeScript

readAttributeClusterRevisionCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeClusterRevision() async throws -> NSNumber

method · iOS 18.4+

readAttributeESACanGenerate

TypeScript

readAttributeESACanGenerateCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeESACanGenerate() async throws -> NSNumber

method · iOS 18.4+

readAttributeESAState

TypeScript

readAttributeESAStateCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeESAState() async throws -> NSNumber

method · iOS 18.4+

readAttributeESAType

TypeScript

readAttributeESATypeCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeESAType() async throws -> NSNumber

method · iOS 18.4+

readAttributeFeatureMap

TypeScript

readAttributeFeatureMapCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeFeatureMap() async throws -> NSNumber

method · iOS 18.4+

readAttributeForecast

TypeScript

readAttributeForecastCompletion(completion: ((arg0: (MTRDeviceEnergyManagementClusterForecastStruct) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeForecast() async throws -> MTRDeviceEnergyManagementClusterForecastStruct

method · iOS 18.4+

readAttributeGeneratedCommandList

TypeScript

readAttributeGeneratedCommandListCompletion(completion: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeGeneratedCommandList() async throws -> [Any]

method · iOS 18.4+

readAttributeOptOutState

TypeScript

readAttributeOptOutStateCompletion(completion: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributeOptOutState() async throws -> NSNumber

method · iOS 18.4+

readAttributePowerAdjustmentCapability

TypeScript

readAttributePowerAdjustmentCapabilityCompletion(completion: ((arg0: (MTRDeviceEnergyManagementClusterPowerAdjustCapabilityStruct) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func readAttributePowerAdjustmentCapability() async throws -> MTRDeviceEnergyManagementClusterPowerAdjustCapabilityStruct

method · iOS 18.4+

requestConstraintBasedForecast

TypeScript

requestConstraintBasedForecast(params: MTRDeviceEnergyManagementClusterRequestConstraintBasedForecastParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func requestConstraintBasedForecast(with params: MTRDeviceEnergyManagementClusterRequestConstraintBasedForecastParams) async throws

method · iOS 18.4+

resumeRequest

TypeScript

resumeRequestCompletion(completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func resumeRequest() async throws

method · iOS 18.4+

resumeRequest

TypeScript

resumeRequestWithCompletion(params: (MTRDeviceEnergyManagementClusterResumeRequestParams) | null, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func resumeRequest(with params: MTRDeviceEnergyManagementClusterResumeRequestParams?) async throws

method · iOS 18.4+

startTimeAdjustRequest

TypeScript

startTimeAdjustRequest(params: MTRDeviceEnergyManagementClusterStartTimeAdjustRequestParams, completion: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func startTimeAdjustRequest(with params: MTRDeviceEnergyManagementClusterStartTimeAdjustRequestParams) async throws

method · iOS 18.4+

subscribeAttributeAbsMaxPower

TypeScript

subscribeAttributeAbsMaxPower(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeAbsMaxPower(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeAbsMinPower

TypeScript

subscribeAttributeAbsMinPower(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeAbsMinPower(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeAcceptedCommandList

TypeScript

subscribeAttributeAcceptedCommandList(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeAcceptedCommandList(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeAttributeList

TypeScript

subscribeAttributeAttributeList(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeAttributeList(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeClusterRevision

TypeScript

subscribeAttributeClusterRevision(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeClusterRevision(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeESACanGenerate

TypeScript

subscribeAttributeESACanGenerate(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeESACanGenerate(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeESAState

TypeScript

subscribeAttributeESAState(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeESAState(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeESAType

TypeScript

subscribeAttributeESAType(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeESAType(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeFeatureMap

TypeScript

subscribeAttributeFeatureMap(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeFeatureMap(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeForecast

TypeScript

subscribeAttributeForecast(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (MTRDeviceEnergyManagementClusterForecastStruct) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeForecast(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (MTRDeviceEnergyManagementClusterForecastStruct?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeGeneratedCommandList

TypeScript

subscribeAttributeGeneratedCommandList(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (Array<unknown>) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeGeneratedCommandList(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping ([Any]?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributeOptOutState

TypeScript

subscribeAttributeOptOutState(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (_Foundation_NSNumber) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributeOptOutState(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (NSNumber?, (any Error)?) -> Void)

method · iOS 18.4+

subscribeAttributePowerAdjustmentCapability

TypeScript

subscribeAttributePowerAdjustmentCapability(params: MTRSubscribeParams, subscriptionEstablished: ((() => void)) | null, reportHandler: ((arg0: (MTRDeviceEnergyManagementClusterPowerAdjustCapabilityStruct) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func subscribeAttributePowerAdjustmentCapability(with params: MTRSubscribeParams, subscriptionEstablished: MTRSubscriptionEstablishedHandler?, reportHandler: @escaping (MTRDeviceEnergyManagementClusterPowerAdjustCapabilityStruct?, (any Error)?) -> Void)

Skipped declarations

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

MTRBaseClusterDeviceEnergyManagement.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All Matter types →