One Logo Pool Ball
X
Github
Discord

System

Matter · IOS API REFERENCE

MTRClusterDeviceEnergyManagement

class · iOS 18.4+ · SDK 27.1

class MTRClusterDeviceEnergyManagement

Members (25)

method · iOS 18.4+

cancelPowerAdjustRequest

TypeScript
cancelPowerAdjustRequestWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func cancelPowerAdjustRequest(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

cancelPowerAdjustRequest

TypeScript
cancelPowerAdjustRequestWithExpectedValuesExpectedValueIntervalCompletion97899(params: (MTRDeviceEnergyManagementClusterCancelPowerAdjustRequestParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func cancelPowerAdjustRequest(with params: MTRDeviceEnergyManagementClusterCancelPowerAdjustRequestParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

cancelRequest

TypeScript
cancelRequestWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func cancelRequest(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

cancelRequest

TypeScript
cancelRequestWithExpectedValuesExpectedValueIntervalCompletion62869(params: (MTRDeviceEnergyManagementClusterCancelRequestParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func cancelRequest(with params: MTRDeviceEnergyManagementClusterCancelRequestParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
init · iOS 18.4+

init

TypeScript
static init(device: MTRDevice, endpointID: _Foundation_NSNumber, queue: _Dispatch_DispatchQueue): (MTRClusterDeviceEnergyManagement) | null
Swift declaration
init?(device: MTRDevice, endpointID: NSNumber, queue: dispatch_queue_t)
method · iOS 18.4+

modifyForecastRequest

TypeScript
modifyForecastRequest(params: MTRDeviceEnergyManagementClusterModifyForecastRequestParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func modifyForecastRequest(with params: MTRDeviceEnergyManagementClusterModifyForecastRequestParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

pauseRequest

TypeScript
pauseRequest(params: MTRDeviceEnergyManagementClusterPauseRequestParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func pauseRequest(with params: MTRDeviceEnergyManagementClusterPauseRequestParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

powerAdjustRequest

TypeScript
powerAdjustRequest(params: MTRDeviceEnergyManagementClusterPowerAdjustRequestParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func powerAdjustRequest(with params: MTRDeviceEnergyManagementClusterPowerAdjustRequestParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

readAttributeAbsMaxPower

TypeScript
readAttributeAbsMaxPower(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeAbsMaxPower(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeAbsMinPower

TypeScript
readAttributeAbsMinPower(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeAbsMinPower(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeAcceptedCommandList

TypeScript
readAttributeAcceptedCommandList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeAcceptedCommandList(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeAttributeList

TypeScript
readAttributeAttributeList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeAttributeList(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeClusterRevision

TypeScript
readAttributeClusterRevision(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeClusterRevision(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeESACanGenerate

TypeScript
readAttributeESACanGenerate(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeESACanGenerate(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeESAState

TypeScript
readAttributeESAState(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeESAState(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeESAType

TypeScript
readAttributeESAType(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeESAType(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeFeatureMap

TypeScript
readAttributeFeatureMap(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeFeatureMap(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeForecast

TypeScript
readAttributeForecast(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeForecast(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeGeneratedCommandList

TypeScript
readAttributeGeneratedCommandList(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeGeneratedCommandList(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributeOptOutState

TypeScript
readAttributeOptOutState(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeOptOutState(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

readAttributePowerAdjustmentCapability

TypeScript
readAttributePowerAdjustmentCapability(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributePowerAdjustmentCapability(with params: MTRReadParams?) -> [String : Any]?
method · iOS 18.4+

requestConstraintBasedForecast

TypeScript
requestConstraintBasedForecast(params: MTRDeviceEnergyManagementClusterRequestConstraintBasedForecastParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func requestConstraintBasedForecast(with params: MTRDeviceEnergyManagementClusterRequestConstraintBasedForecastParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

resumeRequest

TypeScript
resumeRequestWithExpectedValuesExpectedValueIntervalCompletion(expectedValues: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func resumeRequest(withExpectedValues expectedValues: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

resumeRequest

TypeScript
resumeRequestWithExpectedValuesExpectedValueIntervalCompletion69820(params: (MTRDeviceEnergyManagementClusterResumeRequestParams) | null, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func resumeRequest(with params: MTRDeviceEnergyManagementClusterResumeRequestParams?, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws
method · iOS 18.4+

startTimeAdjustRequest

TypeScript
startTimeAdjustRequest(params: MTRDeviceEnergyManagementClusterStartTimeAdjustRequestParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func startTimeAdjustRequest(with params: MTRDeviceEnergyManagementClusterStartTimeAdjustRequestParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws

Skipped declarations

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

MTRClusterDeviceEnergyManagement.init()

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

All Matter types →