Skip to main content

CrystalDocs builds documentation for every shard, on request. The announcement: Documentation for every shard, on CrystalBits.

CrystalDocs

    Browse DocsCrystalShardsAbout

    github.com/Crystal-Matter/matter

    Types

    • Matter
      • Certificate
        • AttestationCertificateManager
        • CertificationDeclaration
          • CDContent
        • ChipPAAuthorities
      • Cluster
        • AccessControlCluster
          • AccessControlEntry
          • AccessControlEntryAuthMode
          • AccessControlEntryPrivilege
          • ExtensionEntry
          • PersistedAclEntry
          • PersistedExtensionEntry
          • PersistedState
          • PersistedTarget
          • Target
        • AddSceneRequest
        • AdministratorCommissioningCluster
          • BusyError
          • CommissioningWindowStatus
          • OpenBasicCommissioningWindowRequest
          • OpenCommissioningWindowRequest
          • PAKEParameterError
          • StatusCode
          • WindowNotOpenError
        • AttributeMetadata
        • AttributeValuePairTlv
        • Base
        • BasicInformationCluster
          • CapabilityMinimaStruct
          • Color
          • LeaveEvent
          • ProductAppearanceStruct
          • ProductFinish
          • ReachableChangedEvent
          • ShutDownEvent
          • StartUpEvent
        • BooleanStateCluster
        • BridgedDeviceBasicInformationCluster
          • Color
          • LeaveEvent
          • ProductAppearanceStruct
          • ProductFinish
          • ReachableChangedEvent
          • ShutDownEvent
          • StartUpEvent
        • CarbonDioxideConcentrationMeasurementCluster
          • LevelValue
          • MeasurementMedium
          • MeasurementUnit
        • ColorControlCluster
          • Feature
        • ColorControlUtils
        • CommandMetadata
        • CommandResponse
        • CopySceneRequest
        • CopySceneResponse
        • Definitions
          • AccessControl
            • ChangeType
            • Entry
            • EntryAuthMode
            • EntryPrivilege
            • Events
              • EntryChanged
              • ExtensionChanged
            • Extension
            • Target
          • AccountLogin
            • GetSetupPinRequest
            • GetSetupPinResponse
            • LoginRequest
          • Action
            • Base
            • DisableRequest
            • DisableWithDurationRequest
            • EnableRequest
            • EnableWithDurationRequest
            • EndpointList
            • EndpointListType
            • Error
            • Events
              • FailedEvent
              • StateChangedEvent
            • InstantRequest
            • InstantWithTransitionRequest
            • PauseRequest
            • PauseWithDurationRequest
            • ResumeRequest
            • StartRequest
            • StartWithDurationRequest
            • State
            • StopRequest
            • Type
          • AdministratorCommissioning
            • CommissioningWindowStatus
            • OpenBasicCommissioningWindowRequest
            • OpenCommissioningWindowRequest
            • StatusCode
          • ApplicationBasic
            • Application
            • ApplicationStatus
          • ApplicationLauncher
            • Application
            • ApplicationEndpoint
            • HideAppRequest
            • LaunchAppRequest
            • LauncherResponse
            • Status
            • StopAppRequest
          • AudioOutput
            • OutputInformation
            • OutputType
            • RenameOutputRequest
            • SelectOutputRequest
          • BarrierControl
            • GoToPercentRequest
          • BasicInformation
            • CapabilityMinima
            • Color
            • Configuration
            • Events
              • Leave
              • ReachableChanged
              • StartUp
            • ProductAppearance
            • ProductFinish
          • Binding
            • Target
          • BooleanState
            • Events
              • StateChange
          • Channel
            • ChangeChannelByNumberRequest
            • ChangeChannelRequest
            • ChangeChannelResponse
            • Information
            • LineupInfo
            • LineupInfoType
            • SkipChannelRequest
            • Status
          • ClientMonitoring
            • MonitoringRegistration
            • RegisterClientMonitoringRequest
            • UnregisterClientMonitoringRequest
          • ColorControl
            • Action
            • ColorLoopSetDirection
            • ColorLoopSetRequest
            • ColorMode
            • Direction
            • DriftCompensation
            • EnhancedColorMode
            • EnhancedMoveHueRequest
            • EnhancedMoveToHueAndSaturationRequest
            • EnhancedMoveToHueRequest
            • EnhancedStepHueRequest
            • MoveColorRequest
            • MoveColorTemperatureRequest
            • MoveHueRequest
            • MoveMode
            • MoveSaturationRequest
            • MoveToColorRequest
            • MoveToColorTemperatureRequest
            • MoveToHueAndSaturationRequest
            • MoveToHueRequest
            • MoveToSaturationRequest
            • StepColorRequest
            • StepColorTemperatureRequest
            • StepHueRequest
            • StepMode
            • StepSaturationRequest
            • StopMoveStepRequest
          • ContentLauncher
            • AdditionalInformation
            • BrandingInformation
            • ContentSearch
            • Dimension
            • LaunchContentRequest
            • LaunchUrlRequest
            • LauncherResponse
            • MetricType
            • Parameter
            • ParameterType
            • Status
            • StyleInformation
          • Descriptor
            • DeviceType
          • DiagnosticLogs
            • Intent
            • RetrieveLogsRequest
            • RetrieveLogsResponse
            • Status
            • TransferProtocol
          • DoorLock
            • AlarmCode
            • ClearCredentialRequest
            • ClearHolidayScheduleRequest
            • ClearUserRequest
            • ClearWeekDayScheduleRequest
            • ClearYearDayScheduleRequest
            • Credential
            • CredentialRule
            • CredentialType
            • DataOperationType
            • DoorState
            • Events
              • DoorLockAlarm
              • DoorStateChange
              • LockOperation
              • LockOperationError
              • LockUserChange
            • GetCredentialStatusRequest
            • GetCredentialStatusResponse
            • GetHolidayScheduleRequest
            • GetHolidayScheduleResponse
            • GetUserRequest
            • GetUserResponse
            • GetWeekDayScheduleRequest
            • GetWeekDayScheduleResponse
            • GetYearDayScheduleRequest
            • GetYearDayScheduleResponse
            • LockDataType
            • LockDoorRequest
            • LockOperationType
            • LockState
            • LockType
            • OperatingMode
            • OperationError
            • OperationSource
            • SetCredentialRequest
            • SetCredentialResponse
            • SetHolidayScheduleRequest
            • SetUserRequest
            • SetWeekDayScheduleRequest
            • SetYearDayScheduleRequest
            • StatusCode
            • UnboltDoorRequest
            • UnlockDoorRequest
            • UnlockWithTimeoutRequest
            • UserStatus
            • UserType
          • ElectricalMeasurement
            • GetMeasurementProfileCommandRequest
          • FaultInjection
            • FailAtFaultRequest
            • FailRandomlyAtFaultRequest
            • FaultType
          • GeneralCommissioning
            • ArmFailSafeRequest
            • ArmFailSafeResponse
            • BasicCommissioningInformation
            • CommissioningCompleteResponse
            • CommissioningError
            • RegulatoryLocationType
            • SetRegularConfigurationRequest
            • SetRegulatoryConfigurationResponse
          • GeneralDiagnostics
            • BootReason
            • Events
              • BootReasonEvent
              • HardwareFaultChange
              • NetworkFaultChange
              • RadioFaultChange
            • HardwareFault
            • InterfaceType
            • NetworkFault
            • NetworkInterface
            • RadioFault
            • TestEventTriggerRequest
          • GroupKeyManagement
            • GroupInformationMap
            • GroupKeyMap
            • GroupKeyMulticastPolicy
            • GroupKeySecurityPolicy
            • GroupKeySet
            • KeySetReadAllIndicesResponse
            • KeySetReadRequest
            • KeySetReadResponse
            • KeySetRemoveRequest
            • KeySetWriteRequest
          • Groups
            • AddGroupIfIdentifyingRequest
            • AddGroupRequest
            • AddGroupResponse
            • GetGroupMembershipRequest
            • GetGroupMembershipResponse
            • RemoveGroupRequest
            • RemoveGroupResponse
            • StatusCode
            • ViewGroupRequest
            • ViewGroupResponse
          • Identify
            • EffectIdentifier
            • EffectVariant
            • IdentifyQueryResponse
            • Request
            • TriggerEffectRequest
            • Type
          • KeypadInput
            • KeyCode
            • SendKeyRequest
            • SendKeyResponse
            • StatusCode
          • Label
            • Base
          • LevelControl
            • MoveMode
            • MoveRequest
            • MoveToClosestFrequencyRequest
            • MoveToLevelRequest
            • MoveToLevelWithOnOffRequest
            • MoveWithOnOffRequest
            • StepMode
            • StepRequest
            • StepWithOnOffRequest
            • StopRequest
            • StopWithOnOffRequest
          • MediaInput
            • InputInformation
            • InputType
            • RenameInputRequest
            • SelectInputRequest
          • MediaPlayback
            • PlaybackPosition
            • PlaybackResponse
            • PlaybackState
            • SkipBackwardRequest
            • SkipForwardRequest
            • SkipRequest
            • StatusCode
          • ModeSelect
            • ChangeToModeRequest
            • ModeOption
            • SemanticTag
          • NetworkCommissioning
            • AddOrUpdateThreadNetworkRequest
            • AddOrUpdateWiFiNetworkRequest
            • Band
            • ConnectNetworkRequest
            • ConnectNetworkResponse
            • NetworkConfigurationResponse
            • NetworkInformation
            • RemoveNetworkRequest
            • ReorderNetworkRequest
            • ScanAvailableNetworksRequest
            • ScanNetworksResponse
            • StatusCode
            • ThreadInterfaceScanResult
            • WiFiInterfaceScanResult
          • OnOff
            • EffectIdentifier
            • OffWithEffectRequest
            • OnWithTimedOffRequest
            • StartUp
          • OperationalCredentials
            • AddNocRequest
            • AddTrustedRootCertificateRequest
            • AttestationRequest
            • AttestationResponse
            • CertificateChainRequest
            • CertificateChainResponse
            • CertificateChainType
            • CsrRequest
            • CsrResponse
            • FabricDescriptor
            • NOC
            • NodeOperationalCertificateStatus
            • RemoveFabricRequest
            • TlvNocResponse
            • UpdateFabricLabelRequest
            • UpdateNocRequest
          • OtaSoftwareUpdateProviderClient
            • ApplyUpdateAction
            • ApplyUpdateRequest
            • ApplyUpdateResponse
            • DownloadProtocol
            • NotifyUpdateAppliedRequest
            • QueryImageRequest
            • QueryImageResponse
            • Status
          • OtaSoftwareUpdateRequestor
            • AnnouncementReason
            • ChangeReason
            • Events
              • TlvDownloadErrorEvent
              • TlvStateTransitionEvent
              • TlvVersionAppliedEvent
            • TlvAnnounceOtaProviderRequest
            • TlvProviderLocation
            • UpdateState
          • PowerSource
            • BatteryChargeFault
            • Events
              • BatteryChargeFaultChangeEvent
              • BatteryFaultChangeEvent
              • TlvWiredFaultChangeEvent
            • Fault
            • WiredFault
          • ProxyConfiguration
            • Configuration
          • PulseWidthModulation
            • MoveMode
            • MoveRequest
            • MoveToClosestFrequencyRequest
            • MoveToLevelRequest
            • StepRequest
            • StopRequest
          • Scenes
            • AddSceneRequest
            • AddSceneResponse
            • AttributeValuePair
            • CopySceneRequest
            • CopySceneResponse
            • ExtensionFieldSet
            • GetSceneMembershipResponse
            • RecallSceneRequest
            • RemoveAllScenesRequest
            • RemoveAllScenesResponse
            • RemoveSceneRequest
            • RemoveSceneResponse
            • StatusCode
            • StoreSceneRequest
            • StoreSceneResponse
            • ViewSceneRequest
            • ViewSceneResponse
          • SoftwareDiagnostics
            • SoftwareFaultEvent
            • ThreadMetrics
          • Switch
            • Events
              • InitialPressEvent
              • LongPressEvent
              • LongReleaseEvent
              • MultiPressCompleteEvent
              • MultiPressOngoingEvent
              • ShortReleaseEvent
              • SwitchLatchedEvent
          • TargetNavigator
            • NavigateTargetRequest
            • NavigateTargetResponse
            • StatusCode
            • TargetInformation
          • Thermostat
            • GetWeeklyScheduleRequest
            • GetWeeklyScheduleResponse
            • SetWeeklyScheduleRequest
            • SetpointAdjustMode
            • SetpointRaiseLowerRequest
            • ThermostatScheduleTransition
        • DescriptorCluster
          • DeviceTypeStruct
        • DiagnosticLogsCluster
          • Intent
          • LogsStatus
          • RetrieveLogsRequest
          • RetrieveLogsResponse
          • TransferProtocol
        • DoorLockCluster
          • Def
          • Feature
          • LedSettings
          • SoundVolume
        • EthernetNetworkDiagnosticsCluster
          • Feature
          • PHYRateEnum
        • EventMetadata
        • ExtensionFieldSetTlv
        • FanControlCluster
          • AirflowDirectionEnum
          • FanMode
          • FanModeSequence
          • Feature
          • RockSupport
          • StepDirection
          • WindSupport
        • FixedLabelCluster
        • GeneralCommissioningCluster
          • ArmFailSafeRequest
          • ArmFailSafeResponse
          • BasicCommissioningInfo
          • CommissioningCompleteResponse
          • CommissioningError
          • RegulatoryLocationType
          • SetRegulatoryConfigRequest
          • SetRegulatoryConfigResponse
        • GeneralDiagnosticsCluster
          • BootReason
          • HardwareFault
          • InterfaceType
          • NetworkFault
          • NetworkInterfaceInfo
          • RadioFault
        • GetSceneMembershipRequest
        • GetSceneMembershipResponse
        • GroupKeyManagementCluster
          • Feature
          • GroupInfoMapStruct
          • GroupKeyMapStruct
          • GroupKeyMulticastPolicyEnum
          • GroupKeySecurityPolicyEnum
          • GroupKeySetStruct
          • KeySetReadAllIndicesResponse
          • KeySetReadRequest
          • KeySetReadResponse
          • KeySetRemoveRequest
          • KeySetWriteRequest
        • GroupsCluster
          • Feature
        • IcdManagement
        • IcdManagementCluster
        • IdentifyCluster
          • EffectIdentifier
          • EffectVariant
          • IdentifyType
        • IlluminanceMeasurementCluster
          • LightSensorType
        • LabelStruct
        • LevelControlCluster
          • Feature
          • MoveMode
          • MoveRequest
          • MoveToClosestFrequencyRequest
          • MoveToLevelRequest
          • MoveToLevelWithOnOffRequest
          • MoveWithOnOffRequest
          • StepMode
          • StepRequest
          • StepWithOnOffRequest
          • StopRequest
          • StopWithOnOffRequest
        • NetworkCommissioningCluster
          • AddOrUpdateThreadNetworkRequest
          • AddOrUpdateWiFiNetworkRequest
          • ConnectNetworkRequest
          • ConnectNetworkResponse
          • Feature
          • NetworkCommissioningStatus
          • NetworkConfigResponse
          • NetworkInfo
          • NetworkType
          • RemoveNetworkRequest
          • ReorderNetworkRequest
          • ScanNetworksRequest
          • ScanNetworksResponse
          • ThreadCapabilitiesBitmap
          • ThreadInterfaceScanResult
          • WiFiBandEnum
          • WiFiInterfaceScanResult
          • WiFiSecurityType
        • OccupancySensingCluster
          • Feature
          • OccupancySensorType
        • OnOffCluster
          • Feature
          • StartUpOnOff
        • OpCredDefs
        • OperationalCredentialsCluster
          • AddNOCCommand
          • AddTrustedRootCertificateCommand
          • AttestationElements
          • AttestationRequestCommand
          • AttestationResponse
          • CSRElements
          • CSRRequestCommand
          • CSRResponse
          • CertificateChainRequestCommand
          • CertificateChainResponse
          • CertificateChainType
          • FabricDescriptorStruct
          • FailsafeContext
          • NOCResponse
          • NOCStruct
          • NodeOperationalCertStatus
          • RemoveFabricCommand
          • UpdateFabricLabelCommand
          • UpdateNOCCommand
        • OtaRequestorCluster
          • UpdateState
        • PowerSourceCluster
          • BatChargeLevel
          • BatChargeState
          • BatReplaceability
          • Feature
          • PowerSourceStatus
          • WiredCurrentType
        • PressureMeasurementCluster
        • RecallSceneRequest
        • RelativeHumidityMeasurementCluster
        • RemoveAllScenesRequest
        • RemoveAllScenesResponse
        • RemoveSceneRequest
        • SceneInfoTlv
        • SceneStatusResponse
        • ScenesCluster
          • Feature
          • SceneData
        • ScenesManagementCluster
          • ExtensionFieldSet
          • Feature
          • PersistedState
          • SceneData
          • SceneInfo
          • SceneKey
        • StoreSceneRequest
        • TemperatureMeasurementCluster
        • ThermostatCluster
          • ControlSequenceOfOperation
          • Feature
          • SystemMode
          • ThermostatRunningMode
        • TimeFormatLocalizationCluster
          • CalendarType
          • Feature
          • HourFormat
        • UserLabelCluster
        • ViewSceneRequest
        • ViewSceneResponseTlv
        • WindowCoveringCluster
          • ConfigStatus
          • CoveringType
          • EndProductType
          • Feature
          • Mode
          • OperationalStatus
      • Codec
        • DERCodec
          • Base
          • ByteArray
          • Class
          • ContextTagged
          • ContextTaggedSlice
          • Node
          • Object
          • ObjectId
          • Type
          • Value
        • MessageCodec
          • Base
          • Message
          • Packet
          • PacketHeader
          • PacketHeaderFlag
          • PayloadHeader
          • PayloadHeaderFlag
          • SecurityFlag
          • SessionType
      • CommissioningController
      • CommissioningServer
      • CommissioningWindow
        • Status
      • Controller
        • CertificateUtil
        • Client
          • ReceivedMessage
        • Clusters
          • AccessControl
            • AuthMode
            • Entry
            • EntryJson
            • Privilege
            • Target
            • TargetJson
        • Commissioning
          • Commissioner
          • CommissioningWindowOpener
            • EnhancedWindow
        • FabricInfo
        • ImClient
        • NodeInfo
        • Pairing
          • CasePairing
          • PasePairing
        • State
        • StateStore
      • Crypto
        • AES
          • Aes
          • Ccm
          • WordArray
          • WordArrayHelper
        • BinaryKeyPair
        • CryptoBase
        • CurveType
        • DNAttributes
        • ECDH
        • Key
        • KeyType
        • MatterCertificate
        • Spake2p
          • PbkdfParameters
          • SecretAndVerifiers
          • W0L
          • W0W1
        • StandardCrypto
      • DataType
        • AttributeId
        • CaseAuthenticatedTag
        • ClusterId
        • CommandId
        • DeviceTypeId
        • EndpointNumber
        • EventId
        • FabricId
        • FabricIndex
        • GroupId
        • NodeId
        • SubjectId
        • VendorId
      • Device
        • Base
        • LifecycleManager
          • Mode
      • DeviceType
      • DeviceTypes
      • Endpoint
      • Fabric
      • FabricDescriptor
      • FabricManager
      • FabricTable
      • FailsafeContext
      • FailsafeTimer
      • InteractionModel
        • AttributeDataIB
        • AttributePath
        • AttributeReportIB
        • AttributeStatusIB
        • CommandDataIBTlv
        • CommandPath
        • CommandStatusIB
        • ConcreteAttributePath
        • DataVersion
        • EventPath
        • EventPriority
        • InvokeRequestMessage
        • InvokeResponseIB
        • InvokeResponseMessage
        • ReadRequestMessage
        • ReportDataMessage
        • Status
        • StatusCode
        • StatusIB
        • StatusResponseMessage
        • SubscribeRequestMessage
        • SubscribeResponseMessage
        • WriteRequestMessage
        • WriteResponseMessage
      • Logger
      • MDNS
        • Advertiser
        • CommissionableAdvertisement
        • CommissionableServiceDescription
        • CommissioningInfo
        • CommissioningMode
        • DiscoveredDevice
        • MulticastSocket
        • OperationalInfo
        • OperationalServiceDescription
        • PairingHint
        • RecordBuilder
        • RecordGenerator
        • Responder
        • ResponderInterface
        • Scanner
        • Server
        • ServiceNames
        • ServiceType
      • MatterNode
      • Network
        • Backend
        • Constants
        • MulticastServer
        • ThreadCredentials
        • WiFiCredentials
        • WiFiNetworkInfo
        • WiFiSecurityType
      • Protocol
        • IMHandler
        • MessageHandler
          • ActiveSubscription
          • CleanupReason
          • PendingReadResponse
          • PendingSessionCleanup
          • PendingSubscription
        • Persistence
          • Base
          • StorageBackend
        • SessionManager
      • Schema
        • BitField
        • BitFieldEnum
        • BitFlag
        • Bitmap
        • BitmapSchema
        • ByteArrayBitmapSchema
        • SpecificationVersion
        • SpecificationVersionData
      • Session
        • Case
          • CaseInitiator
          • CaseResponder
          • Definitions
            • EncryptedDataSigma2
            • EncryptedDataSigma3
            • SessionParameter
            • Sigma1
            • Sigma2
            • Sigma3
            • SignedData
          • OperationalCertChain
        • Pase
          • Definitions
            • MrpParameters
            • Pake1
            • Pake2
            • Pake3
            • PbkdfParamRequest
            • PbkdfParamResponse
            • PbkdfParametersTLV
            • StatusReport
          • PaseCommissioner
          • PaseResponder
          • PbkdfParameters
        • SecureContext
        • SecureMessage
        • SessionParameters
        • SessionType
        • UnsecuredContext
      • SessionManager
        • CaseSession
        • PaseSession
      • SetupPayload
        • QRCode
          • CommissionFlow
          • DiscoveryCapability
        • Verhoeff
      • Storage
        • Base
        • JsonFileBackend
        • Manager
        • MemoryBackend
        • Scalar
        • Type
      • Transport
        • Exchange
          • State
        • ExchangeManager
        • MessageCounter
          • CheckResult
        • UDPTransport
      • Utilities
        • Cache
          • Interface
        • DeepEqual
    module

    Matter::InteractionModel

    Nested types

    • Matter::InteractionModel::AttributeDataIB
    • Matter::InteractionModel::AttributePath
    • Matter::InteractionModel::AttributeReportIB
    • Matter::InteractionModel::AttributeStatusIB
    • Matter::InteractionModel::CommandDataIBTlv
    • Matter::InteractionModel::CommandPath
    • Matter::InteractionModel::CommandStatusIB
    • Matter::InteractionModel::ConcreteAttributePath
    • Matter::InteractionModel::DataVersion
    • Matter::InteractionModel::EventPath
    • Matter::InteractionModel::EventPriority
    • Matter::InteractionModel::InvokeRequestMessage
    • Matter::InteractionModel::InvokeResponseIB
    • Matter::InteractionModel::InvokeResponseMessage
    • Matter::InteractionModel::ReadRequestMessage
    • Matter::InteractionModel::ReportDataMessage
    • Matter::InteractionModel::Status
    • Matter::InteractionModel::StatusCode
    • Matter::InteractionModel::StatusIB
    • Matter::InteractionModel::StatusResponseMessage
    • Matter::InteractionModel::SubscribeRequestMessage
    • Matter::InteractionModel::SubscribeResponseMessage
    • Matter::InteractionModel::WriteRequestMessage
    • Matter::InteractionModel::WriteResponseMessage

    Advertisement

    Crystal jobs from CrystalGigs

    • Your posting here

      Reach Crystal developers on CrystalGigsFirst party

    CrystalDocs.org - Crystal Shard Documentation Hosting

    The CrystalBits newsletter

    Crystal tutorials, release news and community writing. One email when there is something new, never a stream.

    You will get one confirmation email to check the address is yours. Unsubscribe any time.

    GitHubCrystalShardsCrystalGigsCrystalBitsCrystal LanguageStatsSponsor

    The Bushido Collective builds and maintains this site.
    Licensed under the Apache License 2.0