One Logo Pool Ball
X
Github
Discord

System

Matter · IOS API REFERENCE

MTRClusterLevelControl

class · iOS 16.1+ · SDK 27.1

class MTRClusterLevelControl

Members (53)

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript
static initDeviceEndpointQueue(device: MTRDevice, endpoint: number, queue: _Dispatch_DispatchQueue): (MTRClusterLevelControl) | null
Swift declaration
init?(device: MTRDevice, endpoint: UInt16, queue: dispatch_queue_t)
init · iOS 16.4+

init

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

moveToClosestFrequency

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

moveToClosestFrequency

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

moveToLevelWithOnOff

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

moveToLevelWithOnOff

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

moveToLevel

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

moveToLevel

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

moveWithOnOff

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

moveWithOnOff

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

move

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

move

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

readAttributeAcceptedCommandList

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

readAttributeAttributeList

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

readAttributeClusterRevision

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

readAttributeCurrentFrequency

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

readAttributeCurrentLevel

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

readAttributeDefaultMoveRate

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

readAttributeFeatureMap

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

readAttributeGeneratedCommandList

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

readAttributeMaxFrequency

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

readAttributeMaxLevel

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

readAttributeMinFrequency

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

readAttributeMinLevel

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

readAttributeOffTransitionTime

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

readAttributeOnLevel

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

readAttributeOnOffTransitionTime

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

readAttributeOnTransitionTime

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

readAttributeOptions

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

readAttributeRemainingTime

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

readAttributeStartUpCurrentLevel

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

stepWithOnOff

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

stepWithOnOff

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

step

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

step

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

stopWithOnOff

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

stopWithOnOff

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

stop

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

stop

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

writeAttributeDefaultMoveRate

TypeScript
writeAttributeDefaultMoveRateWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeDefaultMoveRate(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeDefaultMoveRate

TypeScript
writeAttributeDefaultMoveRateWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeDefaultMoveRate(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)
method · iOS 16.1+

writeAttributeOffTransitionTime

TypeScript
writeAttributeOffTransitionTimeWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeOffTransitionTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeOffTransitionTime

TypeScript
writeAttributeOffTransitionTimeWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeOffTransitionTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)
method · iOS 16.1+

writeAttributeOnLevel

TypeScript
writeAttributeOnLevelWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeOnLevel(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeOnLevel

TypeScript
writeAttributeOnLevelWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeOnLevel(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)
method · iOS 16.1+

writeAttributeOnOffTransitionTime

TypeScript
writeAttributeOnOffTransitionTimeWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeOnOffTransitionTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeOnOffTransitionTime

TypeScript
writeAttributeOnOffTransitionTimeWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeOnOffTransitionTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)
method · iOS 16.1+

writeAttributeOnTransitionTime

TypeScript
writeAttributeOnTransitionTimeWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeOnTransitionTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeOnTransitionTime

TypeScript
writeAttributeOnTransitionTimeWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeOnTransitionTime(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)
method · iOS 16.1+

writeAttributeOptions

TypeScript
writeAttributeOptionsWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeOptions(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeOptions

TypeScript
writeAttributeOptionsWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeOptions(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)
method · iOS 16.1+

writeAttributeStartUpCurrentLevel

TypeScript
writeAttributeStartUpCurrentLevelWithValueExpectedValueInterval(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber): void
Swift declaration
func writeAttributeStartUpCurrentLevel(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber)
method · iOS 16.1+

writeAttributeStartUpCurrentLevel

TypeScript
writeAttributeStartUpCurrentLevelWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeStartUpCurrentLevel(withValue dataValueDictionary: [String : Any], expectedValueInterval expectedValueIntervalMs: NSNumber, params: MTRWriteParams?)

Skipped declarations

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

MTRClusterLevelControl.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All Matter types →