One Logo Pool Ball
X
Github
Discord

System

Matter · IOS API REFERENCE

MTRClusterGeneralDiagnostics

class · iOS 16.1+ · SDK 27.1

class MTRClusterGeneralDiagnostics

Members (22)

init · iOS 16.1+ · Deprecated in iOS 16.4

init

TypeScript
static initDeviceEndpointQueue(device: MTRDevice, endpoint: number, queue: _Dispatch_DispatchQueue): (MTRClusterGeneralDiagnostics) | 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): (MTRClusterGeneralDiagnostics) | null
Swift declaration
init?(device: MTRDevice, endpointID: NSNumber, queue: dispatch_queue_t)
method · iOS 18.4+

payloadTestRequest

TypeScript
payloadTestRequest(params: MTRGeneralDiagnosticsClusterPayloadTestRequestParams, expectedDataValueDictionaries: (Array<Record<string, unknown>>) | null, expectedValueIntervalMs: (_Foundation_NSNumber) | null, completion: ((arg0: (MTRGeneralDiagnosticsClusterPayloadTestResponseParams) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func payloadTestRequest(with params: MTRGeneralDiagnosticsClusterPayloadTestRequestParams, expectedValues expectedDataValueDictionaries: [[String : Any]]?, expectedValueInterval expectedValueIntervalMs: NSNumber?) async throws -> MTRGeneralDiagnosticsClusterPayloadTestResponseParams
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+

readAttributeActiveHardwareFaults

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

readAttributeActiveNetworkFaults

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

readAttributeActiveRadioFaults

TypeScript
readAttributeActiveRadioFaults(params?: (MTRReadParams) | null): (Record<string, unknown>) | null
Swift declaration
func readAttributeActiveRadioFaults(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.4+

readAttributeBootReason

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

readAttributeBootReasons

TypeScript
readAttributeBootReasons(params?: (MTRReadParams) | null): Record<string, unknown>
Swift declaration
func readAttributeBootReasons(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+

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+

readAttributeNetworkInterfaces

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

readAttributeRebootCount

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

readAttributeTestEventTriggersEnabled

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

readAttributeTotalOperationalHours

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

readAttributeUpTime

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

testEventTrigger

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

testEventTrigger

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

timeSnapshot

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

timeSnapshot

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

Skipped declarations

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

MTRClusterGeneralDiagnostics.init()

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

All Matter types →