Matter
Communicate with and control smart home devices from a variety of manufacturers.
Overview
The Matter smart home connectivity standard enables interoperability between various smart home devices and ecosystems. Use MatterSupport to bring accessories onto a local network, then commission and control those accessories using Matter.
[Image]
To access a Matter accessory on a network, you must commission it. Commissioning provides credentials to enable secure communication and performs initial accessory configuration. Once you commission an accessory, it exposes areas of functionality called clusters that you use to control it. For example, a light exposes the On/Off cluster to control whether it’s on or off. A dimmable light also exposes the Level Control cluster to control its brightness.
Topics
Matter device onboarding
Matter device interactions
Reference
Classes
MTRAccessControlClusterAccessRestrictionEntryStructMTRAccessControlClusterAccessRestrictionStructMTRAccessControlClusterCommissioningAccessRestrictionEntryStructMTRAccessControlClusterFabricRestrictionReviewUpdateEventMTRAccessControlClusterReviewFabricRestrictionsParamsMTRAccessControlClusterReviewFabricRestrictionsResponseParamsMTRAccountLoginClusterLoggedOutEventMTRAttributeValueWaiterMTRBaseClusterCommissionerControlMTRBaseClusterContentAppObserverMTRBaseClusterDeviceEnergyManagementMTRBaseClusterDeviceEnergyManagementModeMTRBaseClusterDishwasherAlarmMTRBaseClusterDishwasherModeMTRBaseClusterEnergyEVSEMTRBaseClusterEnergyEVSEModeMTRBaseClusterICDManagementMTRBaseClusterLaundryDryerControlsMTRBaseClusterLaundryWasherControlsMTRBaseClusterLaundryWasherModeMTRBaseClusterMessagesMTRBaseClusterMicrowaveOvenControlMTRBaseClusterMicrowaveOvenModeMTRBaseClusterOvenCavityOperationalStateMTRBaseClusterOvenModeMTRBaseClusterPowerTopologyMTRBaseClusterRefrigeratorAlarmMTRBaseClusterRefrigeratorAndTemperatureControlledCabinetModeMTRBaseClusterServiceAreaMTRBaseClusterTemperatureControlMTRBaseClusterThreadBorderRouterManagementMTRBaseClusterThreadNetworkDirectoryMTRBaseClusterTimeSynchronizationMTRBaseClusterWaterHeaterManagementMTRBaseClusterWaterHeaterModeMTRBaseClusterWiFiNetworkManagementMTRBridgedDeviceBasicInformationClusterActiveChangedEventMTRBridgedDeviceBasicInformationClusterKeepActiveParamsMTRChannelClusterCancelRecordProgramParamsMTRChannelClusterChannelPagingStructMTRChannelClusterGetProgramGuideParamsMTRChannelClusterPageTokenStructMTRChannelClusterProgramCastStructMTRChannelClusterProgramCategoryStructMTRChannelClusterProgramGuideResponseParamsMTRChannelClusterProgramStructMTRChannelClusterRecordProgramParamsMTRChannelClusterSeriesInfoStructMTRClusterCommissionerControlMTRClusterContentAppObserverMTRClusterDeviceEnergyManagementMTRClusterDeviceEnergyManagementModeMTRClusterDishwasherAlarmMTRClusterDishwasherModeMTRClusterEnergyEVSEMTRClusterEnergyEVSEModeMTRClusterICDManagementMTRClusterLaundryDryerControlsMTRClusterLaundryWasherControlsMTRClusterLaundryWasherModeMTRClusterMessagesMTRClusterMicrowaveOvenControlMTRClusterMicrowaveOvenModeMTRClusterOvenCavityOperationalStateMTRClusterOvenModeMTRClusterPowerTopologyMTRClusterRefrigeratorAlarmMTRClusterRefrigeratorAndTemperatureControlledCabinetModeMTRClusterServiceAreaMTRClusterTemperatureControlMTRClusterThreadBorderRouterManagementMTRClusterThreadNetworkDirectoryMTRClusterTimeSynchronizationMTRClusterWaterHeaterManagementMTRClusterWaterHeaterModeMTRClusterWiFiNetworkManagementMTRCommandWithRequiredResponseMTRCommissioneeInfoMTRCommissionerControlClusterCommissionNodeParamsMTRCommissionerControlClusterCommissioningRequestResultEventMTRCommissionerControlClusterRequestCommissioningApprovalParamsMTRCommissionerControlClusterReverseOpenCommissioningWindowParamsMTRCommissioningOperationMTRContentAppObserverClusterContentAppMessageParamsMTRContentAppObserverClusterContentAppMessageResponseParamsMTRDataTypeAtomicAttributeStatusStructMTRDataTypeLocationDescriptorStructMTRDeviceEnergyManagementClusterCancelPowerAdjustRequestParamsMTRDeviceEnergyManagementClusterCancelRequestParamsMTRDeviceEnergyManagementClusterConstraintsStructMTRDeviceEnergyManagementClusterCostStructMTRDeviceEnergyManagementClusterForecastStructMTRDeviceEnergyManagementClusterModifyForecastRequestParamsMTRDeviceEnergyManagementClusterPauseRequestParamsMTRDeviceEnergyManagementClusterPausedEventMTRDeviceEnergyManagementClusterPowerAdjustCapabilityStructMTRDeviceEnergyManagementClusterPowerAdjustEndEventMTRDeviceEnergyManagementClusterPowerAdjustRequestParamsMTRDeviceEnergyManagementClusterPowerAdjustStartEventMTRDeviceEnergyManagementClusterPowerAdjustStructMTRDeviceEnergyManagementClusterRequestConstraintBasedForecastParamsMTRDeviceEnergyManagementClusterResumeRequestParamsMTRDeviceEnergyManagementClusterResumedEventMTRDeviceEnergyManagementClusterSlotAdjustmentStructMTRDeviceEnergyManagementClusterSlotStructMTRDeviceEnergyManagementClusterStartTimeAdjustRequestParamsMTRDeviceEnergyManagementModeClusterChangeToModeParamsMTRDeviceEnergyManagementModeClusterChangeToModeResponseParamsMTRDeviceEnergyManagementModeClusterModeOptionStructMTRDeviceEnergyManagementModeClusterModeTagStructMTRDeviceTypeMTRDishwasherAlarmClusterModifyEnabledAlarmsParamsMTRDishwasherAlarmClusterNotifyEventMTRDishwasherAlarmClusterResetParamsMTRDishwasherModeClusterChangeToModeParamsMTRDishwasherModeClusterChangeToModeResponseParamsMTRDishwasherModeClusterModeOptionStructMTRDishwasherModeClusterModeTagStructMTRDoorLockClusterClearAliroReaderConfigParamsMTRDoorLockClusterSetAliroReaderConfigParamsMTRDoorLockClusterUnboltDoorParamsMTRElectricalEnergyMeasurementClusterMeasurementAccuracyRangeStructMTREndpointInfoMTREnergyEVSEClusterChargingTargetScheduleStructMTREnergyEVSEClusterChargingTargetStructMTREnergyEVSEClusterClearTargetsParamsMTREnergyEVSEClusterDisableParamsMTREnergyEVSEClusterEVConnectedEventMTREnergyEVSEClusterEVNotDetectedEventMTREnergyEVSEClusterEnableChargingParamsMTREnergyEVSEClusterEnergyTransferStartedEventMTREnergyEVSEClusterEnergyTransferStoppedEventMTREnergyEVSEClusterFaultEventMTREnergyEVSEClusterGetTargetsParamsMTREnergyEVSEClusterGetTargetsResponseParamsMTREnergyEVSEClusterRFIDEventMTREnergyEVSEClusterSetTargetsParamsMTREnergyEVSEClusterStartDiagnosticsParamsMTREnergyEVSEModeClusterChangeToModeParamsMTREnergyEVSEModeClusterChangeToModeResponseParamsMTREnergyEVSEModeClusterModeOptionStructMTREnergyEVSEModeClusterModeTagStructMTRGeneralDiagnosticsClusterPayloadTestRequestParamsMTRGeneralDiagnosticsClusterPayloadTestResponseParamsMTRGeneralDiagnosticsClusterTimeSnapshotParamsMTRGeneralDiagnosticsClusterTimeSnapshotResponseParamsMTRICDManagementClusterMonitoringRegistrationStructMTRICDManagementClusterRegisterClientParamsMTRICDManagementClusterRegisterClientResponseParamsMTRICDManagementClusterStayActiveRequestParamsMTRICDManagementClusterStayActiveResponseParamsMTRICDManagementClusterUnregisterClientParamsMTRLaundryWasherModeClusterChangeToModeParamsMTRLaundryWasherModeClusterChangeToModeResponseParamsMTRLaundryWasherModeClusterModeOptionStructMTRLaundryWasherModeClusterModeTagStructMTRMediaPlaybackClusterActivateAudioTrackParamsMTRMediaPlaybackClusterActivateTextTrackParamsMTRMediaPlaybackClusterDeactivateTextTrackParamsMTRMediaPlaybackClusterStateChangedEventMTRMessagesClusterCancelMessagesRequestParamsMTRMessagesClusterMessageCompleteEventMTRMessagesClusterMessagePresentedEventMTRMessagesClusterMessageQueuedEventMTRMessagesClusterMessageResponseOptionStructMTRMessagesClusterMessageStructMTRMessagesClusterPresentMessagesRequestParamsMTRMicrowaveOvenControlClusterAddMoreTimeParamsMTRMicrowaveOvenControlClusterSetCookingParametersParamsMTRMicrowaveOvenModeClusterModeOptionStructMTRMicrowaveOvenModeClusterModeTagStructMTROccupancySensingClusterHoldTimeLimitsStructMTROccupancySensingClusterOccupancyChangedEventMTROvenCavityOperationalStateClusterErrorStateStructMTROvenCavityOperationalStateClusterOperationCompletionEventMTROvenCavityOperationalStateClusterOperationalCommandResponseParamsMTROvenCavityOperationalStateClusterOperationalErrorEventMTROvenCavityOperationalStateClusterOperationalStateStructMTROvenCavityOperationalStateClusterStartParamsMTROvenCavityOperationalStateClusterStopParamsMTROvenModeClusterChangeToModeParamsMTROvenModeClusterChangeToModeResponseParamsMTROvenModeClusterModeOptionStructMTROvenModeClusterModeTagStructMTRRVCOperationalStateClusterGoHomeParamsMTRRefrigeratorAlarmClusterNotifyEventMTRRefrigeratorAndTemperatureControlledCabinetModeClusterChangeToModeParamsMTRRefrigeratorAndTemperatureControlledCabinetModeClusterChangeToModeResponseParamsMTRRefrigeratorAndTemperatureControlledCabinetModeClusterModeOptionStructMTRRefrigeratorAndTemperatureControlledCabinetModeClusterModeTagStructMTRServiceAreaClusterAreaInfoStructMTRServiceAreaClusterAreaStructMTRServiceAreaClusterLandmarkInfoStructMTRServiceAreaClusterMapStructMTRServiceAreaClusterProgressStructMTRServiceAreaClusterSelectAreasParamsMTRServiceAreaClusterSelectAreasResponseParamsMTRServiceAreaClusterSkipAreaParamsMTRServiceAreaClusterSkipAreaResponseParamsMTRTargetNavigatorClusterTargetUpdatedEventMTRTemperatureControlClusterSetTemperatureParamsMTRThermostatClusterAtomicRequestParamsMTRThermostatClusterAtomicResponseParamsMTRThermostatClusterPresetStructMTRThermostatClusterPresetTypeStructMTRThermostatClusterScheduleStructMTRThermostatClusterScheduleTransitionStructMTRThermostatClusterScheduleTypeStructMTRThermostatClusterSetActivePresetRequestParamsMTRThermostatClusterSetActiveScheduleRequestParamsMTRThreadBorderRouterManagementClusterDatasetResponseParamsMTRThreadBorderRouterManagementClusterGetActiveDatasetRequestParamsMTRThreadBorderRouterManagementClusterGetPendingDatasetRequestParamsMTRThreadBorderRouterManagementClusterSetActiveDatasetRequestParamsMTRThreadBorderRouterManagementClusterSetPendingDatasetRequestParamsMTRThreadNetworkDirectoryClusterAddNetworkParamsMTRThreadNetworkDirectoryClusterGetOperationalDatasetParamsMTRThreadNetworkDirectoryClusterOperationalDatasetResponseParamsMTRThreadNetworkDirectoryClusterRemoveNetworkParamsMTRThreadNetworkDirectoryClusterThreadNetworkStructMTRTimeSynchronizationClusterDSTStatusEventMTRTimeSynchronizationClusterDSTTableEmptyEventMTRTimeSynchronizationClusterFabricScopedTrustedTimeSourceStructMTRTimeSynchronizationClusterMissingTrustedTimeSourceEventMTRTimeSynchronizationClusterSetDSTOffsetParamsMTRTimeSynchronizationClusterSetDefaultNTPParamsMTRTimeSynchronizationClusterSetTimeZoneParamsMTRTimeSynchronizationClusterSetTimeZoneResponseParamsMTRTimeSynchronizationClusterSetTrustedTimeSourceParamsMTRTimeSynchronizationClusterTimeFailureEventMTRTimeSynchronizationClusterTimeZoneStatusEventMTRTimeSynchronizationClusterTrustedTimeSourceStructMTRWaterHeaterManagementClusterBoostEndedEventMTRWaterHeaterManagementClusterBoostParamsMTRWaterHeaterManagementClusterBoostStartedEventMTRWaterHeaterManagementClusterCancelBoostParamsMTRWaterHeaterManagementClusterWaterHeaterBoostInfoStructMTRWaterHeaterModeClusterChangeToModeParamsMTRWaterHeaterModeClusterChangeToModeResponseParamsMTRWaterHeaterModeClusterModeOptionStructMTRWaterHeaterModeClusterModeTagStructMTRWiFiNetworkManagementClusterNetworkPassphraseRequestParamsMTRWiFiNetworkManagementClusterNetworkPassphraseResponseParamsMTRXPCDeviceControllerParameters
Protocols
MTRCommissioningDelegateMTRXPCClientProtocolMTRXPCClientProtocol_MTRDeviceMTRXPCClientProtocol_MTRDeviceControllerMTRXPCServerProtocolMTRXPCServerProtocol_MTRDeviceMTRXPCServerProtocol_MTRDeviceController
Structures
MTRAccessControlFeatureMTRBridgedDeviceBasicInformationFeatureMTRChannelRecordingFlagBitmapMTRColorControlColorCapabilitiesBitmapMTRColorControlOptionsBitmapMTRColorControlUpdateFlagsBitmapMTRCommissionerControlSupportedDeviceCategoryBitmapMTRDeviceEnergyManagementFeatureMTRDishwasherAlarmAlarmBitmapMTRDishwasherAlarmFeatureMTREnergyEVSEFeatureMTREnergyEVSETargetDayOfWeekBitmapMTRGeneralDiagnosticsFeatureMTRICDManagementFeatureMTRICDManagementUserActiveModeTriggerBitmapMTRLaundryWasherControlsFeatureMTRMessagesFeatureMTRMessagesMessageControlBitmapMTRMicrowaveOvenControlFeatureMTRNetworkCommissioningThreadCapabilitiesBitmapMTROccupancySensingFeatureMTRPowerTopologyFeatureMTRRefrigeratorAlarmAlarmBitmapMTRServiceAreaFeatureMTRTemperatureControlFeatureMTRThermostatACErrorCodeBitmapMTRThermostatHVACSystemTypeBitmapMTRThermostatOccupancyBitmapMTRThermostatPresetTypeFeaturesBitmapMTRThermostatProgrammingOperationModeBitmapMTRThermostatRelayStateBitmapMTRThermostatRemoteSensingBitmapMTRThermostatScheduleTypeFeaturesBitmapMTRThreadBorderRouterManagementFeatureMTRTimeSynchronizationFeatureMTRWaterHeaterManagementFeatureMTRWaterHeaterManagementWaterHeaterHeatSourceBitmap
Variables
MTRDeviceControllerRegistrationControllerCompressedFabricIDKeyMTRDeviceControllerRegistrationControllerContextKeyMTRDeviceControllerRegistrationControllerIsRunningKeyMTRDeviceControllerRegistrationControllerNodeIDKeyMTRDeviceControllerRegistrationDeviceInternalStateKeyMTRDeviceControllerRegistrationNodeIDKeyMTRDeviceControllerRegistrationNodeIDsKey
Functions
Enumerations
MTRAccessControlAccessRestrictionTypeMTRChannelTypeMTRColorControlDirectionMTRColorControlDriftCompensationMTRColorControlEnhancedColorModeMTRColorControlMoveModeMTRColorControlStepModeMTRContentAppObserverStatusMTRDataTypeAtomicRequestTypeEnumMTRDataTypeLandmarkTagMTRDataTypePositionTagMTRDataTypeRelativePositionTagMTRDeviceEnergyManagementAdjustmentCauseMTRDeviceEnergyManagementCauseMTRDeviceEnergyManagementCostTypeMTRDeviceEnergyManagementESAStateMTRDeviceEnergyManagementESATypeMTRDeviceEnergyManagementForecastUpdateReasonMTRDeviceEnergyManagementModeModeTagMTRDeviceEnergyManagementOptOutStateMTRDeviceEnergyManagementPowerAdjustReasonMTRDeviceTypeIDTypeMTRDishwasherModeModeTagMTRElectricalEnergyMeasurementMeasurementTypeMTREnergyEVSEEnergyTransferStoppedReasonMTREnergyEVSEFaultStateMTREnergyEVSEModeModeTagMTREnergyEVSEStateMTREnergyEVSESupplyStateMTRICDManagementClientTypeMTRICDManagementOperatingModeMTRLaundryDryerControlsDrynessLevelMTRLaundryWasherControlsNumberOfRinsesMTRLaundryWasherModeModeTagMTRMediaPlaybackCharacteristicMTRMessagesFutureMessagePreferenceMTRMessagesMessagePriorityMTRMicrowaveOvenModeModeTagMTROvenCavityOperationalStateErrorStateMTROvenCavityOperationalStateOperationalStateMTROvenModeModeTagMTRRefrigeratorAndTemperatureControlledCabinetModeModeTagMTRServiceAreaOperationalStatusMTRServiceAreaSelectAreasStatusMTRServiceAreaSkipAreaStatusMTRThermostatACCapacityFormatMTRThermostatACCompressorTypeMTRThermostatACLouverPositionMTRThermostatACRefrigerantTypeMTRThermostatACTypeMTRThermostatPresetScenarioMTRThermostatSetpointChangeSourceMTRThermostatStartOfWeekMTRThermostatTemperatureSetpointHoldMTRTimeSynchronizationStatusCodeMTRTimeSynchronizationTimeZoneDatabaseMTRWaterHeaterManagementBoostStateMTRWaterHeaterModeModeTag