One Logo Pool Ball
X
Github
Discord

System

Matter · IOS API REFERENCE

MTRClusterBasicInformation

class · iOS 16.4+ · SDK 27.1

class MTRClusterBasicInformation

Members (35)

init · iOS 16.4+

init

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

readAttributeAcceptedCommandList

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

readAttributeAttributeList

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

readAttributeCapabilityMinima

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

readAttributeClusterRevision

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

readAttributeDataModelRevision

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

readAttributeFeatureMap

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

readAttributeGeneratedCommandList

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

readAttributeHardwareVersionString

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

readAttributeHardwareVersion

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

readAttributeLocalConfigDisabled

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

readAttributeLocation

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

readAttributeManufacturingDate

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

readAttributeMaxPathsPerInvoke

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

readAttributeNodeLabel

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

readAttributePartNumber

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

readAttributeProductAppearance

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

readAttributeProductID

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

readAttributeProductLabel

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

readAttributeProductName

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

readAttributeProductURL

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

readAttributeReachable

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

readAttributeSerialNumber

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

readAttributeSoftwareVersionString

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

readAttributeSoftwareVersion

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

readAttributeSpecificationVersion

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

readAttributeUniqueID

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

readAttributeVendorID

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

readAttributeVendorName

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

writeAttributeLocalConfigDisabled

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

writeAttributeLocalConfigDisabled

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

writeAttributeLocation

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

writeAttributeLocation

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

writeAttributeNodeLabel

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

writeAttributeNodeLabel

TypeScript
writeAttributeNodeLabelWithValueExpectedValueIntervalParams(dataValueDictionary: Record<string, unknown>, expectedValueIntervalMs: _Foundation_NSNumber, params?: (MTRWriteParams) | null): void
Swift declaration
func writeAttributeNodeLabel(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.

MTRClusterBasicInformation.init()

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

All Matter types →