From 8286292ae46fb559d6f1c0b9f82aa14f396076a1 Mon Sep 17 00:00:00 2001 From: Apollon77's GitHub Automator <146069929+Automator77@users.noreply.github.com> Date: Mon, 13 Nov 2023 12:32:09 +0100 Subject: [PATCH] v0.7.0 (#518) --- CHANGELOG.md | 2 +- chip-testing/package.json | 8 +- codegen/package.json | 8 +- .../classes/BleBroadcaster.md | 30 +- docs/matter-node-ble.js/classes/BleNode.md | 18 +- docs/matter-node-ble.js/classes/BleScanner.md | 115 +- .../classes/internal_.AttributeClient.md | 36 +- .../classes/internal_.AttributeServer.md | 72 +- .../classes/internal_.BaseAttributeServer.md | 26 +- .../classes/internal_.Ble.md | 10 +- .../classes/internal_.BlenoBleServer.md | 48 +- .../classes/internal_.BtpService.md | 2 +- .../classes/internal_.BtpSessionHandler.md | 54 +- .../classes/internal_.ChannelManager.md | 41 +- .../classes/internal_.CommandServer.md | 18 +- .../classes/internal_.Endpoint.md | 70 +- .../classes/internal_.EventClient.md | 26 +- .../classes/internal_.EventHandler.md | 16 +- .../classes/internal_.EventServer.md | 30 +- .../classes/internal_.ExchangeManager.md | 123 +- .../classes/internal_.ExchangeProvider.md | 58 +- .../classes/internal_.Fabric.md | 91 +- .../classes/internal_.FabricBuilder.md | 54 +- .../internal_.FabricScopedAttributeServer.md | 84 +- .../classes/internal_.FailSafeManager.md | 42 +- .../classes/internal_.FixedAttributeServer.md | 48 +- .../classes/internal_.InteractionClient.md | 154 +- .../internal_.InteractionEndpointStructure.md | 60 +- .../classes/internal_.InteractionMessenger.md | 18 +- .../internal_.InteractionServerMessenger.md | 24 +- .../classes/internal_.MatterController.md | 403 ++-- .../classes/internal_.MatterDevice.md | 218 ++- .../classes/internal_.MdnsScanner.md | 662 +++++++ .../classes/internal_.MessageChannel.md | 27 +- .../classes/internal_.MessageCounter.md | 4 +- .../classes/internal_.MessageExchange.md | 82 +- .../classes/internal_.NobleBleClient.md | 20 +- .../classes/internal_.PaseServer.md | 43 +- .../classes/internal_.PaseServerMessenger.md | 34 +- .../internal_.RootCertificateManager.md | 18 +- .../classes/internal_.Schema.md | 10 +- .../internal_.SecureChannelMessenger.md | 26 +- .../classes/internal_.SecureSession.md | 222 ++- .../classes/internal_.SessionManager.md | 140 +- .../classes/internal_.Storage.md | 52 +- .../classes/internal_.StorageContext.md | 65 +- .../classes/internal_.SubscriptionHandler.md | 92 +- .../classes/internal_.TlvSchema.md | 26 +- .../classes/internal_.UdpMulticastServer.md | 206 ++ .../classes/internal_.UnsecureSession.md | 65 +- ...s_dist_esm_tlv_TlvObject_.ObjectSchema.md} | 68 +- .../enums/internal_.AccessLevel.md | 8 +- .../internal_.CommissioningWindowStatus.md | 6 +- .../enums/internal_.CurveType.md | 6 +- .../enums/internal_.DeviceClasses.md | 22 +- .../enums/internal_.EventPriority.md | 6 +- .../enums/internal_.KeyType.md | 6 +- .../enums/internal_.NodeStateInformation.md | 78 + .../enums/internal_.ProtocolStatusCode.md | 10 +- .../enums/internal_.RegulatoryLocationType.md | 6 +- .../enums/internal_.SessionType.md | 4 +- .../enums/internal_.StatusCode.md | 54 +- .../enums/internal_.TlvLength.md | 8 +- .../interfaces/internal_.Attribute.md | 34 +- .../interfaces/internal_.AttributeOptions.md | 14 +- .../interfaces/internal_.AttributePath.md | 6 +- .../interfaces/internal_.AttributeStatus.md | 4 +- .../interfaces/internal_.AttributeWithPath.md | 4 +- .../interfaces/internal_.Channel.md | 6 +- .../interfaces/internal_.Cluster.md | 18 +- .../interfaces/internal_.Command.md | 20 +- .../interfaces/internal_.CommandOptions.md | 4 +- .../interfaces/internal_.CommandPath.md | 6 +- .../interfaces/internal_.CommandWithPath.md | 4 +- .../internal_.DeviceTypeDefinition.md | 20 +- .../interfaces/internal_.EndpointOptions.md | 4 +- .../interfaces/internal_.Event.md | 18 +- .../interfaces/internal_.EventData.md | 12 +- .../interfaces/internal_.EventOptions.md | 2 +- .../interfaces/internal_.EventPath.md | 6 +- .../interfaces/internal_.EventStorageData.md | 14 +- .../interfaces/internal_.EventWithPath.md | 4 +- .../internal_.FabricScopedAttribute.md | 34 +- .../interfaces/internal_.FieldType.md | 8 +- .../interfaces/internal_.FixedAttribute.md | 34 +- .../internal_.InstanceBroadcaster.md | 14 +- .../interfaces/internal_.Key.md | 70 +- .../interfaces/internal_.Listener.md | 2 +- .../interfaces/internal_.Message.md | 6 +- .../interfaces/internal_.MrpParameters.md | 6 +- .../interfaces/internal_.NetInterface.md | 6 +- .../interfaces/internal_.OptionalAttribute.md | 34 +- .../interfaces/internal_.OptionalCommand.md | 20 +- .../interfaces/internal_.OptionalEvent.md | 18 +- .../interfaces/internal_.OptionalFieldType.md | 8 +- .../internal_.OptionalFixedAttribute.md | 34 +- .../internal_.OptionalWritableAttribute.md | 34 +- ..._.OptionalWritableFabricScopedAttribute.md | 34 +- .../interfaces/internal_.Packet.md | 4 +- .../interfaces/internal_.PacketHeader.md | 18 +- .../interfaces/internal_.PayloadHeader.md | 12 +- .../interfaces/internal_.PbkdfParameters.md | 4 +- .../interfaces/internal_.ProtocolHandler.md | 19 +- .../interfaces/internal_.ResumptionRecord.md | 8 +- .../interfaces/internal_.Scanner.md | 72 +- .../interfaces/internal_.Session.md | 46 +- .../interfaces/internal_.Timer.md | 6 +- .../interfaces/internal_.TlvReader.md | 4 +- .../interfaces/internal_.TlvWriter.md | 4 +- .../internal_.TransportInterface.md | 4 +- .../internal_.UdpMulticastServerOptions.md | 54 + .../interfaces/internal_.WritableAttribute.md | 34 +- ...internal_.WritableFabricScopedAttribute.md | 34 +- docs/matter-node-ble.js/modules.md | 4 +- .../modules/internal_.FabricIndex.md | 4 +- .../modules/internal_.NodeId.md | 6 +- ...ages_matter_js_dist_esm_tlv_TlvObject_.md} | 40 +- docs/matter-node-ble.js/modules/internal_.md | 506 ++--- .../classes/crypto_export.CryptoNode.md | 26 +- .../classes/crypto_export.Spake2p.md | 4 +- .../classes/export.CommissioningController.md | 512 +++-- .../classes/export.CommissioningServer.md | 239 ++- .../classes/export.MatterNode.md | 217 +-- .../classes/export.MatterServer.md | 114 +- .../export._internal_.DimmableBaseDevice.md | 52 +- ...port._internal_.ManualPairingCodeSchema.md | 4 +- .../export._internal_.MatterController.md | 403 ++-- .../classes/export._internal_.MatterDevice.md | 204 +- .../export._internal_.QrPairingCodeSchema.md | 4 +- .../exports_cluster.AttributeClient.md | 2 +- .../classes/exports_cluster.EventClient.md | 4 +- ...ports_cluster.SupportedAttributeClient.md} | 42 +- ...> exports_cluster.SupportedEventClient.md} | 34 +- ...luster.UnknownSupportedAttributeClient.md} | 70 +- ...ts_cluster.UnknownSupportedEventClient.md} | 34 +- .../classes/exports_common.MatterError.md | 2 + .../classes/exports_device.Aggregator.md | 4 +- .../classes/exports_device.ComposedDevice.md | 31 +- .../classes/exports_device.Device.md | 50 +- .../exports_device.DimmableLightDevice.md | 52 +- ...exports_device.DimmablePluginUnitDevice.md | 52 +- .../classes/exports_device.OnOffBaseDevice.md | 52 +- .../exports_device.OnOffLightDevice.md | 52 +- .../exports_device.OnOffPluginUnitDevice.md | 52 +- .../classes/exports_device.PairedNode.md | 583 ++++++ .../classes/exports_device.RootEndpoint.md | 98 + .../classes/exports_fabric.Fabric.md | 9 +- .../classes/exports_fabric.FabricBuilder.md | 54 +- .../classes/exports_fabric.FabricManager.md | 38 +- .../exports_interaction.InteractionClient.md | 154 +- .../exports_interaction.InteractionServer.md | 4 + .../exports_interaction.SubscriptionClient.md | 132 +- .../classes/exports_log.Logger.md | 46 +- .../classes/exports_mdns.MdnsBroadcaster.md | 27 +- .../classes/exports_mdns.MdnsScanner.md | 190 +- .../exports_protocol.ChannelManager.md | 27 +- ...exports_protocol.ControllerCommissioner.md | 113 +- .../exports_protocol.ControllerDiscovery.md | 179 ++ .../exports_protocol.DiscoveryError.md | 39 + .../exports_protocol.ExchangeCounter.md | 4 +- .../exports_protocol.ExchangeManager.md | 121 +- .../exports_protocol.ExchangeProvider.md | 58 +- .../exports_protocol.MessageChannel.md | 27 +- .../exports_protocol.MessageCounter.md | 4 +- .../exports_protocol.MessageExchange.md | 6 +- .../classes/exports_schema.QrCodeSchema.md | 21 + ...rts_securechannel.SecureChannelProtocol.md | 65 +- ...l.StatusReportOnlySecureChannelProtocol.md | 116 ++ .../classes/exports_session.CaseServer.md | 19 + .../classes/exports_session.PaseClient.md | 54 +- .../classes/exports_session.PaseServer.md | 19 + .../classes/exports_session.SecureSession.md | 222 ++- .../classes/exports_session.SessionManager.md | 128 +- .../exports_session.UnsecureSession.md | 61 +- .../classes/net_export.NetworkNode.md | 96 +- .../classes/net_export.UdpChannelNode.md | 14 +- .../classes/storage_export.Storage.md | 42 + .../storage_export.StorageBackendDisk.md | 92 +- .../storage_export.StorageBackendJsonFile.md | 84 +- .../storage_export.StorageBackendMemory.md | 50 + .../classes/storage_export.StorageContext.md | 49 + .../classes/time_export.TimeNode.md | 8 +- .../classes/util_export.Cache.md | 31 +- ...Handler.md => util_export.NamedHandler.md} | 20 +- ...._internal_.CommissioningStepResultCode.md | 8 +- .../exports_device.NodeStateInformation.md | 78 + .../exports_schema.CommissionningFlowType.md | 6 +- .../export.CommissioningControllerOptions.md | 144 -- .../export.CommissioningServerOptions.md | 100 +- .../export.DevicePairingInformation.md | 15 +- .../interfaces/exports_common.Scanner.md | 71 +- .../exports_interaction.AttributeStatus.md | 4 +- .../exports_protocol.ProtocolHandler.md | 17 +- .../interfaces/exports_session.Session.md | 44 +- .../interfaces/net_export.UdpChannel.md | 6 +- .../net_export.UdpChannelOptions.md | 11 + .../modules/export._internal_.md | 157 +- docs/matter-node.js/modules/export.md | 49 +- .../exports_cluster.ApplicationLauncher.md | 4 +- .../exports_cluster.BasicInformation.md | 2 +- ...s_cluster.BridgedDeviceBasicInformation.md | 2 +- .../modules/exports_cluster.KeypadInput.md | 2 +- .../modules/exports_cluster.LevelControl.md | 4 +- .../exports_cluster.NetworkCommissioning.md | 4 +- ...xports_cluster.ThreadNetworkDiagnostics.md | 4 +- .../modules/exports_cluster.TimeSync.md | 4 +- .../exports_cluster.WiFiNetworkDiagnostics.md | 4 +- .../matter-node.js/modules/exports_cluster.md | 152 +- docs/matter-node.js/modules/exports_common.md | 24 +- docs/matter-node.js/modules/exports_device.md | 67 +- .../modules/exports_protocol.md | 26 +- docs/matter-node.js/modules/exports_schema.md | 16 +- .../modules/exports_securechannel.md | 1 + .../matter-node.js/modules/exports_session.md | 2 +- docs/matter-node.js/modules/util_export.md | 141 +- docs/matter.js/classes/ble_export.Ble.md | 10 +- .../classes/ble_export.BtpSessionHandler.md | 54 +- ...te_export.AttestationCertificateManager.md | 30 +- .../certificate_export.CertificateManager.md | 20 +- ..._export.CertificationDeclarationManager.md | 2 +- ...rtificate_export.RootCertificateManager.md | 18 +- .../classes/cluster_export.AttributeClient.md | 38 +- .../classes/cluster_export.AttributeServer.md | 72 +- .../cluster_export.BaseAttributeServer.md | 26 +- .../classes/cluster_export.CommandServer.md | 18 +- .../classes/cluster_export.EventClient.md | 30 +- .../classes/cluster_export.EventServer.md | 30 +- ...ster_export.FabricScopedAttributeServer.md | 84 +- .../cluster_export.FixedAttributeServer.md | 48 +- .../classes/cluster_export.GroupsManager.md | 12 +- .../classes/cluster_export.ScenesManager.md | 16 +- ...luster_export.SupportedAttributeClient.md} | 70 +- ...=> cluster_export.SupportedEventClient.md} | 56 +- ...er_export.UnknownPresentAttributeClient.md | 336 ---- ..._export.UnknownSupportedAttributeClient.md | 336 ++++ ...ter_export.UnknownSupportedEventClient.md} | 56 +- .../classes/codec_export.BtpCodec.md | 28 +- .../classes/codec_export.DerCodec.md | 26 +- .../classes/codec_export.DnsCodec.md | 34 +- .../classes/codec_export.MessageCodec.md | 18 +- .../classes/common_export.FailSafeManager.md | 42 +- .../classes/common_export.MatterError.md | 2 + .../matter.js/classes/crypto_export.Crypto.md | 64 +- .../classes/crypto_export.Spake2p.md | 32 +- .../classes/device_export.Aggregator.md | 72 +- .../classes/device_export.ComposedDevice.md | 87 +- .../matter.js/classes/device_export.Device.md | 104 +- .../device_export.DimmableLightDevice.md | 136 +- .../device_export.DimmablePluginUnitDevice.md | 136 +- .../classes/device_export.Endpoint.md | 70 +- .../classes/device_export.OnOffBaseDevice.md | 124 +- .../classes/device_export.OnOffLightDevice.md | 124 +- .../device_export.OnOffPluginUnitDevice.md | 124 +- .../classes/device_export.PairedDevice.md | 62 +- .../classes/device_export.PairedNode.md | 634 ++++++ .../classes/device_export.RootEndpoint.md | 160 +- .../classes/export.CommissioningController.md | 503 ++--- .../classes/export.CommissioningServer.md | 241 ++- docs/matter.js/classes/export.MatterNode.md | 217 +-- docs/matter.js/classes/export.MatterServer.md | 128 +- .../classes/export._internal_.Base38Schema.md | 14 +- .../export._internal_.DimmableBaseDevice.md | 138 +- .../classes/export._internal_.EventHandler.md | 16 +- .../classes/export._internal_.GaloisField.md | 18 +- .../export._internal_.InteractionMessenger.md | 18 +- ...port._internal_.ManualPairingCodeSchema.md | 10 +- .../export._internal_.MatterController.md | 368 ++-- .../classes/export._internal_.MatterDevice.md | 278 +-- ...port._internal_.MdnsInstanceBroadcaster.md | 20 +- .../export._internal_.ModelTraversal-1.md | 631 ++++++ .../export._internal_.QrPairingCodeSchema.md | 10 +- .../export._internal_.UdpConnection.md | 14 +- .../matter.js/classes/fabric_export.Fabric.md | 91 +- .../classes/fabric_export.FabricBuilder.md | 54 +- .../classes/fabric_export.FabricManager.md | 53 +- .../log_export.DiagnosticDictionary.md | 8 +- docs/matter.js/classes/log_export.Logger.md | 64 +- .../classes/math_export.ReedSolomon.md | 6 +- .../matter.js/classes/math_export.Verhoeff.md | 8 +- .../classes/mdns_export.MdnsBroadcaster.md | 54 +- .../classes/mdns_export.MdnsScanner.md | 260 ++- .../classes/mdns_export.MdnsServer.md | 40 +- docs/matter.js/classes/model.Access-1.md | 396 ++++ docs/matter.js/classes/model.Aspect.md | 212 +++ .../matter.js/classes/model.AttributeModel.md | 1666 ++++++++++++++++ .../matter.js/classes/model.ClusterModel-1.md | 1051 ++++++++++ docs/matter.js/classes/model.CommandModel.md | 1696 +++++++++++++++++ docs/matter.js/classes/model.Conformance-1.md | 289 +++ docs/matter.js/classes/model.Constraint-1.md | 358 ++++ docs/matter.js/classes/model.DatatypeModel.md | 1618 ++++++++++++++++ .../classes/model.DeviceTypeModel.md | 1009 ++++++++++ docs/matter.js/classes/model.EndpointModel.md | 983 ++++++++++ docs/matter.js/classes/model.EventModel.md | 1636 ++++++++++++++++ docs/matter.js/classes/model.FabricModel.md | 983 ++++++++++ docs/matter.js/classes/model.FeatureSet-1.md | 110 ++ docs/matter.js/classes/model.MatterModel-1.md | 1068 +++++++++++ docs/matter.js/classes/model.Model-1.md | 796 ++++++++ .../classes/model.Model.CrossReference.md | 118 ++ .../classes/model.ModelVariantTraversal.md | 259 +++ docs/matter.js/classes/model.NodeModel.md | 983 ++++++++++ docs/matter.js/classes/model.Quality-1.md | 387 ++++ .../classes/model.RequirementModel.md | 1139 +++++++++++ .../classes/model.ValidateModel.Result.md | 125 ++ docs/matter.js/classes/model.ValueModel.md | 1494 +++++++++++++++ docs/matter.js/classes/net_export.Network.md | 10 +- .../classes/net_export.NetworkFake.md | 16 +- .../classes/net_export.SimulatedNetwork.md | 10 +- .../classes/net_export.UdpChannelFake.md | 20 +- .../classes/net_export.UdpInterface.md | 12 +- .../classes/net_export.UdpMulticastServer.md | 28 +- .../classes/protocol_export.ChannelManager.md | 52 +- .../protocol_export.ControllerCommissioner.md | 134 +- .../protocol_export.ControllerDiscovery.md | 179 ++ .../classes/protocol_export.DiscoveryError.md | 39 + .../protocol_export.ExchangeCounter.md | 4 +- .../protocol_export.ExchangeManager.md | 123 +- .../protocol_export.ExchangeProvider.md | 58 +- .../classes/protocol_export.MessageChannel.md | 33 +- .../classes/protocol_export.MessageCounter.md | 4 +- .../protocol_export.MessageExchange.md | 92 +- .../protocol_export.UnexpectedMessageError.md | 4 +- ...port.IncomingInteractionClientMessenger.md | 20 +- ...ol_interaction_export.InteractionClient.md | 166 +- ...ction_export.InteractionClientMessenger.md | 36 +- ...ion_export.InteractionEndpointStructure.md | 60 +- ...ol_interaction_export.InteractionServer.md | 38 +- ...ction_export.InteractionServerMessenger.md | 24 +- ..._interaction_export.StatusResponseError.md | 6 +- ...l_interaction_export.SubscriptionClient.md | 132 +- ..._interaction_export.SubscriptionHandler.md | 92 +- ...annel_export.ChannelStatusResponseError.md | 6 +- ...rechannel_export.SecureChannelMessenger.md | 26 +- ...urechannel_export.SecureChannelProtocol.md | 65 +- ...export.SecureChannelStatusMessageSchema.md | 10 +- ...t.StatusReportOnlySecureChannelProtocol.md | 116 ++ .../schema_export.BitmapSchemaInternal.md | 16 +- ...ma_export.ByteArrayBitmapSchemaInternal.md | 18 +- .../classes/schema_export.QrCodeSchema.md | 33 +- .../matter.js/classes/schema_export.Schema.md | 10 +- .../classes/session_export.CaseClient.md | 2 +- .../session_export.CaseClientMessenger.md | 30 +- .../classes/session_export.CaseServer.md | 25 +- .../session_export.CaseServerMessenger.md | 32 +- .../classes/session_export.PaseClient.md | 54 +- .../session_export.PaseClientMessenger.md | 34 +- .../classes/session_export.PaseServer.md | 43 +- .../session_export.PaseServerMessenger.md | 34 +- .../classes/session_export.SecureSession.md | 262 ++- .../classes/session_export.SessionManager.md | 140 +- .../classes/session_export.UnsecureSession.md | 65 +- .../classes/storage_export.Storage.md | 52 +- .../storage_export.StorageBackendMemory.md | 68 +- .../classes/storage_export.StorageContext.md | 65 +- .../classes/storage_export.StorageManager.md | 12 +- docs/matter.js/classes/time_export.Time.md | 20 +- .../matter.js/classes/tlv_export.AnySchema.md | 36 +- .../classes/tlv_export.ArraySchema.md | 36 +- .../classes/tlv_export.BooleanSchema.md | 24 +- .../classes/tlv_export.NoArgumentsSchema.md | 24 +- .../classes/tlv_export.NullableSchema.md | 28 +- .../classes/tlv_export.ObjectSchema.md | 32 +- .../classes/tlv_export.StringSchema.md | 34 +- .../classes/tlv_export.TlvArrayReader.md | 10 +- .../classes/tlv_export.TlvArrayWriter.md | 8 +- .../classes/tlv_export.TlvByteArrayReader.md | 8 +- .../classes/tlv_export.TlvByteArrayWriter.md | 8 +- docs/matter.js/classes/tlv_export.TlvCodec.md | 24 +- .../classes/tlv_export.TlvNumberSchema.md | 38 +- .../classes/tlv_export.TlvNumericSchema.md | 38 +- .../matter.js/classes/tlv_export.TlvSchema.md | 24 +- .../classes/tlv_export.TlvWrapper.md | 32 +- .../classes/tlv_export.VoidSchema.md | 24 +- docs/matter.js/classes/util_export.Cache.md | 37 +- .../classes/util_export.DataReader.md | 44 +- .../classes/util_export.DataWriter.md | 32 +- ...Handler.md => util_export.NamedHandler.md} | 30 +- docs/matter.js/classes/util_export.Queue.md | 12 +- ...ccessControl.AccessControlEntryAuthMode.md | 6 +- ...cessControl.AccessControlEntryPrivilege.md | 10 +- ...cluster_export.AccessControl.ChangeType.md | 6 +- .../enums/cluster_export.AccessLevel.md | 8 +- .../cluster_export.Actions.ActionError.md | 4 +- .../cluster_export.Actions.ActionState.md | 8 +- .../cluster_export.Actions.ActionType.md | 14 +- ...cluster_export.Actions.EndpointListType.md | 6 +- ...Commissioning.CommissioningWindowStatus.md | 6 +- ...port.AdministratorCommissioning.Feature.md | 2 +- ...t.AdministratorCommissioning.StatusCode.md | 6 +- ...port.ApplicationBasic.ApplicationStatus.md | 8 +- ...ster_export.ApplicationLauncher.Feature.md | 2 +- ...uster_export.ApplicationLauncher.Status.md | 6 +- .../cluster_export.AudioOutput.Feature.md | 2 +- .../cluster_export.AudioOutput.OutputType.md | 12 +- .../cluster_export.BasicInformation.Color.md | 42 +- ...r_export.BasicInformation.ProductFinish.md | 12 +- ...ort.BridgedDeviceBasicInformation.Color.md | 42 +- ...gedDeviceBasicInformation.ProductFinish.md | 12 +- .../enums/cluster_export.Channel.Feature.md | 4 +- .../cluster_export.Channel.LineupInfoType.md | 2 +- .../enums/cluster_export.Channel.Status.md | 6 +- .../cluster_export.ColorControl.Action.md | 6 +- ...port.ColorControl.ColorControlDirection.md | 8 +- ...port.ColorControl.ColorLoopSetDirection.md | 4 +- .../cluster_export.ColorControl.ColorMode.md | 6 +- ...r_export.ColorControl.DriftCompensation.md | 10 +- ...r_export.ColorControl.EnhancedColorMode.md | 8 +- .../cluster_export.ColorControl.Feature.md | 10 +- .../cluster_export.ColorControl.MoveMode.md | 6 +- .../cluster_export.ColorControl.StepMode.md | 4 +- .../cluster_export.ContentLauncher.Feature.md | 4 +- ...uster_export.ContentLauncher.MetricType.md | 4 +- ...luster_export.ContentLauncher.Parameter.md | 28 +- .../cluster_export.ContentLauncher.Status.md | 6 +- .../cluster_export.DiagnosticLogs.Intent.md | 6 +- .../cluster_export.DiagnosticLogs.Status.md | 10 +- ..._export.DiagnosticLogs.TransferProtocol.md | 4 +- .../cluster_export.DoorLock.AlarmCode.md | 16 +- .../cluster_export.DoorLock.CredentialRule.md | 6 +- .../cluster_export.DoorLock.CredentialType.md | 12 +- ...uster_export.DoorLock.DataOperationType.md | 6 +- .../enums/cluster_export.DoorLock.DlStatus.md | 14 +- .../cluster_export.DoorLock.DoorState.md | 12 +- .../enums/cluster_export.DoorLock.Feature.md | 24 +- .../cluster_export.DoorLock.LockDataType.md | 22 +- ...uster_export.DoorLock.LockOperationType.md | 8 +- .../cluster_export.DoorLock.LockState.md | 6 +- .../enums/cluster_export.DoorLock.LockType.md | 22 +- .../cluster_export.DoorLock.OperatingMode.md | 10 +- .../cluster_export.DoorLock.OperationError.md | 10 +- ...cluster_export.DoorLock.OperationSource.md | 20 +- .../cluster_export.DoorLock.UserStatus.md | 6 +- .../enums/cluster_export.DoorLock.UserType.md | 20 +- ...port.EthernetNetworkDiagnostics.Feature.md | 4 +- ...port.EthernetNetworkDiagnostics.PHYRate.md | 20 +- .../enums/cluster_export.EventPriority.md | 6 +- .../cluster_export.FanControl.FanMode.md | 14 +- ...uster_export.FanControl.FanModeSequence.md | 12 +- .../cluster_export.FanControl.Feature.md | 8 +- ...cluster_export.FaultInjection.FaultType.md | 10 +- ...GeneralCommissioning.CommissioningError.md | 10 +- ...ralCommissioning.RegulatoryLocationType.md | 6 +- ...er_export.GeneralDiagnostics.BootReason.md | 14 +- ...export.GeneralDiagnostics.HardwareFault.md | 22 +- ...export.GeneralDiagnostics.InterfaceType.md | 10 +- ..._export.GeneralDiagnostics.NetworkFault.md | 8 +- ...er_export.GeneralDiagnostics.RadioFault.md | 14 +- ...er_export.GeneralDiagnostics.StatusCode.md | 2 +- ...uster_export.GroupKeyManagement.Feature.md | 2 +- ...upKeyManagement.GroupKeyMulticastPolicy.md | 4 +- ...oupKeyManagement.GroupKeySecurityPolicy.md | 4 +- .../enums/cluster_export.Groups.Feature.md | 2 +- ...luster_export.Identify.EffectIdentifier.md | 12 +- .../cluster_export.Identify.EffectVariant.md | 2 +- .../enums/cluster_export.Identify.Feature.md | 2 +- .../cluster_export.Identify.IdentifyType.md | 12 +- .../cluster_export.KeypadInput.CecKeyCode.md | 172 +- .../cluster_export.KeypadInput.Feature.md | 6 +- .../cluster_export.KeypadInput.Status.md | 6 +- .../cluster_export.LevelControl.Feature.md | 6 +- .../cluster_export.LevelControl.MoveMode.md | 4 +- .../cluster_export.LevelControl.StepMode.md | 4 +- .../cluster_export.MediaInput.Feature.md | 2 +- .../cluster_export.MediaInput.InputType.md | 24 +- .../cluster_export.MediaPlayback.Feature.md | 4 +- ...ster_export.MediaPlayback.PlaybackState.md | 8 +- .../cluster_export.MediaPlayback.Status.md | 12 +- .../cluster_export.ModeSelect.Feature.md | 2 +- ...ter_export.NetworkCommissioning.Feature.md | 6 +- ...ommissioning.NetworkCommissioningStatus.md | 26 +- ...er_export.NetworkCommissioning.WiFiBand.md | 10 +- ...rt.OccupancySensing.OccupancySensorType.md | 8 +- .../enums/cluster_export.OnOff.Feature.md | 2 +- ...ster_export.OnOff.OnOffEffectIdentifier.md | 4 +- .../cluster_export.OnOff.StartUpOnOff.md | 6 +- ....OnOffSwitchConfiguration.SwitchActions.md | 6 +- ...ort.OnOffSwitchConfiguration.SwitchType.md | 6 +- ...ationalCredentials.CertificateChainType.md | 4 +- ...alCredentials.NodeOperationalCertStatus.md | 20 +- ...oftwareUpdateProvider.ApplyUpdateAction.md | 6 +- ...SoftwareUpdateProvider.DownloadProtocol.md | 8 +- ...export.OtaSoftwareUpdateProvider.Status.md | 8 +- ...twareUpdateRequestor.AnnouncementReason.md | 6 +- ...OtaSoftwareUpdateRequestor.ChangeReason.md | 10 +- ....OtaSoftwareUpdateRequestor.UpdateState.md | 18 +- ...export.PowerSource.BatApprovedChemistry.md | 66 +- ...uster_export.PowerSource.BatChargeFault.md | 22 +- ...uster_export.PowerSource.BatChargeLevel.md | 6 +- ...uster_export.PowerSource.BatChargeState.md | 8 +- ...export.PowerSource.BatCommonDesignation.md | 162 +- .../cluster_export.PowerSource.BatFault.md | 6 +- ...er_export.PowerSource.BatReplaceability.md | 8 +- .../cluster_export.PowerSource.Feature.md | 8 +- ...er_export.PowerSource.PowerSourceStatus.md | 8 +- ...ter_export.PowerSource.WiredCurrentType.md | 4 +- .../cluster_export.PowerSource.WiredFault.md | 6 +- ...ster_export.PressureMeasurement.Feature.md | 2 +- ...ter_export.PulseWidthModulation.Feature.md | 6 +- ...er_export.PulseWidthModulation.MoveMode.md | 4 +- ...PumpConfigurationAndControl.ControlMode.md | 12 +- ...ort.PumpConfigurationAndControl.Feature.md | 14 +- ...mpConfigurationAndControl.OperationMode.md | 8 +- .../enums/cluster_export.Scenes.Feature.md | 2 +- ...ster_export.SoftwareDiagnostics.Feature.md | 2 +- .../enums/cluster_export.Switch.Feature.md | 10 +- .../cluster_export.TargetNavigator.Status.md | 6 +- ...ster_export.Thermostat.AcCapacityFormat.md | 2 +- ...ster_export.Thermostat.AcCompressorType.md | 8 +- ...ster_export.Thermostat.AcLouverPosition.md | 10 +- ...ter_export.Thermostat.AcRefrigerantType.md | 8 +- .../enums/cluster_export.Thermostat.AcType.md | 10 +- ...t.Thermostat.ControlSequenceOfOperation.md | 12 +- .../cluster_export.Thermostat.Feature.md | 14 +- ...er_export.Thermostat.SetpointAdjustMode.md | 6 +- ..._export.Thermostat.SetpointChangeSource.md | 6 +- .../cluster_export.Thermostat.StartOfWeek.md | 14 +- .../cluster_export.Thermostat.SystemMode.md | 18 +- ...port.Thermostat.TemperatureSetpointHold.md | 4 +- ...export.Thermostat.ThermostatRunningMode.md | 6 +- ...serInterfaceConfiguration.KeypadLockout.md | 12 +- ...iguration.ScheduleProgrammingVisibility.md | 4 +- ...aceConfiguration.TemperatureDisplayMode.md | 4 +- ...readNetworkDiagnostics.ConnectionStatus.md | 4 +- ...export.ThreadNetworkDiagnostics.Feature.md | 8 +- ...t.ThreadNetworkDiagnostics.NetworkFault.md | 8 +- ...rt.ThreadNetworkDiagnostics.RoutingRole.md | 14 +- ...ort.TimeFormatLocalization.CalendarType.md | 24 +- ...r_export.TimeFormatLocalization.Feature.md | 2 +- ...xport.TimeFormatLocalization.HourFormat.md | 4 +- .../enums/cluster_export.TimeSync.Feature.md | 6 +- .../cluster_export.TimeSync.Granularity.md | 10 +- .../cluster_export.TimeSync.StatusCode.md | 2 +- .../cluster_export.TimeSync.TimeSource.md | 34 +- ...cluster_export.UnitLocalization.Feature.md | 2 +- ...luster_export.UnitLocalization.TempUnit.md | 6 +- ...workDiagnostics.AssociationFailureCause.md | 8 +- ...WiFiNetworkDiagnostics.ConnectionStatus.md | 4 +- ...r_export.WiFiNetworkDiagnostics.Feature.md | 4 +- ...ort.WiFiNetworkDiagnostics.SecurityType.md | 12 +- ...port.WiFiNetworkDiagnostics.WiFiVersion.md | 12 +- ...er_export.WindowCovering.EndProductType.md | 50 +- .../cluster_export.WindowCovering.Feature.md | 10 +- ...er_export.WindowCovering.MovementStatus.md | 6 +- ...xport.WindowCovering.WindowCoveringType.md | 22 +- .../enums/codec_export.BtpHeaderBits.md | 12 +- .../matter.js/enums/codec_export.BtpOpcode.md | 2 +- docs/matter.js/enums/codec_export.DerType.md | 18 +- .../enums/codec_export.DnsMessageType.md | 8 +- .../enums/codec_export.DnsRecordClass.md | 4 +- .../enums/codec_export.DnsRecordType.md | 14 +- .../enums/codec_export.SessionType.md | 4 +- .../enums/crypto_export.CurveType.md | 6 +- docs/matter.js/enums/crypto_export.KeyType.md | 6 +- .../enums/device_export.DeviceClasses.md | 22 +- .../device_export.NodeStateInformation.md | 78 + ...._internal_.CommissioningStepResultCode.md | 8 +- .../enums/export._internal_.TagControl.md | 16 +- docs/matter.js/enums/log_export.Format.md | 6 +- docs/matter.js/enums/log_export.Level.md | 10 +- .../enums/mdns_export.AnnouncementType.md | 4 +- docs/matter.js/enums/model.Access.Fabric.md | 51 + .../matter.js/enums/model.Access.Privilege.md | 64 + .../enums/model.Access.PrivilegeName.md | 56 + docs/matter.js/enums/model.Access.Rw.md | 64 + docs/matter.js/enums/model.Access.Timed.md | 25 + .../model.ClusterElement.Classification.md | 43 + .../enums/model.CommandElement.Direction.md | 34 + .../matter.js/enums/model.Conformance.Flag.md | 65 + .../enums/model.Conformance.Operator.md | 131 ++ .../enums/model.Conformance.Special.md | 87 + .../model.DeviceTypeElement.Classification.md | 65 + docs/matter.js/enums/model.ElementTag.md | 135 ++ .../enums/model.EventElement.Priority.md | 45 + .../enums/model.EventElement.PriorityId.md | 45 + docs/matter.js/enums/model.Metatype-1.md | 133 ++ docs/matter.js/enums/model.Quality.Field.md | 89 + docs/matter.js/enums/model.Quality.Flag.md | 89 + .../model.RequirementElement.ElementType.md | 87 + docs/matter.js/enums/model.Specification-1.md | 45 + .../enums/model.Specification.Names.md | 45 + docs/matter.js/enums/model.StatusCode.md | 300 +++ .../enums/model.ValueElement.Metatype.md | 34 + ...protocol_interaction_export.MessageType.md | 20 +- .../protocol_interaction_export.StatusCode.md | 54 +- ..._securechannel_export.GeneralStatusCode.md | 34 +- ...otocol_securechannel_export.MessageType.md | 22 +- ...securechannel_export.ProtocolStatusCode.md | 10 +- .../schema_export.CommissionningFlowType.md | 6 +- docs/matter.js/enums/tlv_export.TlvLength.md | 8 +- docs/matter.js/enums/tlv_export.TlvType.md | 22 +- docs/matter.js/enums/util_export.Endian.md | 4 +- ...ate_export.DeviceAttestationCertificate.md | 22 +- ....ProductAttestationAuthorityCertificate.md | 22 +- ...oductAttestationIntermediateCertificate.md | 22 +- .../interfaces/cluster_export.Attribute.md | 34 +- .../interfaces/cluster_export.Cluster.md | 18 +- .../cluster_export.ClusterFactory.Cluster.md | 18 +- ...r_export.ClusterFactory.ClusterElements.md | 6 +- ...cluster_export.ClusterFactory.Component.md | 6 +- ...luster_export.ClusterFactory.Extensible.md | 20 +- .../cluster_export.ClusterFactory.Features.md | 6 +- .../cluster_export.ClusterFactory.Identity.md | 6 +- ...er_export.ClusterFactory.TypedComponent.md | 6 +- .../interfaces/cluster_export.Command.md | 20 +- .../cluster_export.ConditionalAttribute.md | 34 +- .../cluster_export.ConditionalCommand.md | 20 +- .../cluster_export.ConditionalEvent.md | 18 +- ...luster_export.ConditionalFixedAttribute.md | 34 +- ...ter_export.ConditionalWritableAttribute.md | 34 +- ...onditionalWritableFabricScopedAttribute.md | 34 +- .../interfaces/cluster_export.Event.md | 18 +- .../cluster_export.FabricScopedAttribute.md | 34 +- .../cluster_export.FixedAttribute.md | 34 +- ...export.OperationalCredentialsServerConf.md | 8 +- .../cluster_export.OptionalAttribute.md | 34 +- .../cluster_export.OptionalCommand.md | 20 +- .../cluster_export.OptionalEvent.md | 18 +- .../cluster_export.OptionalFixedAttribute.md | 34 +- ...luster_export.OptionalWritableAttribute.md | 34 +- ...t.OptionalWritableFabricScopedAttribute.md | 34 +- .../cluster_export.UnknownAttribute.md | 34 +- .../interfaces/cluster_export.UnknownEvent.md | 18 +- .../cluster_export.WritableAttribute.md | 34 +- ...er_export.WritableFabricScopedAttribute.md | 34 +- .../cluster_export.WritableFixedAttribute.md | 34 +- .../codec_export.BtpHandshakeRequest.md | 6 +- .../codec_export.BtpHandshakeResponse.md | 6 +- .../interfaces/codec_export.BtpHeader.md | 12 +- .../interfaces/codec_export.BtpPacket.md | 4 +- .../codec_export.BtpPacketPayload.md | 8 +- .../codec_export.DecodedBtpPacket.md | 4 +- .../codec_export.DecodedBtpPacketPayload.md | 8 +- .../interfaces/codec_export.Message.md | 6 +- .../interfaces/codec_export.Packet.md | 4 +- .../interfaces/codec_export.PacketHeader.md | 18 +- .../interfaces/codec_export.PayloadHeader.md | 12 +- .../interfaces/common_export.Channel.md | 6 +- .../common_export.InstanceBroadcaster.md | 14 +- .../interfaces/common_export.Listener.md | 2 +- .../interfaces/common_export.Scanner.md | 71 +- .../common_export.TransportInterface.md | 4 +- .../matter.js/interfaces/crypto_export.Key.md | 70 +- .../crypto_export.PbkdfParameters.md | 4 +- .../interfaces/crypto_export.PrivateKey.md | 70 +- .../interfaces/crypto_export.PublicKey.md | 70 +- .../interfaces/crypto_export.SymmetricKey.md | 70 +- .../device_export.DeviceTypeDefinition.md | 20 +- .../device_export.EndpointOptions.md | 4 +- .../export.CommissioningControllerOptions.md | 144 -- .../export.CommissioningServerOptions.md | 100 +- .../export.DevicePairingInformation.md | 15 +- .../export._internal_.AttributeOptions.md | 14 +- ...internal_.AttributePathWithValueVersion.md | 8 +- .../export._internal_.CachedAttributeInfo.md | 4 +- .../export._internal_.CachedCommandInfo.md | 4 +- .../export._internal_.CachedEventInfo.md | 4 +- .../export._internal_.CommandOptions.md | 4 +- ...._internal_.ConditionalAttributeOptions.md | 18 +- ...rt._internal_.ConditionalCommandOptions.md | 8 +- ...port._internal_.ConditionalEventOptions.md | 6 +- .../interfaces/export._internal_.EventData.md | 12 +- .../export._internal_.EventOptions.md | 2 +- ...xport._internal_.EventPathWithEventData.md | 6 +- .../export._internal_.EventStorageData.md | 14 +- .../export._internal_.MrpParameters.md | 6 +- ...xport._internal_.RecordValidationResult.md | 34 + .../export._internal_.RecordValidator.md | 48 + .../export._internal_.scenesTableEntry.md | 12 +- .../interfaces/model.VariantDetail.md | 65 + .../interfaces/net_export.NetInterface.md | 6 +- .../interfaces/net_export.UdpChannel.md | 6 +- .../net_export.UdpChannelOptions.md | 19 +- .../net_export.UdpMulticastServerOptions.md | 8 +- .../protocol_export.ProtocolHandler.md | 21 +- ...otocol_interaction_export.AttributePath.md | 6 +- ...ocol_interaction_export.AttributeStatus.md | 4 +- ...ol_interaction_export.AttributeWithPath.md | 4 +- ...protocol_interaction_export.CommandPath.md | 6 +- ...ocol_interaction_export.CommandWithPath.md | 4 +- .../protocol_interaction_export.EventPath.md | 6 +- ...otocol_interaction_export.EventWithPath.md | 4 +- .../session_export.ResumptionRecord.md | 8 +- .../interfaces/session_export.Session.md | 46 +- .../matter.js/interfaces/time_export.Timer.md | 6 +- .../interfaces/tlv_export.FieldType.md | 8 +- .../tlv_export.OptionalFieldType.md | 8 +- .../interfaces/tlv_export.TlvReader.md | 4 +- .../interfaces/tlv_export.TlvWriter.md | 4 +- .../interfaces/util_export.Stream.md | 4 +- docs/matter.js/modules.md | 1 + docs/matter.js/modules/ble_export.md | 22 +- docs/matter.js/modules/certificate_export.md | 48 +- .../modules/cluster_export.AccessControl.md | 12 +- .../modules/cluster_export.AccountLogin.md | 8 +- .../modules/cluster_export.Actions.md | 36 +- ...uster_export.AdministratorCommissioning.md | 14 +- .../cluster_export.ApplicationBasic.md | 4 +- .../cluster_export.ApplicationLauncher.md | 22 +- .../modules/cluster_export.AudioOutput.md | 16 +- .../cluster_export.BallastConfiguration.md | 6 +- .../modules/cluster_export.BarrierControl.md | 4 +- .../cluster_export.BasicInformation.md | 14 +- .../cluster_export.BinaryInputBasic.md | 2 +- .../modules/cluster_export.Binding.md | 4 +- .../modules/cluster_export.BooleanState.md | 4 +- ...er_export.BridgedDeviceBasicInformation.md | 10 +- .../modules/cluster_export.Channel.md | 26 +- .../cluster_export.ClientMonitoring.md | 8 +- .../modules/cluster_export.ClusterFactory.md | 42 +- .../modules/cluster_export.ColorControl.md | 64 +- .../modules/cluster_export.ContentLauncher.md | 34 +- .../modules/cluster_export.Descriptor.md | 4 +- .../modules/cluster_export.DiagnosticLogs.md | 6 +- .../modules/cluster_export.DoorLock.md | 128 +- .../cluster_export.ElectricalMeasurement.md | 4 +- ...uster_export.EthernetNetworkDiagnostics.md | 14 +- .../modules/cluster_export.FanControl.md | 22 +- .../modules/cluster_export.FaultInjection.md | 6 +- .../modules/cluster_export.FixedLabel.md | 2 +- .../modules/cluster_export.FlowMeasurement.md | 2 +- .../cluster_export.GeneralCommissioning.md | 14 +- .../cluster_export.GeneralDiagnostics.md | 14 +- .../cluster_export.GroupKeyManagement.md | 22 +- .../modules/cluster_export.Groups.md | 26 +- .../modules/cluster_export.Identify.md | 16 +- .../cluster_export.IlluminanceMeasurement.md | 2 +- .../modules/cluster_export.KeypadInput.md | 10 +- .../cluster_export.LeafWetnessMeasurement.md | 2 +- .../modules/cluster_export.LevelControl.md | 32 +- ...luster_export.LocalizationConfiguration.md | 2 +- .../modules/cluster_export.LowPower.md | 2 +- .../modules/cluster_export.MediaInput.md | 16 +- .../modules/cluster_export.MediaPlayback.md | 22 +- .../modules/cluster_export.ModeSelect.md | 16 +- .../cluster_export.NetworkCommissioning.md | 40 +- .../cluster_export.OccupancySensing.md | 6 +- .../matter.js/modules/cluster_export.OnOff.md | 16 +- ...cluster_export.OnOffSwitchConfiguration.md | 2 +- .../cluster_export.OperationalCredentials.md | 30 +- ...luster_export.OtaSoftwareUpdateProvider.md | 12 +- ...uster_export.OtaSoftwareUpdateRequestor.md | 12 +- .../modules/cluster_export.PowerSource.md | 22 +- ...cluster_export.PowerSourceConfiguration.md | 2 +- .../cluster_export.PressureMeasurement.md | 10 +- .../cluster_export.ProxyConfiguration.md | 4 +- .../modules/cluster_export.ProxyDiscovery.md | 2 +- .../cluster_export.PulseWidthModulation.md | 24 +- ...ster_export.PumpConfigurationAndControl.md | 22 +- ...ster_export.RelativeHumidityMeasurement.md | 2 +- .../modules/cluster_export.Scenes.md | 44 +- .../cluster_export.SoftwareDiagnostics.md | 14 +- .../cluster_export.SoilMoistureMeasurement.md | 2 +- .../modules/cluster_export.Switch.md | 32 +- .../modules/cluster_export.TargetNavigator.md | 8 +- .../cluster_export.TemperatureMeasurement.md | 2 +- .../modules/cluster_export.Thermostat.md | 54 +- ...rt.ThermostatUserInterfaceConfiguration.md | 2 +- ...cluster_export.ThreadNetworkDiagnostics.md | 26 +- .../cluster_export.TimeFormatLocalization.md | 10 +- .../modules/cluster_export.TimeSync.md | 22 +- .../cluster_export.UnitLocalization.md | 10 +- .../modules/cluster_export.UserLabel.md | 2 +- .../modules/cluster_export.ValidProxies.md | 4 +- .../modules/cluster_export.WakeOnLan.md | 2 +- .../cluster_export.WiFiNetworkDiagnostics.md | 18 +- .../modules/cluster_export.WindowCovering.md | 40 +- docs/matter.js/modules/cluster_export.md | 800 ++++---- docs/matter.js/modules/codec_export.Base64.md | 4 +- docs/matter.js/modules/codec_export.md | 68 +- docs/matter.js/modules/common_export.md | 46 +- docs/matter.js/modules/crypto_export.md | 48 +- .../modules/datatype_export.FabricIndex.md | 4 +- .../modules/datatype_export.NodeId.md | 6 +- docs/matter.js/modules/datatype_export.md | 96 +- docs/matter.js/modules/device_export.md | 79 +- .../export._internal_.ModelTraversal.md | 21 + docs/matter.js/modules/export._internal_.md | 308 +-- docs/matter.js/modules/export.md | 51 +- docs/matter.js/modules/fabric_export.md | 2 +- .../modules/log_export.consoleLogger.md | 2 +- docs/matter.js/modules/log_export.md | 2 +- docs/matter.js/modules/mdns_export.md | 30 +- docs/matter.js/modules/model.Access.md | 330 ++++ .../modules/model.AttributeElement.md | 50 + docs/matter.js/modules/model.BaseElement.md | 46 + .../matter.js/modules/model.ClusterElement.md | 65 + docs/matter.js/modules/model.ClusterModel.md | 21 + .../matter.js/modules/model.CommandElement.md | 54 + .../modules/model.Conformance.Ast.md | 103 + docs/matter.js/modules/model.Conformance.md | 401 ++++ docs/matter.js/modules/model.Constraint.md | 106 ++ .../modules/model.DatatypeElement.md | 116 ++ .../modules/model.DeviceTypeElement.md | 54 + .../modules/model.EndpointElement.md | 50 + docs/matter.js/modules/model.EventElement.md | 55 + docs/matter.js/modules/model.FabricElement.md | 50 + docs/matter.js/modules/model.FeatureSet.md | 43 + docs/matter.js/modules/model.FieldValue.md | 454 +++++ docs/matter.js/modules/model.MatterElement.md | 61 + docs/matter.js/modules/model.MatterModel.md | 21 + docs/matter.js/modules/model.MergeModels.md | 46 + docs/matter.js/modules/model.Metatype.md | 98 + docs/matter.js/modules/model.Model.md | 79 + docs/matter.js/modules/model.NodeElement.md | 50 + docs/matter.js/modules/model.Quality.md | 142 ++ .../modules/model.RequirementElement.md | 54 + docs/matter.js/modules/model.Specification.md | 34 + docs/matter.js/modules/model.ValidateModel.md | 11 + docs/matter.js/modules/model.ValueElement.md | 71 + docs/matter.js/modules/model.md | 1414 ++++++++++++++ docs/matter.js/modules/net_export.md | 6 +- docs/matter.js/modules/protocol_export.md | 28 +- .../modules/protocol_interaction_export.md | 136 +- .../modules/protocol_securechannel_export.md | 7 +- docs/matter.js/modules/schema_export.md | 58 +- docs/matter.js/modules/session_export.md | 62 +- docs/matter.js/modules/storage_export.md | 6 +- docs/matter.js/modules/time_export.md | 2 +- docs/matter.js/modules/tlv_export.md | 94 +- docs/matter.js/modules/util_export.md | 233 ++- .../modules/util_export.serialize.md | 6 +- lerna.json | 2 +- models/package.json | 6 +- package-lock.json | 56 +- packages/matter-node-ble.js/package.json | 6 +- packages/matter-node-shell.js/package.json | 8 +- packages/matter-node.js-examples/package.json | 8 +- packages/matter-node.js/package.json | 6 +- packages/matter.js-tools/package.json | 2 +- packages/matter.js/package.json | 4 +- 829 files changed, 43071 insertions(+), 11062 deletions(-) create mode 100644 docs/matter-node-ble.js/classes/internal_.MdnsScanner.md create mode 100644 docs/matter-node-ble.js/classes/internal_.UdpMulticastServer.md rename docs/matter-node-ble.js/classes/{internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md => internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md} (79%) create mode 100644 docs/matter-node-ble.js/enums/internal_.NodeStateInformation.md create mode 100644 docs/matter-node-ble.js/interfaces/internal_.UdpMulticastServerOptions.md rename docs/matter-node-ble.js/modules/{internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md => internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md} (76%) rename docs/matter-node.js/classes/{exports_cluster.PresentAttributeClient.md => exports_cluster.SupportedAttributeClient.md} (82%) rename docs/matter-node.js/classes/{exports_cluster.PresentEventClient.md => exports_cluster.SupportedEventClient.md} (82%) rename docs/matter-node.js/classes/{exports_cluster.UnknownPresentAttributeClient.md => exports_cluster.UnknownSupportedAttributeClient.md} (60%) rename docs/matter-node.js/classes/{exports_cluster.UnknownPresentEventClient.md => exports_cluster.UnknownSupportedEventClient.md} (81%) create mode 100644 docs/matter-node.js/classes/exports_device.PairedNode.md create mode 100644 docs/matter-node.js/classes/exports_protocol.ControllerDiscovery.md create mode 100644 docs/matter-node.js/classes/exports_protocol.DiscoveryError.md create mode 100644 docs/matter-node.js/classes/exports_securechannel.StatusReportOnlySecureChannelProtocol.md rename docs/matter-node.js/classes/{export._internal_.NamedHandler.md => util_export.NamedHandler.md} (76%) create mode 100644 docs/matter-node.js/enums/exports_device.NodeStateInformation.md delete mode 100644 docs/matter-node.js/interfaces/export.CommissioningControllerOptions.md rename docs/matter.js/classes/{cluster_export.PresentAttributeClient.md => cluster_export.SupportedAttributeClient.md} (60%) rename docs/matter.js/classes/{cluster_export.PresentEventClient.md => cluster_export.SupportedEventClient.md} (61%) delete mode 100644 docs/matter.js/classes/cluster_export.UnknownPresentAttributeClient.md create mode 100644 docs/matter.js/classes/cluster_export.UnknownSupportedAttributeClient.md rename docs/matter.js/classes/{cluster_export.UnknownPresentEventClient.md => cluster_export.UnknownSupportedEventClient.md} (59%) create mode 100644 docs/matter.js/classes/device_export.PairedNode.md create mode 100644 docs/matter.js/classes/export._internal_.ModelTraversal-1.md create mode 100644 docs/matter.js/classes/model.Access-1.md create mode 100644 docs/matter.js/classes/model.Aspect.md create mode 100644 docs/matter.js/classes/model.AttributeModel.md create mode 100644 docs/matter.js/classes/model.ClusterModel-1.md create mode 100644 docs/matter.js/classes/model.CommandModel.md create mode 100644 docs/matter.js/classes/model.Conformance-1.md create mode 100644 docs/matter.js/classes/model.Constraint-1.md create mode 100644 docs/matter.js/classes/model.DatatypeModel.md create mode 100644 docs/matter.js/classes/model.DeviceTypeModel.md create mode 100644 docs/matter.js/classes/model.EndpointModel.md create mode 100644 docs/matter.js/classes/model.EventModel.md create mode 100644 docs/matter.js/classes/model.FabricModel.md create mode 100644 docs/matter.js/classes/model.FeatureSet-1.md create mode 100644 docs/matter.js/classes/model.MatterModel-1.md create mode 100644 docs/matter.js/classes/model.Model-1.md create mode 100644 docs/matter.js/classes/model.Model.CrossReference.md create mode 100644 docs/matter.js/classes/model.ModelVariantTraversal.md create mode 100644 docs/matter.js/classes/model.NodeModel.md create mode 100644 docs/matter.js/classes/model.Quality-1.md create mode 100644 docs/matter.js/classes/model.RequirementModel.md create mode 100644 docs/matter.js/classes/model.ValidateModel.Result.md create mode 100644 docs/matter.js/classes/model.ValueModel.md create mode 100644 docs/matter.js/classes/protocol_export.ControllerDiscovery.md create mode 100644 docs/matter.js/classes/protocol_export.DiscoveryError.md create mode 100644 docs/matter.js/classes/protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md rename docs/matter.js/classes/{export._internal_.NamedHandler.md => util_export.NamedHandler.md} (60%) create mode 100644 docs/matter.js/enums/device_export.NodeStateInformation.md create mode 100644 docs/matter.js/enums/model.Access.Fabric.md create mode 100644 docs/matter.js/enums/model.Access.Privilege.md create mode 100644 docs/matter.js/enums/model.Access.PrivilegeName.md create mode 100644 docs/matter.js/enums/model.Access.Rw.md create mode 100644 docs/matter.js/enums/model.Access.Timed.md create mode 100644 docs/matter.js/enums/model.ClusterElement.Classification.md create mode 100644 docs/matter.js/enums/model.CommandElement.Direction.md create mode 100644 docs/matter.js/enums/model.Conformance.Flag.md create mode 100644 docs/matter.js/enums/model.Conformance.Operator.md create mode 100644 docs/matter.js/enums/model.Conformance.Special.md create mode 100644 docs/matter.js/enums/model.DeviceTypeElement.Classification.md create mode 100644 docs/matter.js/enums/model.ElementTag.md create mode 100644 docs/matter.js/enums/model.EventElement.Priority.md create mode 100644 docs/matter.js/enums/model.EventElement.PriorityId.md create mode 100644 docs/matter.js/enums/model.Metatype-1.md create mode 100644 docs/matter.js/enums/model.Quality.Field.md create mode 100644 docs/matter.js/enums/model.Quality.Flag.md create mode 100644 docs/matter.js/enums/model.RequirementElement.ElementType.md create mode 100644 docs/matter.js/enums/model.Specification-1.md create mode 100644 docs/matter.js/enums/model.Specification.Names.md create mode 100644 docs/matter.js/enums/model.StatusCode.md create mode 100644 docs/matter.js/enums/model.ValueElement.Metatype.md delete mode 100644 docs/matter.js/interfaces/export.CommissioningControllerOptions.md create mode 100644 docs/matter.js/interfaces/export._internal_.RecordValidationResult.md create mode 100644 docs/matter.js/interfaces/export._internal_.RecordValidator.md create mode 100644 docs/matter.js/interfaces/model.VariantDetail.md create mode 100644 docs/matter.js/modules/export._internal_.ModelTraversal.md create mode 100644 docs/matter.js/modules/model.Access.md create mode 100644 docs/matter.js/modules/model.AttributeElement.md create mode 100644 docs/matter.js/modules/model.BaseElement.md create mode 100644 docs/matter.js/modules/model.ClusterElement.md create mode 100644 docs/matter.js/modules/model.ClusterModel.md create mode 100644 docs/matter.js/modules/model.CommandElement.md create mode 100644 docs/matter.js/modules/model.Conformance.Ast.md create mode 100644 docs/matter.js/modules/model.Conformance.md create mode 100644 docs/matter.js/modules/model.Constraint.md create mode 100644 docs/matter.js/modules/model.DatatypeElement.md create mode 100644 docs/matter.js/modules/model.DeviceTypeElement.md create mode 100644 docs/matter.js/modules/model.EndpointElement.md create mode 100644 docs/matter.js/modules/model.EventElement.md create mode 100644 docs/matter.js/modules/model.FabricElement.md create mode 100644 docs/matter.js/modules/model.FeatureSet.md create mode 100644 docs/matter.js/modules/model.FieldValue.md create mode 100644 docs/matter.js/modules/model.MatterElement.md create mode 100644 docs/matter.js/modules/model.MatterModel.md create mode 100644 docs/matter.js/modules/model.MergeModels.md create mode 100644 docs/matter.js/modules/model.Metatype.md create mode 100644 docs/matter.js/modules/model.Model.md create mode 100644 docs/matter.js/modules/model.NodeElement.md create mode 100644 docs/matter.js/modules/model.Quality.md create mode 100644 docs/matter.js/modules/model.RequirementElement.md create mode 100644 docs/matter.js/modules/model.Specification.md create mode 100644 docs/matter.js/modules/model.ValidateModel.md create mode 100644 docs/matter.js/modules/model.ValueElement.md create mode 100644 docs/matter.js/modules/model.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b4deb71c2..94d52cd85e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ The main work (all changes without a GitHub username in brackets in the below li ## __WORK IN PROGRESS__ --> -## __WORK IN PROGRESS__ +## 0.7.0 (2023-11-13) * General * Breaking: Changed ES target from ES5 to ES2018 (affected environments probably already didn't support matter.js) * Feature (vilic): Added project references and additional tsconfigs to support standard tsc development workflows diff --git a/chip-testing/package.json b/chip-testing/package.json index 4a7b0cbbd4..f94b9307eb 100644 --- a/chip-testing/package.json +++ b/chip-testing/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter.js-chip-testing", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "Testing of matter.js with CHIP tool", "private": true, "license": "Apache-2.0", @@ -20,8 +20,8 @@ "test-chip": "matter-test --force-exit" }, "dependencies": { - "@project-chip/matter-node.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter-node.js": "0.7.0", + "@project-chip/matter.js": "0.7.0", + "@project-chip/matter.js-tools": "0.7.0" } } diff --git a/codegen/package.json b/codegen/package.json index a1bd6d70dc..d361a677f7 100644 --- a/codegen/package.json +++ b/codegen/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter.js-codegen", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "Matter.js tooling", "private": true, "type": "module", @@ -27,11 +27,11 @@ }, "homepage": "https://github.com/project-chip/matter.js#readme", "dependencies": { - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js-intermediate-models": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter.js": "0.7.0", + "@project-chip/matter.js-intermediate-models": "0.7.0" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "@types/jsdom": "^21.1.4", "jsdom": "^22.1.0", "typescript": "^5.2.2", diff --git a/docs/matter-node-ble.js/classes/BleBroadcaster.md b/docs/matter-node-ble.js/classes/BleBroadcaster.md index f7e6af82f3..b136421e4c 100644 --- a/docs/matter-node-ble.js/classes/BleBroadcaster.md +++ b/docs/matter-node-ble.js/classes/BleBroadcaster.md @@ -49,7 +49,7 @@ Interface for classes that allow to announce one Matter instance. #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:26 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L26) ## Properties @@ -59,7 +59,7 @@ matter-node-ble.js/src/ble/BleBroadcaster.ts:26 #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:28 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L28) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:24 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L24) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:27 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L27) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:23 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L23) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:22 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L22) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:21 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L21) ## Methods @@ -129,7 +129,7 @@ Send out announcements for this instance. #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:65 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L65) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:102 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L102) ___ @@ -163,7 +163,7 @@ Expire all announcements. #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:98 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L98) ___ @@ -183,7 +183,7 @@ Expire the announcement for this commissioning instance. #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:90 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L90) ___ @@ -203,7 +203,7 @@ Expire the announcement for this operative instance. #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:94 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L94) ___ @@ -230,7 +230,7 @@ Set a commissionable mode and details to announce a commissionable device. #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:31 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L31) ___ @@ -256,7 +256,7 @@ Set commissioner details to announce a commissioner service for User directed co #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:60 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L60) ___ @@ -277,4 +277,4 @@ Use expireCommissioningAnnouncements = true when Fabrics are changed after a n c #### Defined in -matter-node-ble.js/src/ble/BleBroadcaster.ts:53 +[matter-node-ble.js/src/ble/BleBroadcaster.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleBroadcaster.ts#L53) diff --git a/docs/matter-node-ble.js/classes/BleNode.md b/docs/matter-node-ble.js/classes/BleNode.md index 4c7502b7ea..3cff28c0e2 100644 --- a/docs/matter-node-ble.js/classes/BleNode.md +++ b/docs/matter-node-ble.js/classes/BleNode.md @@ -46,7 +46,7 @@ #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:26 +[matter-node-ble.js/src/ble/BleNode.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L26) ## Properties @@ -56,7 +56,7 @@ matter-node-ble.js/src/ble/BleNode.ts:26 #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:24 +[matter-node-ble.js/src/ble/BleNode.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L24) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:23 +[matter-node-ble.js/src/ble/BleNode.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L23) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:26 +[matter-node-ble.js/src/ble/BleNode.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L26) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/Ble.d.ts:15 +matter.js/dist/esm/ble/Ble.d.ts:15 ## Methods @@ -122,7 +122,7 @@ matter.js/dist/cjs/ble/Ble.d.ts:15 #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:44 +[matter-node-ble.js/src/ble/BleNode.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L44) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:37 +[matter-node-ble.js/src/ble/BleNode.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L37) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:30 +[matter-node-ble.js/src/ble/BleNode.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L30) ___ @@ -176,4 +176,4 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:51 +[matter-node-ble.js/src/ble/BleNode.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L51) diff --git a/docs/matter-node-ble.js/classes/BleScanner.md b/docs/matter-node-ble.js/classes/BleScanner.md index 513684a711..37f74dca15 100644 --- a/docs/matter-node-ble.js/classes/BleScanner.md +++ b/docs/matter-node-ble.js/classes/BleScanner.md @@ -21,8 +21,10 @@ ### Methods - [buildCommissionableQueryIdentifier](BleScanner.md#buildcommissionablequeryidentifier) +- [cancelCommissionableDeviceDiscovery](BleScanner.md#cancelcommissionabledevicediscovery) - [close](BleScanner.md#close) - [findCommissionableDevices](BleScanner.md#findcommissionabledevices) +- [findCommissionableDevicesContinuously](BleScanner.md#findcommissionabledevicescontinuously) - [findCommissionableQueryIdentifier](BleScanner.md#findcommissionablequeryidentifier) - [findOperationalDevice](BleScanner.md#findoperationaldevice) - [finishWaiter](BleScanner.md#finishwaiter) @@ -47,7 +49,7 @@ #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:38 +[matter-node-ble.js/src/ble/BleScanner.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L45) ## Properties @@ -57,7 +59,7 @@ matter-node-ble.js/src/ble/BleScanner.ts:38 #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:36 +[matter-node-ble.js/src/ble/BleScanner.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L43) ___ @@ -67,17 +69,17 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:38 +[matter-node-ble.js/src/ble/BleScanner.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L45) ___ ### recordWaiters -• `Private` `Readonly` **recordWaiters**: `Map`<`string`, { `resolver`: () => `void` ; `timer`: [`Timer`](../interfaces/internal_.Timer.md) }\> +• `Private` `Readonly` **recordWaiters**: `Map`<`string`, { `resolveOnUpdatedRecords`: `boolean` ; `resolver`: () => `void` ; `timer`: [`Timer`](../interfaces/internal_.Timer.md) }\> #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:35 +[matter-node-ble.js/src/ble/BleScanner.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L35) ## Methods @@ -100,7 +102,34 @@ Some identifiers are identical to the official DNS-SD identifiers, others are cu #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:150 +[matter-node-ble.js/src/ble/BleScanner.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L170) + +___ + +### cancelCommissionableDeviceDiscovery + +▸ **cancelCommissionableDeviceDiscovery**(`identifier`): `void` + +Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would +be over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[cancelCommissionableDeviceDiscovery](../interfaces/internal_.Scanner.md#cancelcommissionabledevicediscovery) + +#### Defined in + +[matter-node-ble.js/src/ble/BleScanner.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L92) ___ @@ -120,7 +149,7 @@ Close the scanner server and free resources. #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:224 +[matter-node-ble.js/src/ble/BleScanner.ts:272](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L272) ___ @@ -128,8 +157,8 @@ ___ ▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> -Send DNS-SD queries to discover commissionable devices by an provided identifier (e.g. discriminator, -vendorId, etc.) and return them. +Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, +vendorId, etc.) and returns as soon as minimum one was found or the timeout is over. #### Parameters @@ -148,7 +177,37 @@ vendorId, etc.) and return them. #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:201 +[matter-node-ble.js/src/ble/BleScanner.ts:221](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L221) + +___ + +### findCommissionableDevicesContinuously + +▸ **findCommissionableDevicesContinuously**(`identifier`, `callback`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> + +Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, +vendorId, etc.) and returns after the timeout is over. For each new discovered device the provided callback is +called when it is discovered. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | `undefined` | +| `callback` | (`device`: [`CommissionableDevice`](../modules/internal_.md#commissionabledevice)) => `void` | `undefined` | +| `timeoutSeconds` | `number` | `60` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[findCommissionableDevicesContinuously](../interfaces/internal_.Scanner.md#findcommissionabledevicescontinuously) + +#### Defined in + +[matter-node-ble.js/src/ble/BleScanner.ts:238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L238) ___ @@ -168,7 +227,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:111 +[matter-node-ble.js/src/ble/BleScanner.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L131) ___ @@ -189,13 +248,13 @@ and return them. #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:191 +[matter-node-ble.js/src/ble/BleScanner.ts:211](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L211) ___ ### finishWaiter -▸ `Private` **finishWaiter**(`queryId`, `resolvePromise?`): `void` +▸ `Private` **finishWaiter**(`queryId`, `resolvePromise`, `isUpdatedRecord?`): `void` Remove a waiter promise for a specific queryId and stop the connected timer. If required also resolve the promise. @@ -205,7 +264,8 @@ promise. | Name | Type | Default value | | :------ | :------ | :------ | | `queryId` | `string` | `undefined` | -| `resolvePromise` | `boolean` | `false` | +| `resolvePromise` | `boolean` | `undefined` | +| `isUpdatedRecord` | `boolean` | `false` | #### Returns @@ -213,7 +273,7 @@ promise. #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:68 +[matter-node-ble.js/src/ble/BleScanner.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L79) ___ @@ -233,7 +293,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:163 +[matter-node-ble.js/src/ble/BleScanner.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L183) ___ @@ -259,7 +319,7 @@ Return already discovered commissionable devices and return them. Does not send #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:220 +[matter-node-ble.js/src/ble/BleScanner.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L268) ___ @@ -279,7 +339,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:44 +[matter-node-ble.js/src/ble/BleScanner.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L51) ___ @@ -300,7 +360,7 @@ DNS-SD queries. #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:196 +[matter-node-ble.js/src/ble/BleScanner.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L216) ___ @@ -321,28 +381,29 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:80 +[matter-node-ble.js/src/ble/BleScanner.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L97) ___ ### registerWaiterPromise -▸ `Private` **registerWaiterPromise**(`queryId`, `timeoutSeconds`): `Promise`<{ `promise`: `Promise`<`void`\> }\> +▸ `Private` **registerWaiterPromise**(`queryId`, `timeoutSeconds`, `resolveOnUpdatedRecords?`): `Promise`<`void`\> Registers a deferred promise for a specific queryId together with a timeout and return the promise. The promise will be resolved when the timer runs out latest. #### Parameters -| Name | Type | -| :------ | :------ | -| `queryId` | `string` | -| `timeoutSeconds` | `number` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `queryId` | `string` | `undefined` | +| `timeoutSeconds` | `number` | `undefined` | +| `resolveOnUpdatedRecords` | `boolean` | `true` | #### Returns -`Promise`<{ `promise`: `Promise`<`void`\> }\> +`Promise`<`void`\> #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:56 +[matter-node-ble.js/src/ble/BleScanner.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L63) diff --git a/docs/matter-node-ble.js/classes/internal_.AttributeClient.md b/docs/matter-node-ble.js/classes/internal_.AttributeClient.md index d6b7e82d8e..e4771db102 100644 --- a/docs/matter-node-ble.js/classes/internal_.AttributeClient.md +++ b/docs/matter-node-ble.js/classes/internal_.AttributeClient.md @@ -65,7 +65,7 @@ General class for AttributeClients #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:30 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:30 ## Properties @@ -75,7 +75,7 @@ matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:30 #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:20 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:20 ___ @@ -85,7 +85,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:23 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:23 ___ @@ -95,7 +95,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:22 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:22 ___ @@ -105,7 +105,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:29 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:29 ___ @@ -115,7 +115,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:24 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:24 ___ @@ -125,7 +125,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:26 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:26 ___ @@ -135,7 +135,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:25 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:25 ___ @@ -145,7 +145,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:28 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:28 ___ @@ -155,7 +155,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:21 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:21 ___ @@ -165,7 +165,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:27 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:27 ## Methods @@ -187,7 +187,7 @@ Add a listener to the attribute. #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:53 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:53 ___ @@ -210,7 +210,7 @@ Get the value of the attribute. Fabric scoped reads are always done with the rem #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:37 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:37 ___ @@ -233,7 +233,7 @@ Get the value with version of the attribute. Fabric scoped reads are always done #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:41 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:41 ___ @@ -255,7 +255,7 @@ Remove a listener from the attribute. #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:55 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:55 ___ @@ -279,7 +279,7 @@ cluster dataVersion of the server matches. If it does not match it is rejected w #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:35 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:35 ___ @@ -304,7 +304,7 @@ Subscribe to the attribute. #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:46 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:46 ___ @@ -326,4 +326,4 @@ Update the value of the attribute. Just internally used! #### Defined in -matter.js/dist/cjs/cluster/client/AttributeClient.d.ts:51 +matter.js/dist/esm/cluster/client/AttributeClient.d.ts:51 diff --git a/docs/matter-node-ble.js/classes/internal_.AttributeServer.md b/docs/matter-node-ble.js/classes/internal_.AttributeServer.md index fcb0fe01bc..105c803bf7 100644 --- a/docs/matter-node-ble.js/classes/internal_.AttributeServer.md +++ b/docs/matter-node-ble.js/classes/internal_.AttributeServer.md @@ -102,7 +102,7 @@ Attribute server for normal attributes that can be read and written. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:131 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:131 ## Properties @@ -116,7 +116,7 @@ matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:131 #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:37 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:37 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:42 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:42 ___ @@ -152,7 +152,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:57 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:57 ___ @@ -182,7 +182,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:59 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:59 ___ @@ -196,7 +196,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:31 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:31 ___ @@ -214,7 +214,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:125 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:125 ___ @@ -228,7 +228,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:126 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:126 ___ @@ -242,7 +242,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:35 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:35 ___ @@ -256,7 +256,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:34 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:34 ___ @@ -270,7 +270,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:32 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:32 ___ @@ -284,7 +284,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:36 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:36 ___ @@ -298,7 +298,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:33 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:33 ___ @@ -324,7 +324,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:129 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:129 ___ @@ -350,7 +350,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:130 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:130 ___ @@ -366,7 +366,7 @@ The value is undefined when getter/setter are used. But we still handle the vers #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:41 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:41 ___ @@ -376,7 +376,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:127 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:127 ___ @@ -386,7 +386,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:128 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:128 ## Methods @@ -413,7 +413,7 @@ new value and the version number. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:205 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:205 ___ @@ -440,7 +440,7 @@ new value and the old value. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:214 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:214 ___ @@ -464,7 +464,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:45 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:45 ___ @@ -493,7 +493,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:74 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:74 ___ @@ -515,7 +515,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:90 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:90 ___ @@ -550,7 +550,7 @@ attributes. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:81 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:81 ___ @@ -575,7 +575,7 @@ internally. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:186 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:186 ___ @@ -602,7 +602,7 @@ adjusted before the Device gets announced. Do not use this method to change valu #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:158 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:158 ___ @@ -625,7 +625,7 @@ Helper Method to process the set of a value in a generic way. This method is use #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:181 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:181 ___ @@ -651,7 +651,7 @@ Remove an internal listener. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:209 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:209 ___ @@ -677,7 +677,7 @@ Remove an external listener. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:223 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:223 ___ @@ -703,7 +703,7 @@ Listeners are called when the value changes (internal listeners) or in any case #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:165 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:165 ___ @@ -729,7 +729,7 @@ Listeners are called when the value changes (internal listeners) or in any case #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:177 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:177 ___ @@ -752,7 +752,7 @@ Method that contains the logic to set a value "from remote" (e.g. from a client) #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:169 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:169 ___ @@ -779,7 +779,7 @@ new value and the old value. This method is a convenient alias for addValueSetLi #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:219 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:219 ___ @@ -804,7 +804,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:193 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:193 ___ @@ -823,7 +823,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:200 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:200 ___ @@ -847,4 +847,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:44 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:44 diff --git a/docs/matter-node-ble.js/classes/internal_.BaseAttributeServer.md b/docs/matter-node-ble.js/classes/internal_.BaseAttributeServer.md index 40e017b7e6..1d2a464eaa 100644 --- a/docs/matter-node-ble.js/classes/internal_.BaseAttributeServer.md +++ b/docs/matter-node-ble.js/classes/internal_.BaseAttributeServer.md @@ -68,7 +68,7 @@ Base class for all attribute servers. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:43 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:43 ## Properties @@ -78,7 +78,7 @@ matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:43 #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:37 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:37 ___ @@ -88,7 +88,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:42 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:42 ___ @@ -98,7 +98,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:31 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:31 ___ @@ -108,7 +108,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:35 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:35 ___ @@ -118,7 +118,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:34 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:34 ___ @@ -128,7 +128,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:32 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:32 ___ @@ -138,7 +138,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:36 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:36 ___ @@ -148,7 +148,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:33 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:33 ___ @@ -160,7 +160,7 @@ The value is undefined when getter/setter are used. But we still handle the vers #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:41 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:41 ## Methods @@ -180,7 +180,7 @@ matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:41 #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:45 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:45 ___ @@ -203,7 +203,7 @@ adjusted before the Device gets announced. Do not use this method to change valu #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:50 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:50 ___ @@ -223,4 +223,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:44 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:44 diff --git a/docs/matter-node-ble.js/classes/internal_.Ble.md b/docs/matter-node-ble.js/classes/internal_.Ble.md index 4fba3700f1..1208c478f5 100644 --- a/docs/matter-node-ble.js/classes/internal_.Ble.md +++ b/docs/matter-node-ble.js/classes/internal_.Ble.md @@ -49,7 +49,7 @@ #### Defined in -matter.js/dist/cjs/ble/Ble.d.ts:15 +matter.js/dist/esm/ble/Ble.d.ts:15 ## Methods @@ -69,7 +69,7 @@ matter.js/dist/cjs/ble/Ble.d.ts:15 #### Defined in -matter.js/dist/cjs/ble/Ble.d.ts:18 +matter.js/dist/esm/ble/Ble.d.ts:18 ___ @@ -83,7 +83,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/Ble.d.ts:17 +matter.js/dist/esm/ble/Ble.d.ts:17 ___ @@ -97,7 +97,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/Ble.d.ts:16 +matter.js/dist/esm/ble/Ble.d.ts:16 ___ @@ -111,4 +111,4 @@ ___ #### Defined in -matter.js/dist/cjs/ble/Ble.d.ts:19 +matter.js/dist/esm/ble/Ble.d.ts:19 diff --git a/docs/matter-node-ble.js/classes/internal_.BlenoBleServer.md b/docs/matter-node-ble.js/classes/internal_.BlenoBleServer.md index 3fcebe0671..eba3179e77 100644 --- a/docs/matter-node-ble.js/classes/internal_.BlenoBleServer.md +++ b/docs/matter-node-ble.js/classes/internal_.BlenoBleServer.md @@ -65,7 +65,7 @@ one BLE device at a time! #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:143 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:144](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L144) ## Properties @@ -75,7 +75,7 @@ matter-node-ble.js/src/ble/BlenoBleServer.ts:143 #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:129 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L130) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:130 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L131) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:139 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L140) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:133 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L134) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:138 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L139) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:128 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L129) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:132 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L133) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:141 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L142) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:135 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L136) ___ @@ -165,7 +165,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:127 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L128) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:136 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:137](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L137) ## Accessors @@ -193,7 +193,7 @@ matter-node-ble.js/src/ble/BlenoBleServer.ts:136 #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:391 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:392](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L392) ## Methods @@ -214,7 +214,7 @@ matter-node-ble.js/src/ble/BlenoBleServer.ts:391 #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:312 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:313](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L313) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:356 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:357](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L357) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:361 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:362](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L362) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:370 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:371](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L371) ___ @@ -286,7 +286,7 @@ Otherwise, the data are forwarded to the BTP session handler to be decoded and p #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:216 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L217) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:289 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:290](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L290) ___ @@ -326,7 +326,7 @@ The BtpSessionHandler instance is wired with the bleno instance for sending data #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:251 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:252](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L252) ___ @@ -349,7 +349,7 @@ The relevant data needs optionally to be set before advertising, else empty data #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:304 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L305) ___ @@ -375,7 +375,7 @@ Send a Matter message to the connected device - need to do BTP assembly first. #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:383 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:384](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L384) ___ @@ -395,7 +395,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:349 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:350](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L350) ___ @@ -409,4 +409,4 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:337 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L338) diff --git a/docs/matter-node-ble.js/classes/internal_.BtpService.md b/docs/matter-node-ble.js/classes/internal_.BtpService.md index 3682539598..9b6cbe6c91 100644 --- a/docs/matter-node-ble.js/classes/internal_.BtpService.md +++ b/docs/matter-node-ble.js/classes/internal_.BtpService.md @@ -28,4 +28,4 @@ Bleno.PrimaryService.constructor #### Defined in -matter-node-ble.js/src/ble/BlenoBleServer.ts:105 +[matter-node-ble.js/src/ble/BlenoBleServer.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BlenoBleServer.ts#L106) diff --git a/docs/matter-node-ble.js/classes/internal_.BtpSessionHandler.md b/docs/matter-node-ble.js/classes/internal_.BtpSessionHandler.md index fa6c05ccef..648938651a 100644 --- a/docs/matter-node-ble.js/classes/internal_.BtpSessionHandler.md +++ b/docs/matter-node-ble.js/classes/internal_.BtpSessionHandler.md @@ -64,7 +64,7 @@ Creates a new BTP session handler #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:46 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:46 ## Properties @@ -74,7 +74,7 @@ matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:46 #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:25 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:25 ___ @@ -87,7 +87,7 @@ the peer SHALL close the BTP session and report an error to the application. #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:76 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:76 ___ @@ -100,7 +100,7 @@ acknowledgement #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:71 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:71 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:17 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:17 ___ @@ -120,7 +120,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:21 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:21 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:22 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:22 ___ @@ -140,7 +140,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:19 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:19 ___ @@ -152,7 +152,7 @@ Checks if incoming ackNumber and sent sequence number exceeds the client window #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:84 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:84 ___ @@ -162,7 +162,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:16 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:16 ___ @@ -172,7 +172,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:20 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:20 ___ @@ -182,7 +182,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:31 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:31 ___ @@ -192,7 +192,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:27 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:27 ___ @@ -202,7 +202,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:24 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:24 ___ @@ -212,7 +212,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:23 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:23 ___ @@ -222,7 +222,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:62 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:62 ___ @@ -232,7 +232,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:28 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:28 ___ @@ -242,7 +242,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:30 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:30 ___ @@ -252,7 +252,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:29 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:29 ___ @@ -262,7 +262,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:26 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:26 ___ @@ -272,7 +272,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:18 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:18 ## Methods @@ -288,7 +288,7 @@ Close the BTP session. This method is called when the BLE transport is disconnec #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:66 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:66 ___ @@ -304,7 +304,7 @@ Increments sequence number for the packets and round it off to 0 when it reaches #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:80 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:80 ___ @@ -327,7 +327,7 @@ ExchangeManager layer #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:53 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:53 ___ @@ -351,7 +351,7 @@ should be sent. #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:61 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:61 ___ @@ -374,7 +374,7 @@ ___ #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:34 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:34 ___ @@ -400,4 +400,4 @@ Factory method to create a new BTPSessionHandler from a received handshake reque #### Defined in -matter.js/dist/cjs/ble/BtpSessionHandler.d.ts:33 +matter.js/dist/esm/ble/BtpSessionHandler.d.ts:33 diff --git a/docs/matter-node-ble.js/classes/internal_.ChannelManager.md b/docs/matter-node-ble.js/classes/internal_.ChannelManager.md index a157d83281..d6aa5d9b13 100644 --- a/docs/matter-node-ble.js/classes/internal_.ChannelManager.md +++ b/docs/matter-node-ble.js/classes/internal_.ChannelManager.md @@ -14,6 +14,7 @@ - [channels](internal_.ChannelManager.md#channels) - [getChannelKey](internal_.ChannelManager.md#getchannelkey) +- [getOrCreateAsPaseChannel](internal_.ChannelManager.md#getorcreateaspasechannel) - [paseChannels](internal_.ChannelManager.md#pasechannels) ### Methods @@ -39,7 +40,7 @@ #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:16 +matter.js/dist/esm/protocol/ChannelManager.d.ts:16 ___ @@ -49,7 +50,17 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:18 +matter.js/dist/esm/protocol/ChannelManager.d.ts:18 + +___ + +### getOrCreateAsPaseChannel + +• `Private` **getOrCreateAsPaseChannel**: `any` + +#### Defined in + +matter.js/dist/esm/protocol/ChannelManager.d.ts:23 ___ @@ -59,7 +70,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:17 +matter.js/dist/esm/protocol/ChannelManager.d.ts:17 ## Methods @@ -73,7 +84,7 @@ matter.js/dist/cjs/protocol/ChannelManager.d.ts:17 #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:24 +matter.js/dist/esm/protocol/ChannelManager.d.ts:25 ___ @@ -94,7 +105,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:20 +matter.js/dist/esm/protocol/ChannelManager.d.ts:20 ___ @@ -114,13 +125,13 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:21 +matter.js/dist/esm/protocol/ChannelManager.d.ts:21 ___ ### getOrCreateChannel -▸ **getOrCreateChannel**(`byteArrayChannel`, `session`): [`MessageChannel`](internal_.MessageChannel.md)<`any`\> +▸ **getOrCreateChannel**(`byteArrayChannel`, `session`): `Promise`<[`MessageChannel`](internal_.MessageChannel.md)<`any`\>\> #### Parameters @@ -131,17 +142,17 @@ ___ #### Returns -[`MessageChannel`](internal_.MessageChannel.md)<`any`\> +`Promise`<[`MessageChannel`](internal_.MessageChannel.md)<`any`\>\> #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:23 +matter.js/dist/esm/protocol/ChannelManager.d.ts:24 ___ ### removeChannel -▸ **removeChannel**(`fabric`, `nodeId`): `void` +▸ **removeChannel**(`fabric`, `nodeId`): `Promise`<`void`\> #### Parameters @@ -152,17 +163,17 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:22 +matter.js/dist/esm/protocol/ChannelManager.d.ts:22 ___ ### setChannel -▸ **setChannel**(`fabric`, `nodeId`, `channel`): `void` +▸ **setChannel**(`fabric`, `nodeId`, `channel`): `Promise`<`void`\> #### Parameters @@ -174,8 +185,8 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Defined in -matter.js/dist/cjs/protocol/ChannelManager.d.ts:19 +matter.js/dist/esm/protocol/ChannelManager.d.ts:19 diff --git a/docs/matter-node-ble.js/classes/internal_.CommandServer.md b/docs/matter-node-ble.js/classes/internal_.CommandServer.md index c6111e7690..6cea83e32b 100644 --- a/docs/matter-node-ble.js/classes/internal_.CommandServer.md +++ b/docs/matter-node-ble.js/classes/internal_.CommandServer.md @@ -58,7 +58,7 @@ #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:21 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:21 ## Properties @@ -85,7 +85,7 @@ matter.js/dist/cjs/cluster/server/CommandServer.d.ts:21 #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:20 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:20 ___ @@ -95,7 +95,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:14 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:14 ___ @@ -105,7 +105,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:16 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:16 ___ @@ -115,7 +115,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:17 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:17 ___ @@ -125,7 +125,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:19 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:19 ___ @@ -135,7 +135,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:15 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:15 ___ @@ -145,7 +145,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:18 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:18 ## Methods @@ -168,4 +168,4 @@ matter.js/dist/cjs/cluster/server/CommandServer.d.ts:18 #### Defined in -matter.js/dist/cjs/cluster/server/CommandServer.d.ts:22 +matter.js/dist/esm/cluster/server/CommandServer.d.ts:22 diff --git a/docs/matter-node-ble.js/classes/internal_.Endpoint.md b/docs/matter-node-ble.js/classes/internal_.Endpoint.md index 8ad4b97ef2..765e2703f1 100644 --- a/docs/matter-node-ble.js/classes/internal_.Endpoint.md +++ b/docs/matter-node-ble.js/classes/internal_.Endpoint.md @@ -67,7 +67,7 @@ Create a new Endpoint instance. #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:34 +matter.js/dist/esm/device/Endpoint.d.ts:34 ## Properties @@ -77,7 +77,7 @@ matter.js/dist/cjs/device/Endpoint.d.ts:34 #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:22 +matter.js/dist/esm/device/Endpoint.d.ts:22 ___ @@ -87,7 +87,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:21 +matter.js/dist/esm/device/Endpoint.d.ts:21 ___ @@ -97,7 +97,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:20 +matter.js/dist/esm/device/Endpoint.d.ts:20 ___ @@ -107,7 +107,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:27 +matter.js/dist/esm/device/Endpoint.d.ts:27 ___ @@ -117,7 +117,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:19 +matter.js/dist/esm/device/Endpoint.d.ts:19 ___ @@ -127,7 +127,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:23 +matter.js/dist/esm/device/Endpoint.d.ts:23 ___ @@ -137,7 +137,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:25 +matter.js/dist/esm/device/Endpoint.d.ts:25 ___ @@ -147,7 +147,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:26 +matter.js/dist/esm/device/Endpoint.d.ts:26 ___ @@ -157,7 +157,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:24 +matter.js/dist/esm/device/Endpoint.d.ts:24 ## Methods @@ -177,7 +177,7 @@ matter.js/dist/cjs/device/Endpoint.d.ts:24 #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:51 +matter.js/dist/esm/device/Endpoint.d.ts:51 ___ @@ -206,7 +206,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:42 +matter.js/dist/esm/device/Endpoint.d.ts:42 ___ @@ -233,7 +233,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:41 +matter.js/dist/esm/device/Endpoint.d.ts:41 ___ @@ -254,7 +254,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:39 +matter.js/dist/esm/device/Endpoint.d.ts:39 ___ @@ -275,7 +275,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:40 +matter.js/dist/esm/device/Endpoint.d.ts:40 ___ @@ -289,7 +289,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:37 +matter.js/dist/esm/device/Endpoint.d.ts:37 ___ @@ -303,7 +303,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:55 +matter.js/dist/esm/device/Endpoint.d.ts:55 ___ @@ -317,7 +317,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:58 +matter.js/dist/esm/device/Endpoint.d.ts:58 ___ @@ -331,7 +331,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:57 +matter.js/dist/esm/device/Endpoint.d.ts:57 ___ @@ -351,7 +351,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:52 +matter.js/dist/esm/device/Endpoint.d.ts:52 ___ @@ -365,7 +365,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:53 +matter.js/dist/esm/device/Endpoint.d.ts:53 ___ @@ -395,7 +395,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:44 +matter.js/dist/esm/device/Endpoint.d.ts:44 ___ @@ -415,7 +415,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:46 +matter.js/dist/esm/device/Endpoint.d.ts:46 ___ @@ -445,7 +445,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:43 +matter.js/dist/esm/device/Endpoint.d.ts:43 ___ @@ -465,7 +465,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:45 +matter.js/dist/esm/device/Endpoint.d.ts:45 ___ @@ -479,7 +479,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:49 +matter.js/dist/esm/device/Endpoint.d.ts:49 ___ @@ -493,7 +493,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:38 +matter.js/dist/esm/device/Endpoint.d.ts:38 ___ @@ -523,7 +523,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:48 +matter.js/dist/esm/device/Endpoint.d.ts:48 ___ @@ -553,7 +553,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:47 +matter.js/dist/esm/device/Endpoint.d.ts:47 ___ @@ -573,7 +573,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:54 +matter.js/dist/esm/device/Endpoint.d.ts:54 ___ @@ -587,7 +587,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:36 +matter.js/dist/esm/device/Endpoint.d.ts:36 ___ @@ -607,7 +607,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:50 +matter.js/dist/esm/device/Endpoint.d.ts:50 ___ @@ -627,7 +627,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:35 +matter.js/dist/esm/device/Endpoint.d.ts:35 ___ @@ -641,7 +641,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:59 +matter.js/dist/esm/device/Endpoint.d.ts:59 ___ @@ -655,4 +655,4 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:56 +matter.js/dist/esm/device/Endpoint.d.ts:56 diff --git a/docs/matter-node-ble.js/classes/internal_.EventClient.md b/docs/matter-node-ble.js/classes/internal_.EventClient.md index d50b6110ea..b8ca77ed32 100644 --- a/docs/matter-node-ble.js/classes/internal_.EventClient.md +++ b/docs/matter-node-ble.js/classes/internal_.EventClient.md @@ -60,7 +60,7 @@ General class for EventClients #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:27 +matter.js/dist/esm/cluster/client/EventClient.d.ts:27 ## Properties @@ -70,7 +70,7 @@ matter.js/dist/cjs/cluster/client/EventClient.d.ts:27 #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:23 +matter.js/dist/esm/cluster/client/EventClient.d.ts:23 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:22 +matter.js/dist/esm/cluster/client/EventClient.d.ts:22 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:20 +matter.js/dist/esm/cluster/client/EventClient.d.ts:20 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:26 +matter.js/dist/esm/cluster/client/EventClient.d.ts:26 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:24 +matter.js/dist/esm/cluster/client/EventClient.d.ts:24 ___ @@ -120,7 +120,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:25 +matter.js/dist/esm/cluster/client/EventClient.d.ts:25 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:21 +matter.js/dist/esm/cluster/client/EventClient.d.ts:21 ## Methods @@ -150,7 +150,7 @@ matter.js/dist/cjs/cluster/client/EventClient.d.ts:21 #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:31 +matter.js/dist/esm/cluster/client/EventClient.d.ts:31 ___ @@ -171,7 +171,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:28 +matter.js/dist/esm/cluster/client/EventClient.d.ts:28 ___ @@ -191,7 +191,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:32 +matter.js/dist/esm/cluster/client/EventClient.d.ts:32 ___ @@ -215,7 +215,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:29 +matter.js/dist/esm/cluster/client/EventClient.d.ts:29 ___ @@ -235,4 +235,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/EventClient.d.ts:30 +matter.js/dist/esm/cluster/client/EventClient.d.ts:30 diff --git a/docs/matter-node-ble.js/classes/internal_.EventHandler.md b/docs/matter-node-ble.js/classes/internal_.EventHandler.md index b18477c52a..08410e73f4 100644 --- a/docs/matter-node-ble.js/classes/internal_.EventHandler.md +++ b/docs/matter-node-ble.js/classes/internal_.EventHandler.md @@ -40,7 +40,7 @@ to handle subscriptions (TBD) #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:39 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:39 ## Properties @@ -50,7 +50,7 @@ matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:39 #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:36 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:36 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:35 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:35 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:38 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:38 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:37 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:37 ## Methods @@ -94,7 +94,7 @@ matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:37 #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:50 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:50 ___ @@ -115,7 +115,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:40 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:40 ___ @@ -145,4 +145,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:41 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:41 diff --git a/docs/matter-node-ble.js/classes/internal_.EventServer.md b/docs/matter-node-ble.js/classes/internal_.EventServer.md index 58aed9b81f..dccbd1f942 100644 --- a/docs/matter-node-ble.js/classes/internal_.EventServer.md +++ b/docs/matter-node-ble.js/classes/internal_.EventServer.md @@ -60,7 +60,7 @@ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:22 +matter.js/dist/esm/cluster/server/EventServer.d.ts:22 ## Properties @@ -70,7 +70,7 @@ matter.js/dist/cjs/cluster/server/EventServer.d.ts:22 #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:14 +matter.js/dist/esm/cluster/server/EventServer.d.ts:14 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:20 +matter.js/dist/esm/cluster/server/EventServer.d.ts:20 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:21 +matter.js/dist/esm/cluster/server/EventServer.d.ts:21 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:18 +matter.js/dist/esm/cluster/server/EventServer.d.ts:18 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:13 +matter.js/dist/esm/cluster/server/EventServer.d.ts:13 ___ @@ -120,7 +120,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:19 +matter.js/dist/esm/cluster/server/EventServer.d.ts:19 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:15 +matter.js/dist/esm/cluster/server/EventServer.d.ts:15 ___ @@ -140,7 +140,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:17 +matter.js/dist/esm/cluster/server/EventServer.d.ts:17 ___ @@ -150,7 +150,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:16 +matter.js/dist/esm/cluster/server/EventServer.d.ts:16 ## Methods @@ -170,7 +170,7 @@ matter.js/dist/cjs/cluster/server/EventServer.d.ts:16 #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:26 +matter.js/dist/esm/cluster/server/EventServer.d.ts:26 ___ @@ -190,7 +190,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:23 +matter.js/dist/esm/cluster/server/EventServer.d.ts:23 ___ @@ -210,7 +210,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:24 +matter.js/dist/esm/cluster/server/EventServer.d.ts:24 ___ @@ -230,7 +230,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:27 +matter.js/dist/esm/cluster/server/EventServer.d.ts:27 ___ @@ -250,4 +250,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/EventServer.d.ts:25 +matter.js/dist/esm/cluster/server/EventServer.d.ts:25 diff --git a/docs/matter-node-ble.js/classes/internal_.ExchangeManager.md b/docs/matter-node-ble.js/classes/internal_.ExchangeManager.md index e2c5c409cb..b0c30683c2 100644 --- a/docs/matter-node-ble.js/classes/internal_.ExchangeManager.md +++ b/docs/matter-node-ble.js/classes/internal_.ExchangeManager.md @@ -19,6 +19,7 @@ ### Properties - [channelManager](internal_.ExchangeManager.md#channelmanager) +- [closingSessions](internal_.ExchangeManager.md#closingsessions) - [exchangeCounter](internal_.ExchangeManager.md#exchangecounter) - [exchanges](internal_.ExchangeManager.md#exchanges) - [messageCounter](internal_.ExchangeManager.md#messagecounter) @@ -32,6 +33,10 @@ - [addProtocolHandler](internal_.ExchangeManager.md#addprotocolhandler) - [addTransportInterface](internal_.ExchangeManager.md#addtransportinterface) - [close](internal_.ExchangeManager.md#close) +- [closeSession](internal_.ExchangeManager.md#closesession) +- [deleteExchange](internal_.ExchangeManager.md#deleteexchange) +- [getProtocolHandler](internal_.ExchangeManager.md#getprotocolhandler) +- [hasProtocolHandler](internal_.ExchangeManager.md#hasprotocolhandler) - [initiateExchange](internal_.ExchangeManager.md#initiateexchange) - [initiateExchangeWithChannel](internal_.ExchangeManager.md#initiateexchangewithchannel) @@ -56,7 +61,7 @@ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:35 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:38 ## Properties @@ -66,7 +71,17 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:35 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:29 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:31 + +___ + +### closingSessions + +• `Private` `Readonly` **closingSessions**: `any` + +#### Defined in + +matter.js/dist/esm/protocol/ExchangeManager.d.ts:37 ___ @@ -76,7 +91,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:30 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:32 ___ @@ -86,7 +101,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:32 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:34 ___ @@ -96,7 +111,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:31 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:33 ___ @@ -106,7 +121,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:41 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:46 ___ @@ -116,7 +131,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:33 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:35 ___ @@ -126,7 +141,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:28 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:30 ___ @@ -136,7 +151,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:34 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:36 ## Methods @@ -156,7 +171,7 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:34 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:37 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:42 ___ @@ -176,7 +191,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:36 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:39 ___ @@ -190,7 +205,87 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:40 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:45 + +___ + +### closeSession + +▸ **closeSession**(`session`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `session` | [`SecureSession`](internal_.SecureSession.md)<`any`\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +matter.js/dist/esm/protocol/ExchangeManager.d.ts:48 + +___ + +### deleteExchange + +▸ **deleteExchange**(`exchangeIndex`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `exchangeIndex` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +matter.js/dist/esm/protocol/ExchangeManager.d.ts:47 + +___ + +### getProtocolHandler + +▸ **getProtocolHandler**(`protocolId`): `undefined` \| [`ProtocolHandler`](../interfaces/internal_.ProtocolHandler.md)<`ContextT`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`undefined` \| [`ProtocolHandler`](../interfaces/internal_.ProtocolHandler.md)<`ContextT`\> + +#### Defined in + +matter.js/dist/esm/protocol/ExchangeManager.d.ts:41 + +___ + +### hasProtocolHandler + +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +matter.js/dist/esm/protocol/ExchangeManager.d.ts:40 ___ @@ -212,7 +307,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:38 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:43 ___ @@ -233,4 +328,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:39 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:44 diff --git a/docs/matter-node-ble.js/classes/internal_.ExchangeProvider.md b/docs/matter-node-ble.js/classes/internal_.ExchangeProvider.md index 3568189f63..e6ccece398 100644 --- a/docs/matter-node-ble.js/classes/internal_.ExchangeProvider.md +++ b/docs/matter-node-ble.js/classes/internal_.ExchangeProvider.md @@ -23,6 +23,8 @@ ### Methods - [addProtocolHandler](internal_.ExchangeProvider.md#addprotocolhandler) +- [getProtocolHandler](internal_.ExchangeProvider.md#getprotocolhandler) +- [hasProtocolHandler](internal_.ExchangeProvider.md#hasprotocolhandler) - [initiateExchange](internal_.ExchangeProvider.md#initiateexchange) - [reconnectChannel](internal_.ExchangeProvider.md#reconnectchannel) @@ -42,7 +44,7 @@ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:55 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:62 ## Properties @@ -52,7 +54,7 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:55 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:53 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:60 ___ @@ -62,7 +64,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:52 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:59 ___ @@ -72,7 +74,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:54 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:61 ## Accessors @@ -86,7 +88,7 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:54 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:59 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:68 ## Methods @@ -106,7 +108,47 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:59 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:56 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:65 + +___ + +### getProtocolHandler + +▸ **getProtocolHandler**(`protocolId`): `undefined` \| [`ProtocolHandler`](../interfaces/internal_.ProtocolHandler.md)<[`MatterController`](internal_.MatterController.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`undefined` \| [`ProtocolHandler`](../interfaces/internal_.ProtocolHandler.md)<[`MatterController`](internal_.MatterController.md)\> + +#### Defined in + +matter.js/dist/esm/protocol/ExchangeManager.d.ts:64 + +___ + +### hasProtocolHandler + +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +matter.js/dist/esm/protocol/ExchangeManager.d.ts:63 ___ @@ -120,7 +162,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:57 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:66 ___ @@ -134,4 +176,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:58 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:67 diff --git a/docs/matter-node-ble.js/classes/internal_.Fabric.md b/docs/matter-node-ble.js/classes/internal_.Fabric.md index b1461df933..3cadb7934e 100644 --- a/docs/matter-node-ble.js/classes/internal_.Fabric.md +++ b/docs/matter-node-ble.js/classes/internal_.Fabric.md @@ -84,7 +84,7 @@ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:51 +matter.js/dist/esm/fabric/Fabric.d.ts:51 ## Properties @@ -94,7 +94,7 @@ matter.js/dist/cjs/fabric/Fabric.d.ts:51 #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:34 +matter.js/dist/esm/fabric/Fabric.d.ts:34 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:33 +matter.js/dist/esm/fabric/Fabric.d.ts:33 ___ @@ -114,7 +114,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:42 +matter.js/dist/esm/fabric/Fabric.d.ts:42 ___ @@ -124,7 +124,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:44 +matter.js/dist/esm/fabric/Fabric.d.ts:44 ___ @@ -134,7 +134,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:39 +matter.js/dist/esm/fabric/Fabric.d.ts:39 ___ @@ -144,7 +144,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:46 +matter.js/dist/esm/fabric/Fabric.d.ts:46 ___ @@ -154,7 +154,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:35 +matter.js/dist/esm/fabric/Fabric.d.ts:35 ___ @@ -164,7 +164,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:45 +matter.js/dist/esm/fabric/Fabric.d.ts:45 ___ @@ -174,7 +174,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:37 +matter.js/dist/esm/fabric/Fabric.d.ts:37 ___ @@ -184,7 +184,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:43 +matter.js/dist/esm/fabric/Fabric.d.ts:43 ___ @@ -194,7 +194,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:50 +matter.js/dist/esm/fabric/Fabric.d.ts:50 ___ @@ -204,7 +204,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:49 +matter.js/dist/esm/fabric/Fabric.d.ts:49 ___ @@ -214,7 +214,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:41 +matter.js/dist/esm/fabric/Fabric.d.ts:41 ___ @@ -224,7 +224,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:36 +matter.js/dist/esm/fabric/Fabric.d.ts:36 ___ @@ -234,7 +234,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:38 +matter.js/dist/esm/fabric/Fabric.d.ts:38 ___ @@ -244,7 +244,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:40 +matter.js/dist/esm/fabric/Fabric.d.ts:40 ___ @@ -254,7 +254,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:48 +matter.js/dist/esm/fabric/Fabric.d.ts:48 ___ @@ -264,7 +264,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:47 +matter.js/dist/esm/fabric/Fabric.d.ts:47 ## Methods @@ -284,7 +284,7 @@ matter.js/dist/cjs/fabric/Fabric.d.ts:47 #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:62 +matter.js/dist/esm/fabric/Fabric.d.ts:62 ___ @@ -304,7 +304,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:60 +matter.js/dist/esm/fabric/Fabric.d.ts:60 ___ @@ -324,7 +324,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:63 +matter.js/dist/esm/fabric/Fabric.d.ts:63 ___ @@ -344,7 +344,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:71 +matter.js/dist/esm/fabric/Fabric.d.ts:71 ___ @@ -365,7 +365,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:69 +matter.js/dist/esm/fabric/Fabric.d.ts:69 ___ @@ -386,7 +386,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:59 +matter.js/dist/esm/fabric/Fabric.d.ts:59 ___ @@ -401,6 +401,7 @@ ___ | Name | Type | | :------ | :------ | | `fabricId` | [`FabricId`](../modules/internal_.md#fabricid) | +| `fabricIndex` | [`FabricIndex`](../modules/internal_.md#fabricindex) | | `label` | `string` | | `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | | `rootNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | @@ -408,7 +409,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:73 +matter.js/dist/esm/fabric/Fabric.d.ts:73 ___ @@ -422,7 +423,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:55 +matter.js/dist/esm/fabric/Fabric.d.ts:55 ___ @@ -442,7 +443,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:72 +matter.js/dist/esm/fabric/Fabric.d.ts:72 ___ @@ -469,7 +470,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:67 +matter.js/dist/esm/fabric/Fabric.d.ts:67 ___ @@ -490,7 +491,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:70 +matter.js/dist/esm/fabric/Fabric.d.ts:70 ___ @@ -511,7 +512,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:58 +matter.js/dist/esm/fabric/Fabric.d.ts:58 ___ @@ -525,13 +526,19 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:66 +matter.js/dist/esm/fabric/Fabric.d.ts:66 ___ ### remove -▸ **remove**(): `Promise`<`void`\> +▸ **remove**(`currentSessionId?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `currentSessionId?` | `number` | #### Returns @@ -539,7 +546,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:65 +matter.js/dist/esm/fabric/Fabric.d.ts:65 ___ @@ -559,7 +566,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:61 +matter.js/dist/esm/fabric/Fabric.d.ts:61 ___ @@ -579,7 +586,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:54 +matter.js/dist/esm/fabric/Fabric.d.ts:54 ___ @@ -599,7 +606,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:64 +matter.js/dist/esm/fabric/Fabric.d.ts:64 ___ @@ -627,7 +634,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:68 +matter.js/dist/esm/fabric/Fabric.d.ts:68 ___ @@ -647,7 +654,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:56 +matter.js/dist/esm/fabric/Fabric.d.ts:56 ___ @@ -661,7 +668,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:52 +matter.js/dist/esm/fabric/Fabric.d.ts:52 ___ @@ -682,7 +689,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:57 +matter.js/dist/esm/fabric/Fabric.d.ts:57 ___ @@ -702,4 +709,4 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:53 +matter.js/dist/esm/fabric/Fabric.d.ts:53 diff --git a/docs/matter-node-ble.js/classes/internal_.FabricBuilder.md b/docs/matter-node-ble.js/classes/internal_.FabricBuilder.md index 29e7985321..de72ffc75f 100644 --- a/docs/matter-node-ble.js/classes/internal_.FabricBuilder.md +++ b/docs/matter-node-ble.js/classes/internal_.FabricBuilder.md @@ -57,7 +57,7 @@ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:87 +matter.js/dist/esm/fabric/Fabric.d.ts:88 ___ @@ -67,7 +67,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:92 +matter.js/dist/esm/fabric/Fabric.d.ts:93 ___ @@ -77,7 +77,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:91 +matter.js/dist/esm/fabric/Fabric.d.ts:92 ___ @@ -87,7 +87,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:85 +matter.js/dist/esm/fabric/Fabric.d.ts:86 ___ @@ -97,7 +97,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:82 +matter.js/dist/esm/fabric/Fabric.d.ts:83 ___ @@ -107,7 +107,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:93 +matter.js/dist/esm/fabric/Fabric.d.ts:94 ___ @@ -117,7 +117,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:88 +matter.js/dist/esm/fabric/Fabric.d.ts:89 ___ @@ -127,7 +127,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:86 +matter.js/dist/esm/fabric/Fabric.d.ts:87 ___ @@ -137,7 +137,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:84 +matter.js/dist/esm/fabric/Fabric.d.ts:85 ___ @@ -147,7 +147,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:89 +matter.js/dist/esm/fabric/Fabric.d.ts:90 ___ @@ -157,7 +157,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:90 +matter.js/dist/esm/fabric/Fabric.d.ts:91 ___ @@ -167,7 +167,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:83 +matter.js/dist/esm/fabric/Fabric.d.ts:84 ## Methods @@ -187,7 +187,7 @@ matter.js/dist/cjs/fabric/Fabric.d.ts:83 #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:108 +matter.js/dist/esm/fabric/Fabric.d.ts:109 ___ @@ -201,7 +201,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:96 +matter.js/dist/esm/fabric/Fabric.d.ts:97 ___ @@ -215,7 +215,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:107 +matter.js/dist/esm/fabric/Fabric.d.ts:108 ___ @@ -229,7 +229,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:95 +matter.js/dist/esm/fabric/Fabric.d.ts:96 ___ @@ -243,7 +243,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:106 +matter.js/dist/esm/fabric/Fabric.d.ts:107 ___ @@ -257,7 +257,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:94 +matter.js/dist/esm/fabric/Fabric.d.ts:95 ___ @@ -271,7 +271,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:98 +matter.js/dist/esm/fabric/Fabric.d.ts:99 ___ @@ -291,7 +291,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:104 +matter.js/dist/esm/fabric/Fabric.d.ts:105 ___ @@ -311,7 +311,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:105 +matter.js/dist/esm/fabric/Fabric.d.ts:106 ___ @@ -331,7 +331,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:103 +matter.js/dist/esm/fabric/Fabric.d.ts:104 ___ @@ -351,7 +351,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:100 +matter.js/dist/esm/fabric/Fabric.d.ts:101 ___ @@ -371,7 +371,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:99 +matter.js/dist/esm/fabric/Fabric.d.ts:100 ___ @@ -391,7 +391,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:97 +matter.js/dist/esm/fabric/Fabric.d.ts:98 ___ @@ -411,7 +411,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:102 +matter.js/dist/esm/fabric/Fabric.d.ts:103 ___ @@ -431,4 +431,4 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:101 +matter.js/dist/esm/fabric/Fabric.d.ts:102 diff --git a/docs/matter-node-ble.js/classes/internal_.FabricScopedAttributeServer.md b/docs/matter-node-ble.js/classes/internal_.FabricScopedAttributeServer.md index 9b5921f972..8b6d7a6bde 100644 --- a/docs/matter-node-ble.js/classes/internal_.FabricScopedAttributeServer.md +++ b/docs/matter-node-ble.js/classes/internal_.FabricScopedAttributeServer.md @@ -108,7 +108,7 @@ on fabric level if no custom getter or setter is defined. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:233 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:233 ## Properties @@ -118,7 +118,7 @@ matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:233 #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:230 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:230 ___ @@ -132,7 +132,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:37 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:37 ___ @@ -146,7 +146,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:42 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:42 ___ @@ -168,7 +168,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:57 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:57 ___ @@ -198,7 +198,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:59 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:59 ___ @@ -212,7 +212,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:31 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:31 ___ @@ -234,7 +234,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:125 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:125 ___ @@ -244,7 +244,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:231 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:231 ___ @@ -254,7 +254,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:232 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:232 ___ @@ -268,7 +268,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:126 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:126 ___ @@ -282,7 +282,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:35 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:35 ___ @@ -296,7 +296,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:34 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:34 ___ @@ -310,7 +310,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:32 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:32 ___ @@ -324,7 +324,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:36 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:36 ___ @@ -338,7 +338,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:33 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:33 ___ @@ -368,7 +368,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:129 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:129 ___ @@ -398,7 +398,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:130 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:130 ___ @@ -414,7 +414,7 @@ The value is undefined when getter/setter are used. But we still handle the vers #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:41 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:41 ___ @@ -428,7 +428,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:127 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:127 ___ @@ -442,7 +442,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:128 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:128 ## Methods @@ -469,7 +469,7 @@ new value and the version number. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:205 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:205 ___ @@ -496,7 +496,7 @@ new value and the old value. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:214 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:214 ___ @@ -520,7 +520,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:45 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:45 ___ @@ -549,7 +549,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:74 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:74 ___ @@ -571,7 +571,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:90 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:90 ___ @@ -595,7 +595,7 @@ If a getter is defined this method returns an error and the value should be retr #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:268 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:268 ___ @@ -630,7 +630,7 @@ attributes. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:81 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:81 ___ @@ -659,7 +659,7 @@ internally. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:186 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:186 ___ @@ -686,7 +686,7 @@ the version number. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:238 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:238 ___ @@ -713,7 +713,7 @@ Helper Method to process the set of a value in a generic way. This method is use #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:181 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:181 ___ @@ -739,7 +739,7 @@ Remove an internal listener. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:209 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:209 ___ @@ -765,7 +765,7 @@ Remove an external listener. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:223 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:223 ___ @@ -795,7 +795,7 @@ Listeners are called when the value changes (internal listeners) or in any case #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:165 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:165 ___ @@ -821,7 +821,7 @@ Set Local is not allowed for fabric scoped attributes. Use setLocalForFabric ins #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:247 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:247 ___ @@ -848,7 +848,7 @@ Listeners are called when the value changes (internal listeners) or in any case #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:255 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:255 ___ @@ -876,7 +876,7 @@ we need to inject the fabric index into the value. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:243 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:243 ___ @@ -903,7 +903,7 @@ new value and the old value. This method is a convenient alias for addValueSetLi #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:219 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:219 ___ @@ -932,7 +932,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:193 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:193 ___ @@ -955,7 +955,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:200 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:200 ___ @@ -980,7 +980,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:262 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:262 ___ @@ -1004,4 +1004,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:44 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:44 diff --git a/docs/matter-node-ble.js/classes/internal_.FailSafeManager.md b/docs/matter-node-ble.js/classes/internal_.FailSafeManager.md index bacf2dba8e..3610e0f908 100644 --- a/docs/matter-node-ble.js/classes/internal_.FailSafeManager.md +++ b/docs/matter-node-ble.js/classes/internal_.FailSafeManager.md @@ -60,7 +60,7 @@ Class to Handle one FailSafe context. This is mainly used when adding (Commissio #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:23 +matter.js/dist/esm/common/FailSafeManager.d.ts:23 ## Properties @@ -70,7 +70,7 @@ matter.js/dist/cjs/common/FailSafeManager.d.ts:23 #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:14 +matter.js/dist/esm/common/FailSafeManager.d.ts:14 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:21 +matter.js/dist/esm/common/FailSafeManager.d.ts:21 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:13 +matter.js/dist/esm/common/FailSafeManager.d.ts:13 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:15 +matter.js/dist/esm/common/FailSafeManager.d.ts:15 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:17 +matter.js/dist/esm/common/FailSafeManager.d.ts:17 ___ @@ -120,7 +120,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:18 +matter.js/dist/esm/common/FailSafeManager.d.ts:18 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:22 +matter.js/dist/esm/common/FailSafeManager.d.ts:22 ___ @@ -140,7 +140,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:19 +matter.js/dist/esm/common/FailSafeManager.d.ts:19 ___ @@ -150,7 +150,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:16 +matter.js/dist/esm/common/FailSafeManager.d.ts:16 ___ @@ -162,7 +162,7 @@ Store required CLuster data when opening the FailSafe context to allow to restor #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:25 +matter.js/dist/esm/common/FailSafeManager.d.ts:25 ___ @@ -172,7 +172,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:20 +matter.js/dist/esm/common/FailSafeManager.d.ts:20 ## Accessors @@ -186,7 +186,7 @@ matter.js/dist/cjs/common/FailSafeManager.d.ts:20 #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:28 +matter.js/dist/esm/common/FailSafeManager.d.ts:28 ## Methods @@ -213,7 +213,7 @@ Build a new Fabric object for a new fabric for the "AddNoc" case of the Operatio #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:48 +matter.js/dist/esm/common/FailSafeManager.d.ts:48 ___ @@ -237,7 +237,7 @@ cluster. #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:46 +matter.js/dist/esm/common/FailSafeManager.d.ts:46 ___ @@ -253,7 +253,7 @@ Complete the FailSafe context. This is called when the commissioning is complete #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:34 +matter.js/dist/esm/common/FailSafeManager.d.ts:34 ___ @@ -277,7 +277,7 @@ validity checks. #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:39 +matter.js/dist/esm/common/FailSafeManager.d.ts:39 ___ @@ -293,7 +293,7 @@ Expire the FailSafe context. This is called by the timer and can also be called #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:32 +matter.js/dist/esm/common/FailSafeManager.d.ts:32 ___ @@ -316,7 +316,7 @@ Handle "Re-Arming" an existing FailSafe context to extend the timer, expire or f #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:30 +matter.js/dist/esm/common/FailSafeManager.d.ts:30 ___ @@ -338,7 +338,7 @@ Restore Cluster data when the FailSafe context expired. #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:27 +matter.js/dist/esm/common/FailSafeManager.d.ts:27 ___ @@ -360,4 +360,4 @@ Handles adding a trusted root certificate from Operational Credentials cluster. #### Defined in -matter.js/dist/cjs/common/FailSafeManager.d.ts:41 +matter.js/dist/esm/common/FailSafeManager.d.ts:41 diff --git a/docs/matter-node-ble.js/classes/internal_.FixedAttributeServer.md b/docs/matter-node-ble.js/classes/internal_.FixedAttributeServer.md index 0a2e63ed98..09869946e7 100644 --- a/docs/matter-node-ble.js/classes/internal_.FixedAttributeServer.md +++ b/docs/matter-node-ble.js/classes/internal_.FixedAttributeServer.md @@ -88,7 +88,7 @@ Attribute server types. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:60 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:60 ## Properties @@ -102,7 +102,7 @@ matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:60 #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:37 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:37 ___ @@ -116,7 +116,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:42 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:42 ___ @@ -134,7 +134,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:57 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:57 ___ @@ -160,7 +160,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:59 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:59 ___ @@ -174,7 +174,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:31 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:31 ___ @@ -184,7 +184,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:58 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:58 ___ @@ -198,7 +198,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:35 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:35 ___ @@ -212,7 +212,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:34 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:34 ___ @@ -226,7 +226,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:32 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:32 ___ @@ -240,7 +240,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:36 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:36 ___ @@ -254,7 +254,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:33 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:33 ___ @@ -270,7 +270,7 @@ The value is undefined when getter/setter are used. But we still handle the vers #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:41 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:41 ## Methods @@ -293,7 +293,7 @@ new value and the version number. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:101 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:101 ___ @@ -316,7 +316,7 @@ new value and the old value. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:110 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:110 ___ @@ -340,7 +340,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:45 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:45 ___ @@ -365,7 +365,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:74 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:74 ___ @@ -383,7 +383,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:90 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:90 ___ @@ -414,7 +414,7 @@ attributes. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:81 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:81 ___ @@ -442,7 +442,7 @@ If a getter or setter is defined the value must be undefined The version number #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:96 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:96 ___ @@ -464,7 +464,7 @@ Remove an internal listener. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:105 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:105 ___ @@ -486,7 +486,7 @@ Remove an external listener. #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:119 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:119 ___ @@ -509,7 +509,7 @@ new value and the old value. This method is a convenient alias for addValueSetLi #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:115 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:115 ___ @@ -533,4 +533,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:44 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:44 diff --git a/docs/matter-node-ble.js/classes/internal_.InteractionClient.md b/docs/matter-node-ble.js/classes/internal_.InteractionClient.md index aaa9394310..bfe369d85f 100644 --- a/docs/matter-node-ble.js/classes/internal_.InteractionClient.md +++ b/docs/matter-node-ble.js/classes/internal_.InteractionClient.md @@ -13,10 +13,13 @@ ### Properties - [exchangeProvider](internal_.InteractionClient.md#exchangeprovider) +- [nodeId](internal_.InteractionClient.md#nodeid) +- [ownSubscriptionIds](internal_.InteractionClient.md#ownsubscriptionids) - [processReadRequest](internal_.InteractionClient.md#processreadrequest) +- [registerSubscriptionUpdateTimer](internal_.InteractionClient.md#registersubscriptionupdatetimer) - [subscribedClusterDataVersions](internal_.InteractionClient.md#subscribedclusterdataversions) - [subscribedLocalValues](internal_.InteractionClient.md#subscribedlocalvalues) -- [subscriptionListeners](internal_.InteractionClient.md#subscriptionlisteners) +- [subscriptionClient](internal_.InteractionClient.md#subscriptionclient) - [withMessenger](internal_.InteractionClient.md#withmessenger) ### Accessors @@ -25,6 +28,7 @@ ### Methods +- [close](internal_.InteractionClient.md#close) - [getAllAttributes](internal_.InteractionClient.md#getallattributes) - [getAllAttributesAndEvents](internal_.InteractionClient.md#getallattributesandevents) - [getAllEvents](internal_.InteractionClient.md#getallevents) @@ -36,6 +40,8 @@ - [getMultipleEvents](internal_.InteractionClient.md#getmultipleevents) - [invoke](internal_.InteractionClient.md#invoke) - [invokeWithSuppressedResponse](internal_.InteractionClient.md#invokewithsuppressedresponse) +- [registerSubscriptionListener](internal_.InteractionClient.md#registersubscriptionlistener) +- [removeSubscription](internal_.InteractionClient.md#removesubscription) - [setAttribute](internal_.InteractionClient.md#setattribute) - [setMultipleAttributes](internal_.InteractionClient.md#setmultipleattributes) - [subscribeAllAttributesAndEvents](internal_.InteractionClient.md#subscribeallattributesandevents) @@ -47,17 +53,18 @@ ### constructor -• **new InteractionClient**(`exchangeProvider`) +• **new InteractionClient**(`exchangeProvider`, `nodeId`) #### Parameters | Name | Type | | :------ | :------ | | `exchangeProvider` | [`ExchangeProvider`](internal_.ExchangeProvider.md) | +| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:41 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:50 ## Properties @@ -67,7 +74,27 @@ matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:41 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:37 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:44 + +___ + +### nodeId + +• `Readonly` **nodeId**: [`NodeId`](../modules/internal_.md#nodeid) + +#### Defined in + +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:45 + +___ + +### ownSubscriptionIds + +• `Private` `Readonly` **ownSubscriptionIds**: `any` + +#### Defined in + +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:48 ___ @@ -77,7 +104,17 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:134 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:145 + +___ + +### registerSubscriptionUpdateTimer + +• `Private` **registerSubscriptionUpdateTimer**: `any` + +#### Defined in + +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:260 ___ @@ -87,7 +124,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:40 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:47 ___ @@ -97,17 +134,17 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:39 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:46 ___ -### subscriptionListeners +### subscriptionClient -• `Private` `Readonly` **subscriptionListeners**: `any` +• `Private` `Readonly` **subscriptionClient**: `any` #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:38 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:49 ___ @@ -117,7 +154,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:244 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:259 ## Accessors @@ -131,10 +168,24 @@ matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:244 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:245 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:262 ## Methods +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:261 + +___ + ### getAllAttributes ▸ **getAllAttributes**(`options?`): `Promise`<[`DecodedAttributeReportValue`](../modules/internal_.md#decodedattributereportvalue)<`any`\>[]\> @@ -153,7 +204,7 @@ matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:245 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:42 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:53 ___ @@ -176,7 +227,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:54 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:65 ___ @@ -198,7 +249,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:50 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:61 ___ @@ -229,7 +280,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:110 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:121 ___ @@ -260,7 +311,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:117 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:128 ___ @@ -292,7 +343,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:127 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:138 ___ @@ -315,7 +366,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:66 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:77 ___ @@ -340,7 +391,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:88 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:99 ___ @@ -363,7 +414,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:79 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:90 ___ @@ -396,7 +447,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:227 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:242 ___ @@ -428,7 +479,48 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:236 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:251 + +___ + +### registerSubscriptionListener + +▸ **registerSubscriptionListener**(`subscriptionId`, `listener`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | +| `listener` | (`dataReport`: [`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `attributeReports`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `attributeData`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `data`: [`FieldType`](../interfaces/internal_.FieldType.md)<[`TlvStream`](../modules/internal_.md#tlvstream)\> ; `dataVersion`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`number`\> ; `path`: [`FieldType`](../interfaces/internal_.FieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`AttributeId`](../modules/internal_.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`ClusterId`](../modules/internal_.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`EndpointNumber`](../modules/internal_.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`NodeId`](../modules/internal_.md#nodeid)\> }\>\> }\>\> ; `attributeStatus`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/internal_.FieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`AttributeId`](../modules/internal_.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`ClusterId`](../modules/internal_.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`EndpointNumber`](../modules/internal_.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`NodeId`](../modules/internal_.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/internal_.FieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`StatusCode`](../enums/internal_.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`StatusCode`](../enums/internal_.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `eventReports`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `eventData`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `data`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`TlvStream`](../modules/internal_.md#tlvstream)\> ; `deltaEpochTimestamp`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`number` \| `bigint`\> ; `deltaSystemTimestamp`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`number` \| `bigint`\> ; `epochTimestamp`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`number` \| `bigint`\> ; `eventNumber`: [`FieldType`](../interfaces/internal_.FieldType.md)<`number` \| `bigint`\> ; `path`: [`FieldType`](../interfaces/internal_.FieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`ClusterId`](../modules/internal_.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`EndpointNumber`](../modules/internal_.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`EventId`](../modules/internal_.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`NodeId`](../modules/internal_.md#nodeid)\> }\>\> ; `priority`: [`FieldType`](../interfaces/internal_.FieldType.md)<[`EventPriority`](../enums/internal_.EventPriority.md)\> ; `systemTimestamp`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`number` \| `bigint`\> }\>\> ; `eventStatus`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/internal_.FieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`ClusterId`](../modules/internal_.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`EndpointNumber`](../modules/internal_.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`EventId`](../modules/internal_.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`NodeId`](../modules/internal_.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/internal_.FieldType.md)<[`TypeFromFields`](../modules/internal_.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`StatusCode`](../enums/internal_.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<[`StatusCode`](../enums/internal_.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `interactionModelRevision`: [`FieldType`](../interfaces/internal_.FieldType.md)<`number`\> ; `moreChunkedMessages`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`boolean`\> ; `subscriptionId`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`number`\> ; `suppressResponse`: [`OptionalFieldType`](../interfaces/internal_.OptionalFieldType.md)<`boolean`\> }\>) => `void` | + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:51 + +___ + +### removeSubscription + +▸ **removeSubscription**(`subscriptionId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:52 ___ @@ -463,7 +555,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:135 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:146 ___ @@ -487,7 +579,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:147 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:158 ___ @@ -509,6 +601,7 @@ ___ | `options.keepSubscriptions?` | `boolean` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/internal_.md#timercallback) | #### Returns @@ -516,7 +609,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:181 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:194 ___ @@ -544,6 +637,7 @@ ___ | `options.listener?` | (`value`: [`AttributeJsType`](../modules/internal_.md#attributejstype)<`A`\>, `version`: `number`) => `void` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/internal_.md#timercallback) | #### Returns @@ -551,7 +645,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:159 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:170 ___ @@ -580,6 +674,7 @@ ___ | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | | `options.minimumEventNumber?` | `number` \| `bigint` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/internal_.md#timercallback) | #### Returns @@ -587,7 +682,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:170 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:182 ___ @@ -610,6 +705,7 @@ ___ | `options.keepSubscriptions?` | `boolean` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/internal_.md#timercallback) | #### Returns @@ -617,4 +713,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:199 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:213 diff --git a/docs/matter-node-ble.js/classes/internal_.InteractionEndpointStructure.md b/docs/matter-node-ble.js/classes/internal_.InteractionEndpointStructure.md index f3b249ef55..67d743079f 100644 --- a/docs/matter-node-ble.js/classes/internal_.InteractionEndpointStructure.md +++ b/docs/matter-node-ble.js/classes/internal_.InteractionEndpointStructure.md @@ -60,7 +60,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:23 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:23 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:22 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:22 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:27 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:27 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:26 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:26 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:21 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:21 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:25 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:25 ___ @@ -120,7 +120,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:24 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:24 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:31 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:31 ___ @@ -140,7 +140,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:32 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:32 ## Methods @@ -154,7 +154,7 @@ matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:32 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:28 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:28 ___ @@ -168,7 +168,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:29 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:29 ___ @@ -190,7 +190,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:42 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:42 ___ @@ -211,7 +211,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:48 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:48 ___ @@ -232,7 +232,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:40 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:40 ___ @@ -254,7 +254,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:46 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:46 ___ @@ -274,7 +274,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:50 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:50 ___ @@ -294,7 +294,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:38 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:38 ___ @@ -316,7 +316,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:44 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:44 ___ @@ -336,7 +336,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:49 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:49 ___ @@ -358,7 +358,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:43 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:43 ___ @@ -379,7 +379,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:41 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:41 ___ @@ -401,7 +401,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:47 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:47 ___ @@ -421,7 +421,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:39 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:39 ___ @@ -443,7 +443,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:45 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:45 ___ @@ -463,7 +463,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:30 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:30 ___ @@ -483,7 +483,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:35 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:35 ___ @@ -503,7 +503,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:37 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:37 ___ @@ -523,7 +523,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:36 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:36 ___ @@ -547,7 +547,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:34 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:34 ___ @@ -567,4 +567,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionEndpointStructure.d.ts:33 +matter.js/dist/esm/protocol/interaction/InteractionEndpointStructure.d.ts:33 diff --git a/docs/matter-node-ble.js/classes/internal_.InteractionMessenger.md b/docs/matter-node-ble.js/classes/internal_.InteractionMessenger.md index 381a7314a6..815bd4e7c0 100644 --- a/docs/matter-node-ble.js/classes/internal_.InteractionMessenger.md +++ b/docs/matter-node-ble.js/classes/internal_.InteractionMessenger.md @@ -56,7 +56,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:45 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:45 ## Properties @@ -66,7 +66,7 @@ matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:45 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:44 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:44 ## Methods @@ -80,7 +80,7 @@ matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:44 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:50 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:50 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:52 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:52 ___ @@ -114,7 +114,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:49 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:49 ___ @@ -136,7 +136,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:46 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:46 ___ @@ -156,7 +156,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:47 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:47 ___ @@ -176,7 +176,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:51 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:51 ___ @@ -190,4 +190,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:48 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:48 diff --git a/docs/matter-node-ble.js/classes/internal_.InteractionServerMessenger.md b/docs/matter-node-ble.js/classes/internal_.InteractionServerMessenger.md index 286d38c026..7b1fd0440b 100644 --- a/docs/matter-node-ble.js/classes/internal_.InteractionServerMessenger.md +++ b/docs/matter-node-ble.js/classes/internal_.InteractionServerMessenger.md @@ -51,7 +51,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:45 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:45 ## Properties @@ -65,7 +65,7 @@ matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:45 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:44 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:44 ## Methods @@ -83,7 +83,7 @@ matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:44 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:50 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:50 ___ @@ -101,7 +101,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:52 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:52 ___ @@ -125,7 +125,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:55 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:55 ___ @@ -149,7 +149,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:49 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:49 ___ @@ -175,7 +175,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:46 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:46 ___ @@ -198,7 +198,7 @@ messages and send them out based on the size. #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:60 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:60 ___ @@ -218,7 +218,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:61 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:61 ___ @@ -242,7 +242,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:47 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:47 ___ @@ -266,7 +266,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:51 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:51 ___ @@ -284,4 +284,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionMessenger.d.ts:48 +matter.js/dist/esm/protocol/interaction/InteractionMessenger.d.ts:48 diff --git a/docs/matter-node-ble.js/classes/internal_.MatterController.md b/docs/matter-node-ble.js/classes/internal_.MatterController.md index b85bf37678..bd62867afa 100644 --- a/docs/matter-node-ble.js/classes/internal_.MatterController.md +++ b/docs/matter-node-ble.js/classes/internal_.MatterController.md @@ -12,82 +12,109 @@ ### Properties +- [adminVendorId](internal_.MatterController.md#adminvendorid) +- [bleScanner](internal_.MatterController.md#blescanner) - [caseClient](internal_.MatterController.md#caseclient) - [certificateManager](internal_.MatterController.md#certificatemanager) - [channelManager](internal_.MatterController.md#channelmanager) - [commissionDevice](internal_.MatterController.md#commissiondevice) -- [commissioningOptions](internal_.MatterController.md#commissioningoptions) +- [commissionedNodes](internal_.MatterController.md#commissionednodes) +- [connectOrDiscoverNode](internal_.MatterController.md#connectordiscovernode) - [controllerStorage](internal_.MatterController.md#controllerstorage) -- [discoverDeviceAddressesByIdentifier](internal_.MatterController.md#discoverdeviceaddressesbyidentifier) - [exchangeManager](internal_.MatterController.md#exchangemanager) - [fabric](internal_.MatterController.md#fabric) +- [getLastOperationalAddress](internal_.MatterController.md#getlastoperationaladdress) - [initializePaseSecureChannel](internal_.MatterController.md#initializepasesecurechannel) - [mdnsScanner](internal_.MatterController.md#mdnsscanner) - [netInterfaceBle](internal_.MatterController.md#netinterfaceble) - [netInterfaceIpv4](internal_.MatterController.md#netinterfaceipv4) - [netInterfaceIpv6](internal_.MatterController.md#netinterfaceipv6) -- [operationalServerAddress](internal_.MatterController.md#operationalserveraddress) +- [pair](internal_.MatterController.md#pair) - [paseClient](internal_.MatterController.md#paseclient) +- [reconnectLastKnownAddress](internal_.MatterController.md#reconnectlastknownaddress) +- [resume](internal_.MatterController.md#resume) - [sessionClosedCallback](internal_.MatterController.md#sessionclosedcallback) - [sessionManager](internal_.MatterController.md#sessionmanager) +- [setOperationalServerAddress](internal_.MatterController.md#setoperationalserveraddress) - [storage](internal_.MatterController.md#storage) +- [storeCommisionedNodes](internal_.MatterController.md#storecommisionednodes) + +### Accessors + +- [nodeId](internal_.MatterController.md#nodeid) ### Methods - [addTransportInterface](internal_.MatterController.md#addtransportinterface) - [announce](internal_.MatterController.md#announce) - [close](internal_.MatterController.md#close) +- [collectScanners](internal_.MatterController.md#collectscanners) - [commission](internal_.MatterController.md#commission) -- [commissionViaBle](internal_.MatterController.md#commissionviable) - [connect](internal_.MatterController.md#connect) - [createSecureSession](internal_.MatterController.md#createsecuresession) +- [disconnect](internal_.MatterController.md#disconnect) - [findResumptionRecordByNodeId](internal_.MatterController.md#findresumptionrecordbynodeid) - [getActiveSessionInformation](internal_.MatterController.md#getactivesessioninformation) -- [getFabric](internal_.MatterController.md#getfabric) +- [getCommissionedNodes](internal_.MatterController.md#getcommissionednodes) - [getNextAvailableSessionId](internal_.MatterController.md#getnextavailablesessionid) -- [getOperationalServerAddress](internal_.MatterController.md#getoperationalserveraddress) - [getResumptionRecord](internal_.MatterController.md#getresumptionrecord) - [isCommissioned](internal_.MatterController.md#iscommissioned) -- [iterateServerAddresses](internal_.MatterController.md#iterateserveraddresses) -- [pair](internal_.MatterController.md#pair) -- [resume](internal_.MatterController.md#resume) +- [removeNode](internal_.MatterController.md#removenode) - [saveResumptionRecord](internal_.MatterController.md#saveresumptionrecord) -- [setOperationalServerAddress](internal_.MatterController.md#setoperationalserveraddress) - [create](internal_.MatterController.md#create) ## Constructors ### constructor -• **new MatterController**(`mdnsScanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `certificateManager`, `fabric`, `storage`, `operationalServerAddress?`, `commissioningOptions?`, `sessionClosedCallback?`) +• **new MatterController**(`mdnsScanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `certificateManager`, `fabric`, `storage`, `adminVendorId`, `sessionClosedCallback?`) #### Parameters | Name | Type | | :------ | :------ | -| `mdnsScanner` | [`Scanner`](../interfaces/internal_.Scanner.md) | +| `mdnsScanner` | [`MdnsScanner`](internal_.MdnsScanner.md) | | `netInterfaceIpv4` | `undefined` \| [`NetInterface`](../interfaces/internal_.NetInterface.md) | | `netInterfaceIpv6` | [`NetInterface`](../interfaces/internal_.NetInterface.md) | | `certificateManager` | [`RootCertificateManager`](internal_.RootCertificateManager.md) | | `fabric` | [`Fabric`](internal_.Fabric.md) | | `storage` | [`StorageContext`](internal_.StorageContext.md) | -| `operationalServerAddress?` | [`ServerAddressIp`](../modules/internal_.md#serveraddressip) | -| `commissioningOptions?` | [`CommissioningOptions`](../modules/internal_.md#commissioningoptions) | +| `adminVendorId` | [`VendorId`](../modules/internal_.md#vendorid) | | `sessionClosedCallback?` | (`peerNodeId`: [`NodeId`](../modules/internal_.md#nodeid)) => `void` | #### Defined in -matter.js/dist/cjs/MatterController.d.ts:55 +matter.js/dist/esm/MatterController.d.ts:66 ## Properties +### adminVendorId + +• `Private` `Readonly` **adminVendorId**: `any` + +#### Defined in + +matter.js/dist/esm/MatterController.d.ts:54 + +___ + +### bleScanner + +• `Private` **bleScanner**: `any` + +#### Defined in + +matter.js/dist/esm/MatterController.d.ts:64 + +___ + ### caseClient • `Private` `Readonly` **caseClient**: `any` #### Defined in -matter.js/dist/cjs/MatterController.d.ts:51 +matter.js/dist/esm/MatterController.d.ts:61 ___ @@ -97,7 +124,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:41 +matter.js/dist/esm/MatterController.d.ts:51 ___ @@ -107,7 +134,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:48 +matter.js/dist/esm/MatterController.d.ts:58 ___ @@ -120,40 +147,37 @@ success. #### Defined in -matter.js/dist/cjs/MatterController.d.ts:81 +matter.js/dist/esm/MatterController.d.ts:90 ___ -### commissioningOptions +### commissionedNodes -• `Private` `Readonly` **commissioningOptions**: `any` +• `Private` `Readonly` **commissionedNodes**: `any` #### Defined in -matter.js/dist/cjs/MatterController.d.ts:53 +matter.js/dist/esm/MatterController.d.ts:65 ___ -### controllerStorage +### connectOrDiscoverNode -• `Private` `Readonly` **controllerStorage**: `any` +• `Private` **connectOrDiscoverNode**: `any` #### Defined in -matter.js/dist/cjs/MatterController.d.ts:52 +matter.js/dist/esm/MatterController.d.ts:92 ___ -### discoverDeviceAddressesByIdentifier - -• `Private` **discoverDeviceAddressesByIdentifier**: `any` +### controllerStorage -Discovers devices by a provided identifier. It returns after the timeout or if at least one device was found. -The method returns a list of addresses of the discovered devices. +• `Private` `Readonly` **controllerStorage**: `any` #### Defined in -matter.js/dist/cjs/MatterController.d.ts:61 +matter.js/dist/esm/MatterController.d.ts:62 ___ @@ -163,7 +187,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:49 +matter.js/dist/esm/MatterController.d.ts:59 ___ @@ -173,7 +197,17 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:42 +matter.js/dist/esm/MatterController.d.ts:52 + +___ + +### getLastOperationalAddress + +• `Private` **getLastOperationalAddress**: `any` + +#### Defined in + +matter.js/dist/esm/MatterController.d.ts:105 ___ @@ -187,7 +221,7 @@ is wrong. #### Defined in -matter.js/dist/cjs/MatterController.d.ts:76 +matter.js/dist/esm/MatterController.d.ts:85 ___ @@ -197,7 +231,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:38 +matter.js/dist/esm/MatterController.d.ts:48 ___ @@ -207,7 +241,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:54 +matter.js/dist/esm/MatterController.d.ts:63 ___ @@ -217,7 +251,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:39 +matter.js/dist/esm/MatterController.d.ts:49 ___ @@ -227,17 +261,19 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:40 +matter.js/dist/esm/MatterController.d.ts:50 ___ -### operationalServerAddress +### pair -• `Optional` **operationalServerAddress**: [`ServerAddressIp`](../modules/internal_.md#serveraddressip) +• `Private` **pair**: `any` + +Pair with an operational device (already commissioned) and establish a CASE session. #### Defined in -matter.js/dist/cjs/MatterController.d.ts:44 +matter.js/dist/esm/MatterController.d.ts:101 ___ @@ -247,7 +283,32 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:50 +matter.js/dist/esm/MatterController.d.ts:60 + +___ + +### reconnectLastKnownAddress + +• `Private` **reconnectLastKnownAddress**: `any` + +#### Defined in + +matter.js/dist/esm/MatterController.d.ts:91 + +___ + +### resume + +• `Private` **resume**: `any` + +Resume a device connection and establish a CASE session that was previously paired with the controller. This +method will try to connect to the device using the previously used server address (if set). If that fails, the +device is discovered again using its operational instance details. +It returns the operational MessageChannel on success. + +#### Defined in + +matter.js/dist/esm/MatterController.d.ts:99 ___ @@ -257,7 +318,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:45 +matter.js/dist/esm/MatterController.d.ts:55 ___ @@ -267,7 +328,17 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:47 +matter.js/dist/esm/MatterController.d.ts:57 + +___ + +### setOperationalServerAddress + +• `Private` **setOperationalServerAddress**: `any` + +#### Defined in + +matter.js/dist/esm/MatterController.d.ts:104 ___ @@ -277,7 +348,31 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:43 +matter.js/dist/esm/MatterController.d.ts:53 + +___ + +### storeCommisionedNodes + +• `Private` **storeCommisionedNodes**: `any` + +#### Defined in + +matter.js/dist/esm/MatterController.d.ts:106 + +## Accessors + +### nodeId + +• `get` **nodeId**(): [`NodeId`](../modules/internal_.md#nodeid) + +#### Returns + +[`NodeId`](../modules/internal_.md#nodeid) + +#### Defined in + +matter.js/dist/esm/MatterController.d.ts:67 ## Methods @@ -297,7 +392,7 @@ matter.js/dist/cjs/MatterController.d.ts:43 #### Defined in -matter.js/dist/cjs/MatterController.d.ts:56 +matter.js/dist/esm/MatterController.d.ts:68 ___ @@ -311,7 +406,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:115 +matter.js/dist/esm/MatterController.d.ts:117 ___ @@ -325,50 +420,45 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:116 +matter.js/dist/esm/MatterController.d.ts:118 ___ -### commission +### collectScanners -▸ **commission**(`identifierData`, `passCode`, `timeoutSeconds?`, `knownAddress?`): `Promise`<[`NodeId`](../modules/internal_.md#nodeid)\> - -Commission a device by its identifier and the Passcode. If a known address is provided this is tried first -before discovering devices in the network. If multiple addresses or devices are found, they are tried all after -each other. It returns the NodeId of the commissioned device. -If it throws an PairRetransmissionLimitReachedError that means that no found device responded to the pairing -request or the passode did not match to any discovered device/address. +▸ **collectScanners**(`discoveryCapabilities?`): [`Scanner`](../interfaces/internal_.Scanner.md)[] #### Parameters | Name | Type | | :------ | :------ | -| `identifierData` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | -| `passCode` | `number` | -| `timeoutSeconds?` | `number` | -| `knownAddress?` | [`ServerAddress`](../modules/internal_.md#serveraddress) | +| `discoveryCapabilities?` | [`TypeFromPartialBitSchema`](../modules/internal_.md#typefrompartialbitschema)<{ `ble`: [`BitFlag`](../modules/internal_.md#bitflag-1) ; `onIpNetwork`: [`BitFlag`](../modules/internal_.md#bitflag-1) ; `softAccessPoint`: [`BitFlag`](../modules/internal_.md#bitflag-1) }\> | #### Returns -`Promise`<[`NodeId`](../modules/internal_.md#nodeid)\> +[`Scanner`](../interfaces/internal_.Scanner.md)[] #### Defined in -matter.js/dist/cjs/MatterController.d.ts:70 +matter.js/dist/esm/MatterController.d.ts:69 ___ -### commissionViaBle +### commission -▸ **commissionViaBle**(`identifierData`, `passCode`, `timeoutSeconds?`): `Promise`<[`NodeId`](../modules/internal_.md#nodeid)\> +▸ **commission**(`options`): `Promise`<[`NodeId`](../modules/internal_.md#nodeid)\> + +Commission a device by its identifier and the Passcode. If a known address is provided this is tried first +before discovering devices in the network. If multiple addresses or devices are found, they are tried all after +each other. It returns the NodeId of the commissioned device. +If it throws an PairRetransmissionLimitReachedError that means that no found device responded to the pairing +request or the passode did not match to any discovered device/address. #### Parameters | Name | Type | | :------ | :------ | -| `identifierData` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | -| `passCode` | `number` | -| `timeoutSeconds?` | `number` | +| `options` | [`NodeCommissioningOptions`](../modules/internal_.md#nodecommissioningoptions) | #### Returns @@ -376,13 +466,13 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:62 +matter.js/dist/esm/MatterController.d.ts:77 ___ ### connect -▸ **connect**(`nodeId`, `timeoutSeconds?`): `Promise`<[`InteractionClient`](internal_.InteractionClient.md)\> +▸ **connect**(`peerNodeId`, `timeoutSeconds?`): `Promise`<[`InteractionClient`](internal_.InteractionClient.md)\> Connect to the device by opening a channel and creating a new CASE session if necessary. Returns a InteractionClient on success. @@ -391,7 +481,7 @@ Returns a InteractionClient on success. | Name | Type | | :------ | :------ | -| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | +| `peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | | `timeoutSeconds?` | `number` | #### Returns @@ -400,13 +490,13 @@ Returns a InteractionClient on success. #### Defined in -matter.js/dist/cjs/MatterController.d.ts:108 +matter.js/dist/esm/MatterController.d.ts:111 ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](internal_.SecureSession.md)<[`MatterController`](internal_.MatterController.md)\>\> +▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`): `Promise`<[`SecureSession`](internal_.SecureSession.md)<[`MatterController`](internal_.MatterController.md)\>\> #### Parameters @@ -420,8 +510,8 @@ ___ | `salt` | `Uint8Array` | | `isInitiator` | `boolean` | | `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `idleRetransmissionTimeoutMs?` | `number` | +| `activeRetransmissionTimeoutMs?` | `number` | #### Returns @@ -429,13 +519,13 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:111 +matter.js/dist/esm/MatterController.d.ts:113 ___ -### findResumptionRecordByNodeId +### disconnect -▸ **findResumptionRecordByNodeId**(`nodeId`): `undefined` \| [`ResumptionRecord`](../interfaces/internal_.ResumptionRecord.md) +▸ **disconnect**(`nodeId`): `Promise`<`void`\> #### Parameters @@ -445,67 +535,73 @@ ___ #### Returns -`undefined` \| [`ResumptionRecord`](../interfaces/internal_.ResumptionRecord.md) +`Promise`<`void`\> #### Defined in -matter.js/dist/cjs/MatterController.d.ts:113 +matter.js/dist/esm/MatterController.d.ts:78 ___ -### getActiveSessionInformation +### findResumptionRecordByNodeId -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] +▸ **findResumptionRecordByNodeId**(`nodeId`): `undefined` \| [`ResumptionRecord`](../interfaces/internal_.ResumptionRecord.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] +`undefined` \| [`ResumptionRecord`](../interfaces/internal_.ResumptionRecord.md) #### Defined in -matter.js/dist/cjs/MatterController.d.ts:117 +matter.js/dist/esm/MatterController.d.ts:115 ___ -### getFabric +### getActiveSessionInformation -▸ **getFabric**(): [`Fabric`](internal_.Fabric.md) +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/internal_.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] #### Returns -[`Fabric`](internal_.Fabric.md) +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/internal_.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -matter.js/dist/cjs/MatterController.d.ts:110 +matter.js/dist/esm/MatterController.d.ts:119 ___ -### getNextAvailableSessionId +### getCommissionedNodes -▸ **getNextAvailableSessionId**(): `number` +▸ **getCommissionedNodes**(): [`NodeId`](../modules/internal_.md#nodeid)[] #### Returns -`number` +[`NodeId`](../modules/internal_.md#nodeid)[] #### Defined in -matter.js/dist/cjs/MatterController.d.ts:109 +matter.js/dist/esm/MatterController.d.ts:103 ___ -### getOperationalServerAddress +### getNextAvailableSessionId -▸ **getOperationalServerAddress**(): `undefined` \| [`ServerAddressIp`](../modules/internal_.md#serveraddressip) +▸ **getNextAvailableSessionId**(): `number` #### Returns -`undefined` \| [`ServerAddressIp`](../modules/internal_.md#serveraddressip) +`number` #### Defined in -matter.js/dist/cjs/MatterController.d.ts:103 +matter.js/dist/esm/MatterController.d.ts:112 ___ @@ -525,107 +621,41 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:112 +matter.js/dist/esm/MatterController.d.ts:114 ___ ### isCommissioned -▸ **isCommissioned**(): ``false`` +▸ **isCommissioned**(): `boolean` #### Returns -``false`` +`boolean` #### Defined in -matter.js/dist/cjs/MatterController.d.ts:101 +matter.js/dist/esm/MatterController.d.ts:102 ___ -### iterateServerAddresses - -▸ **iterateServerAddresses**<`SA`, `T`, `E`\>(`servers`, `errorType`, `updateNetworkInterfaceFunc`, `func`, `lastKnownServer?`): `Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> - -Helper method to iterate through a list of server addresses and try to execute a method on each of them. If the -method throws a configurable error (or EHOSTUNREACH), the server address list is updated (to also add later -discovered addresses or devices) and then next server address is tried.The result of the first successful method -call is returned. The logic makes sure to only try each unique address (IP/port) once. - -#### Type parameters +### removeNode -| Name | Type | -| :------ | :------ | -| `SA` | extends [`ServerAddress`](../modules/internal_.md#serveraddress) | -| `T` | `T` | -| `E` | extends `Error` | +▸ **removeNode**(`nodeId`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `servers` | `SA`[] | -| `errorType` | [`ClassExtends`](../modules/internal_.md#classextends)<`E`\> | -| `updateNetworkInterfaceFunc` | () => `Promise`<`SA`[]\> | -| `func` | (`server`: `SA`) => `Promise`<`T`\> | -| `lastKnownServer?` | `SA` | - -#### Returns - -`Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> - -#### Defined in - -matter.js/dist/cjs/MatterController.d.ts:88 - -___ - -### pair - -▸ **pair**(`peerNodeId`, `operationalServerAddress`): `Promise`<[`MessageChannel`](internal_.MessageChannel.md)<[`MatterController`](internal_.MatterController.md)\>\> - -Pair with an operational device (already commissioned) and establish a CASE session. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | -| `operationalServerAddress` | [`ServerAddressIp`](../modules/internal_.md#serveraddressip) | - -#### Returns - -`Promise`<[`MessageChannel`](internal_.MessageChannel.md)<[`MatterController`](internal_.MatterController.md)\>\> - -#### Defined in - -matter.js/dist/cjs/MatterController.d.ts:100 - -___ - -### resume - -▸ **resume**(`peerNodeId`, `timeoutSeconds?`): `Promise`<[`MessageChannel`](internal_.MessageChannel.md)<[`MatterController`](internal_.MatterController.md)\>\> - -Resume a device connection and establish a CASE session that was previously paired with the controller. This -method will try to connect to the device using the previously used server address (if set). If that fails, the -device is discovered again using its operational instance details. -It returns the operational MessageChannel on success. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | -| `timeoutSeconds?` | `number` | +| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | #### Returns -`Promise`<[`MessageChannel`](internal_.MessageChannel.md)<[`MatterController`](internal_.MatterController.md)\>\> +`Promise`<`void`\> #### Defined in -matter.js/dist/cjs/MatterController.d.ts:98 +matter.js/dist/esm/MatterController.d.ts:79 ___ @@ -645,45 +675,26 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:114 - -___ - -### setOperationalServerAddress - -▸ **setOperationalServerAddress**(`address`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`ServerAddressIp`](../modules/internal_.md#serveraddressip) | - -#### Returns - -`void` - -#### Defined in - -matter.js/dist/cjs/MatterController.d.ts:102 +matter.js/dist/esm/MatterController.d.ts:116 ___ ### create -▸ `Static` **create**(`scanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `storage`, `operationalServerAddress?`, `commissioningOptions?`, `sessionClosedCallback?`): `Promise`<[`MatterController`](internal_.MatterController.md)\> +▸ `Static` **create**(`scanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `storage`, `sessionClosedCallback?`, `adminVendorId?`, `adminFabricId?`, `adminFabricIndex?`): `Promise`<[`MatterController`](internal_.MatterController.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `scanner` | [`Scanner`](../interfaces/internal_.Scanner.md) | +| `scanner` | [`MdnsScanner`](internal_.MdnsScanner.md) | | `netInterfaceIpv4` | `undefined` \| [`NetInterface`](../interfaces/internal_.NetInterface.md) | | `netInterfaceIpv6` | [`NetInterface`](../interfaces/internal_.NetInterface.md) | | `storage` | [`StorageContext`](internal_.StorageContext.md) | -| `operationalServerAddress?` | [`ServerAddressIp`](../modules/internal_.md#serveraddressip) | -| `commissioningOptions?` | [`CommissioningOptions`](../modules/internal_.md#commissioningoptions) | | `sessionClosedCallback?` | (`peerNodeId`: [`NodeId`](../modules/internal_.md#nodeid)) => `void` | +| `adminVendorId?` | [`VendorId`](../modules/internal_.md#vendorid) | +| `adminFabricId?` | [`FabricId`](../modules/internal_.md#fabricid) | +| `adminFabricIndex?` | [`FabricIndex`](../modules/internal_.md#fabricindex) | #### Returns @@ -691,4 +702,4 @@ ___ #### Defined in -matter.js/dist/cjs/MatterController.d.ts:46 +matter.js/dist/esm/MatterController.d.ts:56 diff --git a/docs/matter-node-ble.js/classes/internal_.MatterDevice.md b/docs/matter-node-ble.js/classes/internal_.MatterDevice.md index 763b487983..fb83c73fc8 100644 --- a/docs/matter-node-ble.js/classes/internal_.MatterDevice.md +++ b/docs/matter-node-ble.js/classes/internal_.MatterDevice.md @@ -19,7 +19,7 @@ - [announcementStartedTime](internal_.MatterDevice.md#announcementstartedtime) - [broadcasters](internal_.MatterDevice.md#broadcasters) - [channelManager](internal_.MatterDevice.md#channelmanager) -- [closeSession](internal_.MatterDevice.md#closesession) +- [commissioningChangedCallback](internal_.MatterDevice.md#commissioningchangedcallback) - [deviceName](internal_.MatterDevice.md#devicename) - [deviceType](internal_.MatterDevice.md#devicetype) - [discriminator](internal_.MatterDevice.md#discriminator) @@ -27,12 +27,12 @@ - [fabricManager](internal_.MatterDevice.md#fabricmanager) - [failSafeContext](internal_.MatterDevice.md#failsafecontext) - [failSafeExpired](internal_.MatterDevice.md#failsafeexpired) -- [initialCommissioningCallback](internal_.MatterDevice.md#initialcommissioningcallback) - [initialPasscode](internal_.MatterDevice.md#initialpasscode) - [isClosing](internal_.MatterDevice.md#isclosing) - [productId](internal_.MatterDevice.md#productid) - [scanners](internal_.MatterDevice.md#scanners) - [secureChannelProtocol](internal_.MatterDevice.md#securechannelprotocol) +- [sessionChangedCallback](internal_.MatterDevice.md#sessionchangedcallback) - [sessionManager](internal_.MatterDevice.md#sessionmanager) - [storage](internal_.MatterDevice.md#storage) - [transportInterfaces](internal_.MatterDevice.md#transportinterfaces) @@ -63,10 +63,11 @@ - [getFailSafeContext](internal_.MatterDevice.md#getfailsafecontext) - [getNextAvailableSessionId](internal_.MatterDevice.md#getnextavailablesessionid) - [getNextFabricIndex](internal_.MatterDevice.md#getnextfabricindex) +- [hasBroadcaster](internal_.MatterDevice.md#hasbroadcaster) +- [hasProtocolHandler](internal_.MatterDevice.md#hasprotocolhandler) - [initiateExchange](internal_.MatterDevice.md#initiateexchange) - [isCommissioned](internal_.MatterDevice.md#iscommissioned) - [isFailsafeArmed](internal_.MatterDevice.md#isfailsafearmed) -- [processSessionsToClose](internal_.MatterDevice.md#processsessionstoclose) - [removePaseSession](internal_.MatterDevice.md#removepasesession) - [saveResumptionRecord](internal_.MatterDevice.md#saveresumptionrecord) - [sendCommissionableAnnouncement](internal_.MatterDevice.md#sendcommissionableannouncement) @@ -80,7 +81,7 @@ ### constructor -• **new MatterDevice**(`deviceName`, `deviceType`, `vendorId`, `productId`, `discriminator`, `initialPasscode`, `storage`, `initialCommissioningCallback`) +• **new MatterDevice**(`deviceName`, `deviceType`, `vendorId`, `productId`, `discriminator`, `initialPasscode`, `storage`, `commissioningChangedCallback`, `sessionChangedCallback`) #### Parameters @@ -93,11 +94,12 @@ | `discriminator` | `number` | | `initialPasscode` | `number` | | `storage` | [`StorageContext`](internal_.StorageContext.md) | -| `initialCommissioningCallback` | () => `void` | +| `commissioningChangedCallback` | (`fabricIndex`: [`FabricIndex`](../modules/internal_.md#fabricindex)) => `void` | +| `sessionChangedCallback` | (`fabricIndex`: [`FabricIndex`](../modules/internal_.md#fabricindex)) => `void` | #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:53 +matter.js/dist/esm/MatterDevice.d.ts:54 ## Properties @@ -107,7 +109,7 @@ matter.js/dist/cjs/MatterDevice.d.ts:53 #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:48 +matter.js/dist/esm/MatterDevice.d.ts:49 ___ @@ -117,7 +119,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:47 +matter.js/dist/esm/MatterDevice.d.ts:48 ___ @@ -127,7 +129,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:61 +matter.js/dist/esm/MatterDevice.d.ts:64 ___ @@ -137,7 +139,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:49 +matter.js/dist/esm/MatterDevice.d.ts:50 ___ @@ -147,7 +149,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:50 +matter.js/dist/esm/MatterDevice.d.ts:51 ___ @@ -157,7 +159,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:40 +matter.js/dist/esm/MatterDevice.d.ts:41 ___ @@ -167,17 +169,17 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:44 +matter.js/dist/esm/MatterDevice.d.ts:45 ___ -### closeSession +### commissioningChangedCallback -• `Private` **closeSession**: `any` +• `Private` `Readonly` **commissioningChangedCallback**: `any` #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:76 +matter.js/dist/esm/MatterDevice.d.ts:38 ___ @@ -187,7 +189,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:31 +matter.js/dist/esm/MatterDevice.d.ts:31 ___ @@ -197,7 +199,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:32 +matter.js/dist/esm/MatterDevice.d.ts:32 ___ @@ -207,7 +209,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:35 +matter.js/dist/esm/MatterDevice.d.ts:35 ___ @@ -217,7 +219,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:45 +matter.js/dist/esm/MatterDevice.d.ts:46 ___ @@ -227,7 +229,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:42 +matter.js/dist/esm/MatterDevice.d.ts:43 ___ @@ -237,7 +239,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:52 +matter.js/dist/esm/MatterDevice.d.ts:53 ___ @@ -247,17 +249,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:78 - -___ - -### initialCommissioningCallback - -• `Private` `Readonly` **initialCommissioningCallback**: `any` - -#### Defined in - -matter.js/dist/cjs/MatterDevice.d.ts:38 +matter.js/dist/esm/MatterDevice.d.ts:79 ___ @@ -267,7 +259,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:36 +matter.js/dist/esm/MatterDevice.d.ts:36 ___ @@ -277,7 +269,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:51 +matter.js/dist/esm/MatterDevice.d.ts:52 ___ @@ -287,7 +279,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:34 +matter.js/dist/esm/MatterDevice.d.ts:34 ___ @@ -297,7 +289,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:39 +matter.js/dist/esm/MatterDevice.d.ts:40 ___ @@ -307,7 +299,17 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:46 +matter.js/dist/esm/MatterDevice.d.ts:47 + +___ + +### sessionChangedCallback + +• `Private` `Readonly` **sessionChangedCallback**: `any` + +#### Defined in + +matter.js/dist/esm/MatterDevice.d.ts:39 ___ @@ -317,7 +319,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:43 +matter.js/dist/esm/MatterDevice.d.ts:44 ___ @@ -327,7 +329,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:37 +matter.js/dist/esm/MatterDevice.d.ts:37 ___ @@ -337,7 +339,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:41 +matter.js/dist/esm/MatterDevice.d.ts:42 ___ @@ -347,7 +349,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:33 +matter.js/dist/esm/MatterDevice.d.ts:33 ## Methods @@ -367,7 +369,7 @@ matter.js/dist/cjs/MatterDevice.d.ts:33 #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:55 +matter.js/dist/esm/MatterDevice.d.ts:57 ___ @@ -387,7 +389,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:68 +matter.js/dist/esm/MatterDevice.d.ts:71 ___ @@ -407,7 +409,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:57 +matter.js/dist/esm/MatterDevice.d.ts:60 ___ @@ -427,7 +429,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:54 +matter.js/dist/esm/MatterDevice.d.ts:55 ___ @@ -447,7 +449,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:56 +matter.js/dist/esm/MatterDevice.d.ts:58 ___ @@ -467,7 +469,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:86 +matter.js/dist/esm/MatterDevice.d.ts:87 ___ @@ -489,7 +491,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:85 +matter.js/dist/esm/MatterDevice.d.ts:86 ___ @@ -509,7 +511,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:60 +matter.js/dist/esm/MatterDevice.d.ts:63 ___ @@ -532,7 +534,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:79 +matter.js/dist/esm/MatterDevice.d.ts:80 ___ @@ -552,7 +554,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:77 +matter.js/dist/esm/MatterDevice.d.ts:78 ___ @@ -566,13 +568,13 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:83 +matter.js/dist/esm/MatterDevice.d.ts:84 ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](internal_.SecureSession.md)<[`MatterDevice`](internal_.MatterDevice.md)\>\> +▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`): `Promise`<[`SecureSession`](internal_.SecureSession.md)<[`MatterDevice`](internal_.MatterDevice.md)\>\> #### Parameters @@ -586,8 +588,8 @@ ___ | `salt` | `Uint8Array` | | `isInitiator` | `boolean` | | `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `idleRetransmissionTimeoutMs?` | `number` | +| `activeRetransmissionTimeoutMs?` | `number` | #### Returns @@ -595,7 +597,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:64 +matter.js/dist/esm/MatterDevice.d.ts:67 ___ @@ -609,7 +611,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:87 +matter.js/dist/esm/MatterDevice.d.ts:88 ___ @@ -623,7 +625,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:88 +matter.js/dist/esm/MatterDevice.d.ts:89 ___ @@ -645,7 +647,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:89 +matter.js/dist/esm/MatterDevice.d.ts:90 ___ @@ -666,7 +668,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:65 +matter.js/dist/esm/MatterDevice.d.ts:68 ___ @@ -686,21 +688,21 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:72 +matter.js/dist/esm/MatterDevice.d.ts:75 ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/internal_.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/internal_.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:94 +matter.js/dist/esm/MatterDevice.d.ts:95 ___ @@ -720,7 +722,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:70 +matter.js/dist/esm/MatterDevice.d.ts:73 ___ @@ -734,7 +736,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:82 +matter.js/dist/esm/MatterDevice.d.ts:83 ___ @@ -748,7 +750,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:81 +matter.js/dist/esm/MatterDevice.d.ts:82 ___ @@ -762,7 +764,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:63 +matter.js/dist/esm/MatterDevice.d.ts:66 ___ @@ -776,35 +778,39 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:67 +matter.js/dist/esm/MatterDevice.d.ts:70 ___ -### initiateExchange +### hasBroadcaster -▸ **initiateExchange**(`fabric`, `nodeId`, `protocolId`): [`MessageExchange`](internal_.MessageExchange.md)<[`MatterDevice`](internal_.MatterDevice.md)\> +▸ **hasBroadcaster**(`broadcaster`): `boolean` #### Parameters | Name | Type | | :------ | :------ | -| `fabric` | [`Fabric`](internal_.Fabric.md) | -| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | -| `protocolId` | `number` | +| `broadcaster` | [`InstanceBroadcaster`](../interfaces/internal_.InstanceBroadcaster.md) | #### Returns -[`MessageExchange`](internal_.MessageExchange.md)<[`MatterDevice`](internal_.MatterDevice.md)\> +`boolean` #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:71 +matter.js/dist/esm/MatterDevice.d.ts:56 ___ -### isCommissioned +### hasProtocolHandler -▸ **isCommissioned**(): `boolean` +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | #### Returns @@ -812,13 +818,35 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:84 +matter.js/dist/esm/MatterDevice.d.ts:59 ___ -### isFailsafeArmed +### initiateExchange -▸ **isFailsafeArmed**(): `boolean` +▸ **initiateExchange**(`fabric`, `nodeId`, `protocolId`): [`MessageExchange`](internal_.MessageExchange.md)<[`MatterDevice`](internal_.MatterDevice.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](internal_.Fabric.md) | +| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | +| `protocolId` | `number` | + +#### Returns + +[`MessageExchange`](internal_.MessageExchange.md)<[`MatterDevice`](internal_.MatterDevice.md)\> + +#### Defined in + +matter.js/dist/esm/MatterDevice.d.ts:74 + +___ + +### isCommissioned + +▸ **isCommissioned**(): `boolean` #### Returns @@ -826,21 +854,21 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:80 +matter.js/dist/esm/MatterDevice.d.ts:85 ___ -### processSessionsToClose +### isFailsafeArmed -▸ **processSessionsToClose**(): `Promise`<`void`\> +▸ **isFailsafeArmed**(): `boolean` #### Returns -`Promise`<`void`\> +`boolean` #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:75 +matter.js/dist/esm/MatterDevice.d.ts:81 ___ @@ -854,7 +882,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:74 +matter.js/dist/esm/MatterDevice.d.ts:77 ___ @@ -874,7 +902,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:73 +matter.js/dist/esm/MatterDevice.d.ts:76 ___ @@ -895,7 +923,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:62 +matter.js/dist/esm/MatterDevice.d.ts:65 ___ @@ -916,7 +944,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:69 +matter.js/dist/esm/MatterDevice.d.ts:72 ___ @@ -930,7 +958,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:58 +matter.js/dist/esm/MatterDevice.d.ts:61 ___ @@ -944,7 +972,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:59 +matter.js/dist/esm/MatterDevice.d.ts:62 ___ @@ -958,7 +986,7 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:93 +matter.js/dist/esm/MatterDevice.d.ts:94 ___ @@ -978,4 +1006,4 @@ ___ #### Defined in -matter.js/dist/cjs/MatterDevice.d.ts:66 +matter.js/dist/esm/MatterDevice.d.ts:69 diff --git a/docs/matter-node-ble.js/classes/internal_.MdnsScanner.md b/docs/matter-node-ble.js/classes/internal_.MdnsScanner.md new file mode 100644 index 0000000000..3b75e87daf --- /dev/null +++ b/docs/matter-node-ble.js/classes/internal_.MdnsScanner.md @@ -0,0 +1,662 @@ +[@project-chip/matter-node-ble.js](../README.md) / [Exports](../modules.md) / [](../modules/internal_.md) / MdnsScanner + +# Class: MdnsScanner + +[](../modules/internal_.md).MdnsScanner + +This class implements the Scanner interface for a MDNS scanner via UDP messages in a IP based network. +It sends out queries to discover various types of Matter device types and listens for announcements. + +## Implements + +- [`Scanner`](../interfaces/internal_.Scanner.md) + +## Table of contents + +### Constructors + +- [constructor](internal_.MdnsScanner.md#constructor) + +### Properties + +- [activeAnnounceQueries](internal_.MdnsScanner.md#activeannouncequeries) +- [buildCommissionableQueryIdentifier](internal_.MdnsScanner.md#buildcommissionablequeryidentifier) +- [closing](internal_.MdnsScanner.md#closing) +- [commissionableDeviceRecords](internal_.MdnsScanner.md#commissionabledevicerecords) +- [createOperationalMatterQName](internal_.MdnsScanner.md#createoperationalmatterqname) +- [enableIpv4](internal_.MdnsScanner.md#enableipv4) +- [expire](internal_.MdnsScanner.md#expire) +- [extractInstanceId](internal_.MdnsScanner.md#extractinstanceid) +- [findCommissionableQueryIdentifier](internal_.MdnsScanner.md#findcommissionablequeryidentifier) +- [finishWaiter](internal_.MdnsScanner.md#finishwaiter) +- [getActiveQueryEarlierAnswers](internal_.MdnsScanner.md#getactivequeryearlieranswers) +- [getCommissionableDeviceRecords](internal_.MdnsScanner.md#getcommissionabledevicerecords) +- [getCommissionableQueryRecords](internal_.MdnsScanner.md#getcommissionablequeryrecords) +- [getOperationalDeviceRecords](internal_.MdnsScanner.md#getoperationaldevicerecords) +- [handleCommissionableRecords](internal_.MdnsScanner.md#handlecommissionablerecords) +- [handleDnsMessage](internal_.MdnsScanner.md#handlednsmessage) +- [handleIpRecords](internal_.MdnsScanner.md#handleiprecords) +- [handleOperationalSrvRecord](internal_.MdnsScanner.md#handleoperationalsrvrecord) +- [hasWaiter](internal_.MdnsScanner.md#haswaiter) +- [multicastServer](internal_.MdnsScanner.md#multicastserver) +- [nextAnnounceIntervalSeconds](internal_.MdnsScanner.md#nextannounceintervalseconds) +- [operationalDeviceRecords](internal_.MdnsScanner.md#operationaldevicerecords) +- [parseCommissionableTxtRecord](internal_.MdnsScanner.md#parsecommissionabletxtrecord) +- [periodicTimer](internal_.MdnsScanner.md#periodictimer) +- [queryTimer](internal_.MdnsScanner.md#querytimer) +- [recordWaiters](internal_.MdnsScanner.md#recordwaiters) +- [registerWaiterPromise](internal_.MdnsScanner.md#registerwaiterpromise) +- [removeQuery](internal_.MdnsScanner.md#removequery) +- [sendQueries](internal_.MdnsScanner.md#sendqueries) +- [setQueryRecords](internal_.MdnsScanner.md#setqueryrecords) +- [sortServerEntries](internal_.MdnsScanner.md#sortserverentries) + +### Methods + +- [cancelCommissionableDeviceDiscovery](internal_.MdnsScanner.md#cancelcommissionabledevicediscovery) +- [cancelOperationalDeviceDiscovery](internal_.MdnsScanner.md#canceloperationaldevicediscovery) +- [close](internal_.MdnsScanner.md#close) +- [findCommissionableDevices](internal_.MdnsScanner.md#findcommissionabledevices) +- [findCommissionableDevicesContinuously](internal_.MdnsScanner.md#findcommissionabledevicescontinuously) +- [findOperationalDevice](internal_.MdnsScanner.md#findoperationaldevice) +- [getDiscoveredCommissionableDevices](internal_.MdnsScanner.md#getdiscoveredcommissionabledevices) +- [getDiscoveredOperationalDevices](internal_.MdnsScanner.md#getdiscoveredoperationaldevices) +- [create](internal_.MdnsScanner.md#create) + +## Constructors + +### constructor + +• **new MdnsScanner**(`multicastServer`, `enableIpv4?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `multicastServer` | [`UdpMulticastServer`](internal_.UdpMulticastServer.md) | +| `enableIpv4?` | `boolean` | + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:30 + +## Properties + +### activeAnnounceQueries + +• `Private` `Readonly` **activeAnnounceQueries**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:22 + +___ + +### buildCommissionableQueryIdentifier + +• `Private` **buildCommissionableQueryIdentifier**: `any` + +Builds an identifier string for commissionable queries based on the given identifier object. +Some identifiers are identical to the official DNS-SD identifiers, others are custom. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:90 + +___ + +### closing + +• `Private` **closing**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:29 + +___ + +### commissionableDeviceRecords + +• `Private` `Readonly` **commissionableDeviceRecords**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:26 + +___ + +### createOperationalMatterQName + +• `Private` **createOperationalMatterQName**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:72 + +___ + +### enableIpv4 + +• `Private` `Optional` `Readonly` **enableIpv4**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:17 + +___ + +### expire + +• `Private` **expire**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:146 + +___ + +### extractInstanceId + +• `Private` **extractInstanceId**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:91 + +___ + +### findCommissionableQueryIdentifier + +• `Private` **findCommissionableQueryIdentifier**: `any` + +Check all options for a query identifier and return the most relevant one with an active query + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:95 + +___ + +### finishWaiter + +• `Private` **finishWaiter**: `any` + +Remove a waiter promise for a specific queryId and stop the connected timer. If required also resolve the +promise. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:69 + +___ + +### getActiveQueryEarlierAnswers + +• `Private` **getActiveQueryEarlierAnswers**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:44 + +___ + +### getCommissionableDeviceRecords + +• `Private` **getCommissionableDeviceRecords**: `any` + +Returns the metadata and list of all target addresses (IP/port) discovered for a queried commissionable device +record. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:85 + +___ + +### getCommissionableQueryRecords + +• `Private` **getCommissionableQueryRecords**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:96 + +___ + +### getOperationalDeviceRecords + +• `Private` **getOperationalDeviceRecords**: `any` + +Returns the list of all targets (IP/port) discovered for a queried operational device record. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:53 + +___ + +### handleCommissionableRecords + +• `Private` **handleCommissionableRecords**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:144 + +___ + +### handleDnsMessage + +• `Private` **handleDnsMessage**: `any` + +Main method to handle all incoming DNS messages. +It will parse the message and check if it contains relevant discovery records. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:141 + +___ + +### handleIpRecords + +• `Private` **handleIpRecords**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:142 + +___ + +### handleOperationalSrvRecord + +• `Private` **handleOperationalSrvRecord**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:143 + +___ + +### hasWaiter + +• `Private` **hasWaiter**: `any` + +Returns weather a waiter promise is registered for a specific queryId. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:71 + +___ + +### multicastServer + +• `Private` `Readonly` **multicastServer**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:16 + +___ + +### nextAnnounceIntervalSeconds + +• `Private` **nextAnnounceIntervalSeconds**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:24 + +___ + +### operationalDeviceRecords + +• `Private` `Readonly` **operationalDeviceRecords**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:25 + +___ + +### parseCommissionableTxtRecord + +• `Private` **parseCommissionableTxtRecord**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:145 + +___ + +### periodicTimer + +• `Private` `Readonly` **periodicTimer**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:28 + +___ + +### queryTimer + +• `Private` `Optional` **queryTimer**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:23 + +___ + +### recordWaiters + +• `Private` `Readonly` **recordWaiters**: `any` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:27 + +___ + +### registerWaiterPromise + +• `Private` **registerWaiterPromise**: `any` + +Registers a deferred promise for a specific queryId together with a timeout and return the promise. +The promise will be resolved when the timer runs out latest. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:64 + +___ + +### removeQuery + +• `Private` **removeQuery**: `any` + +Remove a query from the list of active queries because discovery has finished or timed out and stop sending it +out. If it was the last query announcing will stop completely. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:49 + +___ + +### sendQueries + +• `Private` **sendQueries**: `any` + +Sends out one DNS-SD query for all collected announce records and start a timer for the next query with doubled +interval, maximum 60min, as per MDNS specs. The already known answers are tried to be sent in the query as long +as they fit into a maximum 1500 byte long packet (as defined in MDNS specs), else they are split into more +packets and the query is sent as Truncated query. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:38 + +___ + +### setQueryRecords + +• `Private` **setQueryRecords**: `any` + +Set new DnsQuery records to the list of active queries to discover devices in the network and start sending them +out. When entry already exists the query is overwritten and answers are always added. + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:43 + +___ + +### sortServerEntries + +• `Private` **sortServerEntries**: `any` + +Sort the list of found IP/ports and make sure link-local IPv6 addresses come first, IPv6 next and IPv4 last. + +**`Param`** + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:59 + +## Methods + +### cancelCommissionableDeviceDiscovery + +▸ **cancelCommissionableDeviceDiscovery**(`identifier`): `void` + +Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would +be over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[cancelCommissionableDeviceDiscovery](../interfaces/internal_.Scanner.md#cancelcommissionabledevicediscovery) + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:79 + +___ + +### cancelOperationalDeviceDiscovery + +▸ **cancelOperationalDeviceDiscovery**(`fabric`, `nodeId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](internal_.Fabric.md) | +| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:78 + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +Close all connects, end all timers and resolve all pending promises. + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[close](../interfaces/internal_.Scanner.md#close) + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:136 + +___ + +### findCommissionableDevices + +▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> + +Discovers commissionable devices based on a defined identifier for maximal given timeout, but returns the +first found entries. If already a discovered device matches in the cache the response is returned directly and +no query is triggered. If no record exists a query is sent out and the promise gets fulfilled as soon as at least +one device is found. If no device is discovered in the defined timeframe an empty array is returned. When the +promise got fulfilled no more queries are send out, but more device entries might be added when discovered later. +These can be requested by the getCommissionableDevices method. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | +| `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[findCommissionableDevices](../interfaces/internal_.Scanner.md#findcommissionabledevices) + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:105 + +___ + +### findCommissionableDevicesContinuously + +▸ **findCommissionableDevicesContinuously**(`identifier`, `callback`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> + +Discovers commissionable devices based on a defined identifier and returns the first found entries. If already a + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | +| `callback` | (`device`: [`CommissionableDevice`](../modules/internal_.md#commissionabledevice)) => `void` | +| `timeoutSeconds?` | `number` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[findCommissionableDevicesContinuously](../interfaces/internal_.Scanner.md#findcommissionabledevicescontinuously) + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:112 + +___ + +### findOperationalDevice + +▸ **findOperationalDevice**(`«destructured»`, `nodeId`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`ServerAddressIp`](../modules/internal_.md#serveraddressip)[]\> + +Method to find an operational device (already commissioned) and return a promise with the list of discovered +IP/ports or an empty array if not found. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | [`Fabric`](internal_.Fabric.md) | +| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | +| `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | + +#### Returns + +`Promise`<[`ServerAddressIp`](../modules/internal_.md#serveraddressip)[]\> + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[findOperationalDevice](../interfaces/internal_.Scanner.md#findoperationaldevice) + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:77 + +___ + +### getDiscoveredCommissionableDevices + +▸ **getDiscoveredCommissionableDevices**(`identifier`): { `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/internal_.md#serveraddressip)[] ; `deviceIdentifier`: `string` ; `expires`: `undefined` ; `instanceId`: `string` }[] + +Return already discovered commissionable devices and return them. Does not send out new DNS-SD queries. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | + +#### Returns + +{ `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/internal_.md#serveraddressip)[] ; `deviceIdentifier`: `string` ; `expires`: `undefined` ; `instanceId`: `string` }[] + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[getDiscoveredCommissionableDevices](../interfaces/internal_.Scanner.md#getdiscoveredcommissionabledevices) + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:113 + +___ + +### getDiscoveredOperationalDevices + +▸ **getDiscoveredOperationalDevices**(`«destructured»`, `nodeId`): [`ServerAddressIp`](../modules/internal_.md#serveraddressip)[] + +Return already discovered addresses of an operational paired device and return them. Does not send out new +DNS-SD queries. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | [`Fabric`](internal_.Fabric.md) | +| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | + +#### Returns + +[`ServerAddressIp`](../modules/internal_.md#serveraddressip)[] + +#### Implementation of + +[Scanner](../interfaces/internal_.Scanner.md).[getDiscoveredOperationalDevices](../interfaces/internal_.Scanner.md#getdiscoveredoperationaldevices) + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:80 + +___ + +### create + +▸ `Static` **create**(`options?`): `Promise`<[`MdnsScanner`](internal_.MdnsScanner.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `Object` | +| `options.enableIpv4?` | `boolean` | +| `options.netInterface?` | `string` | + +#### Returns + +`Promise`<[`MdnsScanner`](internal_.MdnsScanner.md)\> + +#### Defined in + +matter.js/dist/esm/mdns/MdnsScanner.d.ts:18 diff --git a/docs/matter-node-ble.js/classes/internal_.MessageChannel.md b/docs/matter-node-ble.js/classes/internal_.MessageChannel.md index ce56d1dd6b..2dccac6843 100644 --- a/docs/matter-node-ble.js/classes/internal_.MessageChannel.md +++ b/docs/matter-node-ble.js/classes/internal_.MessageChannel.md @@ -29,6 +29,7 @@ SPDX-License-Identifier: Apache-2.0 - [channel](internal_.MessageChannel.md#channel) - [closeCallback](internal_.MessageChannel.md#closecallback) +- [closed](internal_.MessageChannel.md#closed) - [session](internal_.MessageChannel.md#session) ### Accessors @@ -58,11 +59,11 @@ SPDX-License-Identifier: Apache-2.0 | :------ | :------ | | `channel` | [`Channel`](../interfaces/internal_.Channel.md)<`Uint8Array`\> | | `session` | [`Session`](../interfaces/internal_.Session.md)<`ContextT`\> | -| `closeCallback?` | () => `void` | +| `closeCallback?` | () => `Promise`<`void`\> | #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:22 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:24 ## Properties @@ -72,7 +73,7 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:22 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:19 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:20 ___ @@ -82,7 +83,17 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:21 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:22 + +___ + +### closed + +• **closed**: `boolean` + +#### Defined in + +matter.js/dist/esm/protocol/ExchangeManager.d.ts:23 ___ @@ -92,7 +103,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:20 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:21 ## Accessors @@ -110,7 +121,7 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:20 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:24 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:26 ## Methods @@ -128,7 +139,7 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:24 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:25 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:27 ___ @@ -152,4 +163,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:23 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:25 diff --git a/docs/matter-node-ble.js/classes/internal_.MessageCounter.md b/docs/matter-node-ble.js/classes/internal_.MessageCounter.md index 4effc5cc7c..38778e716a 100644 --- a/docs/matter-node-ble.js/classes/internal_.MessageCounter.md +++ b/docs/matter-node-ble.js/classes/internal_.MessageCounter.md @@ -32,7 +32,7 @@ #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:48 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:55 ## Methods @@ -46,4 +46,4 @@ matter.js/dist/cjs/protocol/ExchangeManager.d.ts:48 #### Defined in -matter.js/dist/cjs/protocol/ExchangeManager.d.ts:49 +matter.js/dist/esm/protocol/ExchangeManager.d.ts:56 diff --git a/docs/matter-node-ble.js/classes/internal_.MessageExchange.md b/docs/matter-node-ble.js/classes/internal_.MessageExchange.md index 5c3f88f93e..6117a8b8d3 100644 --- a/docs/matter-node-ble.js/classes/internal_.MessageExchange.md +++ b/docs/matter-node-ble.js/classes/internal_.MessageExchange.md @@ -84,11 +84,11 @@ | `peerNodeId` | `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) | | `exchangeId` | `number` | | `protocolId` | `number` | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:57 +matter.js/dist/esm/protocol/MessageExchange.d.ts:57 ## Properties @@ -98,7 +98,7 @@ matter.js/dist/cjs/protocol/MessageExchange.d.ts:57 #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:46 +matter.js/dist/esm/protocol/MessageExchange.d.ts:46 ___ @@ -108,7 +108,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:35 +matter.js/dist/esm/protocol/MessageExchange.d.ts:35 ___ @@ -118,7 +118,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:43 +matter.js/dist/esm/protocol/MessageExchange.d.ts:43 ___ @@ -128,7 +128,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:72 +matter.js/dist/esm/protocol/MessageExchange.d.ts:72 ___ @@ -138,7 +138,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:55 +matter.js/dist/esm/protocol/MessageExchange.d.ts:55 ___ @@ -148,7 +148,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:41 +matter.js/dist/esm/protocol/MessageExchange.d.ts:41 ___ @@ -162,7 +162,7 @@ MatterCoreSpecificationV1_0, section 4.11.2.1 #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:63 +matter.js/dist/esm/protocol/MessageExchange.d.ts:63 ___ @@ -172,7 +172,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:47 +matter.js/dist/esm/protocol/MessageExchange.d.ts:47 ___ @@ -182,7 +182,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:37 +matter.js/dist/esm/protocol/MessageExchange.d.ts:37 ___ @@ -192,7 +192,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:36 +matter.js/dist/esm/protocol/MessageExchange.d.ts:36 ___ @@ -202,7 +202,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:49 +matter.js/dist/esm/protocol/MessageExchange.d.ts:49 ___ @@ -212,7 +212,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:39 +matter.js/dist/esm/protocol/MessageExchange.d.ts:39 ___ @@ -222,7 +222,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:40 +matter.js/dist/esm/protocol/MessageExchange.d.ts:40 ___ @@ -232,7 +232,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:38 +matter.js/dist/esm/protocol/MessageExchange.d.ts:38 ___ @@ -242,7 +242,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:42 +matter.js/dist/esm/protocol/MessageExchange.d.ts:42 ___ @@ -252,7 +252,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:50 +matter.js/dist/esm/protocol/MessageExchange.d.ts:50 ___ @@ -262,7 +262,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:48 +matter.js/dist/esm/protocol/MessageExchange.d.ts:48 ___ @@ -272,7 +272,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:54 +matter.js/dist/esm/protocol/MessageExchange.d.ts:54 ___ @@ -282,7 +282,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:64 +matter.js/dist/esm/protocol/MessageExchange.d.ts:64 ___ @@ -292,7 +292,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:53 +matter.js/dist/esm/protocol/MessageExchange.d.ts:53 ___ @@ -302,7 +302,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:52 +matter.js/dist/esm/protocol/MessageExchange.d.ts:52 ___ @@ -312,7 +312,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:51 +matter.js/dist/esm/protocol/MessageExchange.d.ts:51 ___ @@ -322,7 +322,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:34 +matter.js/dist/esm/protocol/MessageExchange.d.ts:34 ___ @@ -332,7 +332,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:56 +matter.js/dist/esm/protocol/MessageExchange.d.ts:56 ## Methods @@ -346,7 +346,7 @@ matter.js/dist/cjs/protocol/MessageExchange.d.ts:56 #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:67 +matter.js/dist/esm/protocol/MessageExchange.d.ts:67 ___ @@ -360,7 +360,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:71 +matter.js/dist/esm/protocol/MessageExchange.d.ts:71 ___ @@ -374,7 +374,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:65 +matter.js/dist/esm/protocol/MessageExchange.d.ts:65 ___ @@ -388,7 +388,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:69 +matter.js/dist/esm/protocol/MessageExchange.d.ts:69 ___ @@ -402,7 +402,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:70 +matter.js/dist/esm/protocol/MessageExchange.d.ts:70 ___ @@ -416,7 +416,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:68 +matter.js/dist/esm/protocol/MessageExchange.d.ts:68 ___ @@ -430,7 +430,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:60 +matter.js/dist/esm/protocol/MessageExchange.d.ts:60 ___ @@ -450,7 +450,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:58 +matter.js/dist/esm/protocol/MessageExchange.d.ts:58 ___ @@ -472,7 +472,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:59 +matter.js/dist/esm/protocol/MessageExchange.d.ts:59 ___ @@ -492,7 +492,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:66 +matter.js/dist/esm/protocol/MessageExchange.d.ts:66 ___ @@ -513,7 +513,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:61 +matter.js/dist/esm/protocol/MessageExchange.d.ts:61 ___ @@ -534,7 +534,7 @@ ___ | `channel` | [`MessageChannel`](internal_.MessageChannel.md)<`ContextT`\> | | `messageCounter` | [`MessageCounter`](internal_.MessageCounter.md) | | `initialMessage` | [`Message`](../interfaces/internal_.Message.md) | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Returns @@ -542,7 +542,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:44 +matter.js/dist/esm/protocol/MessageExchange.d.ts:44 ___ @@ -564,7 +564,7 @@ ___ | `exchangeId` | `number` | | `protocolId` | `number` | | `messageCounter` | [`MessageCounter`](internal_.MessageCounter.md) | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Returns @@ -572,4 +572,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:45 +matter.js/dist/esm/protocol/MessageExchange.d.ts:45 diff --git a/docs/matter-node-ble.js/classes/internal_.NobleBleClient.md b/docs/matter-node-ble.js/classes/internal_.NobleBleClient.md index 3949df272f..00dd4a6d28 100644 --- a/docs/matter-node-ble.js/classes/internal_.NobleBleClient.md +++ b/docs/matter-node-ble.js/classes/internal_.NobleBleClient.md @@ -39,7 +39,7 @@ #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:39 +[matter-node-ble.js/src/ble/NobleBleClient.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L40) ## Properties @@ -49,7 +49,7 @@ matter-node-ble.js/src/ble/NobleBleClient.ts:39 #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:37 +[matter-node-ble.js/src/ble/NobleBleClient.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L38) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:30 +[matter-node-ble.js/src/ble/NobleBleClient.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L31) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:35 +[matter-node-ble.js/src/ble/NobleBleClient.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L36) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:36 +[matter-node-ble.js/src/ble/NobleBleClient.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L37) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:34 +[matter-node-ble.js/src/ble/NobleBleClient.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L35) ## Methods @@ -109,7 +109,7 @@ matter-node-ble.js/src/ble/NobleBleClient.ts:34 #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:90 +[matter-node-ble.js/src/ble/NobleBleClient.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L91) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:66 +[matter-node-ble.js/src/ble/NobleBleClient.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L67) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:73 +[matter-node-ble.js/src/ble/NobleBleClient.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L74) ___ @@ -157,4 +157,4 @@ ___ #### Defined in -matter-node-ble.js/src/ble/NobleBleClient.ts:85 +[matter-node-ble.js/src/ble/NobleBleClient.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/NobleBleClient.ts#L86) diff --git a/docs/matter-node-ble.js/classes/internal_.PaseServer.md b/docs/matter-node-ble.js/classes/internal_.PaseServer.md index 80a0bad098..5103a22082 100644 --- a/docs/matter-node-ble.js/classes/internal_.PaseServer.md +++ b/docs/matter-node-ble.js/classes/internal_.PaseServer.md @@ -26,6 +26,7 @@ ### Methods - [cancelPairing](internal_.PaseServer.md#cancelpairing) +- [close](internal_.PaseServer.md#close) - [getId](internal_.PaseServer.md#getid) - [onNewExchange](internal_.PaseServer.md#onnewexchange) - [fromPin](internal_.PaseServer.md#frompin) @@ -47,7 +48,7 @@ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:24 +matter.js/dist/esm/session/pase/PaseServer.d.ts:24 ## Properties @@ -57,7 +58,7 @@ matter.js/dist/cjs/session/pase/PaseServer.d.ts:24 #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:18 +matter.js/dist/esm/session/pase/PaseServer.d.ts:18 ___ @@ -67,7 +68,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:27 +matter.js/dist/esm/session/pase/PaseServer.d.ts:27 ___ @@ -77,7 +78,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:21 +matter.js/dist/esm/session/pase/PaseServer.d.ts:21 ___ @@ -87,7 +88,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:20 +matter.js/dist/esm/session/pase/PaseServer.d.ts:20 ___ @@ -97,7 +98,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:19 +matter.js/dist/esm/session/pase/PaseServer.d.ts:19 ___ @@ -107,7 +108,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:17 +matter.js/dist/esm/session/pase/PaseServer.d.ts:17 ## Methods @@ -128,7 +129,25 @@ matter.js/dist/cjs/session/pase/PaseServer.d.ts:17 #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:28 +matter.js/dist/esm/session/pase/PaseServer.d.ts:28 + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/internal_.ProtocolHandler.md).[close](../interfaces/internal_.ProtocolHandler.md#close) + +#### Defined in + +matter.js/dist/esm/session/pase/PaseServer.d.ts:29 ___ @@ -146,7 +165,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:25 +matter.js/dist/esm/session/pase/PaseServer.d.ts:25 ___ @@ -170,7 +189,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:26 +matter.js/dist/esm/session/pase/PaseServer.d.ts:26 ___ @@ -191,7 +210,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:22 +matter.js/dist/esm/session/pase/PaseServer.d.ts:22 ___ @@ -212,4 +231,4 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseServer.d.ts:23 +matter.js/dist/esm/session/pase/PaseServer.d.ts:23 diff --git a/docs/matter-node-ble.js/classes/internal_.PaseServerMessenger.md b/docs/matter-node-ble.js/classes/internal_.PaseServerMessenger.md index 33f902c54f..b47b5119bd 100644 --- a/docs/matter-node-ble.js/classes/internal_.PaseServerMessenger.md +++ b/docs/matter-node-ble.js/classes/internal_.PaseServerMessenger.md @@ -56,7 +56,7 @@ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:19 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:19 ## Properties @@ -70,7 +70,7 @@ matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:19 #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:18 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:18 ## Methods @@ -88,7 +88,7 @@ matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:18 #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:28 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:28 ___ @@ -106,7 +106,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:27 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:27 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:20 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:20 ___ @@ -161,7 +161,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:21 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:21 ___ @@ -175,7 +175,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseMessenger.d.ts:33 +matter.js/dist/esm/session/pase/PaseMessenger.d.ts:33 ___ @@ -189,7 +189,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseMessenger.d.ts:37 +matter.js/dist/esm/session/pase/PaseMessenger.d.ts:37 ___ @@ -203,7 +203,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseMessenger.d.ts:19 +matter.js/dist/esm/session/pase/PaseMessenger.d.ts:19 ___ @@ -235,7 +235,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:23 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:23 ___ @@ -253,7 +253,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:26 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:26 ___ @@ -277,7 +277,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:24 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:24 ___ @@ -297,7 +297,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseMessenger.d.ts:36 +matter.js/dist/esm/session/pase/PaseMessenger.d.ts:36 ___ @@ -317,7 +317,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/pase/PaseMessenger.d.ts:32 +matter.js/dist/esm/session/pase/PaseMessenger.d.ts:32 ___ @@ -335,7 +335,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:25 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:25 ___ @@ -359,7 +359,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:30 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:30 ___ @@ -377,4 +377,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:22 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:22 diff --git a/docs/matter-node-ble.js/classes/internal_.RootCertificateManager.md b/docs/matter-node-ble.js/classes/internal_.RootCertificateManager.md index 142aa2f146..6a61d096c5 100644 --- a/docs/matter-node-ble.js/classes/internal_.RootCertificateManager.md +++ b/docs/matter-node-ble.js/classes/internal_.RootCertificateManager.md @@ -38,7 +38,7 @@ #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:16 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:16 ## Properties @@ -48,7 +48,7 @@ matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:16 #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:18 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:18 ___ @@ -58,7 +58,7 @@ ___ #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:15 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:15 ___ @@ -68,7 +68,7 @@ ___ #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:14 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:14 ___ @@ -78,7 +78,7 @@ ___ #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:11 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:11 ___ @@ -88,7 +88,7 @@ ___ #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:13 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:13 ___ @@ -98,7 +98,7 @@ ___ #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:12 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:12 ## Methods @@ -120,7 +120,7 @@ matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:12 #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:19 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:19 ___ @@ -134,4 +134,4 @@ ___ #### Defined in -matter.js/dist/cjs/certificate/RootCertificateManager.d.ts:17 +matter.js/dist/esm/certificate/RootCertificateManager.d.ts:17 diff --git a/docs/matter-node-ble.js/classes/internal_.Schema.md b/docs/matter-node-ble.js/classes/internal_.Schema.md index 7a3c9a8357..725fdeb65b 100644 --- a/docs/matter-node-ble.js/classes/internal_.Schema.md +++ b/docs/matter-node-ble.js/classes/internal_.Schema.md @@ -67,7 +67,7 @@ Decodes the encoded data using the schema. #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:11 +matter.js/dist/esm/schema/Schema.d.ts:11 ___ @@ -87,7 +87,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:13 +matter.js/dist/esm/schema/Schema.d.ts:13 ___ @@ -109,7 +109,7 @@ Encodes the value using the schema. #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:9 +matter.js/dist/esm/schema/Schema.d.ts:9 ___ @@ -129,7 +129,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:12 +matter.js/dist/esm/schema/Schema.d.ts:12 ___ @@ -151,4 +151,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:15 +matter.js/dist/esm/schema/Schema.d.ts:15 diff --git a/docs/matter-node-ble.js/classes/internal_.SecureChannelMessenger.md b/docs/matter-node-ble.js/classes/internal_.SecureChannelMessenger.md index 31baba679d..4e76820e7d 100644 --- a/docs/matter-node-ble.js/classes/internal_.SecureChannelMessenger.md +++ b/docs/matter-node-ble.js/classes/internal_.SecureChannelMessenger.md @@ -60,7 +60,7 @@ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:19 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:19 ## Properties @@ -70,7 +70,7 @@ matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:19 #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:18 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:18 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:29 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:29 ## Methods @@ -94,7 +94,7 @@ matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:29 #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:28 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:28 ___ @@ -108,7 +108,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:27 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:27 ___ @@ -128,7 +128,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:20 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:20 ___ @@ -155,7 +155,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:21 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:21 ___ @@ -183,7 +183,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:23 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:23 ___ @@ -197,7 +197,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:26 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:26 ___ @@ -217,7 +217,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:24 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:24 ___ @@ -231,7 +231,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:25 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:25 ___ @@ -251,7 +251,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:30 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:30 ___ @@ -265,4 +265,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessenger.d.ts:22 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessenger.d.ts:22 diff --git a/docs/matter-node-ble.js/classes/internal_.SecureSession.md b/docs/matter-node-ble.js/classes/internal_.SecureSession.md index 1e93086e2e..6c3f0b8344 100644 --- a/docs/matter-node-ble.js/classes/internal_.SecureSession.md +++ b/docs/matter-node-ble.js/classes/internal_.SecureSession.md @@ -22,6 +22,8 @@ ### Properties +- [\_closingAfterExchangeFinished](internal_.SecureSession.md#_closingafterexchangefinished) +- [\_sendCloseMessageWhenClosing](internal_.SecureSession.md#_sendclosemessagewhenclosing) - [activeRetransmissionTimeoutMs](internal_.SecureSession.md#activeretransmissiontimeoutms) - [activeTimestamp](internal_.SecureSession.md#activetimestamp) - [attestationKey](internal_.SecureSession.md#attestationkey) @@ -36,13 +38,16 @@ - [peerNodeId](internal_.SecureSession.md#peernodeid) - [peerSessionId](internal_.SecureSession.md#peersessionid) - [retransmissionRetries](internal_.SecureSession.md#retransmissionretries) +- [subscriptionChangedCallback](internal_.SecureSession.md#subscriptionchangedcallback) - [subscriptions](internal_.SecureSession.md#subscriptions) - [timestamp](internal_.SecureSession.md#timestamp) ### Accessors +- [closingAfterExchangeFinished](internal_.SecureSession.md#closingafterexchangefinished) - [name](internal_.SecureSession.md#name) - [numberOfActiveSubscriptions](internal_.SecureSession.md#numberofactivesubscriptions) +- [sendCloseMessageWhenClosing](internal_.SecureSession.md#sendclosemessagewhenclosing) ### Methods @@ -74,7 +79,7 @@ ### constructor -• **new SecureSession**<`T`\>(`context`, `id`, `fabric`, `peerNodeId`, `peerSessionId`, `_sharedSecret`, `decryptKey`, `encryptKey`, `attestationKey`, `closeCallback`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`, `retransmissionRetries?`) +• **new SecureSession**<`T`\>(`args`) #### Type parameters @@ -86,33 +91,54 @@ | Name | Type | | :------ | :------ | -| `context` | `T` | -| `id` | `number` | -| `fabric` | `undefined` \| [`Fabric`](internal_.Fabric.md) | -| `peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | -| `peerSessionId` | `number` | -| `_sharedSecret` | `Uint8Array` | -| `decryptKey` | `Uint8Array` | -| `encryptKey` | `Uint8Array` | -| `attestationKey` | `Uint8Array` | -| `closeCallback` | (`sendClose`: `boolean`) => `Promise`<`void`\> | -| `idleRetransmissionTimeoutMs?` | `number` | -| `activeRetransmissionTimeoutMs?` | `number` | -| `retransmissionRetries?` | `number` | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.attestationKey` | `Uint8Array` | +| `args.closeCallback` | () => `Promise`<`void`\> | +| `args.context` | `T` | +| `args.decryptKey` | `Uint8Array` | +| `args.encryptKey` | `Uint8Array` | +| `args.fabric` | `undefined` \| [`Fabric`](internal_.Fabric.md) | +| `args.id` | `number` | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.retransmissionRetries?` | `number` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:31 +matter.js/dist/esm/session/SecureSession.d.ts:48 ## Properties +### \_closingAfterExchangeFinished + +• `Private` **\_closingAfterExchangeFinished**: `any` + +#### Defined in + +matter.js/dist/esm/session/SecureSession.d.ts:18 + +___ + +### \_sendCloseMessageWhenClosing + +• `Private` **\_sendCloseMessageWhenClosing**: `any` + +#### Defined in + +matter.js/dist/esm/session/SecureSession.d.ts:19 + +___ + ### activeRetransmissionTimeoutMs • `Private` `Readonly` **activeRetransmissionTimeoutMs**: `any` #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:25 +matter.js/dist/esm/session/SecureSession.d.ts:31 ___ @@ -122,7 +148,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:29 +matter.js/dist/esm/session/SecureSession.d.ts:17 ___ @@ -132,7 +158,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:22 +matter.js/dist/esm/session/SecureSession.d.ts:27 ___ @@ -142,7 +168,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:23 +matter.js/dist/esm/session/SecureSession.d.ts:28 ___ @@ -152,7 +178,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:15 +matter.js/dist/esm/session/SecureSession.d.ts:20 ___ @@ -162,7 +188,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:20 +matter.js/dist/esm/session/SecureSession.d.ts:25 ___ @@ -172,7 +198,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:21 +matter.js/dist/esm/session/SecureSession.d.ts:26 ___ @@ -182,7 +208,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:17 +matter.js/dist/esm/session/SecureSession.d.ts:22 ___ @@ -192,7 +218,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:62 +matter.js/dist/esm/session/SecureSession.d.ts:95 ___ @@ -202,7 +228,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:16 +matter.js/dist/esm/session/SecureSession.d.ts:21 ___ @@ -212,7 +238,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:24 +matter.js/dist/esm/session/SecureSession.d.ts:30 ___ @@ -222,7 +248,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:18 +matter.js/dist/esm/session/SecureSession.d.ts:23 ___ @@ -232,7 +258,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:19 +matter.js/dist/esm/session/SecureSession.d.ts:24 ___ @@ -242,7 +268,17 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:26 +matter.js/dist/esm/session/SecureSession.d.ts:32 + +___ + +### subscriptionChangedCallback + +• `Private` `Readonly` **subscriptionChangedCallback**: `any` + +#### Defined in + +matter.js/dist/esm/session/SecureSession.d.ts:29 ___ @@ -252,7 +288,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:27 +matter.js/dist/esm/session/SecureSession.d.ts:15 ___ @@ -262,10 +298,28 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:28 +matter.js/dist/esm/session/SecureSession.d.ts:16 ## Accessors +### closingAfterExchangeFinished + +• `get` **closingAfterExchangeFinished**(): `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[Session](../interfaces/internal_.Session.md).[closingAfterExchangeFinished](../interfaces/internal_.Session.md#closingafterexchangefinished) + +#### Defined in + +matter.js/dist/esm/session/SecureSession.d.ts:63 + +___ + ### name • `get` **name**(): `string` @@ -280,7 +334,7 @@ matter.js/dist/cjs/session/SecureSession.d.ts:28 #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:43 +matter.js/dist/esm/session/SecureSession.d.ts:76 ___ @@ -294,7 +348,21 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:55 +matter.js/dist/esm/session/SecureSession.d.ts:88 + +___ + +### sendCloseMessageWhenClosing + +• `get` **sendCloseMessageWhenClosing**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +matter.js/dist/esm/session/SecureSession.d.ts:64 ## Methods @@ -314,7 +382,7 @@ matter.js/dist/cjs/session/SecureSession.d.ts:55 #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:41 +matter.js/dist/esm/session/SecureSession.d.ts:74 ___ @@ -334,7 +402,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:54 +matter.js/dist/esm/session/SecureSession.d.ts:87 ___ @@ -354,13 +422,19 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:57 +matter.js/dist/esm/session/SecureSession.d.ts:90 ___ ### close -▸ **close**(): `Promise`<`void`\> +▸ **close**(`closeAfterExchangeFinished?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -368,7 +442,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:34 +matter.js/dist/esm/session/SecureSession.d.ts:67 ___ @@ -392,13 +466,13 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:37 +matter.js/dist/esm/session/SecureSession.d.ts:70 ___ ### destroy -▸ **destroy**(`sendClose`): `Promise`<`void`\> +▸ **destroy**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> Destroys a session. Outstanding subscription data will be discarded. @@ -407,6 +481,7 @@ Destroys a session. Outstanding subscription data will be discarded. | Name | Type | | :------ | :------ | | `sendClose` | `boolean` | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -418,7 +493,7 @@ Destroys a session. Outstanding subscription data will be discarded. #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:61 +matter.js/dist/esm/session/SecureSession.d.ts:94 ___ @@ -442,13 +517,13 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:38 +matter.js/dist/esm/session/SecureSession.d.ts:71 ___ ### end -▸ **end**(`sendClose`): `Promise`<`void`\> +▸ **end**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> Ends a session. Outstanding subscription data will be flushed before the session is destroyed. @@ -457,6 +532,7 @@ Ends a session. Outstanding subscription data will be flushed before the session | Name | Type | | :------ | :------ | | `sendClose` | `boolean` | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -468,7 +544,7 @@ Ends a session. Outstanding subscription data will be flushed before the session #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:59 +matter.js/dist/esm/session/SecureSession.d.ts:92 ___ @@ -486,7 +562,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:42 +matter.js/dist/esm/session/SecureSession.d.ts:75 ___ @@ -500,7 +576,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:39 +matter.js/dist/esm/session/SecureSession.d.ts:72 ___ @@ -518,7 +594,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:49 +matter.js/dist/esm/session/SecureSession.d.ts:82 ___ @@ -532,7 +608,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:40 +matter.js/dist/esm/session/SecureSession.d.ts:73 ___ @@ -550,7 +626,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:50 +matter.js/dist/esm/session/SecureSession.d.ts:83 ___ @@ -574,7 +650,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:44 +matter.js/dist/esm/session/SecureSession.d.ts:77 ___ @@ -592,7 +668,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:52 +matter.js/dist/esm/session/SecureSession.d.ts:85 ___ @@ -610,7 +686,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:53 +matter.js/dist/esm/session/SecureSession.d.ts:86 ___ @@ -628,7 +704,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:51 +matter.js/dist/esm/session/SecureSession.d.ts:84 ___ @@ -646,7 +722,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:33 +matter.js/dist/esm/session/SecureSession.d.ts:66 ___ @@ -664,7 +740,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:36 +matter.js/dist/esm/session/SecureSession.d.ts:69 ___ @@ -682,7 +758,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:32 +matter.js/dist/esm/session/SecureSession.d.ts:65 ___ @@ -706,7 +782,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:35 +matter.js/dist/esm/session/SecureSession.d.ts:68 ___ @@ -726,13 +802,13 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:56 +matter.js/dist/esm/session/SecureSession.d.ts:89 ___ ### create -▸ `Static` **create**<`T`\>(`context`, `id`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `closeCallback`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](internal_.SecureSession.md)<`T`\>\> +▸ `Static` **create**<`T`\>(`args`): `Promise`<[`SecureSession`](internal_.SecureSession.md)<`T`\>\> #### Type parameters @@ -744,18 +820,20 @@ ___ | Name | Type | | :------ | :------ | -| `context` | `T` | -| `id` | `number` | -| `fabric` | `undefined` \| [`Fabric`](internal_.Fabric.md) | -| `peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | -| `peerSessionId` | `number` | -| `sharedSecret` | `Uint8Array` | -| `salt` | `Uint8Array` | -| `isInitiator` | `boolean` | -| `isResumption` | `boolean` | -| `closeCallback` | (`sendClose`: `boolean`) => `Promise`<`void`\> | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.closeCallback` | () => `Promise`<`void`\> | +| `args.context` | `T` | +| `args.fabric` | `undefined` \| [`Fabric`](internal_.Fabric.md) | +| `args.id` | `number` | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.isInitiator` | `boolean` | +| `args.isResumption` | `boolean` | +| `args.peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.salt` | `Uint8Array` | +| `args.sharedSecret` | `Uint8Array` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Returns @@ -763,4 +841,4 @@ ___ #### Defined in -matter.js/dist/cjs/session/SecureSession.d.ts:30 +matter.js/dist/esm/session/SecureSession.d.ts:33 diff --git a/docs/matter-node-ble.js/classes/internal_.SessionManager.md b/docs/matter-node-ble.js/classes/internal_.SessionManager.md index 0a6a6a79bd..6d3dc30181 100644 --- a/docs/matter-node-ble.js/classes/internal_.SessionManager.md +++ b/docs/matter-node-ble.js/classes/internal_.SessionManager.md @@ -23,7 +23,6 @@ - [resumptionRecords](internal_.SessionManager.md#resumptionrecords) - [sessionStorage](internal_.SessionManager.md#sessionstorage) - [sessions](internal_.SessionManager.md#sessions) -- [sessionsToClose](internal_.SessionManager.md#sessionstoclose) - [unsecureSession](internal_.SessionManager.md#unsecuresession) ### Methods @@ -37,9 +36,10 @@ - [getPaseSession](internal_.SessionManager.md#getpasesession) - [getSession](internal_.SessionManager.md#getsession) - [getSessionForNode](internal_.SessionManager.md#getsessionfornode) -- [getSessionsToClose](internal_.SessionManager.md#getsessionstoclose) - [getUnsecureSession](internal_.SessionManager.md#getunsecuresession) - [initFromStorage](internal_.SessionManager.md#initfromstorage) +- [removeAllSessionsForNode](internal_.SessionManager.md#removeallsessionsfornode) +- [removeResumptionRecord](internal_.SessionManager.md#removeresumptionrecord) - [removeSession](internal_.SessionManager.md#removesession) - [saveResumptionRecord](internal_.SessionManager.md#saveresumptionrecord) - [storeResumptionRecords](internal_.SessionManager.md#storeresumptionrecords) @@ -66,7 +66,7 @@ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:30 +matter.js/dist/esm/session/SessionManager.d.ts:29 ## Properties @@ -76,7 +76,7 @@ matter.js/dist/cjs/session/SessionManager.d.ts:30 #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:23 +matter.js/dist/esm/session/SessionManager.d.ts:23 ___ @@ -86,7 +86,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:26 +matter.js/dist/esm/session/SessionManager.d.ts:26 ___ @@ -96,7 +96,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:27 +matter.js/dist/esm/session/SessionManager.d.ts:27 ___ @@ -106,7 +106,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:28 +matter.js/dist/esm/session/SessionManager.d.ts:28 ___ @@ -116,17 +116,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:25 - -___ - -### sessionsToClose - -• `Private` `Readonly` **sessionsToClose**: `any` - -#### Defined in - -matter.js/dist/cjs/session/SessionManager.d.ts:29 +matter.js/dist/esm/session/SessionManager.d.ts:25 ___ @@ -136,7 +126,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:24 +matter.js/dist/esm/session/SessionManager.d.ts:24 ## Methods @@ -150,29 +140,31 @@ matter.js/dist/cjs/session/SessionManager.d.ts:24 #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:62 +matter.js/dist/esm/session/SessionManager.d.ts:76 ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`, `closeCallback?`): `Promise`<[`SecureSession`](internal_.SecureSession.md)<`ContextT`\>\> +▸ **createSecureSession**(`args`): `Promise`<[`SecureSession`](internal_.SecureSession.md)<`ContextT`\>\> #### Parameters | Name | Type | | :------ | :------ | -| `sessionId` | `number` | -| `fabric` | `undefined` \| [`Fabric`](internal_.Fabric.md) | -| `peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | -| `peerSessionId` | `number` | -| `sharedSecret` | `Uint8Array` | -| `salt` | `Uint8Array` | -| `isInitiator` | `boolean` | -| `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | -| `closeCallback?` | (`sendClose`: `boolean`) => `Promise`<`void`\> | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.closeCallback?` | () => `Promise`<`void`\> | +| `args.fabric` | `undefined` \| [`Fabric`](internal_.Fabric.md) | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.isInitiator` | `boolean` | +| `args.isResumption` | `boolean` | +| `args.peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.salt` | `Uint8Array` | +| `args.sessionId` | `number` | +| `args.sharedSecret` | `Uint8Array` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Returns @@ -180,7 +172,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:31 +matter.js/dist/esm/session/SessionManager.d.ts:30 ___ @@ -200,7 +192,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:39 +matter.js/dist/esm/session/SessionManager.d.ts:52 ___ @@ -220,21 +212,21 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:40 +matter.js/dist/esm/session/SessionManager.d.ts:53 ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/internal_.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/internal_.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/internal_.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/internal_.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/internal_.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/internal_.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:45 +matter.js/dist/esm/session/SessionManager.d.ts:58 ___ @@ -248,7 +240,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:34 +matter.js/dist/esm/session/SessionManager.d.ts:46 ___ @@ -262,7 +254,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:36 +matter.js/dist/esm/session/SessionManager.d.ts:48 ___ @@ -282,7 +274,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:35 +matter.js/dist/esm/session/SessionManager.d.ts:47 ___ @@ -303,47 +295,74 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:37 +matter.js/dist/esm/session/SessionManager.d.ts:49 ___ -### getSessionsToClose +### getUnsecureSession -▸ **getSessionsToClose**(): [`SecureSession`](internal_.SecureSession.md)<`any`\>[] +▸ **getUnsecureSession**(): [`UnsecureSession`](internal_.UnsecureSession.md)<`ContextT`\> #### Returns -[`SecureSession`](internal_.SecureSession.md)<`any`\>[] +[`UnsecureSession`](internal_.UnsecureSession.md)<`ContextT`\> #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:32 +matter.js/dist/esm/session/SessionManager.d.ts:51 ___ -### getUnsecureSession +### initFromStorage -▸ **getUnsecureSession**(): [`UnsecureSession`](internal_.UnsecureSession.md)<`ContextT`\> +▸ **initFromStorage**(`fabrics`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabrics` | [`Fabric`](internal_.Fabric.md)[] | #### Returns -[`UnsecureSession`](internal_.UnsecureSession.md)<`ContextT`\> +`void` #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:38 +matter.js/dist/esm/session/SessionManager.d.ts:57 ___ -### initFromStorage +### removeAllSessionsForNode -▸ **initFromStorage**(`fabrics`): `void` +▸ **removeAllSessionsForNode**(`nodeId`, `sendClose?`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `fabrics` | [`Fabric`](internal_.Fabric.md)[] | +| `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | +| `sendClose?` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +matter.js/dist/esm/session/SessionManager.d.ts:50 + +___ + +### removeResumptionRecord + +▸ **removeResumptionRecord**(`peerNodeId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | #### Returns @@ -351,28 +370,27 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:44 +matter.js/dist/esm/session/SessionManager.d.ts:45 ___ ### removeSession -▸ **removeSession**(`sessionId`, `peerNodeId`): `Promise`<`void`\> +▸ **removeSession**(`sessionId`): `void` #### Parameters | Name | Type | | :------ | :------ | | `sessionId` | `number` | -| `peerNodeId` | [`NodeId`](../modules/internal_.md#nodeid) | #### Returns -`Promise`<`void`\> +`void` #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:33 +matter.js/dist/esm/session/SessionManager.d.ts:44 ___ @@ -392,7 +410,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:41 +matter.js/dist/esm/session/SessionManager.d.ts:54 ___ @@ -406,7 +424,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:43 +matter.js/dist/esm/session/SessionManager.d.ts:56 ___ @@ -426,4 +444,4 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:42 +matter.js/dist/esm/session/SessionManager.d.ts:55 diff --git a/docs/matter-node-ble.js/classes/internal_.Storage.md b/docs/matter-node-ble.js/classes/internal_.Storage.md index f4aa0bf003..23f23fc5d9 100644 --- a/docs/matter-node-ble.js/classes/internal_.Storage.md +++ b/docs/matter-node-ble.js/classes/internal_.Storage.md @@ -12,10 +12,12 @@ ### Methods +- [clearAll](internal_.Storage.md#clearall) - [close](internal_.Storage.md#close) - [delete](internal_.Storage.md#delete) - [get](internal_.Storage.md#get) - [initialize](internal_.Storage.md#initialize) +- [keys](internal_.Storage.md#keys) - [set](internal_.Storage.md#set) ## Constructors @@ -26,6 +28,26 @@ ## Methods +### clearAll + +▸ `Abstract` **clearAll**(`contexts`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/storage/Storage.d.ts:17 + +___ + ### close ▸ `Abstract` **close**(): `Promise`<`void`\> @@ -36,7 +58,7 @@ #### Defined in -matter.js/dist/cjs/storage/Storage.d.ts:12 +matter.js/dist/esm/storage/Storage.d.ts:12 ___ @@ -57,7 +79,7 @@ ___ #### Defined in -matter.js/dist/cjs/storage/Storage.d.ts:15 +matter.js/dist/esm/storage/Storage.d.ts:15 ___ @@ -84,7 +106,7 @@ ___ #### Defined in -matter.js/dist/cjs/storage/Storage.d.ts:13 +matter.js/dist/esm/storage/Storage.d.ts:13 ___ @@ -98,7 +120,27 @@ ___ #### Defined in -matter.js/dist/cjs/storage/Storage.d.ts:11 +matter.js/dist/esm/storage/Storage.d.ts:11 + +___ + +### keys + +▸ `Abstract` **keys**(`contexts`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`string`[] + +#### Defined in + +matter.js/dist/esm/storage/Storage.d.ts:16 ___ @@ -126,4 +168,4 @@ ___ #### Defined in -matter.js/dist/cjs/storage/Storage.d.ts:14 +matter.js/dist/esm/storage/Storage.d.ts:14 diff --git a/docs/matter-node-ble.js/classes/internal_.StorageContext.md b/docs/matter-node-ble.js/classes/internal_.StorageContext.md index c70d996c41..cb3af1f0b6 100644 --- a/docs/matter-node-ble.js/classes/internal_.StorageContext.md +++ b/docs/matter-node-ble.js/classes/internal_.StorageContext.md @@ -17,10 +17,13 @@ ### Methods +- [clear](internal_.StorageContext.md#clear) +- [clearAll](internal_.StorageContext.md#clearall) - [createContext](internal_.StorageContext.md#createcontext) - [delete](internal_.StorageContext.md#delete) - [get](internal_.StorageContext.md#get) - [has](internal_.StorageContext.md#has) +- [keys](internal_.StorageContext.md#keys) - [set](internal_.StorageContext.md#set) ## Constructors @@ -38,7 +41,7 @@ #### Defined in -matter.js/dist/cjs/storage/StorageContext.d.ts:11 +matter.js/dist/esm/storage/StorageContext.d.ts:11 ## Properties @@ -48,7 +51,7 @@ matter.js/dist/cjs/storage/StorageContext.d.ts:11 #### Defined in -matter.js/dist/cjs/storage/StorageContext.d.ts:10 +matter.js/dist/esm/storage/StorageContext.d.ts:10 ___ @@ -58,10 +61,42 @@ ___ #### Defined in -matter.js/dist/cjs/storage/StorageContext.d.ts:9 +matter.js/dist/esm/storage/StorageContext.d.ts:9 ## Methods +### clear + +▸ **clear**(): `void` + +Clears all keys in this context + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/storage/StorageContext.d.ts:19 + +___ + +### clearAll + +▸ **clearAll**(): `void` + +Clears all keys in this context and all created sub-contexts. + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/storage/StorageContext.d.ts:21 + +___ + ### createContext ▸ **createContext**(`context`): [`StorageContext`](internal_.StorageContext.md) @@ -78,7 +113,7 @@ matter.js/dist/cjs/storage/StorageContext.d.ts:9 #### Defined in -matter.js/dist/cjs/storage/StorageContext.d.ts:16 +matter.js/dist/esm/storage/StorageContext.d.ts:16 ___ @@ -98,7 +133,7 @@ ___ #### Defined in -matter.js/dist/cjs/storage/StorageContext.d.ts:15 +matter.js/dist/esm/storage/StorageContext.d.ts:15 ___ @@ -125,7 +160,7 @@ ___ #### Defined in -matter.js/dist/cjs/storage/StorageContext.d.ts:12 +matter.js/dist/esm/storage/StorageContext.d.ts:12 ___ @@ -145,7 +180,21 @@ ___ #### Defined in -matter.js/dist/cjs/storage/StorageContext.d.ts:13 +matter.js/dist/esm/storage/StorageContext.d.ts:13 + +___ + +### keys + +▸ **keys**(): `string`[] + +#### Returns + +`string`[] + +#### Defined in + +matter.js/dist/esm/storage/StorageContext.d.ts:17 ___ @@ -172,4 +221,4 @@ ___ #### Defined in -matter.js/dist/cjs/storage/StorageContext.d.ts:14 +matter.js/dist/esm/storage/StorageContext.d.ts:14 diff --git a/docs/matter-node-ble.js/classes/internal_.SubscriptionHandler.md b/docs/matter-node-ble.js/classes/internal_.SubscriptionHandler.md index 33b046282e..0c1957484e 100644 --- a/docs/matter-node-ble.js/classes/internal_.SubscriptionHandler.md +++ b/docs/matter-node-ble.js/classes/internal_.SubscriptionHandler.md @@ -89,7 +89,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:41 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:41 ## Properties @@ -99,7 +99,7 @@ matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:41 #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:28 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:28 ___ @@ -109,7 +109,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:16 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:16 ___ @@ -119,7 +119,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:22 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:22 ___ @@ -129,7 +129,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:17 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:17 ___ @@ -139,7 +139,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:42 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:42 ___ @@ -149,7 +149,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:15 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:15 ___ @@ -159,7 +159,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:19 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:19 ___ @@ -169,7 +169,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:20 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:20 ___ @@ -179,7 +179,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:29 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:29 ___ @@ -189,7 +189,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:18 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:18 ___ @@ -199,7 +199,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:36 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:36 ___ @@ -209,7 +209,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:21 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:21 ___ @@ -219,7 +219,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:23 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:23 ___ @@ -229,7 +229,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:31 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:31 ___ @@ -239,7 +239,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:34 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:34 ___ @@ -249,7 +249,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:33 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:33 ___ @@ -259,7 +259,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:26 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:26 ___ @@ -269,7 +269,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:27 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:27 ___ @@ -279,7 +279,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:37 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:37 ___ @@ -289,7 +289,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:43 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:43 ___ @@ -299,7 +299,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:45 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:45 ___ @@ -309,7 +309,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:25 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:25 ___ @@ -319,7 +319,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:32 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:32 ___ @@ -329,7 +329,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:39 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:39 ___ @@ -339,7 +339,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:40 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:40 ___ @@ -349,7 +349,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:71 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:71 ___ @@ -359,7 +359,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:30 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:30 ___ @@ -369,7 +369,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:38 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:38 ___ @@ -379,7 +379,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:35 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:35 ___ @@ -389,7 +389,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:14 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:14 ___ @@ -399,7 +399,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:13 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:13 ___ @@ -409,7 +409,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:24 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:24 ## Methods @@ -423,7 +423,7 @@ matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:24 #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:56 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:56 ___ @@ -452,7 +452,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:67 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:67 ___ @@ -473,7 +473,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:70 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:70 ___ @@ -501,7 +501,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:68 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:68 ___ @@ -515,7 +515,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:69 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:69 ___ @@ -529,7 +529,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:54 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:54 ___ @@ -543,7 +543,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:55 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:55 ___ @@ -560,7 +560,7 @@ sending by 50ms in any case to mke sure to catch all updates. #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:61 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:61 ___ @@ -580,7 +580,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:66 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:66 ___ @@ -596,7 +596,7 @@ Determine all attributes that have changed since the last update and send them t #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:65 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:65 ___ @@ -616,7 +616,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:44 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:44 ___ @@ -636,7 +636,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:46 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:46 ___ @@ -655,4 +655,4 @@ controller. The data of newly added events are not sent automatically. #### Defined in -matter.js/dist/cjs/protocol/interaction/SubscriptionHandler.d.ts:53 +matter.js/dist/esm/protocol/interaction/SubscriptionHandler.d.ts:53 diff --git a/docs/matter-node-ble.js/classes/internal_.TlvSchema.md b/docs/matter-node-ble.js/classes/internal_.TlvSchema.md index 6a71059e56..4d2dabd5e4 100644 --- a/docs/matter-node-ble.js/classes/internal_.TlvSchema.md +++ b/docs/matter-node-ble.js/classes/internal_.TlvSchema.md @@ -16,7 +16,7 @@ ↳ **`TlvSchema`** - ↳↳ [`ObjectSchema`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md) + ↳↳ [`ObjectSchema`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md) ## Implements @@ -92,7 +92,7 @@ Schema.decode #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:11 +matter.js/dist/esm/schema/Schema.d.ts:11 ___ @@ -120,7 +120,7 @@ Schema.decodeInternal #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:10 +matter.js/dist/esm/tlv/TlvSchema.d.ts:10 ___ @@ -144,7 +144,7 @@ TlvSchema.decodeTlv #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:13 +matter.js/dist/esm/tlv/TlvSchema.d.ts:13 ___ @@ -173,7 +173,7 @@ TlvSchema.decodeTlvInternal #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:14 +matter.js/dist/esm/tlv/TlvSchema.d.ts:14 ___ @@ -198,7 +198,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:18 +matter.js/dist/esm/tlv/TlvSchema.d.ts:18 ___ @@ -228,7 +228,7 @@ Schema.encode #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:9 +matter.js/dist/esm/schema/Schema.d.ts:9 ___ @@ -256,7 +256,7 @@ Schema.encodeInternal #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:11 +matter.js/dist/esm/tlv/TlvSchema.d.ts:11 ___ @@ -280,7 +280,7 @@ TlvSchema.encodeTlv #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:12 +matter.js/dist/esm/tlv/TlvSchema.d.ts:12 ___ @@ -306,7 +306,7 @@ TlvSchema.encodeTlvInternal #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:19 +matter.js/dist/esm/tlv/TlvSchema.d.ts:19 ___ @@ -333,7 +333,7 @@ TlvSchema.injectField #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:20 +matter.js/dist/esm/tlv/TlvSchema.d.ts:20 ___ @@ -359,7 +359,7 @@ TlvSchema.removeField #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:21 +matter.js/dist/esm/tlv/TlvSchema.d.ts:21 ___ @@ -389,4 +389,4 @@ Schema.validate #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:15 +matter.js/dist/esm/schema/Schema.d.ts:15 diff --git a/docs/matter-node-ble.js/classes/internal_.UdpMulticastServer.md b/docs/matter-node-ble.js/classes/internal_.UdpMulticastServer.md new file mode 100644 index 0000000000..4adc109cd0 --- /dev/null +++ b/docs/matter-node-ble.js/classes/internal_.UdpMulticastServer.md @@ -0,0 +1,206 @@ +[@project-chip/matter-node-ble.js](../README.md) / [Exports](../modules.md) / [](../modules/internal_.md) / UdpMulticastServer + +# Class: UdpMulticastServer + +[](../modules/internal_.md).UdpMulticastServer + +## Table of contents + +### Constructors + +- [constructor](internal_.UdpMulticastServer.md#constructor) + +### Properties + +- [broadcastAddressIpv4](internal_.UdpMulticastServer.md#broadcastaddressipv4) +- [broadcastAddressIpv6](internal_.UdpMulticastServer.md#broadcastaddressipv6) +- [broadcastChannels](internal_.UdpMulticastServer.md#broadcastchannels) +- [broadcastPort](internal_.UdpMulticastServer.md#broadcastport) +- [createBroadcastChannel](internal_.UdpMulticastServer.md#createbroadcastchannel) +- [netInterface](internal_.UdpMulticastServer.md#netinterface) +- [network](internal_.UdpMulticastServer.md#network) +- [serverIpv4](internal_.UdpMulticastServer.md#serveripv4) +- [serverIpv6](internal_.UdpMulticastServer.md#serveripv6) + +### Methods + +- [close](internal_.UdpMulticastServer.md#close) +- [onMessage](internal_.UdpMulticastServer.md#onmessage) +- [send](internal_.UdpMulticastServer.md#send) +- [create](internal_.UdpMulticastServer.md#create) + +## Constructors + +### constructor + +• `Private` **new UdpMulticastServer**() + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:23 + +## Properties + +### broadcastAddressIpv4 + +• `Private` `Readonly` **broadcastAddressIpv4**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:15 + +___ + +### broadcastAddressIpv6 + +• `Private` `Readonly` **broadcastAddressIpv6**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:16 + +___ + +### broadcastChannels + +• `Private` `Readonly` **broadcastChannels**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:22 + +___ + +### broadcastPort + +• `Private` `Readonly` **broadcastPort**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:17 + +___ + +### createBroadcastChannel + +• `Private` **createBroadcastChannel**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:26 + +___ + +### netInterface + +• `Private` `Readonly` **netInterface**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:20 + +___ + +### network + +• `Private` `Readonly` **network**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:14 + +___ + +### serverIpv4 + +• `Private` `Readonly` **serverIpv4**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:18 + +___ + +### serverIpv6 + +• `Private` `Readonly` **serverIpv6**: `any` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:19 + +## Methods + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:27 + +___ + +### onMessage + +▸ **onMessage**(`listener`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `listener` | (`message`: `Uint8Array`, `peerAddress`: `string`, `netInterface`: `string`) => `void` | + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:24 + +___ + +### send + +▸ **send**(`message`, `netInterface?`, `uniCastTarget?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `Uint8Array` | +| `netInterface?` | `string` | +| `uniCastTarget?` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:25 + +___ + +### create + +▸ `Static` **create**(`«destructured»`): `Promise`<[`UdpMulticastServer`](internal_.UdpMulticastServer.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | [`UdpMulticastServerOptions`](../interfaces/internal_.UdpMulticastServerOptions.md) | + +#### Returns + +`Promise`<[`UdpMulticastServer`](internal_.UdpMulticastServer.md)\> + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:21 diff --git a/docs/matter-node-ble.js/classes/internal_.UnsecureSession.md b/docs/matter-node-ble.js/classes/internal_.UnsecureSession.md index 124072e4f3..3f658f62aa 100644 --- a/docs/matter-node-ble.js/classes/internal_.UnsecureSession.md +++ b/docs/matter-node-ble.js/classes/internal_.UnsecureSession.md @@ -22,6 +22,7 @@ ### Properties +- [closingAfterExchangeFinished](internal_.UnsecureSession.md#closingafterexchangefinished) - [context](internal_.UnsecureSession.md#context) - [initiatorNodeId](internal_.UnsecureSession.md#initiatornodeid) @@ -69,17 +70,31 @@ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:14 +matter.js/dist/esm/session/UnsecureSession.d.ts:15 ## Properties +### closingAfterExchangeFinished + +• `Readonly` **closingAfterExchangeFinished**: ``false`` + +#### Implementation of + +[Session](../interfaces/internal_.Session.md).[closingAfterExchangeFinished](../interfaces/internal_.Session.md#closingafterexchangefinished) + +#### Defined in + +matter.js/dist/esm/session/UnsecureSession.d.ts:14 + +___ + ### context • `Private` `Readonly` **context**: `any` #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:12 +matter.js/dist/esm/session/UnsecureSession.d.ts:12 ___ @@ -89,7 +104,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:13 +matter.js/dist/esm/session/UnsecureSession.d.ts:13 ## Accessors @@ -107,7 +122,7 @@ matter.js/dist/cjs/session/UnsecureSession.d.ts:13 #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:23 +matter.js/dist/esm/session/UnsecureSession.d.ts:24 ## Methods @@ -131,19 +146,13 @@ matter.js/dist/cjs/session/UnsecureSession.d.ts:23 #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:19 +matter.js/dist/esm/session/UnsecureSession.d.ts:20 ___ ### destroy -▸ **destroy**(`_sendClose`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sendClose` | `boolean` | +▸ **destroy**(): `Promise`<`void`\> #### Returns @@ -155,7 +164,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:34 +matter.js/dist/esm/session/UnsecureSession.d.ts:35 ___ @@ -179,7 +188,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:20 +matter.js/dist/esm/session/UnsecureSession.d.ts:21 ___ @@ -203,7 +212,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:35 +matter.js/dist/esm/session/UnsecureSession.d.ts:36 ___ @@ -221,7 +230,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:36 +matter.js/dist/esm/session/UnsecureSession.d.ts:37 ___ @@ -235,7 +244,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:21 +matter.js/dist/esm/session/UnsecureSession.d.ts:22 ___ @@ -253,7 +262,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:29 +matter.js/dist/esm/session/UnsecureSession.d.ts:30 ___ @@ -271,7 +280,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:30 +matter.js/dist/esm/session/UnsecureSession.d.ts:31 ___ @@ -295,7 +304,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:24 +matter.js/dist/esm/session/UnsecureSession.d.ts:25 ___ @@ -313,7 +322,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:32 +matter.js/dist/esm/session/UnsecureSession.d.ts:33 ___ @@ -331,7 +340,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:33 +matter.js/dist/esm/session/UnsecureSession.d.ts:34 ___ @@ -349,7 +358,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:31 +matter.js/dist/esm/session/UnsecureSession.d.ts:32 ___ @@ -367,7 +376,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:16 +matter.js/dist/esm/session/UnsecureSession.d.ts:17 ___ @@ -385,7 +394,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:18 +matter.js/dist/esm/session/UnsecureSession.d.ts:19 ___ @@ -403,7 +412,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:15 +matter.js/dist/esm/session/UnsecureSession.d.ts:16 ___ @@ -427,7 +436,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:17 +matter.js/dist/esm/session/UnsecureSession.d.ts:18 ___ @@ -447,4 +456,4 @@ ___ #### Defined in -matter.js/dist/cjs/session/UnsecureSession.d.ts:22 +matter.js/dist/esm/session/UnsecureSession.d.ts:23 diff --git a/docs/matter-node-ble.js/classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md b/docs/matter-node-ble.js/classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md similarity index 79% rename from docs/matter-node-ble.js/classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md rename to docs/matter-node-ble.js/classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md index 1c6466d349..8130cbc805 100644 --- a/docs/matter-node-ble.js/classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md +++ b/docs/matter-node-ble.js/classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md @@ -1,8 +1,8 @@ -[@project-chip/matter-node-ble.js](../README.md) / [Exports](../modules.md) / [](../modules/internal_.md) / ["/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"](../modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md) / ObjectSchema +[@project-chip/matter-node-ble.js](../README.md) / [Exports](../modules.md) / [](../modules/internal_.md) / ["/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"](../modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md) / ObjectSchema # Class: ObjectSchema -[](../modules/internal_.md).["/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"](../modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md).ObjectSchema +[](../modules/internal_.md).["/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"](../modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md).ObjectSchema Schema to encode an object in TLV. @@ -26,28 +26,28 @@ MatterCoreSpecificationV1_0 § A.5.1 and § A.11.4 ### Constructors -- [constructor](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#constructor) +- [constructor](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#constructor) ### Properties -- [fieldById](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#fieldbyid) -- [fieldDefinitions](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#fielddefinitions) -- [type](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#type) +- [fieldById](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#fieldbyid) +- [fieldDefinitions](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#fielddefinitions) +- [type](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#type) ### Methods -- [decode](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#decode) -- [decodeInternal](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#decodeinternal) -- [decodeTlv](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#decodetlv) -- [decodeTlvInternal](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#decodetlvinternal) -- [decodeTlvInternalValue](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#decodetlvinternalvalue) -- [encode](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#encode) -- [encodeInternal](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#encodeinternal) -- [encodeTlv](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#encodetlv) -- [encodeTlvInternal](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#encodetlvinternal) -- [injectField](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#injectfield) -- [removeField](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#removefield) -- [validate](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md#validate) +- [decode](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#decode) +- [decodeInternal](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#decodeinternal) +- [decodeTlv](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#decodetlv) +- [decodeTlvInternal](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#decodetlvinternal) +- [decodeTlvInternalValue](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#decodetlvinternalvalue) +- [encode](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#encode) +- [encodeInternal](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#encodeinternal) +- [encodeTlv](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#encodetlv) +- [encodeTlvInternal](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#encodetlvinternal) +- [injectField](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#injectfield) +- [removeField](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#removefield) +- [validate](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md#validate) ## Constructors @@ -74,7 +74,7 @@ TlvSchema<TypeFromFields<F\>\>.constructor #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:44 +matter.js/dist/esm/tlv/TlvObject.d.ts:44 ## Properties @@ -84,7 +84,7 @@ matter.js/dist/cjs/tlv/TlvObject.d.ts:44 #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:43 +matter.js/dist/esm/tlv/TlvObject.d.ts:43 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:41 +matter.js/dist/esm/tlv/TlvObject.d.ts:41 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:42 +matter.js/dist/esm/tlv/TlvObject.d.ts:42 ## Methods @@ -131,7 +131,7 @@ TlvSchema.decode #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:11 +matter.js/dist/esm/schema/Schema.d.ts:11 ___ @@ -155,7 +155,7 @@ TlvSchema.decodeInternal #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:10 +matter.js/dist/esm/tlv/TlvSchema.d.ts:10 ___ @@ -179,7 +179,7 @@ TlvSchema.decodeTlv #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:13 +matter.js/dist/esm/tlv/TlvSchema.d.ts:13 ___ @@ -208,7 +208,7 @@ TlvSchema.decodeTlvInternal #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:14 +matter.js/dist/esm/tlv/TlvSchema.d.ts:14 ___ @@ -233,7 +233,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:46 +matter.js/dist/esm/tlv/TlvObject.d.ts:46 ___ @@ -259,7 +259,7 @@ TlvSchema.encode #### Defined in -matter.js/dist/cjs/schema/Schema.d.ts:9 +matter.js/dist/esm/schema/Schema.d.ts:9 ___ @@ -283,7 +283,7 @@ TlvSchema.encodeInternal #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:11 +matter.js/dist/esm/tlv/TlvSchema.d.ts:11 ___ @@ -307,7 +307,7 @@ TlvSchema.encodeTlv #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:12 +matter.js/dist/esm/tlv/TlvSchema.d.ts:12 ___ @@ -333,7 +333,7 @@ TlvSchema.encodeTlvInternal #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:45 +matter.js/dist/esm/tlv/TlvObject.d.ts:45 ___ @@ -360,7 +360,7 @@ TlvSchema.injectField #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:48 +matter.js/dist/esm/tlv/TlvObject.d.ts:48 ___ @@ -386,7 +386,7 @@ TlvSchema.removeField #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:49 +matter.js/dist/esm/tlv/TlvObject.d.ts:49 ___ @@ -410,4 +410,4 @@ TlvSchema.validate #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:47 +matter.js/dist/esm/tlv/TlvObject.d.ts:47 diff --git a/docs/matter-node-ble.js/enums/internal_.AccessLevel.md b/docs/matter-node-ble.js/enums/internal_.AccessLevel.md index 25cd18fd02..2b688bcd5c 100644 --- a/docs/matter-node-ble.js/enums/internal_.AccessLevel.md +++ b/docs/matter-node-ble.js/enums/internal_.AccessLevel.md @@ -21,7 +21,7 @@ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:22 +matter.js/dist/esm/cluster/Cluster.d.ts:22 ___ @@ -31,7 +31,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:21 +matter.js/dist/esm/cluster/Cluster.d.ts:21 ___ @@ -41,7 +41,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:20 +matter.js/dist/esm/cluster/Cluster.d.ts:20 ___ @@ -51,4 +51,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:19 +matter.js/dist/esm/cluster/Cluster.d.ts:19 diff --git a/docs/matter-node-ble.js/enums/internal_.CommissioningWindowStatus.md b/docs/matter-node-ble.js/enums/internal_.CommissioningWindowStatus.md index 1b5f96254c..9a8b0ee9ff 100644 --- a/docs/matter-node-ble.js/enums/internal_.CommissioningWindowStatus.md +++ b/docs/matter-node-ble.js/enums/internal_.CommissioningWindowStatus.md @@ -26,7 +26,7 @@ A Basic Commissioning Method window is open #### Defined in -matter.js/dist/cjs/cluster/definitions/AdministratorCommissioningCluster.d.ts:26 +matter.js/dist/esm/cluster/definitions/AdministratorCommissioningCluster.d.ts:26 ___ @@ -38,7 +38,7 @@ An Enhanced Commissioning Method window is open #### Defined in -matter.js/dist/cjs/cluster/definitions/AdministratorCommissioningCluster.d.ts:22 +matter.js/dist/esm/cluster/definitions/AdministratorCommissioningCluster.d.ts:22 ___ @@ -50,4 +50,4 @@ Commissioning window not open #### Defined in -matter.js/dist/cjs/cluster/definitions/AdministratorCommissioningCluster.d.ts:18 +matter.js/dist/esm/cluster/definitions/AdministratorCommissioningCluster.d.ts:18 diff --git a/docs/matter-node-ble.js/enums/internal_.CurveType.md b/docs/matter-node-ble.js/enums/internal_.CurveType.md index 9120e06a09..1f7e398b23 100644 --- a/docs/matter-node-ble.js/enums/internal_.CurveType.md +++ b/docs/matter-node-ble.js/enums/internal_.CurveType.md @@ -20,7 +20,7 @@ #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:13 +matter.js/dist/esm/crypto/Key.d.ts:13 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:14 +matter.js/dist/esm/crypto/Key.d.ts:14 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:15 +matter.js/dist/esm/crypto/Key.d.ts:15 diff --git a/docs/matter-node-ble.js/enums/internal_.DeviceClasses.md b/docs/matter-node-ble.js/enums/internal_.DeviceClasses.md index 121faf2c6c..8770359bff 100644 --- a/docs/matter-node-ble.js/enums/internal_.DeviceClasses.md +++ b/docs/matter-node-ble.js/enums/internal_.DeviceClasses.md @@ -37,7 +37,7 @@ Application devices types are typically the most datatype endpoints on a node an #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:19 +matter.js/dist/esm/device/DeviceTypes.d.ts:19 ___ @@ -50,7 +50,7 @@ its power source is available to the Bridge #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:48 +matter.js/dist/esm/device/DeviceTypes.d.ts:48 ___ @@ -62,7 +62,7 @@ There exists a client application cluster on the endpoint. #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:33 +matter.js/dist/esm/device/DeviceTypes.d.ts:33 ___ @@ -74,7 +74,7 @@ The device type is composed of 2 or more device types. #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:37 +matter.js/dist/esm/device/DeviceTypes.d.ts:37 ___ @@ -89,7 +89,7 @@ application device type. #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:31 +matter.js/dist/esm/device/DeviceTypes.d.ts:31 ___ @@ -101,7 +101,7 @@ The endpoint is an Initiator for Zigbee EZ-Mode Finding & Binding. #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:41 +matter.js/dist/esm/device/DeviceTypes.d.ts:41 ___ @@ -113,7 +113,7 @@ The endpoint is a Target for Zigbee EZ-Mode Finding & Binding. #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:43 +matter.js/dist/esm/device/DeviceTypes.d.ts:43 ___ @@ -125,7 +125,7 @@ Composed device type that is composed of 2 or more endpoints with the same devic #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:39 +matter.js/dist/esm/device/DeviceTypes.d.ts:39 ___ @@ -137,7 +137,7 @@ Node device type. #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:14 +matter.js/dist/esm/device/DeviceTypes.d.ts:14 ___ @@ -149,7 +149,7 @@ There exists a server application cluster on the endpoint. #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:35 +matter.js/dist/esm/device/DeviceTypes.d.ts:35 ___ @@ -162,4 +162,4 @@ A Simple device type supports local control that is persistent, independent, and #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:24 +matter.js/dist/esm/device/DeviceTypes.d.ts:24 diff --git a/docs/matter-node-ble.js/enums/internal_.EventPriority.md b/docs/matter-node-ble.js/enums/internal_.EventPriority.md index e337bef0ad..5bc6ea03e5 100644 --- a/docs/matter-node-ble.js/enums/internal_.EventPriority.md +++ b/docs/matter-node-ble.js/enums/internal_.EventPriority.md @@ -26,7 +26,7 @@ MatterCoreSpecificationV1_1 § 7.18.2.25 #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:161 +matter.js/dist/esm/cluster/Cluster.d.ts:161 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:159 +matter.js/dist/esm/cluster/Cluster.d.ts:159 ___ @@ -46,4 +46,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:160 +matter.js/dist/esm/cluster/Cluster.d.ts:160 diff --git a/docs/matter-node-ble.js/enums/internal_.KeyType.md b/docs/matter-node-ble.js/enums/internal_.KeyType.md index 32a5549701..a5417cd34a 100644 --- a/docs/matter-node-ble.js/enums/internal_.KeyType.md +++ b/docs/matter-node-ble.js/enums/internal_.KeyType.md @@ -20,7 +20,7 @@ #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:8 +matter.js/dist/esm/crypto/Key.d.ts:8 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:9 +matter.js/dist/esm/crypto/Key.d.ts:9 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:10 +matter.js/dist/esm/crypto/Key.d.ts:10 diff --git a/docs/matter-node-ble.js/enums/internal_.NodeStateInformation.md b/docs/matter-node-ble.js/enums/internal_.NodeStateInformation.md new file mode 100644 index 0000000000..40cbe65a38 --- /dev/null +++ b/docs/matter-node-ble.js/enums/internal_.NodeStateInformation.md @@ -0,0 +1,78 @@ +[@project-chip/matter-node-ble.js](../README.md) / [Exports](../modules.md) / [](../modules/internal_.md) / NodeStateInformation + +# Enumeration: NodeStateInformation + +[](../modules/internal_.md).NodeStateInformation + +## Table of contents + +### Enumeration Members + +- [Connected](internal_.NodeStateInformation.md#connected) +- [Disconnected](internal_.NodeStateInformation.md#disconnected) +- [Reconnecting](internal_.NodeStateInformation.md#reconnecting) +- [StructureChanged](internal_.NodeStateInformation.md#structurechanged) +- [WaitingForDeviceDiscovery](internal_.NodeStateInformation.md#waitingfordevicediscovery) + +## Enumeration Members + +### Connected + +• **Connected** = ``0`` + +Node is connected and all data is up-to-date. + +#### Defined in + +matter.js/dist/esm/device/PairedNode.d.ts:19 + +___ + +### Disconnected + +• **Disconnected** = ``1`` + +Node is disconnected. Data are stale and interactions will most likely return an error. If controller instance +is still active then the device will be reconnected once it is available again. + +#### Defined in + +matter.js/dist/esm/device/PairedNode.d.ts:24 + +___ + +### Reconnecting + +• **Reconnecting** = ``2`` + +Node is reconnecting. Data are stale. It is yet unknown if the reconnection is successful. + +#### Defined in + +matter.js/dist/esm/device/PairedNode.d.ts:26 + +___ + +### StructureChanged + +• **StructureChanged** = ``4`` + +Node structure has changed (Endpoints got added or also removed). Data are up-to-date. +This State information will only be fired when the subscribeAllAttributesAndEvents option is set to true. + +#### Defined in + +matter.js/dist/esm/device/PairedNode.d.ts:36 + +___ + +### WaitingForDeviceDiscovery + +• **WaitingForDeviceDiscovery** = ``3`` + +The node could not be connected and the controller is now waiting for a MDNS announcement and tries every 10 +minutes to reconnect. + +#### Defined in + +matter.js/dist/esm/device/PairedNode.d.ts:31 diff --git a/docs/matter-node-ble.js/enums/internal_.ProtocolStatusCode.md b/docs/matter-node-ble.js/enums/internal_.ProtocolStatusCode.md index d2cd5053e1..1f020ccc38 100644 --- a/docs/matter-node-ble.js/enums/internal_.ProtocolStatusCode.md +++ b/docs/matter-node-ble.js/enums/internal_.ProtocolStatusCode.md @@ -22,7 +22,7 @@ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessages.d.ts:25 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessages.d.ts:25 ___ @@ -32,7 +32,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessages.d.ts:24 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessages.d.ts:24 ___ @@ -42,7 +42,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessages.d.ts:23 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessages.d.ts:23 ___ @@ -52,7 +52,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessages.d.ts:22 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessages.d.ts:22 ___ @@ -62,4 +62,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/securechannel/SecureChannelMessages.d.ts:21 +matter.js/dist/esm/protocol/securechannel/SecureChannelMessages.d.ts:21 diff --git a/docs/matter-node-ble.js/enums/internal_.RegulatoryLocationType.md b/docs/matter-node-ble.js/enums/internal_.RegulatoryLocationType.md index e16acf8dc3..87aae53e64 100644 --- a/docs/matter-node-ble.js/enums/internal_.RegulatoryLocationType.md +++ b/docs/matter-node-ble.js/enums/internal_.RegulatoryLocationType.md @@ -29,7 +29,7 @@ Indoor only #### Defined in -matter.js/dist/cjs/cluster/definitions/GeneralCommissioningCluster.d.ts:47 +matter.js/dist/esm/cluster/definitions/GeneralCommissioningCluster.d.ts:47 ___ @@ -41,7 +41,7 @@ Indoor/Outdoor #### Defined in -matter.js/dist/cjs/cluster/definitions/GeneralCommissioningCluster.d.ts:55 +matter.js/dist/esm/cluster/definitions/GeneralCommissioningCluster.d.ts:55 ___ @@ -53,4 +53,4 @@ Outdoor only #### Defined in -matter.js/dist/cjs/cluster/definitions/GeneralCommissioningCluster.d.ts:51 +matter.js/dist/esm/cluster/definitions/GeneralCommissioningCluster.d.ts:51 diff --git a/docs/matter-node-ble.js/enums/internal_.SessionType.md b/docs/matter-node-ble.js/enums/internal_.SessionType.md index 468ce898ed..defba6139b 100644 --- a/docs/matter-node-ble.js/enums/internal_.SessionType.md +++ b/docs/matter-node-ble.js/enums/internal_.SessionType.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:38 +matter.js/dist/esm/codec/MessageCodec.d.ts:38 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:39 +matter.js/dist/esm/codec/MessageCodec.d.ts:39 diff --git a/docs/matter-node-ble.js/enums/internal_.StatusCode.md b/docs/matter-node-ble.js/enums/internal_.StatusCode.md index 94241c5a9b..3581537ef7 100644 --- a/docs/matter-node-ble.js/enums/internal_.StatusCode.md +++ b/docs/matter-node-ble.js/enums/internal_.StatusCode.md @@ -48,7 +48,7 @@ MatterCoreSpecificationV1_0, section 8.10 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:28 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:28 ___ @@ -58,7 +58,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:18 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:18 ___ @@ -68,7 +68,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:25 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:25 ___ @@ -78,7 +78,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:35 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:35 ___ @@ -88,7 +88,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:10 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:10 ___ @@ -98,7 +98,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:14 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:14 ___ @@ -108,7 +108,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:16 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:16 ___ @@ -118,7 +118,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:23 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:23 ___ @@ -128,7 +128,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:11 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:11 ___ @@ -138,7 +138,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:31 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:31 ___ @@ -148,7 +148,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:30 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:30 ___ @@ -158,7 +158,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:21 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:21 ___ @@ -168,7 +168,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:33 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:33 ___ @@ -178,7 +178,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:20 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:20 ___ @@ -188,7 +188,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:9 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:9 ___ @@ -198,7 +198,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:34 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:34 ___ @@ -208,7 +208,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:26 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:26 ___ @@ -218,7 +218,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:22 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:22 ___ @@ -228,7 +228,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:12 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:12 ___ @@ -238,7 +238,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:17 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:17 ___ @@ -248,7 +248,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:29 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:29 ___ @@ -258,7 +258,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:15 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:15 ___ @@ -268,7 +268,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:13 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:13 ___ @@ -278,7 +278,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:32 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:32 ___ @@ -288,7 +288,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:27 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:27 ___ @@ -298,7 +298,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:24 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:24 ___ @@ -308,4 +308,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:19 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:19 diff --git a/docs/matter-node-ble.js/enums/internal_.TlvLength.md b/docs/matter-node-ble.js/enums/internal_.TlvLength.md index 6fad799e9d..28da18de3c 100644 --- a/docs/matter-node-ble.js/enums/internal_.TlvLength.md +++ b/docs/matter-node-ble.js/enums/internal_.TlvLength.md @@ -23,7 +23,7 @@ Byte length of the encoded value or length. #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:32 +matter.js/dist/esm/tlv/TlvCodec.d.ts:32 ___ @@ -33,7 +33,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:31 +matter.js/dist/esm/tlv/TlvCodec.d.ts:31 ___ @@ -43,7 +43,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:29 +matter.js/dist/esm/tlv/TlvCodec.d.ts:29 ___ @@ -53,4 +53,4 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:30 +matter.js/dist/esm/tlv/TlvCodec.d.ts:30 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Attribute.md b/docs/matter-node-ble.js/interfaces/internal_.Attribute.md index a89d578e4b..d255b6f945 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Attribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Attribute.md @@ -41,7 +41,7 @@ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -51,7 +51,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:35 +matter.js/dist/esm/cluster/Cluster.d.ts:35 ___ @@ -61,7 +61,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:34 +matter.js/dist/esm/cluster/Cluster.d.ts:34 ___ @@ -71,7 +71,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -81,7 +81,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -91,7 +91,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -101,7 +101,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -111,7 +111,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:28 +matter.js/dist/esm/cluster/Cluster.d.ts:28 ___ @@ -121,7 +121,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -131,7 +131,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -141,7 +141,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -151,7 +151,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -161,7 +161,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -171,7 +171,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -181,7 +181,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -191,7 +191,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:30 +matter.js/dist/esm/cluster/Cluster.d.ts:30 ___ @@ -201,4 +201,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/interfaces/internal_.AttributeOptions.md b/docs/matter-node-ble.js/interfaces/internal_.AttributeOptions.md index de6c736a85..d987ed0f76 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.AttributeOptions.md +++ b/docs/matter-node-ble.js/interfaces/internal_.AttributeOptions.md @@ -30,7 +30,7 @@ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:89 +matter.js/dist/esm/cluster/Cluster.d.ts:89 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:87 +matter.js/dist/esm/cluster/Cluster.d.ts:87 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:86 +matter.js/dist/esm/cluster/Cluster.d.ts:86 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:90 +matter.js/dist/esm/cluster/Cluster.d.ts:90 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:85 +matter.js/dist/esm/cluster/Cluster.d.ts:85 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:88 +matter.js/dist/esm/cluster/Cluster.d.ts:88 ___ @@ -90,4 +90,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:91 +matter.js/dist/esm/cluster/Cluster.d.ts:91 diff --git a/docs/matter-node-ble.js/interfaces/internal_.AttributePath.md b/docs/matter-node-ble.js/interfaces/internal_.AttributePath.md index 554f2db06f..6b428fa320 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.AttributePath.md +++ b/docs/matter-node-ble.js/interfaces/internal_.AttributePath.md @@ -20,7 +20,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:34 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:34 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:33 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:33 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:32 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:32 diff --git a/docs/matter-node-ble.js/interfaces/internal_.AttributeStatus.md b/docs/matter-node-ble.js/interfaces/internal_.AttributeStatus.md index f73fcf0fb4..4a5cf54005 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.AttributeStatus.md +++ b/docs/matter-node-ble.js/interfaces/internal_.AttributeStatus.md @@ -28,7 +28,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:22 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:23 ___ @@ -38,4 +38,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionClient.d.ts:28 +matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:29 diff --git a/docs/matter-node-ble.js/interfaces/internal_.AttributeWithPath.md b/docs/matter-node-ble.js/interfaces/internal_.AttributeWithPath.md index df977e30a8..175907b619 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.AttributeWithPath.md +++ b/docs/matter-node-ble.js/interfaces/internal_.AttributeWithPath.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:43 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:43 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:42 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:42 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Channel.md b/docs/matter-node-ble.js/interfaces/internal_.Channel.md index df435744dc..073877a016 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Channel.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Channel.md @@ -39,7 +39,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -matter.js/dist/cjs/common/Channel.d.ts:7 +matter.js/dist/esm/common/Channel.d.ts:7 ## Methods @@ -53,7 +53,7 @@ matter.js/dist/cjs/common/Channel.d.ts:7 #### Defined in -matter.js/dist/cjs/common/Channel.d.ts:9 +matter.js/dist/esm/common/Channel.d.ts:9 ___ @@ -73,4 +73,4 @@ ___ #### Defined in -matter.js/dist/cjs/common/Channel.d.ts:8 +matter.js/dist/esm/common/Channel.d.ts:8 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Cluster.md b/docs/matter-node-ble.js/interfaces/internal_.Cluster.md index f10fec8a41..3a8770ec03 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Cluster.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Cluster.md @@ -36,7 +36,7 @@ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:232 +matter.js/dist/esm/cluster/Cluster.d.ts:232 ___ @@ -46,7 +46,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:233 +matter.js/dist/esm/cluster/Cluster.d.ts:233 ___ @@ -56,7 +56,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:234 +matter.js/dist/esm/cluster/Cluster.d.ts:234 ___ @@ -66,7 +66,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:230 +matter.js/dist/esm/cluster/Cluster.d.ts:230 ___ @@ -76,7 +76,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:227 +matter.js/dist/esm/cluster/Cluster.d.ts:227 ___ @@ -86,7 +86,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:228 +matter.js/dist/esm/cluster/Cluster.d.ts:228 ___ @@ -96,7 +96,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:229 +matter.js/dist/esm/cluster/Cluster.d.ts:229 ___ @@ -106,7 +106,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:231 +matter.js/dist/esm/cluster/Cluster.d.ts:231 ___ @@ -116,4 +116,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:235 +matter.js/dist/esm/cluster/Cluster.d.ts:235 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Command.md b/docs/matter-node-ble.js/interfaces/internal_.Command.md index 47dbd092ea..58c21391f6 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Command.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Command.md @@ -35,7 +35,7 @@ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:129 +matter.js/dist/esm/cluster/Cluster.d.ts:129 ___ @@ -45,7 +45,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:131 +matter.js/dist/esm/cluster/Cluster.d.ts:131 ___ @@ -55,7 +55,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:132 +matter.js/dist/esm/cluster/Cluster.d.ts:132 ___ @@ -65,7 +65,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:124 +matter.js/dist/esm/cluster/Cluster.d.ts:124 ___ @@ -75,7 +75,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:133 +matter.js/dist/esm/cluster/Cluster.d.ts:133 ___ @@ -85,7 +85,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:125 +matter.js/dist/esm/cluster/Cluster.d.ts:125 ___ @@ -95,7 +95,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:126 +matter.js/dist/esm/cluster/Cluster.d.ts:126 ___ @@ -105,7 +105,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:127 +matter.js/dist/esm/cluster/Cluster.d.ts:127 ___ @@ -115,7 +115,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:128 +matter.js/dist/esm/cluster/Cluster.d.ts:128 ___ @@ -125,4 +125,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:130 +matter.js/dist/esm/cluster/Cluster.d.ts:130 diff --git a/docs/matter-node-ble.js/interfaces/internal_.CommandOptions.md b/docs/matter-node-ble.js/interfaces/internal_.CommandOptions.md index 291537692f..2a04b0e7c6 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.CommandOptions.md +++ b/docs/matter-node-ble.js/interfaces/internal_.CommandOptions.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:144 +matter.js/dist/esm/cluster/Cluster.d.ts:144 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:145 +matter.js/dist/esm/cluster/Cluster.d.ts:145 diff --git a/docs/matter-node-ble.js/interfaces/internal_.CommandPath.md b/docs/matter-node-ble.js/interfaces/internal_.CommandPath.md index 662ca3f7ab..c2a5340cce 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.CommandPath.md +++ b/docs/matter-node-ble.js/interfaces/internal_.CommandPath.md @@ -20,7 +20,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:28 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:28 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:29 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:29 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:27 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:27 diff --git a/docs/matter-node-ble.js/interfaces/internal_.CommandWithPath.md b/docs/matter-node-ble.js/interfaces/internal_.CommandWithPath.md index cfe840dccf..e702dec47e 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.CommandWithPath.md +++ b/docs/matter-node-ble.js/interfaces/internal_.CommandWithPath.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:51 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:51 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:50 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:50 diff --git a/docs/matter-node-ble.js/interfaces/internal_.DeviceTypeDefinition.md b/docs/matter-node-ble.js/interfaces/internal_.DeviceTypeDefinition.md index 8cbadbf9e3..c09ad00121 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.DeviceTypeDefinition.md +++ b/docs/matter-node-ble.js/interfaces/internal_.DeviceTypeDefinition.md @@ -27,7 +27,7 @@ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:52 +matter.js/dist/esm/device/DeviceTypes.d.ts:52 ___ @@ -37,7 +37,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:53 +matter.js/dist/esm/device/DeviceTypes.d.ts:53 ___ @@ -47,7 +47,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:51 +matter.js/dist/esm/device/DeviceTypes.d.ts:51 ___ @@ -57,7 +57,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:59 +matter.js/dist/esm/device/DeviceTypes.d.ts:59 ___ @@ -67,7 +67,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:57 +matter.js/dist/esm/device/DeviceTypes.d.ts:57 ___ @@ -77,7 +77,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:58 +matter.js/dist/esm/device/DeviceTypes.d.ts:58 ___ @@ -87,7 +87,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:56 +matter.js/dist/esm/device/DeviceTypes.d.ts:56 ___ @@ -97,7 +97,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:55 +matter.js/dist/esm/device/DeviceTypes.d.ts:55 ___ @@ -107,7 +107,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:54 +matter.js/dist/esm/device/DeviceTypes.d.ts:54 ___ @@ -117,4 +117,4 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:60 +matter.js/dist/esm/device/DeviceTypes.d.ts:60 diff --git a/docs/matter-node-ble.js/interfaces/internal_.EndpointOptions.md b/docs/matter-node-ble.js/interfaces/internal_.EndpointOptions.md index d90350b715..6bf5f23731 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.EndpointOptions.md +++ b/docs/matter-node-ble.js/interfaces/internal_.EndpointOptions.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:15 +matter.js/dist/esm/device/Endpoint.d.ts:15 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/device/Endpoint.d.ts:16 +matter.js/dist/esm/device/Endpoint.d.ts:16 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Event.md b/docs/matter-node-ble.js/interfaces/internal_.Event.md index 94f64b71df..1897ef139a 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Event.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Event.md @@ -33,7 +33,7 @@ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:164 +matter.js/dist/esm/cluster/Cluster.d.ts:164 ___ @@ -43,7 +43,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:169 +matter.js/dist/esm/cluster/Cluster.d.ts:169 ___ @@ -53,7 +53,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:171 +matter.js/dist/esm/cluster/Cluster.d.ts:171 ___ @@ -63,7 +63,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:167 +matter.js/dist/esm/cluster/Cluster.d.ts:167 ___ @@ -73,7 +73,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:170 +matter.js/dist/esm/cluster/Cluster.d.ts:170 ___ @@ -83,7 +83,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:166 +matter.js/dist/esm/cluster/Cluster.d.ts:166 ___ @@ -93,7 +93,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:168 +matter.js/dist/esm/cluster/Cluster.d.ts:168 ___ @@ -103,7 +103,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:165 +matter.js/dist/esm/cluster/Cluster.d.ts:165 ___ @@ -113,4 +113,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:172 +matter.js/dist/esm/cluster/Cluster.d.ts:172 diff --git a/docs/matter-node-ble.js/interfaces/internal_.EventData.md b/docs/matter-node-ble.js/interfaces/internal_.EventData.md index cd3f72faa8..d7716523d9 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.EventData.md +++ b/docs/matter-node-ble.js/interfaces/internal_.EventData.md @@ -37,7 +37,7 @@ Data of one Event #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:18 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:18 ___ @@ -47,7 +47,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:22 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:22 ___ @@ -57,7 +57,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:17 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:17 ___ @@ -67,7 +67,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:20 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:20 ___ @@ -77,7 +77,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:19 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:19 ___ @@ -87,4 +87,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:21 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:21 diff --git a/docs/matter-node-ble.js/interfaces/internal_.EventOptions.md b/docs/matter-node-ble.js/interfaces/internal_.EventOptions.md index 1b2d0ba5d9..3ec7adbb58 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.EventOptions.md +++ b/docs/matter-node-ble.js/interfaces/internal_.EventOptions.md @@ -18,4 +18,4 @@ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:178 +matter.js/dist/esm/cluster/Cluster.d.ts:178 diff --git a/docs/matter-node-ble.js/interfaces/internal_.EventPath.md b/docs/matter-node-ble.js/interfaces/internal_.EventPath.md index 6b8e1c9c93..77cda3510f 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.EventPath.md +++ b/docs/matter-node-ble.js/interfaces/internal_.EventPath.md @@ -20,7 +20,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:38 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:38 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:37 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:37 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:39 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:39 diff --git a/docs/matter-node-ble.js/interfaces/internal_.EventStorageData.md b/docs/matter-node-ble.js/interfaces/internal_.EventStorageData.md index dc43781aa1..efe568635f 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.EventStorageData.md +++ b/docs/matter-node-ble.js/interfaces/internal_.EventStorageData.md @@ -42,7 +42,7 @@ Data of an event which was triggered and stored internally #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:18 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:18 ___ @@ -56,7 +56,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:22 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:22 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:17 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:17 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:20 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:20 ___ @@ -98,7 +98,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:19 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:19 ___ @@ -108,7 +108,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:28 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:28 ___ @@ -122,4 +122,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventHandler.d.ts:21 +matter.js/dist/esm/protocol/interaction/EventHandler.d.ts:21 diff --git a/docs/matter-node-ble.js/interfaces/internal_.EventWithPath.md b/docs/matter-node-ble.js/interfaces/internal_.EventWithPath.md index 334c4b0ae5..be9c1fb74d 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.EventWithPath.md +++ b/docs/matter-node-ble.js/interfaces/internal_.EventWithPath.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:47 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:47 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionServer.d.ts:46 +matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:46 diff --git a/docs/matter-node-ble.js/interfaces/internal_.FabricScopedAttribute.md b/docs/matter-node-ble.js/interfaces/internal_.FabricScopedAttribute.md index 04f46a0c39..2c38ac3d2d 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.FabricScopedAttribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.FabricScopedAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:60 +matter.js/dist/esm/cluster/Cluster.d.ts:60 ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:34 +matter.js/dist/esm/cluster/Cluster.d.ts:34 ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:28 +matter.js/dist/esm/cluster/Cluster.d.ts:28 ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:30 +matter.js/dist/esm/cluster/Cluster.d.ts:30 ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/interfaces/internal_.FieldType.md b/docs/matter-node-ble.js/interfaces/internal_.FieldType.md index 11e52238f2..f0539c7a25 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.FieldType.md +++ b/docs/matter-node-ble.js/interfaces/internal_.FieldType.md @@ -33,7 +33,7 @@ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:13 +matter.js/dist/esm/tlv/TlvObject.d.ts:13 ___ @@ -43,7 +43,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:10 +matter.js/dist/esm/tlv/TlvObject.d.ts:10 ___ @@ -53,7 +53,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:12 +matter.js/dist/esm/tlv/TlvObject.d.ts:12 ___ @@ -63,4 +63,4 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:11 +matter.js/dist/esm/tlv/TlvObject.d.ts:11 diff --git a/docs/matter-node-ble.js/interfaces/internal_.FixedAttribute.md b/docs/matter-node-ble.js/interfaces/internal_.FixedAttribute.md index ee904f0995..fb9c0b7265 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.FixedAttribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.FixedAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:35 +matter.js/dist/esm/cluster/Cluster.d.ts:35 ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:72 +matter.js/dist/esm/cluster/Cluster.d.ts:72 ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:28 +matter.js/dist/esm/cluster/Cluster.d.ts:28 ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:30 +matter.js/dist/esm/cluster/Cluster.d.ts:30 ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/interfaces/internal_.InstanceBroadcaster.md b/docs/matter-node-ble.js/interfaces/internal_.InstanceBroadcaster.md index 11a75b0fd3..460cc642ea 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.InstanceBroadcaster.md +++ b/docs/matter-node-ble.js/interfaces/internal_.InstanceBroadcaster.md @@ -36,7 +36,7 @@ Send out announcements for this instance. #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:261 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:261 ___ @@ -52,7 +52,7 @@ Expire all announcements. #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:267 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:267 ___ @@ -68,7 +68,7 @@ Expire the announcement for this commissioning instance. #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:265 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:265 ___ @@ -84,7 +84,7 @@ Expire the announcement for this operative instance. #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:263 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:263 ___ @@ -107,7 +107,7 @@ Set a commissionable mode and details to announce a commissionable device. #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:252 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:252 ___ @@ -129,7 +129,7 @@ Set commissioner details to announce a commissioner service for User directed co #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:259 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:259 ___ @@ -153,4 +153,4 @@ Use expireCommissioningAnnouncements = true when Fabrics are changed after a n c #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:257 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:257 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Key.md b/docs/matter-node-ble.js/interfaces/internal_.Key.md index 04fd2c90af..1f57841540 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Key.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Key.md @@ -85,7 +85,7 @@ JsonWebKey.alg #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:57 +matter.js/dist/esm/crypto/Key.d.ts:57 ___ @@ -97,7 +97,7 @@ The key algorithm, alias for JWK "alg" field. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:35 +matter.js/dist/esm/crypto/Key.d.ts:35 ___ @@ -111,7 +111,7 @@ JsonWebKey.crv #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:58 +matter.js/dist/esm/crypto/Key.d.ts:58 ___ @@ -123,7 +123,7 @@ The elliptic curve type, alias for JWK "crv" field. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:39 +matter.js/dist/esm/crypto/Key.d.ts:39 ___ @@ -137,7 +137,7 @@ JsonWebKey.d #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:59 +matter.js/dist/esm/crypto/Key.d.ts:59 ___ @@ -151,7 +151,7 @@ JsonWebKey.dp #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:60 +matter.js/dist/esm/crypto/Key.d.ts:60 ___ @@ -165,7 +165,7 @@ JsonWebKey.dq #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:61 +matter.js/dist/esm/crypto/Key.d.ts:61 ___ @@ -179,7 +179,7 @@ JsonWebKey.e #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:62 +matter.js/dist/esm/crypto/Key.d.ts:62 ___ @@ -193,7 +193,7 @@ JsonWebKey.ext #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:63 +matter.js/dist/esm/crypto/Key.d.ts:63 ___ @@ -206,7 +206,7 @@ field. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:56 +matter.js/dist/esm/crypto/Key.d.ts:56 ___ @@ -220,7 +220,7 @@ JsonWebKey.k #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:64 +matter.js/dist/esm/crypto/Key.d.ts:64 ___ @@ -232,7 +232,7 @@ Alias for keyPairBits that throws if a complete key pair is not present. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:123 +matter.js/dist/esm/crypto/Key.d.ts:123 ___ @@ -245,7 +245,7 @@ serialization format for legacy reasons. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:111 +matter.js/dist/esm/crypto/Key.d.ts:111 ___ @@ -259,7 +259,7 @@ JsonWebKey.key\_ops #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:65 +matter.js/dist/esm/crypto/Key.d.ts:65 ___ @@ -273,7 +273,7 @@ JsonWebKey.kty #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:66 +matter.js/dist/esm/crypto/Key.d.ts:66 ___ @@ -287,7 +287,7 @@ JsonWebKey.n #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:67 +matter.js/dist/esm/crypto/Key.d.ts:67 ___ @@ -299,7 +299,7 @@ Operations supported by the key, alias for JWK "key_ops" field. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:47 +matter.js/dist/esm/crypto/Key.d.ts:47 ___ @@ -313,7 +313,7 @@ JsonWebKey.oth #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:68 +matter.js/dist/esm/crypto/Key.d.ts:68 ___ @@ -327,7 +327,7 @@ JsonWebKey.p #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:69 +matter.js/dist/esm/crypto/Key.d.ts:69 ___ @@ -339,7 +339,7 @@ Import (write-only) of private keys encoded in PKCS #8 format. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:97 +matter.js/dist/esm/crypto/Key.d.ts:97 ___ @@ -351,7 +351,7 @@ The private key, alias for JWK "d" field. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:51 +matter.js/dist/esm/crypto/Key.d.ts:51 ___ @@ -364,7 +364,7 @@ base-64 private key. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:79 +matter.js/dist/esm/crypto/Key.d.ts:79 ___ @@ -376,7 +376,7 @@ Alias for privateBits that throws if no private key is present. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:119 +matter.js/dist/esm/crypto/Key.d.ts:119 ___ @@ -389,7 +389,7 @@ fields internally. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:106 +matter.js/dist/esm/crypto/Key.d.ts:106 ___ @@ -401,7 +401,7 @@ Alias for publicBits that throws if no public key is present. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:115 +matter.js/dist/esm/crypto/Key.d.ts:115 ___ @@ -415,7 +415,7 @@ JsonWebKey.q #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:70 +matter.js/dist/esm/crypto/Key.d.ts:70 ___ @@ -429,7 +429,7 @@ JsonWebKey.qi #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:71 +matter.js/dist/esm/crypto/Key.d.ts:71 ___ @@ -441,7 +441,7 @@ Import (write-only) of private keys encoded in SEC1 format. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:93 +matter.js/dist/esm/crypto/Key.d.ts:93 ___ @@ -453,7 +453,7 @@ Import (write-only) of public keys encoded in SPKI format. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:101 +matter.js/dist/esm/crypto/Key.d.ts:101 ___ @@ -465,7 +465,7 @@ The key type, alias for JWK "kty" field. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:43 +matter.js/dist/esm/crypto/Key.d.ts:43 ___ @@ -479,7 +479,7 @@ JsonWebKey.use #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:72 +matter.js/dist/esm/crypto/Key.d.ts:72 ___ @@ -493,7 +493,7 @@ JsonWebKey.x #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:73 +matter.js/dist/esm/crypto/Key.d.ts:73 ___ @@ -506,7 +506,7 @@ x-point on EC public keys. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:84 +matter.js/dist/esm/crypto/Key.d.ts:84 ___ @@ -520,7 +520,7 @@ JsonWebKey.y #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:74 +matter.js/dist/esm/crypto/Key.d.ts:74 ___ @@ -533,4 +533,4 @@ y-point on EC public keys. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:89 +matter.js/dist/esm/crypto/Key.d.ts:89 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Listener.md b/docs/matter-node-ble.js/interfaces/internal_.Listener.md index 5880e3a336..b7f6786acd 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Listener.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Listener.md @@ -22,4 +22,4 @@ #### Defined in -matter.js/dist/cjs/common/TransportInterface.d.ts:9 +matter.js/dist/esm/common/TransportInterface.d.ts:9 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Message.md b/docs/matter-node-ble.js/interfaces/internal_.Message.md index 65fa578bfc..0c3d2c75a9 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Message.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Message.md @@ -20,7 +20,7 @@ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:33 +matter.js/dist/esm/codec/MessageCodec.d.ts:33 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:35 +matter.js/dist/esm/codec/MessageCodec.d.ts:35 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:34 +matter.js/dist/esm/codec/MessageCodec.d.ts:34 diff --git a/docs/matter-node-ble.js/interfaces/internal_.MrpParameters.md b/docs/matter-node-ble.js/interfaces/internal_.MrpParameters.md index c0f4ce3a02..56dd1c1ea0 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.MrpParameters.md +++ b/docs/matter-node-ble.js/interfaces/internal_.MrpParameters.md @@ -20,7 +20,7 @@ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:20 +matter.js/dist/esm/session/Session.d.ts:20 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:19 +matter.js/dist/esm/session/Session.d.ts:19 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:21 +matter.js/dist/esm/session/Session.d.ts:21 diff --git a/docs/matter-node-ble.js/interfaces/internal_.NetInterface.md b/docs/matter-node-ble.js/interfaces/internal_.NetInterface.md index d269f259f1..88be9ba2a4 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.NetInterface.md +++ b/docs/matter-node-ble.js/interfaces/internal_.NetInterface.md @@ -36,7 +36,7 @@ A Network interface enhances a TransportInterface with the ability to open a cha #### Defined in -matter.js/dist/cjs/common/TransportInterface.d.ts:17 +matter.js/dist/esm/common/TransportInterface.d.ts:17 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/TransportInterface.d.ts:16 +matter.js/dist/esm/common/TransportInterface.d.ts:16 ___ @@ -80,4 +80,4 @@ ___ #### Defined in -matter.js/dist/cjs/net/NetInterface.d.ts:14 +matter.js/dist/esm/net/NetInterface.d.ts:14 diff --git a/docs/matter-node-ble.js/interfaces/internal_.OptionalAttribute.md b/docs/matter-node-ble.js/interfaces/internal_.OptionalAttribute.md index 22315120e0..bcbc55fdea 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.OptionalAttribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.OptionalAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:35 +matter.js/dist/esm/cluster/Cluster.d.ts:35 ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:34 +matter.js/dist/esm/cluster/Cluster.d.ts:34 ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:45 +matter.js/dist/esm/cluster/Cluster.d.ts:45 ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:30 +matter.js/dist/esm/cluster/Cluster.d.ts:30 ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/interfaces/internal_.OptionalCommand.md b/docs/matter-node-ble.js/interfaces/internal_.OptionalCommand.md index c90fb5736c..31b79a3e6d 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.OptionalCommand.md +++ b/docs/matter-node-ble.js/interfaces/internal_.OptionalCommand.md @@ -45,7 +45,7 @@ Command.invokeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:129 +matter.js/dist/esm/cluster/Cluster.d.ts:129 ___ @@ -59,7 +59,7 @@ Command.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:131 +matter.js/dist/esm/cluster/Cluster.d.ts:131 ___ @@ -73,7 +73,7 @@ Command.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:132 +matter.js/dist/esm/cluster/Cluster.d.ts:132 ___ @@ -87,7 +87,7 @@ Command.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:136 +matter.js/dist/esm/cluster/Cluster.d.ts:136 ___ @@ -101,7 +101,7 @@ Command.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:133 +matter.js/dist/esm/cluster/Cluster.d.ts:133 ___ @@ -115,7 +115,7 @@ Command.requestId #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:125 +matter.js/dist/esm/cluster/Cluster.d.ts:125 ___ @@ -129,7 +129,7 @@ Command.requestSchema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:126 +matter.js/dist/esm/cluster/Cluster.d.ts:126 ___ @@ -143,7 +143,7 @@ Command.responseId #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:127 +matter.js/dist/esm/cluster/Cluster.d.ts:127 ___ @@ -157,7 +157,7 @@ Command.responseSchema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:128 +matter.js/dist/esm/cluster/Cluster.d.ts:128 ___ @@ -171,4 +171,4 @@ Command.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:130 +matter.js/dist/esm/cluster/Cluster.d.ts:130 diff --git a/docs/matter-node-ble.js/interfaces/internal_.OptionalEvent.md b/docs/matter-node-ble.js/interfaces/internal_.OptionalEvent.md index be8040b057..279e5d8cef 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.OptionalEvent.md +++ b/docs/matter-node-ble.js/interfaces/internal_.OptionalEvent.md @@ -43,7 +43,7 @@ Event.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:164 +matter.js/dist/esm/cluster/Cluster.d.ts:164 ___ @@ -57,7 +57,7 @@ Event.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:169 +matter.js/dist/esm/cluster/Cluster.d.ts:169 ___ @@ -71,7 +71,7 @@ Event.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:171 +matter.js/dist/esm/cluster/Cluster.d.ts:171 ___ @@ -85,7 +85,7 @@ Event.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:185 +matter.js/dist/esm/cluster/Cluster.d.ts:185 ___ @@ -99,7 +99,7 @@ Event.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:170 +matter.js/dist/esm/cluster/Cluster.d.ts:170 ___ @@ -113,7 +113,7 @@ Event.priority #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:166 +matter.js/dist/esm/cluster/Cluster.d.ts:166 ___ @@ -127,7 +127,7 @@ Event.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:168 +matter.js/dist/esm/cluster/Cluster.d.ts:168 ___ @@ -141,7 +141,7 @@ Event.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:165 +matter.js/dist/esm/cluster/Cluster.d.ts:165 ___ @@ -155,4 +155,4 @@ Event.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:172 +matter.js/dist/esm/cluster/Cluster.d.ts:172 diff --git a/docs/matter-node-ble.js/interfaces/internal_.OptionalFieldType.md b/docs/matter-node-ble.js/interfaces/internal_.OptionalFieldType.md index 85fe9dfe60..aaa187399c 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.OptionalFieldType.md +++ b/docs/matter-node-ble.js/interfaces/internal_.OptionalFieldType.md @@ -37,7 +37,7 @@ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:13 +matter.js/dist/esm/tlv/TlvObject.d.ts:13 ___ @@ -51,7 +51,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:10 +matter.js/dist/esm/tlv/TlvObject.d.ts:10 ___ @@ -65,7 +65,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:16 +matter.js/dist/esm/tlv/TlvObject.d.ts:16 ___ @@ -79,4 +79,4 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:11 +matter.js/dist/esm/tlv/TlvObject.d.ts:11 diff --git a/docs/matter-node-ble.js/interfaces/internal_.OptionalFixedAttribute.md b/docs/matter-node-ble.js/interfaces/internal_.OptionalFixedAttribute.md index ac8f264b08..66021172a0 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.OptionalFixedAttribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.OptionalFixedAttribute.md @@ -51,7 +51,7 @@ OptionalAttribute.default #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -65,7 +65,7 @@ OptionalAttribute.fabricScoped #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:35 +matter.js/dist/esm/cluster/Cluster.d.ts:35 ___ @@ -79,7 +79,7 @@ OptionalAttribute.fixed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:78 +matter.js/dist/esm/cluster/Cluster.d.ts:78 ___ @@ -93,7 +93,7 @@ OptionalAttribute.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -107,7 +107,7 @@ OptionalAttribute.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -121,7 +121,7 @@ OptionalAttribute.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -135,7 +135,7 @@ OptionalAttribute.omitChanges #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -149,7 +149,7 @@ OptionalAttribute.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:45 +matter.js/dist/esm/cluster/Cluster.d.ts:45 ___ @@ -163,7 +163,7 @@ OptionalAttribute.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -177,7 +177,7 @@ OptionalAttribute.persistent #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -191,7 +191,7 @@ OptionalAttribute.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -205,7 +205,7 @@ OptionalAttribute.scene #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -219,7 +219,7 @@ OptionalAttribute.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -233,7 +233,7 @@ OptionalAttribute.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -247,7 +247,7 @@ OptionalAttribute.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -261,7 +261,7 @@ OptionalAttribute.writable #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:30 +matter.js/dist/esm/cluster/Cluster.d.ts:30 ___ @@ -275,4 +275,4 @@ OptionalAttribute.writeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/interfaces/internal_.OptionalWritableAttribute.md b/docs/matter-node-ble.js/interfaces/internal_.OptionalWritableAttribute.md index 2c080f18b3..6d0c7c43c4 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.OptionalWritableAttribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.OptionalWritableAttribute.md @@ -51,7 +51,7 @@ OptionalAttribute.default #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -65,7 +65,7 @@ OptionalAttribute.fabricScoped #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:35 +matter.js/dist/esm/cluster/Cluster.d.ts:35 ___ @@ -79,7 +79,7 @@ OptionalAttribute.fixed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:34 +matter.js/dist/esm/cluster/Cluster.d.ts:34 ___ @@ -93,7 +93,7 @@ OptionalAttribute.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -107,7 +107,7 @@ OptionalAttribute.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -121,7 +121,7 @@ OptionalAttribute.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -135,7 +135,7 @@ OptionalAttribute.omitChanges #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -149,7 +149,7 @@ OptionalAttribute.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:45 +matter.js/dist/esm/cluster/Cluster.d.ts:45 ___ @@ -163,7 +163,7 @@ OptionalAttribute.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -177,7 +177,7 @@ OptionalAttribute.persistent #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -191,7 +191,7 @@ OptionalAttribute.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -205,7 +205,7 @@ OptionalAttribute.scene #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -219,7 +219,7 @@ OptionalAttribute.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -233,7 +233,7 @@ OptionalAttribute.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -247,7 +247,7 @@ OptionalAttribute.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -261,7 +261,7 @@ OptionalAttribute.writable #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:54 +matter.js/dist/esm/cluster/Cluster.d.ts:54 ___ @@ -275,4 +275,4 @@ OptionalAttribute.writeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/interfaces/internal_.OptionalWritableFabricScopedAttribute.md b/docs/matter-node-ble.js/interfaces/internal_.OptionalWritableFabricScopedAttribute.md index 2c5fd877ed..0644218b11 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.OptionalWritableFabricScopedAttribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.OptionalWritableFabricScopedAttribute.md @@ -51,7 +51,7 @@ OptionalWritableAttribute.default #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -65,7 +65,7 @@ OptionalWritableAttribute.fabricScoped #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:66 +matter.js/dist/esm/cluster/Cluster.d.ts:66 ___ @@ -79,7 +79,7 @@ OptionalWritableAttribute.fixed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:34 +matter.js/dist/esm/cluster/Cluster.d.ts:34 ___ @@ -93,7 +93,7 @@ OptionalWritableAttribute.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -107,7 +107,7 @@ OptionalWritableAttribute.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -121,7 +121,7 @@ OptionalWritableAttribute.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -135,7 +135,7 @@ OptionalWritableAttribute.omitChanges #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -149,7 +149,7 @@ OptionalWritableAttribute.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:45 +matter.js/dist/esm/cluster/Cluster.d.ts:45 ___ @@ -163,7 +163,7 @@ OptionalWritableAttribute.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -177,7 +177,7 @@ OptionalWritableAttribute.persistent #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -191,7 +191,7 @@ OptionalWritableAttribute.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -205,7 +205,7 @@ OptionalWritableAttribute.scene #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -219,7 +219,7 @@ OptionalWritableAttribute.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -233,7 +233,7 @@ OptionalWritableAttribute.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -247,7 +247,7 @@ OptionalWritableAttribute.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -261,7 +261,7 @@ OptionalWritableAttribute.writable #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:54 +matter.js/dist/esm/cluster/Cluster.d.ts:54 ___ @@ -275,4 +275,4 @@ OptionalWritableAttribute.writeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Packet.md b/docs/matter-node-ble.js/interfaces/internal_.Packet.md index 599a6208aa..863dfe65d1 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Packet.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Packet.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:30 +matter.js/dist/esm/codec/MessageCodec.d.ts:30 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:29 +matter.js/dist/esm/codec/MessageCodec.d.ts:29 diff --git a/docs/matter-node-ble.js/interfaces/internal_.PacketHeader.md b/docs/matter-node-ble.js/interfaces/internal_.PacketHeader.md index 75e3df7964..f91f3b03c5 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.PacketHeader.md +++ b/docs/matter-node-ble.js/interfaces/internal_.PacketHeader.md @@ -26,7 +26,7 @@ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:18 +matter.js/dist/esm/codec/MessageCodec.d.ts:18 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:17 +matter.js/dist/esm/codec/MessageCodec.d.ts:17 ___ @@ -46,7 +46,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:14 +matter.js/dist/esm/codec/MessageCodec.d.ts:14 ___ @@ -56,7 +56,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:12 +matter.js/dist/esm/codec/MessageCodec.d.ts:12 ___ @@ -66,7 +66,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:13 +matter.js/dist/esm/codec/MessageCodec.d.ts:13 ___ @@ -76,7 +76,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:15 +matter.js/dist/esm/codec/MessageCodec.d.ts:15 ___ @@ -86,7 +86,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:10 +matter.js/dist/esm/codec/MessageCodec.d.ts:10 ___ @@ -96,7 +96,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:11 +matter.js/dist/esm/codec/MessageCodec.d.ts:11 ___ @@ -106,4 +106,4 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:16 +matter.js/dist/esm/codec/MessageCodec.d.ts:16 diff --git a/docs/matter-node-ble.js/interfaces/internal_.PayloadHeader.md b/docs/matter-node-ble.js/interfaces/internal_.PayloadHeader.md index a328fc4d0e..9ad9a7918f 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.PayloadHeader.md +++ b/docs/matter-node-ble.js/interfaces/internal_.PayloadHeader.md @@ -23,7 +23,7 @@ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:26 +matter.js/dist/esm/codec/MessageCodec.d.ts:26 ___ @@ -33,7 +33,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:21 +matter.js/dist/esm/codec/MessageCodec.d.ts:21 ___ @@ -43,7 +43,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:24 +matter.js/dist/esm/codec/MessageCodec.d.ts:24 ___ @@ -53,7 +53,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:23 +matter.js/dist/esm/codec/MessageCodec.d.ts:23 ___ @@ -63,7 +63,7 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:22 +matter.js/dist/esm/codec/MessageCodec.d.ts:22 ___ @@ -73,4 +73,4 @@ ___ #### Defined in -matter.js/dist/cjs/codec/MessageCodec.d.ts:25 +matter.js/dist/esm/codec/MessageCodec.d.ts:25 diff --git a/docs/matter-node-ble.js/interfaces/internal_.PbkdfParameters.md b/docs/matter-node-ble.js/interfaces/internal_.PbkdfParameters.md index bd9bb09f28..f308fb0d33 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.PbkdfParameters.md +++ b/docs/matter-node-ble.js/interfaces/internal_.PbkdfParameters.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/crypto/Spake2p.d.ts:9 +matter.js/dist/esm/crypto/Spake2p.d.ts:9 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/crypto/Spake2p.d.ts:10 +matter.js/dist/esm/crypto/Spake2p.d.ts:10 diff --git a/docs/matter-node-ble.js/interfaces/internal_.ProtocolHandler.md b/docs/matter-node-ble.js/interfaces/internal_.ProtocolHandler.md index 7ad32b1580..ab91c6912e 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.ProtocolHandler.md +++ b/docs/matter-node-ble.js/interfaces/internal_.ProtocolHandler.md @@ -18,11 +18,26 @@ ### Methods +- [close](internal_.ProtocolHandler.md#close) - [getId](internal_.ProtocolHandler.md#getid) - [onNewExchange](internal_.ProtocolHandler.md#onnewexchange) ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +matter.js/dist/esm/protocol/ProtocolHandler.d.ts:11 + +___ + ### getId ▸ **getId**(): `number` @@ -33,7 +48,7 @@ #### Defined in -matter.js/dist/cjs/protocol/ProtocolHandler.d.ts:9 +matter.js/dist/esm/protocol/ProtocolHandler.d.ts:9 ___ @@ -54,4 +69,4 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/ProtocolHandler.d.ts:10 +matter.js/dist/esm/protocol/ProtocolHandler.d.ts:10 diff --git a/docs/matter-node-ble.js/interfaces/internal_.ResumptionRecord.md b/docs/matter-node-ble.js/interfaces/internal_.ResumptionRecord.md index dc4784a4fe..4bf2932ce9 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.ResumptionRecord.md +++ b/docs/matter-node-ble.js/interfaces/internal_.ResumptionRecord.md @@ -21,7 +21,7 @@ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:19 +matter.js/dist/esm/session/SessionManager.d.ts:19 ___ @@ -31,7 +31,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:20 +matter.js/dist/esm/session/SessionManager.d.ts:20 ___ @@ -41,7 +41,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:18 +matter.js/dist/esm/session/SessionManager.d.ts:18 ___ @@ -51,4 +51,4 @@ ___ #### Defined in -matter.js/dist/cjs/session/SessionManager.d.ts:17 +matter.js/dist/esm/session/SessionManager.d.ts:17 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Scanner.md b/docs/matter-node-ble.js/interfaces/internal_.Scanner.md index 19ffbebe44..7a9c86104b 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Scanner.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Scanner.md @@ -7,19 +7,45 @@ ## Implemented by - [`BleScanner`](../classes/BleScanner.md) +- [`MdnsScanner`](../classes/internal_.MdnsScanner.md) ## Table of contents ### Methods +- [cancelCommissionableDeviceDiscovery](internal_.Scanner.md#cancelcommissionabledevicediscovery) - [close](internal_.Scanner.md#close) - [findCommissionableDevices](internal_.Scanner.md#findcommissionabledevices) +- [findCommissionableDevicesContinuously](internal_.Scanner.md#findcommissionabledevicescontinuously) - [findOperationalDevice](internal_.Scanner.md#findoperationaldevice) - [getDiscoveredCommissionableDevices](internal_.Scanner.md#getdiscoveredcommissionabledevices) - [getDiscoveredOperationalDevices](internal_.Scanner.md#getdiscoveredoperationaldevices) ## Methods +### cancelCommissionableDeviceDiscovery + +▸ **cancelCommissionableDeviceDiscovery**(`identifier`): `void` + +Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would +be over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Defined in + +matter.js/dist/esm/common/Scanner.d.ts:94 + +___ + ### close ▸ **close**(): `void` @@ -32,22 +58,49 @@ Close the scanner server and free resources. #### Defined in -matter.js/dist/cjs/common/Scanner.d.ts:84 +matter.js/dist/esm/common/Scanner.d.ts:96 ___ ### findCommissionableDevices -▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> +▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> + +Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, +vendorId, etc.) and returns as soon as minimum one was found or the timeout is over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | +| `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> + +#### Defined in + +matter.js/dist/esm/common/Scanner.d.ts:81 + +___ + +### findCommissionableDevicesContinuously + +▸ **findCommissionableDevicesContinuously**(`identifier`, `callback`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/internal_.md#commissionabledevice)[]\> -Send DNS-SD queries to discover commissionable devices by an provided identifier (e.g. discriminator, -vendorId, etc.) and return them. +Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, +vendorId, etc.) and returns after the timeout is over. For each new discovered device the provided callback is +called when it is discovered. #### Parameters | Name | Type | | :------ | :------ | | `identifier` | [`CommissionableDeviceIdentifiers`](../modules/internal_.md#commissionabledeviceidentifiers) | +| `callback` | (`device`: [`CommissionableDevice`](../modules/internal_.md#commissionabledevice)) => `void` | | `timeoutSeconds?` | `number` | #### Returns @@ -56,13 +109,13 @@ vendorId, etc.) and return them. #### Defined in -matter.js/dist/cjs/common/Scanner.d.ts:80 +matter.js/dist/esm/common/Scanner.d.ts:87 ___ ### findOperationalDevice -▸ **findOperationalDevice**(`fabric`, `nodeId`, `timeoutSeconds?`): `Promise`<[`ServerAddressIp`](../modules/internal_.md#serveraddressip)[]\> +▸ **findOperationalDevice**(`fabric`, `nodeId`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`ServerAddressIp`](../modules/internal_.md#serveraddressip)[]\> Send DNS-SD queries to discover the current addresses of an operational paired device by its operational ID and return them. @@ -74,6 +127,7 @@ and return them. | `fabric` | [`Fabric`](../classes/internal_.Fabric.md) | | `nodeId` | [`NodeId`](../modules/internal_.md#nodeid) | | `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | #### Returns @@ -81,7 +135,7 @@ and return them. #### Defined in -matter.js/dist/cjs/common/Scanner.d.ts:70 +matter.js/dist/esm/common/Scanner.d.ts:71 ___ @@ -103,7 +157,7 @@ Return already discovered commissionable devices and return them. Does not send #### Defined in -matter.js/dist/cjs/common/Scanner.d.ts:82 +matter.js/dist/esm/common/Scanner.d.ts:89 ___ @@ -127,4 +181,4 @@ DNS-SD queries. #### Defined in -matter.js/dist/cjs/common/Scanner.d.ts:75 +matter.js/dist/esm/common/Scanner.d.ts:76 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Session.md b/docs/matter-node-ble.js/interfaces/internal_.Session.md index a72698bc56..8105c030de 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Session.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Session.md @@ -19,6 +19,7 @@ ### Properties +- [closingAfterExchangeFinished](internal_.Session.md#closingafterexchangefinished) - [name](internal_.Session.md#name) ### Methods @@ -41,13 +42,23 @@ ## Properties +### closingAfterExchangeFinished + +• **closingAfterExchangeFinished**: `boolean` + +#### Defined in + +matter.js/dist/esm/session/Session.d.ts:25 + +___ + ### name • **name**: `string` #### Defined in -matter.js/dist/cjs/session/Session.d.ts:24 +matter.js/dist/esm/session/Session.d.ts:24 ## Methods @@ -67,19 +78,20 @@ matter.js/dist/cjs/session/Session.d.ts:24 #### Defined in -matter.js/dist/cjs/session/Session.d.ts:27 +matter.js/dist/esm/session/Session.d.ts:28 ___ ### destroy -▸ **destroy**(`sendClose`): `Promise`<`void`\> +▸ **destroy**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | | `sendClose` | `boolean` | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -87,7 +99,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:36 +matter.js/dist/esm/session/Session.d.ts:37 ___ @@ -107,7 +119,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:28 +matter.js/dist/esm/session/Session.d.ts:29 ___ @@ -127,7 +139,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:35 +matter.js/dist/esm/session/Session.d.ts:36 ___ @@ -141,7 +153,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:39 +matter.js/dist/esm/session/Session.d.ts:40 ___ @@ -155,7 +167,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:30 +matter.js/dist/esm/session/Session.d.ts:31 ___ @@ -169,7 +181,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:31 +matter.js/dist/esm/session/Session.d.ts:32 ___ @@ -183,7 +195,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:29 +matter.js/dist/esm/session/Session.d.ts:30 ___ @@ -197,7 +209,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:33 +matter.js/dist/esm/session/Session.d.ts:34 ___ @@ -211,7 +223,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:34 +matter.js/dist/esm/session/Session.d.ts:35 ___ @@ -225,7 +237,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:32 +matter.js/dist/esm/session/Session.d.ts:33 ___ @@ -239,7 +251,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:26 +matter.js/dist/esm/session/Session.d.ts:27 ___ @@ -253,7 +265,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:38 +matter.js/dist/esm/session/Session.d.ts:39 ___ @@ -267,7 +279,7 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:25 +matter.js/dist/esm/session/Session.d.ts:26 ___ @@ -287,4 +299,4 @@ ___ #### Defined in -matter.js/dist/cjs/session/Session.d.ts:37 +matter.js/dist/esm/session/Session.d.ts:38 diff --git a/docs/matter-node-ble.js/interfaces/internal_.Timer.md b/docs/matter-node-ble.js/interfaces/internal_.Timer.md index a31483321b..6e735e9d6f 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.Timer.md +++ b/docs/matter-node-ble.js/interfaces/internal_.Timer.md @@ -25,7 +25,7 @@ Is true if this timer is running. #### Defined in -matter.js/dist/cjs/time/Time.d.ts:23 +matter.js/dist/esm/time/Time.d.ts:23 ## Methods @@ -41,7 +41,7 @@ Starts this timer, chainable. #### Defined in -matter.js/dist/cjs/time/Time.d.ts:25 +matter.js/dist/esm/time/Time.d.ts:25 ___ @@ -57,4 +57,4 @@ Stops this timer, chainable. #### Defined in -matter.js/dist/cjs/time/Time.d.ts:27 +matter.js/dist/esm/time/Time.d.ts:27 diff --git a/docs/matter-node-ble.js/interfaces/internal_.TlvReader.md b/docs/matter-node-ble.js/interfaces/internal_.TlvReader.md index 346d02ebc0..d4b544086d 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.TlvReader.md +++ b/docs/matter-node-ble.js/interfaces/internal_.TlvReader.md @@ -36,7 +36,7 @@ #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:49 +matter.js/dist/esm/tlv/TlvSchema.d.ts:49 ___ @@ -55,4 +55,4 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:45 +matter.js/dist/esm/tlv/TlvSchema.d.ts:45 diff --git a/docs/matter-node-ble.js/interfaces/internal_.TlvWriter.md b/docs/matter-node-ble.js/interfaces/internal_.TlvWriter.md index 1c4441e463..0ea63e9a81 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.TlvWriter.md +++ b/docs/matter-node-ble.js/interfaces/internal_.TlvWriter.md @@ -36,7 +36,7 @@ #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:53 +matter.js/dist/esm/tlv/TlvSchema.d.ts:53 ___ @@ -57,4 +57,4 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:52 +matter.js/dist/esm/tlv/TlvSchema.d.ts:52 diff --git a/docs/matter-node-ble.js/interfaces/internal_.TransportInterface.md b/docs/matter-node-ble.js/interfaces/internal_.TransportInterface.md index b18cc9113b..adf136d51f 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.TransportInterface.md +++ b/docs/matter-node-ble.js/interfaces/internal_.TransportInterface.md @@ -32,7 +32,7 @@ It can not open new connections. #### Defined in -matter.js/dist/cjs/common/TransportInterface.d.ts:17 +matter.js/dist/esm/common/TransportInterface.d.ts:17 ___ @@ -52,4 +52,4 @@ ___ #### Defined in -matter.js/dist/cjs/common/TransportInterface.d.ts:16 +matter.js/dist/esm/common/TransportInterface.d.ts:16 diff --git a/docs/matter-node-ble.js/interfaces/internal_.UdpMulticastServerOptions.md b/docs/matter-node-ble.js/interfaces/internal_.UdpMulticastServerOptions.md new file mode 100644 index 0000000000..79bef9f9bc --- /dev/null +++ b/docs/matter-node-ble.js/interfaces/internal_.UdpMulticastServerOptions.md @@ -0,0 +1,54 @@ +[@project-chip/matter-node-ble.js](../README.md) / [Exports](../modules.md) / [](../modules/internal_.md) / UdpMulticastServerOptions + +# Interface: UdpMulticastServerOptions + +[](../modules/internal_.md).UdpMulticastServerOptions + +## Table of contents + +### Properties + +- [broadcastAddressIpv4](internal_.UdpMulticastServerOptions.md#broadcastaddressipv4) +- [broadcastAddressIpv6](internal_.UdpMulticastServerOptions.md#broadcastaddressipv6) +- [listeningPort](internal_.UdpMulticastServerOptions.md#listeningport) +- [netInterface](internal_.UdpMulticastServerOptions.md#netinterface) + +## Properties + +### broadcastAddressIpv4 + +• `Optional` **broadcastAddressIpv4**: `string` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:9 + +___ + +### broadcastAddressIpv6 + +• **broadcastAddressIpv6**: `string` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:10 + +___ + +### listeningPort + +• **listeningPort**: `number` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:8 + +___ + +### netInterface + +• `Optional` **netInterface**: `string` + +#### Defined in + +matter.js/dist/esm/net/UdpMulticastServer.d.ts:11 diff --git a/docs/matter-node-ble.js/interfaces/internal_.WritableAttribute.md b/docs/matter-node-ble.js/interfaces/internal_.WritableAttribute.md index 183a4c20a9..acac2852c7 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.WritableAttribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.WritableAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:35 +matter.js/dist/esm/cluster/Cluster.d.ts:35 ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:34 +matter.js/dist/esm/cluster/Cluster.d.ts:34 ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:28 +matter.js/dist/esm/cluster/Cluster.d.ts:28 ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:51 +matter.js/dist/esm/cluster/Cluster.d.ts:51 ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/interfaces/internal_.WritableFabricScopedAttribute.md b/docs/matter-node-ble.js/interfaces/internal_.WritableFabricScopedAttribute.md index db13151bd2..a88d38e084 100644 --- a/docs/matter-node-ble.js/interfaces/internal_.WritableFabricScopedAttribute.md +++ b/docs/matter-node-ble.js/interfaces/internal_.WritableFabricScopedAttribute.md @@ -51,7 +51,7 @@ WritableAttribute.default #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:38 +matter.js/dist/esm/cluster/Cluster.d.ts:38 ___ @@ -65,7 +65,7 @@ WritableAttribute.fabricScoped #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:63 +matter.js/dist/esm/cluster/Cluster.d.ts:63 ___ @@ -79,7 +79,7 @@ WritableAttribute.fixed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:34 +matter.js/dist/esm/cluster/Cluster.d.ts:34 ___ @@ -93,7 +93,7 @@ WritableAttribute.id #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:26 +matter.js/dist/esm/cluster/Cluster.d.ts:26 ___ @@ -107,7 +107,7 @@ WritableAttribute.isConditional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:39 +matter.js/dist/esm/cluster/Cluster.d.ts:39 ___ @@ -121,7 +121,7 @@ WritableAttribute.mandatoryIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:41 +matter.js/dist/esm/cluster/Cluster.d.ts:41 ___ @@ -135,7 +135,7 @@ WritableAttribute.omitChanges #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:36 +matter.js/dist/esm/cluster/Cluster.d.ts:36 ___ @@ -149,7 +149,7 @@ WritableAttribute.optional #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:28 +matter.js/dist/esm/cluster/Cluster.d.ts:28 ___ @@ -163,7 +163,7 @@ WritableAttribute.optionalIf #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:40 +matter.js/dist/esm/cluster/Cluster.d.ts:40 ___ @@ -177,7 +177,7 @@ WritableAttribute.persistent #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:32 +matter.js/dist/esm/cluster/Cluster.d.ts:32 ___ @@ -191,7 +191,7 @@ WritableAttribute.readAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:29 +matter.js/dist/esm/cluster/Cluster.d.ts:29 ___ @@ -205,7 +205,7 @@ WritableAttribute.scene #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:31 +matter.js/dist/esm/cluster/Cluster.d.ts:31 ___ @@ -219,7 +219,7 @@ WritableAttribute.schema #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:27 +matter.js/dist/esm/cluster/Cluster.d.ts:27 ___ @@ -233,7 +233,7 @@ WritableAttribute.timed #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:33 +matter.js/dist/esm/cluster/Cluster.d.ts:33 ___ @@ -247,7 +247,7 @@ WritableAttribute.unknown #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:42 +matter.js/dist/esm/cluster/Cluster.d.ts:42 ___ @@ -261,7 +261,7 @@ WritableAttribute.writable #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:51 +matter.js/dist/esm/cluster/Cluster.d.ts:51 ___ @@ -275,4 +275,4 @@ WritableAttribute.writeAcl #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:37 +matter.js/dist/esm/cluster/Cluster.d.ts:37 diff --git a/docs/matter-node-ble.js/modules.md b/docs/matter-node-ble.js/modules.md index 56b66ef35a..434f8c04e4 100644 --- a/docs/matter-node-ble.js/modules.md +++ b/docs/matter-node-ble.js/modules.md @@ -33,7 +33,7 @@ #### Defined in -matter-node-ble.js/src/ble/BleNode.ts:18 +[matter-node-ble.js/src/ble/BleNode.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleNode.ts#L18) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:24 +[matter-node-ble.js/src/ble/BleScanner.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L24) diff --git a/docs/matter-node-ble.js/modules/internal_.FabricIndex.md b/docs/matter-node-ble.js/modules/internal_.FabricIndex.md index 2d8071792c..c4ca6ce129 100644 --- a/docs/matter-node-ble.js/modules/internal_.FabricIndex.md +++ b/docs/matter-node-ble.js/modules/internal_.FabricIndex.md @@ -19,7 +19,7 @@ #### Defined in -matter.js/dist/cjs/datatype/FabricIndex.d.ts:21 +matter.js/dist/esm/datatype/FabricIndex.d.ts:21 ___ @@ -29,4 +29,4 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/FabricIndex.d.ts:22 +matter.js/dist/esm/datatype/FabricIndex.d.ts:22 diff --git a/docs/matter-node-ble.js/modules/internal_.NodeId.md b/docs/matter-node-ble.js/modules/internal_.NodeId.md index 692019df67..e0817c07b3 100644 --- a/docs/matter-node-ble.js/modules/internal_.NodeId.md +++ b/docs/matter-node-ble.js/modules/internal_.NodeId.md @@ -30,7 +30,7 @@ #### Defined in -matter.js/dist/cjs/datatype/NodeId.d.ts:19 +matter.js/dist/esm/datatype/NodeId.d.ts:19 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/NodeId.d.ts:18 +matter.js/dist/esm/datatype/NodeId.d.ts:18 ___ @@ -64,4 +64,4 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/NodeId.d.ts:17 +matter.js/dist/esm/datatype/NodeId.d.ts:17 diff --git a/docs/matter-node-ble.js/modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md b/docs/matter-node-ble.js/modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md similarity index 76% rename from docs/matter-node-ble.js/modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md rename to docs/matter-node-ble.js/modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md index fe9463ac15..e26e2c3f5c 100644 --- a/docs/matter-node-ble.js/modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md +++ b/docs/matter-node-ble.js/modules/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md @@ -1,28 +1,28 @@ -[@project-chip/matter-node-ble.js](../README.md) / [Exports](../modules.md) / [](internal_.md) / "/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject" +[@project-chip/matter-node-ble.js](../README.md) / [Exports](../modules.md) / [](internal_.md) / "/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject" -# Namespace: "/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject" +# Namespace: "/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject" -[](internal_.md)."/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject" +[](internal_.md)."/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject" ## Table of contents ### References -- [FieldType](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md#fieldtype) -- [OptionalFieldType](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md#optionalfieldtype) -- [TlvFields](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md#tlvfields) -- [TypeFromFields](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md#typefromfields) +- [FieldType](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md#fieldtype) +- [OptionalFieldType](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md#optionalfieldtype) +- [TlvFields](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md#tlvfields) +- [TypeFromFields](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md#typefromfields) ### Classes -- [ObjectSchema](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md) +- [ObjectSchema](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md) ### Functions -- [TlvField](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md#tlvfield) -- [TlvList](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md#tlvlist) -- [TlvObject](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md#tlvobject) -- [TlvOptionalField](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md#tlvoptionalfield) +- [TlvField](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md#tlvfield) +- [TlvList](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md#tlvlist) +- [TlvObject](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md#tlvobject) +- [TlvOptionalField](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md#tlvoptionalfield) ## References @@ -78,13 +78,13 @@ to the value being empty. #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:60 +matter.js/dist/esm/tlv/TlvObject.d.ts:60 ___ ### TlvList -▸ **TlvList**<`F`\>(`fields`): [`ObjectSchema`](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md)<`F`\> +▸ **TlvList**<`F`\>(`fields`): [`ObjectSchema`](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md)<`F`\> List TLV schema. @@ -102,17 +102,17 @@ List TLV schema. #### Returns -[`ObjectSchema`](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md)<`F`\> +[`ObjectSchema`](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md)<`F`\> #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:54 +matter.js/dist/esm/tlv/TlvObject.d.ts:54 ___ ### TlvObject -▸ **TlvObject**<`F`\>(`fields`): [`ObjectSchema`](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md)<`F`\> +▸ **TlvObject**<`F`\>(`fields`): [`ObjectSchema`](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md)<`F`\> Object TLV schema. @@ -130,11 +130,11 @@ Object TLV schema. #### Returns -[`ObjectSchema`](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.ObjectSchema.md)<`F`\> +[`ObjectSchema`](../classes/internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.ObjectSchema.md)<`F`\> #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:52 +matter.js/dist/esm/tlv/TlvObject.d.ts:52 ___ @@ -163,4 +163,4 @@ Object TLV optional field. #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:62 +matter.js/dist/esm/tlv/TlvObject.d.ts:62 diff --git a/docs/matter-node-ble.js/modules/internal_.md b/docs/matter-node-ble.js/modules/internal_.md index 870ce457b9..08444f7aa7 100644 --- a/docs/matter-node-ble.js/modules/internal_.md +++ b/docs/matter-node-ble.js/modules/internal_.md @@ -6,7 +6,7 @@ ### Namespaces -- ["/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md) +- ["/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md) - [FabricIndex](internal_.FabricIndex.md) - [NodeId](internal_.NodeId.md) @@ -19,6 +19,7 @@ - [DeviceClasses](../enums/internal_.DeviceClasses.md) - [EventPriority](../enums/internal_.EventPriority.md) - [KeyType](../enums/internal_.KeyType.md) +- [NodeStateInformation](../enums/internal_.NodeStateInformation.md) - [ProtocolStatusCode](../enums/internal_.ProtocolStatusCode.md) - [RegulatoryLocationType](../enums/internal_.RegulatoryLocationType.md) - [SessionType](../enums/internal_.SessionType.md) @@ -72,6 +73,7 @@ - [InteractionServerMessenger](../classes/internal_.InteractionServerMessenger.md) - [MatterController](../classes/internal_.MatterController.md) - [MatterDevice](../classes/internal_.MatterDevice.md) +- [MdnsScanner](../classes/internal_.MdnsScanner.md) - [MessageChannel](../classes/internal_.MessageChannel.md) - [MessageCounter](../classes/internal_.MessageCounter.md) - [MessageExchange](../classes/internal_.MessageExchange.md) @@ -87,6 +89,7 @@ - [StorageContext](../classes/internal_.StorageContext.md) - [SubscriptionHandler](../classes/internal_.SubscriptionHandler.md) - [TlvSchema](../classes/internal_.TlvSchema.md) +- [UdpMulticastServer](../classes/internal_.UdpMulticastServer.md) - [UnsecureSession](../classes/internal_.UnsecureSession.md) ### Interfaces @@ -141,6 +144,7 @@ - [TlvReader](../interfaces/internal_.TlvReader.md) - [TlvWriter](../interfaces/internal_.TlvWriter.md) - [TransportInterface](../interfaces/internal_.TransportInterface.md) +- [UdpMulticastServerOptions](../interfaces/internal_.UdpMulticastServerOptions.md) - [WritableAttribute](../interfaces/internal_.WritableAttribute.md) - [WritableFabricScopedAttribute](../interfaces/internal_.WritableFabricScopedAttribute.md) @@ -162,7 +166,6 @@ - [Brand](internal_.md#brand) - [Branded](internal_.md#branded) - [ByteArray](internal_.md#bytearray) -- [ClassExtends](internal_.md#classextends) - [ClientAttributeGetters](internal_.md#clientattributegetters) - [ClientAttributeListeners](internal_.md#clientattributelisteners) - [ClientAttributeSetters](internal_.md#clientattributesetters) @@ -180,6 +183,7 @@ - [CommissionableDeviceData](internal_.md#commissionabledevicedata) - [CommissionableDeviceIdentifiers](internal_.md#commissionabledeviceidentifiers) - [CommissionerInstanceData](internal_.md#commissionerinstancedata) +- [CommissioningControllerNodeOptions](internal_.md#commissioningcontrollernodeoptions) - [CommissioningModeInstanceData](internal_.md#commissioningmodeinstancedata) - [CommissioningOptions](internal_.md#commissioningoptions) - [ConditionalFeatureList](internal_.md#conditionalfeaturelist) @@ -209,6 +213,7 @@ - [MandatoryEventNames](internal_.md#mandatoryeventnames) - [MandatoryFieldNames](internal_.md#mandatoryfieldnames) - [Merge](internal_.md#merge) +- [NodeCommissioningOptions](internal_.md#nodecommissioningoptions) - [NodeId](internal_.md#nodeid) - [NonFixedAttributeNames](internal_.md#nonfixedattributenames) - [OptionalAttributeNames](internal_.md#optionalattributenames) @@ -229,6 +234,7 @@ - [SupportedComplexStorageTypes](internal_.md#supportedcomplexstoragetypes) - [SupportedStorageBaseTypes](internal_.md#supportedstoragebasetypes) - [SupportedStorageTypes](internal_.md#supportedstoragetypes) +- [TimerCallback](internal_.md#timercallback) - [TlvElement](internal_.md#tlvelement) - [TlvFields](internal_.md#tlvfields) - [TlvStream](internal_.md#tlvstream) @@ -247,6 +253,7 @@ ### Variables - [ByteArray](internal_.md#bytearray-1) +- [DiscoveryCapabilitiesBitmap](internal_.md#discoverycapabilitiesbitmap) - [PairingHintBitmap](internal_.md#pairinghintbitmap) - [TlvAttributeReport](internal_.md#tlvattributereport) - [TlvAttributeReportData](internal_.md#tlvattributereportdata) @@ -299,7 +306,7 @@ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:23 +matter.js/dist/esm/tlv/TlvCodec.d.ts:23 ___ @@ -309,7 +316,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:17 +matter.js/dist/esm/tlv/TlvCodec.d.ts:17 ___ @@ -319,7 +326,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:20 +matter.js/dist/esm/tlv/TlvCodec.d.ts:20 ___ @@ -329,7 +336,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:32 +matter.js/dist/esm/tlv/TlvCodec.d.ts:32 ___ @@ -339,7 +346,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:25 +matter.js/dist/esm/tlv/TlvCodec.d.ts:25 ___ @@ -349,7 +356,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:12 +matter.js/dist/esm/schema/BitmapSchema.d.ts:12 ___ @@ -359,7 +366,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:10 +matter.js/dist/esm/schema/BitmapSchema.d.ts:10 ___ @@ -369,7 +376,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:18 +matter.js/dist/esm/tlv/TlvCodec.d.ts:18 ___ @@ -379,7 +386,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:31 +matter.js/dist/esm/tlv/TlvCodec.d.ts:31 ___ @@ -389,7 +396,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:24 +matter.js/dist/esm/tlv/TlvCodec.d.ts:24 ___ @@ -399,7 +406,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:21 +matter.js/dist/esm/tlv/TlvCodec.d.ts:21 ___ @@ -409,7 +416,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:11 +matter.js/dist/esm/schema/BitmapSchema.d.ts:11 ___ @@ -419,7 +426,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:15 +matter.js/dist/esm/tlv/TlvCodec.d.ts:15 ___ @@ -429,7 +436,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:22 +matter.js/dist/esm/tlv/TlvCodec.d.ts:22 ___ @@ -439,7 +446,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:16 +matter.js/dist/esm/tlv/TlvCodec.d.ts:16 ___ @@ -449,7 +456,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:19 +matter.js/dist/esm/tlv/TlvCodec.d.ts:19 ## Type Aliases @@ -465,7 +472,7 @@ matter.js/dist/cjs/tlv/TlvCodec.d.ts:19 #### Defined in -matter.js/dist/cjs/cluster/server/AttributeServer.d.ts:22 +matter.js/dist/esm/cluster/server/AttributeServer.d.ts:22 ___ @@ -482,7 +489,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:19 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:20 ___ @@ -494,7 +501,7 @@ Type for TlvAttributeReportData where the real data are represented with the sch #### Defined in -matter.js/dist/cjs/protocol/interaction/AttributeDataEncoder.d.ts:12 +matter.js/dist/esm/protocol/interaction/AttributeDataEncoder.d.ts:12 ___ @@ -510,9 +517,9 @@ MatterCoreSpecificationV1_0 § 7.18.2.15 #### Defined in -matter.js/dist/cjs/datatype/AttributeId.d.ts:14 +matter.js/dist/esm/datatype/AttributeId.d.ts:14 -matter.js/dist/cjs/datatype/AttributeId.d.ts:13 +matter.js/dist/esm/datatype/AttributeId.d.ts:13 ___ @@ -528,7 +535,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:83 +matter.js/dist/esm/cluster/Cluster.d.ts:83 ___ @@ -540,7 +547,7 @@ Type for TlvAttributeReport where the real data are represented with the schema #### Defined in -matter.js/dist/cjs/protocol/interaction/AttributeDataEncoder.d.ts:8 +matter.js/dist/esm/protocol/interaction/AttributeDataEncoder.d.ts:8 ___ @@ -556,7 +563,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:30 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:33 ___ @@ -573,7 +580,7 @@ ___ #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:17 +matter.js/dist/esm/crypto/Key.d.ts:17 ___ @@ -585,9 +592,9 @@ Defines the bit position and bit length of a numeric value. #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:25 +matter.js/dist/esm/schema/BitmapSchema.d.ts:25 -matter.js/dist/cjs/schema/BitmapSchema.d.ts:26 +matter.js/dist/esm/schema/BitmapSchema.d.ts:26 ___ @@ -605,9 +612,9 @@ Defines the bit position and bit length of an enum flag. #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:28 +matter.js/dist/esm/schema/BitmapSchema.d.ts:28 -matter.js/dist/cjs/schema/BitmapSchema.d.ts:29 +matter.js/dist/esm/schema/BitmapSchema.d.ts:29 ___ @@ -619,9 +626,9 @@ Defines the bit position of a boolean flag. #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:22 +matter.js/dist/esm/schema/BitmapSchema.d.ts:22 -matter.js/dist/cjs/schema/BitmapSchema.d.ts:23 +matter.js/dist/esm/schema/BitmapSchema.d.ts:23 ___ @@ -647,9 +654,9 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:14 +matter.js/dist/esm/schema/BitmapSchema.d.ts:14 -matter.js/dist/cjs/schema/BitmapSchema.d.ts:20 +matter.js/dist/esm/schema/BitmapSchema.d.ts:20 ___ @@ -663,7 +670,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:30 +matter.js/dist/esm/schema/BitmapSchema.d.ts:30 ___ @@ -685,7 +692,7 @@ ___ #### Defined in -matter.js/dist/cjs/util/Type.d.ts:29 +matter.js/dist/esm/util/Type.d.ts:29 ___ @@ -702,7 +709,7 @@ ___ #### Defined in -matter.js/dist/cjs/util/Type.d.ts:32 +matter.js/dist/esm/util/Type.d.ts:32 ___ @@ -714,41 +721,9 @@ Array of bytes, alias of Uint8Array. #### Defined in -matter.js/dist/cjs/util/ByteArray.d.ts:25 +matter.js/dist/esm/util/ByteArray.d.ts:25 -matter.js/dist/cjs/util/ByteArray.d.ts:26 - -___ - -### ClassExtends - -Ƭ **ClassExtends**<`C`\>: (...`args`: `any`[]) => `C` - -#### Type parameters - -| Name | -| :------ | -| `C` | - -#### Type declaration - -• **new ClassExtends**(`...args`): `C` - -Type that represents a class constructor of a defined type or extend of it - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`C` - -#### Defined in - -matter.js/dist/cjs/util/Type.d.ts:15 +matter.js/dist/esm/util/ByteArray.d.ts:26 ___ @@ -764,7 +739,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:43 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:44 ___ @@ -780,7 +755,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:60 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:61 ___ @@ -796,7 +771,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:54 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:55 ___ @@ -812,7 +787,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:57 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:58 ___ @@ -828,7 +803,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:66 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:67 ___ @@ -844,7 +819,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:72 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:73 ___ @@ -860,7 +835,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:69 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:70 ___ @@ -876,13 +851,13 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:46 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:47 ___ ### ClusterClientObj -Ƭ **ClusterClientObj**<`F`, `A`, `C`, `E`\>: { `_type`: ``"ClusterClient"`` ; `attributes`: [`AttributeClients`](internal_.md#attributeclients)<`F`, `A`\> ; `commands`: [`CommandServers`](internal_.md#commandservers)<`C`\> ; `endpointId`: `number` ; `events`: [`EventClients`](internal_.md#eventclients)<`E`\> ; `id`: [`ClusterId`](internal_.md#clusterid) ; `isUnknown`: `boolean` ; `name`: `string` ; `revision`: `number` ; `subscribeAllAttributes`: (`options`: { `dataVersionFilters?`: { `clusterId`: [`ClusterId`](internal_.md#clusterid) ; `dataVersion`: `number` ; `endpointId`: [`EndpointNumber`](internal_.md#endpointnumber) }[] ; `eventFilters?`: [`TypeFromSchema`](internal_.md#typefromschema)[] ; `isFabricFiltered?`: `boolean` ; `keepSubscriptions?`: `boolean` ; `maxIntervalCeilingSeconds`: `number` ; `minIntervalFloorSeconds`: `number` }) => `Promise`<`void`\> ; `supportedFeatures`: [`TypeFromPartialBitSchema`](internal_.md#typefrompartialbitschema)<`F`\> } & [`ClientAttributeGetters`](internal_.md#clientattributegetters)<`A`\> & [`ClientGlobalAttributeGetters`](internal_.md#clientglobalattributegetters)<`F`\> & [`ClientAttributeSetters`](internal_.md#clientattributesetters)<`A`\> & [`ClientAttributeSubscribers`](internal_.md#clientattributesubscribers)<`A`\> & [`ClientAttributeListeners`](internal_.md#clientattributelisteners)<`A`\> & [`CommandServers`](internal_.md#commandservers)<`C`\> & [`ClientEventGetters`](internal_.md#clienteventgetters)<`E`\> & [`ClientEventSubscribers`](internal_.md#clienteventsubscribers)<`E`\> & [`ClientEventListeners`](internal_.md#clienteventlisteners)<`E`\> +Ƭ **ClusterClientObj**<`F`, `A`, `C`, `E`\>: { `_type`: ``"ClusterClient"`` ; `attributes`: [`AttributeClients`](internal_.md#attributeclients)<`F`, `A`\> ; `commands`: [`CommandServers`](internal_.md#commandservers)<`C`\> ; `endpointId`: `number` ; `events`: [`EventClients`](internal_.md#eventclients)<`E`\> ; `id`: [`ClusterId`](internal_.md#clusterid) ; `isAttributeSupported`: (`attributeId`: [`AttributeId`](internal_.md#attributeid)) => `boolean` ; `isAttributeSupportedByName`: (`attributeName`: `string`) => `boolean` ; `isCommandSupported`: (`commandId`: [`CommandId`](internal_.md#commandid)) => `boolean` ; `isCommandSupportedByName`: (`commandName`: `string`) => `boolean` ; `isEventSupported`: (`eventId`: [`EventId`](internal_.md#eventid)) => `boolean` ; `isEventSupportedByName`: (`eventName`: `string`) => `boolean` ; `isUnknown`: `boolean` ; `name`: `string` ; `revision`: `number` ; `subscribeAllAttributes`: (`options`: { `dataVersionFilters?`: { `clusterId`: [`ClusterId`](internal_.md#clusterid) ; `dataVersion`: `number` ; `endpointId`: [`EndpointNumber`](internal_.md#endpointnumber) }[] ; `eventFilters?`: [`TypeFromSchema`](internal_.md#typefromschema)[] ; `isFabricFiltered?`: `boolean` ; `keepSubscriptions?`: `boolean` ; `maxIntervalCeilingSeconds`: `number` ; `minIntervalFloorSeconds`: `number` }) => `Promise`<`void`\> ; `supportedFeatures`: [`TypeFromPartialBitSchema`](internal_.md#typefrompartialbitschema)<`F`\> } & [`ClientAttributeGetters`](internal_.md#clientattributegetters)<`A`\> & [`ClientGlobalAttributeGetters`](internal_.md#clientglobalattributegetters)<`F`\> & [`ClientAttributeSetters`](internal_.md#clientattributesetters)<`A`\> & [`ClientAttributeSubscribers`](internal_.md#clientattributesubscribers)<`A`\> & [`ClientAttributeListeners`](internal_.md#clientattributelisteners)<`A`\> & [`CommandServers`](internal_.md#commandservers)<`C`\> & [`ClientEventGetters`](internal_.md#clienteventgetters)<`E`\> & [`ClientEventSubscribers`](internal_.md#clienteventsubscribers)<`E`\> & [`ClientEventListeners`](internal_.md#clienteventlisteners)<`E`\> Strongly typed interface of a cluster client @@ -897,7 +872,7 @@ Strongly typed interface of a cluster client #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:77 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:78 ___ @@ -914,15 +889,15 @@ MatterCoreSpecificationV1_0 § 7.10 #### Defined in -matter.js/dist/cjs/datatype/ClusterId.d.ts:15 +matter.js/dist/esm/datatype/ClusterId.d.ts:15 -matter.js/dist/cjs/datatype/ClusterId.d.ts:14 +matter.js/dist/esm/datatype/ClusterId.d.ts:14 ___ ### ClusterServerObj -Ƭ **ClusterServerObj**<`A`, `E`\>: { `_type`: ``"ClusterServer"`` ; `attributes`: [`AttributeServers`](internal_.md#attributeservers)<`A`\> ; `clusterDataVersion`: `number` ; `id`: [`ClusterId`](internal_.md#clusterid) ; `name`: `string` } & [`ServerAttributeGetters`](internal_.md#serverattributegetters)<`A`\> & [`ServerAttributeSetters`](internal_.md#serverattributesetters)<`A`\> & [`ServerAttributeSubscribers`](internal_.md#serverattributesubscribers)<`A`\> & [`ServerEventTriggers`](internal_.md#servereventtriggers)<`E`\> +Ƭ **ClusterServerObj**<`A`, `E`\>: { `_type`: ``"ClusterServer"`` ; `attributes`: [`AttributeServers`](internal_.md#attributeservers)<`A`\> ; `clusterDataVersion`: `number` ; `id`: [`ClusterId`](internal_.md#clusterid) ; `isAttributeSupported`: (`attributeId`: [`AttributeId`](internal_.md#attributeid)) => `boolean` ; `isAttributeSupportedByName`: (`attributeName`: `string`) => `boolean` ; `isCommandSupported`: (`commandId`: [`CommandId`](internal_.md#commandid)) => `boolean` ; `isCommandSupportedByName`: (`commandName`: `string`) => `boolean` ; `isEventSupported`: (`eventId`: [`EventId`](internal_.md#eventid)) => `boolean` ; `isEventSupportedByName`: (`eventName`: `string`) => `boolean` ; `name`: `string` } & [`ServerAttributeGetters`](internal_.md#serverattributegetters)<`A`\> & [`ServerAttributeSetters`](internal_.md#serverattributesetters)<`A`\> & [`ServerAttributeSubscribers`](internal_.md#serverattributesubscribers)<`A`\> & [`ServerEventTriggers`](internal_.md#servereventtriggers)<`E`\> #### Type parameters @@ -933,7 +908,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:149 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:152 ___ @@ -949,9 +924,9 @@ MatterCoreSpecificationV1_0 § 7.18.2.18 #### Defined in -matter.js/dist/cjs/datatype/CommandId.d.ts:14 +matter.js/dist/esm/datatype/CommandId.d.ts:14 -matter.js/dist/cjs/datatype/CommandId.d.ts:13 +matter.js/dist/esm/datatype/CommandId.d.ts:13 ___ @@ -967,7 +942,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:63 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:64 ___ @@ -994,10 +969,11 @@ The properties are named identical as in the Matter specification. | `T?` | `number` | TCP supported | | `VP?` | `string` | VendorId + ProductId | | `addresses` | [`ServerAddress`](internal_.md#serveraddress)[] | The device's addresses IP/port pairs | +| `deviceIdentifier` | `string` | - | #### Defined in -matter.js/dist/cjs/common/Scanner.d.ts:14 +matter.js/dist/esm/common/Scanner.d.ts:14 ___ @@ -1007,7 +983,7 @@ ___ #### Defined in -matter-node-ble.js/src/ble/BleScanner.ts:30 +[matter-node-ble.js/src/ble/BleScanner.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node-ble.js/src/ble/BleScanner.ts#L30) ___ @@ -1020,7 +996,7 @@ Please decide for the best matching identifier that you have. #### Defined in -matter.js/dist/cjs/common/Scanner.d.ts:44 +matter.js/dist/esm/common/Scanner.d.ts:45 ___ @@ -1041,7 +1017,28 @@ ___ #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:229 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:229 + +___ + +### CommissioningControllerNodeOptions + +Ƭ **CommissioningControllerNodeOptions**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `attributeChangedCallback?` | (`nodeId`: [`NodeId`](internal_.md#nodeid), `data`: [`DecodedAttributeReportValue`](internal_.md#decodedattributereportvalue)<`any`\>) => `void` | Optional additional callback method which is called for each Attribute change reported by the device. Use this if subscribing to all relevant attributes is too much effort. | +| `autoSubscribe?` | `boolean` | Unless set to false all events and attributes are subscribed and value changes are reflected in the ClusterClient instances. With this reading attributes values is mostly looked up in the locally cached data. Additionally more features like reaction on shutdown event or endpoint structure changes (for bridges) are done internally automatically. | +| `eventTriggeredCallback?` | (`nodeId`: [`NodeId`](internal_.md#nodeid), `data`: [`DecodedEventReportValue`](internal_.md#decodedeventreportvalue)<`any`\>) => `void` | Optional additional callback method which is called for each Event reported by the device. Use this if subscribing to all relevant events is too much effort. | +| `stateInformationCallback?` | (`nodeId`: [`NodeId`](internal_.md#nodeid), `state`: [`NodeStateInformation`](../enums/internal_.NodeStateInformation.md)) => `void` | Optional callback method which is called when the state of the node changes. This can be used to detect when the node goes offline or comes back online. | +| `subscribeMaxIntervalCeilingSeconds?` | `number` | Maximum subscription interval when values are changed. This is also used as a keepalive mechanism to validate that the device is still available. Default it is set to 30s. | +| `subscribeMinIntervalFloorSeconds?` | `number` | Minimum subscription interval when values are changed. Default it is set to 0s. | + +#### Defined in + +matter.js/dist/esm/device/PairedNode.d.ts:38 ___ @@ -1065,7 +1062,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:209 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:209 ___ @@ -1077,21 +1074,21 @@ User specific options for the Commissioning process #### Type declaration -| Name | Type | -| :------ | :------ | -| `adminVendorId?` | `number` | -| `regulatoryCountryCode` | `string` | -| `regulatoryLocation` | [`RegulatoryLocationType`](../enums/internal_.RegulatoryLocationType.md) | -| `threadNetwork?` | { `networkName`: `string` ; `operationalDataset`: `string` } | -| `threadNetwork.networkName` | `string` | -| `threadNetwork.operationalDataset` | `string` | -| `wifiNetwork?` | { `wifiCredentials`: `string` ; `wifiSsid`: `string` } | -| `wifiNetwork.wifiCredentials` | `string` | -| `wifiNetwork.wifiSsid` | `string` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nodeId?` | [`NodeId`](internal_.md#nodeid) | - | +| `regulatoryCountryCode` | `string` | Country Code where the device is used. | +| `regulatoryLocation` | [`RegulatoryLocationType`](../enums/internal_.RegulatoryLocationType.md) | Regulatory Location (Indoor/Outdoor) where the device is used. | +| `threadNetwork?` | { `networkName`: `string` ; `operationalDataset`: `string` } | Thread network credentials to commission the device to. | +| `threadNetwork.networkName` | `string` | - | +| `threadNetwork.operationalDataset` | `string` | - | +| `wifiNetwork?` | { `wifiCredentials`: `string` ; `wifiSsid`: `string` } | Wifi network credentials to commission the device to. | +| `wifiNetwork.wifiCredentials` | `string` | - | +| `wifiNetwork.wifiSsid` | `string` | - | #### Defined in -matter.js/dist/cjs/protocol/ControllerCommissioner.d.ts:15 +matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:16 ___ @@ -1107,7 +1104,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:24 +matter.js/dist/esm/cluster/Cluster.d.ts:24 ___ @@ -1119,7 +1116,7 @@ Type for TlvDataReport where the real data are represented with the schema and t #### Defined in -matter.js/dist/cjs/protocol/interaction/AttributeDataEncoder.d.ts:26 +matter.js/dist/esm/protocol/interaction/AttributeDataEncoder.d.ts:26 ___ @@ -1150,7 +1147,7 @@ Represents a fully qualified and decoded attribute value from a received DataRep #### Defined in -matter.js/dist/cjs/protocol/interaction/AttributeDataDecoder.d.ts:13 +matter.js/dist/esm/protocol/interaction/AttributeDataDecoder.d.ts:13 ___ @@ -1178,7 +1175,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventDataDecoder.d.ts:13 +matter.js/dist/esm/protocol/interaction/EventDataDecoder.d.ts:13 ___ @@ -1206,7 +1203,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/interaction/EventDataDecoder.d.ts:22 +matter.js/dist/esm/protocol/interaction/EventDataDecoder.d.ts:22 ___ @@ -1222,9 +1219,9 @@ MatterCoreSpecificationV1_0 § 7.15 #### Defined in -matter.js/dist/cjs/datatype/DeviceTypeId.d.ts:14 +matter.js/dist/esm/datatype/DeviceTypeId.d.ts:14 -matter.js/dist/cjs/datatype/DeviceTypeId.d.ts:13 +matter.js/dist/esm/datatype/DeviceTypeId.d.ts:13 ___ @@ -1240,9 +1237,9 @@ MatterCoreSpecificationV1_0 § 7.18.2.11 #### Defined in -matter.js/dist/cjs/datatype/EndpointNumber.d.ts:14 +matter.js/dist/esm/datatype/EndpointNumber.d.ts:14 -matter.js/dist/cjs/datatype/EndpointNumber.d.ts:13 +matter.js/dist/esm/datatype/EndpointNumber.d.ts:13 ___ @@ -1258,7 +1255,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:26 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:27 ___ @@ -1270,7 +1267,7 @@ Type for TlvEventData where the real data are represented with the schema and th #### Defined in -matter.js/dist/cjs/protocol/interaction/AttributeDataEncoder.d.ts:21 +matter.js/dist/esm/protocol/interaction/AttributeDataEncoder.d.ts:21 ___ @@ -1286,9 +1283,9 @@ MatterCoreSpecificationV1_0 § 7.18.2.17 #### Defined in -matter.js/dist/cjs/datatype/EventId.d.ts:14 +matter.js/dist/esm/datatype/EventId.d.ts:14 -matter.js/dist/cjs/datatype/EventId.d.ts:13 +matter.js/dist/esm/datatype/EventId.d.ts:13 ___ @@ -1300,7 +1297,7 @@ Type for TlvEventReport where the real data are represented with the schema and #### Defined in -matter.js/dist/cjs/protocol/interaction/AttributeDataEncoder.d.ts:17 +matter.js/dist/esm/protocol/interaction/AttributeDataEncoder.d.ts:17 ___ @@ -1316,7 +1313,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:194 +matter.js/dist/esm/cluster/Cluster.d.ts:194 ___ @@ -1334,7 +1331,7 @@ ___ #### Defined in -matter.js/dist/cjs/protocol/MessageExchange.d.ts:18 +matter.js/dist/esm/protocol/MessageExchange.d.ts:18 ___ @@ -1351,9 +1348,9 @@ MatterCoreSpecificationV1_0 § 2.5.1 #### Defined in -matter.js/dist/cjs/datatype/FabricId.d.ts:15 +matter.js/dist/esm/datatype/FabricId.d.ts:15 -matter.js/dist/cjs/datatype/FabricId.d.ts:14 +matter.js/dist/esm/datatype/FabricId.d.ts:14 ___ @@ -1374,11 +1371,11 @@ MatterCoreSpecificationV1_0 § 7.5.2 #### Defined in -matter.js/dist/cjs/datatype/FabricIndex.d.ts:19 +matter.js/dist/esm/datatype/FabricIndex.d.ts:19 -matter.js/dist/cjs/datatype/FabricIndex.d.ts:18 +matter.js/dist/esm/datatype/FabricIndex.d.ts:18 -matter.js/dist/cjs/datatype/FabricIndex.d.ts:20 +matter.js/dist/esm/datatype/FabricIndex.d.ts:20 ___ @@ -1408,7 +1405,7 @@ ___ #### Defined in -matter.js/dist/cjs/fabric/Fabric.d.ts:15 +matter.js/dist/esm/fabric/Fabric.d.ts:15 ___ @@ -1424,7 +1421,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:109 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:112 ___ @@ -1440,7 +1437,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:115 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:118 ___ @@ -1456,7 +1453,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:42 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:43 ___ @@ -1472,7 +1469,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:121 +matter.js/dist/esm/cluster/Cluster.d.ts:121 ___ @@ -1503,9 +1500,9 @@ MatterCoreSpecificationV1_1 § 7.13 #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:211 +matter.js/dist/esm/cluster/Cluster.d.ts:211 -matter.js/dist/cjs/cluster/Cluster.d.ts:225 +matter.js/dist/esm/cluster/Cluster.d.ts:225 ___ @@ -1528,9 +1525,9 @@ MatterCoreSpecificationV1_0 § 2.5.4 #### Defined in -matter.js/dist/cjs/datatype/GroupId.d.ts:21 +matter.js/dist/esm/datatype/GroupId.d.ts:21 -matter.js/dist/cjs/datatype/GroupId.d.ts:20 +matter.js/dist/esm/datatype/GroupId.d.ts:20 ___ @@ -1546,7 +1543,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:115 +matter.js/dist/esm/cluster/Cluster.d.ts:115 ___ @@ -1564,7 +1561,7 @@ Cluster attributes accessible on the cluster server #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:24 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:27 ___ @@ -1580,7 +1577,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:195 +matter.js/dist/esm/cluster/Cluster.d.ts:195 ___ @@ -1596,7 +1593,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:21 +matter.js/dist/esm/tlv/TlvObject.d.ts:21 ___ @@ -1615,9 +1612,21 @@ Merges two types into one. #### Defined in -matter.js/dist/cjs/util/Type.d.ts:13 +matter.js/dist/esm/util/Type.d.ts:13 -matter.js/dist/cjs/util/Type.d.ts:10 +matter.js/dist/esm/util/Type.d.ts:10 + +___ + +### NodeCommissioningOptions + +Ƭ **NodeCommissioningOptions**: [`CommissioningControllerNodeOptions`](internal_.md#commissioningcontrollernodeoptions) & { `commissioning?`: [`CommissioningOptions`](internal_.md#commissioningoptions) ; `discovery`: { `identifierData`: [`CommissionableDeviceIdentifiers`](internal_.md#commissionabledeviceidentifiers) } \| { `commissionableDevice`: [`CommissionableDevice`](internal_.md#commissionabledevice) } & { `discoveryCapabilities?`: [`TypeFromPartialBitSchema`](internal_.md#typefrompartialbitschema) ; `knownAddress?`: [`ServerAddress`](internal_.md#serveraddress) ; `timeoutSeconds?`: `number` } ; `passcode`: `number` } + +Options needed to commission a new node + +#### Defined in + +matter.js/dist/esm/CommissioningController.d.ts:55 ___ @@ -1634,11 +1643,11 @@ MatterCoreSpecificationV1_0 § 2.5.5 #### Defined in -matter.js/dist/cjs/datatype/NodeId.d.ts:15 +matter.js/dist/esm/datatype/NodeId.d.ts:15 -matter.js/dist/cjs/datatype/NodeId.d.ts:14 +matter.js/dist/esm/datatype/NodeId.d.ts:14 -matter.js/dist/cjs/datatype/NodeId.d.ts:16 +matter.js/dist/esm/datatype/NodeId.d.ts:16 ___ @@ -1654,7 +1663,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:112 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:115 ___ @@ -1670,7 +1679,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:118 +matter.js/dist/esm/cluster/Cluster.d.ts:118 ___ @@ -1686,7 +1695,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:27 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:30 ___ @@ -1702,7 +1711,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:198 +matter.js/dist/esm/cluster/Cluster.d.ts:198 ___ @@ -1718,7 +1727,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:24 +matter.js/dist/esm/tlv/TlvObject.d.ts:24 ___ @@ -1737,7 +1746,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -matter.js/dist/cjs/util/Type.d.ts:6 +matter.js/dist/esm/util/Type.d.ts:6 ___ @@ -1753,7 +1762,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:142 +matter.js/dist/esm/cluster/Cluster.d.ts:142 ___ @@ -1769,7 +1778,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:141 +matter.js/dist/esm/cluster/Cluster.d.ts:141 ___ @@ -1779,7 +1788,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/ServerAddress.d.ts:15 +matter.js/dist/esm/common/ServerAddress.d.ts:15 ___ @@ -1796,7 +1805,7 @@ ___ #### Defined in -matter.js/dist/cjs/common/ServerAddress.d.ts:11 +matter.js/dist/esm/common/ServerAddress.d.ts:11 ___ @@ -1819,7 +1828,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -matter.js/dist/cjs/common/ServerAddress.d.ts:6 +matter.js/dist/esm/common/ServerAddress.d.ts:6 ___ @@ -1835,7 +1844,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:116 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:119 ___ @@ -1851,7 +1860,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:123 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:126 ___ @@ -1867,7 +1876,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:128 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:131 ___ @@ -1883,7 +1892,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/server/ClusterServerTypes.d.ts:138 +matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:141 ___ @@ -1917,7 +1926,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:31 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:32 ___ @@ -1929,7 +1938,7 @@ Supported combined types to stringify the data for the storage that can be used #### Defined in -matter.js/dist/cjs/storage/StringifyTools.d.ts:20 +matter.js/dist/esm/storage/StringifyTools.d.ts:20 ___ @@ -1941,7 +1950,7 @@ Supported base types to stringify the data for the storage that can be used as k #### Defined in -matter.js/dist/cjs/storage/StringifyTools.d.ts:18 +matter.js/dist/esm/storage/StringifyTools.d.ts:18 ___ @@ -1951,7 +1960,30 @@ ___ #### Defined in -matter.js/dist/cjs/storage/StringifyTools.d.ts:23 +matter.js/dist/esm/storage/StringifyTools.d.ts:23 + +___ + +### TimerCallback + +Ƭ **TimerCallback**: () => `any` + +#### Type declaration + +▸ (): `any` + +##### Returns + +`any` + +**`License`** + +Copyright 2022-2023 Project CHIP Authors +SPDX-License-Identifier: Apache-2.0 + +#### Defined in + +matter.js/dist/esm/time/Time.d.ts:6 ___ @@ -1975,7 +2007,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:24 +matter.js/dist/esm/tlv/TlvSchema.d.ts:24 ___ @@ -1989,7 +2021,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:18 +matter.js/dist/esm/tlv/TlvObject.d.ts:18 ___ @@ -1999,7 +2031,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:23 +matter.js/dist/esm/tlv/TlvSchema.d.ts:23 ___ @@ -2018,7 +2050,7 @@ MatterCoreSpecificationV1_0 § A.2 #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:79 +matter.js/dist/esm/tlv/TlvCodec.d.ts:79 ___ @@ -2046,7 +2078,7 @@ Converts TlvType to the js primitive type. #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:65 +matter.js/dist/esm/tlv/TlvCodec.d.ts:65 ___ @@ -2058,7 +2090,7 @@ Type and length or value, when applicable. #### Defined in -matter.js/dist/cjs/tlv/TlvCodec.d.ts:35 +matter.js/dist/esm/tlv/TlvCodec.d.ts:35 ___ @@ -2075,7 +2107,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:28 +matter.js/dist/esm/tlv/TlvObject.d.ts:28 ___ @@ -2092,7 +2124,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:31 +matter.js/dist/esm/tlv/TlvObject.d.ts:31 ___ @@ -2108,7 +2140,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:27 +matter.js/dist/esm/tlv/TlvObject.d.ts:27 ___ @@ -2124,7 +2156,7 @@ ___ #### Defined in -matter.js/dist/cjs/tlv/TlvObject.d.ts:34 +matter.js/dist/esm/tlv/TlvObject.d.ts:34 ___ @@ -2140,7 +2172,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:36 +matter.js/dist/esm/schema/BitmapSchema.d.ts:36 ___ @@ -2158,7 +2190,7 @@ Type defined by the TLV schema. #### Defined in -matter.js/dist/cjs/tlv/TlvSchema.d.ts:43 +matter.js/dist/esm/tlv/TlvSchema.d.ts:43 ___ @@ -2176,9 +2208,9 @@ MatterCoreSpecificationV1_0 § 2.5.2 #### Defined in -matter.js/dist/cjs/datatype/VendorId.d.ts:16 +matter.js/dist/esm/datatype/VendorId.d.ts:16 -matter.js/dist/cjs/datatype/VendorId.d.ts:15 +matter.js/dist/esm/datatype/VendorId.d.ts:15 ___ @@ -2194,7 +2226,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:49 +matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:50 ## Variables @@ -2204,9 +2236,29 @@ matter.js/dist/cjs/cluster/client/ClusterClientTypes.d.ts:49 #### Defined in -matter.js/dist/cjs/util/ByteArray.d.ts:25 +matter.js/dist/esm/util/ByteArray.d.ts:25 + +matter.js/dist/esm/util/ByteArray.d.ts:26 + +___ + +### DiscoveryCapabilitiesBitmap + +• `Const` **DiscoveryCapabilitiesBitmap**: `Object` + +See MatterCoreSpecificationV1_0 § 5.1.3.1 Table 36 + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `ble` | [`BitFlag`](internal_.md#bitflag-1) | Device supports BLE for discovery when not commissioned. | +| `onIpNetwork` | [`BitFlag`](internal_.md#bitflag-1) | Device is already on the IP network. | +| `softAccessPoint` | [`BitFlag`](internal_.md#bitflag-1) | Device supports hosting a Soft-AP when not commissioned. | + +#### Defined in -matter.js/dist/cjs/util/ByteArray.d.ts:26 +matter.js/dist/esm/schema/PairingCodeSchema.d.ts:19 ___ @@ -2241,13 +2293,13 @@ ___ #### Defined in -matter.js/dist/cjs/common/InstanceBroadcaster.d.ts:9 +matter.js/dist/esm/common/InstanceBroadcaster.d.ts:9 ___ ### TlvAttributeReport -• `Const` **TlvAttributeReport**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md) +• `Const` **TlvAttributeReport**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md) **`See`** @@ -2255,23 +2307,23 @@ MatterCoreSpecificationV1_0, section 10.5.5 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:137 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:137 ___ ### TlvAttributeReportData -• `Const` **TlvAttributeReportData**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md) +• `Const` **TlvAttributeReportData**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md) #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:124 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:124 ___ ### TlvDataReport -• `Const` **TlvDataReport**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md) +• `Const` **TlvDataReport**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md) **`See`** @@ -2279,13 +2331,13 @@ MatterCoreSpecificationV1_0, section 10.6.3 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:298 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:298 ___ ### TlvEventData -• `Const` **TlvEventData**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md) +• `Const` **TlvEventData**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md) **`See`** @@ -2293,13 +2345,13 @@ MatterCoreSpecificationV1_0, section 10.5.9 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:55 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:55 ___ ### TlvEventFilter -• `Const` **TlvEventFilter**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md) +• `Const` **TlvEventFilter**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md) **`See`** @@ -2307,13 +2359,13 @@ MatterCoreSpecificationV1_0, section 10.5.6 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:72 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:72 ___ ### TlvEventReport -• `Const` **TlvEventReport**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/cjs/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_cjs_tlv_TlvObject_.md) +• `Const` **TlvEventReport**: [`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md) **`See`** @@ -2321,7 +2373,7 @@ MatterCoreSpecificationV1_0, section 10.5.10 #### Defined in -matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:180 +matter.js/dist/esm/protocol/interaction/InteractionProtocol.d.ts:180 ## Functions @@ -2351,7 +2403,7 @@ matter.js/dist/cjs/protocol/interaction/InteractionProtocol.d.ts:180 #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:97 +matter.js/dist/esm/cluster/Cluster.d.ts:97 ___ @@ -2371,7 +2423,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/AttributeId.d.ts:14 +matter.js/dist/esm/datatype/AttributeId.d.ts:14 ___ @@ -2392,7 +2444,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:26 +matter.js/dist/esm/schema/BitmapSchema.d.ts:26 ___ @@ -2419,7 +2471,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:29 +matter.js/dist/esm/schema/BitmapSchema.d.ts:29 ___ @@ -2439,7 +2491,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:23 +matter.js/dist/esm/schema/BitmapSchema.d.ts:23 ___ @@ -2468,7 +2520,7 @@ ___ #### Defined in -matter.js/dist/cjs/schema/BitmapSchema.d.ts:20 +matter.js/dist/esm/schema/BitmapSchema.d.ts:20 ___ @@ -2507,7 +2559,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:237 +matter.js/dist/esm/cluster/Cluster.d.ts:237 ___ @@ -2527,7 +2579,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/ClusterId.d.ts:15 +matter.js/dist/esm/datatype/ClusterId.d.ts:15 ___ @@ -2559,7 +2611,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:151 +matter.js/dist/esm/cluster/Cluster.d.ts:151 ___ @@ -2579,7 +2631,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/CommandId.d.ts:14 +matter.js/dist/esm/datatype/CommandId.d.ts:14 ___ @@ -2609,7 +2661,7 @@ ___ #### Defined in -matter.js/dist/cjs/device/DeviceTypes.d.ts:62 +matter.js/dist/esm/device/DeviceTypes.d.ts:62 ___ @@ -2629,7 +2681,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/DeviceTypeId.d.ts:14 +matter.js/dist/esm/datatype/DeviceTypeId.d.ts:14 ___ @@ -2649,7 +2701,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/EndpointNumber.d.ts:14 +matter.js/dist/esm/datatype/EndpointNumber.d.ts:14 ___ @@ -2679,7 +2731,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:190 +matter.js/dist/esm/cluster/Cluster.d.ts:190 ___ @@ -2699,7 +2751,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/EventId.d.ts:14 +matter.js/dist/esm/datatype/EventId.d.ts:14 ___ @@ -2719,7 +2771,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/FabricId.d.ts:15 +matter.js/dist/esm/datatype/FabricId.d.ts:15 ___ @@ -2739,7 +2791,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/FabricIndex.d.ts:19 +matter.js/dist/esm/datatype/FabricIndex.d.ts:19 ___ @@ -2769,7 +2821,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:103 +matter.js/dist/esm/cluster/Cluster.d.ts:103 ___ @@ -2799,7 +2851,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:107 +matter.js/dist/esm/cluster/Cluster.d.ts:107 ___ @@ -2825,7 +2877,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:225 +matter.js/dist/esm/cluster/Cluster.d.ts:225 ___ @@ -2845,7 +2897,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/GroupId.d.ts:21 +matter.js/dist/esm/datatype/GroupId.d.ts:21 ___ @@ -2867,7 +2919,7 @@ Generic key factory. #### Defined in -matter.js/dist/cjs/crypto/Key.d.ts:159 +matter.js/dist/esm/crypto/Key.d.ts:159 ___ @@ -2895,7 +2947,7 @@ ___ #### Defined in -matter.js/dist/cjs/util/Type.d.ts:13 +matter.js/dist/esm/util/Type.d.ts:13 ___ @@ -2915,7 +2967,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/NodeId.d.ts:15 +matter.js/dist/esm/datatype/NodeId.d.ts:15 ___ @@ -2945,7 +2997,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:98 +matter.js/dist/esm/cluster/Cluster.d.ts:98 ___ @@ -2977,7 +3029,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:152 +matter.js/dist/esm/cluster/Cluster.d.ts:152 ___ @@ -3007,7 +3059,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:191 +matter.js/dist/esm/cluster/Cluster.d.ts:191 ___ @@ -3037,7 +3089,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:109 +matter.js/dist/esm/cluster/Cluster.d.ts:109 ___ @@ -3067,7 +3119,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:101 +matter.js/dist/esm/cluster/Cluster.d.ts:101 ___ @@ -3097,7 +3149,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:105 +matter.js/dist/esm/cluster/Cluster.d.ts:105 ___ @@ -3117,7 +3169,7 @@ ___ #### Defined in -matter.js/dist/cjs/datatype/VendorId.d.ts:16 +matter.js/dist/esm/datatype/VendorId.d.ts:16 ___ @@ -3147,7 +3199,7 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:100 +matter.js/dist/esm/cluster/Cluster.d.ts:100 ___ @@ -3177,4 +3229,4 @@ ___ #### Defined in -matter.js/dist/cjs/cluster/Cluster.d.ts:104 +matter.js/dist/esm/cluster/Cluster.d.ts:104 diff --git a/docs/matter-node.js/classes/crypto_export.CryptoNode.md b/docs/matter-node.js/classes/crypto_export.CryptoNode.md index 9a4379c380..ff5d68df73 100644 --- a/docs/matter-node.js/classes/crypto_export.CryptoNode.md +++ b/docs/matter-node.js/classes/crypto_export.CryptoNode.md @@ -600,7 +600,7 @@ packages/matter.js/dist/esm/crypto/Crypto.d.ts:62 #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:152 +[packages/matter-node.js/src/crypto/CryptoNode.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L152) ___ @@ -627,7 +627,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:35 +[packages/matter-node.js/src/crypto/CryptoNode.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L35) ___ @@ -650,7 +650,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:53 +[packages/matter-node.js/src/crypto/CryptoNode.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L53) ___ @@ -679,7 +679,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:59 +[packages/matter-node.js/src/crypto/CryptoNode.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L59) ___ @@ -704,7 +704,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:68 +[packages/matter-node.js/src/crypto/CryptoNode.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L68) ___ @@ -731,7 +731,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:23 +[packages/matter-node.js/src/crypto/CryptoNode.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L23) ___ @@ -755,7 +755,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:49 +[packages/matter-node.js/src/crypto/CryptoNode.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L49) ___ @@ -779,7 +779,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:72 +[packages/matter-node.js/src/crypto/CryptoNode.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L72) ___ @@ -806,7 +806,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:91 +[packages/matter-node.js/src/crypto/CryptoNode.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L91) ___ @@ -831,7 +831,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:105 +[packages/matter-node.js/src/crypto/CryptoNode.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L105) ___ @@ -858,7 +858,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:82 +[packages/matter-node.js/src/crypto/CryptoNode.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L82) ___ @@ -884,7 +884,7 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:111 +[packages/matter-node.js/src/crypto/CryptoNode.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L111) ___ @@ -911,4 +911,4 @@ ___ #### Defined in -packages/matter-node.js/src/crypto/CryptoNode.ts:132 +[packages/matter-node.js/src/crypto/CryptoNode.ts:132](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/crypto/CryptoNode.ts#L132) diff --git a/docs/matter-node.js/classes/crypto_export.Spake2p.md b/docs/matter-node.js/classes/crypto_export.Spake2p.md index 75787c80dc..057786a29c 100644 --- a/docs/matter-node.js/classes/crypto_export.Spake2p.md +++ b/docs/matter-node.js/classes/crypto_export.Spake2p.md @@ -183,7 +183,7 @@ ___ ### computeW0L -▸ `Static` **computeW0L**(`pbkdfParameters`, `pin`): `Promise`<{ `L`: `any` ; `w0`: `BN` }\> +▸ `Static` **computeW0L**(`pbkdfParameters`, `pin`): `Promise`<{ `L`: `Uint8Array` ; `w0`: `BN` }\> #### Parameters @@ -194,7 +194,7 @@ ___ #### Returns -`Promise`<{ `L`: `any` ; `w0`: `BN` }\> +`Promise`<{ `L`: `Uint8Array` ; `w0`: `BN` }\> #### Defined in diff --git a/docs/matter-node.js/classes/export.CommissioningController.md b/docs/matter-node.js/classes/export.CommissioningController.md index 74564e91fb..72f1364d8b 100644 --- a/docs/matter-node.js/classes/export.CommissioningController.md +++ b/docs/matter-node.js/classes/export.CommissioningController.md @@ -4,7 +4,7 @@ [export](../modules/export.md).CommissioningController -Abstract base class that represents a node in the matter ecosystem. +Controller class to commission and connect multiple nodes into one fabric. ## Hierarchy @@ -20,46 +20,46 @@ Abstract base class that represents a node in the matter ecosystem. ### Properties +- [connectedNodes](export.CommissioningController.md#connectednodes) - [controllerInstance](export.CommissioningController.md#controllerinstance) -- [createDevice](export.CommissioningController.md#createdevice) -- [createInteractionClient](export.CommissioningController.md#createinteractionclient) -- [endpoints](export.CommissioningController.md#endpoints) -- [initializeEndpointStructure](export.CommissioningController.md#initializeendpointstructure) -- [interactionClient](export.CommissioningController.md#interactionclient) +- [initializeController](export.CommissioningController.md#initializecontroller) - [ipv4Disabled](export.CommissioningController.md#ipv4disabled) - [listeningAddressIpv4](export.CommissioningController.md#listeningaddressipv4) - [listeningAddressIpv6](export.CommissioningController.md#listeningaddressipv6) - [mdnsScanner](export.CommissioningController.md#mdnsscanner) -- [nodeId](export.CommissioningController.md#nodeid) - [options](export.CommissioningController.md#options) -- [rootEndpoint](export.CommissioningController.md#rootendpoint) -- [serverAddress](export.CommissioningController.md#serveraddress) +- [sessionDisconnectedHandler](export.CommissioningController.md#sessiondisconnectedhandler) +- [started](export.CommissioningController.md#started) - [storage](export.CommissioningController.md#storage) -- [structureEndpoints](export.CommissioningController.md#structureendpoints) + +### Accessors + +- [nodeId](export.CommissioningController.md#nodeid) ### Methods -- [addEndpoint](export.CommissioningController.md#addendpoint) -- [addRootClusterClient](export.CommissioningController.md#addrootclusterclient) -- [addRootClusterServer](export.CommissioningController.md#addrootclusterserver) +- [assertControllerIsStarted](export.CommissioningController.md#assertcontrollerisstarted) +- [assertIsAddedToMatterServer](export.CommissioningController.md#assertisaddedtomatterserver) - [close](export.CommissioningController.md#close) +- [commissionNode](export.CommissioningController.md#commissionnode) - [connect](export.CommissioningController.md#connect) +- [connectNode](export.CommissioningController.md#connectnode) +- [createInteractionClient](export.CommissioningController.md#createinteractionclient) +- [disconnectNode](export.CommissioningController.md#disconnectnode) +- [discoverCommissionableDevices](export.CommissioningController.md#discovercommissionabledevices) - [getActiveSessionInformation](export.CommissioningController.md#getactivesessioninformation) -- [getChildEndpoint](export.CommissioningController.md#getchildendpoint) -- [getDevices](export.CommissioningController.md#getdevices) -- [getFabric](export.CommissioningController.md#getfabric) -- [getInteractionClient](export.CommissioningController.md#getinteractionclient) +- [getCommissionedNodes](export.CommissioningController.md#getcommissionednodes) +- [getConnectedNode](export.CommissioningController.md#getconnectednode) - [getPort](export.CommissioningController.md#getport) -- [getRootClusterClient](export.CommissioningController.md#getrootclusterclient) -- [getRootClusterServer](export.CommissioningController.md#getrootclusterserver) -- [getRootEndpoint](export.CommissioningController.md#getrootendpoint) -- [initializeAfterConnect](export.CommissioningController.md#initializeafterconnect) +- [initialize](export.CommissioningController.md#initialize) - [isCommissioned](export.CommissioningController.md#iscommissioned) +- [isNodeCommissioned](export.CommissioningController.md#isnodecommissioned) +- [removeNode](export.CommissioningController.md#removenode) +- [resetStorage](export.CommissioningController.md#resetstorage) - [setMdnsBroadcaster](export.CommissioningController.md#setmdnsbroadcaster) - [setMdnsScanner](export.CommissioningController.md#setmdnsscanner) - [setStorage](export.CommissioningController.md#setstorage) - [start](export.CommissioningController.md#start) -- [subscribeAllAttributesAndEvents](export.CommissioningController.md#subscribeallattributesandevents) ## Constructors @@ -73,7 +73,7 @@ Creates a new CommissioningController instance | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`CommissioningControllerOptions`](../interfaces/export.CommissioningControllerOptions.md) | The options for the CommissioningController | +| `options` | [`CommissioningControllerOptions`](../modules/export.md#commissioningcontrolleroptions) | The options for the CommissioningController | #### Overrides @@ -81,95 +81,49 @@ Creates a new CommissioningController instance #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:44 +packages/matter.js/dist/esm/CommissioningController.d.ts:106 ## Properties -### controllerInstance - -• `Private` `Optional` **controllerInstance**: `any` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:35 - -___ - -### createDevice - -• `Private` **createDevice**: `any` - -Create a device object from the data read from the device. - -**`Param`** - -Endpoint ID - -**`Param`** - -Data of all clusters read from the device - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:104 - -___ - -### createInteractionClient - -• `Private` **createInteractionClient**: `any` +### connectedNodes -Creates and Return a new InteractionClient to communicate with the device. +• `Private` **connectedNodes**: `any` #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:83 +packages/matter.js/dist/esm/CommissioningController.d.ts:99 ___ -### endpoints +### controllerInstance -• `Private` **endpoints**: `any` +• `Private` `Optional` **controllerInstance**: `any` #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:38 +packages/matter.js/dist/esm/CommissioningController.d.ts:98 ___ -### initializeEndpointStructure - -• `Private` **initializeEndpointStructure**: `any` - -Read all data from the device and create a device object structure out of it. - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:89 - -___ +### initializeController -### interactionClient +• `Private` **initializeController**: `any` -• `Private` `Optional` **interactionClient**: `any` +Internal method to initialize a MatterController instance. #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:36 +packages/matter.js/dist/esm/CommissioningController.d.ts:114 ___ ### ipv4Disabled -• **ipv4Disabled**: `boolean` - -#### Inherited from - -[MatterNode](export.MatterNode.md).[ipv4Disabled](export.MatterNode.md#ipv4disabled) +• `Private` `Optional` **ipv4Disabled**: `any` #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:20 +packages/matter.js/dist/esm/CommissioningController.d.ts:93 ___ @@ -179,7 +133,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:31 +packages/matter.js/dist/esm/CommissioningController.d.ts:94 ___ @@ -189,7 +143,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:32 +packages/matter.js/dist/esm/CommissioningController.d.ts:95 ___ @@ -199,17 +153,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:34 - -___ - -### nodeId - -• `Private` `Optional` **nodeId**: `any` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:37 +packages/matter.js/dist/esm/CommissioningController.d.ts:97 ___ @@ -219,31 +163,27 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:29 +packages/matter.js/dist/esm/CommissioningController.d.ts:91 ___ -### rootEndpoint - -• `Protected` `Readonly` **rootEndpoint**: [`RootEndpoint`](exports_device.RootEndpoint.md) +### sessionDisconnectedHandler -#### Inherited from - -[MatterNode](export.MatterNode.md).[rootEndpoint](export.MatterNode.md#rootendpoint) +• `Private` **sessionDisconnectedHandler**: `any` #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:19 +packages/matter.js/dist/esm/CommissioningController.d.ts:100 ___ -### serverAddress +### started -• `Optional` **serverAddress**: [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) +• `Private` **started**: `any` #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:30 +packages/matter.js/dist/esm/CommissioningController.d.ts:92 ___ @@ -253,250 +193,274 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:33 - -___ +packages/matter.js/dist/esm/CommissioningController.d.ts:96 -### structureEndpoints +## Accessors -• `Private` **structureEndpoints**: `any` +### nodeId -Bring the endpoints in a structure based on their partsList attribute. +• `get` **nodeId**(): `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) -**`Param`** +#### Returns -A Map of the partsList attributes of all endpoints to structure +`undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:96 +packages/matter.js/dist/esm/CommissioningController.d.ts:107 ## Methods -### addEndpoint +### assertControllerIsStarted -▸ `Protected` **addEndpoint**(`endpoint`): `void` - -Add a child endpoint to the root endpoint. This is mainly used internally and not needed to be called by the user. +▸ **assertControllerIsStarted**(`errorText?`): [`MatterController`](export._internal_.MatterController.md) #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpoint` | [`Endpoint`](exports_device.Endpoint.md) | Endpoint to add | +| Name | Type | +| :------ | :------ | +| `errorText?` | `string` | #### Returns -`void` - -#### Inherited from - -[MatterNode](export.MatterNode.md).[addEndpoint](export.MatterNode.md#addendpoint) +[`MatterController`](export._internal_.MatterController.md) #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:55 +packages/matter.js/dist/esm/CommissioningController.d.ts:112 ___ -### addRootClusterClient +### assertIsAddedToMatterServer -▸ **addRootClusterClient**<`F`, `A`, `C`, `E`\>(`cluster`): `void` +▸ **assertIsAddedToMatterServer**(): `Object` -Add a cluster client to the root endpoint. This is mainly used internally and not needed to be called by the user. +#### Returns -#### Type parameters +`Object` | Name | Type | | :------ | :------ | -| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | -| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | -| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | +| `mdnsScanner` | [`MdnsScanner`](exports_mdns.MdnsScanner.md) | +| `storage` | [`StorageContext`](storage_export.StorageContext.md) | -#### Parameters +#### Defined in -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> | ClusterClient object to add | +packages/matter.js/dist/esm/CommissioningController.d.ts:108 + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +Disconnects all connected nodes and Closes the network connections and other resources of the controller. #### Returns -`void` +`Promise`<`void`\> -#### Inherited from +#### Overrides -[MatterNode](export.MatterNode.md).[addRootClusterClient](export.MatterNode.md#addrootclusterclient) +[MatterNode](export.MatterNode.md).[close](export.MatterNode.md#close) #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:38 +packages/matter.js/dist/esm/CommissioningController.d.ts:170 ___ -### addRootClusterServer +### commissionNode -▸ **addRootClusterServer**<`A`, `E`\>(`cluster`): `void` +▸ **commissionNode**(`nodeOptions`): `Promise`<[`PairedNode`](exports_device.PairedNode.md)\> -Add a cluster to the root endpoint. This is mainly used internally and not needed to be called by the user. +Commissions/Pairs a new device into the controller fabric. The method returns a PairedNode instance of the +paired node on success. -#### Type parameters +#### Parameters | Name | Type | | :------ | :------ | -| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | -| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | +| `nodeOptions` | [`NodeCommissioningOptions`](../modules/export.md#nodecommissioningoptions) | -#### Parameters +#### Returns -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> | ClusterServer object to add | +`Promise`<[`PairedNode`](exports_device.PairedNode.md)\> -#### Returns +#### Defined in -`void` +packages/matter.js/dist/esm/CommissioningController.d.ts:119 + +___ + +### connect + +▸ **connect**(): `Promise`<[`PairedNode`](exports_device.PairedNode.md)[]\> + +Connects to all paired nodes. +After connection the endpoint data of the device is analyzed and an object structure is created. -#### Inherited from +#### Returns -[MatterNode](export.MatterNode.md).[addRootClusterServer](export.MatterNode.md#addrootclusterserver) +`Promise`<[`PairedNode`](exports_device.PairedNode.md)[]\> #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:26 +packages/matter.js/dist/esm/CommissioningController.d.ts:139 ___ -### close +### connectNode -▸ **close**(): `Promise`<`void`\> +▸ **connectNode**(`nodeId`, `connectOptions?`): `Promise`<[`PairedNode`](exports_device.PairedNode.md)\> -close network connections of the device +Connect to an already paired Node. +After connection the endpoint data of the device is analyzed and an object structure is created. -#### Returns +#### Parameters -`Promise`<`void`\> +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `connectOptions?` | [`CommissioningControllerNodeOptions`](../modules/exports_device.md#commissioningcontrollernodeoptions) | -#### Overrides +#### Returns -[MatterNode](export.MatterNode.md).[close](export.MatterNode.md#close) +`Promise`<[`PairedNode`](exports_device.PairedNode.md)\> #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:112 +packages/matter.js/dist/esm/CommissioningController.d.ts:134 ___ -### connect +### createInteractionClient -▸ **connect**(): `Promise`<`void`\> +▸ **createInteractionClient**(`nodeId`): `Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> -Connects to the device. This includes pairing with the device if not yet paired. -After connection the endpoint data of the device is analyzed and an object structure is created. +Creates and Return a new InteractionClient to communicate with a node. This is mainly used internally and should +not be used directly. See the PairedNode class for the public API. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | #### Returns -`Promise`<`void`\> +`Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:49 +packages/matter.js/dist/esm/CommissioningController.d.ts:164 ___ -### getActiveSessionInformation +### disconnectNode + +▸ **disconnectNode**(`nodeId`): `Promise`<`void`\> -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +`Promise`<`void`\> #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:115 +packages/matter.js/dist/esm/CommissioningController.d.ts:129 ___ -### getChildEndpoint +### discoverCommissionableDevices -▸ `Protected` **getChildEndpoint**(`endpointId`): `undefined` \| [`Endpoint`](exports_device.Endpoint.md) - -Get a child endpoint from the root endpoint. This is mainly used internally and not needed to be called by the user. +▸ **discoverCommissionableDevices**(`identifierData`, `discoveryCapabilities?`, `discoveredCallback?`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpointId` | [`EndpointNumber`](../modules/exports_datatype.md#endpointnumber) | Endpoint ID of the child endpoint to get | +| Name | Type | +| :------ | :------ | +| `identifierData` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | +| `discoveryCapabilities?` | [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<{ `ble`: [`BitFlag`](../modules/exports_schema.md#bitflag-1) ; `onIpNetwork`: [`BitFlag`](../modules/exports_schema.md#bitflag-1) ; `softAccessPoint`: [`BitFlag`](../modules/exports_schema.md#bitflag-1) }\> | +| `discoveredCallback?` | (`device`: [`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)) => `void` | +| `timeoutSeconds?` | `number` | #### Returns -`undefined` \| [`Endpoint`](exports_device.Endpoint.md) - -#### Inherited from - -[MatterNode](export.MatterNode.md).[getChildEndpoint](export.MatterNode.md#getchildendpoint) +`Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:62 +packages/matter.js/dist/esm/CommissioningController.d.ts:175 ___ -### getDevices +### getActiveSessionInformation -▸ **getDevices**(): [`Endpoint`](exports_device.Endpoint.md)[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] -Returns the devices known to the controller. +Returns active session information for all connected nodes. #### Returns -[`Endpoint`](exports_device.Endpoint.md)[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:108 +packages/matter.js/dist/esm/CommissioningController.d.ts:178 ___ -### getFabric +### getCommissionedNodes -▸ **getFabric**(): [`Fabric`](exports_fabric.Fabric.md) +▸ **getCommissionedNodes**(): [`NodeId`](../modules/exports_datatype.md#nodeid)[] -Returns the paired Fabric object of the node +Returns an array with the Node Ids for all commissioned nodes. #### Returns -[`Fabric`](exports_fabric.Fabric.md) +[`NodeId`](../modules/exports_datatype.md#nodeid)[] #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:75 +packages/matter.js/dist/esm/CommissioningController.d.ts:168 ___ -### getInteractionClient +### getConnectedNode + +▸ **getConnectedNode**(`nodeId`): `undefined` \| [`PairedNode`](exports_device.PairedNode.md) -▸ **getInteractionClient**(): [`InteractionClient`](exports_interaction.InteractionClient.md) +Returns the PairedNode instance for a given node id, if this node is connected. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | #### Returns -[`InteractionClient`](exports_interaction.InteractionClient.md) +`undefined` \| [`PairedNode`](exports_device.PairedNode.md) #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:132 +packages/matter.js/dist/esm/CommissioningController.d.ts:166 ___ ### getPort -▸ **getPort**(): `undefined` +▸ **getPort**(): `undefined` \| `number` #### Returns -`undefined` +`undefined` \| `number` #### Overrides @@ -504,105 +468,87 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:113 +packages/matter.js/dist/esm/CommissioningController.d.ts:171 ___ -### getRootClusterClient - -▸ **getRootClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> +### initialize -Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user. +▸ **initialize**(`ipv4Disabled`): `void` -#### Type parameters +#### Parameters | Name | Type | | :------ | :------ | -| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | -| `SF` | extends [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<`F`\> | -| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | -| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`Cluster`](../modules/exports_cluster.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterClient to get or undefined if not existing | +| `ipv4Disabled` | `boolean` | #### Returns -`undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> +`void` -#### Inherited from +#### Overrides -[MatterNode](export.MatterNode.md).[getRootClusterClient](export.MatterNode.md#getrootclusterclient) +[MatterNode](export.MatterNode.md).[initialize](export.MatterNode.md#initialize) #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:44 +packages/matter.js/dist/esm/CommissioningController.d.ts:172 ___ -### getRootClusterServer - -▸ **getRootClusterServer**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> - -Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | -| `SF` | extends [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<`F`\> | -| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | -| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | +### isCommissioned -#### Parameters +▸ **isCommissioned**(): `boolean` -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`Cluster`](../modules/exports_cluster.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterServer to get or undefined if not existing | +Returns true if t least one node is commissioned/paired with this controller instance. #### Returns -`undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> - -#### Inherited from - -[MatterNode](export.MatterNode.md).[getRootClusterServer](export.MatterNode.md#getrootclusterserver) +`boolean` #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:32 +packages/matter.js/dist/esm/CommissioningController.d.ts:159 ___ -### getRootEndpoint +### isNodeCommissioned -▸ **getRootEndpoint**(): [`RootEndpoint`](exports_device.RootEndpoint.md) +▸ **isNodeCommissioned**(`nodeId`): `boolean` -Get the root endpoint of the node. +Check if a given node id is commissioned on this controller. -#### Returns +#### Parameters -[`RootEndpoint`](exports_device.RootEndpoint.md) +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | -#### Inherited from +#### Returns -[MatterNode](export.MatterNode.md).[getRootEndpoint](export.MatterNode.md#getrootendpoint) +`boolean` #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:48 +packages/matter.js/dist/esm/CommissioningController.d.ts:121 ___ -### initializeAfterConnect +### removeNode + +▸ **removeNode**(`nodeId`, `tryDecommissioning?`): `Promise`<`void`\> -▸ **initializeAfterConnect**(): `Promise`<`void`\> +Remove a Node id from the controller. This method should only be used if the decommission method on the +PairedNode instance returns an error. By default it tries to decommission the node from the controller but will +remove it also in case of an error during decommissioning. Ideally try to decommission the node before and only +use this in case of an error. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `tryDecommissioning?` | `boolean` | #### Returns @@ -610,23 +556,21 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:54 +packages/matter.js/dist/esm/CommissioningController.d.ts:128 ___ -### isCommissioned - -▸ **isCommissioned**(): `boolean` +### resetStorage -Return info if a device is successfully paired. +▸ **resetStorage**(): `void` #### Returns -`boolean` +`void` #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:79 +packages/matter.js/dist/esm/CommissioningController.d.ts:176 ___ @@ -652,7 +596,7 @@ Set the MDNS Broadcaster instance. Should be only used internally #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:66 +packages/matter.js/dist/esm/CommissioningController.d.ts:151 ___ @@ -678,7 +622,7 @@ Set the MDNS Scanner instance. Should be only used internally #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:60 +packages/matter.js/dist/esm/CommissioningController.d.ts:145 ___ @@ -700,7 +644,7 @@ Set the Storage instance. Should be only used internally #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:71 +packages/matter.js/dist/esm/CommissioningController.d.ts:157 ___ @@ -708,6 +652,8 @@ ___ ▸ **start**(): `Promise`<`void`\> +Initialize the controller and connect to all commissioned nodes if autoConnect is not set to false. + #### Returns `Promise`<`void`\> @@ -718,24 +664,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningController.d.ts:114 - -___ - -### subscribeAllAttributesAndEvents - -▸ **subscribeAllAttributesAndEvents**(`ignoreInitialTriggers`): `Promise`<{ `attributeReports?`: [`DecodedAttributeReportValue`](../modules/exports_interaction.md#decodedattributereportvalue)<`any`\>[] ; `eventReports?`: [`DecodedEventReportValue`](../modules/exports_interaction.md#decodedeventreportvalue)<`any`\>[] }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ignoreInitialTriggers` | `boolean` | - -#### Returns - -`Promise`<{ `attributeReports?`: [`DecodedAttributeReportValue`](../modules/exports_interaction.md#decodedattributereportvalue)<`any`\>[] ; `eventReports?`: [`DecodedEventReportValue`](../modules/exports_interaction.md#decodedeventreportvalue)<`any`\>[] }\> - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:50 +packages/matter.js/dist/esm/CommissioningController.d.ts:174 diff --git a/docs/matter-node.js/classes/export.CommissioningServer.md b/docs/matter-node.js/classes/export.CommissioningServer.md index 733520ec35..686fbe1bb6 100644 --- a/docs/matter-node.js/classes/export.CommissioningServer.md +++ b/docs/matter-node.js/classes/export.CommissioningServer.md @@ -50,6 +50,7 @@ host - [advertise](export.CommissioningServer.md#advertise) - [assignEndpointIds](export.CommissioningServer.md#assignendpointids) - [close](export.CommissioningServer.md#close) +- [factoryReset](export.CommissioningServer.md#factoryreset) - [getActiveSessionInformation](export.CommissioningServer.md#getactivesessioninformation) - [getChildEndpoint](export.CommissioningServer.md#getchildendpoint) - [getCommissionedFabricInformation](export.CommissioningServer.md#getcommissionedfabricinformation) @@ -59,10 +60,13 @@ host - [getRootClusterClient](export.CommissioningServer.md#getrootclusterclient) - [getRootClusterServer](export.CommissioningServer.md#getrootclusterserver) - [getRootEndpoint](export.CommissioningServer.md#getrootendpoint) +- [initialize](export.CommissioningServer.md#initialize) - [isCommissioned](export.CommissioningServer.md#iscommissioned) - [removeCommandHandler](export.CommissioningServer.md#removecommandhandler) - [setMdnsBroadcaster](export.CommissioningServer.md#setmdnsbroadcaster) - [setMdnsScanner](export.CommissioningServer.md#setmdnsscanner) +- [setPort](export.CommissioningServer.md#setport) +- [setReachability](export.CommissioningServer.md#setreachability) - [setStorage](export.CommissioningServer.md#setstorage) - [start](export.CommissioningServer.md#start) - [updateStructure](export.CommissioningServer.md#updatestructure) @@ -87,7 +91,7 @@ Creates a new CommissioningServer node and add all needed Root clusters #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:131 +packages/matter.js/dist/esm/CommissioningServer.d.ts:148 ## Properties @@ -97,7 +101,7 @@ packages/matter.js/dist/esm/CommissioningServer.d.ts:131 #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:125 +packages/matter.js/dist/esm/CommissioningServer.d.ts:142 ___ @@ -107,7 +111,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:124 +packages/matter.js/dist/esm/CommissioningServer.d.ts:141 ___ @@ -117,7 +121,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:121 +packages/matter.js/dist/esm/CommissioningServer.d.ts:137 ___ @@ -127,7 +131,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:115 +packages/matter.js/dist/esm/CommissioningServer.d.ts:131 ___ @@ -137,7 +141,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:118 +packages/matter.js/dist/esm/CommissioningServer.d.ts:134 ___ @@ -147,7 +151,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:151 +packages/matter.js/dist/esm/CommissioningServer.d.ts:204 ___ @@ -157,7 +161,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:116 +packages/matter.js/dist/esm/CommissioningServer.d.ts:132 ___ @@ -167,7 +171,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:150 +packages/matter.js/dist/esm/CommissioningServer.d.ts:203 ___ @@ -177,21 +181,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:122 +packages/matter.js/dist/esm/CommissioningServer.d.ts:138 ___ ### ipv4Disabled -• **ipv4Disabled**: `boolean` - -#### Inherited from - -[MatterNode](export.MatterNode.md).[ipv4Disabled](export.MatterNode.md#ipv4disabled) +• `Private` `Optional` **ipv4Disabled**: `any` #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:20 +packages/matter.js/dist/esm/CommissioningServer.d.ts:128 ___ @@ -201,7 +201,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:120 +packages/matter.js/dist/esm/CommissioningServer.d.ts:136 ___ @@ -211,7 +211,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:119 +packages/matter.js/dist/esm/CommissioningServer.d.ts:135 ___ @@ -221,7 +221,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:123 +packages/matter.js/dist/esm/CommissioningServer.d.ts:140 ___ @@ -231,7 +231,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:112 +packages/matter.js/dist/esm/CommissioningServer.d.ts:127 ___ @@ -241,17 +241,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:114 +packages/matter.js/dist/esm/CommissioningServer.d.ts:130 ___ ### port -• `Private` `Readonly` **port**: `any` +• `Private` `Optional` **port**: `any` #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:113 +packages/matter.js/dist/esm/CommissioningServer.d.ts:129 ___ @@ -259,13 +259,9 @@ ___ • `Protected` `Readonly` **rootEndpoint**: [`RootEndpoint`](exports_device.RootEndpoint.md) -#### Inherited from - -[MatterNode](export.MatterNode.md).[rootEndpoint](export.MatterNode.md#rootendpoint) - #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:19 +packages/matter.js/dist/esm/CommissioningServer.d.ts:139 ___ @@ -275,7 +271,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:117 +packages/matter.js/dist/esm/CommissioningServer.d.ts:133 ## Methods @@ -304,7 +300,7 @@ Add a new command handler for the given command #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:197 +packages/matter.js/dist/esm/CommissioningServer.d.ts:253 ___ @@ -326,7 +322,7 @@ Add a new device to the node #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:182 +packages/matter.js/dist/esm/CommissioningServer.d.ts:235 ___ @@ -346,13 +342,9 @@ Add a child endpoint to the root endpoint. This is mainly used internally and no `void` -#### Inherited from - -[MatterNode](export.MatterNode.md).[addEndpoint](export.MatterNode.md#addendpoint) - #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:55 +packages/matter.js/dist/esm/CommissioningServer.d.ts:177 ___ @@ -381,13 +373,9 @@ Add a cluster client to the root endpoint. This is mainly used internally and no `void` -#### Inherited from - -[MatterNode](export.MatterNode.md).[addRootClusterClient](export.MatterNode.md#addrootclusterclient) - #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:38 +packages/matter.js/dist/esm/CommissioningServer.d.ts:160 ___ @@ -416,13 +404,9 @@ added in the constructor `void` -#### Overrides - -[MatterNode](export.MatterNode.md).[addRootClusterServer](export.MatterNode.md#addrootclusterserver) - #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:139 +packages/matter.js/dist/esm/CommissioningServer.d.ts:192 ___ @@ -444,7 +428,7 @@ Advertise the node via all available interfaces (Ethernet/MDNS, BLE, ...) and st #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:146 +packages/matter.js/dist/esm/CommissioningServer.d.ts:199 ___ @@ -458,7 +442,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:149 +packages/matter.js/dist/esm/CommissioningServer.d.ts:202 ___ @@ -466,7 +450,7 @@ ___ ▸ **close**(): `Promise`<`void`\> -close network connections of the device +Close network connections of the device and stop responding to requests #### Returns @@ -478,23 +462,43 @@ close network connections of the device #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:190 +packages/matter.js/dist/esm/CommissioningServer.d.ts:245 + +___ + +### factoryReset + +▸ **factoryReset**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/CommissioningServer.d.ts:246 ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(`fabricIndex?`): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] Get some basic details of all currently active sessions. +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fabricIndex?` | [`FabricIndex`](../modules/exports_datatype.md#fabricindex) | Optional fabric index to filter for. If not set all sessions are returned. | + #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:215 +packages/matter.js/dist/esm/CommissioningServer.d.ts:290 ___ @@ -514,29 +518,31 @@ Get a child endpoint from the root endpoint. This is mainly used internally and `undefined` \| [`Endpoint`](exports_device.Endpoint.md) -#### Inherited from - -[MatterNode](export.MatterNode.md).[getChildEndpoint](export.MatterNode.md#getchildendpoint) - #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:62 +packages/matter.js/dist/esm/CommissioningServer.d.ts:184 ___ ### getCommissionedFabricInformation -▸ **getCommissionedFabricInformation**(): { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) }[] +▸ **getCommissionedFabricInformation**(`fabricIndex?`): { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) }[] Get some basic details of all Fabrics the server is commissioned to. +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fabricIndex?` | [`FabricIndex`](../modules/exports_datatype.md#fabricindex) | Optional fabric index to filter for. If not set all fabrics are returned. | + #### Returns -{ `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) }[] +{ `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) }[] #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:207 +packages/matter.js/dist/esm/CommissioningServer.d.ts:277 ___ @@ -556,7 +562,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:148 +packages/matter.js/dist/esm/CommissioningServer.d.ts:201 ___ @@ -578,19 +584,19 @@ Return the pairing information for the device #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:159 +packages/matter.js/dist/esm/CommissioningServer.d.ts:212 ___ ### getPort -▸ **getPort**(): `number` +▸ **getPort**(): `undefined` \| `number` Return the port the device is listening on #### Returns -`number` +`undefined` \| `number` #### Overrides @@ -598,7 +604,7 @@ Return the port the device is listening on #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:186 +packages/matter.js/dist/esm/CommissioningServer.d.ts:239 ___ @@ -628,13 +634,9 @@ Get a cluster client from the root endpoint. This is mainly used internally and `undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> -#### Inherited from - -[MatterNode](export.MatterNode.md).[getRootClusterClient](export.MatterNode.md#getrootclusterclient) - #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:44 +packages/matter.js/dist/esm/CommissioningServer.d.ts:166 ___ @@ -664,13 +666,9 @@ Get a cluster server from the root endpoint. This is mainly used internally and `undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> -#### Inherited from - -[MatterNode](export.MatterNode.md).[getRootClusterServer](export.MatterNode.md#getrootclusterserver) - #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:32 +packages/matter.js/dist/esm/CommissioningServer.d.ts:154 ___ @@ -684,13 +682,35 @@ Get the root endpoint of the node. [`RootEndpoint`](exports_device.RootEndpoint.md) -#### Inherited from +#### Defined in + +packages/matter.js/dist/esm/CommissioningServer.d.ts:170 + +___ + +### initialize -[MatterNode](export.MatterNode.md).[getRootEndpoint](export.MatterNode.md#getrootendpoint) +▸ **initialize**(`ipv4Disabled`): `void` + +used internally by MatterServer to initialize the state of the device. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ipv4Disabled` | `boolean` | + +#### Returns + +`void` + +#### Overrides + +[MatterNode](export.MatterNode.md).[initialize](export.MatterNode.md#initialize) #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:48 +packages/matter.js/dist/esm/CommissioningServer.d.ts:269 ___ @@ -706,7 +726,7 @@ Return info if the device is paired with at least one controller #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:155 +packages/matter.js/dist/esm/CommissioningServer.d.ts:208 ___ @@ -735,7 +755,7 @@ Remove a command handler for the given command #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:204 +packages/matter.js/dist/esm/CommissioningServer.d.ts:260 ___ @@ -761,7 +781,7 @@ Set the MDNS Broadcaster instance. Should be only used internally #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:171 +packages/matter.js/dist/esm/CommissioningServer.d.ts:224 ___ @@ -787,7 +807,52 @@ Set the MDNS Scanner instance. Should be only used internally #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:165 +packages/matter.js/dist/esm/CommissioningServer.d.ts:218 + +___ + +### setPort + +▸ **setPort**(`port`): `void` + +Set the port the device is listening on. Can only be called before the device is initialized. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `port` | `number` | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/CommissioningServer.d.ts:241 + +___ + +### setReachability + +▸ **setReachability**(`reachable`): `void` + +Set the reachability of the commissioning server aka "the main matter device". This call only has effect when +the reachability flag was set in the BasicInformationCluster or in the BasicInformation data in the constructor! + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/CommissioningServer.d.ts:267 ___ @@ -809,7 +874,7 @@ Set the StorageManager instance. Should be only used internally #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:176 +packages/matter.js/dist/esm/CommissioningServer.d.ts:229 ___ @@ -817,6 +882,8 @@ ___ ▸ **start**(): `Promise`<`void`\> +Starts the Matter device and advertises it. + #### Returns `Promise`<`void`\> @@ -827,7 +894,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:205 +packages/matter.js/dist/esm/CommissioningServer.d.ts:271 ___ @@ -841,4 +908,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:147 +packages/matter.js/dist/esm/CommissioningServer.d.ts:200 diff --git a/docs/matter-node.js/classes/export.MatterNode.md b/docs/matter-node.js/classes/export.MatterNode.md index 0884d769f6..33c8c30cb0 100644 --- a/docs/matter-node.js/classes/export.MatterNode.md +++ b/docs/matter-node.js/classes/export.MatterNode.md @@ -20,22 +20,11 @@ Abstract base class that represents a node in the matter ecosystem. - [constructor](export.MatterNode.md#constructor) -### Properties - -- [ipv4Disabled](export.MatterNode.md#ipv4disabled) -- [rootEndpoint](export.MatterNode.md#rootendpoint) - ### Methods -- [addEndpoint](export.MatterNode.md#addendpoint) -- [addRootClusterClient](export.MatterNode.md#addrootclusterclient) -- [addRootClusterServer](export.MatterNode.md#addrootclusterserver) - [close](export.MatterNode.md#close) -- [getChildEndpoint](export.MatterNode.md#getchildendpoint) - [getPort](export.MatterNode.md#getport) -- [getRootClusterClient](export.MatterNode.md#getrootclusterclient) -- [getRootClusterServer](export.MatterNode.md#getrootclusterserver) -- [getRootEndpoint](export.MatterNode.md#getrootendpoint) +- [initialize](export.MatterNode.md#initialize) - [setMdnsBroadcaster](export.MatterNode.md#setmdnsbroadcaster) - [setMdnsScanner](export.MatterNode.md#setmdnsscanner) - [start](export.MatterNode.md#start) @@ -46,110 +35,8 @@ Abstract base class that represents a node in the matter ecosystem. • **new MatterNode**() -## Properties - -### ipv4Disabled - -• **ipv4Disabled**: `boolean` - -#### Defined in - -packages/matter.js/dist/esm/MatterNode.d.ts:20 - -___ - -### rootEndpoint - -• `Protected` `Readonly` **rootEndpoint**: [`RootEndpoint`](exports_device.RootEndpoint.md) - -#### Defined in - -packages/matter.js/dist/esm/MatterNode.d.ts:19 - ## Methods -### addEndpoint - -▸ `Protected` **addEndpoint**(`endpoint`): `void` - -Add a child endpoint to the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpoint` | [`Endpoint`](exports_device.Endpoint.md) | Endpoint to add | - -#### Returns - -`void` - -#### Defined in - -packages/matter.js/dist/esm/MatterNode.d.ts:55 - -___ - -### addRootClusterClient - -▸ **addRootClusterClient**<`F`, `A`, `C`, `E`\>(`cluster`): `void` - -Add a cluster client to the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | -| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | -| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> | ClusterClient object to add | - -#### Returns - -`void` - -#### Defined in - -packages/matter.js/dist/esm/MatterNode.d.ts:38 - -___ - -### addRootClusterServer - -▸ **addRootClusterServer**<`A`, `E`\>(`cluster`): `void` - -Add a cluster to the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | -| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> | ClusterServer object to add | - -#### Returns - -`void` - -#### Defined in - -packages/matter.js/dist/esm/MatterNode.d.ts:26 - -___ - ### close ▸ `Abstract` **close**(): `Promise`<`void`\> @@ -160,29 +47,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:63 - -___ - -### getChildEndpoint - -▸ `Protected` **getChildEndpoint**(`endpointId`): `undefined` \| [`Endpoint`](exports_device.Endpoint.md) - -Get a child endpoint from the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpointId` | [`EndpointNumber`](../modules/exports_datatype.md#endpointnumber) | Endpoint ID of the child endpoint to get | - -#### Returns - -`undefined` \| [`Endpoint`](exports_device.Endpoint.md) - -#### Defined in - -packages/matter.js/dist/esm/MatterNode.d.ts:62 +packages/matter.js/dist/esm/MatterNode.d.ts:12 ___ @@ -196,87 +61,27 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:64 +packages/matter.js/dist/esm/MatterNode.d.ts:13 ___ -### getRootClusterClient - -▸ **getRootClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> - -Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user. +### initialize -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | -| `SF` | extends [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<`F`\> | -| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | -| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | +▸ `Abstract` **initialize**(`ipv4Disabled`): `void` #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`Cluster`](../modules/exports_cluster.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterClient to get or undefined if not existing | - -#### Returns - -`undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> - -#### Defined in - -packages/matter.js/dist/esm/MatterNode.d.ts:44 - -___ - -### getRootClusterServer - -▸ **getRootClusterServer**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> - -Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Type parameters - | Name | Type | | :------ | :------ | -| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | -| `SF` | extends [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<`F`\> | -| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | -| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`Cluster`](../modules/exports_cluster.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterServer to get or undefined if not existing | - -#### Returns - -`undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> - -#### Defined in - -packages/matter.js/dist/esm/MatterNode.d.ts:32 - -___ - -### getRootEndpoint - -▸ **getRootEndpoint**(): [`RootEndpoint`](exports_device.RootEndpoint.md) - -Get the root endpoint of the node. +| `ipv4Disabled` | `boolean` | #### Returns -[`RootEndpoint`](exports_device.RootEndpoint.md) +`void` #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:48 +packages/matter.js/dist/esm/MatterNode.d.ts:14 ___ @@ -296,7 +101,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:66 +packages/matter.js/dist/esm/MatterNode.d.ts:16 ___ @@ -316,7 +121,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:67 +packages/matter.js/dist/esm/MatterNode.d.ts:17 ___ @@ -330,4 +135,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterNode.d.ts:65 +packages/matter.js/dist/esm/MatterNode.d.ts:15 diff --git a/docs/matter-node.js/classes/export.MatterServer.md b/docs/matter-node.js/classes/export.MatterServer.md index dbccd7c6d5..c4f3634db1 100644 --- a/docs/matter-node.js/classes/export.MatterServer.md +++ b/docs/matter-node.js/classes/export.MatterServer.md @@ -15,11 +15,14 @@ by reusing MDNS scanner and broadcaster ### Properties +- [formerlyUsedPorts](export.MatterServer.md#formerlyusedports) +- [getNextMatterPort](export.MatterServer.md#getnextmatterport) - [mdnsBroadcaster](export.MatterServer.md#mdnsbroadcaster) - [mdnsScanner](export.MatterServer.md#mdnsscanner) - [nodes](export.MatterServer.md#nodes) - [options](export.MatterServer.md#options) - [prepareNode](export.MatterServer.md#preparenode) +- [started](export.MatterServer.md#started) - [storageManager](export.MatterServer.md#storagemanager) ### Accessors @@ -31,6 +34,8 @@ by reusing MDNS scanner and broadcaster - [addCommissioningController](export.MatterServer.md#addcommissioningcontroller) - [addCommissioningServer](export.MatterServer.md#addcommissioningserver) - [close](export.MatterServer.md#close) +- [removeCommissioningController](export.MatterServer.md#removecommissioningcontroller) +- [removeCommissioningServer](export.MatterServer.md#removecommissioningserver) - [start](export.MatterServer.md#start) ## Constructors @@ -50,17 +55,37 @@ Create a new Matter server instance #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:37 +packages/matter.js/dist/esm/MatterServer.d.ts:52 ## Properties +### formerlyUsedPorts + +• `Private` `Readonly` **formerlyUsedPorts**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterServer.d.ts:45 + +___ + +### getNextMatterPort + +• `Private` **getNextMatterPort**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterServer.d.ts:54 + +___ + ### mdnsBroadcaster • `Private` `Optional` **mdnsBroadcaster**: `any` #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:30 +packages/matter.js/dist/esm/MatterServer.d.ts:44 ___ @@ -70,7 +95,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:29 +packages/matter.js/dist/esm/MatterServer.d.ts:43 ___ @@ -80,7 +105,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:28 +packages/matter.js/dist/esm/MatterServer.d.ts:42 ___ @@ -90,7 +115,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:27 +packages/matter.js/dist/esm/MatterServer.d.ts:40 ___ @@ -100,7 +125,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:58 +packages/matter.js/dist/esm/MatterServer.d.ts:89 + +___ + +### started + +• `Private` **started**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterServer.d.ts:41 ___ @@ -110,7 +145,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:26 +packages/matter.js/dist/esm/MatterServer.d.ts:39 ## Accessors @@ -124,13 +159,13 @@ packages/matter.js/dist/esm/MatterServer.d.ts:26 #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:38 +packages/matter.js/dist/esm/MatterServer.d.ts:53 ## Methods ### addCommissioningController -▸ **addCommissioningController**(`commissioningController`, `nodeOptions?`): `void` +▸ **addCommissioningController**(`commissioningController`, `nodeOptions?`): `Promise`<`void`\> Add a Controller node to the server @@ -143,17 +178,17 @@ Add a Controller node to the server #### Returns -`void` +`Promise`<`void`\> #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:52 +packages/matter.js/dist/esm/MatterServer.d.ts:76 ___ ### addCommissioningServer -▸ **addCommissioningServer**(`commissioningServer`, `nodeOptions?`): `void` +▸ **addCommissioningServer**(`commissioningServer`, `nodeOptions?`): `Promise`<`void`\> Add a CommissioningServer node to the server @@ -166,11 +201,11 @@ Add a CommissioningServer node to the server #### Returns -`void` +`Promise`<`void`\> #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:45 +packages/matter.js/dist/esm/MatterServer.d.ts:61 ___ @@ -186,7 +221,54 @@ Close the server and all nodes #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:62 +packages/matter.js/dist/esm/MatterServer.d.ts:93 + +___ + +### removeCommissioningController + +▸ **removeCommissioningController**(`commissioningController`, `destroyStorage?`): `Promise`<`void`\> + +Remove a Controller node from the server, close the Controller and optionally destroy the storage context. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `commissioningController` | [`CommissioningController`](export.CommissioningController.md) | Controller node to remove | +| `destroyStorage?` | `boolean` | If true the storage context will be destroyed | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/MatterServer.d.ts:83 + +___ + +### removeCommissioningServer + +▸ **removeCommissioningServer**(`commissioningServer`, `destroyStorage?`): `Promise`<`void`\> + +Remove a CommissioningServer node from the server, close the CommissioningServer and optionally destroy the +storage context. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `commissioningServer` | [`CommissioningServer`](export.CommissioningServer.md) | CommissioningServer node to remove | +| `destroyStorage?` | `boolean` | If true the storage context will be destroyed | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/MatterServer.d.ts:69 ___ @@ -203,4 +285,4 @@ be announced/paired immediately. #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:57 +packages/matter.js/dist/esm/MatterServer.d.ts:88 diff --git a/docs/matter-node.js/classes/export._internal_.DimmableBaseDevice.md b/docs/matter-node.js/classes/export._internal_.DimmableBaseDevice.md index 5ca27d2893..63f14cd608 100644 --- a/docs/matter-node.js/classes/export._internal_.DimmableBaseDevice.md +++ b/docs/matter-node.js/classes/export._internal_.DimmableBaseDevice.md @@ -62,6 +62,7 @@ - [removeChildEndpoint](export._internal_.DimmableBaseDevice.md#removechildendpoint) - [removeCommandHandler](export._internal_.DimmableBaseDevice.md#removecommandhandler) - [removeFromStructure](export._internal_.DimmableBaseDevice.md#removefromstructure) +- [setBridgedDeviceReachability](export._internal_.DimmableBaseDevice.md#setbridgeddevicereachability) - [setCurrentLevel](export._internal_.DimmableBaseDevice.md#setcurrentlevel) - [setDeviceTypes](export._internal_.DimmableBaseDevice.md#setdevicetypes) - [setOnOff](export._internal_.DimmableBaseDevice.md#setonoff) @@ -96,7 +97,7 @@ packages/matter.js/dist/esm/device/DimmableDevices.d.ts:17 ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -104,7 +105,7 @@ DimmableBaseDevice\_base.commandHandler #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:64 +packages/matter.js/dist/esm/device/Device.d.ts:82 ___ @@ -118,7 +119,7 @@ DimmableBaseDevice\_base.deviceType #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:63 +packages/matter.js/dist/esm/device/Device.d.ts:81 ___ @@ -202,7 +203,7 @@ DimmableBaseDevice\_base.\_executeHandler #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:96 +packages/matter.js/dist/esm/device/Device.d.ts:114 ▸ `Protected` **_executeHandler**<`K_2`\>(`action`, `...args`): `Promise`<`void`\> @@ -360,7 +361,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -372,7 +373,7 @@ DimmableBaseDevice\_base.addCommandHandler #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:79 +packages/matter.js/dist/esm/device/Device.d.ts:97 ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -584,7 +585,7 @@ DimmableBaseDevice\_base.createOptionalClusterClient #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:98 +packages/matter.js/dist/esm/device/Device.d.ts:116 ___ @@ -618,7 +619,7 @@ DimmableBaseDevice\_base.createOptionalClusterServer #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:97 +packages/matter.js/dist/esm/device/Device.d.ts:115 ___ @@ -766,7 +767,7 @@ DimmableBaseDevice\_base.getClusterClient #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:100 +packages/matter.js/dist/esm/device/Device.d.ts:118 ___ @@ -824,7 +825,7 @@ DimmableBaseDevice\_base.getClusterServer #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:99 +packages/matter.js/dist/esm/device/Device.d.ts:117 ___ @@ -1024,7 +1025,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -1036,7 +1037,7 @@ DimmableBaseDevice\_base.removeCommandHandler #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:87 +packages/matter.js/dist/esm/device/Device.d.ts:105 ▸ **removeCommandHandler**<`K_1`\>(`action`, `handler`): `void` @@ -1112,6 +1113,33 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:36 ___ +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +DimmableBaseDevice\_base.setBridgedDeviceReachability + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:125 + +___ + ### setCurrentLevel ▸ **setCurrentLevel**(`level`): `void` diff --git a/docs/matter-node.js/classes/export._internal_.ManualPairingCodeSchema.md b/docs/matter-node.js/classes/export._internal_.ManualPairingCodeSchema.md index 890e99a787..fd4ff488a2 100644 --- a/docs/matter-node.js/classes/export._internal_.ManualPairingCodeSchema.md +++ b/docs/matter-node.js/classes/export._internal_.ManualPairingCodeSchema.md @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:60 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:61 ___ @@ -135,7 +135,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:59 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:60 ___ diff --git a/docs/matter-node.js/classes/export._internal_.MatterController.md b/docs/matter-node.js/classes/export._internal_.MatterController.md index f462ee05d3..08113a5ca5 100644 --- a/docs/matter-node.js/classes/export._internal_.MatterController.md +++ b/docs/matter-node.js/classes/export._internal_.MatterController.md @@ -12,82 +12,109 @@ ### Properties +- [adminVendorId](export._internal_.MatterController.md#adminvendorid) +- [bleScanner](export._internal_.MatterController.md#blescanner) - [caseClient](export._internal_.MatterController.md#caseclient) - [certificateManager](export._internal_.MatterController.md#certificatemanager) - [channelManager](export._internal_.MatterController.md#channelmanager) - [commissionDevice](export._internal_.MatterController.md#commissiondevice) -- [commissioningOptions](export._internal_.MatterController.md#commissioningoptions) +- [commissionedNodes](export._internal_.MatterController.md#commissionednodes) +- [connectOrDiscoverNode](export._internal_.MatterController.md#connectordiscovernode) - [controllerStorage](export._internal_.MatterController.md#controllerstorage) -- [discoverDeviceAddressesByIdentifier](export._internal_.MatterController.md#discoverdeviceaddressesbyidentifier) - [exchangeManager](export._internal_.MatterController.md#exchangemanager) - [fabric](export._internal_.MatterController.md#fabric) +- [getLastOperationalAddress](export._internal_.MatterController.md#getlastoperationaladdress) - [initializePaseSecureChannel](export._internal_.MatterController.md#initializepasesecurechannel) - [mdnsScanner](export._internal_.MatterController.md#mdnsscanner) - [netInterfaceBle](export._internal_.MatterController.md#netinterfaceble) - [netInterfaceIpv4](export._internal_.MatterController.md#netinterfaceipv4) - [netInterfaceIpv6](export._internal_.MatterController.md#netinterfaceipv6) -- [operationalServerAddress](export._internal_.MatterController.md#operationalserveraddress) +- [pair](export._internal_.MatterController.md#pair) - [paseClient](export._internal_.MatterController.md#paseclient) +- [reconnectLastKnownAddress](export._internal_.MatterController.md#reconnectlastknownaddress) +- [resume](export._internal_.MatterController.md#resume) - [sessionClosedCallback](export._internal_.MatterController.md#sessionclosedcallback) - [sessionManager](export._internal_.MatterController.md#sessionmanager) +- [setOperationalServerAddress](export._internal_.MatterController.md#setoperationalserveraddress) - [storage](export._internal_.MatterController.md#storage) +- [storeCommisionedNodes](export._internal_.MatterController.md#storecommisionednodes) + +### Accessors + +- [nodeId](export._internal_.MatterController.md#nodeid) ### Methods - [addTransportInterface](export._internal_.MatterController.md#addtransportinterface) - [announce](export._internal_.MatterController.md#announce) - [close](export._internal_.MatterController.md#close) +- [collectScanners](export._internal_.MatterController.md#collectscanners) - [commission](export._internal_.MatterController.md#commission) -- [commissionViaBle](export._internal_.MatterController.md#commissionviable) - [connect](export._internal_.MatterController.md#connect) - [createSecureSession](export._internal_.MatterController.md#createsecuresession) +- [disconnect](export._internal_.MatterController.md#disconnect) - [findResumptionRecordByNodeId](export._internal_.MatterController.md#findresumptionrecordbynodeid) - [getActiveSessionInformation](export._internal_.MatterController.md#getactivesessioninformation) -- [getFabric](export._internal_.MatterController.md#getfabric) +- [getCommissionedNodes](export._internal_.MatterController.md#getcommissionednodes) - [getNextAvailableSessionId](export._internal_.MatterController.md#getnextavailablesessionid) -- [getOperationalServerAddress](export._internal_.MatterController.md#getoperationalserveraddress) - [getResumptionRecord](export._internal_.MatterController.md#getresumptionrecord) - [isCommissioned](export._internal_.MatterController.md#iscommissioned) -- [iterateServerAddresses](export._internal_.MatterController.md#iterateserveraddresses) -- [pair](export._internal_.MatterController.md#pair) -- [resume](export._internal_.MatterController.md#resume) +- [removeNode](export._internal_.MatterController.md#removenode) - [saveResumptionRecord](export._internal_.MatterController.md#saveresumptionrecord) -- [setOperationalServerAddress](export._internal_.MatterController.md#setoperationalserveraddress) - [create](export._internal_.MatterController.md#create) ## Constructors ### constructor -• **new MatterController**(`mdnsScanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `certificateManager`, `fabric`, `storage`, `operationalServerAddress?`, `commissioningOptions?`, `sessionClosedCallback?`) +• **new MatterController**(`mdnsScanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `certificateManager`, `fabric`, `storage`, `adminVendorId`, `sessionClosedCallback?`) #### Parameters | Name | Type | | :------ | :------ | -| `mdnsScanner` | [`Scanner`](../interfaces/exports_common.Scanner.md) | +| `mdnsScanner` | [`MdnsScanner`](exports_mdns.MdnsScanner.md) | | `netInterfaceIpv4` | `undefined` \| [`NetInterface`](../interfaces/net_export.NetInterface.md) | | `netInterfaceIpv6` | [`NetInterface`](../interfaces/net_export.NetInterface.md) | | `certificateManager` | [`RootCertificateManager`](exports_certificate.RootCertificateManager.md) | | `fabric` | [`Fabric`](exports_fabric.Fabric.md) | | `storage` | [`StorageContext`](storage_export.StorageContext.md) | -| `operationalServerAddress?` | [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) | -| `commissioningOptions?` | [`CommissioningOptions`](../modules/exports_protocol.md#commissioningoptions) | +| `adminVendorId` | [`VendorId`](../modules/exports_datatype.md#vendorid) | | `sessionClosedCallback?` | (`peerNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid)) => `void` | #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:55 +packages/matter.js/dist/esm/MatterController.d.ts:66 ## Properties +### adminVendorId + +• `Private` `Readonly` **adminVendorId**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterController.d.ts:54 + +___ + +### bleScanner + +• `Private` **bleScanner**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterController.d.ts:64 + +___ + ### caseClient • `Private` `Readonly` **caseClient**: `any` #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:51 +packages/matter.js/dist/esm/MatterController.d.ts:61 ___ @@ -97,7 +124,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:41 +packages/matter.js/dist/esm/MatterController.d.ts:51 ___ @@ -107,7 +134,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:48 +packages/matter.js/dist/esm/MatterController.d.ts:58 ___ @@ -120,40 +147,37 @@ success. #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:81 +packages/matter.js/dist/esm/MatterController.d.ts:90 ___ -### commissioningOptions +### commissionedNodes -• `Private` `Readonly` **commissioningOptions**: `any` +• `Private` `Readonly` **commissionedNodes**: `any` #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:53 +packages/matter.js/dist/esm/MatterController.d.ts:65 ___ -### controllerStorage +### connectOrDiscoverNode -• `Private` `Readonly` **controllerStorage**: `any` +• `Private` **connectOrDiscoverNode**: `any` #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:52 +packages/matter.js/dist/esm/MatterController.d.ts:92 ___ -### discoverDeviceAddressesByIdentifier - -• `Private` **discoverDeviceAddressesByIdentifier**: `any` +### controllerStorage -Discovers devices by a provided identifier. It returns after the timeout or if at least one device was found. -The method returns a list of addresses of the discovered devices. +• `Private` `Readonly` **controllerStorage**: `any` #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:61 +packages/matter.js/dist/esm/MatterController.d.ts:62 ___ @@ -163,7 +187,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:49 +packages/matter.js/dist/esm/MatterController.d.ts:59 ___ @@ -173,7 +197,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:42 +packages/matter.js/dist/esm/MatterController.d.ts:52 + +___ + +### getLastOperationalAddress + +• `Private` **getLastOperationalAddress**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterController.d.ts:105 ___ @@ -187,7 +221,7 @@ is wrong. #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:76 +packages/matter.js/dist/esm/MatterController.d.ts:85 ___ @@ -197,7 +231,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:38 +packages/matter.js/dist/esm/MatterController.d.ts:48 ___ @@ -207,7 +241,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:54 +packages/matter.js/dist/esm/MatterController.d.ts:63 ___ @@ -217,7 +251,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:39 +packages/matter.js/dist/esm/MatterController.d.ts:49 ___ @@ -227,17 +261,19 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:40 +packages/matter.js/dist/esm/MatterController.d.ts:50 ___ -### operationalServerAddress +### pair + +• `Private` **pair**: `any` -• `Optional` **operationalServerAddress**: [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) +Pair with an operational device (already commissioned) and establish a CASE session. #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:44 +packages/matter.js/dist/esm/MatterController.d.ts:101 ___ @@ -247,7 +283,32 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:50 +packages/matter.js/dist/esm/MatterController.d.ts:60 + +___ + +### reconnectLastKnownAddress + +• `Private` **reconnectLastKnownAddress**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterController.d.ts:91 + +___ + +### resume + +• `Private` **resume**: `any` + +Resume a device connection and establish a CASE session that was previously paired with the controller. This +method will try to connect to the device using the previously used server address (if set). If that fails, the +device is discovered again using its operational instance details. +It returns the operational MessageChannel on success. + +#### Defined in + +packages/matter.js/dist/esm/MatterController.d.ts:99 ___ @@ -257,7 +318,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:45 +packages/matter.js/dist/esm/MatterController.d.ts:55 ___ @@ -267,7 +328,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:47 +packages/matter.js/dist/esm/MatterController.d.ts:57 + +___ + +### setOperationalServerAddress + +• `Private` **setOperationalServerAddress**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterController.d.ts:104 ___ @@ -277,7 +348,31 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:43 +packages/matter.js/dist/esm/MatterController.d.ts:53 + +___ + +### storeCommisionedNodes + +• `Private` **storeCommisionedNodes**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterController.d.ts:106 + +## Accessors + +### nodeId + +• `get` **nodeId**(): [`NodeId`](../modules/exports_datatype.md#nodeid) + +#### Returns + +[`NodeId`](../modules/exports_datatype.md#nodeid) + +#### Defined in + +packages/matter.js/dist/esm/MatterController.d.ts:67 ## Methods @@ -297,7 +392,7 @@ packages/matter.js/dist/esm/MatterController.d.ts:43 #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:56 +packages/matter.js/dist/esm/MatterController.d.ts:68 ___ @@ -311,7 +406,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:115 +packages/matter.js/dist/esm/MatterController.d.ts:117 ___ @@ -325,50 +420,45 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:116 +packages/matter.js/dist/esm/MatterController.d.ts:118 ___ -### commission - -▸ **commission**(`identifierData`, `passCode`, `timeoutSeconds?`, `knownAddress?`): `Promise`<[`NodeId`](../modules/exports_datatype.md#nodeid)\> +### collectScanners -Commission a device by its identifier and the Passcode. If a known address is provided this is tried first -before discovering devices in the network. If multiple addresses or devices are found, they are tried all after -each other. It returns the NodeId of the commissioned device. -If it throws an PairRetransmissionLimitReachedError that means that no found device responded to the pairing -request or the passode did not match to any discovered device/address. +▸ **collectScanners**(`discoveryCapabilities?`): [`Scanner`](../interfaces/exports_common.Scanner.md)[] #### Parameters | Name | Type | | :------ | :------ | -| `identifierData` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | -| `passCode` | `number` | -| `timeoutSeconds?` | `number` | -| `knownAddress?` | [`ServerAddress`](../modules/exports_common.md#serveraddress) | +| `discoveryCapabilities?` | [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<{ `ble`: [`BitFlag`](../modules/exports_schema.md#bitflag-1) ; `onIpNetwork`: [`BitFlag`](../modules/exports_schema.md#bitflag-1) ; `softAccessPoint`: [`BitFlag`](../modules/exports_schema.md#bitflag-1) }\> | #### Returns -`Promise`<[`NodeId`](../modules/exports_datatype.md#nodeid)\> +[`Scanner`](../interfaces/exports_common.Scanner.md)[] #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:70 +packages/matter.js/dist/esm/MatterController.d.ts:69 ___ -### commissionViaBle +### commission -▸ **commissionViaBle**(`identifierData`, `passCode`, `timeoutSeconds?`): `Promise`<[`NodeId`](../modules/exports_datatype.md#nodeid)\> +▸ **commission**(`options`): `Promise`<[`NodeId`](../modules/exports_datatype.md#nodeid)\> + +Commission a device by its identifier and the Passcode. If a known address is provided this is tried first +before discovering devices in the network. If multiple addresses or devices are found, they are tried all after +each other. It returns the NodeId of the commissioned device. +If it throws an PairRetransmissionLimitReachedError that means that no found device responded to the pairing +request or the passode did not match to any discovered device/address. #### Parameters | Name | Type | | :------ | :------ | -| `identifierData` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | -| `passCode` | `number` | -| `timeoutSeconds?` | `number` | +| `options` | [`NodeCommissioningOptions`](../modules/export.md#nodecommissioningoptions) | #### Returns @@ -376,13 +466,13 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:62 +packages/matter.js/dist/esm/MatterController.d.ts:77 ___ ### connect -▸ **connect**(`nodeId`, `timeoutSeconds?`): `Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> +▸ **connect**(`peerNodeId`, `timeoutSeconds?`): `Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> Connect to the device by opening a channel and creating a new CASE session if necessary. Returns a InteractionClient on success. @@ -391,7 +481,7 @@ Returns a InteractionClient on success. | Name | Type | | :------ | :------ | -| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | | `timeoutSeconds?` | `number` | #### Returns @@ -400,13 +490,13 @@ Returns a InteractionClient on success. #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:108 +packages/matter.js/dist/esm/MatterController.d.ts:111 ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](exports_session.SecureSession.md)<[`MatterController`](export._internal_.MatterController.md)\>\> +▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`): `Promise`<[`SecureSession`](exports_session.SecureSession.md)<[`MatterController`](export._internal_.MatterController.md)\>\> #### Parameters @@ -420,8 +510,8 @@ ___ | `salt` | `Uint8Array` | | `isInitiator` | `boolean` | | `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `idleRetransmissionTimeoutMs?` | `number` | +| `activeRetransmissionTimeoutMs?` | `number` | #### Returns @@ -429,13 +519,13 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:111 +packages/matter.js/dist/esm/MatterController.d.ts:113 ___ -### findResumptionRecordByNodeId +### disconnect -▸ **findResumptionRecordByNodeId**(`nodeId`): `undefined` \| [`ResumptionRecord`](../interfaces/exports_session.ResumptionRecord.md) +▸ **disconnect**(`nodeId`): `Promise`<`void`\> #### Parameters @@ -445,67 +535,73 @@ ___ #### Returns -`undefined` \| [`ResumptionRecord`](../interfaces/exports_session.ResumptionRecord.md) +`Promise`<`void`\> #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:113 +packages/matter.js/dist/esm/MatterController.d.ts:78 ___ -### getActiveSessionInformation +### findResumptionRecordByNodeId + +▸ **findResumptionRecordByNodeId**(`nodeId`): `undefined` \| [`ResumptionRecord`](../interfaces/exports_session.ResumptionRecord.md) -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +`undefined` \| [`ResumptionRecord`](../interfaces/exports_session.ResumptionRecord.md) #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:117 +packages/matter.js/dist/esm/MatterController.d.ts:115 ___ -### getFabric +### getActiveSessionInformation -▸ **getFabric**(): [`Fabric`](exports_fabric.Fabric.md) +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] #### Returns -[`Fabric`](exports_fabric.Fabric.md) +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:110 +packages/matter.js/dist/esm/MatterController.d.ts:119 ___ -### getNextAvailableSessionId +### getCommissionedNodes -▸ **getNextAvailableSessionId**(): `number` +▸ **getCommissionedNodes**(): [`NodeId`](../modules/exports_datatype.md#nodeid)[] #### Returns -`number` +[`NodeId`](../modules/exports_datatype.md#nodeid)[] #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:109 +packages/matter.js/dist/esm/MatterController.d.ts:103 ___ -### getOperationalServerAddress +### getNextAvailableSessionId -▸ **getOperationalServerAddress**(): `undefined` \| [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) +▸ **getNextAvailableSessionId**(): `number` #### Returns -`undefined` \| [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) +`number` #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:103 +packages/matter.js/dist/esm/MatterController.d.ts:112 ___ @@ -525,107 +621,41 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:112 +packages/matter.js/dist/esm/MatterController.d.ts:114 ___ ### isCommissioned -▸ **isCommissioned**(): ``false`` - -#### Returns - -``false`` - -#### Defined in - -packages/matter.js/dist/esm/MatterController.d.ts:101 - -___ - -### iterateServerAddresses - -▸ **iterateServerAddresses**<`SA`, `T`, `E`\>(`servers`, `errorType`, `updateNetworkInterfaceFunc`, `func`, `lastKnownServer?`): `Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> - -Helper method to iterate through a list of server addresses and try to execute a method on each of them. If the -method throws a configurable error (or EHOSTUNREACH), the server address list is updated (to also add later -discovered addresses or devices) and then next server address is tried.The result of the first successful method -call is returned. The logic makes sure to only try each unique address (IP/port) once. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `SA` | extends [`ServerAddress`](../modules/exports_common.md#serveraddress) | -| `T` | `T` | -| `E` | extends `Error` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `servers` | `SA`[] | -| `errorType` | [`ClassExtends`](../modules/util_export.md#classextends)<`E`\> | -| `updateNetworkInterfaceFunc` | () => `Promise`<`SA`[]\> | -| `func` | (`server`: `SA`) => `Promise`<`T`\> | -| `lastKnownServer?` | `SA` | +▸ **isCommissioned**(): `boolean` #### Returns -`Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> +`boolean` #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:88 +packages/matter.js/dist/esm/MatterController.d.ts:102 ___ -### pair +### removeNode -▸ **pair**(`peerNodeId`, `operationalServerAddress`): `Promise`<[`MessageChannel`](exports_protocol.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> - -Pair with an operational device (already commissioned) and establish a CASE session. +▸ **removeNode**(`nodeId`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | -| `operationalServerAddress` | [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) | - -#### Returns - -`Promise`<[`MessageChannel`](exports_protocol.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> - -#### Defined in - -packages/matter.js/dist/esm/MatterController.d.ts:100 - -___ - -### resume - -▸ **resume**(`peerNodeId`, `timeoutSeconds?`): `Promise`<[`MessageChannel`](exports_protocol.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> - -Resume a device connection and establish a CASE session that was previously paired with the controller. This -method will try to connect to the device using the previously used server address (if set). If that fails, the -device is discovered again using its operational instance details. -It returns the operational MessageChannel on success. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | -| `timeoutSeconds?` | `number` | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | #### Returns -`Promise`<[`MessageChannel`](exports_protocol.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> +`Promise`<`void`\> #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:98 +packages/matter.js/dist/esm/MatterController.d.ts:79 ___ @@ -645,45 +675,26 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:114 - -___ - -### setOperationalServerAddress - -▸ **setOperationalServerAddress**(`address`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) | - -#### Returns - -`void` - -#### Defined in - -packages/matter.js/dist/esm/MatterController.d.ts:102 +packages/matter.js/dist/esm/MatterController.d.ts:116 ___ ### create -▸ `Static` **create**(`scanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `storage`, `operationalServerAddress?`, `commissioningOptions?`, `sessionClosedCallback?`): `Promise`<[`MatterController`](export._internal_.MatterController.md)\> +▸ `Static` **create**(`scanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `storage`, `sessionClosedCallback?`, `adminVendorId?`, `adminFabricId?`, `adminFabricIndex?`): `Promise`<[`MatterController`](export._internal_.MatterController.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `scanner` | [`Scanner`](../interfaces/exports_common.Scanner.md) | +| `scanner` | [`MdnsScanner`](exports_mdns.MdnsScanner.md) | | `netInterfaceIpv4` | `undefined` \| [`NetInterface`](../interfaces/net_export.NetInterface.md) | | `netInterfaceIpv6` | [`NetInterface`](../interfaces/net_export.NetInterface.md) | | `storage` | [`StorageContext`](storage_export.StorageContext.md) | -| `operationalServerAddress?` | [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) | -| `commissioningOptions?` | [`CommissioningOptions`](../modules/exports_protocol.md#commissioningoptions) | | `sessionClosedCallback?` | (`peerNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid)) => `void` | +| `adminVendorId?` | [`VendorId`](../modules/exports_datatype.md#vendorid) | +| `adminFabricId?` | [`FabricId`](../modules/exports_datatype.md#fabricid) | +| `adminFabricIndex?` | [`FabricIndex`](../modules/exports_datatype.md#fabricindex) | #### Returns @@ -691,4 +702,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterController.d.ts:46 +packages/matter.js/dist/esm/MatterController.d.ts:56 diff --git a/docs/matter-node.js/classes/export._internal_.MatterDevice.md b/docs/matter-node.js/classes/export._internal_.MatterDevice.md index fd2832784c..a45fa7ffb0 100644 --- a/docs/matter-node.js/classes/export._internal_.MatterDevice.md +++ b/docs/matter-node.js/classes/export._internal_.MatterDevice.md @@ -19,7 +19,7 @@ - [announcementStartedTime](export._internal_.MatterDevice.md#announcementstartedtime) - [broadcasters](export._internal_.MatterDevice.md#broadcasters) - [channelManager](export._internal_.MatterDevice.md#channelmanager) -- [closeSession](export._internal_.MatterDevice.md#closesession) +- [commissioningChangedCallback](export._internal_.MatterDevice.md#commissioningchangedcallback) - [deviceName](export._internal_.MatterDevice.md#devicename) - [deviceType](export._internal_.MatterDevice.md#devicetype) - [discriminator](export._internal_.MatterDevice.md#discriminator) @@ -27,12 +27,12 @@ - [fabricManager](export._internal_.MatterDevice.md#fabricmanager) - [failSafeContext](export._internal_.MatterDevice.md#failsafecontext) - [failSafeExpired](export._internal_.MatterDevice.md#failsafeexpired) -- [initialCommissioningCallback](export._internal_.MatterDevice.md#initialcommissioningcallback) - [initialPasscode](export._internal_.MatterDevice.md#initialpasscode) - [isClosing](export._internal_.MatterDevice.md#isclosing) - [productId](export._internal_.MatterDevice.md#productid) - [scanners](export._internal_.MatterDevice.md#scanners) - [secureChannelProtocol](export._internal_.MatterDevice.md#securechannelprotocol) +- [sessionChangedCallback](export._internal_.MatterDevice.md#sessionchangedcallback) - [sessionManager](export._internal_.MatterDevice.md#sessionmanager) - [storage](export._internal_.MatterDevice.md#storage) - [transportInterfaces](export._internal_.MatterDevice.md#transportinterfaces) @@ -63,10 +63,11 @@ - [getFailSafeContext](export._internal_.MatterDevice.md#getfailsafecontext) - [getNextAvailableSessionId](export._internal_.MatterDevice.md#getnextavailablesessionid) - [getNextFabricIndex](export._internal_.MatterDevice.md#getnextfabricindex) +- [hasBroadcaster](export._internal_.MatterDevice.md#hasbroadcaster) +- [hasProtocolHandler](export._internal_.MatterDevice.md#hasprotocolhandler) - [initiateExchange](export._internal_.MatterDevice.md#initiateexchange) - [isCommissioned](export._internal_.MatterDevice.md#iscommissioned) - [isFailsafeArmed](export._internal_.MatterDevice.md#isfailsafearmed) -- [processSessionsToClose](export._internal_.MatterDevice.md#processsessionstoclose) - [removePaseSession](export._internal_.MatterDevice.md#removepasesession) - [saveResumptionRecord](export._internal_.MatterDevice.md#saveresumptionrecord) - [sendCommissionableAnnouncement](export._internal_.MatterDevice.md#sendcommissionableannouncement) @@ -80,7 +81,7 @@ ### constructor -• **new MatterDevice**(`deviceName`, `deviceType`, `vendorId`, `productId`, `discriminator`, `initialPasscode`, `storage`, `initialCommissioningCallback`) +• **new MatterDevice**(`deviceName`, `deviceType`, `vendorId`, `productId`, `discriminator`, `initialPasscode`, `storage`, `commissioningChangedCallback`, `sessionChangedCallback`) #### Parameters @@ -93,11 +94,12 @@ | `discriminator` | `number` | | `initialPasscode` | `number` | | `storage` | [`StorageContext`](storage_export.StorageContext.md) | -| `initialCommissioningCallback` | () => `void` | +| `commissioningChangedCallback` | (`fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex)) => `void` | +| `sessionChangedCallback` | (`fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex)) => `void` | #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:53 +packages/matter.js/dist/esm/MatterDevice.d.ts:54 ## Properties @@ -107,7 +109,7 @@ packages/matter.js/dist/esm/MatterDevice.d.ts:53 #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:48 +packages/matter.js/dist/esm/MatterDevice.d.ts:49 ___ @@ -117,7 +119,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:47 +packages/matter.js/dist/esm/MatterDevice.d.ts:48 ___ @@ -127,7 +129,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:61 +packages/matter.js/dist/esm/MatterDevice.d.ts:64 ___ @@ -137,7 +139,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:49 +packages/matter.js/dist/esm/MatterDevice.d.ts:50 ___ @@ -147,7 +149,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:50 +packages/matter.js/dist/esm/MatterDevice.d.ts:51 ___ @@ -157,7 +159,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:40 +packages/matter.js/dist/esm/MatterDevice.d.ts:41 ___ @@ -167,17 +169,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:44 +packages/matter.js/dist/esm/MatterDevice.d.ts:45 ___ -### closeSession +### commissioningChangedCallback -• `Private` **closeSession**: `any` +• `Private` `Readonly` **commissioningChangedCallback**: `any` #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:76 +packages/matter.js/dist/esm/MatterDevice.d.ts:38 ___ @@ -217,7 +219,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:45 +packages/matter.js/dist/esm/MatterDevice.d.ts:46 ___ @@ -227,7 +229,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:42 +packages/matter.js/dist/esm/MatterDevice.d.ts:43 ___ @@ -237,7 +239,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:52 +packages/matter.js/dist/esm/MatterDevice.d.ts:53 ___ @@ -247,17 +249,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:78 - -___ - -### initialCommissioningCallback - -• `Private` `Readonly` **initialCommissioningCallback**: `any` - -#### Defined in - -packages/matter.js/dist/esm/MatterDevice.d.ts:38 +packages/matter.js/dist/esm/MatterDevice.d.ts:79 ___ @@ -277,7 +269,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:51 +packages/matter.js/dist/esm/MatterDevice.d.ts:52 ___ @@ -297,7 +289,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:39 +packages/matter.js/dist/esm/MatterDevice.d.ts:40 ___ @@ -307,7 +299,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:46 +packages/matter.js/dist/esm/MatterDevice.d.ts:47 + +___ + +### sessionChangedCallback + +• `Private` `Readonly` **sessionChangedCallback**: `any` + +#### Defined in + +packages/matter.js/dist/esm/MatterDevice.d.ts:39 ___ @@ -317,7 +319,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:43 +packages/matter.js/dist/esm/MatterDevice.d.ts:44 ___ @@ -337,7 +339,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:41 +packages/matter.js/dist/esm/MatterDevice.d.ts:42 ___ @@ -367,7 +369,7 @@ packages/matter.js/dist/esm/MatterDevice.d.ts:33 #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:55 +packages/matter.js/dist/esm/MatterDevice.d.ts:57 ___ @@ -387,7 +389,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:68 +packages/matter.js/dist/esm/MatterDevice.d.ts:71 ___ @@ -407,7 +409,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:57 +packages/matter.js/dist/esm/MatterDevice.d.ts:60 ___ @@ -427,7 +429,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:54 +packages/matter.js/dist/esm/MatterDevice.d.ts:55 ___ @@ -447,7 +449,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:56 +packages/matter.js/dist/esm/MatterDevice.d.ts:58 ___ @@ -467,7 +469,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:86 +packages/matter.js/dist/esm/MatterDevice.d.ts:87 ___ @@ -489,7 +491,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:85 +packages/matter.js/dist/esm/MatterDevice.d.ts:86 ___ @@ -509,7 +511,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:60 +packages/matter.js/dist/esm/MatterDevice.d.ts:63 ___ @@ -532,7 +534,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:79 +packages/matter.js/dist/esm/MatterDevice.d.ts:80 ___ @@ -552,7 +554,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:77 +packages/matter.js/dist/esm/MatterDevice.d.ts:78 ___ @@ -566,13 +568,13 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:83 +packages/matter.js/dist/esm/MatterDevice.d.ts:84 ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](exports_session.SecureSession.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\>\> +▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`): `Promise`<[`SecureSession`](exports_session.SecureSession.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\>\> #### Parameters @@ -586,8 +588,8 @@ ___ | `salt` | `Uint8Array` | | `isInitiator` | `boolean` | | `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `idleRetransmissionTimeoutMs?` | `number` | +| `activeRetransmissionTimeoutMs?` | `number` | #### Returns @@ -595,7 +597,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:64 +packages/matter.js/dist/esm/MatterDevice.d.ts:67 ___ @@ -609,7 +611,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:87 +packages/matter.js/dist/esm/MatterDevice.d.ts:88 ___ @@ -623,7 +625,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:88 +packages/matter.js/dist/esm/MatterDevice.d.ts:89 ___ @@ -645,7 +647,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:89 +packages/matter.js/dist/esm/MatterDevice.d.ts:90 ___ @@ -666,7 +668,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:65 +packages/matter.js/dist/esm/MatterDevice.d.ts:68 ___ @@ -686,21 +688,21 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:72 +packages/matter.js/dist/esm/MatterDevice.d.ts:75 ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:94 +packages/matter.js/dist/esm/MatterDevice.d.ts:95 ___ @@ -720,7 +722,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:70 +packages/matter.js/dist/esm/MatterDevice.d.ts:73 ___ @@ -734,7 +736,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:82 +packages/matter.js/dist/esm/MatterDevice.d.ts:83 ___ @@ -748,7 +750,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:81 +packages/matter.js/dist/esm/MatterDevice.d.ts:82 ___ @@ -762,7 +764,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:63 +packages/matter.js/dist/esm/MatterDevice.d.ts:66 ___ @@ -776,35 +778,39 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:67 +packages/matter.js/dist/esm/MatterDevice.d.ts:70 ___ -### initiateExchange +### hasBroadcaster -▸ **initiateExchange**(`fabric`, `nodeId`, `protocolId`): [`MessageExchange`](exports_protocol.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> +▸ **hasBroadcaster**(`broadcaster`): `boolean` #### Parameters | Name | Type | | :------ | :------ | -| `fabric` | [`Fabric`](exports_fabric.Fabric.md) | -| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | -| `protocolId` | `number` | +| `broadcaster` | [`InstanceBroadcaster`](../interfaces/exports_common.InstanceBroadcaster.md) | #### Returns -[`MessageExchange`](exports_protocol.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> +`boolean` #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:71 +packages/matter.js/dist/esm/MatterDevice.d.ts:56 ___ -### isCommissioned +### hasProtocolHandler -▸ **isCommissioned**(): `boolean` +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | #### Returns @@ -812,13 +818,35 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:84 +packages/matter.js/dist/esm/MatterDevice.d.ts:59 ___ -### isFailsafeArmed +### initiateExchange -▸ **isFailsafeArmed**(): `boolean` +▸ **initiateExchange**(`fabric`, `nodeId`, `protocolId`): [`MessageExchange`](exports_protocol.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](exports_fabric.Fabric.md) | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `protocolId` | `number` | + +#### Returns + +[`MessageExchange`](exports_protocol.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> + +#### Defined in + +packages/matter.js/dist/esm/MatterDevice.d.ts:74 + +___ + +### isCommissioned + +▸ **isCommissioned**(): `boolean` #### Returns @@ -826,21 +854,21 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:80 +packages/matter.js/dist/esm/MatterDevice.d.ts:85 ___ -### processSessionsToClose +### isFailsafeArmed -▸ **processSessionsToClose**(): `Promise`<`void`\> +▸ **isFailsafeArmed**(): `boolean` #### Returns -`Promise`<`void`\> +`boolean` #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:75 +packages/matter.js/dist/esm/MatterDevice.d.ts:81 ___ @@ -854,7 +882,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:74 +packages/matter.js/dist/esm/MatterDevice.d.ts:77 ___ @@ -874,7 +902,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:73 +packages/matter.js/dist/esm/MatterDevice.d.ts:76 ___ @@ -895,7 +923,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:62 +packages/matter.js/dist/esm/MatterDevice.d.ts:65 ___ @@ -916,7 +944,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:69 +packages/matter.js/dist/esm/MatterDevice.d.ts:72 ___ @@ -930,7 +958,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:58 +packages/matter.js/dist/esm/MatterDevice.d.ts:61 ___ @@ -944,7 +972,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:59 +packages/matter.js/dist/esm/MatterDevice.d.ts:62 ___ @@ -958,7 +986,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:93 +packages/matter.js/dist/esm/MatterDevice.d.ts:94 ___ @@ -978,4 +1006,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/MatterDevice.d.ts:66 +packages/matter.js/dist/esm/MatterDevice.d.ts:69 diff --git a/docs/matter-node.js/classes/export._internal_.QrPairingCodeSchema.md b/docs/matter-node.js/classes/export._internal_.QrPairingCodeSchema.md index 7784cf8e31..4198bd523a 100644 --- a/docs/matter-node.js/classes/export._internal_.QrPairingCodeSchema.md +++ b/docs/matter-node.js/classes/export._internal_.QrPairingCodeSchema.md @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:47 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:48 ___ @@ -135,7 +135,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:46 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:47 ___ diff --git a/docs/matter-node.js/classes/exports_cluster.AttributeClient.md b/docs/matter-node.js/classes/exports_cluster.AttributeClient.md index 2794fe9c0c..3037abd983 100644 --- a/docs/matter-node.js/classes/exports_cluster.AttributeClient.md +++ b/docs/matter-node.js/classes/exports_cluster.AttributeClient.md @@ -16,7 +16,7 @@ General class for AttributeClients - **`AttributeClient`** - ↳ [`PresentAttributeClient`](exports_cluster.PresentAttributeClient.md) + ↳ [`SupportedAttributeClient`](exports_cluster.SupportedAttributeClient.md) ## Table of contents diff --git a/docs/matter-node.js/classes/exports_cluster.EventClient.md b/docs/matter-node.js/classes/exports_cluster.EventClient.md index 8f67b76093..be6fe7b96f 100644 --- a/docs/matter-node.js/classes/exports_cluster.EventClient.md +++ b/docs/matter-node.js/classes/exports_cluster.EventClient.md @@ -16,9 +16,9 @@ General class for EventClients - **`EventClient`** - ↳ [`PresentEventClient`](exports_cluster.PresentEventClient.md) + ↳ [`SupportedEventClient`](exports_cluster.SupportedEventClient.md) - ↳ [`UnknownPresentEventClient`](exports_cluster.UnknownPresentEventClient.md) + ↳ [`UnknownSupportedEventClient`](exports_cluster.UnknownSupportedEventClient.md) ## Table of contents diff --git a/docs/matter-node.js/classes/exports_cluster.PresentAttributeClient.md b/docs/matter-node.js/classes/exports_cluster.SupportedAttributeClient.md similarity index 82% rename from docs/matter-node.js/classes/exports_cluster.PresentAttributeClient.md rename to docs/matter-node.js/classes/exports_cluster.SupportedAttributeClient.md index 607d2f7994..e47a1985da 100644 --- a/docs/matter-node.js/classes/exports_cluster.PresentAttributeClient.md +++ b/docs/matter-node.js/classes/exports_cluster.SupportedAttributeClient.md @@ -1,10 +1,10 @@ -[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/cluster](../modules/exports_cluster.md) / PresentAttributeClient +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/cluster](../modules/exports_cluster.md) / SupportedAttributeClient -# Class: PresentAttributeClient +# Class: SupportedAttributeClient -[exports/cluster](../modules/exports_cluster.md).PresentAttributeClient +[exports/cluster](../modules/exports_cluster.md).SupportedAttributeClient -Special AttributeClient class to allow identifying attributes that are present because reported by the Devices. +Special AttributeClient class to allow identifying attributes that are supported because reported by the Devices. ## Type parameters @@ -16,40 +16,40 @@ Special AttributeClient class to allow identifying attributes that are present b - [`AttributeClient`](exports_cluster.AttributeClient.md)<`T`\> - ↳ **`PresentAttributeClient`** + ↳ **`SupportedAttributeClient`** - ↳↳ [`UnknownPresentAttributeClient`](exports_cluster.UnknownPresentAttributeClient.md) + ↳↳ [`UnknownSupportedAttributeClient`](exports_cluster.UnknownSupportedAttributeClient.md) ## Table of contents ### Constructors -- [constructor](exports_cluster.PresentAttributeClient.md#constructor) +- [constructor](exports_cluster.SupportedAttributeClient.md#constructor) ### Properties -- [attribute](exports_cluster.PresentAttributeClient.md#attribute) -- [clusterId](exports_cluster.PresentAttributeClient.md#clusterid) -- [endpointId](exports_cluster.PresentAttributeClient.md#endpointid) -- [id](exports_cluster.PresentAttributeClient.md#id) -- [name](exports_cluster.PresentAttributeClient.md#name) -- [schema](exports_cluster.PresentAttributeClient.md#schema) +- [attribute](exports_cluster.SupportedAttributeClient.md#attribute) +- [clusterId](exports_cluster.SupportedAttributeClient.md#clusterid) +- [endpointId](exports_cluster.SupportedAttributeClient.md#endpointid) +- [id](exports_cluster.SupportedAttributeClient.md#id) +- [name](exports_cluster.SupportedAttributeClient.md#name) +- [schema](exports_cluster.SupportedAttributeClient.md#schema) ### Methods -- [addListener](exports_cluster.PresentAttributeClient.md#addlistener) -- [get](exports_cluster.PresentAttributeClient.md#get) -- [getWithVersion](exports_cluster.PresentAttributeClient.md#getwithversion) -- [removeListener](exports_cluster.PresentAttributeClient.md#removelistener) -- [set](exports_cluster.PresentAttributeClient.md#set) -- [subscribe](exports_cluster.PresentAttributeClient.md#subscribe) -- [update](exports_cluster.PresentAttributeClient.md#update) +- [addListener](exports_cluster.SupportedAttributeClient.md#addlistener) +- [get](exports_cluster.SupportedAttributeClient.md#get) +- [getWithVersion](exports_cluster.SupportedAttributeClient.md#getwithversion) +- [removeListener](exports_cluster.SupportedAttributeClient.md#removelistener) +- [set](exports_cluster.SupportedAttributeClient.md#set) +- [subscribe](exports_cluster.SupportedAttributeClient.md#subscribe) +- [update](exports_cluster.SupportedAttributeClient.md#update) ## Constructors ### constructor -• **new PresentAttributeClient**<`T`\>(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`) +• **new SupportedAttributeClient**<`T`\>(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`) #### Type parameters diff --git a/docs/matter-node.js/classes/exports_cluster.PresentEventClient.md b/docs/matter-node.js/classes/exports_cluster.SupportedEventClient.md similarity index 82% rename from docs/matter-node.js/classes/exports_cluster.PresentEventClient.md rename to docs/matter-node.js/classes/exports_cluster.SupportedEventClient.md index e2b311379a..cd3453e4bf 100644 --- a/docs/matter-node.js/classes/exports_cluster.PresentEventClient.md +++ b/docs/matter-node.js/classes/exports_cluster.SupportedEventClient.md @@ -1,10 +1,10 @@ -[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/cluster](../modules/exports_cluster.md) / PresentEventClient +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/cluster](../modules/exports_cluster.md) / SupportedEventClient -# Class: PresentEventClient +# Class: SupportedEventClient -[exports/cluster](../modules/exports_cluster.md).PresentEventClient +[exports/cluster](../modules/exports_cluster.md).SupportedEventClient -Special EventClient class to allow identifying events that are present because reported by the Devices. +Special EventClient class to allow identifying events that are supported because reported by the Devices. ## Type parameters @@ -16,35 +16,35 @@ Special EventClient class to allow identifying events that are present because r - [`EventClient`](exports_cluster.EventClient.md)<`T`\> - ↳ **`PresentEventClient`** + ↳ **`SupportedEventClient`** ## Table of contents ### Constructors -- [constructor](exports_cluster.PresentEventClient.md#constructor) +- [constructor](exports_cluster.SupportedEventClient.md#constructor) ### Properties -- [clusterId](exports_cluster.PresentEventClient.md#clusterid) -- [endpointId](exports_cluster.PresentEventClient.md#endpointid) -- [event](exports_cluster.PresentEventClient.md#event) -- [id](exports_cluster.PresentEventClient.md#id) -- [name](exports_cluster.PresentEventClient.md#name) +- [clusterId](exports_cluster.SupportedEventClient.md#clusterid) +- [endpointId](exports_cluster.SupportedEventClient.md#endpointid) +- [event](exports_cluster.SupportedEventClient.md#event) +- [id](exports_cluster.SupportedEventClient.md#id) +- [name](exports_cluster.SupportedEventClient.md#name) ### Methods -- [addListener](exports_cluster.PresentEventClient.md#addlistener) -- [get](exports_cluster.PresentEventClient.md#get) -- [removeListener](exports_cluster.PresentEventClient.md#removelistener) -- [subscribe](exports_cluster.PresentEventClient.md#subscribe) -- [update](exports_cluster.PresentEventClient.md#update) +- [addListener](exports_cluster.SupportedEventClient.md#addlistener) +- [get](exports_cluster.SupportedEventClient.md#get) +- [removeListener](exports_cluster.SupportedEventClient.md#removelistener) +- [subscribe](exports_cluster.SupportedEventClient.md#subscribe) +- [update](exports_cluster.SupportedEventClient.md#update) ## Constructors ### constructor -• **new PresentEventClient**<`T`\>(`event`, `name`, `endpointId`, `clusterId`, `interactionClient`) +• **new SupportedEventClient**<`T`\>(`event`, `name`, `endpointId`, `clusterId`, `interactionClient`) #### Type parameters diff --git a/docs/matter-node.js/classes/exports_cluster.UnknownPresentAttributeClient.md b/docs/matter-node.js/classes/exports_cluster.UnknownSupportedAttributeClient.md similarity index 60% rename from docs/matter-node.js/classes/exports_cluster.UnknownPresentAttributeClient.md rename to docs/matter-node.js/classes/exports_cluster.UnknownSupportedAttributeClient.md index a4a25e609c..39e2423c63 100644 --- a/docs/matter-node.js/classes/exports_cluster.UnknownPresentAttributeClient.md +++ b/docs/matter-node.js/classes/exports_cluster.UnknownSupportedAttributeClient.md @@ -1,48 +1,48 @@ -[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/cluster](../modules/exports_cluster.md) / UnknownPresentAttributeClient +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/cluster](../modules/exports_cluster.md) / UnknownSupportedAttributeClient -# Class: UnknownPresentAttributeClient +# Class: UnknownSupportedAttributeClient -[exports/cluster](../modules/exports_cluster.md).UnknownPresentAttributeClient +[exports/cluster](../modules/exports_cluster.md).UnknownSupportedAttributeClient -Special AttributeClient class to allow identifying attributes that are present because reported by the Devices, +Special AttributeClient class to allow identifying attributes that are supported because reported by the Devices, but the contained attribute is unknown. ## Hierarchy -- [`PresentAttributeClient`](exports_cluster.PresentAttributeClient.md)<`any`\> +- [`SupportedAttributeClient`](exports_cluster.SupportedAttributeClient.md)<`any`\> - ↳ **`UnknownPresentAttributeClient`** + ↳ **`UnknownSupportedAttributeClient`** ## Table of contents ### Constructors -- [constructor](exports_cluster.UnknownPresentAttributeClient.md#constructor) +- [constructor](exports_cluster.UnknownSupportedAttributeClient.md#constructor) ### Properties -- [attribute](exports_cluster.UnknownPresentAttributeClient.md#attribute) -- [clusterId](exports_cluster.UnknownPresentAttributeClient.md#clusterid) -- [endpointId](exports_cluster.UnknownPresentAttributeClient.md#endpointid) -- [id](exports_cluster.UnknownPresentAttributeClient.md#id) -- [name](exports_cluster.UnknownPresentAttributeClient.md#name) -- [schema](exports_cluster.UnknownPresentAttributeClient.md#schema) +- [attribute](exports_cluster.UnknownSupportedAttributeClient.md#attribute) +- [clusterId](exports_cluster.UnknownSupportedAttributeClient.md#clusterid) +- [endpointId](exports_cluster.UnknownSupportedAttributeClient.md#endpointid) +- [id](exports_cluster.UnknownSupportedAttributeClient.md#id) +- [name](exports_cluster.UnknownSupportedAttributeClient.md#name) +- [schema](exports_cluster.UnknownSupportedAttributeClient.md#schema) ### Methods -- [addListener](exports_cluster.UnknownPresentAttributeClient.md#addlistener) -- [get](exports_cluster.UnknownPresentAttributeClient.md#get) -- [getWithVersion](exports_cluster.UnknownPresentAttributeClient.md#getwithversion) -- [removeListener](exports_cluster.UnknownPresentAttributeClient.md#removelistener) -- [set](exports_cluster.UnknownPresentAttributeClient.md#set) -- [subscribe](exports_cluster.UnknownPresentAttributeClient.md#subscribe) -- [update](exports_cluster.UnknownPresentAttributeClient.md#update) +- [addListener](exports_cluster.UnknownSupportedAttributeClient.md#addlistener) +- [get](exports_cluster.UnknownSupportedAttributeClient.md#get) +- [getWithVersion](exports_cluster.UnknownSupportedAttributeClient.md#getwithversion) +- [removeListener](exports_cluster.UnknownSupportedAttributeClient.md#removelistener) +- [set](exports_cluster.UnknownSupportedAttributeClient.md#set) +- [subscribe](exports_cluster.UnknownSupportedAttributeClient.md#subscribe) +- [update](exports_cluster.UnknownSupportedAttributeClient.md#update) ## Constructors ### constructor -• **new UnknownPresentAttributeClient**(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`) +• **new UnknownSupportedAttributeClient**(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`) #### Parameters @@ -56,7 +56,7 @@ but the contained attribute is unknown. #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[constructor](exports_cluster.PresentAttributeClient.md#constructor) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[constructor](exports_cluster.SupportedAttributeClient.md#constructor) #### Defined in @@ -70,7 +70,7 @@ packages/matter.js/dist/esm/cluster/client/AttributeClient.d.ts:30 #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[attribute](exports_cluster.PresentAttributeClient.md#attribute) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[attribute](exports_cluster.SupportedAttributeClient.md#attribute) #### Defined in @@ -84,7 +84,7 @@ ___ #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[clusterId](exports_cluster.PresentAttributeClient.md#clusterid) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[clusterId](exports_cluster.SupportedAttributeClient.md#clusterid) #### Defined in @@ -98,7 +98,7 @@ ___ #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[endpointId](exports_cluster.PresentAttributeClient.md#endpointid) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[endpointId](exports_cluster.SupportedAttributeClient.md#endpointid) #### Defined in @@ -112,7 +112,7 @@ ___ #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[id](exports_cluster.PresentAttributeClient.md#id) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[id](exports_cluster.SupportedAttributeClient.md#id) #### Defined in @@ -126,7 +126,7 @@ ___ #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[name](exports_cluster.PresentAttributeClient.md#name) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[name](exports_cluster.SupportedAttributeClient.md#name) #### Defined in @@ -140,7 +140,7 @@ ___ #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[schema](exports_cluster.PresentAttributeClient.md#schema) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[schema](exports_cluster.SupportedAttributeClient.md#schema) #### Defined in @@ -166,7 +166,7 @@ Add a listener to the attribute. #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[addListener](exports_cluster.PresentAttributeClient.md#addlistener) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[addListener](exports_cluster.SupportedAttributeClient.md#addlistener) #### Defined in @@ -193,7 +193,7 @@ Get the value of the attribute. Fabric scoped reads are always done with the rem #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[get](exports_cluster.PresentAttributeClient.md#get) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[get](exports_cluster.SupportedAttributeClient.md#get) #### Defined in @@ -220,7 +220,7 @@ Get the value with version of the attribute. Fabric scoped reads are always done #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[getWithVersion](exports_cluster.PresentAttributeClient.md#getwithversion) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[getWithVersion](exports_cluster.SupportedAttributeClient.md#getwithversion) #### Defined in @@ -246,7 +246,7 @@ Remove a listener from the attribute. #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[removeListener](exports_cluster.PresentAttributeClient.md#removelistener) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[removeListener](exports_cluster.SupportedAttributeClient.md#removelistener) #### Defined in @@ -274,7 +274,7 @@ cluster dataVersion of the server matches. If it does not match it is rejected w #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[set](exports_cluster.PresentAttributeClient.md#set) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[set](exports_cluster.SupportedAttributeClient.md#set) #### Defined in @@ -303,7 +303,7 @@ Subscribe to the attribute. #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[subscribe](exports_cluster.PresentAttributeClient.md#subscribe) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[subscribe](exports_cluster.SupportedAttributeClient.md#subscribe) #### Defined in @@ -329,7 +329,7 @@ Update the value of the attribute. Just internally used! #### Inherited from -[PresentAttributeClient](exports_cluster.PresentAttributeClient.md).[update](exports_cluster.PresentAttributeClient.md#update) +[SupportedAttributeClient](exports_cluster.SupportedAttributeClient.md).[update](exports_cluster.SupportedAttributeClient.md#update) #### Defined in diff --git a/docs/matter-node.js/classes/exports_cluster.UnknownPresentEventClient.md b/docs/matter-node.js/classes/exports_cluster.UnknownSupportedEventClient.md similarity index 81% rename from docs/matter-node.js/classes/exports_cluster.UnknownPresentEventClient.md rename to docs/matter-node.js/classes/exports_cluster.UnknownSupportedEventClient.md index ccee7ef9a3..16ba85f07a 100644 --- a/docs/matter-node.js/classes/exports_cluster.UnknownPresentEventClient.md +++ b/docs/matter-node.js/classes/exports_cluster.UnknownSupportedEventClient.md @@ -1,45 +1,45 @@ -[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/cluster](../modules/exports_cluster.md) / UnknownPresentEventClient +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/cluster](../modules/exports_cluster.md) / UnknownSupportedEventClient -# Class: UnknownPresentEventClient +# Class: UnknownSupportedEventClient -[exports/cluster](../modules/exports_cluster.md).UnknownPresentEventClient +[exports/cluster](../modules/exports_cluster.md).UnknownSupportedEventClient -Special EventClient class to allow identifying events that are present because reported by the Devices, +Special EventClient class to allow identifying events that are supported because reported by the Devices, but the contained event is unknown. ## Hierarchy - [`EventClient`](exports_cluster.EventClient.md)<`any`\> - ↳ **`UnknownPresentEventClient`** + ↳ **`UnknownSupportedEventClient`** ## Table of contents ### Constructors -- [constructor](exports_cluster.UnknownPresentEventClient.md#constructor) +- [constructor](exports_cluster.UnknownSupportedEventClient.md#constructor) ### Properties -- [clusterId](exports_cluster.UnknownPresentEventClient.md#clusterid) -- [endpointId](exports_cluster.UnknownPresentEventClient.md#endpointid) -- [event](exports_cluster.UnknownPresentEventClient.md#event) -- [id](exports_cluster.UnknownPresentEventClient.md#id) -- [name](exports_cluster.UnknownPresentEventClient.md#name) +- [clusterId](exports_cluster.UnknownSupportedEventClient.md#clusterid) +- [endpointId](exports_cluster.UnknownSupportedEventClient.md#endpointid) +- [event](exports_cluster.UnknownSupportedEventClient.md#event) +- [id](exports_cluster.UnknownSupportedEventClient.md#id) +- [name](exports_cluster.UnknownSupportedEventClient.md#name) ### Methods -- [addListener](exports_cluster.UnknownPresentEventClient.md#addlistener) -- [get](exports_cluster.UnknownPresentEventClient.md#get) -- [removeListener](exports_cluster.UnknownPresentEventClient.md#removelistener) -- [subscribe](exports_cluster.UnknownPresentEventClient.md#subscribe) -- [update](exports_cluster.UnknownPresentEventClient.md#update) +- [addListener](exports_cluster.UnknownSupportedEventClient.md#addlistener) +- [get](exports_cluster.UnknownSupportedEventClient.md#get) +- [removeListener](exports_cluster.UnknownSupportedEventClient.md#removelistener) +- [subscribe](exports_cluster.UnknownSupportedEventClient.md#subscribe) +- [update](exports_cluster.UnknownSupportedEventClient.md#update) ## Constructors ### constructor -• **new UnknownPresentEventClient**(`event`, `name`, `endpointId`, `clusterId`, `interactionClient`) +• **new UnknownSupportedEventClient**(`event`, `name`, `endpointId`, `clusterId`, `interactionClient`) #### Parameters diff --git a/docs/matter-node.js/classes/exports_common.MatterError.md b/docs/matter-node.js/classes/exports_common.MatterError.md index 67b97949d4..4a67b05615 100644 --- a/docs/matter-node.js/classes/exports_common.MatterError.md +++ b/docs/matter-node.js/classes/exports_common.MatterError.md @@ -50,6 +50,8 @@ Error base class for all errors thrown by this library. ↳↳ [`CommissioningError`](exports_protocol.CommissioningError.md) + ↳↳ [`DiscoveryError`](exports_protocol.DiscoveryError.md) + ↳↳ [`RetransmissionLimitReachedError`](exports_protocol.RetransmissionLimitReachedError.md) ↳↳ [`UnexpectedMessageError`](exports_protocol.UnexpectedMessageError.md) diff --git a/docs/matter-node.js/classes/exports_device.Aggregator.md b/docs/matter-node.js/classes/exports_device.Aggregator.md index efdd8a16dc..713297aaad 100644 --- a/docs/matter-node.js/classes/exports_device.Aggregator.md +++ b/docs/matter-node.js/classes/exports_device.Aggregator.md @@ -157,7 +157,7 @@ on the device! | Name | Type | Description | | :------ | :------ | :------ | | `device` | [`Device`](exports_device.Device.md) \| [`ComposedDevice`](exports_device.ComposedDevice.md) | Device instance to add | -| `bridgedBasicInformation?` | [`AttributeInitialValues`](../modules/exports_cluster.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `hardwareVersion`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](../modules/exports_cluster.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](../modules/exports_cluster.md#optionalattribute)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](../modules/exports_cluster.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<[`VendorId`](../modules/exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/exports_cluster.md#globalattributes-1)<{}\>\>\> | Optional BridgedDeviceBasicInformationCluster attribute values to | +| `bridgedBasicInformation?` | [`AttributeInitialValues`](../modules/exports_cluster.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `hardwareVersion`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](../modules/exports_cluster.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](../modules/exports_cluster.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<[`VendorId`](../modules/exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/exports_cluster.md#globalattributes-1)<{}\>\>\> | Optional BridgedDeviceBasicInformationCluster attribute values to | #### Returns @@ -183,7 +183,7 @@ The required clusters PowerSourceConfigurationCluster and PowerSourceCluster nee | Name | Type | Description | | :------ | :------ | :------ | | `device` | [`Device`](exports_device.Device.md) \| [`ComposedDevice`](exports_device.ComposedDevice.md) | Device instance to add | -| `bridgedBasicInformation?` | [`AttributeInitialValues`](../modules/exports_cluster.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `hardwareVersion`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](../modules/exports_cluster.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](../modules/exports_cluster.md#optionalattribute)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](../modules/exports_cluster.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<[`VendorId`](../modules/exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/exports_cluster.md#globalattributes-1)<{}\>\>\> | Optional BridgedDeviceBasicInformationCluster attribute values to | +| `bridgedBasicInformation?` | [`AttributeInitialValues`](../modules/exports_cluster.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `hardwareVersion`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](../modules/exports_cluster.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](../modules/exports_cluster.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<[`VendorId`](../modules/exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/exports_cluster.md#globalattributes-1)<{}\>\>\> | Optional BridgedDeviceBasicInformationCluster attribute values to | #### Returns diff --git a/docs/matter-node.js/classes/exports_device.ComposedDevice.md b/docs/matter-node.js/classes/exports_device.ComposedDevice.md index 278809c1f0..58eff29663 100644 --- a/docs/matter-node.js/classes/exports_device.ComposedDevice.md +++ b/docs/matter-node.js/classes/exports_device.ComposedDevice.md @@ -51,6 +51,7 @@ A ComposedDevice is a special endpoint that allows to combine multiple sub devic - [hasClusterServer](exports_device.ComposedDevice.md#hasclusterserver) - [removeChildEndpoint](exports_device.ComposedDevice.md#removechildendpoint) - [removeFromStructure](exports_device.ComposedDevice.md#removefromstructure) +- [setBridgedDeviceReachability](exports_device.ComposedDevice.md#setbridgeddevicereachability) - [setDeviceTypes](exports_device.ComposedDevice.md#setdevicetypes) - [setStructureChangedCallback](exports_device.ComposedDevice.md#setstructurechangedcallback) - [updatePartsList](exports_device.ComposedDevice.md#updatepartslist) @@ -78,7 +79,7 @@ Creates a new ComposedDevice. #### Defined in -packages/matter.js/dist/esm/device/ComposedDevice.d.ts:21 +packages/matter.js/dist/esm/device/ComposedDevice.d.ts:16 ## Properties @@ -244,7 +245,7 @@ Add a sub-device to the composed device. #### Defined in -packages/matter.js/dist/esm/device/ComposedDevice.d.ts:26 +packages/matter.js/dist/esm/device/ComposedDevice.d.ts:21 ___ @@ -560,7 +561,7 @@ Array with all sub-devices #### Defined in -packages/matter.js/dist/esm/device/ComposedDevice.d.ts:32 +packages/matter.js/dist/esm/device/ComposedDevice.d.ts:27 ___ @@ -692,6 +693,28 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:36 ___ +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the Composed device exposed via the bridge. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/device/ComposedDevice.d.ts:37 + +___ + ### setDeviceTypes ▸ **setDeviceTypes**(`deviceTypes`): `void` @@ -774,4 +797,4 @@ Verify that the required clusters exists on the device. #### Defined in -packages/matter.js/dist/esm/device/ComposedDevice.d.ts:36 +packages/matter.js/dist/esm/device/ComposedDevice.d.ts:31 diff --git a/docs/matter-node.js/classes/exports_device.Device.md b/docs/matter-node.js/classes/exports_device.Device.md index d28a4a2653..7f8aa83268 100644 --- a/docs/matter-node.js/classes/exports_device.Device.md +++ b/docs/matter-node.js/classes/exports_device.Device.md @@ -55,6 +55,7 @@ Base class for all devices. This class should be extended by all devices. - [removeChildEndpoint](exports_device.Device.md#removechildendpoint) - [removeCommandHandler](exports_device.Device.md#removecommandhandler) - [removeFromStructure](exports_device.Device.md#removefromstructure) +- [setBridgedDeviceReachability](exports_device.Device.md#setbridgeddevicereachability) - [setDeviceTypes](exports_device.Device.md#setdevicetypes) - [setStructureChangedCallback](exports_device.Device.md#setstructurechangedcallback) - [updatePartsList](exports_device.Device.md#updatepartslist) @@ -81,17 +82,17 @@ Create a new Device instance. #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:71 +packages/matter.js/dist/esm/device/Device.d.ts:89 ## Properties ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:64 +packages/matter.js/dist/esm/device/Device.d.ts:82 ___ @@ -101,7 +102,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:63 +packages/matter.js/dist/esm/device/Device.d.ts:81 ___ @@ -181,7 +182,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:96 +packages/matter.js/dist/esm/device/Device.d.ts:114 ___ @@ -285,7 +286,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -293,7 +294,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:79 +packages/matter.js/dist/esm/device/Device.d.ts:97 ___ @@ -373,7 +374,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:98 +packages/matter.js/dist/esm/device/Device.d.ts:116 ___ @@ -403,7 +404,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:97 +packages/matter.js/dist/esm/device/Device.d.ts:115 ___ @@ -551,7 +552,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:100 +packages/matter.js/dist/esm/device/Device.d.ts:118 ___ @@ -609,7 +610,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:99 +packages/matter.js/dist/esm/device/Device.d.ts:117 ___ @@ -777,7 +778,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -785,7 +786,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:87 +packages/matter.js/dist/esm/device/Device.d.ts:105 ___ @@ -807,6 +808,29 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:36 ___ +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:125 + +___ + ### setDeviceTypes ▸ **setDeviceTypes**(`deviceTypes`): `void` diff --git a/docs/matter-node.js/classes/exports_device.DimmableLightDevice.md b/docs/matter-node.js/classes/exports_device.DimmableLightDevice.md index acff071cb4..69ece98f46 100644 --- a/docs/matter-node.js/classes/exports_device.DimmableLightDevice.md +++ b/docs/matter-node.js/classes/exports_device.DimmableLightDevice.md @@ -58,6 +58,7 @@ - [removeChildEndpoint](exports_device.DimmableLightDevice.md#removechildendpoint) - [removeCommandHandler](exports_device.DimmableLightDevice.md#removecommandhandler) - [removeFromStructure](exports_device.DimmableLightDevice.md#removefromstructure) +- [setBridgedDeviceReachability](exports_device.DimmableLightDevice.md#setbridgeddevicereachability) - [setCurrentLevel](exports_device.DimmableLightDevice.md#setcurrentlevel) - [setDeviceTypes](exports_device.DimmableLightDevice.md#setdevicetypes) - [setOnOff](exports_device.DimmableLightDevice.md#setonoff) @@ -92,7 +93,7 @@ packages/matter.js/dist/esm/device/DimmableDevices.d.ts:41 ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -100,7 +101,7 @@ packages/matter.js/dist/esm/device/DimmableDevices.d.ts:41 #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:64 +packages/matter.js/dist/esm/device/Device.d.ts:82 ___ @@ -114,7 +115,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:63 +packages/matter.js/dist/esm/device/Device.d.ts:81 ___ @@ -198,7 +199,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:96 +packages/matter.js/dist/esm/device/Device.d.ts:114 ▸ `Protected` **_executeHandler**<`K_2`\>(`action`, `...args`): `Promise`<`void`\> @@ -356,7 +357,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -368,7 +369,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:79 +packages/matter.js/dist/esm/device/Device.d.ts:97 ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -584,7 +585,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:98 +packages/matter.js/dist/esm/device/Device.d.ts:116 ___ @@ -618,7 +619,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:97 +packages/matter.js/dist/esm/device/Device.d.ts:115 ___ @@ -766,7 +767,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:100 +packages/matter.js/dist/esm/device/Device.d.ts:118 ___ @@ -824,7 +825,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:99 +packages/matter.js/dist/esm/device/Device.d.ts:117 ___ @@ -1028,7 +1029,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -1040,7 +1041,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:87 +packages/matter.js/dist/esm/device/Device.d.ts:105 ▸ **removeCommandHandler**<`K_1`\>(`action`, `handler`): `void` @@ -1116,6 +1117,33 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:36 ___ +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +[DimmableBaseDevice](export._internal_.DimmableBaseDevice.md).[setBridgedDeviceReachability](export._internal_.DimmableBaseDevice.md#setbridgeddevicereachability) + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:125 + +___ + ### setCurrentLevel ▸ **setCurrentLevel**(`level`): `void` diff --git a/docs/matter-node.js/classes/exports_device.DimmablePluginUnitDevice.md b/docs/matter-node.js/classes/exports_device.DimmablePluginUnitDevice.md index 4ebb5ed09a..e7ca32f155 100644 --- a/docs/matter-node.js/classes/exports_device.DimmablePluginUnitDevice.md +++ b/docs/matter-node.js/classes/exports_device.DimmablePluginUnitDevice.md @@ -58,6 +58,7 @@ - [removeChildEndpoint](exports_device.DimmablePluginUnitDevice.md#removechildendpoint) - [removeCommandHandler](exports_device.DimmablePluginUnitDevice.md#removecommandhandler) - [removeFromStructure](exports_device.DimmablePluginUnitDevice.md#removefromstructure) +- [setBridgedDeviceReachability](exports_device.DimmablePluginUnitDevice.md#setbridgeddevicereachability) - [setCurrentLevel](exports_device.DimmablePluginUnitDevice.md#setcurrentlevel) - [setDeviceTypes](exports_device.DimmablePluginUnitDevice.md#setdevicetypes) - [setOnOff](exports_device.DimmablePluginUnitDevice.md#setonoff) @@ -92,7 +93,7 @@ packages/matter.js/dist/esm/device/DimmableDevices.d.ts:38 ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -100,7 +101,7 @@ packages/matter.js/dist/esm/device/DimmableDevices.d.ts:38 #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:64 +packages/matter.js/dist/esm/device/Device.d.ts:82 ___ @@ -114,7 +115,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:63 +packages/matter.js/dist/esm/device/Device.d.ts:81 ___ @@ -198,7 +199,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:96 +packages/matter.js/dist/esm/device/Device.d.ts:114 ▸ `Protected` **_executeHandler**<`K_2`\>(`action`, `...args`): `Promise`<`void`\> @@ -356,7 +357,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -368,7 +369,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:79 +packages/matter.js/dist/esm/device/Device.d.ts:97 ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -584,7 +585,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:98 +packages/matter.js/dist/esm/device/Device.d.ts:116 ___ @@ -618,7 +619,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:97 +packages/matter.js/dist/esm/device/Device.d.ts:115 ___ @@ -766,7 +767,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:100 +packages/matter.js/dist/esm/device/Device.d.ts:118 ___ @@ -824,7 +825,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:99 +packages/matter.js/dist/esm/device/Device.d.ts:117 ___ @@ -1028,7 +1029,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -1040,7 +1041,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:87 +packages/matter.js/dist/esm/device/Device.d.ts:105 ▸ **removeCommandHandler**<`K_1`\>(`action`, `handler`): `void` @@ -1116,6 +1117,33 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:36 ___ +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +[DimmableBaseDevice](export._internal_.DimmableBaseDevice.md).[setBridgedDeviceReachability](export._internal_.DimmableBaseDevice.md#setbridgeddevicereachability) + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:125 + +___ + ### setCurrentLevel ▸ **setCurrentLevel**(`level`): `void` diff --git a/docs/matter-node.js/classes/exports_device.OnOffBaseDevice.md b/docs/matter-node.js/classes/exports_device.OnOffBaseDevice.md index 70ede218e4..614a01f8cf 100644 --- a/docs/matter-node.js/classes/exports_device.OnOffBaseDevice.md +++ b/docs/matter-node.js/classes/exports_device.OnOffBaseDevice.md @@ -62,6 +62,7 @@ Abstract Base class for OnOff devices - [removeChildEndpoint](exports_device.OnOffBaseDevice.md#removechildendpoint) - [removeCommandHandler](exports_device.OnOffBaseDevice.md#removecommandhandler) - [removeFromStructure](exports_device.OnOffBaseDevice.md#removefromstructure) +- [setBridgedDeviceReachability](exports_device.OnOffBaseDevice.md#setbridgeddevicereachability) - [setDeviceTypes](exports_device.OnOffBaseDevice.md#setdevicetypes) - [setOnOff](exports_device.OnOffBaseDevice.md#setonoff) - [setStructureChangedCallback](exports_device.OnOffBaseDevice.md#setstructurechangedcallback) @@ -97,7 +98,7 @@ packages/matter.js/dist/esm/device/OnOffDevices.d.ts:47 ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -105,7 +106,7 @@ OnOffBaseDevice\_base.commandHandler #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:64 +packages/matter.js/dist/esm/device/Device.d.ts:82 ___ @@ -119,7 +120,7 @@ OnOffBaseDevice\_base.deviceType #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:63 +packages/matter.js/dist/esm/device/Device.d.ts:81 ___ @@ -203,7 +204,7 @@ OnOffBaseDevice\_base.\_executeHandler #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:96 +packages/matter.js/dist/esm/device/Device.d.ts:114 ▸ `Protected` **_executeHandler**<`K_2`\>(`action`, `...args`): `Promise`<`void`\> @@ -334,7 +335,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -346,7 +347,7 @@ OnOffBaseDevice\_base.addCommandHandler #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:79 +packages/matter.js/dist/esm/device/Device.d.ts:97 ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -503,7 +504,7 @@ OnOffBaseDevice\_base.createOptionalClusterClient #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:98 +packages/matter.js/dist/esm/device/Device.d.ts:116 ___ @@ -537,7 +538,7 @@ OnOffBaseDevice\_base.createOptionalClusterServer #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:97 +packages/matter.js/dist/esm/device/Device.d.ts:115 ___ @@ -685,7 +686,7 @@ OnOffBaseDevice\_base.getClusterClient #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:100 +packages/matter.js/dist/esm/device/Device.d.ts:118 ___ @@ -743,7 +744,7 @@ OnOffBaseDevice\_base.getClusterServer #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:99 +packages/matter.js/dist/esm/device/Device.d.ts:117 ___ @@ -925,7 +926,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -937,7 +938,7 @@ OnOffBaseDevice\_base.removeCommandHandler #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:87 +packages/matter.js/dist/esm/device/Device.d.ts:105 ▸ **removeCommandHandler**<`K_1`\>(`action`, `handler`): `void` @@ -986,6 +987,33 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:36 ___ +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +OnOffBaseDevice\_base.setBridgedDeviceReachability + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:125 + +___ + ### setDeviceTypes ▸ **setDeviceTypes**(`deviceTypes`): `void` diff --git a/docs/matter-node.js/classes/exports_device.OnOffLightDevice.md b/docs/matter-node.js/classes/exports_device.OnOffLightDevice.md index 47a213b030..72104b1d18 100644 --- a/docs/matter-node.js/classes/exports_device.OnOffLightDevice.md +++ b/docs/matter-node.js/classes/exports_device.OnOffLightDevice.md @@ -58,6 +58,7 @@ Device class for an OnOffPluginUnit Device - [removeChildEndpoint](exports_device.OnOffLightDevice.md#removechildendpoint) - [removeCommandHandler](exports_device.OnOffLightDevice.md#removecommandhandler) - [removeFromStructure](exports_device.OnOffLightDevice.md#removefromstructure) +- [setBridgedDeviceReachability](exports_device.OnOffLightDevice.md#setbridgeddevicereachability) - [setDeviceTypes](exports_device.OnOffLightDevice.md#setdevicetypes) - [setOnOff](exports_device.OnOffLightDevice.md#setonoff) - [setStructureChangedCallback](exports_device.OnOffLightDevice.md#setstructurechangedcallback) @@ -90,7 +91,7 @@ packages/matter.js/dist/esm/device/OnOffDevices.d.ts:91 ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -98,7 +99,7 @@ packages/matter.js/dist/esm/device/OnOffDevices.d.ts:91 #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:64 +packages/matter.js/dist/esm/device/Device.d.ts:82 ___ @@ -112,7 +113,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:63 +packages/matter.js/dist/esm/device/Device.d.ts:81 ___ @@ -196,7 +197,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:96 +packages/matter.js/dist/esm/device/Device.d.ts:114 ▸ `Protected` **_executeHandler**<`K_2`\>(`action`, `...args`): `Promise`<`void`\> @@ -327,7 +328,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -339,7 +340,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:79 +packages/matter.js/dist/esm/device/Device.d.ts:97 ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -504,7 +505,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:98 +packages/matter.js/dist/esm/device/Device.d.ts:116 ___ @@ -538,7 +539,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:97 +packages/matter.js/dist/esm/device/Device.d.ts:115 ___ @@ -686,7 +687,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:100 +packages/matter.js/dist/esm/device/Device.d.ts:118 ___ @@ -744,7 +745,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:99 +packages/matter.js/dist/esm/device/Device.d.ts:117 ___ @@ -930,7 +931,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -942,7 +943,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:87 +packages/matter.js/dist/esm/device/Device.d.ts:105 ▸ **removeCommandHandler**<`K_1`\>(`action`, `handler`): `void` @@ -991,6 +992,33 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:36 ___ +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +[OnOffBaseDevice](exports_device.OnOffBaseDevice.md).[setBridgedDeviceReachability](exports_device.OnOffBaseDevice.md#setbridgeddevicereachability) + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:125 + +___ + ### setDeviceTypes ▸ **setDeviceTypes**(`deviceTypes`): `void` diff --git a/docs/matter-node.js/classes/exports_device.OnOffPluginUnitDevice.md b/docs/matter-node.js/classes/exports_device.OnOffPluginUnitDevice.md index e139ca8d97..db55e9480e 100644 --- a/docs/matter-node.js/classes/exports_device.OnOffPluginUnitDevice.md +++ b/docs/matter-node.js/classes/exports_device.OnOffPluginUnitDevice.md @@ -58,6 +58,7 @@ Device class for an OnOffPluginUnit Device - [removeChildEndpoint](exports_device.OnOffPluginUnitDevice.md#removechildendpoint) - [removeCommandHandler](exports_device.OnOffPluginUnitDevice.md#removecommandhandler) - [removeFromStructure](exports_device.OnOffPluginUnitDevice.md#removefromstructure) +- [setBridgedDeviceReachability](exports_device.OnOffPluginUnitDevice.md#setbridgeddevicereachability) - [setDeviceTypes](exports_device.OnOffPluginUnitDevice.md#setdevicetypes) - [setOnOff](exports_device.OnOffPluginUnitDevice.md#setonoff) - [setStructureChangedCallback](exports_device.OnOffPluginUnitDevice.md#setstructurechangedcallback) @@ -90,7 +91,7 @@ packages/matter.js/dist/esm/device/OnOffDevices.d.ts:85 ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -98,7 +99,7 @@ packages/matter.js/dist/esm/device/OnOffDevices.d.ts:85 #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:64 +packages/matter.js/dist/esm/device/Device.d.ts:82 ___ @@ -112,7 +113,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:63 +packages/matter.js/dist/esm/device/Device.d.ts:81 ___ @@ -196,7 +197,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:96 +packages/matter.js/dist/esm/device/Device.d.ts:114 ▸ `Protected` **_executeHandler**<`K_2`\>(`action`, `...args`): `Promise`<`void`\> @@ -327,7 +328,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -339,7 +340,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:79 +packages/matter.js/dist/esm/device/Device.d.ts:97 ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -504,7 +505,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:98 +packages/matter.js/dist/esm/device/Device.d.ts:116 ___ @@ -538,7 +539,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:97 +packages/matter.js/dist/esm/device/Device.d.ts:115 ___ @@ -686,7 +687,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:100 +packages/matter.js/dist/esm/device/Device.d.ts:118 ___ @@ -744,7 +745,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:99 +packages/matter.js/dist/esm/device/Device.d.ts:117 ___ @@ -930,7 +931,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -942,7 +943,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/dist/esm/device/Device.d.ts:87 +packages/matter.js/dist/esm/device/Device.d.ts:105 ▸ **removeCommandHandler**<`K_1`\>(`action`, `handler`): `void` @@ -991,6 +992,33 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:36 ___ +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +[OnOffBaseDevice](exports_device.OnOffBaseDevice.md).[setBridgedDeviceReachability](exports_device.OnOffBaseDevice.md#setbridgeddevicereachability) + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:125 + +___ + ### setDeviceTypes ▸ **setDeviceTypes**(`deviceTypes`): `void` diff --git a/docs/matter-node.js/classes/exports_device.PairedNode.md b/docs/matter-node.js/classes/exports_device.PairedNode.md new file mode 100644 index 0000000000..6bf49c978a --- /dev/null +++ b/docs/matter-node.js/classes/exports_device.PairedNode.md @@ -0,0 +1,583 @@ +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/device](../modules/exports_device.md) / PairedNode + +# Class: PairedNode + +[exports/device](../modules/exports_device.md).PairedNode + +Class to represents one node that is paired/commissioned with the matter.js Controller. Instances are returned by +the CommissioningController on commissioning or when connecting. + +## Table of contents + +### Constructors + +- [constructor](exports_device.PairedNode.md#constructor) + +### Properties + +- [commissioningController](exports_device.PairedNode.md#commissioningcontroller) +- [connectionState](exports_device.PairedNode.md#connectionstate) +- [createDevice](exports_device.PairedNode.md#createdevice) +- [endpoints](exports_device.PairedNode.md#endpoints) +- [ensureConnection](exports_device.PairedNode.md#ensureconnection) +- [handleNodeShutdown](exports_device.PairedNode.md#handlenodeshutdown) +- [initialize](exports_device.PairedNode.md#initialize) +- [initializeEndpointStructure](exports_device.PairedNode.md#initializeendpointstructure) +- [interactionClient](exports_device.PairedNode.md#interactionclient) +- [nodeId](exports_device.PairedNode.md#nodeid) +- [options](exports_device.PairedNode.md#options) +- [reconnectDelayTimer](exports_device.PairedNode.md#reconnectdelaytimer) +- [reconnectInteractionClient](exports_device.PairedNode.md#reconnectinteractionclient) +- [setConnectionState](exports_device.PairedNode.md#setconnectionstate) +- [structureEndpoints](exports_device.PairedNode.md#structureendpoints) +- [updateEndpointStructureTimer](exports_device.PairedNode.md#updateendpointstructuretimer) + +### Accessors + +- [isConnected](exports_device.PairedNode.md#isconnected) + +### Methods + +- [close](exports_device.PairedNode.md#close) +- [decommission](exports_device.PairedNode.md#decommission) +- [disconnect](exports_device.PairedNode.md#disconnect) +- [getDeviceById](exports_device.PairedNode.md#getdevicebyid) +- [getDevices](exports_device.PairedNode.md#getdevices) +- [getInteractionClient](exports_device.PairedNode.md#getinteractionclient) +- [getRootClusterClient](exports_device.PairedNode.md#getrootclusterclient) +- [getRootClusterServer](exports_device.PairedNode.md#getrootclusterserver) +- [logStructure](exports_device.PairedNode.md#logstructure) +- [openBasicCommissioningWindow](exports_device.PairedNode.md#openbasiccommissioningwindow) +- [openEnhancedCommissioningWindow](exports_device.PairedNode.md#openenhancedcommissioningwindow) +- [reconnect](exports_device.PairedNode.md#reconnect) +- [subscribeAllAttributesAndEvents](exports_device.PairedNode.md#subscribeallattributesandevents) +- [updateEndpointStructure](exports_device.PairedNode.md#updateendpointstructure) +- [create](exports_device.PairedNode.md#create) + +## Constructors + +### constructor + +• **new PairedNode**(`nodeId`, `commissioningController`, `options`, `reconnectInteractionClient`, `assignDisconnectedHandler`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `commissioningController` | [`CommissioningController`](export.CommissioningController.md) | +| `options` | [`CommissioningControllerNodeOptions`](../modules/exports_device.md#commissioningcontrollernodeoptions) | +| `reconnectInteractionClient` | () => `Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> | +| `assignDisconnectedHandler` | (`handler`: () => `Promise`<`void`\>) => `void` | + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:84 + +## Properties + +### commissioningController + +• `Private` `Readonly` **commissioningController**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:75 + +___ + +### connectionState + +• `Private` **connectionState**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:82 + +___ + +### createDevice + +• `Private` **createDevice**: `any` + +Create a device object from the data read from the device. + +**`Param`** + +Endpoint ID + +**`Param`** + +Data of all clusters read from the device + +**`Param`** + +InteractionClient to use for the device + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:132 + +___ + +### endpoints + +• `Private` `Readonly` **endpoints**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:78 + +___ + +### ensureConnection + +• `Private` **ensureConnection**: `any` + +Ensure that the node is connected by creating a new InteractionClient if needed. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:93 + +___ + +### handleNodeShutdown + +• `Private` **handleNodeShutdown**: `any` + +Handles a node shutDown event (if supported by the node and received). + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:118 + +___ + +### initialize + +• `Private` **initialize**: `any` + +Initialize the node after the InteractionClient was created and to subscribe attributes and events if requested. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:97 + +___ + +### initializeEndpointStructure + +• `Private` **initializeEndpointStructure**: `any` + +Reads all data from the device and create a device object structure out of it. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:121 + +___ + +### interactionClient + +• `Private` `Optional` **interactionClient**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:79 + +___ + +### nodeId + +• `Readonly` **nodeId**: [`NodeId`](../modules/exports_datatype.md#nodeid) + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:74 + +___ + +### options + +• `Private` `Readonly` **options**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:76 + +___ + +### reconnectDelayTimer + +• `Private` `Readonly` **reconnectDelayTimer**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:80 + +___ + +### reconnectInteractionClient + +• `Private` `Readonly` **reconnectInteractionClient**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:77 + +___ + +### setConnectionState + +• `Private` **setConnectionState**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:86 + +___ + +### structureEndpoints + +• `Private` **structureEndpoints**: `any` + +Bring the endpoints in a structure based on their partsList attribute. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:123 + +___ + +### updateEndpointStructureTimer + +• `Private` `Readonly` **updateEndpointStructureTimer**: `any` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:81 + +## Accessors + +### isConnected + +• `get` **isConnected**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:85 + +## Methods + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:147 + +___ + +### decommission + +▸ **decommission**(): `Promise`<`void`\> + +De-Commission (unpair) the device from this controller by removing the fabric from the device. + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:138 + +___ + +### disconnect + +▸ **disconnect**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:146 + +___ + +### getDeviceById + +▸ **getDeviceById**(`endpointId`): `undefined` \| [`Endpoint`](exports_device.Endpoint.md) + +Returns the device/endpoint with the given endpoint ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `endpointId` | `number` | + +#### Returns + +`undefined` \| [`Endpoint`](exports_device.Endpoint.md) + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:136 + +___ + +### getDevices + +▸ **getDevices**(): [`Endpoint`](exports_device.Endpoint.md)[] + +Returns the devices/endpoints known for this node. + +#### Returns + +[`Endpoint`](exports_device.Endpoint.md)[] + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:134 + +___ + +### getInteractionClient + +▸ **getInteractionClient**(): `Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> + +Request the current InteractionClient for custom special case interactions with the device. Usually the +ClusterClients of the Devices of the node should be used instead. + +#### Returns + +`Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:102 + +___ + +### getRootClusterClient + +▸ **getRootClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> + +Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | +| `SF` | extends [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<`F`\> | +| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | +| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`Cluster`](../modules/exports_cluster.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterClient to get or undefined if not existing | + +#### Returns + +`undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:159 + +___ + +### getRootClusterServer + +▸ **getRootClusterServer**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> + +Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | +| `SF` | extends [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<`F`\> | +| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | +| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`Cluster`](../modules/exports_cluster.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterServer to get or undefined if not existing | + +#### Returns + +`undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:153 + +___ + +### logStructure + +▸ **logStructure**(`options?`): `void` + +Method to log the structure of this node with all endpoint and clusters. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | [`EndpointLoggingOptions`](../modules/exports_device.md#endpointloggingoptions) | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:104 + +___ + +### openBasicCommissioningWindow + +▸ **openBasicCommissioningWindow**(`commissioningTimeout?`): `Promise`<`void`\> + +Opens a Basic Commissioning Window (uses the original Passcode printed on the device) with the device. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `commissioningTimeout?` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:140 + +___ + +### openEnhancedCommissioningWindow + +▸ **openEnhancedCommissioningWindow**(`commissioningTimeout?`): `Promise`<{ `manualPairingCode`: `string` ; `qrPairingCode`: `string` }\> + +Opens an Enhanced Commissioning Window (uses a generated random Passcode) with the device. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `commissioningTimeout?` | `number` | + +#### Returns + +`Promise`<{ `manualPairingCode`: `string` ; `qrPairingCode`: `string` }\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:142 + +___ + +### reconnect + +▸ **reconnect**(): `Promise`<`void`\> + +Force a reconnection to the device. This method is mainly used internally to reconnect after the active session +was closed or the device wen offline and was detected as being online again. + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:91 + +___ + +### subscribeAllAttributesAndEvents + +▸ **subscribeAllAttributesAndEvents**(`options?`): `Promise`<{ `attributeReports?`: [`DecodedAttributeReportValue`](../modules/exports_interaction.md#decodedattributereportvalue)<`any`\>[] ; `eventReports?`: [`DecodedEventReportValue`](../modules/exports_interaction.md#decodedeventreportvalue)<`any`\>[] }\> + +Subscribe to all attributes and events of the device. Unless setting the Controller property autoSubscribe to +false this is executed automatically. Alternatively you can manually subscribe by calling this method. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `Object` | +| `options.attributeChangedCallback?` | (`data`: [`DecodedAttributeReportValue`](../modules/exports_interaction.md#decodedattributereportvalue)<`any`\>) => `void` | +| `options.eventTriggeredCallback?` | (`data`: [`DecodedEventReportValue`](../modules/exports_interaction.md#decodedeventreportvalue)<`any`\>) => `void` | +| `options.ignoreInitialTriggers?` | `boolean` | + +#### Returns + +`Promise`<{ `attributeReports?`: [`DecodedAttributeReportValue`](../modules/exports_interaction.md#decodedattributereportvalue)<`any`\>[] ; `eventReports?`: [`DecodedEventReportValue`](../modules/exports_interaction.md#decodedeventreportvalue)<`any`\>[] }\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:109 + +___ + +### updateEndpointStructure + +▸ **updateEndpointStructure**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:119 + +___ + +### create + +▸ `Static` **create**(`nodeId`, `commissioningController`, `options`, `reconnectInteractionClient`, `assignDisconnectedHandler`): `Promise`<[`PairedNode`](exports_device.PairedNode.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `commissioningController` | [`CommissioningController`](export.CommissioningController.md) | +| `options` | `undefined` \| [`CommissioningControllerNodeOptions`](../modules/exports_device.md#commissioningcontrollernodeoptions) | +| `reconnectInteractionClient` | () => `Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> | +| `assignDisconnectedHandler` | (`handler`: () => `Promise`<`void`\>) => `void` | + +#### Returns + +`Promise`<[`PairedNode`](exports_device.PairedNode.md)\> + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:83 diff --git a/docs/matter-node.js/classes/exports_device.RootEndpoint.md b/docs/matter-node.js/classes/exports_device.RootEndpoint.md index e0c137062b..e8fc9318a3 100644 --- a/docs/matter-node.js/classes/exports_device.RootEndpoint.md +++ b/docs/matter-node.js/classes/exports_device.RootEndpoint.md @@ -32,6 +32,7 @@ Root endpoint of a device. This is used internally and not needed to be instance - [addClusterClient](exports_device.RootEndpoint.md#addclusterclient) - [addClusterServer](exports_device.RootEndpoint.md#addclusterserver) - [addFixedLabel](exports_device.RootEndpoint.md#addfixedlabel) +- [addRootClusterClient](exports_device.RootEndpoint.md#addrootclusterclient) - [addUserLabel](exports_device.RootEndpoint.md#adduserlabel) - [destroy](exports_device.RootEndpoint.md#destroy) - [determineUniqueID](exports_device.RootEndpoint.md#determineuniqueid) @@ -45,6 +46,8 @@ Root endpoint of a device. This is used internally and not needed to be instance - [getClusterServerById](exports_device.RootEndpoint.md#getclusterserverbyid) - [getDeviceTypes](exports_device.RootEndpoint.md#getdevicetypes) - [getId](exports_device.RootEndpoint.md#getid) +- [getRootClusterClient](exports_device.RootEndpoint.md#getrootclusterclient) +- [getRootClusterServer](exports_device.RootEndpoint.md#getrootclusterserver) - [hasClusterClient](exports_device.RootEndpoint.md#hasclusterclient) - [hasClusterServer](exports_device.RootEndpoint.md#hasclusterserver) - [removeChildEndpoint](exports_device.RootEndpoint.md#removechildendpoint) @@ -251,6 +254,37 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:39 ___ +### addRootClusterClient + +▸ **addRootClusterClient**<`F`, `A`, `C`, `E`\>(`cluster`): `void` + +Add a cluster client to the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | +| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | +| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> | ClusterClient object to add | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:69 + +___ + ### addUserLabel ▸ **addUserLabel**(`label`, `value`): `void` @@ -542,6 +576,70 @@ packages/matter.js/dist/esm/device/Endpoint.d.ts:38 ___ +### getRootClusterClient + +▸ **getRootClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> + +Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | +| `SF` | extends [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<`F`\> | +| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | +| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`Cluster`](../modules/exports_cluster.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterClient to get or undefined if not existing | + +#### Returns + +`undefined` \| [`ClusterClientObj`](../modules/exports_cluster.md#clusterclientobj)<`F`, `A`, `C`, `E`\> + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:75 + +___ + +### getRootClusterServer + +▸ **getRootClusterServer**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> + +Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/exports_schema.md#bitschema) | +| `SF` | extends [`TypeFromPartialBitSchema`](../modules/exports_schema.md#typefrompartialbitschema)<`F`\> | +| `A` | extends [`Attributes`](../interfaces/exports_cluster.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/exports_cluster.Commands.md) | +| `E` | extends [`Events`](../interfaces/exports_cluster.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`Cluster`](../modules/exports_cluster.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterServer to get or undefined if not existing | + +#### Returns + +`undefined` \| [`ClusterServerObj`](../modules/exports_cluster.md#clusterserverobj)<`A`, `E`\> + +#### Defined in + +packages/matter.js/dist/esm/device/Device.d.ts:63 + +___ + ### hasClusterClient ▸ **hasClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `boolean` diff --git a/docs/matter-node.js/classes/exports_fabric.Fabric.md b/docs/matter-node.js/classes/exports_fabric.Fabric.md index ae627b832d..65187c20c8 100644 --- a/docs/matter-node.js/classes/exports_fabric.Fabric.md +++ b/docs/matter-node.js/classes/exports_fabric.Fabric.md @@ -401,6 +401,7 @@ ___ | Name | Type | | :------ | :------ | | `fabricId` | [`FabricId`](../modules/exports_datatype.md#fabricid) | +| `fabricIndex` | [`FabricIndex`](../modules/exports_datatype.md#fabricindex) | | `label` | `string` | | `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | | `rootNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | @@ -531,7 +532,13 @@ ___ ### remove -▸ **remove**(): `Promise`<`void`\> +▸ **remove**(`currentSessionId?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `currentSessionId?` | `number` | #### Returns diff --git a/docs/matter-node.js/classes/exports_fabric.FabricBuilder.md b/docs/matter-node.js/classes/exports_fabric.FabricBuilder.md index c09b9b2b2f..7f9490f4bc 100644 --- a/docs/matter-node.js/classes/exports_fabric.FabricBuilder.md +++ b/docs/matter-node.js/classes/exports_fabric.FabricBuilder.md @@ -57,7 +57,7 @@ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:87 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:88 ___ @@ -67,7 +67,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:92 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:93 ___ @@ -77,7 +77,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:91 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:92 ___ @@ -87,7 +87,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:85 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:86 ___ @@ -97,7 +97,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:82 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:83 ___ @@ -107,7 +107,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:93 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:94 ___ @@ -117,7 +117,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:88 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:89 ___ @@ -127,7 +127,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:86 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:87 ___ @@ -137,7 +137,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:84 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:85 ___ @@ -147,7 +147,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:89 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:90 ___ @@ -157,7 +157,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:90 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:91 ___ @@ -167,7 +167,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:83 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:84 ## Methods @@ -187,7 +187,7 @@ packages/matter.js/dist/esm/fabric/Fabric.d.ts:83 #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:108 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:109 ___ @@ -201,7 +201,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:96 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:97 ___ @@ -215,7 +215,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:107 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:108 ___ @@ -229,7 +229,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:95 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:96 ___ @@ -243,7 +243,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:106 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:107 ___ @@ -257,7 +257,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:94 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:95 ___ @@ -271,7 +271,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:98 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:99 ___ @@ -291,7 +291,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:104 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:105 ___ @@ -311,7 +311,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:105 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:106 ___ @@ -331,7 +331,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:103 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:104 ___ @@ -351,7 +351,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:100 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:101 ___ @@ -371,7 +371,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:99 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:100 ___ @@ -391,7 +391,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:97 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:98 ___ @@ -411,7 +411,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:102 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:103 ___ @@ -431,4 +431,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/Fabric.d.ts:101 +packages/matter.js/dist/esm/fabric/Fabric.d.ts:102 diff --git a/docs/matter-node.js/classes/exports_fabric.FabricManager.md b/docs/matter-node.js/classes/exports_fabric.FabricManager.md index 1217a35867..1cc2eac1c9 100644 --- a/docs/matter-node.js/classes/exports_fabric.FabricManager.md +++ b/docs/matter-node.js/classes/exports_fabric.FabricManager.md @@ -12,6 +12,7 @@ ### Properties +- [fabricRemoveCallback](exports_fabric.FabricManager.md#fabricremovecallback) - [fabricStorage](exports_fabric.FabricManager.md#fabricstorage) - [fabrics](exports_fabric.FabricManager.md#fabrics) - [nextFabricIndex](exports_fabric.FabricManager.md#nextfabricindex) @@ -31,27 +32,38 @@ ### constructor -• **new FabricManager**(`storage`) +• **new FabricManager**(`storage`, `fabricRemoveCallback?`) #### Parameters | Name | Type | | :------ | :------ | | `storage` | [`StorageContext`](storage_export.StorageContext.md) | +| `fabricRemoveCallback?` | (`fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex), `peerNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid)) => `void` | #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:20 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:22 ## Properties +### fabricRemoveCallback + +• `Private` `Optional` `Readonly` **fabricRemoveCallback**: `any` + +#### Defined in + +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:18 + +___ + ### fabricStorage • `Private` `Readonly` **fabricStorage**: `any` #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:19 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:21 ___ @@ -61,7 +73,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:18 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:20 ___ @@ -71,7 +83,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:17 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:19 ## Methods @@ -91,7 +103,7 @@ packages/matter.js/dist/esm/fabric/FabricManager.d.ts:17 #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:23 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:25 ___ @@ -112,7 +124,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:26 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:28 ___ @@ -126,7 +138,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:25 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:27 ___ @@ -140,7 +152,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:21 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:23 ___ @@ -154,7 +166,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:22 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:24 ___ @@ -174,7 +186,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:24 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:26 ___ @@ -194,7 +206,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:28 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:30 ___ @@ -214,4 +226,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/fabric/FabricManager.d.ts:27 +packages/matter.js/dist/esm/fabric/FabricManager.d.ts:29 diff --git a/docs/matter-node.js/classes/exports_interaction.InteractionClient.md b/docs/matter-node.js/classes/exports_interaction.InteractionClient.md index 54774da08e..8518b4f133 100644 --- a/docs/matter-node.js/classes/exports_interaction.InteractionClient.md +++ b/docs/matter-node.js/classes/exports_interaction.InteractionClient.md @@ -13,10 +13,13 @@ ### Properties - [exchangeProvider](exports_interaction.InteractionClient.md#exchangeprovider) +- [nodeId](exports_interaction.InteractionClient.md#nodeid) +- [ownSubscriptionIds](exports_interaction.InteractionClient.md#ownsubscriptionids) - [processReadRequest](exports_interaction.InteractionClient.md#processreadrequest) +- [registerSubscriptionUpdateTimer](exports_interaction.InteractionClient.md#registersubscriptionupdatetimer) - [subscribedClusterDataVersions](exports_interaction.InteractionClient.md#subscribedclusterdataversions) - [subscribedLocalValues](exports_interaction.InteractionClient.md#subscribedlocalvalues) -- [subscriptionListeners](exports_interaction.InteractionClient.md#subscriptionlisteners) +- [subscriptionClient](exports_interaction.InteractionClient.md#subscriptionclient) - [withMessenger](exports_interaction.InteractionClient.md#withmessenger) ### Accessors @@ -25,6 +28,7 @@ ### Methods +- [close](exports_interaction.InteractionClient.md#close) - [getAllAttributes](exports_interaction.InteractionClient.md#getallattributes) - [getAllAttributesAndEvents](exports_interaction.InteractionClient.md#getallattributesandevents) - [getAllEvents](exports_interaction.InteractionClient.md#getallevents) @@ -36,6 +40,8 @@ - [getMultipleEvents](exports_interaction.InteractionClient.md#getmultipleevents) - [invoke](exports_interaction.InteractionClient.md#invoke) - [invokeWithSuppressedResponse](exports_interaction.InteractionClient.md#invokewithsuppressedresponse) +- [registerSubscriptionListener](exports_interaction.InteractionClient.md#registersubscriptionlistener) +- [removeSubscription](exports_interaction.InteractionClient.md#removesubscription) - [setAttribute](exports_interaction.InteractionClient.md#setattribute) - [setMultipleAttributes](exports_interaction.InteractionClient.md#setmultipleattributes) - [subscribeAllAttributesAndEvents](exports_interaction.InteractionClient.md#subscribeallattributesandevents) @@ -47,17 +53,18 @@ ### constructor -• **new InteractionClient**(`exchangeProvider`) +• **new InteractionClient**(`exchangeProvider`, `nodeId`) #### Parameters | Name | Type | | :------ | :------ | | `exchangeProvider` | [`ExchangeProvider`](exports_protocol.ExchangeProvider.md) | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:41 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:50 ## Properties @@ -67,7 +74,27 @@ packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:41 #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:37 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:44 + +___ + +### nodeId + +• `Readonly` **nodeId**: [`NodeId`](../modules/exports_datatype.md#nodeid) + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:45 + +___ + +### ownSubscriptionIds + +• `Private` `Readonly` **ownSubscriptionIds**: `any` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:48 ___ @@ -77,7 +104,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:134 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:145 + +___ + +### registerSubscriptionUpdateTimer + +• `Private` **registerSubscriptionUpdateTimer**: `any` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:260 ___ @@ -87,7 +124,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:40 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:47 ___ @@ -97,17 +134,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:39 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:46 ___ -### subscriptionListeners +### subscriptionClient -• `Private` `Readonly` **subscriptionListeners**: `any` +• `Private` `Readonly` **subscriptionClient**: `any` #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:38 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:49 ___ @@ -117,7 +154,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:244 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:259 ## Accessors @@ -131,10 +168,24 @@ packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:244 #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:245 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:262 ## Methods +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:261 + +___ + ### getAllAttributes ▸ **getAllAttributes**(`options?`): `Promise`<[`DecodedAttributeReportValue`](../modules/exports_interaction.md#decodedattributereportvalue)<`any`\>[]\> @@ -153,7 +204,7 @@ packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:245 #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:42 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:53 ___ @@ -176,7 +227,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:54 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:65 ___ @@ -198,7 +249,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:50 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:61 ___ @@ -229,7 +280,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:110 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:121 ___ @@ -260,7 +311,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:117 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:128 ___ @@ -292,7 +343,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:127 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:138 ___ @@ -315,7 +366,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:66 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:77 ___ @@ -340,7 +391,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:88 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:99 ___ @@ -363,7 +414,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:79 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:90 ___ @@ -396,7 +447,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:227 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:242 ___ @@ -428,7 +479,48 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:236 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:251 + +___ + +### registerSubscriptionListener + +▸ **registerSubscriptionListener**(`subscriptionId`, `listener`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | +| `listener` | (`dataReport`: [`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeReports`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeData`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `data`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TlvStream`](../modules/exports_tlv.md#tlvstream)\> ; `dataVersion`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number`\> ; `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`AttributeId`](../modules/exports_datatype.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> }\>\> ; `attributeStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`AttributeId`](../modules/exports_datatype.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `eventReports`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `eventData`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `data`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TlvStream`](../modules/exports_tlv.md#tlvstream)\> ; `deltaEpochTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `deltaSystemTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `epochTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `eventNumber`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number` \| `bigint`\> ; `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EventId`](../modules/exports_datatype.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `priority`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`EventPriority`](../enums/exports_cluster.EventPriority.md)\> ; `systemTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> }\>\> ; `eventStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EventId`](../modules/exports_datatype.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `interactionModelRevision`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> ; `moreChunkedMessages`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `subscriptionId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number`\> ; `suppressResponse`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> }\>) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:51 + +___ + +### removeSubscription + +▸ **removeSubscription**(`subscriptionId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:52 ___ @@ -463,7 +555,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:135 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:146 ___ @@ -487,7 +579,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:147 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:158 ___ @@ -509,6 +601,7 @@ ___ | `options.keepSubscriptions?` | `boolean` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/time_export.md#timercallback) | #### Returns @@ -516,7 +609,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:181 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:194 ___ @@ -544,6 +637,7 @@ ___ | `options.listener?` | (`value`: [`AttributeJsType`](../modules/exports_cluster.md#attributejstype)<`A`\>, `version`: `number`) => `void` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/time_export.md#timercallback) | #### Returns @@ -551,7 +645,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:159 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:170 ___ @@ -580,6 +674,7 @@ ___ | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | | `options.minimumEventNumber?` | `number` \| `bigint` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/time_export.md#timercallback) | #### Returns @@ -587,7 +682,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:170 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:182 ___ @@ -610,6 +705,7 @@ ___ | `options.keepSubscriptions?` | `boolean` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/time_export.md#timercallback) | #### Returns @@ -617,4 +713,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:199 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:213 diff --git a/docs/matter-node.js/classes/exports_interaction.InteractionServer.md b/docs/matter-node.js/classes/exports_interaction.InteractionServer.md index 3fee251347..764e02f3cd 100644 --- a/docs/matter-node.js/classes/exports_interaction.InteractionServer.md +++ b/docs/matter-node.js/classes/exports_interaction.InteractionServer.md @@ -133,6 +133,10 @@ packages/matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:69 `Promise`<`void`\> +#### Implementation of + +[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[close](../interfaces/exports_protocol.ProtocolHandler.md#close) + #### Defined in packages/matter.js/dist/esm/protocol/interaction/InteractionServer.d.ts:80 diff --git a/docs/matter-node.js/classes/exports_interaction.SubscriptionClient.md b/docs/matter-node.js/classes/exports_interaction.SubscriptionClient.md index 582bc10a58..21e877237a 100644 --- a/docs/matter-node.js/classes/exports_interaction.SubscriptionClient.md +++ b/docs/matter-node.js/classes/exports_interaction.SubscriptionClient.md @@ -17,27 +17,27 @@ ### Properties - [subscriptionListeners](exports_interaction.SubscriptionClient.md#subscriptionlisteners) +- [subscriptionUpdateTimers](exports_interaction.SubscriptionClient.md#subscriptionupdatetimers) ### Methods +- [close](exports_interaction.SubscriptionClient.md#close) - [getId](exports_interaction.SubscriptionClient.md#getid) - [onNewExchange](exports_interaction.SubscriptionClient.md#onnewexchange) +- [registerSubscriptionListener](exports_interaction.SubscriptionClient.md#registersubscriptionlistener) +- [registerSubscriptionUpdateTimer](exports_interaction.SubscriptionClient.md#registersubscriptionupdatetimer) +- [removeSubscriptionListener](exports_interaction.SubscriptionClient.md#removesubscriptionlistener) +- [removeSubscriptionUpdateTimer](exports_interaction.SubscriptionClient.md#removesubscriptionupdatetimer) ## Constructors ### constructor -• **new SubscriptionClient**(`subscriptionListeners`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `subscriptionListeners` | `Map`<`number`, (`dataReport`: [`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeReports`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeData`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `data`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TlvStream`](../modules/exports_tlv.md#tlvstream)\> ; `dataVersion`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number`\> ; `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`AttributeId`](../modules/exports_datatype.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> }\>\> ; `attributeStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`AttributeId`](../modules/exports_datatype.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `eventReports`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `eventData`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `data`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TlvStream`](../modules/exports_tlv.md#tlvstream)\> ; `deltaEpochTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `deltaSystemTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `epochTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `eventNumber`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number` \| `bigint`\> ; `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EventId`](../modules/exports_datatype.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `priority`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`EventPriority`](../enums/exports_cluster.EventPriority.md)\> ; `systemTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> }\>\> ; `eventStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EventId`](../modules/exports_datatype.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `interactionModelRevision`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> ; `moreChunkedMessages`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `subscriptionId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number`\> ; `suppressResponse`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> }\>) => `void`\> | +• **new SubscriptionClient**() #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:32 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:34 ## Properties @@ -47,10 +47,38 @@ packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:32 #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:31 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:32 + +___ + +### subscriptionUpdateTimers + +• `Private` `Readonly` **subscriptionUpdateTimers**: `any` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:33 ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[close](../interfaces/exports_protocol.ProtocolHandler.md#close) + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:41 + +___ + ### getId ▸ **getId**(): `number` @@ -65,7 +93,7 @@ packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:31 #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:33 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:35 ___ @@ -89,4 +117,86 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:34 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:40 + +___ + +### registerSubscriptionListener + +▸ **registerSubscriptionListener**(`subscriptionId`, `listener`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | +| `listener` | (`dataReport`: [`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeReports`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeData`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `data`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TlvStream`](../modules/exports_tlv.md#tlvstream)\> ; `dataVersion`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number`\> ; `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`AttributeId`](../modules/exports_datatype.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> }\>\> ; `attributeStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`AttributeId`](../modules/exports_datatype.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `eventReports`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `eventData`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `data`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TlvStream`](../modules/exports_tlv.md#tlvstream)\> ; `deltaEpochTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `deltaSystemTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `epochTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> ; `eventNumber`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number` \| `bigint`\> ; `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EventId`](../modules/exports_datatype.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `priority`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`EventPriority`](../enums/exports_cluster.EventPriority.md)\> ; `systemTimestamp`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number` \| `bigint`\> }\>\> ; `eventStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`ClusterId`](../modules/exports_datatype.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EndpointNumber`](../modules/exports_datatype.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`EventId`](../modules/exports_datatype.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`NodeId`](../modules/exports_datatype.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<[`StatusCode`](../enums/exports_interaction.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `interactionModelRevision`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> ; `moreChunkedMessages`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> ; `subscriptionId`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`number`\> ; `suppressResponse`: [`OptionalFieldType`](../interfaces/exports_tlv.OptionalFieldType.md)<`boolean`\> }\>) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:36 + +___ + +### registerSubscriptionUpdateTimer + +▸ **registerSubscriptionUpdateTimer**(`subscriptionId`, `timer`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | +| `timer` | [`Timer`](../interfaces/time_export.Timer.md) | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:38 + +___ + +### removeSubscriptionListener + +▸ **removeSubscriptionListener**(`subscriptionId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:37 + +___ + +### removeSubscriptionUpdateTimer + +▸ **removeSubscriptionUpdateTimer**(`subscriptionId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:39 diff --git a/docs/matter-node.js/classes/exports_log.Logger.md b/docs/matter-node.js/classes/exports_log.Logger.md index 901b5c76a1..53c1bc1fbf 100644 --- a/docs/matter-node.js/classes/exports_log.Logger.md +++ b/docs/matter-node.js/classes/exports_log.Logger.md @@ -44,6 +44,7 @@ Logger.format = Format.ANSI enables colorization via ANSI escape sequences in de - [dict](exports_log.Logger.md#dict) - [get](exports_log.Logger.md#get) +- [maskString](exports_log.Logger.md#maskstring) - [nest](exports_log.Logger.md#nest) - [nestAsync](exports_log.Logger.md#nestasync) - [toJSON](exports_log.Logger.md#tojson) @@ -62,7 +63,7 @@ Logger.format = Format.ANSI enables colorization via ANSI escape sequences in de #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:116 +packages/matter.js/dist/esm/log/Logger.d.ts:125 ## Properties @@ -86,7 +87,7 @@ packages/matter.js/dist/esm/log/Logger.d.ts:116 #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:117 +packages/matter.js/dist/esm/log/Logger.d.ts:126 ___ @@ -110,7 +111,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:120 +packages/matter.js/dist/esm/log/Logger.d.ts:129 ___ @@ -134,7 +135,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:121 +packages/matter.js/dist/esm/log/Logger.d.ts:130 ___ @@ -158,7 +159,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:118 +packages/matter.js/dist/esm/log/Logger.d.ts:127 ___ @@ -168,7 +169,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:122 +packages/matter.js/dist/esm/log/Logger.d.ts:131 ___ @@ -202,7 +203,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:119 +packages/matter.js/dist/esm/log/Logger.d.ts:128 ___ @@ -332,7 +333,7 @@ Shortcut for new DiagnosticDictionary(). #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:104 +packages/matter.js/dist/esm/log/Logger.d.ts:113 ___ @@ -360,6 +361,31 @@ packages/matter.js/dist/esm/log/Logger.d.ts:91 ___ +### maskString + +▸ `Static` **maskString**(`str`, `maskChar?`, `unmaskedLength?`): `string` + +Mask a string with a given character. If unmaskedLength is provided then these number of characters will be +shown unmasked. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `str` | `string` | String to mask | +| `maskChar?` | `string` | character to mask with | +| `unmaskedLength?` | `number` | number of characters to show unmasked in the beginning | + +#### Returns + +`string` + +#### Defined in + +packages/matter.js/dist/esm/log/Logger.d.ts:107 + +___ + ### nest ▸ `Static` **nest**<`T`\>(`context`): `T` @@ -385,7 +411,7 @@ indented while the context executes. #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:111 +packages/matter.js/dist/esm/log/Logger.d.ts:120 ___ @@ -407,7 +433,7 @@ Async version of nest(). #### Defined in -packages/matter.js/dist/esm/log/Logger.d.ts:115 +packages/matter.js/dist/esm/log/Logger.d.ts:124 ___ diff --git a/docs/matter-node.js/classes/exports_mdns.MdnsBroadcaster.md b/docs/matter-node.js/classes/exports_mdns.MdnsBroadcaster.md index 9d5814f202..213ee53b0e 100644 --- a/docs/matter-node.js/classes/exports_mdns.MdnsBroadcaster.md +++ b/docs/matter-node.js/classes/exports_mdns.MdnsBroadcaster.md @@ -17,6 +17,7 @@ This class is handing MDNS Announcements for multiple instances/devices - [activeCommissioningAnnouncements](exports_mdns.MdnsBroadcaster.md#activecommissioningannouncements) - [activeOperationalAnnouncements](exports_mdns.MdnsBroadcaster.md#activeoperationalannouncements) - [enableIpv4](exports_mdns.MdnsBroadcaster.md#enableipv4) +- [getIpRecords](exports_mdns.MdnsBroadcaster.md#getiprecords) - [mdnsServer](exports_mdns.MdnsBroadcaster.md#mdnsserver) - [network](exports_mdns.MdnsBroadcaster.md#network) @@ -82,6 +83,16 @@ packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:15 ___ +### getIpRecords + +• `Private` **getIpRecords**: `any` + +#### Defined in + +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:25 + +___ + ### mdnsServer • `Private` `Readonly` **mdnsServer**: `any` @@ -118,7 +129,7 @@ packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:20 #### Defined in -packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:31 +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:32 ___ @@ -132,7 +143,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:35 +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:36 ___ @@ -152,7 +163,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:34 +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:35 ___ @@ -172,7 +183,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:33 +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:34 ___ @@ -192,7 +203,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:32 +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:33 ___ @@ -216,7 +227,7 @@ Set the Broadcaster data to announce a device ready for commissioning in a speci #### Defined in -packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:26 +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:27 ___ @@ -239,7 +250,7 @@ Set the Broadcaster data to announce a Commissioner (aka Commissioner discovery) #### Defined in -packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:30 +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:31 ___ @@ -263,7 +274,7 @@ Set the Broadcaster Data to announce a device for operative discovery (aka "alre #### Defined in -packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:28 +packages/matter.js/dist/esm/mdns/MdnsBroadcaster.d.ts:29 ___ diff --git a/docs/matter-node.js/classes/exports_mdns.MdnsScanner.md b/docs/matter-node.js/classes/exports_mdns.MdnsScanner.md index aa4bf64ffa..c5d887450d 100644 --- a/docs/matter-node.js/classes/exports_mdns.MdnsScanner.md +++ b/docs/matter-node.js/classes/exports_mdns.MdnsScanner.md @@ -21,19 +21,23 @@ It sends out queries to discover various types of Matter device types and listen - [activeAnnounceQueries](exports_mdns.MdnsScanner.md#activeannouncequeries) - [buildCommissionableQueryIdentifier](exports_mdns.MdnsScanner.md#buildcommissionablequeryidentifier) +- [closing](exports_mdns.MdnsScanner.md#closing) - [commissionableDeviceRecords](exports_mdns.MdnsScanner.md#commissionabledevicerecords) - [createOperationalMatterQName](exports_mdns.MdnsScanner.md#createoperationalmatterqname) - [enableIpv4](exports_mdns.MdnsScanner.md#enableipv4) - [expire](exports_mdns.MdnsScanner.md#expire) +- [extractInstanceId](exports_mdns.MdnsScanner.md#extractinstanceid) - [findCommissionableQueryIdentifier](exports_mdns.MdnsScanner.md#findcommissionablequeryidentifier) - [finishWaiter](exports_mdns.MdnsScanner.md#finishwaiter) - [getActiveQueryEarlierAnswers](exports_mdns.MdnsScanner.md#getactivequeryearlieranswers) - [getCommissionableDeviceRecords](exports_mdns.MdnsScanner.md#getcommissionabledevicerecords) +- [getCommissionableQueryRecords](exports_mdns.MdnsScanner.md#getcommissionablequeryrecords) - [getOperationalDeviceRecords](exports_mdns.MdnsScanner.md#getoperationaldevicerecords) - [handleCommissionableRecords](exports_mdns.MdnsScanner.md#handlecommissionablerecords) - [handleDnsMessage](exports_mdns.MdnsScanner.md#handlednsmessage) - [handleIpRecords](exports_mdns.MdnsScanner.md#handleiprecords) - [handleOperationalSrvRecord](exports_mdns.MdnsScanner.md#handleoperationalsrvrecord) +- [hasWaiter](exports_mdns.MdnsScanner.md#haswaiter) - [multicastServer](exports_mdns.MdnsScanner.md#multicastserver) - [nextAnnounceIntervalSeconds](exports_mdns.MdnsScanner.md#nextannounceintervalseconds) - [operationalDeviceRecords](exports_mdns.MdnsScanner.md#operationaldevicerecords) @@ -49,9 +53,11 @@ It sends out queries to discover various types of Matter device types and listen ### Methods +- [cancelCommissionableDeviceDiscovery](exports_mdns.MdnsScanner.md#cancelcommissionabledevicediscovery) +- [cancelOperationalDeviceDiscovery](exports_mdns.MdnsScanner.md#canceloperationaldevicediscovery) - [close](exports_mdns.MdnsScanner.md#close) -- [extractInstanceId](exports_mdns.MdnsScanner.md#extractinstanceid) - [findCommissionableDevices](exports_mdns.MdnsScanner.md#findcommissionabledevices) +- [findCommissionableDevicesContinuously](exports_mdns.MdnsScanner.md#findcommissionabledevicescontinuously) - [findOperationalDevice](exports_mdns.MdnsScanner.md#findoperationaldevice) - [getDiscoveredCommissionableDevices](exports_mdns.MdnsScanner.md#getdiscoveredcommissionabledevices) - [getDiscoveredOperationalDevices](exports_mdns.MdnsScanner.md#getdiscoveredoperationaldevices) @@ -72,7 +78,7 @@ It sends out queries to discover various types of Matter device types and listen #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:29 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:30 ## Properties @@ -95,7 +101,17 @@ Some identifiers are identical to the official DNS-SD identifiers, others are cu #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:85 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:90 + +___ + +### closing + +• `Private` **closing**: `any` + +#### Defined in + +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:29 ___ @@ -115,7 +131,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:69 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:72 ___ @@ -135,7 +151,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:132 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:146 + +___ + +### extractInstanceId + +• `Private` **extractInstanceId**: `any` + +#### Defined in + +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:91 ___ @@ -147,7 +173,7 @@ Check all options for a query identifier and return the most relevant one with a #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:90 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:95 ___ @@ -160,7 +186,7 @@ promise. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:68 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:69 ___ @@ -170,7 +196,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:43 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:44 ___ @@ -183,7 +209,17 @@ record. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:80 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:85 + +___ + +### getCommissionableQueryRecords + +• `Private` **getCommissionableQueryRecords**: `any` + +#### Defined in + +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:96 ___ @@ -195,7 +231,7 @@ Returns the list of all targets (IP/port) discovered for a queried operational d #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:52 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:53 ___ @@ -205,7 +241,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:130 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:144 ___ @@ -218,7 +254,7 @@ It will parse the message and check if it contains relevant discovery records. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:127 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:141 ___ @@ -228,7 +264,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:128 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:142 ___ @@ -238,7 +274,19 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:129 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:143 + +___ + +### hasWaiter + +• `Private` **hasWaiter**: `any` + +Returns weather a waiter promise is registered for a specific queryId. + +#### Defined in + +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:71 ___ @@ -278,7 +326,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:131 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:145 ___ @@ -321,7 +369,7 @@ The promise will be resolved when the timer runs out latest. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:63 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:64 ___ @@ -334,7 +382,7 @@ out. If it was the last query announcing will stop completely. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:48 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:49 ___ @@ -349,7 +397,7 @@ packets and the query is sent as Truncated query. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:37 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:38 ___ @@ -362,7 +410,7 @@ out. When entry already exists the query is overwritten and answers are always a #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:42 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:43 ___ @@ -376,10 +424,58 @@ Sort the list of found IP/ports and make sure link-local IPv6 addresses come fir #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:58 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:59 ## Methods +### cancelCommissionableDeviceDiscovery + +▸ **cancelCommissionableDeviceDiscovery**(`identifier`): `void` + +Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would +be over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Implementation of + +[Scanner](../interfaces/exports_common.Scanner.md).[cancelCommissionableDeviceDiscovery](../interfaces/exports_common.Scanner.md#cancelcommissionabledevicediscovery) + +#### Defined in + +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:79 + +___ + +### cancelOperationalDeviceDiscovery + +▸ **cancelOperationalDeviceDiscovery**(`fabric`, `nodeId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](exports_fabric.Fabric.md) | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:78 + +___ + ### close ▸ **close**(): `Promise`<`void`\> @@ -396,46 +492,55 @@ Close all connects, end all timers and resolve all pending promises. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:122 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:136 ___ -### extractInstanceId +### findCommissionableDevices -▸ **extractInstanceId**(`instanceName`): `string` +▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> + +Discovers commissionable devices based on a defined identifier for maximal given timeout, but returns the +first found entries. If already a discovered device matches in the cache the response is returned directly and +no query is triggered. If no record exists a query is sent out and the promise gets fulfilled as soon as at least +one device is found. If no device is discovered in the defined timeframe an empty array is returned. When the +promise got fulfilled no more queries are send out, but more device entries might be added when discovered later. +These can be requested by the getCommissionableDevices method. #### Parameters | Name | Type | | :------ | :------ | -| `instanceName` | `string` | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | +| `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | #### Returns -`string` +`Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> + +#### Implementation of + +[Scanner](../interfaces/exports_common.Scanner.md).[findCommissionableDevices](../interfaces/exports_common.Scanner.md#findcommissionabledevices) #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:86 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:105 ___ -### findCommissionableDevices +### findCommissionableDevicesContinuously -▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> +▸ **findCommissionableDevicesContinuously**(`identifier`, `callback`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> -Discovers commissionalble devices based on a defined identifier. If an already discovered device matched the -query it is returned directly and no query is triggered. This works because the commissionable device records -that are announced into the network are always stored already. If no record can be found a query is registered -and sent out and the promise gets fulfilled as soon as one device is found. More might be added later and can -be requested ny the getCommissionableDevices method. If no device is discovered the promise is fulfilled after -the timeout period. +Discovers commissionable devices based on a defined identifier and returns the first found entries. If already a #### Parameters | Name | Type | | :------ | :------ | | `identifier` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | +| `callback` | (`device`: [`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)) => `void` | | `timeoutSeconds?` | `number` | #### Returns @@ -444,17 +549,17 @@ the timeout period. #### Implementation of -[Scanner](../interfaces/exports_common.Scanner.md).[findCommissionableDevices](../interfaces/exports_common.Scanner.md#findcommissionabledevices) +[Scanner](../interfaces/exports_common.Scanner.md).[findCommissionableDevicesContinuously](../interfaces/exports_common.Scanner.md#findcommissionabledevicescontinuously) #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:99 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:112 ___ ### findOperationalDevice -▸ **findOperationalDevice**(`«destructured»`, `nodeId`, `timeoutSeconds?`): `Promise`<[`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[]\> +▸ **findOperationalDevice**(`«destructured»`, `nodeId`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[]\> Method to find an operational device (already commissioned) and return a promise with the list of discovered IP/ports or an empty array if not found. @@ -466,6 +571,7 @@ IP/ports or an empty array if not found. | `«destructured»` | [`Fabric`](exports_fabric.Fabric.md) | | `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | | `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | #### Returns @@ -477,13 +583,13 @@ IP/ports or an empty array if not found. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:74 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:77 ___ ### getDiscoveredCommissionableDevices -▸ **getDiscoveredCommissionableDevices**(`identifier`): { `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[] ; `expires`: `undefined` ; `instanceId`: `string` }[] +▸ **getDiscoveredCommissionableDevices**(`identifier`): { `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[] ; `deviceIdentifier`: `string` ; `expires`: `undefined` ; `instanceId`: `string` }[] Return already discovered commissionable devices and return them. Does not send out new DNS-SD queries. @@ -495,7 +601,7 @@ Return already discovered commissionable devices and return them. Does not send #### Returns -{ `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[] ; `expires`: `undefined` ; `instanceId`: `string` }[] +{ `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[] ; `deviceIdentifier`: `string` ; `expires`: `undefined` ; `instanceId`: `string` }[] #### Implementation of @@ -503,7 +609,7 @@ Return already discovered commissionable devices and return them. Does not send #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:100 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:113 ___ @@ -531,7 +637,7 @@ DNS-SD queries. #### Defined in -packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:75 +packages/matter.js/dist/esm/mdns/MdnsScanner.d.ts:80 ___ diff --git a/docs/matter-node.js/classes/exports_protocol.ChannelManager.md b/docs/matter-node.js/classes/exports_protocol.ChannelManager.md index 0a655d446d..8f97b60cca 100644 --- a/docs/matter-node.js/classes/exports_protocol.ChannelManager.md +++ b/docs/matter-node.js/classes/exports_protocol.ChannelManager.md @@ -14,6 +14,7 @@ - [channels](exports_protocol.ChannelManager.md#channels) - [getChannelKey](exports_protocol.ChannelManager.md#getchannelkey) +- [getOrCreateAsPaseChannel](exports_protocol.ChannelManager.md#getorcreateaspasechannel) - [paseChannels](exports_protocol.ChannelManager.md#pasechannels) ### Methods @@ -53,6 +54,16 @@ packages/matter.js/dist/esm/protocol/ChannelManager.d.ts:18 ___ +### getOrCreateAsPaseChannel + +• `Private` **getOrCreateAsPaseChannel**: `any` + +#### Defined in + +packages/matter.js/dist/esm/protocol/ChannelManager.d.ts:23 + +___ + ### paseChannels • `Private` `Readonly` **paseChannels**: `any` @@ -73,7 +84,7 @@ packages/matter.js/dist/esm/protocol/ChannelManager.d.ts:17 #### Defined in -packages/matter.js/dist/esm/protocol/ChannelManager.d.ts:24 +packages/matter.js/dist/esm/protocol/ChannelManager.d.ts:25 ___ @@ -120,7 +131,7 @@ ___ ### getOrCreateChannel -▸ **getOrCreateChannel**(`byteArrayChannel`, `session`): [`MessageChannel`](exports_protocol.MessageChannel.md)<`any`\> +▸ **getOrCreateChannel**(`byteArrayChannel`, `session`): `Promise`<[`MessageChannel`](exports_protocol.MessageChannel.md)<`any`\>\> #### Parameters @@ -131,17 +142,17 @@ ___ #### Returns -[`MessageChannel`](exports_protocol.MessageChannel.md)<`any`\> +`Promise`<[`MessageChannel`](exports_protocol.MessageChannel.md)<`any`\>\> #### Defined in -packages/matter.js/dist/esm/protocol/ChannelManager.d.ts:23 +packages/matter.js/dist/esm/protocol/ChannelManager.d.ts:24 ___ ### removeChannel -▸ **removeChannel**(`fabric`, `nodeId`): `void` +▸ **removeChannel**(`fabric`, `nodeId`): `Promise`<`void`\> #### Parameters @@ -152,7 +163,7 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Defined in @@ -162,7 +173,7 @@ ___ ### setChannel -▸ **setChannel**(`fabric`, `nodeId`, `channel`): `void` +▸ **setChannel**(`fabric`, `nodeId`, `channel`): `Promise`<`void`\> #### Parameters @@ -174,7 +185,7 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Defined in diff --git a/docs/matter-node.js/classes/exports_protocol.ControllerCommissioner.md b/docs/matter-node.js/classes/exports_protocol.ControllerCommissioner.md index 4578b9209f..ae823c217f 100644 --- a/docs/matter-node.js/classes/exports_protocol.ControllerCommissioner.md +++ b/docs/matter-node.js/classes/exports_protocol.ControllerCommissioner.md @@ -14,6 +14,7 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp ### Properties +- [adminVendorId](exports_protocol.ControllerCommissioner.md#adminvendorid) - [armFailsafe](exports_protocol.ControllerCommissioner.md#armfailsafe) - [certificateManager](exports_protocol.ControllerCommissioner.md#certificatemanager) - [certificates](exports_protocol.ControllerCommissioner.md#certificates) @@ -31,6 +32,7 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp - [configureRegulatoryInformation](exports_protocol.ControllerCommissioner.md#configureregulatoryinformation) - [deviceAttestation](exports_protocol.ControllerCommissioner.md#deviceattestation) - [ensureGeneralCommissioningSuccess](exports_protocol.ControllerCommissioner.md#ensuregeneralcommissioningsuccess) +- [ensureOperationalCredentialsSuccess](exports_protocol.ControllerCommissioner.md#ensureoperationalcredentialssuccess) - [fabric](exports_protocol.ControllerCommissioner.md#fabric) - [failSafeTimeMs](exports_protocol.ControllerCommissioner.md#failsafetimems) - [getClusterClient](exports_protocol.ControllerCommissioner.md#getclusterclient) @@ -39,6 +41,7 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp - [interactionClient](exports_protocol.ControllerCommissioner.md#interactionclient) - [lastBreadcrumb](exports_protocol.ControllerCommissioner.md#lastbreadcrumb) - [lastFailSafeTime](exports_protocol.ControllerCommissioner.md#lastfailsafetime) +- [nodeId](exports_protocol.ControllerCommissioner.md#nodeid) - [reconnectWithDevice](exports_protocol.ControllerCommissioner.md#reconnectwithdevice) - [reconnectWithDeviceCallback](exports_protocol.ControllerCommissioner.md#reconnectwithdevicecallback) - [resetFailsafeTimer](exports_protocol.ControllerCommissioner.md#resetfailsafetimer) @@ -56,7 +59,7 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp ### constructor -• **new ControllerCommissioner**(`interactionClient`, `certificateManager`, `fabric`, `commissioningOptions`, `reconnectWithDeviceCallback`) +• **new ControllerCommissioner**(`interactionClient`, `certificateManager`, `fabric`, `commissioningOptions`, `nodeId`, `adminVendorId`, `reconnectWithDeviceCallback`) #### Parameters @@ -66,14 +69,26 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp | `certificateManager` | [`RootCertificateManager`](exports_certificate.RootCertificateManager.md) | | `fabric` | [`Fabric`](exports_fabric.Fabric.md) | | `commissioningOptions` | [`CommissioningOptions`](../modules/exports_protocol.md#commissioningoptions) | -| `reconnectWithDeviceCallback` | (`peerNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid)) => `Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `adminVendorId` | [`VendorId`](../modules/exports_datatype.md#vendorid) | +| `reconnectWithDeviceCallback` | () => `Promise`<[`InteractionClient`](exports_interaction.InteractionClient.md)\> | #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:65 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:70 ## Properties +### adminVendorId + +• `Private` `Readonly` **adminVendorId**: `any` + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:59 + +___ + ### armFailsafe • `Private` **armFailsafe**: `any` @@ -88,7 +103,7 @@ invoking the ArmFailSafe command. #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:99 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:106 ___ @@ -98,7 +113,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:52 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:55 ___ @@ -119,7 +134,7 @@ the Commissionee using the AddTrustedRootCertificate and AddNOC commands. #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:137 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:144 ___ @@ -129,7 +144,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:58 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:63 ___ @@ -139,7 +154,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:63 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:68 ___ @@ -149,7 +164,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:60 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:65 ___ @@ -159,7 +174,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:54 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:57 ___ @@ -169,7 +184,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:59 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:64 ___ @@ -179,7 +194,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:57 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:62 ___ @@ -189,7 +204,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:56 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:61 ___ @@ -205,7 +220,7 @@ the commissioning process. #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:178 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:185 ___ @@ -221,7 +236,7 @@ its desired access control policies. #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:145 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:152 ___ @@ -231,7 +246,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:160 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:167 ___ @@ -241,7 +256,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:159 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:166 ___ @@ -258,7 +273,7 @@ The regulatory information is configured using SetRegulatoryConfig (see Section #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:109 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:116 ___ @@ -272,7 +287,7 @@ Commissioner SHALL establish the authenticity of the Commissionee as a certified #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:124 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:131 ___ @@ -284,7 +299,19 @@ Helper method to check for errorCode/debugTest responses and throw error on fail #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:85 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:92 + +___ + +### ensureOperationalCredentialsSuccess + +• `Private` **ensureOperationalCredentialsSuccess**: `any` + +Helper method to check for errorCode/debugTest responses and throw error on failure + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:90 ___ @@ -294,7 +321,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:53 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:56 ___ @@ -304,7 +331,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:64 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:69 ___ @@ -316,7 +343,7 @@ Helper method to create ClusterClients. If not feature specific and for the Root #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:69 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:74 ___ @@ -328,7 +355,7 @@ Initial Step to receive some common data used by other steps #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:89 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:96 ___ @@ -340,7 +367,7 @@ Initialize commissioning steps and add them in the default order #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:73 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:78 ___ @@ -350,7 +377,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:51 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:54 ___ @@ -360,7 +387,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:62 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:67 ___ @@ -370,7 +397,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:61 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:66 + +___ + +### nodeId + +• `Private` `Readonly` **nodeId**: `any` + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:58 ___ @@ -387,7 +424,7 @@ the Commissioner itself, or another Node to which the Commissioner has delegated #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:170 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:177 ___ @@ -397,7 +434,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:55 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:60 ___ @@ -407,7 +444,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:100 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:107 ___ @@ -417,7 +454,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:82 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:87 ___ @@ -427,7 +464,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:81 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:86 ___ @@ -444,7 +481,7 @@ command (see Section 11.16.9.1, “SetUtcTime Command”) while timezone and DST #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:118 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:125 ___ @@ -465,7 +502,7 @@ command (see Section 11.8.7.9, “ConnectNetwork Command”) unless the Commissi #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:158 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:165 ## Methods @@ -476,7 +513,7 @@ packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:158 Execute the commissioning process in the defined order. The steps are sorted before execution based on the step number and sub step number. If >50% of the failsafe time has passed, the failsafe timer is re-armed (50% of 60s default are 30s and each -action is allowed to take 30s at minimum based on specs) +action is allowed to take 30s at minimum based on specs). #### Returns @@ -484,7 +521,7 @@ action is allowed to take 30s at minimum based on specs) #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:80 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:85 ___ @@ -505,4 +542,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:83 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:88 diff --git a/docs/matter-node.js/classes/exports_protocol.ControllerDiscovery.md b/docs/matter-node.js/classes/exports_protocol.ControllerDiscovery.md new file mode 100644 index 0000000000..4d540a89ed --- /dev/null +++ b/docs/matter-node.js/classes/exports_protocol.ControllerDiscovery.md @@ -0,0 +1,179 @@ +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/protocol](../modules/exports_protocol.md) / ControllerDiscovery + +# Class: ControllerDiscovery + +[exports/protocol](../modules/exports_protocol.md).ControllerDiscovery + +## Table of contents + +### Constructors + +- [constructor](exports_protocol.ControllerDiscovery.md#constructor) + +### Methods + +- [cancelCommissionableDeviceDiscovery](exports_protocol.ControllerDiscovery.md#cancelcommissionabledevicediscovery) +- [cancelOperationalDeviceDiscovery](exports_protocol.ControllerDiscovery.md#canceloperationaldevicediscovery) +- [discoverCommissionableDevices](exports_protocol.ControllerDiscovery.md#discovercommissionabledevices) +- [discoverDeviceAddressesByIdentifier](exports_protocol.ControllerDiscovery.md#discoverdeviceaddressesbyidentifier) +- [discoverOperationalDevice](exports_protocol.ControllerDiscovery.md#discoveroperationaldevice) +- [iterateServerAddresses](exports_protocol.ControllerDiscovery.md#iterateserveraddresses) + +## Constructors + +### constructor + +• **new ControllerDiscovery**() + +## Methods + +### cancelCommissionableDeviceDiscovery + +▸ `Static` **cancelCommissionableDeviceDiscovery**(`scanner`, `identifier?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scanner` | [`Scanner`](../interfaces/exports_common.Scanner.md) | +| `identifier?` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerDiscovery.d.ts:25 + +___ + +### cancelOperationalDeviceDiscovery + +▸ `Static` **cancelOperationalDeviceDiscovery**(`fabric`, `peerNodeId`, `scanner`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](exports_fabric.Fabric.md) | +| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `scanner` | [`MdnsScanner`](exports_mdns.MdnsScanner.md) | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerDiscovery.d.ts:24 + +___ + +### discoverCommissionableDevices + +▸ `Static` **discoverCommissionableDevices**(`scanners`, `timeoutSeconds`, `identifier?`, `discoveredCallback?`): `Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scanners` | [`Scanner`](../interfaces/exports_common.Scanner.md)[] | +| `timeoutSeconds` | `number` | +| `identifier?` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | +| `discoveredCallback?` | (`device`: [`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)) => `void` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerDiscovery.d.ts:22 + +___ + +### discoverDeviceAddressesByIdentifier + +▸ `Static` **discoverDeviceAddressesByIdentifier**(`scanners`, `identifier`, `timeoutSeconds?`): `Promise`<[`ServerAddress`](../modules/exports_common.md#serveraddress)[]\> + +Discovers devices by a provided identifier and a list of scanners (e.g. IP and BLE in parallel). +It returns after the timeout or if at least one device was found. +The method returns a list of addresses of the discovered devices. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scanners` | [`Scanner`](../interfaces/exports_common.Scanner.md)[] | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | +| `timeoutSeconds?` | `number` | + +#### Returns + +`Promise`<[`ServerAddress`](../modules/exports_common.md#serveraddress)[]\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerDiscovery.d.ts:21 + +___ + +### discoverOperationalDevice + +▸ `Static` **discoverOperationalDevice**(`fabric`, `peerNodeId`, `scanner`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](exports_fabric.Fabric.md) | +| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `scanner` | [`MdnsScanner`](exports_mdns.MdnsScanner.md) | +| `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | + +#### Returns + +`Promise`<[`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[]\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerDiscovery.d.ts:23 + +___ + +### iterateServerAddresses + +▸ `Static` **iterateServerAddresses**<`SA`, `T`, `E`\>(`servers`, `errorType`, `updateNetworkInterfaceFunc`, `func`, `lastKnownServer?`): `Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> + +Helper method to iterate through a list of server addresses and try to execute a method on each of them. If the +method throws a configurable error (or EHOSTUNREACH), the server address list is updated (to also add later +discovered addresses or devices) and then next server address is tried.The result of the first successful method +call is returned. The logic makes sure to only try each unique address (IP/port) once. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `SA` | extends [`ServerAddress`](../modules/exports_common.md#serveraddress) | +| `T` | `T` | +| `E` | extends `Error` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `servers` | `SA`[] | +| `errorType` | [`ClassExtends`](../modules/util_export.md#classextends)<`E`\> | +| `updateNetworkInterfaceFunc` | () => `Promise`<`SA`[]\> | +| `func` | (`server`: `SA`) => `Promise`<`T`\> | +| `lastKnownServer?` | `SA` | + +#### Returns + +`Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ControllerDiscovery.d.ts:32 diff --git a/docs/matter-node.js/classes/exports_protocol.DiscoveryError.md b/docs/matter-node.js/classes/exports_protocol.DiscoveryError.md new file mode 100644 index 0000000000..8de25ef069 --- /dev/null +++ b/docs/matter-node.js/classes/exports_protocol.DiscoveryError.md @@ -0,0 +1,39 @@ +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/protocol](../modules/exports_protocol.md) / DiscoveryError + +# Class: DiscoveryError + +[exports/protocol](../modules/exports_protocol.md).DiscoveryError + +Error base class for all errors thrown by this library. + +## Hierarchy + +- [`MatterError`](exports_common.MatterError.md) + + ↳ **`DiscoveryError`** + +## Table of contents + +### Constructors + +- [constructor](exports_protocol.DiscoveryError.md#constructor) + +## Constructors + +### constructor + +• **new DiscoveryError**(`message?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Inherited from + +[MatterError](exports_common.MatterError.md).[constructor](exports_common.MatterError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1073 diff --git a/docs/matter-node.js/classes/exports_protocol.ExchangeCounter.md b/docs/matter-node.js/classes/exports_protocol.ExchangeCounter.md index e7a327ae9c..0aa1802252 100644 --- a/docs/matter-node.js/classes/exports_protocol.ExchangeCounter.md +++ b/docs/matter-node.js/classes/exports_protocol.ExchangeCounter.md @@ -32,7 +32,7 @@ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:44 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:51 ## Methods @@ -46,4 +46,4 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:44 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:45 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:52 diff --git a/docs/matter-node.js/classes/exports_protocol.ExchangeManager.md b/docs/matter-node.js/classes/exports_protocol.ExchangeManager.md index 3758e32fad..9d99328f13 100644 --- a/docs/matter-node.js/classes/exports_protocol.ExchangeManager.md +++ b/docs/matter-node.js/classes/exports_protocol.ExchangeManager.md @@ -19,6 +19,7 @@ ### Properties - [channelManager](exports_protocol.ExchangeManager.md#channelmanager) +- [closingSessions](exports_protocol.ExchangeManager.md#closingsessions) - [exchangeCounter](exports_protocol.ExchangeManager.md#exchangecounter) - [exchanges](exports_protocol.ExchangeManager.md#exchanges) - [messageCounter](exports_protocol.ExchangeManager.md#messagecounter) @@ -32,6 +33,10 @@ - [addProtocolHandler](exports_protocol.ExchangeManager.md#addprotocolhandler) - [addTransportInterface](exports_protocol.ExchangeManager.md#addtransportinterface) - [close](exports_protocol.ExchangeManager.md#close) +- [closeSession](exports_protocol.ExchangeManager.md#closesession) +- [deleteExchange](exports_protocol.ExchangeManager.md#deleteexchange) +- [getProtocolHandler](exports_protocol.ExchangeManager.md#getprotocolhandler) +- [hasProtocolHandler](exports_protocol.ExchangeManager.md#hasprotocolhandler) - [initiateExchange](exports_protocol.ExchangeManager.md#initiateexchange) - [initiateExchangeWithChannel](exports_protocol.ExchangeManager.md#initiateexchangewithchannel) @@ -56,7 +61,7 @@ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:35 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:38 ## Properties @@ -66,7 +71,17 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:35 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:29 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:31 + +___ + +### closingSessions + +• `Private` `Readonly` **closingSessions**: `any` + +#### Defined in + +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:37 ___ @@ -76,7 +91,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:30 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:32 ___ @@ -86,7 +101,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:32 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:34 ___ @@ -96,7 +111,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:31 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:33 ___ @@ -106,7 +121,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:41 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:46 ___ @@ -116,7 +131,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:33 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:35 ___ @@ -126,7 +141,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:28 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:30 ___ @@ -136,7 +151,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:34 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:36 ## Methods @@ -156,7 +171,7 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:34 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:37 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:42 ___ @@ -176,7 +191,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:36 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:39 ___ @@ -190,6 +205,86 @@ ___ #### Defined in +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:45 + +___ + +### closeSession + +▸ **closeSession**(`session`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `session` | [`SecureSession`](exports_session.SecureSession.md)<`any`\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:48 + +___ + +### deleteExchange + +▸ **deleteExchange**(`exchangeIndex`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `exchangeIndex` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:47 + +___ + +### getProtocolHandler + +▸ **getProtocolHandler**(`protocolId`): `undefined` \| [`ProtocolHandler`](../interfaces/exports_protocol.ProtocolHandler.md)<`ContextT`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`undefined` \| [`ProtocolHandler`](../interfaces/exports_protocol.ProtocolHandler.md)<`ContextT`\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:41 + +___ + +### hasProtocolHandler + +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`boolean` + +#### Defined in + packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:40 ___ @@ -212,7 +307,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:38 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:43 ___ @@ -233,4 +328,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:39 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:44 diff --git a/docs/matter-node.js/classes/exports_protocol.ExchangeProvider.md b/docs/matter-node.js/classes/exports_protocol.ExchangeProvider.md index 0b3ec4d8a6..ef65c19d08 100644 --- a/docs/matter-node.js/classes/exports_protocol.ExchangeProvider.md +++ b/docs/matter-node.js/classes/exports_protocol.ExchangeProvider.md @@ -23,6 +23,8 @@ ### Methods - [addProtocolHandler](exports_protocol.ExchangeProvider.md#addprotocolhandler) +- [getProtocolHandler](exports_protocol.ExchangeProvider.md#getprotocolhandler) +- [hasProtocolHandler](exports_protocol.ExchangeProvider.md#hasprotocolhandler) - [initiateExchange](exports_protocol.ExchangeProvider.md#initiateexchange) - [reconnectChannel](exports_protocol.ExchangeProvider.md#reconnectchannel) @@ -42,7 +44,7 @@ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:55 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:62 ## Properties @@ -52,7 +54,7 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:55 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:53 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:60 ___ @@ -62,7 +64,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:52 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:59 ___ @@ -72,7 +74,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:54 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:61 ## Accessors @@ -86,7 +88,7 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:54 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:59 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:68 ## Methods @@ -106,7 +108,47 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:59 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:56 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:65 + +___ + +### getProtocolHandler + +▸ **getProtocolHandler**(`protocolId`): `undefined` \| [`ProtocolHandler`](../interfaces/exports_protocol.ProtocolHandler.md)<[`MatterController`](export._internal_.MatterController.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`undefined` \| [`ProtocolHandler`](../interfaces/exports_protocol.ProtocolHandler.md)<[`MatterController`](export._internal_.MatterController.md)\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:64 + +___ + +### hasProtocolHandler + +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:63 ___ @@ -120,7 +162,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:57 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:66 ___ @@ -134,4 +176,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:58 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:67 diff --git a/docs/matter-node.js/classes/exports_protocol.MessageChannel.md b/docs/matter-node.js/classes/exports_protocol.MessageChannel.md index 72ee6da081..4d5b7f51f5 100644 --- a/docs/matter-node.js/classes/exports_protocol.MessageChannel.md +++ b/docs/matter-node.js/classes/exports_protocol.MessageChannel.md @@ -29,6 +29,7 @@ SPDX-License-Identifier: Apache-2.0 - [channel](exports_protocol.MessageChannel.md#channel) - [closeCallback](exports_protocol.MessageChannel.md#closecallback) +- [closed](exports_protocol.MessageChannel.md#closed) - [session](exports_protocol.MessageChannel.md#session) ### Accessors @@ -58,11 +59,11 @@ SPDX-License-Identifier: Apache-2.0 | :------ | :------ | | `channel` | [`Channel`](../interfaces/exports_common.Channel.md)<`Uint8Array`\> | | `session` | [`Session`](../interfaces/exports_session.Session.md)<`ContextT`\> | -| `closeCallback?` | () => `void` | +| `closeCallback?` | () => `Promise`<`void`\> | #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:22 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:24 ## Properties @@ -72,7 +73,7 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:22 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:19 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:20 ___ @@ -82,7 +83,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:21 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:22 + +___ + +### closed + +• **closed**: `boolean` + +#### Defined in + +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:23 ___ @@ -92,7 +103,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:20 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:21 ## Accessors @@ -110,7 +121,7 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:20 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:24 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:26 ## Methods @@ -128,7 +139,7 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:24 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:25 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:27 ___ @@ -152,4 +163,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:23 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:25 diff --git a/docs/matter-node.js/classes/exports_protocol.MessageCounter.md b/docs/matter-node.js/classes/exports_protocol.MessageCounter.md index 9935443764..cabc9f4f33 100644 --- a/docs/matter-node.js/classes/exports_protocol.MessageCounter.md +++ b/docs/matter-node.js/classes/exports_protocol.MessageCounter.md @@ -32,7 +32,7 @@ #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:48 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:55 ## Methods @@ -46,4 +46,4 @@ packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:48 #### Defined in -packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:49 +packages/matter.js/dist/esm/protocol/ExchangeManager.d.ts:56 diff --git a/docs/matter-node.js/classes/exports_protocol.MessageExchange.md b/docs/matter-node.js/classes/exports_protocol.MessageExchange.md index 51cc7a80cf..c197801c6b 100644 --- a/docs/matter-node.js/classes/exports_protocol.MessageExchange.md +++ b/docs/matter-node.js/classes/exports_protocol.MessageExchange.md @@ -84,7 +84,7 @@ | `peerNodeId` | `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) | | `exchangeId` | `number` | | `protocolId` | `number` | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Defined in @@ -534,7 +534,7 @@ ___ | `channel` | [`MessageChannel`](exports_protocol.MessageChannel.md)<`ContextT`\> | | `messageCounter` | [`MessageCounter`](exports_protocol.MessageCounter.md) | | `initialMessage` | [`Message`](../interfaces/exports_codec.Message.md) | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Returns @@ -564,7 +564,7 @@ ___ | `exchangeId` | `number` | | `protocolId` | `number` | | `messageCounter` | [`MessageCounter`](exports_protocol.MessageCounter.md) | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Returns diff --git a/docs/matter-node.js/classes/exports_schema.QrCodeSchema.md b/docs/matter-node.js/classes/exports_schema.QrCodeSchema.md index 9e5f414f25..70bccad7af 100644 --- a/docs/matter-node.js/classes/exports_schema.QrCodeSchema.md +++ b/docs/matter-node.js/classes/exports_schema.QrCodeSchema.md @@ -28,6 +28,7 @@ Define a schema to encode / decode convert type T to type E. - [decodeInternal](exports_schema.QrCodeSchema.md#decodeinternal) - [encode](exports_schema.QrCodeSchema.md#encode) - [encodeInternal](exports_schema.QrCodeSchema.md#encodeinternal) +- [get](exports_schema.QrCodeSchema.md#get) - [validate](exports_schema.QrCodeSchema.md#validate) ## Constructors @@ -153,6 +154,26 @@ packages/matter.js/dist/esm/schema/QrCodeSchema.d.ts:8 ___ +### get + +▸ **get**(`code`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | + +#### Returns + +`string` + +#### Defined in + +packages/matter.js/dist/esm/schema/QrCodeSchema.d.ts:11 + +___ + ### validate ▸ **validate**(`_value`): `void` diff --git a/docs/matter-node.js/classes/exports_securechannel.SecureChannelProtocol.md b/docs/matter-node.js/classes/exports_securechannel.SecureChannelProtocol.md index d63edea5bb..5468e6742d 100644 --- a/docs/matter-node.js/classes/exports_securechannel.SecureChannelProtocol.md +++ b/docs/matter-node.js/classes/exports_securechannel.SecureChannelProtocol.md @@ -4,9 +4,11 @@ [exports/securechannel](../modules/exports_securechannel.md).SecureChannelProtocol -## Implements +## Hierarchy -- [`ProtocolHandler`](../interfaces/exports_protocol.ProtocolHandler.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> +- [`StatusReportOnlySecureChannelProtocol`](exports_securechannel.StatusReportOnlySecureChannelProtocol.md) + + ↳ **`SecureChannelProtocol`** ## Table of contents @@ -22,6 +24,7 @@ ### Methods +- [close](exports_securechannel.SecureChannelProtocol.md#close) - [getId](exports_securechannel.SecureChannelProtocol.md#getid) - [handleInitialStatusReport](exports_securechannel.SecureChannelProtocol.md#handleinitialstatusreport) - [onNewExchange](exports_securechannel.SecureChannelProtocol.md#onnewexchange) @@ -41,9 +44,13 @@ | :------ | :------ | | `commissioningCancelledCallback` | () => `Promise`<`void`\> | +#### Overrides + +[StatusReportOnlySecureChannelProtocol](exports_securechannel.StatusReportOnlySecureChannelProtocol.md).[constructor](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#constructor) + #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:15 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:20 ## Properties @@ -53,7 +60,7 @@ packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:15 #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:14 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:19 ___ @@ -63,7 +70,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:12 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:17 ___ @@ -73,10 +80,28 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:13 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:18 ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[StatusReportOnlySecureChannelProtocol](exports_securechannel.StatusReportOnlySecureChannelProtocol.md).[close](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#close) + +#### Defined in + +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:14 + +___ + ### getId ▸ **getId**(): `number` @@ -85,13 +110,13 @@ packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:13 `number` -#### Implementation of +#### Inherited from -[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[getId](../interfaces/exports_protocol.ProtocolHandler.md#getid) +[StatusReportOnlySecureChannelProtocol](exports_securechannel.StatusReportOnlySecureChannelProtocol.md).[getId](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#getid) #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:16 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:11 ___ @@ -103,16 +128,20 @@ ___ | Name | Type | | :------ | :------ | -| `exchange` | [`MessageExchange`](exports_protocol.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> | +| `exchange` | [`MessageExchange`](exports_protocol.MessageExchange.md)<`any`\> | | `message` | [`Message`](../interfaces/exports_codec.Message.md) | #### Returns `Promise`<`void`\> +#### Inherited from + +[StatusReportOnlySecureChannelProtocol](exports_securechannel.StatusReportOnlySecureChannelProtocol.md).[handleInitialStatusReport](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#handleinitialstatusreport) + #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:20 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:13 ___ @@ -124,20 +153,20 @@ ___ | Name | Type | | :------ | :------ | -| `exchange` | [`MessageExchange`](exports_protocol.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> | +| `exchange` | [`MessageExchange`](exports_protocol.MessageExchange.md)<`any`\> | | `message` | [`Message`](../interfaces/exports_codec.Message.md) | #### Returns `Promise`<`void`\> -#### Implementation of +#### Overrides -[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[onNewExchange](../interfaces/exports_protocol.ProtocolHandler.md#onnewexchange) +[StatusReportOnlySecureChannelProtocol](exports_securechannel.StatusReportOnlySecureChannelProtocol.md).[onNewExchange](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#onnewexchange) #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:19 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:23 ___ @@ -151,7 +180,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:18 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:22 ___ @@ -171,7 +200,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:17 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:21 ___ @@ -192,4 +221,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:21 +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:24 diff --git a/docs/matter-node.js/classes/exports_securechannel.StatusReportOnlySecureChannelProtocol.md b/docs/matter-node.js/classes/exports_securechannel.StatusReportOnlySecureChannelProtocol.md new file mode 100644 index 0000000000..57e37859ab --- /dev/null +++ b/docs/matter-node.js/classes/exports_securechannel.StatusReportOnlySecureChannelProtocol.md @@ -0,0 +1,116 @@ +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/securechannel](../modules/exports_securechannel.md) / StatusReportOnlySecureChannelProtocol + +# Class: StatusReportOnlySecureChannelProtocol + +[exports/securechannel](../modules/exports_securechannel.md).StatusReportOnlySecureChannelProtocol + +## Hierarchy + +- **`StatusReportOnlySecureChannelProtocol`** + + ↳ [`SecureChannelProtocol`](exports_securechannel.SecureChannelProtocol.md) + +## Implements + +- [`ProtocolHandler`](../interfaces/exports_protocol.ProtocolHandler.md)<`any`\> + +## Table of contents + +### Constructors + +- [constructor](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#constructor) + +### Methods + +- [close](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#close) +- [getId](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#getid) +- [handleInitialStatusReport](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#handleinitialstatusreport) +- [onNewExchange](exports_securechannel.StatusReportOnlySecureChannelProtocol.md#onnewexchange) + +## Constructors + +### constructor + +• **new StatusReportOnlySecureChannelProtocol**() + +## Methods + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[close](../interfaces/exports_protocol.ProtocolHandler.md#close) + +#### Defined in + +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:14 + +___ + +### getId + +▸ **getId**(): `number` + +#### Returns + +`number` + +#### Implementation of + +[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[getId](../interfaces/exports_protocol.ProtocolHandler.md#getid) + +#### Defined in + +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:11 + +___ + +### handleInitialStatusReport + +▸ **handleInitialStatusReport**(`exchange`, `message`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `exchange` | [`MessageExchange`](exports_protocol.MessageExchange.md)<`any`\> | +| `message` | [`Message`](../interfaces/exports_codec.Message.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:13 + +___ + +### onNewExchange + +▸ **onNewExchange**(`exchange`, `message`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `exchange` | [`MessageExchange`](exports_protocol.MessageExchange.md)<`any`\> | +| `message` | [`Message`](../interfaces/exports_codec.Message.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[onNewExchange](../interfaces/exports_protocol.ProtocolHandler.md#onnewexchange) + +#### Defined in + +packages/matter.js/dist/esm/protocol/securechannel/SecureChannelProtocol.d.ts:12 diff --git a/docs/matter-node.js/classes/exports_session.CaseServer.md b/docs/matter-node.js/classes/exports_session.CaseServer.md index 992f2ee4b7..221cf6bb8d 100644 --- a/docs/matter-node.js/classes/exports_session.CaseServer.md +++ b/docs/matter-node.js/classes/exports_session.CaseServer.md @@ -20,6 +20,7 @@ ### Methods +- [close](exports_session.CaseServer.md#close) - [getId](exports_session.CaseServer.md#getid) - [onNewExchange](exports_session.CaseServer.md#onnewexchange) @@ -41,6 +42,24 @@ packages/matter.js/dist/esm/session/case/CaseServer.d.ts:12 ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[close](../interfaces/exports_protocol.ProtocolHandler.md#close) + +#### Defined in + +packages/matter.js/dist/esm/session/case/CaseServer.d.ts:13 + +___ + ### getId ▸ **getId**(): `number` diff --git a/docs/matter-node.js/classes/exports_session.PaseClient.md b/docs/matter-node.js/classes/exports_session.PaseClient.md index 8fdd5ab78d..fb84f1a8a0 100644 --- a/docs/matter-node.js/classes/exports_session.PaseClient.md +++ b/docs/matter-node.js/classes/exports_session.PaseClient.md @@ -13,6 +13,9 @@ ### Methods - [pair](exports_session.PaseClient.md#pair) +- [generatePakePasscodeVerifier](exports_session.PaseClient.md#generatepakepasscodeverifier) +- [generateRandomDiscriminator](exports_session.PaseClient.md#generaterandomdiscriminator) +- [generateRandomPasscode](exports_session.PaseClient.md#generaterandompasscode) ## Constructors @@ -40,4 +43,53 @@ #### Defined in -packages/matter.js/dist/esm/session/pase/PaseClient.d.ts:9 +packages/matter.js/dist/esm/session/pase/PaseClient.d.ts:13 + +___ + +### generatePakePasscodeVerifier + +▸ `Static` **generatePakePasscodeVerifier**(`setupPinCode`, `pbkdfParameters`): `Promise`<`Uint8Array`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `setupPinCode` | `number` | +| `pbkdfParameters` | [`PbkdfParameters`](../interfaces/crypto_export.PbkdfParameters.md) | + +#### Returns + +`Promise`<`Uint8Array`\> + +#### Defined in + +packages/matter.js/dist/esm/session/pase/PaseClient.d.ts:10 + +___ + +### generateRandomDiscriminator + +▸ `Static` **generateRandomDiscriminator**(): `number` + +#### Returns + +`number` + +#### Defined in + +packages/matter.js/dist/esm/session/pase/PaseClient.d.ts:12 + +___ + +### generateRandomPasscode + +▸ `Static` **generateRandomPasscode**(): `number` + +#### Returns + +`number` + +#### Defined in + +packages/matter.js/dist/esm/session/pase/PaseClient.d.ts:11 diff --git a/docs/matter-node.js/classes/exports_session.PaseServer.md b/docs/matter-node.js/classes/exports_session.PaseServer.md index aa89cd92e0..73a790e94f 100644 --- a/docs/matter-node.js/classes/exports_session.PaseServer.md +++ b/docs/matter-node.js/classes/exports_session.PaseServer.md @@ -26,6 +26,7 @@ ### Methods - [cancelPairing](exports_session.PaseServer.md#cancelpairing) +- [close](exports_session.PaseServer.md#close) - [getId](exports_session.PaseServer.md#getid) - [onNewExchange](exports_session.PaseServer.md#onnewexchange) - [fromPin](exports_session.PaseServer.md#frompin) @@ -132,6 +133,24 @@ packages/matter.js/dist/esm/session/pase/PaseServer.d.ts:28 ___ +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/exports_protocol.ProtocolHandler.md).[close](../interfaces/exports_protocol.ProtocolHandler.md#close) + +#### Defined in + +packages/matter.js/dist/esm/session/pase/PaseServer.d.ts:29 + +___ + ### getId ▸ **getId**(): `number` diff --git a/docs/matter-node.js/classes/exports_session.SecureSession.md b/docs/matter-node.js/classes/exports_session.SecureSession.md index 50f32f8cff..7b3e2eaf81 100644 --- a/docs/matter-node.js/classes/exports_session.SecureSession.md +++ b/docs/matter-node.js/classes/exports_session.SecureSession.md @@ -22,6 +22,8 @@ ### Properties +- [\_closingAfterExchangeFinished](exports_session.SecureSession.md#_closingafterexchangefinished) +- [\_sendCloseMessageWhenClosing](exports_session.SecureSession.md#_sendclosemessagewhenclosing) - [activeRetransmissionTimeoutMs](exports_session.SecureSession.md#activeretransmissiontimeoutms) - [activeTimestamp](exports_session.SecureSession.md#activetimestamp) - [attestationKey](exports_session.SecureSession.md#attestationkey) @@ -36,13 +38,16 @@ - [peerNodeId](exports_session.SecureSession.md#peernodeid) - [peerSessionId](exports_session.SecureSession.md#peersessionid) - [retransmissionRetries](exports_session.SecureSession.md#retransmissionretries) +- [subscriptionChangedCallback](exports_session.SecureSession.md#subscriptionchangedcallback) - [subscriptions](exports_session.SecureSession.md#subscriptions) - [timestamp](exports_session.SecureSession.md#timestamp) ### Accessors +- [closingAfterExchangeFinished](exports_session.SecureSession.md#closingafterexchangefinished) - [name](exports_session.SecureSession.md#name) - [numberOfActiveSubscriptions](exports_session.SecureSession.md#numberofactivesubscriptions) +- [sendCloseMessageWhenClosing](exports_session.SecureSession.md#sendclosemessagewhenclosing) ### Methods @@ -74,7 +79,7 @@ ### constructor -• **new SecureSession**<`T`\>(`context`, `id`, `fabric`, `peerNodeId`, `peerSessionId`, `_sharedSecret`, `decryptKey`, `encryptKey`, `attestationKey`, `closeCallback`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`, `retransmissionRetries?`) +• **new SecureSession**<`T`\>(`args`) #### Type parameters @@ -86,33 +91,54 @@ | Name | Type | | :------ | :------ | -| `context` | `T` | -| `id` | `number` | -| `fabric` | `undefined` \| [`Fabric`](exports_fabric.Fabric.md) | -| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | -| `peerSessionId` | `number` | -| `_sharedSecret` | `Uint8Array` | -| `decryptKey` | `Uint8Array` | -| `encryptKey` | `Uint8Array` | -| `attestationKey` | `Uint8Array` | -| `closeCallback` | (`sendClose`: `boolean`) => `Promise`<`void`\> | -| `idleRetransmissionTimeoutMs?` | `number` | -| `activeRetransmissionTimeoutMs?` | `number` | -| `retransmissionRetries?` | `number` | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.attestationKey` | `Uint8Array` | +| `args.closeCallback` | () => `Promise`<`void`\> | +| `args.context` | `T` | +| `args.decryptKey` | `Uint8Array` | +| `args.encryptKey` | `Uint8Array` | +| `args.fabric` | `undefined` \| [`Fabric`](exports_fabric.Fabric.md) | +| `args.id` | `number` | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.retransmissionRetries?` | `number` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:31 +packages/matter.js/dist/esm/session/SecureSession.d.ts:48 ## Properties +### \_closingAfterExchangeFinished + +• `Private` **\_closingAfterExchangeFinished**: `any` + +#### Defined in + +packages/matter.js/dist/esm/session/SecureSession.d.ts:18 + +___ + +### \_sendCloseMessageWhenClosing + +• `Private` **\_sendCloseMessageWhenClosing**: `any` + +#### Defined in + +packages/matter.js/dist/esm/session/SecureSession.d.ts:19 + +___ + ### activeRetransmissionTimeoutMs • `Private` `Readonly` **activeRetransmissionTimeoutMs**: `any` #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:25 +packages/matter.js/dist/esm/session/SecureSession.d.ts:31 ___ @@ -122,7 +148,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:29 +packages/matter.js/dist/esm/session/SecureSession.d.ts:17 ___ @@ -132,7 +158,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:22 +packages/matter.js/dist/esm/session/SecureSession.d.ts:27 ___ @@ -142,7 +168,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:23 +packages/matter.js/dist/esm/session/SecureSession.d.ts:28 ___ @@ -152,7 +178,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:15 +packages/matter.js/dist/esm/session/SecureSession.d.ts:20 ___ @@ -162,7 +188,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:20 +packages/matter.js/dist/esm/session/SecureSession.d.ts:25 ___ @@ -172,7 +198,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:21 +packages/matter.js/dist/esm/session/SecureSession.d.ts:26 ___ @@ -182,7 +208,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:17 +packages/matter.js/dist/esm/session/SecureSession.d.ts:22 ___ @@ -192,7 +218,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:62 +packages/matter.js/dist/esm/session/SecureSession.d.ts:95 ___ @@ -202,7 +228,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:16 +packages/matter.js/dist/esm/session/SecureSession.d.ts:21 ___ @@ -212,7 +238,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:24 +packages/matter.js/dist/esm/session/SecureSession.d.ts:30 ___ @@ -222,7 +248,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:18 +packages/matter.js/dist/esm/session/SecureSession.d.ts:23 ___ @@ -232,7 +258,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:19 +packages/matter.js/dist/esm/session/SecureSession.d.ts:24 ___ @@ -242,7 +268,17 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:26 +packages/matter.js/dist/esm/session/SecureSession.d.ts:32 + +___ + +### subscriptionChangedCallback + +• `Private` `Readonly` **subscriptionChangedCallback**: `any` + +#### Defined in + +packages/matter.js/dist/esm/session/SecureSession.d.ts:29 ___ @@ -252,7 +288,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:27 +packages/matter.js/dist/esm/session/SecureSession.d.ts:15 ___ @@ -262,10 +298,28 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:28 +packages/matter.js/dist/esm/session/SecureSession.d.ts:16 ## Accessors +### closingAfterExchangeFinished + +• `get` **closingAfterExchangeFinished**(): `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[Session](../interfaces/exports_session.Session.md).[closingAfterExchangeFinished](../interfaces/exports_session.Session.md#closingafterexchangefinished) + +#### Defined in + +packages/matter.js/dist/esm/session/SecureSession.d.ts:63 + +___ + ### name • `get` **name**(): `string` @@ -280,7 +334,7 @@ packages/matter.js/dist/esm/session/SecureSession.d.ts:28 #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:43 +packages/matter.js/dist/esm/session/SecureSession.d.ts:76 ___ @@ -294,7 +348,21 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:55 +packages/matter.js/dist/esm/session/SecureSession.d.ts:88 + +___ + +### sendCloseMessageWhenClosing + +• `get` **sendCloseMessageWhenClosing**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +packages/matter.js/dist/esm/session/SecureSession.d.ts:64 ## Methods @@ -314,7 +382,7 @@ packages/matter.js/dist/esm/session/SecureSession.d.ts:55 #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:41 +packages/matter.js/dist/esm/session/SecureSession.d.ts:74 ___ @@ -334,7 +402,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:54 +packages/matter.js/dist/esm/session/SecureSession.d.ts:87 ___ @@ -354,13 +422,19 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:57 +packages/matter.js/dist/esm/session/SecureSession.d.ts:90 ___ ### close -▸ **close**(): `Promise`<`void`\> +▸ **close**(`closeAfterExchangeFinished?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -368,7 +442,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:34 +packages/matter.js/dist/esm/session/SecureSession.d.ts:67 ___ @@ -392,13 +466,13 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:37 +packages/matter.js/dist/esm/session/SecureSession.d.ts:70 ___ ### destroy -▸ **destroy**(`sendClose`): `Promise`<`void`\> +▸ **destroy**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> Destroys a session. Outstanding subscription data will be discarded. @@ -407,6 +481,7 @@ Destroys a session. Outstanding subscription data will be discarded. | Name | Type | | :------ | :------ | | `sendClose` | `boolean` | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -418,7 +493,7 @@ Destroys a session. Outstanding subscription data will be discarded. #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:61 +packages/matter.js/dist/esm/session/SecureSession.d.ts:94 ___ @@ -442,13 +517,13 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:38 +packages/matter.js/dist/esm/session/SecureSession.d.ts:71 ___ ### end -▸ **end**(`sendClose`): `Promise`<`void`\> +▸ **end**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> Ends a session. Outstanding subscription data will be flushed before the session is destroyed. @@ -457,6 +532,7 @@ Ends a session. Outstanding subscription data will be flushed before the session | Name | Type | | :------ | :------ | | `sendClose` | `boolean` | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -468,7 +544,7 @@ Ends a session. Outstanding subscription data will be flushed before the session #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:59 +packages/matter.js/dist/esm/session/SecureSession.d.ts:92 ___ @@ -486,7 +562,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:42 +packages/matter.js/dist/esm/session/SecureSession.d.ts:75 ___ @@ -500,7 +576,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:39 +packages/matter.js/dist/esm/session/SecureSession.d.ts:72 ___ @@ -518,7 +594,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:49 +packages/matter.js/dist/esm/session/SecureSession.d.ts:82 ___ @@ -532,7 +608,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:40 +packages/matter.js/dist/esm/session/SecureSession.d.ts:73 ___ @@ -550,7 +626,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:50 +packages/matter.js/dist/esm/session/SecureSession.d.ts:83 ___ @@ -574,7 +650,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:44 +packages/matter.js/dist/esm/session/SecureSession.d.ts:77 ___ @@ -592,7 +668,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:52 +packages/matter.js/dist/esm/session/SecureSession.d.ts:85 ___ @@ -610,7 +686,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:53 +packages/matter.js/dist/esm/session/SecureSession.d.ts:86 ___ @@ -628,7 +704,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:51 +packages/matter.js/dist/esm/session/SecureSession.d.ts:84 ___ @@ -646,7 +722,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:33 +packages/matter.js/dist/esm/session/SecureSession.d.ts:66 ___ @@ -664,7 +740,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:36 +packages/matter.js/dist/esm/session/SecureSession.d.ts:69 ___ @@ -682,7 +758,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:32 +packages/matter.js/dist/esm/session/SecureSession.d.ts:65 ___ @@ -706,7 +782,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:35 +packages/matter.js/dist/esm/session/SecureSession.d.ts:68 ___ @@ -726,13 +802,13 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:56 +packages/matter.js/dist/esm/session/SecureSession.d.ts:89 ___ ### create -▸ `Static` **create**<`T`\>(`context`, `id`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `closeCallback`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](exports_session.SecureSession.md)<`T`\>\> +▸ `Static` **create**<`T`\>(`args`): `Promise`<[`SecureSession`](exports_session.SecureSession.md)<`T`\>\> #### Type parameters @@ -744,18 +820,20 @@ ___ | Name | Type | | :------ | :------ | -| `context` | `T` | -| `id` | `number` | -| `fabric` | `undefined` \| [`Fabric`](exports_fabric.Fabric.md) | -| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | -| `peerSessionId` | `number` | -| `sharedSecret` | `Uint8Array` | -| `salt` | `Uint8Array` | -| `isInitiator` | `boolean` | -| `isResumption` | `boolean` | -| `closeCallback` | (`sendClose`: `boolean`) => `Promise`<`void`\> | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.closeCallback` | () => `Promise`<`void`\> | +| `args.context` | `T` | +| `args.fabric` | `undefined` \| [`Fabric`](exports_fabric.Fabric.md) | +| `args.id` | `number` | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.isInitiator` | `boolean` | +| `args.isResumption` | `boolean` | +| `args.peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.salt` | `Uint8Array` | +| `args.sharedSecret` | `Uint8Array` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Returns @@ -763,4 +841,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:30 +packages/matter.js/dist/esm/session/SecureSession.d.ts:33 diff --git a/docs/matter-node.js/classes/exports_session.SessionManager.md b/docs/matter-node.js/classes/exports_session.SessionManager.md index b42c71aace..59c01b18f1 100644 --- a/docs/matter-node.js/classes/exports_session.SessionManager.md +++ b/docs/matter-node.js/classes/exports_session.SessionManager.md @@ -23,7 +23,6 @@ - [resumptionRecords](exports_session.SessionManager.md#resumptionrecords) - [sessionStorage](exports_session.SessionManager.md#sessionstorage) - [sessions](exports_session.SessionManager.md#sessions) -- [sessionsToClose](exports_session.SessionManager.md#sessionstoclose) - [unsecureSession](exports_session.SessionManager.md#unsecuresession) ### Methods @@ -37,9 +36,10 @@ - [getPaseSession](exports_session.SessionManager.md#getpasesession) - [getSession](exports_session.SessionManager.md#getsession) - [getSessionForNode](exports_session.SessionManager.md#getsessionfornode) -- [getSessionsToClose](exports_session.SessionManager.md#getsessionstoclose) - [getUnsecureSession](exports_session.SessionManager.md#getunsecuresession) - [initFromStorage](exports_session.SessionManager.md#initfromstorage) +- [removeAllSessionsForNode](exports_session.SessionManager.md#removeallsessionsfornode) +- [removeResumptionRecord](exports_session.SessionManager.md#removeresumptionrecord) - [removeSession](exports_session.SessionManager.md#removesession) - [saveResumptionRecord](exports_session.SessionManager.md#saveresumptionrecord) - [storeResumptionRecords](exports_session.SessionManager.md#storeresumptionrecords) @@ -66,7 +66,7 @@ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:30 +packages/matter.js/dist/esm/session/SessionManager.d.ts:29 ## Properties @@ -120,16 +120,6 @@ packages/matter.js/dist/esm/session/SessionManager.d.ts:25 ___ -### sessionsToClose - -• `Private` `Readonly` **sessionsToClose**: `any` - -#### Defined in - -packages/matter.js/dist/esm/session/SessionManager.d.ts:29 - -___ - ### unsecureSession • `Private` `Readonly` **unsecureSession**: `any` @@ -150,29 +140,31 @@ packages/matter.js/dist/esm/session/SessionManager.d.ts:24 #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:62 +packages/matter.js/dist/esm/session/SessionManager.d.ts:76 ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`, `closeCallback?`): `Promise`<[`SecureSession`](exports_session.SecureSession.md)<`ContextT`\>\> +▸ **createSecureSession**(`args`): `Promise`<[`SecureSession`](exports_session.SecureSession.md)<`ContextT`\>\> #### Parameters | Name | Type | | :------ | :------ | -| `sessionId` | `number` | -| `fabric` | `undefined` \| [`Fabric`](exports_fabric.Fabric.md) | -| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | -| `peerSessionId` | `number` | -| `sharedSecret` | `Uint8Array` | -| `salt` | `Uint8Array` | -| `isInitiator` | `boolean` | -| `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | -| `closeCallback?` | (`sendClose`: `boolean`) => `Promise`<`void`\> | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.closeCallback?` | () => `Promise`<`void`\> | +| `args.fabric` | `undefined` \| [`Fabric`](exports_fabric.Fabric.md) | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.isInitiator` | `boolean` | +| `args.isResumption` | `boolean` | +| `args.peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.salt` | `Uint8Array` | +| `args.sessionId` | `number` | +| `args.sharedSecret` | `Uint8Array` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Returns @@ -180,7 +172,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:31 +packages/matter.js/dist/esm/session/SessionManager.d.ts:30 ___ @@ -200,7 +192,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:39 +packages/matter.js/dist/esm/session/SessionManager.d.ts:52 ___ @@ -220,21 +212,21 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:40 +packages/matter.js/dist/esm/session/SessionManager.d.ts:53 ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/exports_datatype.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/exports_datatype.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/exports_datatype.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` ; `nodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/exports_datatype.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:45 +packages/matter.js/dist/esm/session/SessionManager.d.ts:58 ___ @@ -248,7 +240,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:34 +packages/matter.js/dist/esm/session/SessionManager.d.ts:46 ___ @@ -262,7 +254,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:36 +packages/matter.js/dist/esm/session/SessionManager.d.ts:48 ___ @@ -282,7 +274,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:35 +packages/matter.js/dist/esm/session/SessionManager.d.ts:47 ___ @@ -303,47 +295,74 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:37 +packages/matter.js/dist/esm/session/SessionManager.d.ts:49 ___ -### getSessionsToClose +### getUnsecureSession -▸ **getSessionsToClose**(): [`SecureSession`](exports_session.SecureSession.md)<`any`\>[] +▸ **getUnsecureSession**(): [`UnsecureSession`](exports_session.UnsecureSession.md)<`ContextT`\> #### Returns -[`SecureSession`](exports_session.SecureSession.md)<`any`\>[] +[`UnsecureSession`](exports_session.UnsecureSession.md)<`ContextT`\> #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:32 +packages/matter.js/dist/esm/session/SessionManager.d.ts:51 ___ -### getUnsecureSession +### initFromStorage -▸ **getUnsecureSession**(): [`UnsecureSession`](exports_session.UnsecureSession.md)<`ContextT`\> +▸ **initFromStorage**(`fabrics`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabrics` | [`Fabric`](exports_fabric.Fabric.md)[] | #### Returns -[`UnsecureSession`](exports_session.UnsecureSession.md)<`ContextT`\> +`void` #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:38 +packages/matter.js/dist/esm/session/SessionManager.d.ts:57 ___ -### initFromStorage +### removeAllSessionsForNode -▸ **initFromStorage**(`fabrics`): `void` +▸ **removeAllSessionsForNode**(`nodeId`, `sendClose?`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `fabrics` | [`Fabric`](exports_fabric.Fabric.md)[] | +| `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | +| `sendClose?` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/session/SessionManager.d.ts:50 + +___ + +### removeResumptionRecord + +▸ **removeResumptionRecord**(`peerNodeId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | #### Returns @@ -351,28 +370,27 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:44 +packages/matter.js/dist/esm/session/SessionManager.d.ts:45 ___ ### removeSession -▸ **removeSession**(`sessionId`, `peerNodeId`): `Promise`<`void`\> +▸ **removeSession**(`sessionId`): `void` #### Parameters | Name | Type | | :------ | :------ | | `sessionId` | `number` | -| `peerNodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | #### Returns -`Promise`<`void`\> +`void` #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:33 +packages/matter.js/dist/esm/session/SessionManager.d.ts:44 ___ @@ -392,7 +410,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:41 +packages/matter.js/dist/esm/session/SessionManager.d.ts:54 ___ @@ -406,7 +424,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:43 +packages/matter.js/dist/esm/session/SessionManager.d.ts:56 ___ @@ -426,4 +444,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/SessionManager.d.ts:42 +packages/matter.js/dist/esm/session/SessionManager.d.ts:55 diff --git a/docs/matter-node.js/classes/exports_session.UnsecureSession.md b/docs/matter-node.js/classes/exports_session.UnsecureSession.md index ce5dd9f804..df527777c6 100644 --- a/docs/matter-node.js/classes/exports_session.UnsecureSession.md +++ b/docs/matter-node.js/classes/exports_session.UnsecureSession.md @@ -22,6 +22,7 @@ ### Properties +- [closingAfterExchangeFinished](exports_session.UnsecureSession.md#closingafterexchangefinished) - [context](exports_session.UnsecureSession.md#context) - [initiatorNodeId](exports_session.UnsecureSession.md#initiatornodeid) @@ -69,10 +70,24 @@ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:14 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:15 ## Properties +### closingAfterExchangeFinished + +• `Readonly` **closingAfterExchangeFinished**: ``false`` + +#### Implementation of + +[Session](../interfaces/exports_session.Session.md).[closingAfterExchangeFinished](../interfaces/exports_session.Session.md#closingafterexchangefinished) + +#### Defined in + +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:14 + +___ + ### context • `Private` `Readonly` **context**: `any` @@ -107,7 +122,7 @@ packages/matter.js/dist/esm/session/UnsecureSession.d.ts:13 #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:23 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:24 ## Methods @@ -131,19 +146,13 @@ packages/matter.js/dist/esm/session/UnsecureSession.d.ts:23 #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:19 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:20 ___ ### destroy -▸ **destroy**(`_sendClose`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sendClose` | `boolean` | +▸ **destroy**(): `Promise`<`void`\> #### Returns @@ -155,7 +164,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:34 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:35 ___ @@ -179,7 +188,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:20 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:21 ___ @@ -203,7 +212,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:35 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:36 ___ @@ -221,7 +230,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:36 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:37 ___ @@ -235,7 +244,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:21 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:22 ___ @@ -253,7 +262,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:29 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:30 ___ @@ -271,7 +280,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:30 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:31 ___ @@ -295,7 +304,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:24 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:25 ___ @@ -313,7 +322,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:32 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:33 ___ @@ -331,7 +340,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:33 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:34 ___ @@ -349,7 +358,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:31 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:32 ___ @@ -367,7 +376,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:16 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:17 ___ @@ -385,7 +394,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:18 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:19 ___ @@ -403,7 +412,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:15 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:16 ___ @@ -427,7 +436,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:17 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:18 ___ @@ -447,4 +456,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/UnsecureSession.d.ts:22 +packages/matter.js/dist/esm/session/UnsecureSession.d.ts:23 diff --git a/docs/matter-node.js/classes/net_export.NetworkNode.md b/docs/matter-node.js/classes/net_export.NetworkNode.md index 4d3109af69..9833df09f2 100644 --- a/docs/matter-node.js/classes/net_export.NetworkNode.md +++ b/docs/matter-node.js/classes/net_export.NetworkNode.md @@ -27,9 +27,12 @@ - [createUdpChannel](net_export.NetworkNode.md#createudpchannel) - [getIpMac](net_export.NetworkNode.md#getipmac) - [getNetInterfaces](net_export.NetworkNode.md#getnetinterfaces) -- [getMulticastInterface](net_export.NetworkNode.md#getmulticastinterface) +- [getMembershipMulticastInterfaces](net_export.NetworkNode.md#getmembershipmulticastinterfaces) +- [getMulticastInterfaceIpv4](net_export.NetworkNode.md#getmulticastinterfaceipv4) - [getNetInterfaceForIp](net_export.NetworkNode.md#getnetinterfaceforip) -- [getNetInterfaceForIpInternal](net_export.NetworkNode.md#getnetinterfaceforipinternal) +- [getNetInterfaceForRemoveAddress](net_export.NetworkNode.md#getnetinterfaceforremoveaddress) +- [getNetInterfaceZoneIpv6](net_export.NetworkNode.md#getnetinterfacezoneipv6) +- [getNetInterfaceZoneIpv6Internal](net_export.NetworkNode.md#getnetinterfacezoneipv6internal) ## Constructors @@ -71,7 +74,7 @@ ___ #### Defined in -packages/matter-node.js/src/net/NetworkNode.ts:43 +[packages/matter-node.js/src/net/NetworkNode.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L64) ## Methods @@ -89,7 +92,7 @@ packages/matter-node.js/src/net/NetworkNode.ts:43 #### Defined in -packages/matter-node.js/src/net/NetworkNode.ts:48 +[packages/matter-node.js/src/net/NetworkNode.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L69) ___ @@ -113,7 +116,7 @@ ___ #### Defined in -packages/matter-node.js/src/net/NetworkNode.ts:94 +[packages/matter-node.js/src/net/NetworkNode.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L128) ___ @@ -137,7 +140,7 @@ ___ #### Defined in -packages/matter-node.js/src/net/NetworkNode.ts:88 +[packages/matter-node.js/src/net/NetworkNode.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L122) ___ @@ -155,28 +158,48 @@ ___ #### Defined in -packages/matter-node.js/src/net/NetworkNode.ts:76 +[packages/matter-node.js/src/net/NetworkNode.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L110) ___ -### getMulticastInterface +### getMembershipMulticastInterfaces -▸ `Static` **getMulticastInterface**(`netInterface`, `ipv4`): `string` +▸ `Static` **getMembershipMulticastInterfaces**(`netInterface`, `ipv4`): (`undefined` \| `string`)[] #### Parameters | Name | Type | | :------ | :------ | -| `netInterface` | `string` | +| `netInterface` | `undefined` \| `string` | | `ipv4` | `boolean` | #### Returns -`string` +(`undefined` \| `string`)[] + +#### Defined in + +[packages/matter-node.js/src/net/NetworkNode.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L28) + +___ + +### getMulticastInterfaceIpv4 + +▸ `Static` **getMulticastInterfaceIpv4**(`netInterface`): `undefined` \| `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `netInterface` | `string` | + +#### Returns + +`undefined` \| `string` #### Defined in -packages/matter-node.js/src/net/NetworkNode.ts:14 +[packages/matter-node.js/src/net/NetworkNode.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L17) ___ @@ -196,13 +219,13 @@ ___ #### Defined in -packages/matter-node.js/src/net/NetworkNode.ts:37 +[packages/matter-node.js/src/net/NetworkNode.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L58) ___ -### getNetInterfaceForIpInternal +### getNetInterfaceForRemoveAddress -▸ `Static` `Private` **getNetInterfaceForIpInternal**(`ip`): `undefined` \| `string` +▸ `Static` `Private` **getNetInterfaceForRemoveAddress**(`ip`): `undefined` \| `string` #### Parameters @@ -216,4 +239,45 @@ ___ #### Defined in -packages/matter-node.js/src/net/NetworkNode.ts:52 +[packages/matter-node.js/src/net/NetworkNode.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L73) + +___ + +### getNetInterfaceZoneIpv6 + +▸ `Static` **getNetInterfaceZoneIpv6**(`netInterface`): `undefined` \| `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `netInterface` | `string` | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[packages/matter-node.js/src/net/NetworkNode.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L52) + +___ + +### getNetInterfaceZoneIpv6Internal + +▸ `Static` `Private` **getNetInterfaceZoneIpv6Internal**(`netInterface`, `netInterfaceInfos`): `undefined` \| `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `netInterface` | `string` | +| `netInterfaceInfos` | `undefined` \| `NetworkInterfaceInfo`[] | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[packages/matter-node.js/src/net/NetworkNode.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/NetworkNode.ts#L97) diff --git a/docs/matter-node.js/classes/net_export.UdpChannelNode.md b/docs/matter-node.js/classes/net_export.UdpChannelNode.md index af0182852f..086e38d93d 100644 --- a/docs/matter-node.js/classes/net_export.UdpChannelNode.md +++ b/docs/matter-node.js/classes/net_export.UdpChannelNode.md @@ -41,7 +41,7 @@ #### Defined in -packages/matter-node.js/src/net/UdpChannelNode.ts:63 +[packages/matter-node.js/src/net/UdpChannelNode.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/UdpChannelNode.ts#L98) ## Properties @@ -51,7 +51,7 @@ packages/matter-node.js/src/net/UdpChannelNode.ts:63 #### Defined in -packages/matter-node.js/src/net/UdpChannelNode.ts:65 +[packages/matter-node.js/src/net/UdpChannelNode.ts:100](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/UdpChannelNode.ts#L100) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/matter-node.js/src/net/UdpChannelNode.ts:64 +[packages/matter-node.js/src/net/UdpChannelNode.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/UdpChannelNode.ts#L99) ## Methods @@ -79,7 +79,7 @@ packages/matter-node.js/src/net/UdpChannelNode.ts:64 #### Defined in -packages/matter-node.js/src/net/UdpChannelNode.ts:95 +[packages/matter-node.js/src/net/UdpChannelNode.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/UdpChannelNode.ts#L130) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -packages/matter-node.js/src/net/UdpChannelNode.ts:68 +[packages/matter-node.js/src/net/UdpChannelNode.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/UdpChannelNode.ts#L103) ___ @@ -133,7 +133,7 @@ ___ #### Defined in -packages/matter-node.js/src/net/UdpChannelNode.ts:83 +[packages/matter-node.js/src/net/UdpChannelNode.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/UdpChannelNode.ts#L118) ___ @@ -153,4 +153,4 @@ ___ #### Defined in -packages/matter-node.js/src/net/UdpChannelNode.ts:41 +[packages/matter-node.js/src/net/UdpChannelNode.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/net/UdpChannelNode.ts#L41) diff --git a/docs/matter-node.js/classes/storage_export.Storage.md b/docs/matter-node.js/classes/storage_export.Storage.md index f90d89d4ad..e2cec31d59 100644 --- a/docs/matter-node.js/classes/storage_export.Storage.md +++ b/docs/matter-node.js/classes/storage_export.Storage.md @@ -17,10 +17,12 @@ ### Methods +- [clearAll](storage_export.Storage.md#clearall) - [close](storage_export.Storage.md#close) - [delete](storage_export.Storage.md#delete) - [get](storage_export.Storage.md#get) - [initialize](storage_export.Storage.md#initialize) +- [keys](storage_export.Storage.md#keys) - [set](storage_export.Storage.md#set) ## Constructors @@ -31,6 +33,26 @@ ## Methods +### clearAll + +▸ `Abstract` **clearAll**(`contexts`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/storage/Storage.d.ts:17 + +___ + ### close ▸ `Abstract` **close**(): `Promise`<`void`\> @@ -107,6 +129,26 @@ packages/matter.js/dist/esm/storage/Storage.d.ts:11 ___ +### keys + +▸ `Abstract` **keys**(`contexts`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`string`[] + +#### Defined in + +packages/matter.js/dist/esm/storage/Storage.d.ts:16 + +___ + ### set ▸ `Abstract` **set**<`T`\>(`contexts`, `key`, `value`): `void` diff --git a/docs/matter-node.js/classes/storage_export.StorageBackendDisk.md b/docs/matter-node.js/classes/storage_export.StorageBackendDisk.md index 3c07a115f5..f779fa3cfb 100644 --- a/docs/matter-node.js/classes/storage_export.StorageBackendDisk.md +++ b/docs/matter-node.js/classes/storage_export.StorageBackendDisk.md @@ -22,10 +22,13 @@ - [buildStorageKey](storage_export.StorageBackendDisk.md#buildstoragekey) - [clear](storage_export.StorageBackendDisk.md#clear) +- [clearAll](storage_export.StorageBackendDisk.md#clearall) - [close](storage_export.StorageBackendDisk.md#close) - [delete](storage_export.StorageBackendDisk.md#delete) - [get](storage_export.StorageBackendDisk.md#get) +- [getContextBaseKey](storage_export.StorageBackendDisk.md#getcontextbasekey) - [initialize](storage_export.StorageBackendDisk.md#initialize) +- [keys](storage_export.StorageBackendDisk.md#keys) - [set](storage_export.StorageBackendDisk.md#set) ## Constructors @@ -43,7 +46,7 @@ #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:14 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L14) ## Properties @@ -53,7 +56,7 @@ packages/matter-node.js/src/storage/StorageBackendDisk.ts:14 #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:12 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L12) ## Methods @@ -74,7 +77,7 @@ packages/matter-node.js/src/storage/StorageBackendDisk.ts:12 #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:31 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L43) ___ @@ -88,7 +91,31 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:27 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L27) + +___ + +### clearAll + +▸ **clearAll**(`contexts`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`void` + +#### Implementation of + +[Storage](storage_export.Storage.md).[clearAll](storage_export.Storage.md#clearall) + +#### Defined in + +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L78) ___ @@ -106,7 +133,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:23 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L23) ___ @@ -131,7 +158,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:56 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L61) ___ @@ -162,7 +189,28 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:44 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L51) + +___ + +### getContextBaseKey + +▸ **getContextBaseKey**(`contexts`, `allowEmptyContext?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `contexts` | `string`[] | `undefined` | +| `allowEmptyContext` | `boolean` | `false` | + +#### Returns + +`string` + +#### Defined in + +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L31) ___ @@ -180,7 +228,33 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:19 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L19) + +___ + +### keys + +▸ **keys**(`contexts`): `string`[] + +Returns all keys of a storage context without keys of sub-contexts + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`string`[] + +#### Implementation of + +[Storage](storage_export.Storage.md).[keys](storage_export.Storage.md#keys) + +#### Defined in + +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L66) ___ @@ -212,4 +286,4 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendDisk.ts:51 +[packages/matter-node.js/src/storage/StorageBackendDisk.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendDisk.ts#L57) diff --git a/docs/matter-node.js/classes/storage_export.StorageBackendJsonFile.md b/docs/matter-node.js/classes/storage_export.StorageBackendJsonFile.md index 07d1e87c64..1fb098767e 100644 --- a/docs/matter-node.js/classes/storage_export.StorageBackendJsonFile.md +++ b/docs/matter-node.js/classes/storage_export.StorageBackendJsonFile.md @@ -30,12 +30,14 @@ ### Methods - [clear](storage_export.StorageBackendJsonFile.md#clear) +- [clearAll](storage_export.StorageBackendJsonFile.md#clearall) - [close](storage_export.StorageBackendJsonFile.md#close) - [commit](storage_export.StorageBackendJsonFile.md#commit) - [delete](storage_export.StorageBackendJsonFile.md#delete) - [fromJson](storage_export.StorageBackendJsonFile.md#fromjson) - [get](storage_export.StorageBackendJsonFile.md#get) - [initialize](storage_export.StorageBackendJsonFile.md#initialize) +- [keys](storage_export.StorageBackendJsonFile.md#keys) - [set](storage_export.StorageBackendJsonFile.md#set) - [toJson](storage_export.StorageBackendJsonFile.md#tojson) - [triggerCommit](storage_export.StorageBackendJsonFile.md#triggercommit) @@ -58,7 +60,7 @@ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:27 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L27) ## Properties @@ -68,7 +70,7 @@ packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:27 #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:23 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L23) ___ @@ -78,7 +80,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:22 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L22) ___ @@ -88,7 +90,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:20 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L20) ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:24 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L24) ___ @@ -108,7 +110,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:27 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L27) ___ @@ -126,7 +128,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:25 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L25) ___ @@ -152,7 +154,7 @@ We store changes after a value was set to the storage, but not more often than t #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:19 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L19) ## Methods @@ -170,7 +172,31 @@ packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:19 #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:63 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L63) + +___ + +### clearAll + +▸ **clearAll**(`contexts`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`void` + +#### Inherited from + +[StorageBackendMemory](storage_export.StorageBackendMemory.md).[clearAll](storage_export.StorageBackendMemory.md#clearall) + +#### Defined in + +packages/matter.js/dist/esm/storage/StorageBackendMemory.d.ts:19 ___ @@ -188,7 +214,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:82 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L82) ___ @@ -202,7 +228,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:68 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L68) ___ @@ -227,7 +253,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:58 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L58) ___ @@ -247,7 +273,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:92 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L92) ___ @@ -296,7 +322,31 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:31 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L31) + +___ + +### keys + +▸ **keys**(`contexts`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`string`[] + +#### Inherited from + +[StorageBackendMemory](storage_export.StorageBackendMemory.md).[keys](storage_export.StorageBackendMemory.md#keys) + +#### Defined in + +packages/matter.js/dist/esm/storage/StorageBackendMemory.d.ts:18 ___ @@ -328,7 +378,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:53 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L53) ___ @@ -348,7 +398,7 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:88 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L88) ___ @@ -362,4 +412,4 @@ ___ #### Defined in -packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:44 +[packages/matter-node.js/src/storage/StorageBackendJsonFile.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/storage/StorageBackendJsonFile.ts#L44) diff --git a/docs/matter-node.js/classes/storage_export.StorageBackendMemory.md b/docs/matter-node.js/classes/storage_export.StorageBackendMemory.md index 6edc9ebec1..fe57891466 100644 --- a/docs/matter-node.js/classes/storage_export.StorageBackendMemory.md +++ b/docs/matter-node.js/classes/storage_export.StorageBackendMemory.md @@ -28,10 +28,12 @@ ### Methods - [clear](storage_export.StorageBackendMemory.md#clear) +- [clearAll](storage_export.StorageBackendMemory.md#clearall) - [close](storage_export.StorageBackendMemory.md#close) - [delete](storage_export.StorageBackendMemory.md#delete) - [get](storage_export.StorageBackendMemory.md#get) - [initialize](storage_export.StorageBackendMemory.md#initialize) +- [keys](storage_export.StorageBackendMemory.md#keys) - [set](storage_export.StorageBackendMemory.md#set) ## Constructors @@ -86,6 +88,30 @@ packages/matter.js/dist/esm/storage/StorageBackendMemory.d.ts:14 ___ +### clearAll + +▸ **clearAll**(`contexts`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`void` + +#### Implementation of + +[Storage](storage_export.Storage.md).[clearAll](storage_export.Storage.md#clearall) + +#### Defined in + +packages/matter.js/dist/esm/storage/StorageBackendMemory.d.ts:19 + +___ + ### close ▸ **close**(): `Promise`<`void`\> @@ -178,6 +204,30 @@ packages/matter.js/dist/esm/storage/StorageBackendMemory.d.ts:12 ___ +### keys + +▸ **keys**(`contexts`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`string`[] + +#### Implementation of + +[Storage](storage_export.Storage.md).[keys](storage_export.Storage.md#keys) + +#### Defined in + +packages/matter.js/dist/esm/storage/StorageBackendMemory.d.ts:18 + +___ + ### set ▸ **set**<`T`\>(`contexts`, `key`, `value`): `void` diff --git a/docs/matter-node.js/classes/storage_export.StorageContext.md b/docs/matter-node.js/classes/storage_export.StorageContext.md index 6bee706507..289517ddf8 100644 --- a/docs/matter-node.js/classes/storage_export.StorageContext.md +++ b/docs/matter-node.js/classes/storage_export.StorageContext.md @@ -17,10 +17,13 @@ ### Methods +- [clear](storage_export.StorageContext.md#clear) +- [clearAll](storage_export.StorageContext.md#clearall) - [createContext](storage_export.StorageContext.md#createcontext) - [delete](storage_export.StorageContext.md#delete) - [get](storage_export.StorageContext.md#get) - [has](storage_export.StorageContext.md#has) +- [keys](storage_export.StorageContext.md#keys) - [set](storage_export.StorageContext.md#set) ## Constructors @@ -62,6 +65,38 @@ packages/matter.js/dist/esm/storage/StorageContext.d.ts:9 ## Methods +### clear + +▸ **clear**(): `void` + +Clears all keys in this context + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/storage/StorageContext.d.ts:19 + +___ + +### clearAll + +▸ **clearAll**(): `void` + +Clears all keys in this context and all created sub-contexts. + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/storage/StorageContext.d.ts:21 + +___ + ### createContext ▸ **createContext**(`context`): [`StorageContext`](storage_export.StorageContext.md) @@ -149,6 +184,20 @@ packages/matter.js/dist/esm/storage/StorageContext.d.ts:13 ___ +### keys + +▸ **keys**(): `string`[] + +#### Returns + +`string`[] + +#### Defined in + +packages/matter.js/dist/esm/storage/StorageContext.d.ts:17 + +___ + ### set ▸ **set**<`T`\>(`key`, `value`): `void` diff --git a/docs/matter-node.js/classes/time_export.TimeNode.md b/docs/matter-node.js/classes/time_export.TimeNode.md index a19f03d7db..78ebcbd912 100644 --- a/docs/matter-node.js/classes/time_export.TimeNode.md +++ b/docs/matter-node.js/classes/time_export.TimeNode.md @@ -219,7 +219,7 @@ Returns a timer that will periodically call callback at intervalMs intervals. #### Defined in -packages/matter-node.js/src/time/TimeNode.ts:51 +[packages/matter-node.js/src/time/TimeNode.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/time/TimeNode.ts#L58) ___ @@ -246,7 +246,7 @@ Returns a timer that will call callback after durationMs has passed. #### Defined in -packages/matter-node.js/src/time/TimeNode.ts:47 +[packages/matter-node.js/src/time/TimeNode.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/time/TimeNode.ts#L54) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -packages/matter-node.js/src/time/TimeNode.ts:39 +[packages/matter-node.js/src/time/TimeNode.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/time/TimeNode.ts#L46) ___ @@ -282,4 +282,4 @@ ___ #### Defined in -packages/matter-node.js/src/time/TimeNode.ts:43 +[packages/matter-node.js/src/time/TimeNode.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/time/TimeNode.ts#L50) diff --git a/docs/matter-node.js/classes/util_export.Cache.md b/docs/matter-node.js/classes/util_export.Cache.md index 5c131e28ef..e351b571e2 100644 --- a/docs/matter-node.js/classes/util_export.Cache.md +++ b/docs/matter-node.js/classes/util_export.Cache.md @@ -30,6 +30,7 @@ SPDX-License-Identifier: Apache-2.0 - [expire](util_export.Cache.md#expire) - [expireCallback](util_export.Cache.md#expirecallback) - [generator](util_export.Cache.md#generator) +- [knownKeys](util_export.Cache.md#knownkeys) - [periodicTimer](util_export.Cache.md#periodictimer) - [timestamps](util_export.Cache.md#timestamps) - [values](util_export.Cache.md#values) @@ -63,7 +64,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:15 +packages/matter.js/dist/esm/util/Cache.d.ts:16 ## Properties @@ -73,7 +74,7 @@ packages/matter.js/dist/esm/util/Cache.d.ts:15 #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:18 +packages/matter.js/dist/esm/util/Cache.d.ts:19 ___ @@ -93,7 +94,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:21 +packages/matter.js/dist/esm/util/Cache.d.ts:22 ___ @@ -117,13 +118,23 @@ packages/matter.js/dist/esm/util/Cache.d.ts:9 ___ +### knownKeys + +• `Private` `Readonly` **knownKeys**: `any` + +#### Defined in + +packages/matter.js/dist/esm/util/Cache.d.ts:12 + +___ + ### periodicTimer • `Private` `Readonly` **periodicTimer**: `any` #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:14 +packages/matter.js/dist/esm/util/Cache.d.ts:15 ___ @@ -133,7 +144,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:13 +packages/matter.js/dist/esm/util/Cache.d.ts:14 ___ @@ -143,7 +154,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:12 +packages/matter.js/dist/esm/util/Cache.d.ts:13 ## Methods @@ -157,7 +168,7 @@ packages/matter.js/dist/esm/util/Cache.d.ts:12 #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:19 +packages/matter.js/dist/esm/util/Cache.d.ts:20 ___ @@ -171,7 +182,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:20 +packages/matter.js/dist/esm/util/Cache.d.ts:21 ___ @@ -191,7 +202,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:16 +packages/matter.js/dist/esm/util/Cache.d.ts:17 ___ @@ -205,4 +216,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/util/Cache.d.ts:17 +packages/matter.js/dist/esm/util/Cache.d.ts:18 diff --git a/docs/matter-node.js/classes/export._internal_.NamedHandler.md b/docs/matter-node.js/classes/util_export.NamedHandler.md similarity index 76% rename from docs/matter-node.js/classes/export._internal_.NamedHandler.md rename to docs/matter-node.js/classes/util_export.NamedHandler.md index 8fb7a2a375..1eb2cad8be 100644 --- a/docs/matter-node.js/classes/export._internal_.NamedHandler.md +++ b/docs/matter-node.js/classes/util_export.NamedHandler.md @@ -1,31 +1,31 @@ -[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [export](../modules/export.md) / [](../modules/export._internal_.md) / NamedHandler +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [util/export](../modules/util_export.md) / NamedHandler # Class: NamedHandler -[export](../modules/export.md).[](../modules/export._internal_.md).NamedHandler +[util/export](../modules/util_export.md).NamedHandler ## Type parameters | Name | Type | | :------ | :------ | -| `H` | extends `Record` | +| `H` | extends `Record` | ## Table of contents ### Constructors -- [constructor](export._internal_.NamedHandler.md#constructor) +- [constructor](util_export.NamedHandler.md#constructor) ### Properties -- [handler](export._internal_.NamedHandler.md#handler) +- [handler](util_export.NamedHandler.md#handler) ### Methods -- [addHandler](export._internal_.NamedHandler.md#addhandler) -- [executeHandler](export._internal_.NamedHandler.md#executehandler) -- [hasHandler](export._internal_.NamedHandler.md#hashandler) -- [removeHandler](export._internal_.NamedHandler.md#removehandler) +- [addHandler](util_export.NamedHandler.md#addhandler) +- [executeHandler](util_export.NamedHandler.md#executehandler) +- [hasHandler](util_export.NamedHandler.md#hashandler) +- [removeHandler](util_export.NamedHandler.md#removehandler) ## Constructors @@ -37,7 +37,7 @@ | Name | Type | | :------ | :------ | -| `H` | extends `Record` | +| `H` | extends `Record` | ## Properties diff --git a/docs/matter-node.js/enums/export._internal_.CommissioningStepResultCode.md b/docs/matter-node.js/enums/export._internal_.CommissioningStepResultCode.md index c650e8b54c..64f14d5d53 100644 --- a/docs/matter-node.js/enums/export._internal_.CommissioningStepResultCode.md +++ b/docs/matter-node.js/enums/export._internal_.CommissioningStepResultCode.md @@ -4,7 +4,7 @@ [export](../modules/export.md).[](../modules/export._internal_.md).CommissioningStepResultCode -Result code of a single commissioning step +Result code of a single commissioning step. ## Table of contents @@ -22,7 +22,7 @@ Result code of a single commissioning step #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:33 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:36 ___ @@ -32,7 +32,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:34 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:37 ___ @@ -42,4 +42,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:32 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:35 diff --git a/docs/matter-node.js/enums/exports_device.NodeStateInformation.md b/docs/matter-node.js/enums/exports_device.NodeStateInformation.md new file mode 100644 index 0000000000..bab06ecd95 --- /dev/null +++ b/docs/matter-node.js/enums/exports_device.NodeStateInformation.md @@ -0,0 +1,78 @@ +[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [exports/device](../modules/exports_device.md) / NodeStateInformation + +# Enumeration: NodeStateInformation + +[exports/device](../modules/exports_device.md).NodeStateInformation + +## Table of contents + +### Enumeration Members + +- [Connected](exports_device.NodeStateInformation.md#connected) +- [Disconnected](exports_device.NodeStateInformation.md#disconnected) +- [Reconnecting](exports_device.NodeStateInformation.md#reconnecting) +- [StructureChanged](exports_device.NodeStateInformation.md#structurechanged) +- [WaitingForDeviceDiscovery](exports_device.NodeStateInformation.md#waitingfordevicediscovery) + +## Enumeration Members + +### Connected + +• **Connected** = ``0`` + +Node is connected and all data is up-to-date. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:19 + +___ + +### Disconnected + +• **Disconnected** = ``1`` + +Node is disconnected. Data are stale and interactions will most likely return an error. If controller instance +is still active then the device will be reconnected once it is available again. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:24 + +___ + +### Reconnecting + +• **Reconnecting** = ``2`` + +Node is reconnecting. Data are stale. It is yet unknown if the reconnection is successful. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:26 + +___ + +### StructureChanged + +• **StructureChanged** = ``4`` + +Node structure has changed (Endpoints got added or also removed). Data are up-to-date. +This State information will only be fired when the subscribeAllAttributesAndEvents option is set to true. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:36 + +___ + +### WaitingForDeviceDiscovery + +• **WaitingForDeviceDiscovery** = ``3`` + +The node could not be connected and the controller is now waiting for a MDNS announcement and tries every 10 +minutes to reconnect. + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:31 diff --git a/docs/matter-node.js/enums/exports_schema.CommissionningFlowType.md b/docs/matter-node.js/enums/exports_schema.CommissionningFlowType.md index b1b63c3555..e31c8a1dd4 100644 --- a/docs/matter-node.js/enums/exports_schema.CommissionningFlowType.md +++ b/docs/matter-node.js/enums/exports_schema.CommissionningFlowType.md @@ -24,7 +24,7 @@ Interaction with a vendor-specified means is needed before commissioning. #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:15 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:16 ___ @@ -36,7 +36,7 @@ When not commissioned, the device always enters commissioning mode upon power-up #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:11 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:12 ___ @@ -48,4 +48,4 @@ User action required to enter commissioning mode. #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:13 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:14 diff --git a/docs/matter-node.js/interfaces/export.CommissioningControllerOptions.md b/docs/matter-node.js/interfaces/export.CommissioningControllerOptions.md deleted file mode 100644 index 2d85bdb375..0000000000 --- a/docs/matter-node.js/interfaces/export.CommissioningControllerOptions.md +++ /dev/null @@ -1,144 +0,0 @@ -[@project-chip/matter-node.js](../README.md) / [Modules](../modules.md) / [export](../modules/export.md) / CommissioningControllerOptions - -# Interface: CommissioningControllerOptions - -[export](../modules/export.md).CommissioningControllerOptions - -Constructor options for the CommissioningController class - -## Table of contents - -### Properties - -- [commissioningOptions](export.CommissioningControllerOptions.md#commissioningoptions) -- [delayedPairing](export.CommissioningControllerOptions.md#delayedpairing) -- [listeningAddressIpv4](export.CommissioningControllerOptions.md#listeningaddressipv4) -- [listeningAddressIpv6](export.CommissioningControllerOptions.md#listeningaddressipv6) -- [localPort](export.CommissioningControllerOptions.md#localport) -- [longDiscriminator](export.CommissioningControllerOptions.md#longdiscriminator) -- [passcode](export.CommissioningControllerOptions.md#passcode) -- [serverAddress](export.CommissioningControllerOptions.md#serveraddress) -- [shortDiscriminator](export.CommissioningControllerOptions.md#shortdiscriminator) -- [subscribeAllAttributes](export.CommissioningControllerOptions.md#subscribeallattributes) -- [subscribeMaxIntervalCeilingSeconds](export.CommissioningControllerOptions.md#subscribemaxintervalceilingseconds) -- [subscribeMinIntervalFloorSeconds](export.CommissioningControllerOptions.md#subscribeminintervalfloorseconds) - -## Properties - -### commissioningOptions - -• `Optional` **commissioningOptions**: [`CommissioningOptions`](../modules/exports_protocol.md#commissioningoptions) - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:26 - -___ - -### delayedPairing - -• `Optional` `Readonly` **delayedPairing**: `boolean` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:19 - -___ - -### listeningAddressIpv4 - -• `Optional` `Readonly` **listeningAddressIpv4**: `string` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:17 - -___ - -### listeningAddressIpv6 - -• `Optional` `Readonly` **listeningAddressIpv6**: `string` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:18 - -___ - -### localPort - -• `Optional` `Readonly` **localPort**: `number` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:16 - -___ - -### longDiscriminator - -• `Optional` **longDiscriminator**: `number` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:24 - -___ - -### passcode - -• **passcode**: `number` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:23 - -___ - -### serverAddress - -• `Optional` **serverAddress**: [`ServerAddressIp`](../modules/exports_common.md#serveraddressip) - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:15 - -___ - -### shortDiscriminator - -• `Optional` **shortDiscriminator**: `number` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:25 - -___ - -### subscribeAllAttributes - -• `Optional` `Readonly` **subscribeAllAttributes**: `boolean` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:20 - -___ - -### subscribeMaxIntervalCeilingSeconds - -• `Optional` `Readonly` **subscribeMaxIntervalCeilingSeconds**: `number` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:22 - -___ - -### subscribeMinIntervalFloorSeconds - -• `Optional` `Readonly` **subscribeMinIntervalFloorSeconds**: `number` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningController.d.ts:21 diff --git a/docs/matter-node.js/interfaces/export.CommissioningServerOptions.md b/docs/matter-node.js/interfaces/export.CommissioningServerOptions.md index 92e21e3472..7e35b38e58 100644 --- a/docs/matter-node.js/interfaces/export.CommissioningServerOptions.md +++ b/docs/matter-node.js/interfaces/export.CommissioningServerOptions.md @@ -12,9 +12,11 @@ and allows to override the certificates used for the OperationalCredentials clus ### Properties +- [activeSessionsChangedCallback](export.CommissioningServerOptions.md#activesessionschangedcallback) - [additionalBleAdvertisementData](export.CommissioningServerOptions.md#additionalbleadvertisementdata) - [basicInformation](export.CommissioningServerOptions.md#basicinformation) - [certificates](export.CommissioningServerOptions.md#certificates) +- [commissioningChangedCallback](export.CommissioningServerOptions.md#commissioningchangedcallback) - [delayedAnnouncement](export.CommissioningServerOptions.md#delayedannouncement) - [deviceName](export.CommissioningServerOptions.md#devicename) - [deviceType](export.CommissioningServerOptions.md#devicetype) @@ -32,6 +34,34 @@ and allows to override the certificates used for the OperationalCredentials clus ## Properties +### activeSessionsChangedCallback + +• `Optional` **activeSessionsChangedCallback**: (`fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex)) => `void` + +#### Type declaration + +▸ (`fabricIndex`): `void` + +This callback is called when sessions to the device are established, closed or subscriptions get added or +removed. The provided fabricIndex can be used together with getActiveSessionInformation() to get more details +about the open sessions and their status. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `fabricIndex` | [`FabricIndex`](../modules/exports_datatype.md#fabricindex) | + +##### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/CommissioningServer.d.ts:113 + +___ + ### additionalBleAdvertisementData • `Optional` **additionalBleAdvertisementData**: `Uint8Array` @@ -40,20 +70,20 @@ Optional Vendor specific additional BLE Advertisement data. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:56 +packages/matter.js/dist/esm/CommissioningServer.d.ts:59 ___ ### basicInformation -• **basicInformation**: { `productId`: `number` ; `productName`: `string` ; `vendorId`: `number` ; `vendorName`: `string` } \| [`AttributeInitialValues`](../modules/exports_cluster.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `capabilityMinima`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](exports_tlv.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](exports_tlv.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](../modules/exports_cluster.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](../modules/exports_cluster.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](../modules/exports_cluster.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](../modules/exports_cluster.md#optionalattribute)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](../modules/exports_cluster.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<[`VendorId`](../modules/exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/exports_cluster.md#globalattributes-1)<{}\>\>\> +• **basicInformation**: { `productId`: `number` ; `productName`: `string` ; `vendorId`: `number` ; `vendorName`: `string` } \| [`AttributeInitialValues`](../modules/exports_cluster.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `capabilityMinima`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](exports_tlv.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](exports_tlv.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](../modules/exports_cluster.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](../modules/exports_cluster.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](../modules/exports_cluster.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<[`TypeFromFields`](../modules/exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](../modules/exports_cluster.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<[`VendorId`](../modules/exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](../modules/exports_cluster.md#fixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/exports_cluster.md#globalattributes-1)<{}\>\>\> Device details to be used for the BasicInformation cluster. Some of the values are initialized with defaults if not set here. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:80 +packages/matter.js/dist/esm/CommissioningServer.d.ts:83 ___ @@ -66,7 +96,35 @@ Vendor specific certificates to be used for the OperationalCredentials cluster. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:90 +packages/matter.js/dist/esm/CommissioningServer.d.ts:93 + +___ + +### commissioningChangedCallback + +• `Optional` **commissioningChangedCallback**: (`fabricIndex`: [`FabricIndex`](../modules/exports_datatype.md#fabricindex)) => `void` + +#### Type declaration + +▸ (`fabricIndex`): `void` + +This callback is called when the device is commissioned or decommissioned to a fabric/controller. The provided +fabricIndex can be used together with getCommissionedFabricInformation() to get more details about the fabric +(or if this fabricIndex is missing it was deleted). + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `fabricIndex` | [`FabricIndex`](../modules/exports_datatype.md#fabricindex) | + +##### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/CommissioningServer.d.ts:107 ___ @@ -78,7 +136,7 @@ Should the device directly be announced automatically by the MatterServer of man #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:58 +packages/matter.js/dist/esm/CommissioningServer.d.ts:61 ___ @@ -90,7 +148,7 @@ The device name to be used for the BasicInformation cluster. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:44 +packages/matter.js/dist/esm/CommissioningServer.d.ts:47 ___ @@ -102,19 +160,19 @@ The device type to be used for the BasicInformation cluster. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:46 +packages/matter.js/dist/esm/CommissioningServer.d.ts:49 ___ ### discriminator -• **discriminator**: `number` +• `Optional` **discriminator**: `number` The Discriminator to use for initial commissioning. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:52 +packages/matter.js/dist/esm/CommissioningServer.d.ts:55 ___ @@ -126,7 +184,7 @@ The Flow type of the Commissioning flow used in announcements. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:54 +packages/matter.js/dist/esm/CommissioningServer.d.ts:57 ___ @@ -139,7 +197,7 @@ Use these options to limit the allowed countries for regulatory configuration. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:95 +packages/matter.js/dist/esm/CommissioningServer.d.ts:98 ___ @@ -151,7 +209,7 @@ IPv4 listener address, defaults to all interfaces. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:40 +packages/matter.js/dist/esm/CommissioningServer.d.ts:43 ___ @@ -163,7 +221,7 @@ IPv6 listener address, defaults to all interfaces. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:42 +packages/matter.js/dist/esm/CommissioningServer.d.ts:45 ___ @@ -175,31 +233,31 @@ The next endpoint ID to be assigned to a new endpoint. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:48 +packages/matter.js/dist/esm/CommissioningServer.d.ts:51 ___ ### passcode -• **passcode**: `number` +• `Optional` **passcode**: `number` The passcode/pin of the device to use for initial commissioning. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:50 +packages/matter.js/dist/esm/CommissioningServer.d.ts:53 ___ ### port -• **port**: `number` +• `Optional` **port**: `number` Port of the server, normally automatically managed. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:38 +packages/matter.js/dist/esm/CommissioningServer.d.ts:41 ___ @@ -212,7 +270,7 @@ and inside the range requested by the connected controller. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:63 +packages/matter.js/dist/esm/CommissioningServer.d.ts:66 ___ @@ -226,7 +284,7 @@ limits. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:69 +packages/matter.js/dist/esm/CommissioningServer.d.ts:72 ___ @@ -240,4 +298,4 @@ powered on in parallel not all send at the same timepoint. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:75 +packages/matter.js/dist/esm/CommissioningServer.d.ts:78 diff --git a/docs/matter-node.js/interfaces/export.DevicePairingInformation.md b/docs/matter-node.js/interfaces/export.DevicePairingInformation.md index c550121d26..cde62422a1 100644 --- a/docs/matter-node.js/interfaces/export.DevicePairingInformation.md +++ b/docs/matter-node.js/interfaces/export.DevicePairingInformation.md @@ -11,7 +11,6 @@ Represents device pairing information. ### Properties - [manualPairingCode](export.DevicePairingInformation.md#manualpairingcode) -- [qrCode](export.DevicePairingInformation.md#qrcode) - [qrPairingCode](export.DevicePairingInformation.md#qrpairingcode) ## Properties @@ -22,17 +21,7 @@ Represents device pairing information. #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:27 - -___ - -### qrCode - -• **qrCode**: `string` - -#### Defined in - -packages/matter.js/dist/esm/CommissioningServer.d.ts:29 +packages/matter.js/dist/esm/CommissioningServer.d.ts:31 ___ @@ -42,4 +31,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:28 +packages/matter.js/dist/esm/CommissioningServer.d.ts:32 diff --git a/docs/matter-node.js/interfaces/exports_common.Scanner.md b/docs/matter-node.js/interfaces/exports_common.Scanner.md index 1c8940c487..1991c21f47 100644 --- a/docs/matter-node.js/interfaces/exports_common.Scanner.md +++ b/docs/matter-node.js/interfaces/exports_common.Scanner.md @@ -12,14 +12,39 @@ ### Methods +- [cancelCommissionableDeviceDiscovery](exports_common.Scanner.md#cancelcommissionabledevicediscovery) - [close](exports_common.Scanner.md#close) - [findCommissionableDevices](exports_common.Scanner.md#findcommissionabledevices) +- [findCommissionableDevicesContinuously](exports_common.Scanner.md#findcommissionabledevicescontinuously) - [findOperationalDevice](exports_common.Scanner.md#findoperationaldevice) - [getDiscoveredCommissionableDevices](exports_common.Scanner.md#getdiscoveredcommissionabledevices) - [getDiscoveredOperationalDevices](exports_common.Scanner.md#getdiscoveredoperationaldevices) ## Methods +### cancelCommissionableDeviceDiscovery + +▸ **cancelCommissionableDeviceDiscovery**(`identifier`): `void` + +Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would +be over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Defined in + +packages/matter.js/dist/esm/common/Scanner.d.ts:94 + +___ + ### close ▸ **close**(): `void` @@ -32,22 +57,49 @@ Close the scanner server and free resources. #### Defined in -packages/matter.js/dist/esm/common/Scanner.d.ts:84 +packages/matter.js/dist/esm/common/Scanner.d.ts:96 ___ ### findCommissionableDevices -▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> +▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> + +Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, +vendorId, etc.) and returns as soon as minimum one was found or the timeout is over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | +| `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> + +#### Defined in + +packages/matter.js/dist/esm/common/Scanner.d.ts:81 + +___ + +### findCommissionableDevicesContinuously + +▸ **findCommissionableDevicesContinuously**(`identifier`, `callback`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)[]\> -Send DNS-SD queries to discover commissionable devices by an provided identifier (e.g. discriminator, -vendorId, etc.) and return them. +Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, +vendorId, etc.) and returns after the timeout is over. For each new discovered device the provided callback is +called when it is discovered. #### Parameters | Name | Type | | :------ | :------ | | `identifier` | [`CommissionableDeviceIdentifiers`](../modules/exports_common.md#commissionabledeviceidentifiers) | +| `callback` | (`device`: [`CommissionableDevice`](../modules/exports_common.md#commissionabledevice)) => `void` | | `timeoutSeconds?` | `number` | #### Returns @@ -56,13 +108,13 @@ vendorId, etc.) and return them. #### Defined in -packages/matter.js/dist/esm/common/Scanner.d.ts:80 +packages/matter.js/dist/esm/common/Scanner.d.ts:87 ___ ### findOperationalDevice -▸ **findOperationalDevice**(`fabric`, `nodeId`, `timeoutSeconds?`): `Promise`<[`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[]\> +▸ **findOperationalDevice**(`fabric`, `nodeId`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`ServerAddressIp`](../modules/exports_common.md#serveraddressip)[]\> Send DNS-SD queries to discover the current addresses of an operational paired device by its operational ID and return them. @@ -74,6 +126,7 @@ and return them. | `fabric` | [`Fabric`](../classes/exports_fabric.Fabric.md) | | `nodeId` | [`NodeId`](../modules/exports_datatype.md#nodeid) | | `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | #### Returns @@ -81,7 +134,7 @@ and return them. #### Defined in -packages/matter.js/dist/esm/common/Scanner.d.ts:70 +packages/matter.js/dist/esm/common/Scanner.d.ts:71 ___ @@ -103,7 +156,7 @@ Return already discovered commissionable devices and return them. Does not send #### Defined in -packages/matter.js/dist/esm/common/Scanner.d.ts:82 +packages/matter.js/dist/esm/common/Scanner.d.ts:89 ___ @@ -127,4 +180,4 @@ DNS-SD queries. #### Defined in -packages/matter.js/dist/esm/common/Scanner.d.ts:75 +packages/matter.js/dist/esm/common/Scanner.d.ts:76 diff --git a/docs/matter-node.js/interfaces/exports_interaction.AttributeStatus.md b/docs/matter-node.js/interfaces/exports_interaction.AttributeStatus.md index 8ba52cf2fc..b67d4fa2d8 100644 --- a/docs/matter-node.js/interfaces/exports_interaction.AttributeStatus.md +++ b/docs/matter-node.js/interfaces/exports_interaction.AttributeStatus.md @@ -28,7 +28,7 @@ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:22 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:23 ___ @@ -38,4 +38,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:28 +packages/matter.js/dist/esm/protocol/interaction/InteractionClient.d.ts:29 diff --git a/docs/matter-node.js/interfaces/exports_protocol.ProtocolHandler.md b/docs/matter-node.js/interfaces/exports_protocol.ProtocolHandler.md index 8c18bb2037..6d64c74f36 100644 --- a/docs/matter-node.js/interfaces/exports_protocol.ProtocolHandler.md +++ b/docs/matter-node.js/interfaces/exports_protocol.ProtocolHandler.md @@ -15,18 +15,33 @@ - [`CaseServer`](../classes/exports_session.CaseServer.md) - [`InteractionServer`](../classes/exports_interaction.InteractionServer.md) - [`PaseServer`](../classes/exports_session.PaseServer.md) -- [`SecureChannelProtocol`](../classes/exports_securechannel.SecureChannelProtocol.md) +- [`StatusReportOnlySecureChannelProtocol`](../classes/exports_securechannel.StatusReportOnlySecureChannelProtocol.md) - [`SubscriptionClient`](../classes/exports_interaction.SubscriptionClient.md) ## Table of contents ### Methods +- [close](exports_protocol.ProtocolHandler.md#close) - [getId](exports_protocol.ProtocolHandler.md#getid) - [onNewExchange](exports_protocol.ProtocolHandler.md#onnewexchange) ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/matter.js/dist/esm/protocol/ProtocolHandler.d.ts:11 + +___ + ### getId ▸ **getId**(): `number` diff --git a/docs/matter-node.js/interfaces/exports_session.Session.md b/docs/matter-node.js/interfaces/exports_session.Session.md index dde24e179f..ae9879cf02 100644 --- a/docs/matter-node.js/interfaces/exports_session.Session.md +++ b/docs/matter-node.js/interfaces/exports_session.Session.md @@ -19,6 +19,7 @@ ### Properties +- [closingAfterExchangeFinished](exports_session.Session.md#closingafterexchangefinished) - [name](exports_session.Session.md#name) ### Methods @@ -41,6 +42,16 @@ ## Properties +### closingAfterExchangeFinished + +• **closingAfterExchangeFinished**: `boolean` + +#### Defined in + +packages/matter.js/dist/esm/session/Session.d.ts:25 + +___ + ### name • **name**: `string` @@ -67,19 +78,20 @@ packages/matter.js/dist/esm/session/Session.d.ts:24 #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:27 +packages/matter.js/dist/esm/session/Session.d.ts:28 ___ ### destroy -▸ **destroy**(`sendClose`): `Promise`<`void`\> +▸ **destroy**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | | `sendClose` | `boolean` | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -87,7 +99,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:36 +packages/matter.js/dist/esm/session/Session.d.ts:37 ___ @@ -107,7 +119,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:28 +packages/matter.js/dist/esm/session/Session.d.ts:29 ___ @@ -127,7 +139,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:35 +packages/matter.js/dist/esm/session/Session.d.ts:36 ___ @@ -141,7 +153,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:39 +packages/matter.js/dist/esm/session/Session.d.ts:40 ___ @@ -155,7 +167,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:30 +packages/matter.js/dist/esm/session/Session.d.ts:31 ___ @@ -169,7 +181,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:31 +packages/matter.js/dist/esm/session/Session.d.ts:32 ___ @@ -183,7 +195,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:29 +packages/matter.js/dist/esm/session/Session.d.ts:30 ___ @@ -197,7 +209,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:33 +packages/matter.js/dist/esm/session/Session.d.ts:34 ___ @@ -211,7 +223,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:34 +packages/matter.js/dist/esm/session/Session.d.ts:35 ___ @@ -225,7 +237,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:32 +packages/matter.js/dist/esm/session/Session.d.ts:33 ___ @@ -239,7 +251,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:26 +packages/matter.js/dist/esm/session/Session.d.ts:27 ___ @@ -253,7 +265,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:38 +packages/matter.js/dist/esm/session/Session.d.ts:39 ___ @@ -267,7 +279,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:25 +packages/matter.js/dist/esm/session/Session.d.ts:26 ___ @@ -287,4 +299,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/session/Session.d.ts:37 +packages/matter.js/dist/esm/session/Session.d.ts:38 diff --git a/docs/matter-node.js/interfaces/net_export.UdpChannel.md b/docs/matter-node.js/interfaces/net_export.UdpChannel.md index e652a0e2ac..7d6f95222d 100644 --- a/docs/matter-node.js/interfaces/net_export.UdpChannel.md +++ b/docs/matter-node.js/interfaces/net_export.UdpChannel.md @@ -29,7 +29,7 @@ #### Defined in -packages/matter.js/dist/esm/net/UdpChannel.d.ts:17 +packages/matter.js/dist/esm/net/UdpChannel.d.ts:18 ___ @@ -49,7 +49,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/net/UdpChannel.d.ts:15 +packages/matter.js/dist/esm/net/UdpChannel.d.ts:16 ___ @@ -71,4 +71,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/net/UdpChannel.d.ts:16 +packages/matter.js/dist/esm/net/UdpChannel.d.ts:17 diff --git a/docs/matter-node.js/interfaces/net_export.UdpChannelOptions.md b/docs/matter-node.js/interfaces/net_export.UdpChannelOptions.md index 88c017d09c..56fb26b36c 100644 --- a/docs/matter-node.js/interfaces/net_export.UdpChannelOptions.md +++ b/docs/matter-node.js/interfaces/net_export.UdpChannelOptions.md @@ -10,6 +10,7 @@ - [listeningAddress](net_export.UdpChannelOptions.md#listeningaddress) - [listeningPort](net_export.UdpChannelOptions.md#listeningport) +- [membershipAddresses](net_export.UdpChannelOptions.md#membershipaddresses) - [netInterface](net_export.UdpChannelOptions.md#netinterface) - [type](net_export.UdpChannelOptions.md#type) @@ -35,6 +36,16 @@ packages/matter.js/dist/esm/net/UdpChannel.d.ts:9 ___ +### membershipAddresses + +• `Optional` **membershipAddresses**: `string`[] + +#### Defined in + +packages/matter.js/dist/esm/net/UdpChannel.d.ts:13 + +___ + ### netInterface • `Optional` **netInterface**: `string` diff --git a/docs/matter-node.js/modules/export._internal_.md b/docs/matter-node.js/modules/export._internal_.md index 1f8b145d43..61826e4b2e 100644 --- a/docs/matter-node.js/modules/export._internal_.md +++ b/docs/matter-node.js/modules/export._internal_.md @@ -42,7 +42,6 @@ - [ManualPairingCodeSchema](../classes/export._internal_.ManualPairingCodeSchema.md) - [MatterController](../classes/export._internal_.MatterController.md) - [MatterDevice](../classes/export._internal_.MatterDevice.md) -- [NamedHandler](../classes/export._internal_.NamedHandler.md) - [QrPairingCodeSchema](../classes/export._internal_.QrPairingCodeSchema.md) - [UdpConnection](../classes/export._internal_.UdpConnection.md) @@ -73,6 +72,7 @@ - [AttributeSetters](export._internal_.md#attributesetters) - [AttributeValidators](export._internal_.md#attributevalidators) - [BitRange](export._internal_.md#bitrange) +- [BuildArrayMinLength](export._internal_.md#buildarrayminlength) - [ClientAttributeGetters](export._internal_.md#clientattributegetters) - [ClientAttributeListeners](export._internal_.md#clientattributelisteners) - [ClientAttributeSetters](export._internal_.md#clientattributesetters) @@ -89,12 +89,11 @@ - [CommissioningStepResult](export._internal_.md#commissioningstepresult) - [DimmableDeviceCommands](export._internal_.md#dimmabledevicecommands) - [ElementSelector](export._internal_.md#elementselector) -- [EndpointLoggingOptions](export._internal_.md#endpointloggingoptions) - [ErrorHandler](export._internal_.md#errorhandler) - [EventDataPayload](export._internal_.md#eventdatapayload) +- [ExtendPublicHandlerMethods](export._internal_.md#extendpublichandlermethods) - [GetterTypeFromSpec](export._internal_.md#gettertypefromspec) - [GetterTypeFromSpec](export._internal_.md#gettertypefromspec-1) -- [HandlerFunction](export._internal_.md#handlerfunction) - [LengthConstraints](export._internal_.md#lengthconstraints) - [LengthConstraints](export._internal_.md#lengthconstraints-1) - [MakeAttributeMandatory](export._internal_.md#makeattributemandatory) @@ -207,7 +206,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:48 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:51 ___ @@ -225,7 +224,7 @@ Handlers to process cluster commands #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:84 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:87 ___ @@ -241,7 +240,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:56 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:59 ___ @@ -257,7 +256,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:63 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:66 ___ @@ -289,6 +288,24 @@ packages/matter.js/dist/esm/schema/BitmapSchema.d.ts:20 ___ +### BuildArrayMinLength + +Ƭ **BuildArrayMinLength**<`T`, `N`, `Current`\>: `Current`[``"length"``] extends `N` ? [...Current, ...T[]] : [`BuildArrayMinLength`](export._internal_.md#buildarrayminlength)<`T`, `N`, [...Current, `T`]\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `N` | extends `number` | +| `Current` | extends `T`[] | + +#### Defined in + +packages/matter.js/dist/esm/util/Array.d.ts:9 + +___ + ### ClientAttributeGetters Ƭ **ClientAttributeGetters**<`A`\>: `Omit`<{ [P in keyof A as \`get${Capitalize}Attribute\`]: Function }, keyof [`GlobalAttributes`](exports_cluster.md#globalattributes-1)<`any`\>\> @@ -301,7 +318,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:43 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:44 ___ @@ -317,7 +334,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:60 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:61 ___ @@ -333,7 +350,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:54 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:55 ___ @@ -349,7 +366,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:57 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:58 ___ @@ -365,7 +382,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:66 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:67 ___ @@ -381,7 +398,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:72 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:73 ___ @@ -397,7 +414,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:69 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:70 ___ @@ -413,7 +430,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:46 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:47 ___ @@ -480,7 +497,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:78 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:81 ___ @@ -496,7 +513,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:63 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:64 ___ @@ -514,7 +531,7 @@ Commands exposed by the CommissioningServer #### Defined in -packages/matter.js/dist/esm/CommissioningServer.d.ts:103 +packages/matter.js/dist/esm/CommissioningServer.d.ts:118 ___ @@ -534,7 +551,7 @@ Breadcrump value is stored for each step for transparency #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:40 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:43 ___ @@ -571,38 +588,6 @@ packages/matter.js/dist/esm/model/logic/ModelTraversal.d.ts:129 ___ -### EndpointLoggingOptions - -Ƭ **EndpointLoggingOptions**: `Object` - -Options for logging endpoint structure. The default is that anything is logged beside "Non present" attributes and -events on ClusterClients. The Filter methods can be used to filter out specific endpoints or clusters if wanted. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `clusterClientFilter?` | (`endpoint`: [`Endpoint`](../classes/exports_device.Endpoint.md), `cluster`: [`ClusterClientObj`](exports_cluster.md#clusterclientobj)<`any`, `any`, `any`, `any`\>) => `boolean` | -| `clusterServerFilter?` | (`endpoint`: [`Endpoint`](../classes/exports_device.Endpoint.md), `cluster`: [`ClusterServerObj`](exports_cluster.md#clusterserverobj)<`any`, `any`\>) => `boolean` | -| `endpointFilter?` | (`endpoint`: [`Endpoint`](../classes/exports_device.Endpoint.md)) => `boolean` | -| `logAttributeObjectValues?` | `boolean` | -| `logAttributePrimitiveValues?` | `boolean` | -| `logChildEndpoints?` | `boolean` | -| `logClusterAttributes?` | `boolean` | -| `logClusterClients?` | `boolean` | -| `logClusterCommands?` | `boolean` | -| `logClusterEvents?` | `boolean` | -| `logClusterGlobalAttributes?` | `boolean` | -| `logClusterServers?` | `boolean` | -| `logNotPresentClusterAttributes?` | `boolean` | -| `logNotPresentClusterEvents?` | `boolean` | - -#### Defined in - -packages/matter.js/dist/esm/device/EndpointStructureLogger.d.ts:13 - -___ - ### ErrorHandler Ƭ **ErrorHandler**<`T`, `E`\>: (`error`: `E`) => `T` @@ -646,19 +631,20 @@ packages/matter.js/dist/esm/protocol/interaction/AttributeDataEncoder.d.ts:21 ___ -### GetterTypeFromSpec +### ExtendPublicHandlerMethods -Ƭ **GetterTypeFromSpec**<`A`\>: `A` extends [`OptionalAttribute`](exports_cluster.md#optionalattribute) ? `T` \| `undefined` : [`AttributeJsType`](exports_cluster.md#attributejstype)<`A`\> +Ƭ **ExtendPublicHandlerMethods**<`ParentClass`, `H`\>: `ParentClass` extends (...`args`: infer TArgs) => infer T ? (...`args`: `TArgs`) => `T` & { `_executeHandler`: (`action`: `K`, ...`args`: `Parameters`<`H`[`K`]\>) => `Promise`<`void`\> ; `addCommandHandler`: (`action`: `K`, `handler`: `H`[`K`]) => `void` ; `removeCommandHandler`: (`action`: `K`, `handler`: `H`[`K`]) => `void` } : `never` #### Type parameters | Name | Type | | :------ | :------ | -| `A` | extends [`Attribute`](exports_cluster.md#attribute)<`any`, `any`\> | +| `ParentClass` | extends (...`args`: `any`[]) => `any` | +| `H` | extends `Record` | #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:42 +packages/matter.js/dist/esm/util/NamedHandler.d.ts:14 ___ @@ -674,36 +660,23 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:115 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:43 ___ -### HandlerFunction - -Ƭ **HandlerFunction**: (...`args`: `any`[]) => `any` - -#### Type declaration +### GetterTypeFromSpec -▸ (`...args`): `any` +Ƭ **GetterTypeFromSpec**<`A`\>: `A` extends [`OptionalAttribute`](exports_cluster.md#optionalattribute) ? `T` \| `undefined` : [`AttributeJsType`](exports_cluster.md#attributejstype)<`A`\> -##### Parameters +#### Type parameters | Name | Type | | :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`any` - -**`License`** - -Copyright 2022 The matter.js Authors -SPDX-License-Identifier: Apache-2.0 +| `A` | extends [`Attribute`](exports_cluster.md#attribute)<`any`, `any`\> | #### Defined in -packages/matter.js/dist/esm/util/NamedHandler.d.ts:6 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:118 ___ @@ -755,7 +728,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:101 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:104 ___ @@ -772,10 +745,10 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:102 - packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:105 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:108 + ___ ### MandatoryAttributeServers @@ -792,7 +765,7 @@ Cluster attributes accessible on the cluster server #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:24 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:27 ___ @@ -808,7 +781,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:42 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:45 ___ @@ -869,7 +842,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:98 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:101 ___ @@ -885,7 +858,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:27 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:30 ___ @@ -901,7 +874,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:45 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:48 ___ @@ -933,7 +906,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:116 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:119 ___ @@ -949,7 +922,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:123 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:126 ___ @@ -965,7 +938,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:128 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:131 ___ @@ -981,7 +954,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:138 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:141 ___ @@ -1088,9 +1061,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:106 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:109 -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:108 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:111 ___ @@ -1106,7 +1079,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:49 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:50 ## Variables @@ -1161,7 +1134,7 @@ See [MatterCoreSpecificationV1_0](../interfaces/exports_spec.MatterCoreSpecifica #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:35 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:36 ## Functions @@ -1253,7 +1226,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:105 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:108 ___ @@ -1283,4 +1256,4 @@ Forces the presence of the specified optional attributes, so they can be used in #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:108 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:111 diff --git a/docs/matter-node.js/modules/export.md b/docs/matter-node.js/modules/export.md index 5609432d14..8f2bc78382 100644 --- a/docs/matter-node.js/modules/export.md +++ b/docs/matter-node.js/modules/export.md @@ -26,15 +26,20 @@ ### Interfaces -- [CommissioningControllerOptions](../interfaces/export.CommissioningControllerOptions.md) - [CommissioningServerOptions](../interfaces/export.CommissioningServerOptions.md) - [DevicePairingInformation](../interfaces/export.DevicePairingInformation.md) ### Type Aliases +- [CommissioningControllerOptions](export.md#commissioningcontrolleroptions) - [MatterServerOptions](export.md#matterserveroptions) +- [NodeCommissioningOptions](export.md#nodecommissioningoptions) - [NodeOptions](export.md#nodeoptions) +### Variables + +- [FORBIDDEN\_PASSCODES](export.md#forbidden_passcodes) + ## References ### MatterApplicationClusterSpecificationV1\_0 @@ -73,6 +78,18 @@ Re-exports [MatterDeviceLibrarySpecificationV1_1](../interfaces/exports_spec.Mat ## Type Aliases +### CommissioningControllerOptions + +Ƭ **CommissioningControllerOptions**: [`CommissioningControllerNodeOptions`](exports_device.md#commissioningcontrollernodeoptions) & { `adminFabricId?`: [`FabricId`](exports_datatype.md#fabricid) ; `adminFabricIndex?`: [`FabricIndex`](exports_datatype.md#fabricindex) ; `adminVendorId?`: [`VendorId`](exports_datatype.md#vendorid) ; `autoConnect?`: `boolean` ; `listeningAddressIpv4?`: `string` ; `listeningAddressIpv6?`: `string` ; `localPort?`: `number` } + +Constructor options for the CommissioningController class + +#### Defined in + +packages/matter.js/dist/esm/CommissioningController.d.ts:25 + +___ + ### MatterServerOptions Ƭ **MatterServerOptions**: `Object` @@ -82,11 +99,24 @@ Re-exports [MatterDeviceLibrarySpecificationV1_1](../interfaces/exports_spec.Mat | Name | Type | Description | | :------ | :------ | :------ | | `disableIpv4?` | `boolean` | If set to true no IPv4 socket listener is sed and only IPv6 is supported. | -| `mdnsAnnounceInterface?` | `string` | Interface to use for MDNS announcements. If not provided announcements will be sent from all network interfaces | +| `mdnsAnnounceInterface?` | `string` | Interface to use for MDNS announcements. If not provided announcements will be sent from all network interfaces TODO: Remove in later versions then 0.7 **`Deprecated`** | +| `mdnsInterface?` | `string` | Interface to use for MDNS announcements and scanning. If not provided announcements/scanning will be done on all network interfaces | + +#### Defined in + +packages/matter.js/dist/esm/MatterServer.d.ts:19 + +___ + +### NodeCommissioningOptions + +Ƭ **NodeCommissioningOptions**: [`CommissioningControllerNodeOptions`](exports_device.md#commissioningcontrollernodeoptions) & { `commissioning?`: [`CommissioningOptions`](exports_protocol.md#commissioningoptions) ; `discovery`: { `identifierData`: [`CommissionableDeviceIdentifiers`](exports_common.md#commissionabledeviceidentifiers) } \| { `commissionableDevice`: [`CommissionableDevice`](exports_common.md#commissionabledevice) } & { `discoveryCapabilities?`: [`TypeFromPartialBitSchema`](exports_schema.md#typefrompartialbitschema) ; `knownAddress?`: [`ServerAddress`](exports_common.md#serveraddress) ; `timeoutSeconds?`: `number` } ; `passcode`: `number` } + +Options needed to commission a new node #### Defined in -packages/matter.js/dist/esm/MatterServer.d.ts:13 +packages/matter.js/dist/esm/CommissioningController.d.ts:55 ___ @@ -98,8 +128,19 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `uniqueNodeId?` | `string` | Unique node id to use for the storage context of this node. If not provided the order of node addition is used. | +| `uniqueNodeId?` | `string` | Deprecated name for uniqueStorageKey TODO: Remove with 0.8 or such **`Deprecated`** | +| `uniqueStorageKey?` | `string` | Unique storage key for this node to use for the storage context of this node. If not provided the order of node addition is used. | #### Defined in packages/matter.js/dist/esm/MatterServer.d.ts:9 + +## Variables + +### FORBIDDEN\_PASSCODES + +• `Const` **FORBIDDEN\_PASSCODES**: `number`[] + +#### Defined in + +packages/matter.js/dist/esm/CommissioningServer.d.ts:26 diff --git a/docs/matter-node.js/modules/exports_cluster.ApplicationLauncher.md b/docs/matter-node.js/modules/exports_cluster.ApplicationLauncher.md index 3db2a76afd..480c39e0db 100644 --- a/docs/matter-node.js/modules/exports_cluster.ApplicationLauncher.md +++ b/docs/matter-node.js/modules/exports_cluster.ApplicationLauncher.md @@ -42,7 +42,7 @@ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:975 +packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:974 ## Variables @@ -102,7 +102,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:986 +packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:985 ___ diff --git a/docs/matter-node.js/modules/exports_cluster.BasicInformation.md b/docs/matter-node.js/modules/exports_cluster.BasicInformation.md index 951ff739ea..ebe82d791b 100644 --- a/docs/matter-node.js/modules/exports_cluster.BasicInformation.md +++ b/docs/matter-node.js/modules/exports_cluster.BasicInformation.md @@ -24,7 +24,7 @@ ### Cluster -• `Const` **Cluster**: [`Definition`](exports_cluster.ClusterFactory.md#definition)<{ `attributes`: { `capabilityMinima`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `dataModelRevision`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](exports_cluster.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](exports_cluster.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `productId`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/datatype/VendorId"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_datatype_VendorId_.md), `any`\> ; `vendorName`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `reachableChanged`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `shutDown`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `startUp`: [`Event`](exports_cluster.md#event)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> } ; `id`: ``40`` ; `name`: ``"BasicInformation"`` ; `revision`: ``2`` }\> +• `Const` **Cluster**: [`Definition`](exports_cluster.ClusterFactory.md#definition)<{ `attributes`: { `capabilityMinima`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `dataModelRevision`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](exports_cluster.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](exports_cluster.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `productId`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/datatype/VendorId"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_datatype_VendorId_.md), `any`\> ; `vendorName`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `reachableChanged`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `shutDown`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `startUp`: [`Event`](exports_cluster.md#event)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> } ; `id`: ``40`` ; `name`: ``"BasicInformation"`` ; `revision`: ``2`` }\> Basic Information diff --git a/docs/matter-node.js/modules/exports_cluster.BridgedDeviceBasicInformation.md b/docs/matter-node.js/modules/exports_cluster.BridgedDeviceBasicInformation.md index e063282526..f9d79b8509 100644 --- a/docs/matter-node.js/modules/exports_cluster.BridgedDeviceBasicInformation.md +++ b/docs/matter-node.js/modules/exports_cluster.BridgedDeviceBasicInformation.md @@ -22,7 +22,7 @@ ### Cluster -• `Const` **Cluster**: [`Definition`](exports_cluster.ClusterFactory.md#definition)<{ `attributes`: { `hardwareVersion`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `productLabel`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](exports_cluster.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/datatype/VendorId"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_datatype_VendorId_.md), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `reachableChanged`: [`Event`](exports_cluster.md#event)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `shutDown`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `startUp`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> } ; `id`: ``57`` ; `name`: ``"BridgedDeviceBasicInformation"`` ; `revision`: ``2`` }\> +• `Const` **Cluster**: [`Definition`](exports_cluster.ClusterFactory.md#definition)<{ `attributes`: { `hardwareVersion`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `productLabel`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](exports_cluster.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/datatype/VendorId"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_datatype_VendorId_.md), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `reachableChanged`: [`Event`](exports_cluster.md#event)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> ; `shutDown`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `startUp`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`"/home/runner/work/matter.js/matter.js/packages/matter.js/dist/esm/tlv/TlvObject"`](export._internal_.__home_runner_work_matter_js_matter_js_packages_matter_js_dist_esm_tlv_TlvObject_.md), `any`\> } ; `id`: ``57`` ; `name`: ``"BridgedDeviceBasicInformation"`` ; `revision`: ``2`` }\> Bridged Device Basic Information diff --git a/docs/matter-node.js/modules/exports_cluster.KeypadInput.md b/docs/matter-node.js/modules/exports_cluster.KeypadInput.md index 2f3f8ac4f3..3145c49f12 100644 --- a/docs/matter-node.js/modules/exports_cluster.KeypadInput.md +++ b/docs/matter-node.js/modules/exports_cluster.KeypadInput.md @@ -37,7 +37,7 @@ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:377 +packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:381 ## Variables diff --git a/docs/matter-node.js/modules/exports_cluster.LevelControl.md b/docs/matter-node.js/modules/exports_cluster.LevelControl.md index 39a49a6451..297551a0e3 100644 --- a/docs/matter-node.js/modules/exports_cluster.LevelControl.md +++ b/docs/matter-node.js/modules/exports_cluster.LevelControl.md @@ -48,7 +48,7 @@ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1144 +packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1148 ## Variables @@ -97,7 +97,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1157 +packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1161 ___ diff --git a/docs/matter-node.js/modules/exports_cluster.NetworkCommissioning.md b/docs/matter-node.js/modules/exports_cluster.NetworkCommissioning.md index de872c0b88..15df1a7cfe 100644 --- a/docs/matter-node.js/modules/exports_cluster.NetworkCommissioning.md +++ b/docs/matter-node.js/modules/exports_cluster.NetworkCommissioning.md @@ -52,7 +52,7 @@ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:1691 +packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:1688 ## Variables @@ -112,7 +112,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:1721 +packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:1718 ___ diff --git a/docs/matter-node.js/modules/exports_cluster.ThreadNetworkDiagnostics.md b/docs/matter-node.js/modules/exports_cluster.ThreadNetworkDiagnostics.md index 2cabd9dfe0..f42d706a53 100644 --- a/docs/matter-node.js/modules/exports_cluster.ThreadNetworkDiagnostics.md +++ b/docs/matter-node.js/modules/exports_cluster.ThreadNetworkDiagnostics.md @@ -46,7 +46,7 @@ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2272 +packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2280 ## Variables @@ -97,7 +97,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2287 +packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2295 ___ diff --git a/docs/matter-node.js/modules/exports_cluster.TimeSync.md b/docs/matter-node.js/modules/exports_cluster.TimeSync.md index 6b28ddfeb7..330d41f88b 100644 --- a/docs/matter-node.js/modules/exports_cluster.TimeSync.md +++ b/docs/matter-node.js/modules/exports_cluster.TimeSync.md @@ -44,7 +44,7 @@ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:816 +packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:817 ## Variables @@ -99,7 +99,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:831 +packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:832 ___ diff --git a/docs/matter-node.js/modules/exports_cluster.WiFiNetworkDiagnostics.md b/docs/matter-node.js/modules/exports_cluster.WiFiNetworkDiagnostics.md index 8b41ed8cd9..761f6ef6be 100644 --- a/docs/matter-node.js/modules/exports_cluster.WiFiNetworkDiagnostics.md +++ b/docs/matter-node.js/modules/exports_cluster.WiFiNetworkDiagnostics.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:686 +packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:705 ## Variables @@ -93,7 +93,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:699 +packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:718 ___ diff --git a/docs/matter-node.js/modules/exports_cluster.md b/docs/matter-node.js/modules/exports_cluster.md index caf2d05c2a..9ccd6ed9c0 100644 --- a/docs/matter-node.js/modules/exports_cluster.md +++ b/docs/matter-node.js/modules/exports_cluster.md @@ -101,11 +101,11 @@ - [FixedAttributeServer](../classes/exports_cluster.FixedAttributeServer.md) - [GroupsManager](../classes/exports_cluster.GroupsManager.md) - [IllegalClusterError](../classes/exports_cluster.IllegalClusterError.md) -- [PresentAttributeClient](../classes/exports_cluster.PresentAttributeClient.md) -- [PresentEventClient](../classes/exports_cluster.PresentEventClient.md) - [ScenesManager](../classes/exports_cluster.ScenesManager.md) -- [UnknownPresentAttributeClient](../classes/exports_cluster.UnknownPresentAttributeClient.md) -- [UnknownPresentEventClient](../classes/exports_cluster.UnknownPresentEventClient.md) +- [SupportedAttributeClient](../classes/exports_cluster.SupportedAttributeClient.md) +- [SupportedEventClient](../classes/exports_cluster.SupportedEventClient.md) +- [UnknownSupportedAttributeClient](../classes/exports_cluster.UnknownSupportedAttributeClient.md) +- [UnknownSupportedEventClient](../classes/exports_cluster.UnknownSupportedEventClient.md) ### Interfaces @@ -473,9 +473,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:1231 +packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:1230 -packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:1232 +packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:1231 ___ @@ -492,7 +492,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:19 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:20 ___ @@ -510,7 +510,7 @@ Initial values for the cluster attribute #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:32 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:35 ___ @@ -542,7 +542,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:37 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:40 ___ @@ -558,7 +558,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:30 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:33 ___ @@ -684,7 +684,7 @@ ___ ### ClusterClientObj -Ƭ **ClusterClientObj**<`F`, `A`, `C`, `E`\>: { `_type`: ``"ClusterClient"`` ; `attributes`: [`AttributeClients`](exports_cluster.md#attributeclients)<`F`, `A`\> ; `commands`: [`CommandServers`](export._internal_.md#commandservers)<`C`\> ; `endpointId`: `number` ; `events`: [`EventClients`](exports_cluster.md#eventclients)<`E`\> ; `id`: [`ClusterId`](exports_datatype.md#clusterid) ; `isUnknown`: `boolean` ; `name`: `string` ; `revision`: `number` ; `subscribeAllAttributes`: (`options`: { `dataVersionFilters?`: { `clusterId`: [`ClusterId`](exports_datatype.md#clusterid) ; `dataVersion`: `number` ; `endpointId`: [`EndpointNumber`](exports_datatype.md#endpointnumber) }[] ; `eventFilters?`: [`TypeFromSchema`](exports_tlv.md#typefromschema)[] ; `isFabricFiltered?`: `boolean` ; `keepSubscriptions?`: `boolean` ; `maxIntervalCeilingSeconds`: `number` ; `minIntervalFloorSeconds`: `number` }) => `Promise`<`void`\> ; `supportedFeatures`: [`TypeFromPartialBitSchema`](exports_schema.md#typefrompartialbitschema)<`F`\> } & [`ClientAttributeGetters`](export._internal_.md#clientattributegetters)<`A`\> & [`ClientGlobalAttributeGetters`](export._internal_.md#clientglobalattributegetters)<`F`\> & [`ClientAttributeSetters`](export._internal_.md#clientattributesetters)<`A`\> & [`ClientAttributeSubscribers`](export._internal_.md#clientattributesubscribers)<`A`\> & [`ClientAttributeListeners`](export._internal_.md#clientattributelisteners)<`A`\> & [`CommandServers`](export._internal_.md#commandservers)<`C`\> & [`ClientEventGetters`](export._internal_.md#clienteventgetters)<`E`\> & [`ClientEventSubscribers`](export._internal_.md#clienteventsubscribers)<`E`\> & [`ClientEventListeners`](export._internal_.md#clienteventlisteners)<`E`\> +Ƭ **ClusterClientObj**<`F`, `A`, `C`, `E`\>: { `_type`: ``"ClusterClient"`` ; `attributes`: [`AttributeClients`](exports_cluster.md#attributeclients)<`F`, `A`\> ; `commands`: [`CommandServers`](export._internal_.md#commandservers)<`C`\> ; `endpointId`: `number` ; `events`: [`EventClients`](exports_cluster.md#eventclients)<`E`\> ; `id`: [`ClusterId`](exports_datatype.md#clusterid) ; `isAttributeSupported`: (`attributeId`: [`AttributeId`](exports_datatype.md#attributeid)) => `boolean` ; `isAttributeSupportedByName`: (`attributeName`: `string`) => `boolean` ; `isCommandSupported`: (`commandId`: [`CommandId`](exports_datatype.md#commandid)) => `boolean` ; `isCommandSupportedByName`: (`commandName`: `string`) => `boolean` ; `isEventSupported`: (`eventId`: [`EventId`](exports_datatype.md#eventid)) => `boolean` ; `isEventSupportedByName`: (`eventName`: `string`) => `boolean` ; `isUnknown`: `boolean` ; `name`: `string` ; `revision`: `number` ; `subscribeAllAttributes`: (`options`: { `dataVersionFilters?`: { `clusterId`: [`ClusterId`](exports_datatype.md#clusterid) ; `dataVersion`: `number` ; `endpointId`: [`EndpointNumber`](exports_datatype.md#endpointnumber) }[] ; `eventFilters?`: [`TypeFromSchema`](exports_tlv.md#typefromschema)[] ; `isFabricFiltered?`: `boolean` ; `keepSubscriptions?`: `boolean` ; `maxIntervalCeilingSeconds`: `number` ; `minIntervalFloorSeconds`: `number` }) => `Promise`<`void`\> ; `supportedFeatures`: [`TypeFromPartialBitSchema`](exports_schema.md#typefrompartialbitschema)<`F`\> } & [`ClientAttributeGetters`](export._internal_.md#clientattributegetters)<`A`\> & [`ClientGlobalAttributeGetters`](export._internal_.md#clientglobalattributegetters)<`F`\> & [`ClientAttributeSetters`](export._internal_.md#clientattributesetters)<`A`\> & [`ClientAttributeSubscribers`](export._internal_.md#clientattributesubscribers)<`A`\> & [`ClientAttributeListeners`](export._internal_.md#clientattributelisteners)<`A`\> & [`CommandServers`](export._internal_.md#commandservers)<`C`\> & [`ClientEventGetters`](export._internal_.md#clienteventgetters)<`E`\> & [`ClientEventSubscribers`](export._internal_.md#clienteventsubscribers)<`E`\> & [`ClientEventListeners`](export._internal_.md#clienteventlisteners)<`E`\> Strongly typed interface of a cluster client @@ -699,7 +699,7 @@ Strongly typed interface of a cluster client #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:77 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:78 ___ @@ -715,7 +715,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:75 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:76 ___ @@ -734,7 +734,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:150 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:163 ___ @@ -750,13 +750,13 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:85 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:88 ___ ### ClusterServerObj -Ƭ **ClusterServerObj**<`A`, `E`\>: { `_type`: ``"ClusterServer"`` ; `attributes`: [`AttributeServers`](exports_cluster.md#attributeservers)<`A`\> ; `clusterDataVersion`: `number` ; `id`: [`ClusterId`](exports_datatype.md#clusterid) ; `name`: `string` } & [`ServerAttributeGetters`](export._internal_.md#serverattributegetters)<`A`\> & [`ServerAttributeSetters`](export._internal_.md#serverattributesetters)<`A`\> & [`ServerAttributeSubscribers`](export._internal_.md#serverattributesubscribers)<`A`\> & [`ServerEventTriggers`](export._internal_.md#servereventtriggers)<`E`\> +Ƭ **ClusterServerObj**<`A`, `E`\>: { `_type`: ``"ClusterServer"`` ; `attributes`: [`AttributeServers`](exports_cluster.md#attributeservers)<`A`\> ; `clusterDataVersion`: `number` ; `id`: [`ClusterId`](exports_datatype.md#clusterid) ; `isAttributeSupported`: (`attributeId`: [`AttributeId`](exports_datatype.md#attributeid)) => `boolean` ; `isAttributeSupportedByName`: (`attributeName`: `string`) => `boolean` ; `isCommandSupported`: (`commandId`: [`CommandId`](exports_datatype.md#commandid)) => `boolean` ; `isCommandSupportedByName`: (`commandName`: `string`) => `boolean` ; `isEventSupported`: (`eventId`: [`EventId`](exports_datatype.md#eventid)) => `boolean` ; `isEventSupportedByName`: (`eventName`: `string`) => `boolean` ; `name`: `string` } & [`ServerAttributeGetters`](export._internal_.md#serverattributegetters)<`A`\> & [`ServerAttributeSetters`](export._internal_.md#serverattributesetters)<`A`\> & [`ServerAttributeSubscribers`](export._internal_.md#serverattributesubscribers)<`A`\> & [`ServerEventTriggers`](export._internal_.md#servereventtriggers)<`E`\> #### Type parameters @@ -767,7 +767,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:149 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:152 ___ @@ -783,7 +783,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:148 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:151 ___ @@ -803,7 +803,7 @@ Strongly typed interface of a cluster server #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:178 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:193 ___ @@ -833,7 +833,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:70 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:73 ___ @@ -849,7 +849,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:93 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:96 ___ @@ -875,9 +875,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ContentLauncherCluster.d.ts:1991 +packages/matter.js/dist/esm/cluster/definitions/ContentLauncherCluster.d.ts:1999 -packages/matter.js/dist/esm/cluster/definitions/ContentLauncherCluster.d.ts:1992 +packages/matter.js/dist/esm/cluster/definitions/ContentLauncherCluster.d.ts:2000 ___ @@ -953,7 +953,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:26 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:27 ___ @@ -969,7 +969,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:133 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:136 ___ @@ -1001,7 +1001,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:109 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:112 ___ @@ -1180,9 +1180,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:381 +packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:385 -packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:382 +packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:386 ___ @@ -1204,9 +1204,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1406 +packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1410 -packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1407 +packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1411 ___ @@ -1284,9 +1284,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/MediaPlaybackCluster.d.ts:1460 +packages/matter.js/dist/esm/cluster/definitions/MediaPlaybackCluster.d.ts:1496 -packages/matter.js/dist/esm/cluster/definitions/MediaPlaybackCluster.d.ts:1461 +packages/matter.js/dist/esm/cluster/definitions/MediaPlaybackCluster.d.ts:1497 ___ @@ -1308,9 +1308,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:2259 +packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:2128 -packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:2260 +packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:2129 ___ @@ -1326,7 +1326,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:112 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:115 ___ @@ -1348,9 +1348,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/OnOffCluster.d.ts:630 +packages/matter.js/dist/esm/cluster/definitions/OnOffCluster.d.ts:560 -packages/matter.js/dist/esm/cluster/definitions/OnOffCluster.d.ts:631 +packages/matter.js/dist/esm/cluster/definitions/OnOffCluster.d.ts:561 ___ @@ -1604,7 +1604,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:31 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:32 ___ @@ -1644,7 +1644,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:143 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:146 ___ @@ -1714,9 +1714,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2915 +packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2923 -packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2916 +packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2924 ___ @@ -1738,10 +1738,10 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:1023 - packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:1024 +packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:1025 + ___ ### UnitLocalizationCluster @@ -1798,9 +1798,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:858 +packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:877 -packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:859 +packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:878 ___ @@ -1896,9 +1896,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:1231 +packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:1230 -packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:1232 +packages/matter.js/dist/esm/cluster/definitions/ApplicationLauncherCluster.d.ts:1231 ___ @@ -1940,7 +1940,7 @@ ___ ### BasicInformationCluster -• **BasicInformationCluster**: [`Definition`](exports_cluster.ClusterFactory.md#definition)<{ `attributes`: { `capabilityMinima`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](exports_cluster.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](exports_cluster.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<[`VendorId`](exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `fabricIndex`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`FabricIndex`](exports_datatype.md#fabricindex)\> }\>, `any`\> ; `reachableChanged`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `startUp`: [`Event`](exports_cluster.md#event)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``40`` ; `name`: ``"BasicInformation"`` ; `revision`: ``2`` }\> +• **BasicInformationCluster**: [`Definition`](exports_cluster.ClusterFactory.md#definition)<{ `attributes`: { `capabilityMinima`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](exports_cluster.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](exports_cluster.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<[`VendorId`](exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](exports_cluster.md#fixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `fabricIndex`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`FabricIndex`](exports_datatype.md#fabricindex)\> }\>, `any`\> ; `reachableChanged`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `startUp`: [`Event`](exports_cluster.md#event)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``40`` ; `name`: ``"BasicInformation"`` ; `revision`: ``2`` }\> #### Defined in @@ -1988,7 +1988,7 @@ ___ ### BridgedDeviceBasicInformationCluster -• **BridgedDeviceBasicInformationCluster**: [`Definition`](exports_cluster.ClusterFactory.md#definition)<{ `attributes`: { `hardwareVersion`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](exports_cluster.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<[`VendorId`](exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `reachableChanged`: [`Event`](exports_cluster.md#event)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `startUp`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``57`` ; `name`: ``"BridgedDeviceBasicInformation"`` ; `revision`: ``2`` }\> +• **BridgedDeviceBasicInformationCluster**: [`Definition`](exports_cluster.ClusterFactory.md#definition)<{ `attributes`: { `hardwareVersion`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<[`ProductFinish`](../enums/exports_cluster.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<``null`` \| [`Color`](../enums/exports_cluster.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](exports_cluster.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<[`VendorId`](exports_datatype.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](exports_cluster.md#optionalfixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `reachableChanged`: [`Event`](exports_cluster.md#event)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](exports_cluster.md#optionalevent)<`void`, `any`\> ; `startUp`: [`OptionalEvent`](exports_cluster.md#optionalevent)<[`TypeFromFields`](exports_tlv.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/exports_tlv.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``57`` ; `name`: ``"BridgedDeviceBasicInformation"`` ; `revision`: ``2`` }\> #### Defined in @@ -2040,9 +2040,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ContentLauncherCluster.d.ts:1991 +packages/matter.js/dist/esm/cluster/definitions/ContentLauncherCluster.d.ts:1999 -packages/matter.js/dist/esm/cluster/definitions/ContentLauncherCluster.d.ts:1992 +packages/matter.js/dist/esm/cluster/definitions/ContentLauncherCluster.d.ts:2000 ___ @@ -2232,9 +2232,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:381 +packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:385 -packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:382 +packages/matter.js/dist/esm/cluster/definitions/KeypadInputCluster.d.ts:386 ___ @@ -2256,9 +2256,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1406 +packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1410 -packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1407 +packages/matter.js/dist/esm/cluster/definitions/LevelControlCluster.d.ts:1411 ___ @@ -2324,9 +2324,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/MediaPlaybackCluster.d.ts:1460 +packages/matter.js/dist/esm/cluster/definitions/MediaPlaybackCluster.d.ts:1496 -packages/matter.js/dist/esm/cluster/definitions/MediaPlaybackCluster.d.ts:1461 +packages/matter.js/dist/esm/cluster/definitions/MediaPlaybackCluster.d.ts:1497 ___ @@ -2348,9 +2348,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:2259 +packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:2128 -packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:2260 +packages/matter.js/dist/esm/cluster/definitions/NetworkCommissioningCluster.d.ts:2129 ___ @@ -2372,9 +2372,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/OnOffCluster.d.ts:630 +packages/matter.js/dist/esm/cluster/definitions/OnOffCluster.d.ts:560 -packages/matter.js/dist/esm/cluster/definitions/OnOffCluster.d.ts:631 +packages/matter.js/dist/esm/cluster/definitions/OnOffCluster.d.ts:561 ___ @@ -2624,9 +2624,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2915 +packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2923 -packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2916 +packages/matter.js/dist/esm/cluster/definitions/ThreadNetworkDiagnosticsCluster.d.ts:2924 ___ @@ -2648,10 +2648,10 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:1023 - packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:1024 +packages/matter.js/dist/esm/cluster/definitions/TimeSyncCluster.d.ts:1025 + ___ ### TlvAttestation @@ -2746,9 +2746,9 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:858 +packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:877 -packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:859 +packages/matter.js/dist/esm/cluster/definitions/WiFiNetworkDiagnosticsCluster.d.ts:878 ___ @@ -3684,7 +3684,7 @@ Forces the presence of the specified optional attributes, so they can be used in #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:108 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:111 ___ @@ -3803,7 +3803,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:164 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:177 ___ @@ -3830,7 +3830,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:233 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:248 ___ @@ -3950,7 +3950,7 @@ ___ | Name | Type | | :------ | :------ | -| `commandHandler` | [`NamedHandler`](../classes/export._internal_.NamedHandler.md)<`any`\> | +| `commandHandler` | [`NamedHandler`](../classes/util_export.NamedHandler.md)<`any`\> | | `attributeInitialValues?` | [`AttributeInitialValues`](exports_cluster.md#attributeinitialvalues)<[`Merge`](util_export.md#merge)<[`Merge`](util_export.md#merge)<{ `currentLevel`: [`Attribute`](exports_cluster.md#attribute)<``null`` \| `number`, `any`\> ; `defaultMoveRate`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<``null`` \| `number`, `any`\> ; `maxLevel`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<`number`, `any`\> ; `minLevel`: [`OptionalAttribute`](exports_cluster.md#optionalattribute)<`number`, `any`\> ; `offTransitionTime`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<``null`` \| `number`, `any`\> ; `onLevel`: [`WritableAttribute`](exports_cluster.md#writableattribute)<``null`` \| `number`, `any`\> ; `onOffTransitionTime`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<`number`, `any`\> ; `onTransitionTime`: [`OptionalWritableAttribute`](exports_cluster.md#optionalwritableattribute)<``null`` \| `number`, `any`\> ; `options`: [`WritableAttribute`](exports_cluster.md#writableattribute)<[`TypeFromBitSchema`](exports_schema.md#typefrombitschema)<{ `coupleColorTempToLevel`: [`BitFlag`](exports_schema.md#bitflag-1) ; `executeIfOff`: [`BitFlag`](exports_schema.md#bitflag-1) }\>, `any`\> }, [`GlobalAttributes`](exports_cluster.md#globalattributes-1)<{ `frequency`: [`BitFlag`](exports_schema.md#bitflag-1) ; `lighting`: [`BitFlag`](exports_schema.md#bitflag-1) ; `onOff`: [`BitFlag`](exports_schema.md#bitflag-1) }\>\>, [`GlobalAttributes`](exports_cluster.md#globalattributes-1)<{ `frequency`: [`BitFlag`](exports_schema.md#bitflag-1) ; `lighting`: [`BitFlag`](exports_schema.md#bitflag-1) ; `onOff`: [`BitFlag`](exports_schema.md#bitflag-1) }\>\>\> | #### Returns @@ -3971,7 +3971,7 @@ ___ | Name | Type | | :------ | :------ | -| `commandHandler?` | [`NamedHandler`](../classes/export._internal_.NamedHandler.md)<`any`\> | +| `commandHandler?` | [`NamedHandler`](../classes/util_export.NamedHandler.md)<`any`\> | | `attributeInitialValues?` | [`AttributeInitialValues`](exports_cluster.md#attributeinitialvalues)<[`Merge`](util_export.md#merge)<[`Merge`](util_export.md#merge)<{ `onOff`: [`Attribute`](exports_cluster.md#attribute)<`boolean`, `any`\> }, [`GlobalAttributes`](exports_cluster.md#globalattributes-1)<{ `levelControlForLighting`: [`BitFlag`](exports_schema.md#bitflag-1) }\>\>, [`GlobalAttributes`](exports_cluster.md#globalattributes-1)<{ `levelControlForLighting`: [`BitFlag`](exports_schema.md#bitflag-1) }\>\>\> | #### Returns @@ -4159,7 +4159,7 @@ obj is ClusterClientObj #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:162 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:175 ___ @@ -4188,7 +4188,7 @@ obj is ClusterClientObjInternal #### Defined in -packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:163 +packages/matter.js/dist/esm/cluster/client/ClusterClientTypes.d.ts:176 ___ @@ -4217,7 +4217,7 @@ obj is ClusterServerObj #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:231 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:246 ___ @@ -4246,7 +4246,7 @@ obj is ClusterServerObjInternal #### Defined in -packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:232 +packages/matter.js/dist/esm/cluster/server/ClusterServerTypes.d.ts:247 ___ diff --git a/docs/matter-node.js/modules/exports_common.md b/docs/matter-node.js/modules/exports_common.md index 375a5e3076..42141d0113 100644 --- a/docs/matter-node.js/modules/exports_common.md +++ b/docs/matter-node.js/modules/exports_common.md @@ -43,6 +43,7 @@ ### Functions +- [serverAddressToString](exports_common.md#serveraddresstostring) - [tryCatch](exports_common.md#trycatch) - [tryCatchAsync](exports_common.md#trycatchasync) @@ -71,6 +72,7 @@ The properties are named identical as in the Matter specification. | `T?` | `number` | TCP supported | | `VP?` | `string` | VendorId + ProductId | | `addresses` | [`ServerAddress`](exports_common.md#serveraddress)[] | The device's addresses IP/port pairs | +| `deviceIdentifier` | `string` | - | #### Defined in @@ -87,7 +89,7 @@ Please decide for the best matching identifier that you have. #### Defined in -packages/matter.js/dist/esm/common/Scanner.d.ts:44 +packages/matter.js/dist/esm/common/Scanner.d.ts:45 ___ @@ -248,6 +250,26 @@ packages/matter.js/dist/esm/common/InstanceBroadcaster.d.ts:109 ## Functions +### serverAddressToString + +▸ **serverAddressToString**(`address`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `address` | [`ServerAddress`](exports_common.md#serveraddress) | + +#### Returns + +`string` + +#### Defined in + +packages/matter.js/dist/esm/common/ServerAddress.d.ts:16 + +___ + ### tryCatch ▸ **tryCatch**<`T`, `E`\>(`codeBlock`, `errorType`, `fallbackValueOrFunction`): `T` diff --git a/docs/matter-node.js/modules/exports_device.md b/docs/matter-node.js/modules/exports_device.md index 9f3ca9ad5a..6c71d8527c 100644 --- a/docs/matter-node.js/modules/exports_device.md +++ b/docs/matter-node.js/modules/exports_device.md @@ -7,6 +7,7 @@ ### Enumerations - [DeviceClasses](../enums/exports_device.DeviceClasses.md) +- [NodeStateInformation](../enums/exports_device.NodeStateInformation.md) ### Classes @@ -20,6 +21,7 @@ - [OnOffLightDevice](../classes/exports_device.OnOffLightDevice.md) - [OnOffPluginUnitDevice](../classes/exports_device.OnOffPluginUnitDevice.md) - [PairedDevice](../classes/exports_device.PairedDevice.md) +- [PairedNode](../classes/exports_device.PairedNode.md) - [RootEndpoint](../classes/exports_device.RootEndpoint.md) ### Interfaces @@ -27,6 +29,11 @@ - [DeviceTypeDefinition](../interfaces/exports_device.DeviceTypeDefinition.md) - [EndpointOptions](../interfaces/exports_device.EndpointOptions.md) +### Type Aliases + +- [CommissioningControllerNodeOptions](exports_device.md#commissioningcontrollernodeoptions) +- [EndpointLoggingOptions](exports_device.md#endpointloggingoptions) + ### Variables - [DeviceTypes](exports_device.md#devicetypes) @@ -40,6 +47,60 @@ - [getDeviceTypeDefinitionByCode](exports_device.md#getdevicetypedefinitionbycode) - [logEndpoint](exports_device.md#logendpoint) +## Type Aliases + +### CommissioningControllerNodeOptions + +Ƭ **CommissioningControllerNodeOptions**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `attributeChangedCallback?` | (`nodeId`: [`NodeId`](exports_datatype.md#nodeid), `data`: [`DecodedAttributeReportValue`](exports_interaction.md#decodedattributereportvalue)<`any`\>) => `void` | Optional additional callback method which is called for each Attribute change reported by the device. Use this if subscribing to all relevant attributes is too much effort. | +| `autoSubscribe?` | `boolean` | Unless set to false all events and attributes are subscribed and value changes are reflected in the ClusterClient instances. With this reading attributes values is mostly looked up in the locally cached data. Additionally more features like reaction on shutdown event or endpoint structure changes (for bridges) are done internally automatically. | +| `eventTriggeredCallback?` | (`nodeId`: [`NodeId`](exports_datatype.md#nodeid), `data`: [`DecodedEventReportValue`](exports_interaction.md#decodedeventreportvalue)<`any`\>) => `void` | Optional additional callback method which is called for each Event reported by the device. Use this if subscribing to all relevant events is too much effort. | +| `stateInformationCallback?` | (`nodeId`: [`NodeId`](exports_datatype.md#nodeid), `state`: [`NodeStateInformation`](../enums/exports_device.NodeStateInformation.md)) => `void` | Optional callback method which is called when the state of the node changes. This can be used to detect when the node goes offline or comes back online. | +| `subscribeMaxIntervalCeilingSeconds?` | `number` | Maximum subscription interval when values are changed. This is also used as a keepalive mechanism to validate that the device is still available. Default it is set to 30s. | +| `subscribeMinIntervalFloorSeconds?` | `number` | Minimum subscription interval when values are changed. Default it is set to 0s. | + +#### Defined in + +packages/matter.js/dist/esm/device/PairedNode.d.ts:38 + +___ + +### EndpointLoggingOptions + +Ƭ **EndpointLoggingOptions**: `Object` + +Options for logging endpoint structure. The default is that anything is logged beside "Non Supported" attributes and +events on ClusterClients. The Filter methods can be used to filter out specific endpoints or clusters if wanted. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `clusterClientFilter?` | (`endpoint`: [`Endpoint`](../classes/exports_device.Endpoint.md), `cluster`: [`ClusterClientObj`](exports_cluster.md#clusterclientobj)<`any`, `any`, `any`, `any`\>) => `boolean` | +| `clusterServerFilter?` | (`endpoint`: [`Endpoint`](../classes/exports_device.Endpoint.md), `cluster`: [`ClusterServerObj`](exports_cluster.md#clusterserverobj)<`any`, `any`\>) => `boolean` | +| `endpointFilter?` | (`endpoint`: [`Endpoint`](../classes/exports_device.Endpoint.md)) => `boolean` | +| `logAttributeObjectValues?` | `boolean` | +| `logAttributePrimitiveValues?` | `boolean` | +| `logChildEndpoints?` | `boolean` | +| `logClusterAttributes?` | `boolean` | +| `logClusterClients?` | `boolean` | +| `logClusterCommands?` | `boolean` | +| `logClusterEvents?` | `boolean` | +| `logClusterGlobalAttributes?` | `boolean` | +| `logClusterServers?` | `boolean` | +| `logNotSupportedClusterAttributes?` | `boolean` | +| `logNotSupportedClusterCommands?` | `boolean` | +| `logNotSupportedClusterEvents?` | `boolean` | + +#### Defined in + +packages/matter.js/dist/esm/device/EndpointStructureLogger.d.ts:13 + ## Variables ### DeviceTypes @@ -124,7 +185,7 @@ the custom ones are used if defined | Name | Type | Description | | :------ | :------ | :------ | | `handler` | [`ClusterServerHandlers`](exports_cluster.md#clusterserverhandlers)<`C`\> | Internal handlers instance to wrap the external handler into | -| `commandHandler?` | [`NamedHandler`](../classes/export._internal_.NamedHandler.md)<`any`\> | Command handler instance with the registered handlers | +| `commandHandler?` | [`NamedHandler`](../classes/util_export.NamedHandler.md)<`any`\> | Command handler instance with the registered handlers | #### Returns @@ -199,7 +260,7 @@ ___ | Name | Type | | :------ | :------ | | `endpoint` | [`Endpoint`](../classes/exports_device.Endpoint.md) | -| `options?` | [`EndpointLoggingOptions`](export._internal_.md#endpointloggingoptions) | +| `options?` | [`EndpointLoggingOptions`](exports_device.md#endpointloggingoptions) | #### Returns @@ -207,4 +268,4 @@ ___ #### Defined in -packages/matter.js/dist/esm/device/EndpointStructureLogger.d.ts:29 +packages/matter.js/dist/esm/device/EndpointStructureLogger.d.ts:30 diff --git a/docs/matter-node.js/modules/exports_protocol.md b/docs/matter-node.js/modules/exports_protocol.md index c7e22d0a3c..215f278a02 100644 --- a/docs/matter-node.js/modules/exports_protocol.md +++ b/docs/matter-node.js/modules/exports_protocol.md @@ -9,6 +9,8 @@ - [ChannelManager](../classes/exports_protocol.ChannelManager.md) - [CommissioningError](../classes/exports_protocol.CommissioningError.md) - [ControllerCommissioner](../classes/exports_protocol.ControllerCommissioner.md) +- [ControllerDiscovery](../classes/exports_protocol.ControllerDiscovery.md) +- [DiscoveryError](../classes/exports_protocol.DiscoveryError.md) - [ExchangeCounter](../classes/exports_protocol.ExchangeCounter.md) - [ExchangeManager](../classes/exports_protocol.ExchangeManager.md) - [ExchangeProvider](../classes/exports_protocol.ExchangeProvider.md) @@ -38,21 +40,21 @@ User specific options for the Commissioning process #### Type declaration -| Name | Type | -| :------ | :------ | -| `adminVendorId?` | `number` | -| `regulatoryCountryCode` | `string` | -| `regulatoryLocation` | [`RegulatoryLocationType`](../enums/exports_cluster.GeneralCommissioning.RegulatoryLocationType.md) | -| `threadNetwork?` | { `networkName`: `string` ; `operationalDataset`: `string` } | -| `threadNetwork.networkName` | `string` | -| `threadNetwork.operationalDataset` | `string` | -| `wifiNetwork?` | { `wifiCredentials`: `string` ; `wifiSsid`: `string` } | -| `wifiNetwork.wifiCredentials` | `string` | -| `wifiNetwork.wifiSsid` | `string` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nodeId?` | [`NodeId`](exports_datatype.md#nodeid) | - | +| `regulatoryCountryCode` | `string` | Country Code where the device is used. | +| `regulatoryLocation` | [`RegulatoryLocationType`](../enums/exports_cluster.GeneralCommissioning.RegulatoryLocationType.md) | Regulatory Location (Indoor/Outdoor) where the device is used. | +| `threadNetwork?` | { `networkName`: `string` ; `operationalDataset`: `string` } | Thread network credentials to commission the device to. | +| `threadNetwork.networkName` | `string` | - | +| `threadNetwork.operationalDataset` | `string` | - | +| `wifiNetwork?` | { `wifiCredentials`: `string` ; `wifiSsid`: `string` } | Wifi network credentials to commission the device to. | +| `wifiNetwork.wifiCredentials` | `string` | - | +| `wifiNetwork.wifiSsid` | `string` | - | #### Defined in -packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:15 +packages/matter.js/dist/esm/protocol/ControllerCommissioner.d.ts:16 ___ diff --git a/docs/matter-node.js/modules/exports_schema.md b/docs/matter-node.js/modules/exports_schema.md index c65dd2d4a2..2c2d5ae437 100644 --- a/docs/matter-node.js/modules/exports_schema.md +++ b/docs/matter-node.js/modules/exports_schema.md @@ -163,11 +163,11 @@ ___ | `passcode` | `number` | | `productId?` | `number` | | `shortDiscriminator?` | `number` | -| `vendorId?` | `number` | +| `vendorId?` | [`VendorId`](exports_datatype.md#vendorid) | #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:50 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:51 ___ @@ -177,7 +177,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:44 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:45 ___ @@ -255,7 +255,7 @@ See MatterCoreSpecificationV1_0 § 5.1.3.1 Table 36 #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:18 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:19 ___ @@ -265,7 +265,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:26 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:27 ___ @@ -275,7 +275,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:62 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:63 ___ @@ -285,7 +285,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/QrCodeSchema.d.ts:12 +packages/matter.js/dist/esm/schema/QrCodeSchema.d.ts:13 ___ @@ -295,7 +295,7 @@ ___ #### Defined in -packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:49 +packages/matter.js/dist/esm/schema/PairingCodeSchema.d.ts:50 ## Functions diff --git a/docs/matter-node.js/modules/exports_securechannel.md b/docs/matter-node.js/modules/exports_securechannel.md index b5e087178a..b747024678 100644 --- a/docs/matter-node.js/modules/exports_securechannel.md +++ b/docs/matter-node.js/modules/exports_securechannel.md @@ -16,6 +16,7 @@ - [SecureChannelMessenger](../classes/exports_securechannel.SecureChannelMessenger.md) - [SecureChannelProtocol](../classes/exports_securechannel.SecureChannelProtocol.md) - [SecureChannelStatusMessageSchema](../classes/exports_securechannel.SecureChannelStatusMessageSchema.md) +- [StatusReportOnlySecureChannelProtocol](../classes/exports_securechannel.StatusReportOnlySecureChannelProtocol.md) ### Type Aliases diff --git a/docs/matter-node.js/modules/exports_session.md b/docs/matter-node.js/modules/exports_session.md index 3b6728f476..92f4eec612 100644 --- a/docs/matter-node.js/modules/exports_session.md +++ b/docs/matter-node.js/modules/exports_session.md @@ -441,4 +441,4 @@ asserts session is SecureSession #### Defined in -packages/matter.js/dist/esm/session/SecureSession.d.ts:64 +packages/matter.js/dist/esm/session/SecureSession.d.ts:97 diff --git a/docs/matter-node.js/modules/util_export.md b/docs/matter-node.js/modules/util_export.md index e8a55fd50f..a89a74ee65 100644 --- a/docs/matter-node.js/modules/util_export.md +++ b/docs/matter-node.js/modules/util_export.md @@ -18,6 +18,7 @@ - [DataReader](../classes/util_export.DataReader.md) - [DataWriter](../classes/util_export.DataWriter.md) - [EndOfStreamError](../classes/util_export.EndOfStreamError.md) +- [NamedHandler](../classes/util_export.NamedHandler.md) - [NoResponseTimeoutError](../classes/util_export.NoResponseTimeoutError.md) - [Queue](../classes/util_export.Queue.md) @@ -27,10 +28,13 @@ ### Type Aliases +- [ArrayMinLength](util_export.md#arrayminlength) +- [AtLeastOne](util_export.md#atleastone) - [Brand](util_export.md#brand) - [Branded](util_export.md#branded) - [ByteArray](util_export.md#bytearray) - [ClassExtends](util_export.md#classextends) +- [HandlerFunction](util_export.md#handlerfunction) - [MakeMandatory](util_export.md#makemandatory) - [Merge](util_export.md#merge) - [MergeAll](util_export.md#mergeall) @@ -61,11 +65,13 @@ - [Merge](util_export.md#merge-1) - [MergeAll](util_export.md#mergeall-1) - [Pluck](util_export.md#pluck-1) +- [anyPromise](util_export.md#anypromise) - [camelize](util_export.md#camelize) - [capitalize](util_export.md#capitalize) - [commandExecutor](util_export.md#commandexecutor) - [createPromise](util_export.md#createpromise) - [describeList](util_export.md#describelist) +- [extendPublicHandlerMethods](util_export.md#extendpublichandlermethods) - [getIntParameter](util_export.md#getintparameter) - [getParameter](util_export.md#getparameter) - [hasParameter](util_export.md#hasparameter) @@ -87,6 +93,46 @@ ## Type Aliases +### ArrayMinLength + +Ƭ **ArrayMinLength**<`T`, `N`\>: [`BuildArrayMinLength`](export._internal_.md#buildarrayminlength)<`T`, `N`, []\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `N` | extends `number` | + +#### Defined in + +packages/matter.js/dist/esm/util/Array.d.ts:10 + +___ + +### AtLeastOne + +Ƭ **AtLeastOne**<`T`\>: [`ArrayMinLength`](util_export.md#arrayminlength)<`T`, ``1``\> + +Array types + +**`License`** + +Copyright 2022 The node-matter Authors +SPDX-License-Identifier: Apache-2.0 + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/matter.js/dist/esm/util/Array.d.ts:8 + +___ + ### Brand Ƭ **Brand**<`B`\>: `Object` @@ -172,6 +218,35 @@ packages/matter.js/dist/esm/util/Type.d.ts:15 ___ +### HandlerFunction + +Ƭ **HandlerFunction**: (...`args`: `any`[]) => `any` + +#### Type declaration + +▸ (`...args`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | `any`[] | + +##### Returns + +`any` + +**`License`** + +Copyright 2022 The matter.js Authors +SPDX-License-Identifier: Apache-2.0 + +#### Defined in + +packages/matter.js/dist/esm/util/NamedHandler.d.ts:6 + +___ + ### MakeMandatory Ƭ **MakeMandatory**<`T`\>: `Exclude`<`T`, `undefined`\> @@ -518,6 +593,35 @@ packages/matter.js/dist/esm/util/Type.d.ts:23 ___ +### anyPromise + +▸ **anyPromise**<`T`\>(`promises`): `Promise`<`T`\> + +Use all promises or promise returning methods and return the first resolved promise or reject when all promises +rejected + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `promises` | (`Promise`<`T`\> \| () => `Promise`<`T`\>)[] | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +packages/matter.js/dist/esm/util/Promises.d.ts:20 + +___ + ### camelize ▸ **camelize**(`name`, `upperFirst?`): `string` @@ -589,7 +693,7 @@ ___ #### Defined in -packages/matter-node.js/src/util/CommandLine.ts:30 +[packages/matter-node.js/src/util/CommandLine.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/util/CommandLine.ts#L30) ___ @@ -644,6 +748,33 @@ packages/matter.js/dist/esm/util/String.d.ts:34 ___ +### extendPublicHandlerMethods + +▸ **extendPublicHandlerMethods**<`ParentClass`, `H`\>(`parentClass`): [`ExtendPublicHandlerMethods`](export._internal_.md#extendpublichandlermethods)<`ParentClass`, `H`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `ParentClass` | extends (...`args`: `any`[]) => `any` | +| `H` | extends `Record` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parentClass` | `ParentClass` | + +#### Returns + +[`ExtendPublicHandlerMethods`](export._internal_.md#extendpublichandlermethods)<`ParentClass`, `H`\> + +#### Defined in + +packages/matter.js/dist/esm/util/NamedHandler.d.ts:19 + +___ + ### getIntParameter ▸ **getIntParameter**(`name`): `undefined` \| `number` @@ -660,7 +791,7 @@ ___ #### Defined in -packages/matter-node.js/src/util/CommandLine.ts:22 +[packages/matter-node.js/src/util/CommandLine.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/util/CommandLine.ts#L22) ___ @@ -680,7 +811,7 @@ ___ #### Defined in -packages/matter-node.js/src/util/CommandLine.ts:12 +[packages/matter-node.js/src/util/CommandLine.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/util/CommandLine.ts#L12) ___ @@ -700,7 +831,7 @@ ___ #### Defined in -packages/matter-node.js/src/util/CommandLine.ts:18 +[packages/matter-node.js/src/util/CommandLine.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/util/CommandLine.ts#L18) ___ @@ -929,7 +1060,7 @@ ___ #### Defined in -packages/matter-node.js/src/util/Node.ts:11 +[packages/matter-node.js/src/util/Node.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter-node.js/src/util/Node.ts#L11) ___ diff --git a/docs/matter.js/classes/ble_export.Ble.md b/docs/matter.js/classes/ble_export.Ble.md index c217421cfa..04506a87f8 100644 --- a/docs/matter.js/classes/ble_export.Ble.md +++ b/docs/matter.js/classes/ble_export.Ble.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/ble/Ble.ts:17 +[packages/matter.js/src/ble/Ble.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/Ble.ts#L17) ## Methods @@ -63,7 +63,7 @@ packages/matter.js/src/ble/Ble.ts:17 #### Defined in -packages/matter.js/src/ble/Ble.ts:23 +[packages/matter.js/src/ble/Ble.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/Ble.ts#L23) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -packages/matter.js/src/ble/Ble.ts:22 +[packages/matter.js/src/ble/Ble.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/Ble.ts#L22) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/ble/Ble.ts:21 +[packages/matter.js/src/ble/Ble.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/Ble.ts#L21) ___ @@ -105,4 +105,4 @@ ___ #### Defined in -packages/matter.js/src/ble/Ble.ts:24 +[packages/matter.js/src/ble/Ble.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/Ble.ts#L24) diff --git a/docs/matter.js/classes/ble_export.BtpSessionHandler.md b/docs/matter.js/classes/ble_export.BtpSessionHandler.md index c3e7cd94f5..9447dfce63 100644 --- a/docs/matter.js/classes/ble_export.BtpSessionHandler.md +++ b/docs/matter.js/classes/ble_export.BtpSessionHandler.md @@ -64,7 +64,7 @@ Creates a new BTP session handler #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:143 +[packages/matter.js/src/ble/BtpSessionHandler.ts:143](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L143) ## Properties @@ -74,7 +74,7 @@ packages/matter.js/src/ble/BtpSessionHandler.ts:143 #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:35 +[packages/matter.js/src/ble/BtpSessionHandler.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L35) ___ @@ -86,7 +86,7 @@ The client window size to use #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:147 +[packages/matter.js/src/ble/BtpSessionHandler.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L147) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:31 +[packages/matter.js/src/ble/BtpSessionHandler.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L31) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:32 +[packages/matter.js/src/ble/BtpSessionHandler.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L32) ___ @@ -126,7 +126,7 @@ Callback to disconnect the BLE transport #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:149 +[packages/matter.js/src/ble/BtpSessionHandler.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L149) ___ @@ -138,7 +138,7 @@ The fragment size to use for the messages #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:146 +[packages/matter.js/src/ble/BtpSessionHandler.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L146) ___ @@ -164,7 +164,7 @@ Callback to handle a Matter message payload #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:150 +[packages/matter.js/src/ble/BtpSessionHandler.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L150) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:42 +[packages/matter.js/src/ble/BtpSessionHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L42) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:38 +[packages/matter.js/src/ble/BtpSessionHandler.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L38) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:34 +[packages/matter.js/src/ble/BtpSessionHandler.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L34) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:33 +[packages/matter.js/src/ble/BtpSessionHandler.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L33) ___ @@ -214,7 +214,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:39 +[packages/matter.js/src/ble/BtpSessionHandler.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L39) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:41 +[packages/matter.js/src/ble/BtpSessionHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L41) ___ @@ -234,7 +234,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:40 +[packages/matter.js/src/ble/BtpSessionHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L40) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:37 +[packages/matter.js/src/ble/BtpSessionHandler.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L37) ___ @@ -270,7 +270,7 @@ Callback to write data to the BLE transport #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:148 +[packages/matter.js/src/ble/BtpSessionHandler.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L148) ## Methods @@ -287,7 +287,7 @@ the peer SHALL close the BTP session and report an error to the application. #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:444 +[packages/matter.js/src/ble/BtpSessionHandler.ts:444](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L444) ___ @@ -304,7 +304,7 @@ acknowledgement #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:414 +[packages/matter.js/src/ble/BtpSessionHandler.ts:414](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L414) ___ @@ -320,7 +320,7 @@ Close the BTP session. This method is called when the BLE transport is disconnec #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:400 +[packages/matter.js/src/ble/BtpSessionHandler.ts:400](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L400) ___ @@ -343,7 +343,7 @@ Checks if incoming ackNumber and sent sequence number exceeds the client window #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:465 +[packages/matter.js/src/ble/BtpSessionHandler.ts:465](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L465) ___ @@ -359,7 +359,7 @@ Increments sequence number for the packets and round it off to 0 when it reaches #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:454 +[packages/matter.js/src/ble/BtpSessionHandler.ts:454](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L454) ___ @@ -382,7 +382,7 @@ ExchangeManager layer #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:171 +[packages/matter.js/src/ble/BtpSessionHandler.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L171) ___ @@ -396,7 +396,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:313 +[packages/matter.js/src/ble/BtpSessionHandler.ts:313](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L313) ___ @@ -420,7 +420,7 @@ should be sent. #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:299 +[packages/matter.js/src/ble/BtpSessionHandler.ts:299](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L299) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:110 +[packages/matter.js/src/ble/BtpSessionHandler.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L110) ___ @@ -469,4 +469,4 @@ Factory method to create a new BTPSessionHandler from a received handshake reque #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:45 +[packages/matter.js/src/ble/BtpSessionHandler.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L45) diff --git a/docs/matter.js/classes/certificate_export.AttestationCertificateManager.md b/docs/matter.js/classes/certificate_export.AttestationCertificateManager.md index 2418cca681..f78a7174b3 100644 --- a/docs/matter.js/classes/certificate_export.AttestationCertificateManager.md +++ b/docs/matter.js/classes/certificate_export.AttestationCertificateManager.md @@ -44,7 +44,7 @@ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:49 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L49) ## Properties @@ -54,7 +54,7 @@ packages/matter.js/src/certificate/AttestationCertificateManager.ts:49 #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:47 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L47) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:35 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L35) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:42 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L42) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:39 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L39) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:46 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L46) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:43 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L43) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:45 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L45) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:44 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L44) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:49 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L49) ## Methods @@ -156,7 +156,7 @@ packages/matter.js/src/certificate/AttestationCertificateManager.ts:49 #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:130 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L130) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:68 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L68) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:99 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L99) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:57 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L57) ___ @@ -236,4 +236,4 @@ ___ #### Defined in -packages/matter.js/src/certificate/AttestationCertificateManager.ts:53 +[packages/matter.js/src/certificate/AttestationCertificateManager.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/AttestationCertificateManager.ts#L53) diff --git a/docs/matter.js/classes/certificate_export.CertificateManager.md b/docs/matter.js/classes/certificate_export.CertificateManager.md index 641ca233f6..45b552f9b7 100644 --- a/docs/matter.js/classes/certificate_export.CertificateManager.md +++ b/docs/matter.js/classes/certificate_export.CertificateManager.md @@ -49,7 +49,7 @@ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:541 +[packages/matter.js/src/certificate/CertificateManager.ts:541](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L541) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:572 +[packages/matter.js/src/certificate/CertificateManager.ts:572](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L572) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:400 +[packages/matter.js/src/certificate/CertificateManager.ts:400](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L400) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:587 +[packages/matter.js/src/certificate/CertificateManager.ts:587](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L587) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:365 +[packages/matter.js/src/certificate/CertificateManager.ts:365](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L365) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:493 +[packages/matter.js/src/certificate/CertificateManager.ts:493](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L493) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:446 +[packages/matter.js/src/certificate/CertificateManager.ts:446](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L446) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:332 +[packages/matter.js/src/certificate/CertificateManager.ts:332](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L332) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:568 +[packages/matter.js/src/certificate/CertificateManager.ts:568](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L568) ___ @@ -233,4 +233,4 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:564 +[packages/matter.js/src/certificate/CertificateManager.ts:564](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L564) diff --git a/docs/matter.js/classes/certificate_export.CertificationDeclarationManager.md b/docs/matter.js/classes/certificate_export.CertificationDeclarationManager.md index 3be740ab34..2a22acc1bb 100644 --- a/docs/matter.js/classes/certificate_export.CertificationDeclarationManager.md +++ b/docs/matter.js/classes/certificate_export.CertificationDeclarationManager.md @@ -39,4 +39,4 @@ #### Defined in -packages/matter.js/src/certificate/CertificationDeclarationManager.ts:34 +[packages/matter.js/src/certificate/CertificationDeclarationManager.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificationDeclarationManager.ts#L34) diff --git a/docs/matter.js/classes/certificate_export.RootCertificateManager.md b/docs/matter.js/classes/certificate_export.RootCertificateManager.md index 319dd050d2..45a6e67773 100644 --- a/docs/matter.js/classes/certificate_export.RootCertificateManager.md +++ b/docs/matter.js/classes/certificate_export.RootCertificateManager.md @@ -38,7 +38,7 @@ #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:28 +[packages/matter.js/src/certificate/RootCertificateManager.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L28) ## Properties @@ -48,7 +48,7 @@ packages/matter.js/src/certificate/RootCertificateManager.ts:28 #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:26 +[packages/matter.js/src/certificate/RootCertificateManager.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L26) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:25 +[packages/matter.js/src/certificate/RootCertificateManager.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L25) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:22 +[packages/matter.js/src/certificate/RootCertificateManager.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L22) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:24 +[packages/matter.js/src/certificate/RootCertificateManager.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L24) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:23 +[packages/matter.js/src/certificate/RootCertificateManager.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L23) ## Methods @@ -110,7 +110,7 @@ packages/matter.js/src/certificate/RootCertificateManager.ts:23 #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:85 +[packages/matter.js/src/certificate/RootCertificateManager.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L85) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:62 +[packages/matter.js/src/certificate/RootCertificateManager.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L62) ___ @@ -138,4 +138,4 @@ ___ #### Defined in -packages/matter.js/src/certificate/RootCertificateManager.ts:58 +[packages/matter.js/src/certificate/RootCertificateManager.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/RootCertificateManager.ts#L58) diff --git a/docs/matter.js/classes/cluster_export.AttributeClient.md b/docs/matter.js/classes/cluster_export.AttributeClient.md index 93055ce1bc..17592a2503 100644 --- a/docs/matter.js/classes/cluster_export.AttributeClient.md +++ b/docs/matter.js/classes/cluster_export.AttributeClient.md @@ -16,7 +16,7 @@ General class for AttributeClients - **`AttributeClient`** - ↳ [`PresentAttributeClient`](cluster_export.PresentAttributeClient.md) + ↳ [`SupportedAttributeClient`](cluster_export.SupportedAttributeClient.md) ## Table of contents @@ -71,7 +71,7 @@ General class for AttributeClients #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:48 +[packages/matter.js/src/cluster/client/AttributeClient.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L48) ## Properties @@ -81,7 +81,7 @@ packages/matter.js/src/cluster/client/AttributeClient.ts:48 #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:49 +[packages/matter.js/src/cluster/client/AttributeClient.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L49) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:52 +[packages/matter.js/src/cluster/client/AttributeClient.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L52) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:51 +[packages/matter.js/src/cluster/client/AttributeClient.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L51) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:46 +[packages/matter.js/src/cluster/client/AttributeClient.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L46) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:53 +[packages/matter.js/src/cluster/client/AttributeClient.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L53) ___ @@ -131,7 +131,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:43 +[packages/matter.js/src/cluster/client/AttributeClient.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L43) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:42 +[packages/matter.js/src/cluster/client/AttributeClient.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L42) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:45 +[packages/matter.js/src/cluster/client/AttributeClient.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L45) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:50 +[packages/matter.js/src/cluster/client/AttributeClient.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L50) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:44 +[packages/matter.js/src/cluster/client/AttributeClient.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L44) ## Methods @@ -193,7 +193,7 @@ Add a listener to the attribute. #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:166 +[packages/matter.js/src/cluster/client/AttributeClient.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L166) ___ @@ -216,7 +216,7 @@ Get the value of the attribute. Fabric scoped reads are always done with the rem #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:105 +[packages/matter.js/src/cluster/client/AttributeClient.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L105) ___ @@ -239,7 +239,7 @@ Get the value with version of the attribute. Fabric scoped reads are always done #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:123 +[packages/matter.js/src/cluster/client/AttributeClient.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L123) ___ @@ -261,7 +261,7 @@ Remove a listener from the attribute. #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:171 +[packages/matter.js/src/cluster/client/AttributeClient.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L171) ___ @@ -285,7 +285,7 @@ cluster dataVersion of the server matches. If it does not match it is rejected w #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:66 +[packages/matter.js/src/cluster/client/AttributeClient.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L66) ___ @@ -310,7 +310,7 @@ Subscribe to the attribute. #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:139 +[packages/matter.js/src/cluster/client/AttributeClient.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L139) ___ @@ -332,4 +332,4 @@ Update the value of the attribute. Just internally used! #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:161 +[packages/matter.js/src/cluster/client/AttributeClient.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L161) diff --git a/docs/matter.js/classes/cluster_export.AttributeServer.md b/docs/matter.js/classes/cluster_export.AttributeServer.md index fd988391d4..0c0b5ffc7b 100644 --- a/docs/matter.js/classes/cluster_export.AttributeServer.md +++ b/docs/matter.js/classes/cluster_export.AttributeServer.md @@ -102,7 +102,7 @@ Attribute server for normal attributes that can be read and written. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:281 +[packages/matter.js/src/cluster/server/AttributeServer.ts:281](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L281) ## Properties @@ -116,7 +116,7 @@ packages/matter.js/src/cluster/server/AttributeServer.ts:281 #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:119 +[packages/matter.js/src/cluster/server/AttributeServer.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L119) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:110 +[packages/matter.js/src/cluster/server/AttributeServer.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L110) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:163 +[packages/matter.js/src/cluster/server/AttributeServer.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L163) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:153 +[packages/matter.js/src/cluster/server/AttributeServer.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L153) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:113 +[packages/matter.js/src/cluster/server/AttributeServer.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L113) ___ @@ -214,7 +214,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:290 +[packages/matter.js/src/cluster/server/AttributeServer.ts:290](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L290) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:275 +[packages/matter.js/src/cluster/server/AttributeServer.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L275) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:117 +[packages/matter.js/src/cluster/server/AttributeServer.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L117) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:116 +[packages/matter.js/src/cluster/server/AttributeServer.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L116) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:114 +[packages/matter.js/src/cluster/server/AttributeServer.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L114) ___ @@ -284,7 +284,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:118 +[packages/matter.js/src/cluster/server/AttributeServer.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L118) ___ @@ -298,7 +298,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:115 +[packages/matter.js/src/cluster/server/AttributeServer.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L115) ___ @@ -324,7 +324,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:278 +[packages/matter.js/src/cluster/server/AttributeServer.ts:278](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L278) ___ @@ -350,7 +350,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:279 +[packages/matter.js/src/cluster/server/AttributeServer.ts:279](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L279) ___ @@ -366,7 +366,7 @@ The value is undefined when getter/setter are used. But we still handle the vers #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:109 +[packages/matter.js/src/cluster/server/AttributeServer.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L109) ___ @@ -376,7 +376,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:276 +[packages/matter.js/src/cluster/server/AttributeServer.ts:276](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L276) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:277 +[packages/matter.js/src/cluster/server/AttributeServer.ts:277](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L277) ## Methods @@ -413,7 +413,7 @@ new value and the version number. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:463 +[packages/matter.js/src/cluster/server/AttributeServer.ts:463](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L463) ___ @@ -440,7 +440,7 @@ new value and the old value. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:481 +[packages/matter.js/src/cluster/server/AttributeServer.ts:481](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L481) ___ @@ -464,7 +464,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:136 +[packages/matter.js/src/cluster/server/AttributeServer.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L136) ___ @@ -493,7 +493,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:194 +[packages/matter.js/src/cluster/server/AttributeServer.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L194) ___ @@ -515,7 +515,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:215 +[packages/matter.js/src/cluster/server/AttributeServer.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L215) ___ @@ -550,7 +550,7 @@ attributes. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:206 +[packages/matter.js/src/cluster/server/AttributeServer.ts:206](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L206) ___ @@ -575,7 +575,7 @@ internally. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:421 +[packages/matter.js/src/cluster/server/AttributeServer.ts:421](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L421) ___ @@ -602,7 +602,7 @@ adjusted before the Device gets announced. Do not use this method to change valu #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:361 +[packages/matter.js/src/cluster/server/AttributeServer.ts:361](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L361) ___ @@ -625,7 +625,7 @@ Helper Method to process the set of a value in a generic way. This method is use #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:410 +[packages/matter.js/src/cluster/server/AttributeServer.ts:410](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L410) ___ @@ -651,7 +651,7 @@ Remove an internal listener. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:470 +[packages/matter.js/src/cluster/server/AttributeServer.ts:470](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L470) ___ @@ -677,7 +677,7 @@ Remove an external listener. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:496 +[packages/matter.js/src/cluster/server/AttributeServer.ts:496](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L496) ___ @@ -703,7 +703,7 @@ Listeners are called when the value changes (internal listeners) or in any case #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:378 +[packages/matter.js/src/cluster/server/AttributeServer.ts:378](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L378) ___ @@ -729,7 +729,7 @@ Listeners are called when the value changes (internal listeners) or in any case #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:402 +[packages/matter.js/src/cluster/server/AttributeServer.ts:402](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L402) ___ @@ -752,7 +752,7 @@ Method that contains the logic to set a value "from remote" (e.g. from a client) #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:390 +[packages/matter.js/src/cluster/server/AttributeServer.ts:390](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L390) ___ @@ -779,7 +779,7 @@ new value and the old value. This method is a convenient alias for addValueSetLi #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:489 +[packages/matter.js/src/cluster/server/AttributeServer.ts:489](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L489) ___ @@ -804,7 +804,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:437 +[packages/matter.js/src/cluster/server/AttributeServer.ts:437](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L437) ___ @@ -823,7 +823,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:453 +[packages/matter.js/src/cluster/server/AttributeServer.ts:453](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L453) ___ @@ -847,4 +847,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:125 +[packages/matter.js/src/cluster/server/AttributeServer.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L125) diff --git a/docs/matter.js/classes/cluster_export.BaseAttributeServer.md b/docs/matter.js/classes/cluster_export.BaseAttributeServer.md index 3d49c55531..558251a9ca 100644 --- a/docs/matter.js/classes/cluster_export.BaseAttributeServer.md +++ b/docs/matter.js/classes/cluster_export.BaseAttributeServer.md @@ -68,7 +68,7 @@ Base class for all attribute servers. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:112 +[packages/matter.js/src/cluster/server/AttributeServer.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L112) ## Properties @@ -78,7 +78,7 @@ packages/matter.js/src/cluster/server/AttributeServer.ts:112 #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:119 +[packages/matter.js/src/cluster/server/AttributeServer.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L119) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:110 +[packages/matter.js/src/cluster/server/AttributeServer.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L110) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:113 +[packages/matter.js/src/cluster/server/AttributeServer.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L113) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:117 +[packages/matter.js/src/cluster/server/AttributeServer.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L117) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:116 +[packages/matter.js/src/cluster/server/AttributeServer.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L116) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:114 +[packages/matter.js/src/cluster/server/AttributeServer.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L114) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:118 +[packages/matter.js/src/cluster/server/AttributeServer.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L118) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:115 +[packages/matter.js/src/cluster/server/AttributeServer.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L115) ___ @@ -160,7 +160,7 @@ The value is undefined when getter/setter are used. But we still handle the vers #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:109 +[packages/matter.js/src/cluster/server/AttributeServer.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L109) ## Methods @@ -180,7 +180,7 @@ packages/matter.js/src/cluster/server/AttributeServer.ts:109 #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:136 +[packages/matter.js/src/cluster/server/AttributeServer.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L136) ___ @@ -203,7 +203,7 @@ adjusted before the Device gets announced. Do not use this method to change valu #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:144 +[packages/matter.js/src/cluster/server/AttributeServer.ts:144](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L144) ___ @@ -223,4 +223,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:125 +[packages/matter.js/src/cluster/server/AttributeServer.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L125) diff --git a/docs/matter.js/classes/cluster_export.CommandServer.md b/docs/matter.js/classes/cluster_export.CommandServer.md index 7a84989389..72ff853767 100644 --- a/docs/matter.js/classes/cluster_export.CommandServer.md +++ b/docs/matter.js/classes/cluster_export.CommandServer.md @@ -58,7 +58,7 @@ #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:19 +[packages/matter.js/src/cluster/server/CommandServer.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L19) ## Properties @@ -85,7 +85,7 @@ packages/matter.js/src/cluster/server/CommandServer.ts:19 #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:26 +[packages/matter.js/src/cluster/server/CommandServer.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L26) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:20 +[packages/matter.js/src/cluster/server/CommandServer.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L20) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:22 +[packages/matter.js/src/cluster/server/CommandServer.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L22) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:23 +[packages/matter.js/src/cluster/server/CommandServer.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L23) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:25 +[packages/matter.js/src/cluster/server/CommandServer.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L25) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:21 +[packages/matter.js/src/cluster/server/CommandServer.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L21) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:24 +[packages/matter.js/src/cluster/server/CommandServer.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L24) ## Methods @@ -168,4 +168,4 @@ packages/matter.js/src/cluster/server/CommandServer.ts:24 #### Defined in -packages/matter.js/src/cluster/server/CommandServer.ts:34 +[packages/matter.js/src/cluster/server/CommandServer.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/CommandServer.ts#L34) diff --git a/docs/matter.js/classes/cluster_export.EventClient.md b/docs/matter.js/classes/cluster_export.EventClient.md index 5fd115162a..9039d76680 100644 --- a/docs/matter.js/classes/cluster_export.EventClient.md +++ b/docs/matter.js/classes/cluster_export.EventClient.md @@ -16,9 +16,9 @@ General class for EventClients - **`EventClient`** - ↳ [`PresentEventClient`](cluster_export.PresentEventClient.md) + ↳ [`SupportedEventClient`](cluster_export.SupportedEventClient.md) - ↳ [`UnknownPresentEventClient`](cluster_export.UnknownPresentEventClient.md) + ↳ [`UnknownSupportedEventClient`](cluster_export.UnknownSupportedEventClient.md) ## Table of contents @@ -68,7 +68,7 @@ General class for EventClients #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:41 +[packages/matter.js/src/cluster/client/EventClient.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L41) ## Properties @@ -78,7 +78,7 @@ packages/matter.js/src/cluster/client/EventClient.ts:41 #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:45 +[packages/matter.js/src/cluster/client/EventClient.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L45) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:44 +[packages/matter.js/src/cluster/client/EventClient.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L44) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:42 +[packages/matter.js/src/cluster/client/EventClient.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L42) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:39 +[packages/matter.js/src/cluster/client/EventClient.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L39) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:46 +[packages/matter.js/src/cluster/client/EventClient.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L46) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:38 +[packages/matter.js/src/cluster/client/EventClient.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L38) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:43 +[packages/matter.js/src/cluster/client/EventClient.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L43) ## Methods @@ -158,7 +158,7 @@ packages/matter.js/src/cluster/client/EventClient.ts:43 #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:90 +[packages/matter.js/src/cluster/client/EventClient.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L90) ___ @@ -179,7 +179,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:51 +[packages/matter.js/src/cluster/client/EventClient.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L51) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:94 +[packages/matter.js/src/cluster/client/EventClient.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L94) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:64 +[packages/matter.js/src/cluster/client/EventClient.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L64) ___ @@ -243,4 +243,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:84 +[packages/matter.js/src/cluster/client/EventClient.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L84) diff --git a/docs/matter.js/classes/cluster_export.EventServer.md b/docs/matter.js/classes/cluster_export.EventServer.md index ae7e1c3dc4..f768738a3a 100644 --- a/docs/matter.js/classes/cluster_export.EventServer.md +++ b/docs/matter.js/classes/cluster_export.EventServer.md @@ -60,7 +60,7 @@ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:24 +[packages/matter.js/src/cluster/server/EventServer.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L24) ## Properties @@ -70,7 +70,7 @@ packages/matter.js/src/cluster/server/EventServer.ts:24 #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:26 +[packages/matter.js/src/cluster/server/EventServer.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L26) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:21 +[packages/matter.js/src/cluster/server/EventServer.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L21) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:22 +[packages/matter.js/src/cluster/server/EventServer.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L22) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:19 +[packages/matter.js/src/cluster/server/EventServer.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L19) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:25 +[packages/matter.js/src/cluster/server/EventServer.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L25) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:20 +[packages/matter.js/src/cluster/server/EventServer.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L20) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:27 +[packages/matter.js/src/cluster/server/EventServer.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L27) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:29 +[packages/matter.js/src/cluster/server/EventServer.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L29) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:28 +[packages/matter.js/src/cluster/server/EventServer.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L28) ## Methods @@ -170,7 +170,7 @@ packages/matter.js/src/cluster/server/EventServer.ts:28 #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:69 +[packages/matter.js/src/cluster/server/EventServer.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L69) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:32 +[packages/matter.js/src/cluster/server/EventServer.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L32) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:38 +[packages/matter.js/src/cluster/server/EventServer.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L38) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:73 +[packages/matter.js/src/cluster/server/EventServer.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L73) ___ @@ -250,4 +250,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/EventServer.ts:48 +[packages/matter.js/src/cluster/server/EventServer.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/EventServer.ts#L48) diff --git a/docs/matter.js/classes/cluster_export.FabricScopedAttributeServer.md b/docs/matter.js/classes/cluster_export.FabricScopedAttributeServer.md index d7be4b7876..059b17c096 100644 --- a/docs/matter.js/classes/cluster_export.FabricScopedAttributeServer.md +++ b/docs/matter.js/classes/cluster_export.FabricScopedAttributeServer.md @@ -108,7 +108,7 @@ on fabric level if no custom getter or setter is defined. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:512 +[packages/matter.js/src/cluster/server/AttributeServer.ts:512](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L512) ## Properties @@ -118,7 +118,7 @@ packages/matter.js/src/cluster/server/AttributeServer.ts:512 #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:520 +[packages/matter.js/src/cluster/server/AttributeServer.ts:520](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L520) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:119 +[packages/matter.js/src/cluster/server/AttributeServer.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L119) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:110 +[packages/matter.js/src/cluster/server/AttributeServer.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L110) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:163 +[packages/matter.js/src/cluster/server/AttributeServer.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L163) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:153 +[packages/matter.js/src/cluster/server/AttributeServer.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L153) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:113 +[packages/matter.js/src/cluster/server/AttributeServer.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L113) ___ @@ -234,7 +234,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:290 +[packages/matter.js/src/cluster/server/AttributeServer.ts:290](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L290) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:509 +[packages/matter.js/src/cluster/server/AttributeServer.ts:509](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L509) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:510 +[packages/matter.js/src/cluster/server/AttributeServer.ts:510](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L510) ___ @@ -268,7 +268,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:275 +[packages/matter.js/src/cluster/server/AttributeServer.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L275) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:117 +[packages/matter.js/src/cluster/server/AttributeServer.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L117) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:116 +[packages/matter.js/src/cluster/server/AttributeServer.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L116) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:114 +[packages/matter.js/src/cluster/server/AttributeServer.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L114) ___ @@ -324,7 +324,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:118 +[packages/matter.js/src/cluster/server/AttributeServer.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L118) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:115 +[packages/matter.js/src/cluster/server/AttributeServer.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L115) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:278 +[packages/matter.js/src/cluster/server/AttributeServer.ts:278](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L278) ___ @@ -398,7 +398,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:279 +[packages/matter.js/src/cluster/server/AttributeServer.ts:279](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L279) ___ @@ -414,7 +414,7 @@ The value is undefined when getter/setter are used. But we still handle the vers #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:109 +[packages/matter.js/src/cluster/server/AttributeServer.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L109) ___ @@ -428,7 +428,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:276 +[packages/matter.js/src/cluster/server/AttributeServer.ts:276](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L276) ___ @@ -442,7 +442,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:277 +[packages/matter.js/src/cluster/server/AttributeServer.ts:277](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L277) ## Methods @@ -469,7 +469,7 @@ new value and the version number. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:463 +[packages/matter.js/src/cluster/server/AttributeServer.ts:463](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L463) ___ @@ -496,7 +496,7 @@ new value and the old value. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:481 +[packages/matter.js/src/cluster/server/AttributeServer.ts:481](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L481) ___ @@ -520,7 +520,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:136 +[packages/matter.js/src/cluster/server/AttributeServer.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L136) ___ @@ -549,7 +549,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:194 +[packages/matter.js/src/cluster/server/AttributeServer.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L194) ___ @@ -571,7 +571,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:215 +[packages/matter.js/src/cluster/server/AttributeServer.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L215) ___ @@ -595,7 +595,7 @@ If a getter is defined this method returns an error and the value should be retr #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:683 +[packages/matter.js/src/cluster/server/AttributeServer.ts:683](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L683) ___ @@ -630,7 +630,7 @@ attributes. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:206 +[packages/matter.js/src/cluster/server/AttributeServer.ts:206](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L206) ___ @@ -659,7 +659,7 @@ internally. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:421 +[packages/matter.js/src/cluster/server/AttributeServer.ts:421](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L421) ___ @@ -686,7 +686,7 @@ the version number. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:608 +[packages/matter.js/src/cluster/server/AttributeServer.ts:608](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L608) ___ @@ -713,7 +713,7 @@ Helper Method to process the set of a value in a generic way. This method is use #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:410 +[packages/matter.js/src/cluster/server/AttributeServer.ts:410](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L410) ___ @@ -739,7 +739,7 @@ Remove an internal listener. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:470 +[packages/matter.js/src/cluster/server/AttributeServer.ts:470](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L470) ___ @@ -765,7 +765,7 @@ Remove an external listener. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:496 +[packages/matter.js/src/cluster/server/AttributeServer.ts:496](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L496) ___ @@ -795,7 +795,7 @@ Listeners are called when the value changes (internal listeners) or in any case #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:378 +[packages/matter.js/src/cluster/server/AttributeServer.ts:378](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L378) ___ @@ -821,7 +821,7 @@ Set Local is not allowed for fabric scoped attributes. Use setLocalForFabric ins #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:633 +[packages/matter.js/src/cluster/server/AttributeServer.ts:633](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L633) ___ @@ -848,7 +848,7 @@ Listeners are called when the value changes (internal listeners) or in any case #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:646 +[packages/matter.js/src/cluster/server/AttributeServer.ts:646](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L646) ___ @@ -876,7 +876,7 @@ we need to inject the fabric index into the value. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:618 +[packages/matter.js/src/cluster/server/AttributeServer.ts:618](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L618) ___ @@ -903,7 +903,7 @@ new value and the old value. This method is a convenient alias for addValueSetLi #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:489 +[packages/matter.js/src/cluster/server/AttributeServer.ts:489](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L489) ___ @@ -932,7 +932,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:437 +[packages/matter.js/src/cluster/server/AttributeServer.ts:437](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L437) ___ @@ -955,7 +955,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:453 +[packages/matter.js/src/cluster/server/AttributeServer.ts:453](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L453) ___ @@ -980,7 +980,7 @@ ACL checks needs to be performed before calling this method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:668 +[packages/matter.js/src/cluster/server/AttributeServer.ts:668](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L668) ___ @@ -1004,4 +1004,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:125 +[packages/matter.js/src/cluster/server/AttributeServer.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L125) diff --git a/docs/matter.js/classes/cluster_export.FixedAttributeServer.md b/docs/matter.js/classes/cluster_export.FixedAttributeServer.md index 88eb67afa7..f0e7cd5392 100644 --- a/docs/matter.js/classes/cluster_export.FixedAttributeServer.md +++ b/docs/matter.js/classes/cluster_export.FixedAttributeServer.md @@ -88,7 +88,7 @@ Attribute server types. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:155 +[packages/matter.js/src/cluster/server/AttributeServer.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L155) ## Properties @@ -102,7 +102,7 @@ packages/matter.js/src/cluster/server/AttributeServer.ts:155 #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:119 +[packages/matter.js/src/cluster/server/AttributeServer.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L119) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:110 +[packages/matter.js/src/cluster/server/AttributeServer.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L110) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:163 +[packages/matter.js/src/cluster/server/AttributeServer.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L163) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:153 +[packages/matter.js/src/cluster/server/AttributeServer.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L153) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:113 +[packages/matter.js/src/cluster/server/AttributeServer.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L113) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:152 +[packages/matter.js/src/cluster/server/AttributeServer.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L152) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:117 +[packages/matter.js/src/cluster/server/AttributeServer.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L117) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:116 +[packages/matter.js/src/cluster/server/AttributeServer.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L116) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:114 +[packages/matter.js/src/cluster/server/AttributeServer.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L114) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:118 +[packages/matter.js/src/cluster/server/AttributeServer.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L118) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:115 +[packages/matter.js/src/cluster/server/AttributeServer.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L115) ___ @@ -270,7 +270,7 @@ The value is undefined when getter/setter are used. But we still handle the vers #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:109 +[packages/matter.js/src/cluster/server/AttributeServer.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L109) ## Methods @@ -293,7 +293,7 @@ new value and the version number. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:236 +[packages/matter.js/src/cluster/server/AttributeServer.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L236) ___ @@ -316,7 +316,7 @@ new value and the old value. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:251 +[packages/matter.js/src/cluster/server/AttributeServer.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L251) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:136 +[packages/matter.js/src/cluster/server/AttributeServer.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L136) ___ @@ -365,7 +365,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:194 +[packages/matter.js/src/cluster/server/AttributeServer.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L194) ___ @@ -383,7 +383,7 @@ If a getter is defined the value is determined by that getter method. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:215 +[packages/matter.js/src/cluster/server/AttributeServer.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L215) ___ @@ -414,7 +414,7 @@ attributes. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:206 +[packages/matter.js/src/cluster/server/AttributeServer.ts:206](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L206) ___ @@ -442,7 +442,7 @@ If a getter or setter is defined the value must be undefined The version number #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:224 +[packages/matter.js/src/cluster/server/AttributeServer.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L224) ___ @@ -464,7 +464,7 @@ Remove an internal listener. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:243 +[packages/matter.js/src/cluster/server/AttributeServer.ts:243](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L243) ___ @@ -486,7 +486,7 @@ Remove an external listener. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:266 +[packages/matter.js/src/cluster/server/AttributeServer.ts:266](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L266) ___ @@ -509,7 +509,7 @@ new value and the old value. This method is a convenient alias for addValueSetLi #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:259 +[packages/matter.js/src/cluster/server/AttributeServer.ts:259](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L259) ___ @@ -533,4 +533,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:125 +[packages/matter.js/src/cluster/server/AttributeServer.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L125) diff --git a/docs/matter.js/classes/cluster_export.GroupsManager.md b/docs/matter.js/classes/cluster_export.GroupsManager.md index 8b5fcd3d9b..fc47d1d08b 100644 --- a/docs/matter.js/classes/cluster_export.GroupsManager.md +++ b/docs/matter.js/classes/cluster_export.GroupsManager.md @@ -45,7 +45,7 @@ #### Defined in -packages/matter.js/src/cluster/server/GroupsServer.ts:37 +[packages/matter.js/src/cluster/server/GroupsServer.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupsServer.ts#L37) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GroupsServer.ts:53 +[packages/matter.js/src/cluster/server/GroupsServer.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupsServer.ts#L53) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GroupsServer.ts:45 +[packages/matter.js/src/cluster/server/GroupsServer.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupsServer.ts#L45) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GroupsServer.ts:74 +[packages/matter.js/src/cluster/server/GroupsServer.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupsServer.ts#L74) ___ @@ -131,7 +131,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GroupsServer.ts:60 +[packages/matter.js/src/cluster/server/GroupsServer.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupsServer.ts#L60) ___ @@ -154,4 +154,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GroupsServer.ts:24 +[packages/matter.js/src/cluster/server/GroupsServer.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupsServer.ts#L24) diff --git a/docs/matter.js/classes/cluster_export.ScenesManager.md b/docs/matter.js/classes/cluster_export.ScenesManager.md index 2feaca51a6..f336a54238 100644 --- a/docs/matter.js/classes/cluster_export.ScenesManager.md +++ b/docs/matter.js/classes/cluster_export.ScenesManager.md @@ -47,7 +47,7 @@ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:91 +[packages/matter.js/src/cluster/server/ScenesServer.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L91) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:44 +[packages/matter.js/src/cluster/server/ScenesServer.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L44) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:82 +[packages/matter.js/src/cluster/server/ScenesServer.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L82) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:120 +[packages/matter.js/src/cluster/server/ScenesServer.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L120) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:111 +[packages/matter.js/src/cluster/server/ScenesServer.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L111) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:97 +[packages/matter.js/src/cluster/server/ScenesServer.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L97) ___ @@ -179,7 +179,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:54 +[packages/matter.js/src/cluster/server/ScenesServer.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L54) ___ @@ -201,4 +201,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:62 +[packages/matter.js/src/cluster/server/ScenesServer.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L62) diff --git a/docs/matter.js/classes/cluster_export.PresentAttributeClient.md b/docs/matter.js/classes/cluster_export.SupportedAttributeClient.md similarity index 60% rename from docs/matter.js/classes/cluster_export.PresentAttributeClient.md rename to docs/matter.js/classes/cluster_export.SupportedAttributeClient.md index 48fdb5c732..25ad29e95a 100644 --- a/docs/matter.js/classes/cluster_export.PresentAttributeClient.md +++ b/docs/matter.js/classes/cluster_export.SupportedAttributeClient.md @@ -1,10 +1,10 @@ -[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [cluster/export](../modules/cluster_export.md) / PresentAttributeClient +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [cluster/export](../modules/cluster_export.md) / SupportedAttributeClient -# Class: PresentAttributeClient +# Class: SupportedAttributeClient -[cluster/export](../modules/cluster_export.md).PresentAttributeClient +[cluster/export](../modules/cluster_export.md).SupportedAttributeClient -Special AttributeClient class to allow identifying attributes that are present because reported by the Devices. +Special AttributeClient class to allow identifying attributes that are supported because reported by the Devices. ## Type parameters @@ -16,40 +16,40 @@ Special AttributeClient class to allow identifying attributes that are present b - [`AttributeClient`](cluster_export.AttributeClient.md)<`T`\> - ↳ **`PresentAttributeClient`** + ↳ **`SupportedAttributeClient`** - ↳↳ [`UnknownPresentAttributeClient`](cluster_export.UnknownPresentAttributeClient.md) + ↳↳ [`UnknownSupportedAttributeClient`](cluster_export.UnknownSupportedAttributeClient.md) ## Table of contents ### Constructors -- [constructor](cluster_export.PresentAttributeClient.md#constructor) +- [constructor](cluster_export.SupportedAttributeClient.md#constructor) ### Properties -- [attribute](cluster_export.PresentAttributeClient.md#attribute) -- [clusterId](cluster_export.PresentAttributeClient.md#clusterid) -- [endpointId](cluster_export.PresentAttributeClient.md#endpointid) -- [id](cluster_export.PresentAttributeClient.md#id) -- [name](cluster_export.PresentAttributeClient.md#name) -- [schema](cluster_export.PresentAttributeClient.md#schema) +- [attribute](cluster_export.SupportedAttributeClient.md#attribute) +- [clusterId](cluster_export.SupportedAttributeClient.md#clusterid) +- [endpointId](cluster_export.SupportedAttributeClient.md#endpointid) +- [id](cluster_export.SupportedAttributeClient.md#id) +- [name](cluster_export.SupportedAttributeClient.md#name) +- [schema](cluster_export.SupportedAttributeClient.md#schema) ### Methods -- [addListener](cluster_export.PresentAttributeClient.md#addlistener) -- [get](cluster_export.PresentAttributeClient.md#get) -- [getWithVersion](cluster_export.PresentAttributeClient.md#getwithversion) -- [removeListener](cluster_export.PresentAttributeClient.md#removelistener) -- [set](cluster_export.PresentAttributeClient.md#set) -- [subscribe](cluster_export.PresentAttributeClient.md#subscribe) -- [update](cluster_export.PresentAttributeClient.md#update) +- [addListener](cluster_export.SupportedAttributeClient.md#addlistener) +- [get](cluster_export.SupportedAttributeClient.md#get) +- [getWithVersion](cluster_export.SupportedAttributeClient.md#getwithversion) +- [removeListener](cluster_export.SupportedAttributeClient.md#removelistener) +- [set](cluster_export.SupportedAttributeClient.md#set) +- [subscribe](cluster_export.SupportedAttributeClient.md#subscribe) +- [update](cluster_export.SupportedAttributeClient.md#update) ## Constructors ### constructor -• **new PresentAttributeClient**<`T`\>(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`) +• **new SupportedAttributeClient**<`T`\>(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`) #### Type parameters @@ -73,7 +73,7 @@ Special AttributeClient class to allow identifying attributes that are present b #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:48 +[packages/matter.js/src/cluster/client/AttributeClient.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L48) ## Properties @@ -87,7 +87,7 @@ packages/matter.js/src/cluster/client/AttributeClient.ts:48 #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:49 +[packages/matter.js/src/cluster/client/AttributeClient.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L49) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:52 +[packages/matter.js/src/cluster/client/AttributeClient.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L52) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:51 +[packages/matter.js/src/cluster/client/AttributeClient.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L51) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:46 +[packages/matter.js/src/cluster/client/AttributeClient.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L46) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:50 +[packages/matter.js/src/cluster/client/AttributeClient.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L50) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:44 +[packages/matter.js/src/cluster/client/AttributeClient.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L44) ## Methods @@ -183,7 +183,7 @@ Add a listener to the attribute. #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:166 +[packages/matter.js/src/cluster/client/AttributeClient.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L166) ___ @@ -210,7 +210,7 @@ Get the value of the attribute. Fabric scoped reads are always done with the rem #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:105 +[packages/matter.js/src/cluster/client/AttributeClient.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L105) ___ @@ -237,7 +237,7 @@ Get the value with version of the attribute. Fabric scoped reads are always done #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:123 +[packages/matter.js/src/cluster/client/AttributeClient.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L123) ___ @@ -263,7 +263,7 @@ Remove a listener from the attribute. #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:171 +[packages/matter.js/src/cluster/client/AttributeClient.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L171) ___ @@ -291,7 +291,7 @@ cluster dataVersion of the server matches. If it does not match it is rejected w #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:66 +[packages/matter.js/src/cluster/client/AttributeClient.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L66) ___ @@ -320,7 +320,7 @@ Subscribe to the attribute. #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:139 +[packages/matter.js/src/cluster/client/AttributeClient.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L139) ___ @@ -346,4 +346,4 @@ Update the value of the attribute. Just internally used! #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:161 +[packages/matter.js/src/cluster/client/AttributeClient.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L161) diff --git a/docs/matter.js/classes/cluster_export.PresentEventClient.md b/docs/matter.js/classes/cluster_export.SupportedEventClient.md similarity index 61% rename from docs/matter.js/classes/cluster_export.PresentEventClient.md rename to docs/matter.js/classes/cluster_export.SupportedEventClient.md index 67c120760a..5b53c2acce 100644 --- a/docs/matter.js/classes/cluster_export.PresentEventClient.md +++ b/docs/matter.js/classes/cluster_export.SupportedEventClient.md @@ -1,10 +1,10 @@ -[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [cluster/export](../modules/cluster_export.md) / PresentEventClient +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [cluster/export](../modules/cluster_export.md) / SupportedEventClient -# Class: PresentEventClient +# Class: SupportedEventClient -[cluster/export](../modules/cluster_export.md).PresentEventClient +[cluster/export](../modules/cluster_export.md).SupportedEventClient -Special EventClient class to allow identifying events that are present because reported by the Devices. +Special EventClient class to allow identifying events that are supported because reported by the Devices. ## Type parameters @@ -16,35 +16,35 @@ Special EventClient class to allow identifying events that are present because r - [`EventClient`](cluster_export.EventClient.md)<`T`\> - ↳ **`PresentEventClient`** + ↳ **`SupportedEventClient`** ## Table of contents ### Constructors -- [constructor](cluster_export.PresentEventClient.md#constructor) +- [constructor](cluster_export.SupportedEventClient.md#constructor) ### Properties -- [clusterId](cluster_export.PresentEventClient.md#clusterid) -- [endpointId](cluster_export.PresentEventClient.md#endpointid) -- [event](cluster_export.PresentEventClient.md#event) -- [id](cluster_export.PresentEventClient.md#id) -- [name](cluster_export.PresentEventClient.md#name) +- [clusterId](cluster_export.SupportedEventClient.md#clusterid) +- [endpointId](cluster_export.SupportedEventClient.md#endpointid) +- [event](cluster_export.SupportedEventClient.md#event) +- [id](cluster_export.SupportedEventClient.md#id) +- [name](cluster_export.SupportedEventClient.md#name) ### Methods -- [addListener](cluster_export.PresentEventClient.md#addlistener) -- [get](cluster_export.PresentEventClient.md#get) -- [removeListener](cluster_export.PresentEventClient.md#removelistener) -- [subscribe](cluster_export.PresentEventClient.md#subscribe) -- [update](cluster_export.PresentEventClient.md#update) +- [addListener](cluster_export.SupportedEventClient.md#addlistener) +- [get](cluster_export.SupportedEventClient.md#get) +- [removeListener](cluster_export.SupportedEventClient.md#removelistener) +- [subscribe](cluster_export.SupportedEventClient.md#subscribe) +- [update](cluster_export.SupportedEventClient.md#update) ## Constructors ### constructor -• **new PresentEventClient**<`T`\>(`event`, `name`, `endpointId`, `clusterId`, `interactionClient`) +• **new SupportedEventClient**<`T`\>(`event`, `name`, `endpointId`, `clusterId`, `interactionClient`) #### Type parameters @@ -68,7 +68,7 @@ Special EventClient class to allow identifying events that are present because r #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:41 +[packages/matter.js/src/cluster/client/EventClient.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L41) ## Properties @@ -82,7 +82,7 @@ packages/matter.js/src/cluster/client/EventClient.ts:41 #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:45 +[packages/matter.js/src/cluster/client/EventClient.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L45) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:44 +[packages/matter.js/src/cluster/client/EventClient.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L44) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:42 +[packages/matter.js/src/cluster/client/EventClient.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L42) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:39 +[packages/matter.js/src/cluster/client/EventClient.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L39) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:43 +[packages/matter.js/src/cluster/client/EventClient.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L43) ## Methods @@ -162,7 +162,7 @@ packages/matter.js/src/cluster/client/EventClient.ts:43 #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:90 +[packages/matter.js/src/cluster/client/EventClient.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L90) ___ @@ -187,7 +187,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:51 +[packages/matter.js/src/cluster/client/EventClient.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L51) ___ @@ -211,7 +211,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:94 +[packages/matter.js/src/cluster/client/EventClient.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L94) ___ @@ -239,7 +239,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:64 +[packages/matter.js/src/cluster/client/EventClient.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L64) ___ @@ -263,4 +263,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:84 +[packages/matter.js/src/cluster/client/EventClient.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L84) diff --git a/docs/matter.js/classes/cluster_export.UnknownPresentAttributeClient.md b/docs/matter.js/classes/cluster_export.UnknownPresentAttributeClient.md deleted file mode 100644 index 05b38f6b3b..0000000000 --- a/docs/matter.js/classes/cluster_export.UnknownPresentAttributeClient.md +++ /dev/null @@ -1,336 +0,0 @@ -[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [cluster/export](../modules/cluster_export.md) / UnknownPresentAttributeClient - -# Class: UnknownPresentAttributeClient - -[cluster/export](../modules/cluster_export.md).UnknownPresentAttributeClient - -Special AttributeClient class to allow identifying attributes that are present because reported by the Devices, -but the contained attribute is unknown. - -## Hierarchy - -- [`PresentAttributeClient`](cluster_export.PresentAttributeClient.md)<`any`\> - - ↳ **`UnknownPresentAttributeClient`** - -## Table of contents - -### Constructors - -- [constructor](cluster_export.UnknownPresentAttributeClient.md#constructor) - -### Properties - -- [attribute](cluster_export.UnknownPresentAttributeClient.md#attribute) -- [clusterId](cluster_export.UnknownPresentAttributeClient.md#clusterid) -- [endpointId](cluster_export.UnknownPresentAttributeClient.md#endpointid) -- [id](cluster_export.UnknownPresentAttributeClient.md#id) -- [name](cluster_export.UnknownPresentAttributeClient.md#name) -- [schema](cluster_export.UnknownPresentAttributeClient.md#schema) - -### Methods - -- [addListener](cluster_export.UnknownPresentAttributeClient.md#addlistener) -- [get](cluster_export.UnknownPresentAttributeClient.md#get) -- [getWithVersion](cluster_export.UnknownPresentAttributeClient.md#getwithversion) -- [removeListener](cluster_export.UnknownPresentAttributeClient.md#removelistener) -- [set](cluster_export.UnknownPresentAttributeClient.md#set) -- [subscribe](cluster_export.UnknownPresentAttributeClient.md#subscribe) -- [update](cluster_export.UnknownPresentAttributeClient.md#update) - -## Constructors - -### constructor - -• **new UnknownPresentAttributeClient**(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `attribute` | [`Attribute`](../modules/cluster_export.md#attribute)<`any`, `any`\> | -| `name` | `string` | -| `endpointId` | [`EndpointNumber`](../modules/datatype_export.md#endpointnumber) | -| `clusterId` | [`ClusterId`](../modules/datatype_export.md#clusterid) | -| `interactionClient` | [`InteractionClient`](protocol_interaction_export.InteractionClient.md) | - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[constructor](cluster_export.PresentAttributeClient.md#constructor) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:48 - -## Properties - -### attribute - -• `Readonly` **attribute**: [`Attribute`](../modules/cluster_export.md#attribute)<`any`, `any`\> - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[attribute](cluster_export.PresentAttributeClient.md#attribute) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:49 - -___ - -### clusterId - -• `Readonly` **clusterId**: [`ClusterId`](../modules/datatype_export.md#clusterid) - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[clusterId](cluster_export.PresentAttributeClient.md#clusterid) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:52 - -___ - -### endpointId - -• `Readonly` **endpointId**: [`EndpointNumber`](../modules/datatype_export.md#endpointnumber) - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[endpointId](cluster_export.PresentAttributeClient.md#endpointid) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:51 - -___ - -### id - -• `Readonly` **id**: [`AttributeId`](../modules/datatype_export.md#attributeid) - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[id](cluster_export.PresentAttributeClient.md#id) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:46 - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[name](cluster_export.PresentAttributeClient.md#name) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:50 - -___ - -### schema - -• `Protected` `Readonly` **schema**: [`TlvSchema`](tlv_export.TlvSchema.md)<`any`\> - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[schema](cluster_export.PresentAttributeClient.md#schema) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:44 - -## Methods - -### addListener - -▸ **addListener**(`listener`): `void` - -Add a listener to the attribute. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | (`newValue`: `any`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[addListener](cluster_export.PresentAttributeClient.md#addlistener) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:166 - -___ - -### get - -▸ **get**(`alwaysRequestFromRemote?`, `isFabricFiltered?`): `Promise`<`any`\> - -Get the value of the attribute. Fabric scoped reads are always done with the remote. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `alwaysRequestFromRemote?` | `boolean` | `undefined` | -| `isFabricFiltered` | `boolean` | `true` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[get](cluster_export.PresentAttributeClient.md#get) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:105 - -___ - -### getWithVersion - -▸ **getWithVersion**(`alwaysRequestFromRemote?`, `isFabricFiltered?`): `Promise`<`undefined` \| { `value`: `any` ; `version`: `number` }\> - -Get the value with version of the attribute. Fabric scoped reads are always done with the remote. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `alwaysRequestFromRemote?` | `boolean` | `undefined` | -| `isFabricFiltered` | `boolean` | `true` | - -#### Returns - -`Promise`<`undefined` \| { `value`: `any` ; `version`: `number` }\> - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[getWithVersion](cluster_export.PresentAttributeClient.md#getwithversion) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:123 - -___ - -### removeListener - -▸ **removeListener**(`listener`): `void` - -Remove a listener from the attribute. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | (`newValue`: `any`) => `void` | - -#### Returns - -`void` - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[removeListener](cluster_export.PresentAttributeClient.md#removelistener) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:171 - -___ - -### set - -▸ **set**(`value`, `dataVersion?`): `Promise`<`void`\> - -Set the value of the attribute. When dataVersion parameter is provided the value is only set when the -cluster dataVersion of the server matches. If it does not match it is rejected with an Error. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | -| `dataVersion?` | `number` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[set](cluster_export.PresentAttributeClient.md#set) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:66 - -___ - -### subscribe - -▸ **subscribe**(`minIntervalFloorSeconds`, `maxIntervalCeilingSeconds`, `knownDataVersion?`, `isFabricFiltered?`): `Promise`<`void`\> - -Subscribe to the attribute. - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `minIntervalFloorSeconds` | `number` | `undefined` | -| `maxIntervalCeilingSeconds` | `number` | `undefined` | -| `knownDataVersion?` | `number` | `undefined` | -| `isFabricFiltered` | `boolean` | `true` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[subscribe](cluster_export.PresentAttributeClient.md#subscribe) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:139 - -___ - -### update - -▸ `Private` **update**(`value`): `void` - -Update the value of the attribute. Just internally used! - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -`void` - -#### Inherited from - -[PresentAttributeClient](cluster_export.PresentAttributeClient.md).[update](cluster_export.PresentAttributeClient.md#update) - -#### Defined in - -packages/matter.js/src/cluster/client/AttributeClient.ts:161 diff --git a/docs/matter.js/classes/cluster_export.UnknownSupportedAttributeClient.md b/docs/matter.js/classes/cluster_export.UnknownSupportedAttributeClient.md new file mode 100644 index 0000000000..2b32abc19f --- /dev/null +++ b/docs/matter.js/classes/cluster_export.UnknownSupportedAttributeClient.md @@ -0,0 +1,336 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [cluster/export](../modules/cluster_export.md) / UnknownSupportedAttributeClient + +# Class: UnknownSupportedAttributeClient + +[cluster/export](../modules/cluster_export.md).UnknownSupportedAttributeClient + +Special AttributeClient class to allow identifying attributes that are supported because reported by the Devices, +but the contained attribute is unknown. + +## Hierarchy + +- [`SupportedAttributeClient`](cluster_export.SupportedAttributeClient.md)<`any`\> + + ↳ **`UnknownSupportedAttributeClient`** + +## Table of contents + +### Constructors + +- [constructor](cluster_export.UnknownSupportedAttributeClient.md#constructor) + +### Properties + +- [attribute](cluster_export.UnknownSupportedAttributeClient.md#attribute) +- [clusterId](cluster_export.UnknownSupportedAttributeClient.md#clusterid) +- [endpointId](cluster_export.UnknownSupportedAttributeClient.md#endpointid) +- [id](cluster_export.UnknownSupportedAttributeClient.md#id) +- [name](cluster_export.UnknownSupportedAttributeClient.md#name) +- [schema](cluster_export.UnknownSupportedAttributeClient.md#schema) + +### Methods + +- [addListener](cluster_export.UnknownSupportedAttributeClient.md#addlistener) +- [get](cluster_export.UnknownSupportedAttributeClient.md#get) +- [getWithVersion](cluster_export.UnknownSupportedAttributeClient.md#getwithversion) +- [removeListener](cluster_export.UnknownSupportedAttributeClient.md#removelistener) +- [set](cluster_export.UnknownSupportedAttributeClient.md#set) +- [subscribe](cluster_export.UnknownSupportedAttributeClient.md#subscribe) +- [update](cluster_export.UnknownSupportedAttributeClient.md#update) + +## Constructors + +### constructor + +• **new UnknownSupportedAttributeClient**(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attribute` | [`Attribute`](../modules/cluster_export.md#attribute)<`any`, `any`\> | +| `name` | `string` | +| `endpointId` | [`EndpointNumber`](../modules/datatype_export.md#endpointnumber) | +| `clusterId` | [`ClusterId`](../modules/datatype_export.md#clusterid) | +| `interactionClient` | [`InteractionClient`](protocol_interaction_export.InteractionClient.md) | + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[constructor](cluster_export.SupportedAttributeClient.md#constructor) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L48) + +## Properties + +### attribute + +• `Readonly` **attribute**: [`Attribute`](../modules/cluster_export.md#attribute)<`any`, `any`\> + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[attribute](cluster_export.SupportedAttributeClient.md#attribute) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L49) + +___ + +### clusterId + +• `Readonly` **clusterId**: [`ClusterId`](../modules/datatype_export.md#clusterid) + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[clusterId](cluster_export.SupportedAttributeClient.md#clusterid) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L52) + +___ + +### endpointId + +• `Readonly` **endpointId**: [`EndpointNumber`](../modules/datatype_export.md#endpointnumber) + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[endpointId](cluster_export.SupportedAttributeClient.md#endpointid) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L51) + +___ + +### id + +• `Readonly` **id**: [`AttributeId`](../modules/datatype_export.md#attributeid) + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[id](cluster_export.SupportedAttributeClient.md#id) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L46) + +___ + +### name + +• `Readonly` **name**: `string` + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[name](cluster_export.SupportedAttributeClient.md#name) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L50) + +___ + +### schema + +• `Protected` `Readonly` **schema**: [`TlvSchema`](tlv_export.TlvSchema.md)<`any`\> + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[schema](cluster_export.SupportedAttributeClient.md#schema) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L44) + +## Methods + +### addListener + +▸ **addListener**(`listener`): `void` + +Add a listener to the attribute. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `listener` | (`newValue`: `any`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[addListener](cluster_export.SupportedAttributeClient.md#addlistener) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L166) + +___ + +### get + +▸ **get**(`alwaysRequestFromRemote?`, `isFabricFiltered?`): `Promise`<`any`\> + +Get the value of the attribute. Fabric scoped reads are always done with the remote. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `alwaysRequestFromRemote?` | `boolean` | `undefined` | +| `isFabricFiltered` | `boolean` | `true` | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[get](cluster_export.SupportedAttributeClient.md#get) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L105) + +___ + +### getWithVersion + +▸ **getWithVersion**(`alwaysRequestFromRemote?`, `isFabricFiltered?`): `Promise`<`undefined` \| { `value`: `any` ; `version`: `number` }\> + +Get the value with version of the attribute. Fabric scoped reads are always done with the remote. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `alwaysRequestFromRemote?` | `boolean` | `undefined` | +| `isFabricFiltered` | `boolean` | `true` | + +#### Returns + +`Promise`<`undefined` \| { `value`: `any` ; `version`: `number` }\> + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[getWithVersion](cluster_export.SupportedAttributeClient.md#getwithversion) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L123) + +___ + +### removeListener + +▸ **removeListener**(`listener`): `void` + +Remove a listener from the attribute. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `listener` | (`newValue`: `any`) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[removeListener](cluster_export.SupportedAttributeClient.md#removelistener) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L171) + +___ + +### set + +▸ **set**(`value`, `dataVersion?`): `Promise`<`void`\> + +Set the value of the attribute. When dataVersion parameter is provided the value is only set when the +cluster dataVersion of the server matches. If it does not match it is rejected with an Error. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | +| `dataVersion?` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[set](cluster_export.SupportedAttributeClient.md#set) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L66) + +___ + +### subscribe + +▸ **subscribe**(`minIntervalFloorSeconds`, `maxIntervalCeilingSeconds`, `knownDataVersion?`, `isFabricFiltered?`): `Promise`<`void`\> + +Subscribe to the attribute. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `minIntervalFloorSeconds` | `number` | `undefined` | +| `maxIntervalCeilingSeconds` | `number` | `undefined` | +| `knownDataVersion?` | `number` | `undefined` | +| `isFabricFiltered` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[subscribe](cluster_export.SupportedAttributeClient.md#subscribe) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L139) + +___ + +### update + +▸ `Private` **update**(`value`): `void` + +Update the value of the attribute. Just internally used! + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +`void` + +#### Inherited from + +[SupportedAttributeClient](cluster_export.SupportedAttributeClient.md).[update](cluster_export.SupportedAttributeClient.md#update) + +#### Defined in + +[packages/matter.js/src/cluster/client/AttributeClient.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L161) diff --git a/docs/matter.js/classes/cluster_export.UnknownPresentEventClient.md b/docs/matter.js/classes/cluster_export.UnknownSupportedEventClient.md similarity index 59% rename from docs/matter.js/classes/cluster_export.UnknownPresentEventClient.md rename to docs/matter.js/classes/cluster_export.UnknownSupportedEventClient.md index cb583d4ccc..5b4609e86a 100644 --- a/docs/matter.js/classes/cluster_export.UnknownPresentEventClient.md +++ b/docs/matter.js/classes/cluster_export.UnknownSupportedEventClient.md @@ -1,45 +1,45 @@ -[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [cluster/export](../modules/cluster_export.md) / UnknownPresentEventClient +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [cluster/export](../modules/cluster_export.md) / UnknownSupportedEventClient -# Class: UnknownPresentEventClient +# Class: UnknownSupportedEventClient -[cluster/export](../modules/cluster_export.md).UnknownPresentEventClient +[cluster/export](../modules/cluster_export.md).UnknownSupportedEventClient -Special EventClient class to allow identifying events that are present because reported by the Devices, +Special EventClient class to allow identifying events that are supported because reported by the Devices, but the contained event is unknown. ## Hierarchy - [`EventClient`](cluster_export.EventClient.md)<`any`\> - ↳ **`UnknownPresentEventClient`** + ↳ **`UnknownSupportedEventClient`** ## Table of contents ### Constructors -- [constructor](cluster_export.UnknownPresentEventClient.md#constructor) +- [constructor](cluster_export.UnknownSupportedEventClient.md#constructor) ### Properties -- [clusterId](cluster_export.UnknownPresentEventClient.md#clusterid) -- [endpointId](cluster_export.UnknownPresentEventClient.md#endpointid) -- [event](cluster_export.UnknownPresentEventClient.md#event) -- [id](cluster_export.UnknownPresentEventClient.md#id) -- [name](cluster_export.UnknownPresentEventClient.md#name) +- [clusterId](cluster_export.UnknownSupportedEventClient.md#clusterid) +- [endpointId](cluster_export.UnknownSupportedEventClient.md#endpointid) +- [event](cluster_export.UnknownSupportedEventClient.md#event) +- [id](cluster_export.UnknownSupportedEventClient.md#id) +- [name](cluster_export.UnknownSupportedEventClient.md#name) ### Methods -- [addListener](cluster_export.UnknownPresentEventClient.md#addlistener) -- [get](cluster_export.UnknownPresentEventClient.md#get) -- [removeListener](cluster_export.UnknownPresentEventClient.md#removelistener) -- [subscribe](cluster_export.UnknownPresentEventClient.md#subscribe) -- [update](cluster_export.UnknownPresentEventClient.md#update) +- [addListener](cluster_export.UnknownSupportedEventClient.md#addlistener) +- [get](cluster_export.UnknownSupportedEventClient.md#get) +- [removeListener](cluster_export.UnknownSupportedEventClient.md#removelistener) +- [subscribe](cluster_export.UnknownSupportedEventClient.md#subscribe) +- [update](cluster_export.UnknownSupportedEventClient.md#update) ## Constructors ### constructor -• **new UnknownPresentEventClient**(`event`, `name`, `endpointId`, `clusterId`, `interactionClient`) +• **new UnknownSupportedEventClient**(`event`, `name`, `endpointId`, `clusterId`, `interactionClient`) #### Parameters @@ -57,7 +57,7 @@ but the contained event is unknown. #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:41 +[packages/matter.js/src/cluster/client/EventClient.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L41) ## Properties @@ -71,7 +71,7 @@ packages/matter.js/src/cluster/client/EventClient.ts:41 #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:45 +[packages/matter.js/src/cluster/client/EventClient.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L45) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:44 +[packages/matter.js/src/cluster/client/EventClient.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L44) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:42 +[packages/matter.js/src/cluster/client/EventClient.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L42) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:39 +[packages/matter.js/src/cluster/client/EventClient.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L39) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:43 +[packages/matter.js/src/cluster/client/EventClient.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L43) ## Methods @@ -151,7 +151,7 @@ packages/matter.js/src/cluster/client/EventClient.ts:43 #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:90 +[packages/matter.js/src/cluster/client/EventClient.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L90) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:51 +[packages/matter.js/src/cluster/client/EventClient.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L51) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:94 +[packages/matter.js/src/cluster/client/EventClient.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L94) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:64 +[packages/matter.js/src/cluster/client/EventClient.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L64) ___ @@ -252,4 +252,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:84 +[packages/matter.js/src/cluster/client/EventClient.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L84) diff --git a/docs/matter.js/classes/codec_export.BtpCodec.md b/docs/matter.js/classes/codec_export.BtpCodec.md index a3d832b62e..381db2da3b 100644 --- a/docs/matter.js/classes/codec_export.BtpCodec.md +++ b/docs/matter.js/classes/codec_export.BtpCodec.md @@ -58,7 +58,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:305 +[packages/matter.js/src/codec/BtpCodec.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L305) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:325 +[packages/matter.js/src/codec/BtpCodec.ts:325](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L325) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:72 +[packages/matter.js/src/codec/BtpCodec.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L72) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:217 +[packages/matter.js/src/codec/BtpCodec.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L217) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:77 +[packages/matter.js/src/codec/BtpCodec.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L77) ___ @@ -165,7 +165,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:235 +[packages/matter.js/src/codec/BtpCodec.ts:235](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L235) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:115 +[packages/matter.js/src/codec/BtpCodec.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L115) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:178 +[packages/matter.js/src/codec/BtpCodec.ts:178](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L178) ___ @@ -229,7 +229,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:284 +[packages/matter.js/src/codec/BtpCodec.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L284) ___ @@ -249,7 +249,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:92 +[packages/matter.js/src/codec/BtpCodec.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L92) ___ @@ -269,7 +269,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:105 +[packages/matter.js/src/codec/BtpCodec.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L105) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:88 +[packages/matter.js/src/codec/BtpCodec.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L88) ___ @@ -309,7 +309,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:258 +[packages/matter.js/src/codec/BtpCodec.ts:258](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L258) ___ @@ -330,4 +330,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:128 +[packages/matter.js/src/codec/BtpCodec.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L128) diff --git a/docs/matter.js/classes/codec_export.DerCodec.md b/docs/matter.js/classes/codec_export.DerCodec.md index abd0d7b02d..169391c6fe 100644 --- a/docs/matter.js/classes/codec_export.DerCodec.md +++ b/docs/matter.js/classes/codec_export.DerCodec.md @@ -50,7 +50,7 @@ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:167 +[packages/matter.js/src/codec/DerCodec.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L167) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:184 +[packages/matter.js/src/codec/DerCodec.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L184) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:171 +[packages/matter.js/src/codec/DerCodec.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L171) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:63 +[packages/matter.js/src/codec/DerCodec.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L63) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:163 +[packages/matter.js/src/codec/DerCodec.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L163) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:108 +[packages/matter.js/src/codec/DerCodec.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L108) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:104 +[packages/matter.js/src/codec/DerCodec.ts:104](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L104) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:92 +[packages/matter.js/src/codec/DerCodec.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L92) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:145 +[packages/matter.js/src/codec/DerCodec.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L145) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:119 +[packages/matter.js/src/codec/DerCodec.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L119) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:115 +[packages/matter.js/src/codec/DerCodec.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L115) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:127 +[packages/matter.js/src/codec/DerCodec.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L127) ___ @@ -296,4 +296,4 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:131 +[packages/matter.js/src/codec/DerCodec.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L131) diff --git a/docs/matter.js/classes/codec_export.DnsCodec.md b/docs/matter.js/classes/codec_export.DnsCodec.md index d0383989af..ad2fed0835 100644 --- a/docs/matter.js/classes/codec_export.DnsCodec.md +++ b/docs/matter.js/classes/codec_export.DnsCodec.md @@ -54,7 +54,7 @@ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:125 +[packages/matter.js/src/codec/DnsCodec.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L125) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:261 +[packages/matter.js/src/codec/DnsCodec.ts:261](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L261) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:235 +[packages/matter.js/src/codec/DnsCodec.ts:235](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L235) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:178 +[packages/matter.js/src/codec/DnsCodec.ts:178](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L178) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:156 +[packages/matter.js/src/codec/DnsCodec.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L156) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:165 +[packages/matter.js/src/codec/DnsCodec.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L165) ___ @@ -179,7 +179,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:196 +[packages/matter.js/src/codec/DnsCodec.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L196) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:214 +[packages/matter.js/src/codec/DnsCodec.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L214) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:223 +[packages/matter.js/src/codec/DnsCodec.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L223) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:270 +[packages/matter.js/src/codec/DnsCodec.ts:270](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L270) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:337 +[packages/matter.js/src/codec/DnsCodec.ts:337](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L337) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:346 +[packages/matter.js/src/codec/DnsCodec.ts:346](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L346) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:381 +[packages/matter.js/src/codec/DnsCodec.ts:381](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L381) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:305 +[packages/matter.js/src/codec/DnsCodec.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L305) ___ @@ -341,7 +341,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:319 +[packages/matter.js/src/codec/DnsCodec.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L319) ___ @@ -361,7 +361,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:372 +[packages/matter.js/src/codec/DnsCodec.ts:372](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L372) ___ @@ -381,4 +381,4 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:362 +[packages/matter.js/src/codec/DnsCodec.ts:362](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L362) diff --git a/docs/matter.js/classes/codec_export.MessageCodec.md b/docs/matter.js/classes/codec_export.MessageCodec.md index 6dba79d292..6ed637d6e8 100644 --- a/docs/matter.js/classes/codec_export.MessageCodec.md +++ b/docs/matter.js/classes/codec_export.MessageCodec.md @@ -46,7 +46,7 @@ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:79 +[packages/matter.js/src/codec/MessageCodec.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L79) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:109 +[packages/matter.js/src/codec/MessageCodec.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L109) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:89 +[packages/matter.js/src/codec/MessageCodec.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L89) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:151 +[packages/matter.js/src/codec/MessageCodec.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L151) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:105 +[packages/matter.js/src/codec/MessageCodec.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L105) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:169 +[packages/matter.js/src/codec/MessageCodec.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L169) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:98 +[packages/matter.js/src/codec/MessageCodec.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L98) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:209 +[packages/matter.js/src/codec/MessageCodec.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L209) ___ @@ -218,4 +218,4 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:195 +[packages/matter.js/src/codec/MessageCodec.ts:195](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L195) diff --git a/docs/matter.js/classes/common_export.FailSafeManager.md b/docs/matter.js/classes/common_export.FailSafeManager.md index c7b1dc7165..880e7e94f7 100644 --- a/docs/matter.js/classes/common_export.FailSafeManager.md +++ b/docs/matter.js/classes/common_export.FailSafeManager.md @@ -60,7 +60,7 @@ Class to Handle one FailSafe context. This is mainly used when adding (Commissio #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:30 +[packages/matter.js/src/common/FailSafeManager.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L30) ## Properties @@ -70,7 +70,7 @@ packages/matter.js/src/common/FailSafeManager.ts:30 #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:32 +[packages/matter.js/src/common/FailSafeManager.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L32) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:27 +[packages/matter.js/src/common/FailSafeManager.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L27) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:31 +[packages/matter.js/src/common/FailSafeManager.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L31) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:35 +[packages/matter.js/src/common/FailSafeManager.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L35) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:20 +[packages/matter.js/src/common/FailSafeManager.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L20) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:21 +[packages/matter.js/src/common/FailSafeManager.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L21) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:28 +[packages/matter.js/src/common/FailSafeManager.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L28) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:22 +[packages/matter.js/src/common/FailSafeManager.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L22) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:36 +[packages/matter.js/src/common/FailSafeManager.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L36) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:23 +[packages/matter.js/src/common/FailSafeManager.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L23) ## Accessors @@ -182,7 +182,7 @@ packages/matter.js/src/common/FailSafeManager.ts:23 #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:79 +[packages/matter.js/src/common/FailSafeManager.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L79) ## Methods @@ -209,7 +209,7 @@ Build a new Fabric object for a new fabric for the "AddNoc" case of the Operatio #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:163 +[packages/matter.js/src/common/FailSafeManager.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L163) ___ @@ -233,7 +233,7 @@ cluster. #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:152 +[packages/matter.js/src/common/FailSafeManager.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L152) ___ @@ -249,7 +249,7 @@ Complete the FailSafe context. This is called when the commissioning is complete #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:118 +[packages/matter.js/src/common/FailSafeManager.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L118) ___ @@ -273,7 +273,7 @@ validity checks. #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:127 +[packages/matter.js/src/common/FailSafeManager.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L127) ___ @@ -289,7 +289,7 @@ Expire the FailSafe context. This is called by the timer and can also be called #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:111 +[packages/matter.js/src/common/FailSafeManager.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L111) ___ @@ -312,7 +312,7 @@ Handle "Re-Arming" an existing FailSafe context to extend the timer, expire or f #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:84 +[packages/matter.js/src/common/FailSafeManager.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L84) ___ @@ -334,7 +334,7 @@ Restore Cluster data when the FailSafe context expired. #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:60 +[packages/matter.js/src/common/FailSafeManager.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L60) ___ @@ -356,7 +356,7 @@ Handles adding a trusted root certificate from Operational Credentials cluster. #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:141 +[packages/matter.js/src/common/FailSafeManager.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L141) ___ @@ -378,4 +378,4 @@ Store required CLuster data when opening the FailSafe context to allow to restor #### Defined in -packages/matter.js/src/common/FailSafeManager.ts:46 +[packages/matter.js/src/common/FailSafeManager.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/FailSafeManager.ts#L46) diff --git a/docs/matter.js/classes/common_export.MatterError.md b/docs/matter.js/classes/common_export.MatterError.md index f8ffc01842..80b4e21710 100644 --- a/docs/matter.js/classes/common_export.MatterError.md +++ b/docs/matter.js/classes/common_export.MatterError.md @@ -50,6 +50,8 @@ Error base class for all errors thrown by this library. ↳↳ [`CommissioningError`](protocol_export.CommissioningError.md) + ↳↳ [`DiscoveryError`](protocol_export.DiscoveryError.md) + ↳↳ [`RetransmissionLimitReachedError`](protocol_export.RetransmissionLimitReachedError.md) ↳↳ [`UnexpectedMessageError`](protocol_export.UnexpectedMessageError.md) diff --git a/docs/matter.js/classes/crypto_export.Crypto.md b/docs/matter.js/classes/crypto_export.Crypto.md index c8d0c42f1a..be331ce9dc 100644 --- a/docs/matter.js/classes/crypto_export.Crypto.md +++ b/docs/matter.js/classes/crypto_export.Crypto.md @@ -70,7 +70,7 @@ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:25 +[packages/matter.js/src/crypto/Crypto.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L25) ## Methods @@ -84,7 +84,7 @@ packages/matter.js/src/crypto/Crypto.ts:25 #### Defined in -packages/matter.js/src/crypto/Crypto.ts:112 +[packages/matter.js/src/crypto/Crypto.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L112) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:33 +[packages/matter.js/src/crypto/Crypto.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L33) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:58 +[packages/matter.js/src/crypto/Crypto.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L58) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:62 +[packages/matter.js/src/crypto/Crypto.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L62) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:70 +[packages/matter.js/src/crypto/Crypto.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L70) ___ @@ -195,7 +195,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:29 +[packages/matter.js/src/crypto/Crypto.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L29) ___ @@ -215,7 +215,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:37 +[packages/matter.js/src/crypto/Crypto.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L37) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:74 +[packages/matter.js/src/crypto/Crypto.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L74) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:85 +[packages/matter.js/src/crypto/Crypto.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L85) ___ @@ -279,7 +279,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:89 +[packages/matter.js/src/crypto/Crypto.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L89) ___ @@ -302,7 +302,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:77 +[packages/matter.js/src/crypto/Crypto.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L77) ___ @@ -324,7 +324,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:92 +[packages/matter.js/src/crypto/Crypto.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L92) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:99 +[packages/matter.js/src/crypto/Crypto.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L99) ___ @@ -361,7 +361,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:113 +[packages/matter.js/src/crypto/Crypto.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L113) ___ @@ -384,7 +384,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:34 +[packages/matter.js/src/crypto/Crypto.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L34) ___ @@ -403,7 +403,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:59 +[packages/matter.js/src/crypto/Crypto.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L59) ___ @@ -428,7 +428,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:66 +[packages/matter.js/src/crypto/Crypto.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L66) ___ @@ -449,7 +449,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:71 +[packages/matter.js/src/crypto/Crypto.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L71) ___ @@ -472,7 +472,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:30 +[packages/matter.js/src/crypto/Crypto.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L30) ___ @@ -486,7 +486,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:40 +[packages/matter.js/src/crypto/Crypto.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L40) ___ @@ -507,7 +507,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:51 +[packages/matter.js/src/crypto/Crypto.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L51) ___ @@ -521,7 +521,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:48 +[packages/matter.js/src/crypto/Crypto.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L48) ___ @@ -541,7 +541,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:38 +[packages/matter.js/src/crypto/Crypto.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L38) ___ @@ -555,7 +555,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:42 +[packages/matter.js/src/crypto/Crypto.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L42) ___ @@ -569,7 +569,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:45 +[packages/matter.js/src/crypto/Crypto.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L45) ___ @@ -589,7 +589,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:75 +[packages/matter.js/src/crypto/Crypto.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L75) ___ @@ -612,7 +612,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:86 +[packages/matter.js/src/crypto/Crypto.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L86) ___ @@ -633,7 +633,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:90 +[packages/matter.js/src/crypto/Crypto.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L90) ___ @@ -656,7 +656,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:78 +[packages/matter.js/src/crypto/Crypto.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L78) ___ @@ -678,7 +678,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:93 +[packages/matter.js/src/crypto/Crypto.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L93) ___ @@ -701,4 +701,4 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:105 +[packages/matter.js/src/crypto/Crypto.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L105) diff --git a/docs/matter.js/classes/crypto_export.Spake2p.md b/docs/matter.js/classes/crypto_export.Spake2p.md index f85ce5a126..246275952e 100644 --- a/docs/matter.js/classes/crypto_export.Spake2p.md +++ b/docs/matter.js/classes/crypto_export.Spake2p.md @@ -45,7 +45,7 @@ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:45 +[packages/matter.js/src/crypto/Spake2p.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L45) ## Properties @@ -55,7 +55,7 @@ packages/matter.js/src/crypto/Spake2p.ts:45 #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:46 +[packages/matter.js/src/crypto/Spake2p.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L46) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:47 +[packages/matter.js/src/crypto/Spake2p.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L47) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:48 +[packages/matter.js/src/crypto/Spake2p.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L48) ## Methods @@ -96,7 +96,7 @@ packages/matter.js/src/crypto/Spake2p.ts:48 #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:109 +[packages/matter.js/src/crypto/Spake2p.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L109) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:79 +[packages/matter.js/src/crypto/Spake2p.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L79) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:70 +[packages/matter.js/src/crypto/Spake2p.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L70) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:61 +[packages/matter.js/src/crypto/Spake2p.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L61) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:94 +[packages/matter.js/src/crypto/Spake2p.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L94) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:51 +[packages/matter.js/src/crypto/Spake2p.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L51) ___ @@ -214,13 +214,13 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:56 +[packages/matter.js/src/crypto/Spake2p.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L56) ___ ### computeW0L -▸ `Static` **computeW0L**(`pbkdfParameters`, `pin`): `Promise`<{ `L`: `any` ; `w0`: `BN` }\> +▸ `Static` **computeW0L**(`pbkdfParameters`, `pin`): `Promise`<{ `L`: `Uint8Array` ; `w0`: `BN` }\> #### Parameters @@ -231,11 +231,11 @@ ___ #### Returns -`Promise`<{ `L`: `any` ; `w0`: `BN` }\> +`Promise`<{ `L`: `Uint8Array` ; `w0`: `BN` }\> #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:34 +[packages/matter.js/src/crypto/Spake2p.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L34) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:25 +[packages/matter.js/src/crypto/Spake2p.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L25) ___ @@ -277,4 +277,4 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:40 +[packages/matter.js/src/crypto/Spake2p.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L40) diff --git a/docs/matter.js/classes/device_export.Aggregator.md b/docs/matter.js/classes/device_export.Aggregator.md index ba36dc1b08..18f50af2cf 100644 --- a/docs/matter.js/classes/device_export.Aggregator.md +++ b/docs/matter.js/classes/device_export.Aggregator.md @@ -83,7 +83,7 @@ already have the BridgedDeviceBasicInformationCluster added! #### Defined in -packages/matter.js/src/device/Aggregator.ts:29 +[packages/matter.js/src/device/Aggregator.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Aggregator.ts#L29) ## Properties @@ -99,7 +99,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -159,7 +159,7 @@ on the device! | Name | Type | Description | | :------ | :------ | :------ | | `device` | [`Device`](device_export.Device.md) \| [`ComposedDevice`](device_export.ComposedDevice.md) | Device instance to add | -| `bridgedBasicInformation?` | [`AttributeInitialValues`](../modules/cluster_export.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `hardwareVersion`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](../modules/cluster_export.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](../modules/cluster_export.md#optionalattribute)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](../modules/cluster_export.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<[`VendorId`](../modules/datatype_export.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/cluster_export.md#globalattributes-1)<{}\>\>\> | Optional BridgedDeviceBasicInformationCluster attribute values to | +| `bridgedBasicInformation?` | [`AttributeInitialValues`](../modules/cluster_export.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `hardwareVersion`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](../modules/cluster_export.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](../modules/cluster_export.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<[`VendorId`](../modules/datatype_export.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/cluster_export.md#globalattributes-1)<{}\>\>\> | Optional BridgedDeviceBasicInformationCluster attribute values to | #### Returns @@ -167,7 +167,7 @@ on the device! #### Defined in -packages/matter.js/src/device/Aggregator.ts:44 +[packages/matter.js/src/device/Aggregator.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Aggregator.ts#L44) ___ @@ -185,7 +185,7 @@ The required clusters PowerSourceConfigurationCluster and PowerSourceCluster nee | Name | Type | Description | | :------ | :------ | :------ | | `device` | [`Device`](device_export.Device.md) \| [`ComposedDevice`](device_export.ComposedDevice.md) | Device instance to add | -| `bridgedBasicInformation?` | [`AttributeInitialValues`](../modules/cluster_export.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `hardwareVersion`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](../modules/cluster_export.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](../modules/cluster_export.md#optionalattribute)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](../modules/cluster_export.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<[`VendorId`](../modules/datatype_export.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/cluster_export.md#globalattributes-1)<{}\>\>\> | Optional BridgedDeviceBasicInformationCluster attribute values to | +| `bridgedBasicInformation?` | [`AttributeInitialValues`](../modules/cluster_export.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `hardwareVersion`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](../modules/cluster_export.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](../modules/cluster_export.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<[`VendorId`](../modules/datatype_export.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/cluster_export.md#globalattributes-1)<{}\>\>\> | Optional BridgedDeviceBasicInformationCluster attribute values to | #### Returns @@ -193,7 +193,7 @@ The required clusters PowerSourceConfigurationCluster and PowerSourceCluster nee #### Defined in -packages/matter.js/src/device/Aggregator.ts:87 +[packages/matter.js/src/device/Aggregator.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Aggregator.ts#L87) ___ @@ -217,7 +217,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -281,7 +281,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -349,7 +349,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -367,7 +367,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -385,7 +385,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -403,7 +403,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -421,7 +421,7 @@ Array of bridged devices #### Defined in -packages/matter.js/src/device/Aggregator.ts:114 +[packages/matter.js/src/device/Aggregator.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Aggregator.ts#L114) ___ @@ -445,7 +445,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -463,7 +463,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -497,7 +497,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:198 +[packages/matter.js/src/device/Endpoint.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L198) ___ @@ -521,7 +521,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -555,7 +555,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:183 +[packages/matter.js/src/device/Endpoint.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L183) ___ @@ -579,7 +579,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -597,7 +597,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -615,7 +615,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -649,7 +649,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -683,7 +683,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -703,7 +703,7 @@ ___ #### Defined in -packages/matter.js/src/device/Aggregator.ts:118 +[packages/matter.js/src/device/Aggregator.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Aggregator.ts#L118) ___ @@ -727,7 +727,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -745,7 +745,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) ___ @@ -769,7 +769,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -793,7 +793,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -811,7 +811,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -829,4 +829,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.ComposedDevice.md b/docs/matter.js/classes/device_export.ComposedDevice.md index 9b7205b249..5630232bc9 100644 --- a/docs/matter.js/classes/device_export.ComposedDevice.md +++ b/docs/matter.js/classes/device_export.ComposedDevice.md @@ -51,6 +51,7 @@ A ComposedDevice is a special endpoint that allows to combine multiple sub devic - [hasClusterServer](device_export.ComposedDevice.md#hasclusterserver) - [removeChildEndpoint](device_export.ComposedDevice.md#removechildendpoint) - [removeFromStructure](device_export.ComposedDevice.md#removefromstructure) +- [setBridgedDeviceReachability](device_export.ComposedDevice.md#setbridgeddevicereachability) - [setDeviceTypes](device_export.ComposedDevice.md#setdevicetypes) - [setStructureChangedCallback](device_export.ComposedDevice.md#setstructurechangedcallback) - [updatePartsList](device_export.ComposedDevice.md#updatepartslist) @@ -78,7 +79,7 @@ Creates a new ComposedDevice. #### Defined in -packages/matter.js/src/device/ComposedDevice.ts:22 +[packages/matter.js/src/device/ComposedDevice.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/ComposedDevice.ts#L24) ## Properties @@ -94,7 +95,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -108,7 +109,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -122,7 +123,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -136,7 +137,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -160,7 +161,7 @@ packages/matter.js/src/device/Endpoint.ts:38 #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -193,7 +194,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -224,7 +225,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -246,7 +247,7 @@ Add a sub-device to the composed device. #### Defined in -packages/matter.js/src/device/ComposedDevice.ts:31 +[packages/matter.js/src/device/ComposedDevice.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/ComposedDevice.ts#L33) ___ @@ -271,7 +272,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -296,7 +297,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -314,7 +315,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -332,7 +333,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -350,7 +351,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -368,7 +369,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -392,7 +393,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -410,7 +411,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -444,7 +445,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:198 +[packages/matter.js/src/device/Endpoint.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L198) ___ @@ -468,7 +469,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -502,7 +503,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:183 +[packages/matter.js/src/device/Endpoint.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L183) ___ @@ -526,7 +527,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -544,7 +545,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -562,7 +563,7 @@ Array with all sub-devices #### Defined in -packages/matter.js/src/device/ComposedDevice.ts:40 +[packages/matter.js/src/device/ComposedDevice.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/ComposedDevice.ts#L42) ___ @@ -580,7 +581,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -614,7 +615,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -648,7 +649,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -672,7 +673,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -690,7 +691,29 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) + +___ + +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the Composed device exposed via the bridge. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/device/ComposedDevice.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/ComposedDevice.ts#L61) ___ @@ -714,7 +737,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -738,7 +761,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -756,7 +779,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -776,4 +799,4 @@ Verify that the required clusters exists on the device. #### Defined in -packages/matter.js/src/device/ComposedDevice.ts:47 +[packages/matter.js/src/device/ComposedDevice.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/ComposedDevice.ts#L49) diff --git a/docs/matter.js/classes/device_export.Device.md b/docs/matter.js/classes/device_export.Device.md index 6c34849c16..1bdc3b362c 100644 --- a/docs/matter.js/classes/device_export.Device.md +++ b/docs/matter.js/classes/device_export.Device.md @@ -55,6 +55,7 @@ Base class for all devices. This class should be extended by all devices. - [removeChildEndpoint](device_export.Device.md#removechildendpoint) - [removeCommandHandler](device_export.Device.md#removecommandhandler) - [removeFromStructure](device_export.Device.md#removefromstructure) +- [setBridgedDeviceReachability](device_export.Device.md#setbridgeddevicereachability) - [setDeviceTypes](device_export.Device.md#setdevicetypes) - [setStructureChangedCallback](device_export.Device.md#setstructurechangedcallback) - [updatePartsList](device_export.Device.md#updatepartslist) @@ -81,17 +82,17 @@ Create a new Device instance. #### Defined in -packages/matter.js/src/device/Device.ts:134 +[packages/matter.js/src/device/Device.ts:176](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L176) ## Properties ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Defined in -packages/matter.js/src/device/Device.ts:126 +[packages/matter.js/src/device/Device.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L168) ___ @@ -101,7 +102,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:125 +[packages/matter.js/src/device/Device.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L167) ___ @@ -117,7 +118,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -131,7 +132,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -145,7 +146,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -159,7 +160,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -183,7 +184,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/device/Device.ts:183 +[packages/matter.js/src/device/Device.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L225) ___ @@ -207,7 +208,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -240,7 +241,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -271,7 +272,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -287,7 +288,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -295,7 +296,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:160 +[packages/matter.js/src/device/Device.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L202) ___ @@ -320,7 +321,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -345,7 +346,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -375,7 +376,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:198 +[packages/matter.js/src/device/Device.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L240) ___ @@ -405,7 +406,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:187 +[packages/matter.js/src/device/Device.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L229) ___ @@ -423,7 +424,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -441,7 +442,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -459,7 +460,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -477,7 +478,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -501,7 +502,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -519,7 +520,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -553,7 +554,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:229 +[packages/matter.js/src/device/Device.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L271) ___ @@ -577,7 +578,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -611,7 +612,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:209 +[packages/matter.js/src/device/Device.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L251) ___ @@ -635,7 +636,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -653,7 +654,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -671,7 +672,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -705,7 +706,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -739,7 +740,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -763,7 +764,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -779,7 +780,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -787,7 +788,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:171 +[packages/matter.js/src/device/Device.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L213) ___ @@ -805,7 +806,30 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) + +___ + +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/device/Device.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L296) ___ @@ -829,7 +853,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -853,7 +877,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -871,7 +895,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -889,4 +913,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.DimmableLightDevice.md b/docs/matter.js/classes/device_export.DimmableLightDevice.md index 527a5b1c2a..dcb5d13751 100644 --- a/docs/matter.js/classes/device_export.DimmableLightDevice.md +++ b/docs/matter.js/classes/device_export.DimmableLightDevice.md @@ -58,6 +58,7 @@ - [removeChildEndpoint](device_export.DimmableLightDevice.md#removechildendpoint) - [removeCommandHandler](device_export.DimmableLightDevice.md#removecommandhandler) - [removeFromStructure](device_export.DimmableLightDevice.md#removefromstructure) +- [setBridgedDeviceReachability](device_export.DimmableLightDevice.md#setbridgeddevicereachability) - [setCurrentLevel](device_export.DimmableLightDevice.md#setcurrentlevel) - [setDeviceTypes](device_export.DimmableLightDevice.md#setdevicetypes) - [setOnOff](device_export.DimmableLightDevice.md#setonoff) @@ -86,13 +87,13 @@ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:94 +[packages/matter.js/src/device/DimmableDevices.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L94) ## Properties ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -100,7 +101,7 @@ packages/matter.js/src/device/DimmableDevices.ts:94 #### Defined in -packages/matter.js/src/device/Device.ts:126 +[packages/matter.js/src/device/Device.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L168) ___ @@ -114,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:125 +[packages/matter.js/src/device/Device.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L167) ___ @@ -130,7 +131,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -144,7 +145,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -158,7 +159,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -172,7 +173,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -200,7 +201,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/device/Device.ts:183 +[packages/matter.js/src/device/Device.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L225) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -230,7 +231,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -260,7 +261,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ___ @@ -284,7 +285,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -317,7 +318,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -348,7 +349,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -364,7 +365,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -376,7 +377,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:160 +[packages/matter.js/src/device/Device.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L202) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -406,7 +407,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -436,7 +437,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ___ @@ -462,7 +463,7 @@ Adds a listener for the CurrentLevel attribute #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:71 +[packages/matter.js/src/device/DimmableDevices.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L71) ___ @@ -487,7 +488,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:29 +[packages/matter.js/src/device/DimmableDevices.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L29) ___ @@ -512,7 +513,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -539,7 +540,7 @@ This is an example of a convenient device class API to control the device withou #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:136 +[packages/matter.js/src/device/OnOffDevices.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L136) ___ @@ -564,7 +565,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -598,7 +599,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:198 +[packages/matter.js/src/device/Device.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L240) ___ @@ -632,7 +633,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:187 +[packages/matter.js/src/device/Device.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L229) ___ @@ -650,7 +651,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -668,7 +669,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -686,7 +687,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -704,7 +705,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -728,7 +729,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -746,7 +747,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -780,7 +781,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:229 +[packages/matter.js/src/device/Device.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L271) ___ @@ -804,7 +805,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -838,7 +839,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:209 +[packages/matter.js/src/device/Device.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L251) ___ @@ -862,7 +863,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -880,7 +881,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:58 +[packages/matter.js/src/device/DimmableDevices.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L58) ___ @@ -898,7 +899,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -916,7 +917,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -934,7 +935,7 @@ ___ #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:116 +[packages/matter.js/src/device/OnOffDevices.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L116) ___ @@ -968,7 +969,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -1002,7 +1003,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -1026,7 +1027,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -1042,7 +1043,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -1054,7 +1055,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:171 +[packages/matter.js/src/device/Device.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L213) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -1084,7 +1085,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -1114,7 +1115,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ___ @@ -1132,7 +1133,34 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) + +___ + +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +[DimmableBaseDevice](export._internal_.DimmableBaseDevice.md).[setBridgedDeviceReachability](export._internal_.DimmableBaseDevice.md#setbridgeddevicereachability) + +#### Defined in + +[packages/matter.js/src/device/Device.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L296) ___ @@ -1156,7 +1184,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:62 +[packages/matter.js/src/device/DimmableDevices.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L62) ___ @@ -1180,7 +1208,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -1207,7 +1235,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:112 +[packages/matter.js/src/device/OnOffDevices.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L112) ___ @@ -1231,7 +1259,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -1252,7 +1280,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:124 +[packages/matter.js/src/device/OnOffDevices.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L124) ___ @@ -1270,7 +1298,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -1288,4 +1316,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.DimmablePluginUnitDevice.md b/docs/matter.js/classes/device_export.DimmablePluginUnitDevice.md index b70710a1b9..fbfb7b7a3d 100644 --- a/docs/matter.js/classes/device_export.DimmablePluginUnitDevice.md +++ b/docs/matter.js/classes/device_export.DimmablePluginUnitDevice.md @@ -58,6 +58,7 @@ - [removeChildEndpoint](device_export.DimmablePluginUnitDevice.md#removechildendpoint) - [removeCommandHandler](device_export.DimmablePluginUnitDevice.md#removecommandhandler) - [removeFromStructure](device_export.DimmablePluginUnitDevice.md#removefromstructure) +- [setBridgedDeviceReachability](device_export.DimmablePluginUnitDevice.md#setbridgeddevicereachability) - [setCurrentLevel](device_export.DimmablePluginUnitDevice.md#setcurrentlevel) - [setDeviceTypes](device_export.DimmablePluginUnitDevice.md#setdevicetypes) - [setOnOff](device_export.DimmablePluginUnitDevice.md#setonoff) @@ -86,13 +87,13 @@ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:77 +[packages/matter.js/src/device/DimmableDevices.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L77) ## Properties ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -100,7 +101,7 @@ packages/matter.js/src/device/DimmableDevices.ts:77 #### Defined in -packages/matter.js/src/device/Device.ts:126 +[packages/matter.js/src/device/Device.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L168) ___ @@ -114,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:125 +[packages/matter.js/src/device/Device.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L167) ___ @@ -130,7 +131,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -144,7 +145,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -158,7 +159,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -172,7 +173,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -200,7 +201,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/device/Device.ts:183 +[packages/matter.js/src/device/Device.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L225) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -230,7 +231,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -260,7 +261,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ___ @@ -284,7 +285,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -317,7 +318,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -348,7 +349,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -364,7 +365,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -376,7 +377,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:160 +[packages/matter.js/src/device/Device.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L202) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -406,7 +407,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -436,7 +437,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ___ @@ -462,7 +463,7 @@ Adds a listener for the CurrentLevel attribute #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:71 +[packages/matter.js/src/device/DimmableDevices.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L71) ___ @@ -487,7 +488,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:29 +[packages/matter.js/src/device/DimmableDevices.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L29) ___ @@ -512,7 +513,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -539,7 +540,7 @@ This is an example of a convenient device class API to control the device withou #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:136 +[packages/matter.js/src/device/OnOffDevices.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L136) ___ @@ -564,7 +565,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -598,7 +599,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:198 +[packages/matter.js/src/device/Device.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L240) ___ @@ -632,7 +633,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:187 +[packages/matter.js/src/device/Device.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L229) ___ @@ -650,7 +651,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -668,7 +669,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -686,7 +687,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -704,7 +705,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -728,7 +729,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -746,7 +747,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -780,7 +781,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:229 +[packages/matter.js/src/device/Device.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L271) ___ @@ -804,7 +805,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -838,7 +839,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:209 +[packages/matter.js/src/device/Device.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L251) ___ @@ -862,7 +863,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -880,7 +881,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:58 +[packages/matter.js/src/device/DimmableDevices.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L58) ___ @@ -898,7 +899,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -916,7 +917,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -934,7 +935,7 @@ ___ #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:116 +[packages/matter.js/src/device/OnOffDevices.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L116) ___ @@ -968,7 +969,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -1002,7 +1003,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -1026,7 +1027,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -1042,7 +1043,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -1054,7 +1055,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:171 +[packages/matter.js/src/device/Device.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L213) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -1084,7 +1085,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -1114,7 +1115,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ___ @@ -1132,7 +1133,34 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) + +___ + +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +[DimmableBaseDevice](export._internal_.DimmableBaseDevice.md).[setBridgedDeviceReachability](export._internal_.DimmableBaseDevice.md#setbridgeddevicereachability) + +#### Defined in + +[packages/matter.js/src/device/Device.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L296) ___ @@ -1156,7 +1184,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:62 +[packages/matter.js/src/device/DimmableDevices.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L62) ___ @@ -1180,7 +1208,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -1207,7 +1235,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:112 +[packages/matter.js/src/device/OnOffDevices.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L112) ___ @@ -1231,7 +1259,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -1252,7 +1280,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:124 +[packages/matter.js/src/device/OnOffDevices.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L124) ___ @@ -1270,7 +1298,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -1288,4 +1316,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.Endpoint.md b/docs/matter.js/classes/device_export.Endpoint.md index a881ae8171..97fefaf8be 100644 --- a/docs/matter.js/classes/device_export.Endpoint.md +++ b/docs/matter.js/classes/device_export.Endpoint.md @@ -81,7 +81,7 @@ Create a new Endpoint instance. #### Defined in -packages/matter.js/src/device/Endpoint.ts:52 +[packages/matter.js/src/device/Endpoint.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L52) ## Properties @@ -91,7 +91,7 @@ packages/matter.js/src/device/Endpoint.ts:52 #### Defined in -packages/matter.js/src/device/Endpoint.ts:36 +[packages/matter.js/src/device/Endpoint.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L36) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:35 +[packages/matter.js/src/device/Endpoint.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L35) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:34 +[packages/matter.js/src/device/Endpoint.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L34) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:44 +[packages/matter.js/src/device/Endpoint.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L44) ___ @@ -133,7 +133,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:40 +[packages/matter.js/src/device/Endpoint.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L40) ___ @@ -181,7 +181,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -201,7 +201,7 @@ packages/matter.js/src/device/Endpoint.ts:38 #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -257,7 +257,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -278,7 +278,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -299,7 +299,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -313,7 +313,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -327,7 +327,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -341,7 +341,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -355,7 +355,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -375,7 +375,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -389,7 +389,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -419,7 +419,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:198 +[packages/matter.js/src/device/Endpoint.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L198) ___ @@ -439,7 +439,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -469,7 +469,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:183 +[packages/matter.js/src/device/Endpoint.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L183) ___ @@ -489,7 +489,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -503,7 +503,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -517,7 +517,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -547,7 +547,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -577,7 +577,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -597,7 +597,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -611,7 +611,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) ___ @@ -631,7 +631,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -651,7 +651,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -665,7 +665,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -679,4 +679,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.OnOffBaseDevice.md b/docs/matter.js/classes/device_export.OnOffBaseDevice.md index d899e2a65a..d45b341c5c 100644 --- a/docs/matter.js/classes/device_export.OnOffBaseDevice.md +++ b/docs/matter.js/classes/device_export.OnOffBaseDevice.md @@ -62,6 +62,7 @@ Abstract Base class for OnOff devices - [removeChildEndpoint](device_export.OnOffBaseDevice.md#removechildendpoint) - [removeCommandHandler](device_export.OnOffBaseDevice.md#removecommandhandler) - [removeFromStructure](device_export.OnOffBaseDevice.md#removefromstructure) +- [setBridgedDeviceReachability](device_export.OnOffBaseDevice.md#setbridgeddevicereachability) - [setDeviceTypes](device_export.OnOffBaseDevice.md#setdevicetypes) - [setOnOff](device_export.OnOffBaseDevice.md#setonoff) - [setStructureChangedCallback](device_export.OnOffBaseDevice.md#setstructurechangedcallback) @@ -91,13 +92,13 @@ extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands\>(Device #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:62 +[packages/matter.js/src/device/OnOffDevices.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L62) ## Properties ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -105,7 +106,7 @@ extendPublicHandlerMethods(Device).comm #### Defined in -packages/matter.js/src/device/Device.ts:126 +[packages/matter.js/src/device/Device.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L168) ___ @@ -119,7 +120,7 @@ extendPublicHandlerMethods(Device).devi #### Defined in -packages/matter.js/src/device/Device.ts:125 +[packages/matter.js/src/device/Device.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L167) ___ @@ -135,7 +136,7 @@ extendPublicHandlerMethods(Device).devi #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -149,7 +150,7 @@ extendPublicHandlerMethods(Device).id #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -163,7 +164,7 @@ extendPublicHandlerMethods(Device).name #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -177,7 +178,7 @@ extendPublicHandlerMethods(Device).uniq #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -205,7 +206,7 @@ extendPublicHandlerMethods(Device).\_ex #### Defined in -packages/matter.js/src/device/Device.ts:183 +[packages/matter.js/src/device/Device.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L225) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -235,7 +236,7 @@ extendPublicHandlerMethods(Device).\_ex #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ___ @@ -259,7 +260,7 @@ extendPublicHandlerMethods(Device).addC #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -292,7 +293,7 @@ extendPublicHandlerMethods(Device).addC #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -323,7 +324,7 @@ extendPublicHandlerMethods(Device).addC #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -339,7 +340,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -351,7 +352,7 @@ extendPublicHandlerMethods(Device).addC #### Defined in -packages/matter.js/src/device/Device.ts:160 +[packages/matter.js/src/device/Device.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L202) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -381,7 +382,7 @@ extendPublicHandlerMethods(Device).addC #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ___ @@ -404,7 +405,7 @@ Adds mandatory clusters to the device #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:78 +[packages/matter.js/src/device/OnOffDevices.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L78) ___ @@ -429,7 +430,7 @@ extendPublicHandlerMethods(Device).addF #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -452,7 +453,7 @@ This is an example of a convenient device class API to control the device withou #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:136 +[packages/matter.js/src/device/OnOffDevices.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L136) ___ @@ -477,7 +478,7 @@ extendPublicHandlerMethods(Device).addU #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -511,7 +512,7 @@ extendPublicHandlerMethods(Device).crea #### Defined in -packages/matter.js/src/device/Device.ts:198 +[packages/matter.js/src/device/Device.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L240) ___ @@ -545,7 +546,7 @@ extendPublicHandlerMethods(Device).crea #### Defined in -packages/matter.js/src/device/Device.ts:187 +[packages/matter.js/src/device/Device.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L229) ___ @@ -563,7 +564,7 @@ extendPublicHandlerMethods(Device).dest #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -581,7 +582,7 @@ extendPublicHandlerMethods(Device).dete #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -599,7 +600,7 @@ extendPublicHandlerMethods(Device).getA #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -617,7 +618,7 @@ extendPublicHandlerMethods(Device).getA #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -641,7 +642,7 @@ extendPublicHandlerMethods(Device).getC #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -659,7 +660,7 @@ extendPublicHandlerMethods(Device).getC #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -693,7 +694,7 @@ extendPublicHandlerMethods(Device).getC #### Defined in -packages/matter.js/src/device/Device.ts:229 +[packages/matter.js/src/device/Device.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L271) ___ @@ -717,7 +718,7 @@ extendPublicHandlerMethods(Device).getC #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -751,7 +752,7 @@ extendPublicHandlerMethods(Device).getC #### Defined in -packages/matter.js/src/device/Device.ts:209 +[packages/matter.js/src/device/Device.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L251) ___ @@ -775,7 +776,7 @@ extendPublicHandlerMethods(Device).getC #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -793,7 +794,7 @@ extendPublicHandlerMethods(Device).getD #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -811,7 +812,7 @@ extendPublicHandlerMethods(Device).getI #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -825,7 +826,7 @@ ___ #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:116 +[packages/matter.js/src/device/OnOffDevices.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L116) ___ @@ -859,7 +860,7 @@ extendPublicHandlerMethods(Device).hasC #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -893,7 +894,7 @@ extendPublicHandlerMethods(Device).hasC #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -917,7 +918,7 @@ extendPublicHandlerMethods(Device).remo #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -933,7 +934,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -945,7 +946,7 @@ extendPublicHandlerMethods(Device).remo #### Defined in -packages/matter.js/src/device/Device.ts:171 +[packages/matter.js/src/device/Device.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L213) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -975,7 +976,7 @@ extendPublicHandlerMethods(Device).remo #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ___ @@ -993,7 +994,34 @@ extendPublicHandlerMethods(Device).remo #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) + +___ + +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +extendPublicHandlerMethods(Device).setBridgedDeviceReachability + +#### Defined in + +[packages/matter.js/src/device/Device.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L296) ___ @@ -1017,7 +1045,7 @@ extendPublicHandlerMethods(Device).setD #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -1040,7 +1068,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:112 +[packages/matter.js/src/device/OnOffDevices.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L112) ___ @@ -1064,7 +1092,7 @@ extendPublicHandlerMethods(Device).setS #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -1081,7 +1109,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:124 +[packages/matter.js/src/device/OnOffDevices.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L124) ___ @@ -1099,7 +1127,7 @@ extendPublicHandlerMethods(Device).upda #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -1117,4 +1145,4 @@ extendPublicHandlerMethods(Device).veri #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.OnOffLightDevice.md b/docs/matter.js/classes/device_export.OnOffLightDevice.md index 6da71753e2..731166d91c 100644 --- a/docs/matter.js/classes/device_export.OnOffLightDevice.md +++ b/docs/matter.js/classes/device_export.OnOffLightDevice.md @@ -58,6 +58,7 @@ Device class for an OnOffPluginUnit Device - [removeChildEndpoint](device_export.OnOffLightDevice.md#removechildendpoint) - [removeCommandHandler](device_export.OnOffLightDevice.md#removecommandhandler) - [removeFromStructure](device_export.OnOffLightDevice.md#removefromstructure) +- [setBridgedDeviceReachability](device_export.OnOffLightDevice.md#setbridgeddevicereachability) - [setDeviceTypes](device_export.OnOffLightDevice.md#setdevicetypes) - [setOnOff](device_export.OnOffLightDevice.md#setonoff) - [setStructureChangedCallback](device_export.OnOffLightDevice.md#setstructurechangedcallback) @@ -84,13 +85,13 @@ Device class for an OnOffPluginUnit Device #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:161 +[packages/matter.js/src/device/OnOffDevices.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L161) ## Properties ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -98,7 +99,7 @@ packages/matter.js/src/device/OnOffDevices.ts:161 #### Defined in -packages/matter.js/src/device/Device.ts:126 +[packages/matter.js/src/device/Device.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L168) ___ @@ -112,7 +113,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:125 +[packages/matter.js/src/device/Device.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L167) ___ @@ -128,7 +129,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -142,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -156,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -170,7 +171,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -198,7 +199,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/device/Device.ts:183 +[packages/matter.js/src/device/Device.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L225) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -228,7 +229,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ___ @@ -252,7 +253,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -285,7 +286,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -316,7 +317,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -332,7 +333,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -344,7 +345,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:160 +[packages/matter.js/src/device/Device.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L202) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -374,7 +375,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ___ @@ -401,7 +402,7 @@ Adds mandatory clusters to the device #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:172 +[packages/matter.js/src/device/OnOffDevices.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L172) ___ @@ -426,7 +427,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -453,7 +454,7 @@ This is an example of a convenient device class API to control the device withou #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:136 +[packages/matter.js/src/device/OnOffDevices.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L136) ___ @@ -478,7 +479,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -512,7 +513,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:198 +[packages/matter.js/src/device/Device.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L240) ___ @@ -546,7 +547,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:187 +[packages/matter.js/src/device/Device.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L229) ___ @@ -564,7 +565,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -582,7 +583,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -600,7 +601,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -618,7 +619,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -642,7 +643,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -660,7 +661,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -694,7 +695,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:229 +[packages/matter.js/src/device/Device.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L271) ___ @@ -718,7 +719,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -752,7 +753,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:209 +[packages/matter.js/src/device/Device.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L251) ___ @@ -776,7 +777,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -794,7 +795,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -812,7 +813,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -830,7 +831,7 @@ ___ #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:116 +[packages/matter.js/src/device/OnOffDevices.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L116) ___ @@ -864,7 +865,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -898,7 +899,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -922,7 +923,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -938,7 +939,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -950,7 +951,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:171 +[packages/matter.js/src/device/Device.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L213) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -980,7 +981,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ___ @@ -998,7 +999,34 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) + +___ + +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +[OnOffBaseDevice](device_export.OnOffBaseDevice.md).[setBridgedDeviceReachability](device_export.OnOffBaseDevice.md#setbridgeddevicereachability) + +#### Defined in + +[packages/matter.js/src/device/Device.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L296) ___ @@ -1022,7 +1050,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -1049,7 +1077,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:112 +[packages/matter.js/src/device/OnOffDevices.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L112) ___ @@ -1073,7 +1101,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -1094,7 +1122,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:124 +[packages/matter.js/src/device/OnOffDevices.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L124) ___ @@ -1112,7 +1140,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -1130,4 +1158,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.OnOffPluginUnitDevice.md b/docs/matter.js/classes/device_export.OnOffPluginUnitDevice.md index 7439872e90..d99f79f7b6 100644 --- a/docs/matter.js/classes/device_export.OnOffPluginUnitDevice.md +++ b/docs/matter.js/classes/device_export.OnOffPluginUnitDevice.md @@ -58,6 +58,7 @@ Device class for an OnOffPluginUnit Device - [removeChildEndpoint](device_export.OnOffPluginUnitDevice.md#removechildendpoint) - [removeCommandHandler](device_export.OnOffPluginUnitDevice.md#removecommandhandler) - [removeFromStructure](device_export.OnOffPluginUnitDevice.md#removefromstructure) +- [setBridgedDeviceReachability](device_export.OnOffPluginUnitDevice.md#setbridgeddevicereachability) - [setDeviceTypes](device_export.OnOffPluginUnitDevice.md#setdevicetypes) - [setOnOff](device_export.OnOffPluginUnitDevice.md#setonoff) - [setStructureChangedCallback](device_export.OnOffPluginUnitDevice.md#setstructurechangedcallback) @@ -84,13 +85,13 @@ Device class for an OnOffPluginUnit Device #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:145 +[packages/matter.js/src/device/OnOffDevices.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L145) ## Properties ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -98,7 +99,7 @@ packages/matter.js/src/device/OnOffDevices.ts:145 #### Defined in -packages/matter.js/src/device/Device.ts:126 +[packages/matter.js/src/device/Device.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L168) ___ @@ -112,7 +113,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:125 +[packages/matter.js/src/device/Device.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L167) ___ @@ -128,7 +129,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -142,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -156,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -170,7 +171,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -198,7 +199,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/device/Device.ts:183 +[packages/matter.js/src/device/Device.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L225) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -228,7 +229,7 @@ because needed public for derived classes. #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ___ @@ -252,7 +253,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -285,7 +286,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -316,7 +317,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -332,7 +333,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -344,7 +345,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:160 +[packages/matter.js/src/device/Device.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L202) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -374,7 +375,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ___ @@ -401,7 +402,7 @@ Adds mandatory clusters to the device #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:78 +[packages/matter.js/src/device/OnOffDevices.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L78) ___ @@ -426,7 +427,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -453,7 +454,7 @@ This is an example of a convenient device class API to control the device withou #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:136 +[packages/matter.js/src/device/OnOffDevices.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L136) ___ @@ -478,7 +479,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -512,7 +513,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:198 +[packages/matter.js/src/device/Device.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L240) ___ @@ -546,7 +547,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:187 +[packages/matter.js/src/device/Device.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L229) ___ @@ -564,7 +565,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -582,7 +583,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -600,7 +601,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -618,7 +619,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -642,7 +643,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -660,7 +661,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -694,7 +695,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:229 +[packages/matter.js/src/device/Device.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L271) ___ @@ -718,7 +719,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -752,7 +753,7 @@ ___ #### Defined in -packages/matter.js/src/device/Device.ts:209 +[packages/matter.js/src/device/Device.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L251) ___ @@ -776,7 +777,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -794,7 +795,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -812,7 +813,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -830,7 +831,7 @@ ___ #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:116 +[packages/matter.js/src/device/OnOffDevices.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L116) ___ @@ -864,7 +865,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -898,7 +899,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -922,7 +923,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -938,7 +939,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -950,7 +951,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/device/Device.ts:171 +[packages/matter.js/src/device/Device.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L213) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -980,7 +981,7 @@ The base class do not expose any commands! #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ___ @@ -998,7 +999,34 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) + +___ + +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +[OnOffBaseDevice](device_export.OnOffBaseDevice.md).[setBridgedDeviceReachability](device_export.OnOffBaseDevice.md#setbridgeddevicereachability) + +#### Defined in + +[packages/matter.js/src/device/Device.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L296) ___ @@ -1022,7 +1050,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -1049,7 +1077,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:112 +[packages/matter.js/src/device/OnOffDevices.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L112) ___ @@ -1073,7 +1101,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -1094,7 +1122,7 @@ This is an example f a convenient device class API to control the device without #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:124 +[packages/matter.js/src/device/OnOffDevices.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L124) ___ @@ -1112,7 +1140,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -1130,4 +1158,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.PairedDevice.md b/docs/matter.js/classes/device_export.PairedDevice.md index ed5c21517e..3ba43ed3a9 100644 --- a/docs/matter.js/classes/device_export.PairedDevice.md +++ b/docs/matter.js/classes/device_export.PairedDevice.md @@ -77,7 +77,7 @@ Create a new PairedDevice instance. All data are automatically parsed from the p #### Defined in -packages/matter.js/src/device/Device.ts:60 +[packages/matter.js/src/device/Device.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L61) ## Properties @@ -87,7 +87,7 @@ packages/matter.js/src/device/Device.ts:60 #### Defined in -packages/matter.js/src/device/Device.ts:52 +[packages/matter.js/src/device/Device.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L53) ___ @@ -103,7 +103,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -131,7 +131,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -145,7 +145,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -169,7 +169,7 @@ packages/matter.js/src/device/Endpoint.ts:38 #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -208,7 +208,7 @@ PairedDevice does not support adding additional clusters #### Defined in -packages/matter.js/src/device/Device.ts:92 +[packages/matter.js/src/device/Device.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L93) ___ @@ -245,7 +245,7 @@ PairedDevice does not support adding additional clusters #### Defined in -packages/matter.js/src/device/Device.ts:81 +[packages/matter.js/src/device/Device.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L82) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -295,7 +295,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -313,7 +313,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -349,7 +349,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -367,7 +367,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -391,7 +391,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -409,7 +409,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:198 +[packages/matter.js/src/device/Endpoint.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L198) ___ @@ -467,7 +467,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -501,7 +501,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:183 +[packages/matter.js/src/device/Endpoint.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L183) ___ @@ -525,7 +525,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -543,7 +543,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -561,7 +561,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -595,7 +595,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -629,7 +629,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -653,7 +653,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -671,7 +671,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) ___ @@ -695,7 +695,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -719,7 +719,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -737,7 +737,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -755,4 +755,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/device_export.PairedNode.md b/docs/matter.js/classes/device_export.PairedNode.md new file mode 100644 index 0000000000..0ede38d3ce --- /dev/null +++ b/docs/matter.js/classes/device_export.PairedNode.md @@ -0,0 +1,634 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [device/export](../modules/device_export.md) / PairedNode + +# Class: PairedNode + +[device/export](../modules/device_export.md).PairedNode + +Class to represents one node that is paired/commissioned with the matter.js Controller. Instances are returned by +the CommissioningController on commissioning or when connecting. + +## Table of contents + +### Constructors + +- [constructor](device_export.PairedNode.md#constructor) + +### Properties + +- [commissioningController](device_export.PairedNode.md#commissioningcontroller) +- [connectionState](device_export.PairedNode.md#connectionstate) +- [endpoints](device_export.PairedNode.md#endpoints) +- [interactionClient](device_export.PairedNode.md#interactionclient) +- [nodeId](device_export.PairedNode.md#nodeid) +- [options](device_export.PairedNode.md#options) +- [reconnectDelayTimer](device_export.PairedNode.md#reconnectdelaytimer) +- [reconnectInteractionClient](device_export.PairedNode.md#reconnectinteractionclient) +- [updateEndpointStructureTimer](device_export.PairedNode.md#updateendpointstructuretimer) + +### Accessors + +- [isConnected](device_export.PairedNode.md#isconnected) + +### Methods + +- [close](device_export.PairedNode.md#close) +- [createDevice](device_export.PairedNode.md#createdevice) +- [decommission](device_export.PairedNode.md#decommission) +- [disconnect](device_export.PairedNode.md#disconnect) +- [ensureConnection](device_export.PairedNode.md#ensureconnection) +- [getDeviceById](device_export.PairedNode.md#getdevicebyid) +- [getDevices](device_export.PairedNode.md#getdevices) +- [getInteractionClient](device_export.PairedNode.md#getinteractionclient) +- [getRootClusterClient](device_export.PairedNode.md#getrootclusterclient) +- [getRootClusterServer](device_export.PairedNode.md#getrootclusterserver) +- [handleNodeShutdown](device_export.PairedNode.md#handlenodeshutdown) +- [initialize](device_export.PairedNode.md#initialize) +- [initializeEndpointStructure](device_export.PairedNode.md#initializeendpointstructure) +- [logStructure](device_export.PairedNode.md#logstructure) +- [openBasicCommissioningWindow](device_export.PairedNode.md#openbasiccommissioningwindow) +- [openEnhancedCommissioningWindow](device_export.PairedNode.md#openenhancedcommissioningwindow) +- [reconnect](device_export.PairedNode.md#reconnect) +- [setConnectionState](device_export.PairedNode.md#setconnectionstate) +- [structureEndpoints](device_export.PairedNode.md#structureendpoints) +- [subscribeAllAttributesAndEvents](device_export.PairedNode.md#subscribeallattributesandevents) +- [updateEndpointStructure](device_export.PairedNode.md#updateendpointstructure) +- [create](device_export.PairedNode.md#create) + +## Constructors + +### constructor + +• **new PairedNode**(`nodeId`, `commissioningController`, `options?`, `reconnectInteractionClient`, `assignDisconnectedHandler`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `commissioningController` | [`CommissioningController`](export.CommissioningController.md) | +| `options` | [`CommissioningControllerNodeOptions`](../modules/device_export.md#commissioningcontrollernodeoptions) | +| `reconnectInteractionClient` | () => `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> | +| `assignDisconnectedHandler` | (`handler`: () => `Promise`<`void`\>) => `void` | + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:159](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L159) + +## Properties + +### commissioningController + +• `Private` `Readonly` **commissioningController**: [`CommissioningController`](export.CommissioningController.md) + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L161) + +___ + +### connectionState + +• `Private` **connectionState**: [`NodeStateInformation`](../enums/device_export.NodeStateInformation.md) = `NodeStateInformation.Disconnected` + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L139) + +___ + +### endpoints + +• `Private` `Readonly` **endpoints**: `Map`<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber), [`Endpoint`](device_export.Endpoint.md)\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L129) + +___ + +### interactionClient + +• `Private` `Optional` **interactionClient**: [`InteractionClient`](protocol_interaction_export.InteractionClient.md) + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L130) + +___ + +### nodeId + +• `Readonly` **nodeId**: [`NodeId`](../modules/datatype_export.md#nodeid) + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L160) + +___ + +### options + +• `Private` `Readonly` **options**: [`CommissioningControllerNodeOptions`](../modules/device_export.md#commissioningcontrollernodeoptions) = `{}` + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L162) + +___ + +### reconnectDelayTimer + +• `Private` `Readonly` **reconnectDelayTimer**: [`Timer`](../interfaces/time_export.Timer.md) + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L131) + +___ + +### reconnectInteractionClient + +• `Private` `Readonly` **reconnectInteractionClient**: () => `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> + +#### Type declaration + +▸ (): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> + +##### Returns + +`Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L163) + +___ + +### updateEndpointStructureTimer + +• `Private` `Readonly` **updateEndpointStructureTimer**: [`Timer`](../interfaces/time_export.Timer.md) + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L135) + +## Accessors + +### isConnected + +• `get` **isConnected**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:178](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L178) + +## Methods + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:745](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L745) + +___ + +### createDevice + +▸ `Private` **createDevice**(`endpointId`, `data`, `interactionClient`): [`PairedDevice`](device_export.PairedDevice.md) \| [`RootEndpoint`](device_export.RootEndpoint.md) \| [`ComposedDevice`](device_export.ComposedDevice.md) \| [`Aggregator`](device_export.Aggregator.md) + +Create a device object from the data read from the device. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `endpointId` | [`EndpointNumber`](../modules/datatype_export.md#endpointnumber) | Endpoint ID | +| `data` | `Object` | Data of all clusters read from the device | +| `interactionClient` | [`InteractionClient`](protocol_interaction_export.InteractionClient.md) | InteractionClient to use for the device | + +#### Returns + +[`PairedDevice`](device_export.PairedDevice.md) \| [`RootEndpoint`](device_export.RootEndpoint.md) \| [`ComposedDevice`](device_export.ComposedDevice.md) \| [`Aggregator`](device_export.Aggregator.md) + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:513](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L513) + +___ + +### decommission + +▸ **decommission**(): `Promise`<`void`\> + +De-Commission (unpair) the device from this controller by removing the fabric from the device. + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:622](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L622) + +___ + +### disconnect + +▸ **disconnect**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:740](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L740) + +___ + +### ensureConnection + +▸ `Private` **ensureConnection**(): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> + +Ensure that the node is connected by creating a new InteractionClient if needed. + +#### Returns + +`Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L223) + +___ + +### getDeviceById + +▸ **getDeviceById**(`endpointId`): `undefined` \| [`Endpoint`](device_export.Endpoint.md) + +Returns the device/endpoint with the given endpoint ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `endpointId` | `number` | + +#### Returns + +`undefined` \| [`Endpoint`](device_export.Endpoint.md) + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:617](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L617) + +___ + +### getDevices + +▸ **getDevices**(): [`Endpoint`](device_export.Endpoint.md)[] + +Returns the devices/endpoints known for this node. + +#### Returns + +[`Endpoint`](device_export.Endpoint.md)[] + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:612](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L612) + +___ + +### getInteractionClient + +▸ **getInteractionClient**(): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> + +Request the current InteractionClient for custom special case interactions with the device. Usually the +ClusterClients of the Devices of the node should be used instead. + +#### Returns + +`Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L263) + +___ + +### getRootClusterClient + +▸ **getRootClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> + +Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | +| `SF` | extends [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<`F`\> | +| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | +| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`Cluster`](../modules/cluster_export.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterClient to get or undefined if not existing | + +#### Returns + +`undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:770](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L770) + +___ + +### getRootClusterServer + +▸ **getRootClusterServer**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> + +Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | +| `SF` | extends [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<`F`\> | +| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | +| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`Cluster`](../modules/cluster_export.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterServer to get or undefined if not existing | + +#### Returns + +`undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:755](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L755) + +___ + +### handleNodeShutdown + +▸ `Private` **handleNodeShutdown**(): `Promise`<`void`\> + +Handles a node shutDown event (if supported by the node and received). + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:381](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L381) + +___ + +### initialize + +▸ `Private` **initialize**(): `Promise`<`void`\> + +Initialize the node after the InteractionClient was created and to subscribe attributes and events if requested. + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:232](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L232) + +___ + +### initializeEndpointStructure + +▸ `Private` **initializeEndpointStructure**(`allClusterAttributes`, `updateStructure?`): `Promise`<`void`\> + +Reads all data from the device and create a device object structure out of it. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `allClusterAttributes` | [`DecodedAttributeReportValue`](../modules/protocol_interaction_export.md#decodedattributereportvalue)<`any`\>[] | `undefined` | +| `updateStructure` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:397](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L397) + +___ + +### logStructure + +▸ **logStructure**(`options?`): `void` + +Method to log the structure of this node with all endpoint and clusters. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | [`EndpointLoggingOptions`](../modules/device_export.md#endpointloggingoptions) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L268) + +___ + +### openBasicCommissioningWindow + +▸ **openBasicCommissioningWindow**(`commissioningTimeout?`): `Promise`<`void`\> + +Opens a Basic Commissioning Window (uses the original Passcode printed on the device) with the device. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `commissioningTimeout` | `number` | `900` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:647](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L647) + +___ + +### openEnhancedCommissioningWindow + +▸ **openEnhancedCommissioningWindow**(`commissioningTimeout?`): `Promise`<{ `manualPairingCode`: `string` ; `qrPairingCode`: `string` }\> + +Opens an Enhanced Commissioning Window (uses a generated random Passcode) with the device. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `commissioningTimeout` | `number` | `900` | + +#### Returns + +`Promise`<{ `manualPairingCode`: `string` ; `qrPairingCode`: `string` }\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:675](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L675) + +___ + +### reconnect + +▸ **reconnect**(): `Promise`<`void`\> + +Force a reconnection to the device. This method is mainly used internally to reconnect after the active session +was closed or the device wen offline and was detected as being online again. + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:199](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L199) + +___ + +### setConnectionState + +▸ `Private` **setConnectionState**(`state`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `state` | [`NodeStateInformation`](../enums/device_export.NodeStateInformation.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:182](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L182) + +___ + +### structureEndpoints + +▸ `Private` **structureEndpoints**(`partLists`): `void` + +Bring the endpoints in a structure based on their partsList attribute. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `partLists` | `Map`<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber), [`EndpointNumber`](../modules/datatype_export.md#endpointnumber)[]\> | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:446](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L446) + +___ + +### subscribeAllAttributesAndEvents + +▸ **subscribeAllAttributesAndEvents**(`options?`): `Promise`<{ `attributeReports?`: [`DecodedAttributeReportValue`](../modules/protocol_interaction_export.md#decodedattributereportvalue)<`any`\>[] ; `eventReports?`: [`DecodedEventReportValue`](../modules/protocol_interaction_export.md#decodedeventreportvalue)<`any`\>[] }\> + +Subscribe to all attributes and events of the device. Unless setting the Controller property autoSubscribe to +false this is executed automatically. Alternatively you can manually subscribe by calling this method. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `Object` | +| `options.attributeChangedCallback?` | (`data`: [`DecodedAttributeReportValue`](../modules/protocol_interaction_export.md#decodedattributereportvalue)<`any`\>) => `void` | +| `options.eventTriggeredCallback?` | (`data`: [`DecodedEventReportValue`](../modules/protocol_interaction_export.md#decodedeventreportvalue)<`any`\>) => `void` | +| `options.ignoreInitialTriggers?` | `boolean` | + +#### Returns + +`Promise`<{ `attributeReports?`: [`DecodedAttributeReportValue`](../modules/protocol_interaction_export.md#decodedattributereportvalue)<`any`\>[] ; `eventReports?`: [`DecodedEventReportValue`](../modules/protocol_interaction_export.md#decodedeventreportvalue)<`any`\>[] }\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:281](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L281) + +___ + +### updateEndpointStructure + +▸ **updateEndpointStructure**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:389](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L389) + +___ + +### create + +▸ `Static` **create**(`nodeId`, `commissioningController`, `options?`, `reconnectInteractionClient`, `assignDisconnectedHandler`): `Promise`<[`PairedNode`](device_export.PairedNode.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `commissioningController` | [`CommissioningController`](export.CommissioningController.md) | +| `options` | [`CommissioningControllerNodeOptions`](../modules/device_export.md#commissioningcontrollernodeoptions) | +| `reconnectInteractionClient` | () => `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> | +| `assignDisconnectedHandler` | (`handler`: () => `Promise`<`void`\>) => `void` | + +#### Returns + +`Promise`<[`PairedNode`](device_export.PairedNode.md)\> + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L141) diff --git a/docs/matter.js/classes/device_export.RootEndpoint.md b/docs/matter.js/classes/device_export.RootEndpoint.md index 2808508aff..b62c99f7c9 100644 --- a/docs/matter.js/classes/device_export.RootEndpoint.md +++ b/docs/matter.js/classes/device_export.RootEndpoint.md @@ -32,6 +32,7 @@ Root endpoint of a device. This is used internally and not needed to be instance - [addClusterClient](device_export.RootEndpoint.md#addclusterclient) - [addClusterServer](device_export.RootEndpoint.md#addclusterserver) - [addFixedLabel](device_export.RootEndpoint.md#addfixedlabel) +- [addRootClusterClient](device_export.RootEndpoint.md#addrootclusterclient) - [addUserLabel](device_export.RootEndpoint.md#adduserlabel) - [destroy](device_export.RootEndpoint.md#destroy) - [determineUniqueID](device_export.RootEndpoint.md#determineuniqueid) @@ -45,6 +46,8 @@ Root endpoint of a device. This is used internally and not needed to be instance - [getClusterServerById](device_export.RootEndpoint.md#getclusterserverbyid) - [getDeviceTypes](device_export.RootEndpoint.md#getdevicetypes) - [getId](device_export.RootEndpoint.md#getid) +- [getRootClusterClient](device_export.RootEndpoint.md#getrootclusterclient) +- [getRootClusterServer](device_export.RootEndpoint.md#getrootclusterserver) - [hasClusterClient](device_export.RootEndpoint.md#hasclusterclient) - [hasClusterServer](device_export.RootEndpoint.md#hasclusterserver) - [removeChildEndpoint](device_export.RootEndpoint.md#removechildendpoint) @@ -68,7 +71,7 @@ Create a new RootEndpoint instance. This is automatically instanced by the Commi #### Defined in -packages/matter.js/src/device/Device.ts:111 +[packages/matter.js/src/device/Device.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L112) ## Properties @@ -78,7 +81,7 @@ packages/matter.js/src/device/Device.ts:111 #### Defined in -packages/matter.js/src/device/Device.ts:106 +[packages/matter.js/src/device/Device.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L107) ___ @@ -94,7 +97,7 @@ One or multiple DeviceTypeDefinitions of the endpoint #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -108,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -122,7 +125,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -136,7 +139,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -160,7 +163,7 @@ packages/matter.js/src/device/Endpoint.ts:38 #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -193,7 +196,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -224,7 +227,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -249,7 +252,38 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) + +___ + +### addRootClusterClient + +▸ **addRootClusterClient**<`F`, `A`, `C`, `E`\>(`cluster`): `void` + +Add a cluster client to the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | +| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | +| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> | ClusterClient object to add | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/device/Device.ts:137](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L137) ___ @@ -274,7 +308,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -292,7 +326,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -310,7 +344,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -328,7 +362,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -346,7 +380,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -370,7 +404,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -388,7 +422,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -422,7 +456,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:198 +[packages/matter.js/src/device/Endpoint.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L198) ___ @@ -446,7 +480,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -480,7 +514,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:183 +[packages/matter.js/src/device/Endpoint.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L183) ___ @@ -504,7 +538,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -522,7 +556,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -540,7 +574,71 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) + +___ + +### getRootClusterClient + +▸ **getRootClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> + +Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | +| `SF` | extends [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<`F`\> | +| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | +| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`Cluster`](../modules/cluster_export.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterClient to get or undefined if not existing | + +#### Returns + +`undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> + +#### Defined in + +[packages/matter.js/src/device/Device.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L148) + +___ + +### getRootClusterServer + +▸ **getRootClusterServer**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> + +Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | +| `SF` | extends [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<`F`\> | +| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | +| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | +| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cluster` | [`Cluster`](../modules/cluster_export.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterServer to get or undefined if not existing | + +#### Returns + +`undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> + +#### Defined in + +[packages/matter.js/src/device/Device.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L122) ___ @@ -574,7 +672,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -608,7 +706,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -632,7 +730,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -650,7 +748,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) ___ @@ -674,7 +772,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -698,7 +796,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -716,7 +814,7 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -734,4 +832,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/export.CommissioningController.md b/docs/matter.js/classes/export.CommissioningController.md index 6be945aa80..6ba1dd66c4 100644 --- a/docs/matter.js/classes/export.CommissioningController.md +++ b/docs/matter.js/classes/export.CommissioningController.md @@ -4,7 +4,7 @@ [export](../modules/export.md).CommissioningController -Abstract base class that represents a node in the matter ecosystem. +Controller class to commission and connect multiple nodes into one fabric. ## Hierarchy @@ -20,46 +20,46 @@ Abstract base class that represents a node in the matter ecosystem. ### Properties +- [connectedNodes](export.CommissioningController.md#connectednodes) - [controllerInstance](export.CommissioningController.md#controllerinstance) -- [endpoints](export.CommissioningController.md#endpoints) -- [interactionClient](export.CommissioningController.md#interactionclient) - [ipv4Disabled](export.CommissioningController.md#ipv4disabled) - [listeningAddressIpv4](export.CommissioningController.md#listeningaddressipv4) - [listeningAddressIpv6](export.CommissioningController.md#listeningaddressipv6) - [mdnsScanner](export.CommissioningController.md#mdnsscanner) -- [nodeId](export.CommissioningController.md#nodeid) - [options](export.CommissioningController.md#options) -- [rootEndpoint](export.CommissioningController.md#rootendpoint) -- [serverAddress](export.CommissioningController.md#serveraddress) +- [sessionDisconnectedHandler](export.CommissioningController.md#sessiondisconnectedhandler) +- [started](export.CommissioningController.md#started) - [storage](export.CommissioningController.md#storage) +### Accessors + +- [nodeId](export.CommissioningController.md#nodeid) + ### Methods -- [addEndpoint](export.CommissioningController.md#addendpoint) -- [addRootClusterClient](export.CommissioningController.md#addrootclusterclient) -- [addRootClusterServer](export.CommissioningController.md#addrootclusterserver) +- [assertControllerIsStarted](export.CommissioningController.md#assertcontrollerisstarted) +- [assertIsAddedToMatterServer](export.CommissioningController.md#assertisaddedtomatterserver) - [close](export.CommissioningController.md#close) +- [commissionNode](export.CommissioningController.md#commissionnode) - [connect](export.CommissioningController.md#connect) -- [createDevice](export.CommissioningController.md#createdevice) +- [connectNode](export.CommissioningController.md#connectnode) - [createInteractionClient](export.CommissioningController.md#createinteractionclient) +- [disconnectNode](export.CommissioningController.md#disconnectnode) +- [discoverCommissionableDevices](export.CommissioningController.md#discovercommissionabledevices) - [getActiveSessionInformation](export.CommissioningController.md#getactivesessioninformation) -- [getChildEndpoint](export.CommissioningController.md#getchildendpoint) -- [getDevices](export.CommissioningController.md#getdevices) -- [getFabric](export.CommissioningController.md#getfabric) -- [getInteractionClient](export.CommissioningController.md#getinteractionclient) +- [getCommissionedNodes](export.CommissioningController.md#getcommissionednodes) +- [getConnectedNode](export.CommissioningController.md#getconnectednode) - [getPort](export.CommissioningController.md#getport) -- [getRootClusterClient](export.CommissioningController.md#getrootclusterclient) -- [getRootClusterServer](export.CommissioningController.md#getrootclusterserver) -- [getRootEndpoint](export.CommissioningController.md#getrootendpoint) -- [initializeAfterConnect](export.CommissioningController.md#initializeafterconnect) -- [initializeEndpointStructure](export.CommissioningController.md#initializeendpointstructure) +- [initialize](export.CommissioningController.md#initialize) +- [initializeController](export.CommissioningController.md#initializecontroller) - [isCommissioned](export.CommissioningController.md#iscommissioned) +- [isNodeCommissioned](export.CommissioningController.md#isnodecommissioned) +- [removeNode](export.CommissioningController.md#removenode) +- [resetStorage](export.CommissioningController.md#resetstorage) - [setMdnsBroadcaster](export.CommissioningController.md#setmdnsbroadcaster) - [setMdnsScanner](export.CommissioningController.md#setmdnsscanner) - [setStorage](export.CommissioningController.md#setstorage) - [start](export.CommissioningController.md#start) -- [structureEndpoints](export.CommissioningController.md#structureendpoints) -- [subscribeAllAttributesAndEvents](export.CommissioningController.md#subscribeallattributesandevents) ## Constructors @@ -73,7 +73,7 @@ Creates a new CommissioningController instance | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`CommissioningControllerOptions`](../interfaces/export.CommissioningControllerOptions.md) | The options for the CommissioningController | +| `options` | [`CommissioningControllerOptions`](../modules/export.md#commissioningcontrolleroptions) | The options for the CommissioningController | #### Overrides @@ -81,51 +81,37 @@ Creates a new CommissioningController instance #### Defined in -packages/matter.js/src/CommissioningController.ts:97 +[packages/matter.js/src/CommissioningController.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L134) ## Properties -### controllerInstance +### connectedNodes -• `Private` `Optional` **controllerInstance**: [`MatterController`](export._internal_.MatterController.md) +• `Private` **connectedNodes**: `Map`<[`NodeId`](../modules/datatype_export.md#nodeid), [`PairedNode`](device_export.PairedNode.md)\> #### Defined in -packages/matter.js/src/CommissioningController.ts:86 +[packages/matter.js/src/CommissioningController.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L126) ___ -### endpoints - -• `Private` **endpoints**: `Map`<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber), [`Endpoint`](device_export.Endpoint.md)\> - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:90 - -___ - -### interactionClient +### controllerInstance -• `Private` `Optional` **interactionClient**: [`InteractionClient`](protocol_interaction_export.InteractionClient.md) +• `Private` `Optional` **controllerInstance**: [`MatterController`](export._internal_.MatterController.md) #### Defined in -packages/matter.js/src/CommissioningController.ts:87 +[packages/matter.js/src/CommissioningController.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L125) ___ ### ipv4Disabled -• **ipv4Disabled**: `boolean` = `false` - -#### Inherited from - -[MatterNode](export.MatterNode.md).[ipv4Disabled](export.MatterNode.md#ipv4disabled) +• `Private` `Optional` **ipv4Disabled**: `boolean` #### Defined in -packages/matter.js/src/MatterNode.ts:22 +[packages/matter.js/src/CommissioningController.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L118) ___ @@ -135,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningController.ts:80 +[packages/matter.js/src/CommissioningController.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L119) ___ @@ -145,7 +131,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningController.ts:81 +[packages/matter.js/src/CommissioningController.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L120) ___ @@ -155,53 +141,39 @@ ___ #### Defined in -packages/matter.js/src/CommissioningController.ts:84 - -___ - -### nodeId - -• `Private` `Optional` **nodeId**: [`NodeId`](../modules/datatype_export.md#nodeid) - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:89 +[packages/matter.js/src/CommissioningController.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L123) ___ ### options -• `Private` `Readonly` **options**: [`CommissioningControllerOptions`](../interfaces/export.CommissioningControllerOptions.md) +• `Private` `Readonly` **options**: [`CommissioningControllerOptions`](../modules/export.md#commissioningcontrolleroptions) The options for the CommissioningController #### Defined in -packages/matter.js/src/CommissioningController.ts:97 +[packages/matter.js/src/CommissioningController.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L134) ___ -### rootEndpoint - -• `Protected` `Readonly` **rootEndpoint**: [`RootEndpoint`](device_export.RootEndpoint.md) +### sessionDisconnectedHandler -#### Inherited from - -[MatterNode](export.MatterNode.md).[rootEndpoint](export.MatterNode.md#rootendpoint) +• `Private` **sessionDisconnectedHandler**: `Map`<[`NodeId`](../modules/datatype_export.md#nodeid), () => `Promise`<`void`\>\> #### Defined in -packages/matter.js/src/MatterNode.ts:21 +[packages/matter.js/src/CommissioningController.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L127) ___ -### serverAddress +### started -• `Optional` **serverAddress**: [`ServerAddressIp`](../modules/common_export.md#serveraddressip) +• `Private` **started**: `boolean` = `false` #### Defined in -packages/matter.js/src/CommissioningController.ts:79 +[packages/matter.js/src/CommissioningController.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L117) ___ @@ -211,169 +183,159 @@ ___ #### Defined in -packages/matter.js/src/CommissioningController.ts:83 - -## Methods +[packages/matter.js/src/CommissioningController.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L122) -### addEndpoint +## Accessors -▸ `Protected` **addEndpoint**(`endpoint`): `void` - -Add a child endpoint to the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Parameters +### nodeId -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpoint` | [`Endpoint`](device_export.Endpoint.md) | Endpoint to add | +• `get` **nodeId**(): `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) #### Returns -`void` - -#### Inherited from - -[MatterNode](export.MatterNode.md).[addEndpoint](export.MatterNode.md#addendpoint) +`undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) #### Defined in -packages/matter.js/src/MatterNode.ts:87 - -___ +[packages/matter.js/src/CommissioningController.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L138) -### addRootClusterClient +## Methods -▸ **addRootClusterClient**<`F`, `A`, `C`, `E`\>(`cluster`): `void` +### assertControllerIsStarted -Add a cluster client to the root endpoint. This is mainly used internally and not needed to be called by the user. +▸ **assertControllerIsStarted**(`errorText?`): [`MatterController`](export._internal_.MatterController.md) -#### Type parameters +#### Parameters | Name | Type | | :------ | :------ | -| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | -| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | -| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> | ClusterClient object to add | +| `errorText?` | `string` | #### Returns -`void` - -#### Inherited from - -[MatterNode](export.MatterNode.md).[addRootClusterClient](export.MatterNode.md#addrootclusterclient) +[`MatterController`](export._internal_.MatterController.md) #### Defined in -packages/matter.js/src/MatterNode.ts:53 +[packages/matter.js/src/CommissioningController.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L152) ___ -### addRootClusterServer +### assertIsAddedToMatterServer -▸ **addRootClusterServer**<`A`, `E`\>(`cluster`): `void` +▸ **assertIsAddedToMatterServer**(): `Object` -Add a cluster to the root endpoint. This is mainly used internally and not needed to be called by the user. +#### Returns -#### Type parameters +`Object` | Name | Type | | :------ | :------ | -| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | -| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | +| `mdnsScanner` | [`MdnsScanner`](mdns_export.MdnsScanner.md) | +| `storage` | [`StorageContext`](storage_export.StorageContext.md) | -#### Parameters +#### Defined in -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> | ClusterServer object to add | +[packages/matter.js/src/CommissioningController.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L142) + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +Disconnects all connected nodes and Closes the network connections and other resources of the controller. #### Returns -`void` +`Promise`<`void`\> -#### Inherited from +#### Overrides -[MatterNode](export.MatterNode.md).[addRootClusterServer](export.MatterNode.md#addrootclusterserver) +[MatterNode](export.MatterNode.md).[close](export.MatterNode.md#close) #### Defined in -packages/matter.js/src/MatterNode.ts:29 +[packages/matter.js/src/CommissioningController.ts:352](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L352) ___ -### close +### commissionNode -▸ **close**(): `Promise`<`void`\> +▸ **commissionNode**(`nodeOptions`): `Promise`<[`PairedNode`](device_export.PairedNode.md)\> -close network connections of the device +Commissions/Pairs a new device into the controller fabric. The method returns a PairedNode instance of the +paired node on success. -#### Returns +#### Parameters -`Promise`<`void`\> +| Name | Type | +| :------ | :------ | +| `nodeOptions` | [`NodeCommissioningOptions`](../modules/export.md#nodecommissioningoptions) | -#### Overrides +#### Returns -[MatterNode](export.MatterNode.md).[close](export.MatterNode.md#close) +`Promise`<[`PairedNode`](device_export.PairedNode.md)\> #### Defined in -packages/matter.js/src/CommissioningController.ts:506 +[packages/matter.js/src/CommissioningController.ts:191](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L191) ___ ### connect -▸ **connect**(): `Promise`<`void`\> +▸ **connect**(): `Promise`<[`PairedNode`](device_export.PairedNode.md)[]\> -Connects to the device. This includes pairing with the device if not yet paired. +Connects to all paired nodes. After connection the endpoint data of the device is analyzed and an object structure is created. #### Returns -`Promise`<`void`\> +`Promise`<[`PairedNode`](device_export.PairedNode.md)[]\> #### Defined in -packages/matter.js/src/CommissioningController.ts:106 +[packages/matter.js/src/CommissioningController.ts:281](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L281) ___ -### createDevice +### connectNode -▸ `Private` **createDevice**(`endpointId`, `data`): [`PairedDevice`](device_export.PairedDevice.md) \| [`RootEndpoint`](device_export.RootEndpoint.md) \| [`ComposedDevice`](device_export.ComposedDevice.md) \| [`Aggregator`](device_export.Aggregator.md) +▸ **connectNode**(`nodeId`, `connectOptions?`): `Promise`<[`PairedNode`](device_export.PairedNode.md)\> -Create a device object from the data read from the device. +Connect to an already paired Node. +After connection the endpoint data of the device is analyzed and an object structure is created. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpointId` | [`EndpointNumber`](../modules/datatype_export.md#endpointnumber) | Endpoint ID | -| `data` | `Object` | Data of all clusters read from the device | +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `connectOptions?` | [`CommissioningControllerNodeOptions`](../modules/device_export.md#commissioningcontrollernodeoptions) | #### Returns -[`PairedDevice`](device_export.PairedDevice.md) \| [`RootEndpoint`](device_export.RootEndpoint.md) \| [`ComposedDevice`](device_export.ComposedDevice.md) \| [`Aggregator`](device_export.Aggregator.md) +`Promise`<[`PairedNode`](device_export.PairedNode.md)\> #### Defined in -packages/matter.js/src/CommissioningController.ts:393 +[packages/matter.js/src/CommissioningController.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L251) ___ ### createInteractionClient -▸ `Private` **createInteractionClient**(): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> +▸ **createInteractionClient**(`nodeId`): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> -Creates and Return a new InteractionClient to communicate with the device. +Creates and Return a new InteractionClient to communicate with a node. This is mainly used internally and should +not be used directly. See the PairedNode class for the public API. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns @@ -381,103 +343,114 @@ Creates and Return a new InteractionClient to communicate with the device. #### Defined in -packages/matter.js/src/CommissioningController.ts:296 +[packages/matter.js/src/CommissioningController.ts:334](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L334) ___ -### getActiveSessionInformation +### disconnectNode -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +▸ **disconnectNode**(`nodeId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +`Promise`<`void`\> #### Defined in -packages/matter.js/src/CommissioningController.ts:522 +[packages/matter.js/src/CommissioningController.ts:239](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L239) ___ -### getChildEndpoint - -▸ `Protected` **getChildEndpoint**(`endpointId`): `undefined` \| [`Endpoint`](device_export.Endpoint.md) +### discoverCommissionableDevices -Get a child endpoint from the root endpoint. This is mainly used internally and not needed to be called by the user. +▸ **discoverCommissionableDevices**(`identifierData`, `discoveryCapabilities?`, `discoveredCallback?`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> #### Parameters -| Name | Type | Description | +| Name | Type | Default value | | :------ | :------ | :------ | -| `endpointId` | [`EndpointNumber`](../modules/datatype_export.md#endpointnumber) | Endpoint ID of the child endpoint to get | +| `identifierData` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | `undefined` | +| `discoveryCapabilities?` | [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<{ `ble`: [`BitFlag`](../modules/schema_export.md#bitflag-1) ; `onIpNetwork`: [`BitFlag`](../modules/schema_export.md#bitflag-1) ; `softAccessPoint`: [`BitFlag`](../modules/schema_export.md#bitflag-1) }\> | `undefined` | +| `discoveredCallback?` | (`device`: [`CommissionableDevice`](../modules/common_export.md#commissionabledevice)) => `void` | `undefined` | +| `timeoutSeconds` | `number` | `900` | #### Returns -`undefined` \| [`Endpoint`](device_export.Endpoint.md) - -#### Inherited from - -[MatterNode](export.MatterNode.md).[getChildEndpoint](export.MatterNode.md#getchildendpoint) +`Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> #### Defined in -packages/matter.js/src/MatterNode.ts:97 +[packages/matter.js/src/CommissioningController.ts:393](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L393) ___ -### getDevices +### getActiveSessionInformation -▸ **getDevices**(): [`Endpoint`](device_export.Endpoint.md)[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] -Returns the devices known to the controller. +Returns active session information for all connected nodes. #### Returns -[`Endpoint`](device_export.Endpoint.md)[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/src/CommissioningController.ts:499 +[packages/matter.js/src/CommissioningController.ts:418](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L418) ___ -### getFabric +### getCommissionedNodes -▸ **getFabric**(): [`Fabric`](fabric_export.Fabric.md) +▸ **getCommissionedNodes**(): [`NodeId`](../modules/datatype_export.md#nodeid)[] -Returns the paired Fabric object of the node +Returns an array with the Node Ids for all commissioned nodes. #### Returns -[`Fabric`](fabric_export.Fabric.md) +[`NodeId`](../modules/datatype_export.md#nodeid)[] #### Defined in -packages/matter.js/src/CommissioningController.ts:279 +[packages/matter.js/src/CommissioningController.ts:345](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L345) ___ -### getInteractionClient +### getConnectedNode -▸ **getInteractionClient**(): [`InteractionClient`](protocol_interaction_export.InteractionClient.md) +▸ **getConnectedNode**(`nodeId`): `undefined` \| [`PairedNode`](device_export.PairedNode.md) + +Returns the PairedNode instance for a given node id, if this node is connected. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns -[`InteractionClient`](protocol_interaction_export.InteractionClient.md) +`undefined` \| [`PairedNode`](device_export.PairedNode.md) #### Defined in -packages/matter.js/src/CommissioningController.ts:526 +[packages/matter.js/src/CommissioningController.ts:340](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L340) ___ ### getPort -▸ **getPort**(): `undefined` +▸ **getPort**(): `undefined` \| `number` #### Returns -`undefined` +`undefined` \| `number` #### Overrides @@ -485,127 +458,103 @@ ___ #### Defined in -packages/matter.js/src/CommissioningController.ts:512 +[packages/matter.js/src/CommissioningController.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L363) ___ -### getRootClusterClient +### initialize -▸ **getRootClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> +▸ **initialize**(`ipv4Disabled`): `void` -Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Type parameters +#### Parameters | Name | Type | | :------ | :------ | -| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | -| `SF` | extends [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<`F`\> | -| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | -| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`Cluster`](../modules/cluster_export.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterClient to get or undefined if not existing | +| `ipv4Disabled` | `boolean` | #### Returns -`undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> +`void` -#### Inherited from +#### Overrides -[MatterNode](export.MatterNode.md).[getRootClusterClient](export.MatterNode.md#getrootclusterclient) +[MatterNode](export.MatterNode.md).[initialize](export.MatterNode.md#initialize) #### Defined in -packages/matter.js/src/MatterNode.ts:64 +[packages/matter.js/src/CommissioningController.ts:367](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L367) ___ -### getRootClusterServer - -▸ **getRootClusterServer**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> - -Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user. +### initializeController -#### Type parameters +▸ `Private` **initializeController**(): `Promise`<[`MatterController`](export._internal_.MatterController.md)\> -| Name | Type | -| :------ | :------ | -| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | -| `SF` | extends [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<`F`\> | -| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | -| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`Cluster`](../modules/cluster_export.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterServer to get or undefined if not existing | +Internal method to initialize a MatterController instance. #### Returns -`undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> - -#### Inherited from - -[MatterNode](export.MatterNode.md).[getRootClusterServer](export.MatterNode.md#getrootclusterserver) +`Promise`<[`MatterController`](export._internal_.MatterController.md)\> #### Defined in -packages/matter.js/src/MatterNode.ts:38 +[packages/matter.js/src/CommissioningController.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L162) ___ -### getRootEndpoint +### isCommissioned -▸ **getRootEndpoint**(): [`RootEndpoint`](device_export.RootEndpoint.md) +▸ **isCommissioned**(): `boolean` -Get the root endpoint of the node. +Returns true if t least one node is commissioned/paired with this controller instance. #### Returns -[`RootEndpoint`](device_export.RootEndpoint.md) - -#### Inherited from - -[MatterNode](export.MatterNode.md).[getRootEndpoint](export.MatterNode.md#getrootendpoint) +`boolean` #### Defined in -packages/matter.js/src/MatterNode.ts:77 +[packages/matter.js/src/CommissioningController.ts:324](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L324) ___ -### initializeAfterConnect +### isNodeCommissioned -▸ **initializeAfterConnect**(): `Promise`<`void`\> +▸ **isNodeCommissioned**(`nodeId`): `boolean` + +Check if a given node id is commissioned on this controller. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns -`Promise`<`void`\> +`boolean` #### Defined in -packages/matter.js/src/CommissioningController.ts:234 +[packages/matter.js/src/CommissioningController.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L208) ___ -### initializeEndpointStructure +### removeNode -▸ `Private` **initializeEndpointStructure**(`allClusterAttributes`): `Promise`<`void`\> +▸ **removeNode**(`nodeId`, `tryDecommissioning?`): `Promise`<`void`\> -Read all data from the device and create a device object structure out of it. +Remove a Node id from the controller. This method should only be used if the decommission method on the +PairedNode instance returns an error. By default it tries to decommission the node from the controller but will +remove it also in case of an error during decommissioning. Ideally try to decommission the node before and only +use this in case of an error. #### Parameters -| Name | Type | -| :------ | :------ | -| `allClusterAttributes` | [`DecodedAttributeReportValue`](../modules/protocol_interaction_export.md#decodedattributereportvalue)<`any`\>[] | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | `undefined` | +| `tryDecommissioning` | `boolean` | `true` | #### Returns @@ -613,23 +562,21 @@ Read all data from the device and create a device object structure out of it. #### Defined in -packages/matter.js/src/CommissioningController.ts:308 +[packages/matter.js/src/CommissioningController.ts:219](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L219) ___ -### isCommissioned - -▸ **isCommissioned**(): `boolean` +### resetStorage -Return info if a device is successfully paired. +▸ **resetStorage**(): `void` #### Returns -`boolean` +`void` #### Defined in -packages/matter.js/src/CommissioningController.ts:289 +[packages/matter.js/src/CommissioningController.ts:409](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L409) ___ @@ -655,7 +602,7 @@ Set the MDNS Broadcaster instance. Should be only used internally #### Defined in -packages/matter.js/src/CommissioningController.ts:264 +[packages/matter.js/src/CommissioningController.ts:310](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L310) ___ @@ -681,7 +628,7 @@ Set the MDNS Scanner instance. Should be only used internally #### Defined in -packages/matter.js/src/CommissioningController.ts:255 +[packages/matter.js/src/CommissioningController.ts:301](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L301) ___ @@ -703,7 +650,7 @@ Set the Storage instance. Should be only used internally #### Defined in -packages/matter.js/src/CommissioningController.ts:272 +[packages/matter.js/src/CommissioningController.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L319) ___ @@ -711,6 +658,8 @@ ___ ▸ **start**(): `Promise`<`void`\> +Initialize the controller and connect to all commissioned nodes if autoConnect is not set to false. + #### Returns `Promise`<`void`\> @@ -721,46 +670,4 @@ ___ #### Defined in -packages/matter.js/src/CommissioningController.ts:516 - -___ - -### structureEndpoints - -▸ `Private` **structureEndpoints**(`partLists`): `void` - -Bring the endpoints in a structure based on their partsList attribute. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `partLists` | `Map`<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber), [`EndpointNumber`](../modules/datatype_export.md#endpointnumber)[]\> | A Map of the partsList attributes of all endpoints to structure | - -#### Returns - -`void` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:333 - -___ - -### subscribeAllAttributesAndEvents - -▸ **subscribeAllAttributesAndEvents**(`ignoreInitialTriggers`): `Promise`<{ `attributeReports?`: [`DecodedAttributeReportValue`](../modules/protocol_interaction_export.md#decodedattributereportvalue)<`any`\>[] ; `eventReports?`: [`DecodedEventReportValue`](../modules/protocol_interaction_export.md#decodedeventreportvalue)<`any`\>[] }\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ignoreInitialTriggers` | `boolean` | - -#### Returns - -`Promise`<{ `attributeReports?`: [`DecodedAttributeReportValue`](../modules/protocol_interaction_export.md#decodedattributereportvalue)<`any`\>[] ; `eventReports?`: [`DecodedEventReportValue`](../modules/protocol_interaction_export.md#decodedeventreportvalue)<`any`\>[] }\> - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:182 +[packages/matter.js/src/CommissioningController.ts:380](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L380) diff --git a/docs/matter.js/classes/export.CommissioningServer.md b/docs/matter.js/classes/export.CommissioningServer.md index 72e93c1db9..1affd17b28 100644 --- a/docs/matter.js/classes/export.CommissioningServer.md +++ b/docs/matter.js/classes/export.CommissioningServer.md @@ -48,6 +48,7 @@ host - [advertise](export.CommissioningServer.md#advertise) - [assignEndpointIds](export.CommissioningServer.md#assignendpointids) - [close](export.CommissioningServer.md#close) +- [factoryReset](export.CommissioningServer.md#factoryreset) - [fillAndStoreEndpointIds](export.CommissioningServer.md#fillandstoreendpointids) - [getActiveSessionInformation](export.CommissioningServer.md#getactivesessioninformation) - [getChildEndpoint](export.CommissioningServer.md#getchildendpoint) @@ -58,11 +59,14 @@ host - [getRootClusterClient](export.CommissioningServer.md#getrootclusterclient) - [getRootClusterServer](export.CommissioningServer.md#getrootclusterserver) - [getRootEndpoint](export.CommissioningServer.md#getrootendpoint) +- [initialize](export.CommissioningServer.md#initialize) - [initializeEndpointIdsFromStorage](export.CommissioningServer.md#initializeendpointidsfromstorage) - [isCommissioned](export.CommissioningServer.md#iscommissioned) - [removeCommandHandler](export.CommissioningServer.md#removecommandhandler) - [setMdnsBroadcaster](export.CommissioningServer.md#setmdnsbroadcaster) - [setMdnsScanner](export.CommissioningServer.md#setmdnsscanner) +- [setPort](export.CommissioningServer.md#setport) +- [setReachability](export.CommissioningServer.md#setreachability) - [setStorage](export.CommissioningServer.md#setstorage) - [start](export.CommissioningServer.md#start) - [updateStructure](export.CommissioningServer.md#updatestructure) @@ -87,17 +91,17 @@ Creates a new CommissioningServer node and add all needed Root clusters #### Defined in -packages/matter.js/src/CommissioningServer.ts:223 +[packages/matter.js/src/CommissioningServer.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L240) ## Properties ### commandHandler -• `Private` `Readonly` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<[`CommissioningServerCommands`](../modules/export._internal_.md#commissioningservercommands)\> +• `Private` `Readonly` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<[`CommissioningServerCommands`](../modules/export._internal_.md#commissioningservercommands)\> #### Defined in -packages/matter.js/src/CommissioningServer.ts:216 +[packages/matter.js/src/CommissioningServer.ts:233](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L233) ___ @@ -107,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:214 +[packages/matter.js/src/CommissioningServer.ts:231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L231) ___ @@ -117,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:209 +[packages/matter.js/src/CommissioningServer.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L224) ___ @@ -127,7 +131,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:201 +[packages/matter.js/src/CommissioningServer.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L216) ___ @@ -137,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:205 +[packages/matter.js/src/CommissioningServer.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L220) ___ @@ -147,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:202 +[packages/matter.js/src/CommissioningServer.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L217) ___ @@ -157,21 +161,17 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:210 +[packages/matter.js/src/CommissioningServer.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L225) ___ ### ipv4Disabled -• **ipv4Disabled**: `boolean` = `false` - -#### Inherited from - -[MatterNode](export.MatterNode.md).[ipv4Disabled](export.MatterNode.md#ipv4disabled) +• `Private` `Optional` **ipv4Disabled**: `boolean` #### Defined in -packages/matter.js/src/MatterNode.ts:22 +[packages/matter.js/src/CommissioningServer.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L213) ___ @@ -181,7 +181,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:207 +[packages/matter.js/src/CommissioningServer.ts:222](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L222) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:206 +[packages/matter.js/src/CommissioningServer.ts:221](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L221) ___ @@ -201,7 +201,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:212 +[packages/matter.js/src/CommissioningServer.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L229) ___ @@ -213,7 +213,7 @@ The options for the CommissioningServer node #### Defined in -packages/matter.js/src/CommissioningServer.ts:223 +[packages/matter.js/src/CommissioningServer.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L240) ___ @@ -223,17 +223,17 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:200 +[packages/matter.js/src/CommissioningServer.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L215) ___ ### port -• `Private` `Readonly` **port**: `number` +• `Private` `Optional` **port**: `number` #### Defined in -packages/matter.js/src/CommissioningServer.ts:199 +[packages/matter.js/src/CommissioningServer.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L214) ___ @@ -241,13 +241,9 @@ ___ • `Protected` `Readonly` **rootEndpoint**: [`RootEndpoint`](device_export.RootEndpoint.md) -#### Inherited from - -[MatterNode](export.MatterNode.md).[rootEndpoint](export.MatterNode.md#rootendpoint) - #### Defined in -packages/matter.js/src/MatterNode.ts:21 +[packages/matter.js/src/CommissioningServer.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L227) ___ @@ -257,7 +253,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:204 +[packages/matter.js/src/CommissioningServer.ts:219](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L219) ## Methods @@ -286,7 +282,7 @@ Add a new command handler for the given command #### Defined in -packages/matter.js/src/CommissioningServer.ts:748 +[packages/matter.js/src/CommissioningServer.ts:893](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L893) ___ @@ -308,7 +304,7 @@ Add a new device to the node #### Defined in -packages/matter.js/src/CommissioningServer.ts:722 +[packages/matter.js/src/CommissioningServer.ts:837](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L837) ___ @@ -328,13 +324,9 @@ Add a child endpoint to the root endpoint. This is mainly used internally and no `void` -#### Inherited from - -[MatterNode](export.MatterNode.md).[addEndpoint](export.MatterNode.md#addendpoint) - #### Defined in -packages/matter.js/src/MatterNode.ts:87 +[packages/matter.js/src/CommissioningServer.ts:503](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L503) ___ @@ -363,13 +355,9 @@ Add a cluster client to the root endpoint. This is mainly used internally and no `void` -#### Inherited from - -[MatterNode](export.MatterNode.md).[addRootClusterClient](export.MatterNode.md#addrootclusterclient) - #### Defined in -packages/matter.js/src/MatterNode.ts:53 +[packages/matter.js/src/CommissioningServer.ts:469](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L469) ___ @@ -398,13 +386,9 @@ added in the constructor `void` -#### Overrides - -[MatterNode](export.MatterNode.md).[addRootClusterServer](export.MatterNode.md#addrootclusterserver) - #### Defined in -packages/matter.js/src/CommissioningServer.ts:431 +[packages/matter.js/src/CommissioningServer.ts:524](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L524) ___ @@ -426,7 +410,7 @@ Advertise the node via all available interfaces (Ethernet/MDNS, BLE, ...) and st #### Defined in -packages/matter.js/src/CommissioningServer.ts:451 +[packages/matter.js/src/CommissioningServer.ts:544](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L544) ___ @@ -440,7 +424,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:565 +[packages/matter.js/src/CommissioningServer.ts:678](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L678) ___ @@ -448,7 +432,7 @@ ___ ▸ **close**(): `Promise`<`void`\> -close network connections of the device +Close network connections of the device and stop responding to requests #### Returns @@ -460,7 +444,21 @@ close network connections of the device #### Defined in -packages/matter.js/src/CommissioningServer.ts:736 +[packages/matter.js/src/CommissioningServer.ts:860](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L860) + +___ + +### factoryReset + +▸ **factoryReset**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/CommissioningServer.ts:868](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L868) ___ @@ -481,23 +479,29 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:607 +[packages/matter.js/src/CommissioningServer.ts:720](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L720) ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(`fabricIndex?`): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] Get some basic details of all currently active sessions. +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fabricIndex?` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | Optional fabric index to filter for. If not set all sessions are returned. | + #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/src/CommissioningServer.ts:781 +[packages/matter.js/src/CommissioningServer.ts:966](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L966) ___ @@ -517,29 +521,31 @@ Get a child endpoint from the root endpoint. This is mainly used internally and `undefined` \| [`Endpoint`](device_export.Endpoint.md) -#### Inherited from - -[MatterNode](export.MatterNode.md).[getChildEndpoint](export.MatterNode.md#getchildendpoint) - #### Defined in -packages/matter.js/src/MatterNode.ts:97 +[packages/matter.js/src/CommissioningServer.ts:513](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L513) ___ ### getCommissionedFabricInformation -▸ **getCommissionedFabricInformation**(): { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) }[] +▸ **getCommissionedFabricInformation**(`fabricIndex?`): { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) }[] Get some basic details of all Fabrics the server is commissioned to. +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fabricIndex?` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | Optional fabric index to filter for. If not set all fabrics are returned. | + #### Returns -{ `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) }[] +{ `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) }[] #### Defined in -packages/matter.js/src/CommissioningServer.ts:775 +[packages/matter.js/src/CommissioningServer.ts:954](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L954) ___ @@ -559,7 +565,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:558 +[packages/matter.js/src/CommissioningServer.ts:671](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L671) ___ @@ -581,19 +587,19 @@ Return the pairing information for the device #### Defined in -packages/matter.js/src/CommissioningServer.ts:643 +[packages/matter.js/src/CommissioningServer.ts:756](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L756) ___ ### getPort -▸ **getPort**(): `number` +▸ **getPort**(): `undefined` \| `number` Return the port the device is listening on #### Returns -`number` +`undefined` \| `number` #### Overrides @@ -601,7 +607,7 @@ Return the port the device is listening on #### Defined in -packages/matter.js/src/CommissioningServer.ts:729 +[packages/matter.js/src/CommissioningServer.ts:844](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L844) ___ @@ -631,13 +637,9 @@ Get a cluster client from the root endpoint. This is mainly used internally and `undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> -#### Inherited from - -[MatterNode](export.MatterNode.md).[getRootClusterClient](export.MatterNode.md#getrootclusterclient) - #### Defined in -packages/matter.js/src/MatterNode.ts:64 +[packages/matter.js/src/CommissioningServer.ts:480](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L480) ___ @@ -667,13 +669,9 @@ Get a cluster server from the root endpoint. This is mainly used internally and `undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> -#### Inherited from - -[MatterNode](export.MatterNode.md).[getRootClusterServer](export.MatterNode.md#getrootclusterserver) - #### Defined in -packages/matter.js/src/MatterNode.ts:38 +[packages/matter.js/src/CommissioningServer.ts:454](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L454) ___ @@ -687,13 +685,35 @@ Get the root endpoint of the node. [`RootEndpoint`](device_export.RootEndpoint.md) -#### Inherited from +#### Defined in + +[packages/matter.js/src/CommissioningServer.ts:493](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L493) -[MatterNode](export.MatterNode.md).[getRootEndpoint](export.MatterNode.md#getrootendpoint) +___ + +### initialize + +▸ **initialize**(`ipv4Disabled`): `void` + +used internally by MatterServer to initialize the state of the device. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ipv4Disabled` | `boolean` | + +#### Returns + +`void` + +#### Overrides + +[MatterNode](export.MatterNode.md).[initialize](export.MatterNode.md#initialize) #### Defined in -packages/matter.js/src/MatterNode.ts:77 +[packages/matter.js/src/CommissioningServer.ts:930](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L930) ___ @@ -714,7 +734,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:572 +[packages/matter.js/src/CommissioningServer.ts:685](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L685) ___ @@ -730,7 +750,7 @@ Return info if the device is paired with at least one controller #### Defined in -packages/matter.js/src/CommissioningServer.ts:636 +[packages/matter.js/src/CommissioningServer.ts:749](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L749) ___ @@ -759,7 +779,7 @@ Remove a command handler for the given command #### Defined in -packages/matter.js/src/CommissioningServer.ts:761 +[packages/matter.js/src/CommissioningServer.ts:906](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L906) ___ @@ -785,7 +805,7 @@ Set the MDNS Broadcaster instance. Should be only used internally #### Defined in -packages/matter.js/src/CommissioningServer.ts:704 +[packages/matter.js/src/CommissioningServer.ts:816](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L816) ___ @@ -811,7 +831,52 @@ Set the MDNS Scanner instance. Should be only used internally #### Defined in -packages/matter.js/src/CommissioningServer.ts:695 +[packages/matter.js/src/CommissioningServer.ts:807](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L807) + +___ + +### setPort + +▸ **setPort**(`port`): `void` + +Set the port the device is listening on. Can only be called before the device is initialized. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `port` | `number` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/CommissioningServer.ts:849](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L849) + +___ + +### setReachability + +▸ **setReachability**(`reachable`): `void` + +Set the reachability of the commissioning server aka "the main matter device". This call only has effect when +the reachability flag was set in the BasicInformationCluster or in the BasicInformation data in the constructor! + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/CommissioningServer.ts:919](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L919) ___ @@ -833,7 +898,7 @@ Set the StorageManager instance. Should be only used internally #### Defined in -packages/matter.js/src/CommissioningServer.ts:712 +[packages/matter.js/src/CommissioningServer.ts:827](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L827) ___ @@ -841,6 +906,8 @@ ___ ▸ **start**(): `Promise`<`void`\> +Starts the Matter device and advertises it. + #### Returns `Promise`<`void`\> @@ -851,7 +918,7 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:768 +[packages/matter.js/src/CommissioningServer.ts:940](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L940) ___ @@ -865,4 +932,4 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:551 +[packages/matter.js/src/CommissioningServer.ts:664](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L664) diff --git a/docs/matter.js/classes/export.MatterNode.md b/docs/matter.js/classes/export.MatterNode.md index a7eefbac40..9a7df21b90 100644 --- a/docs/matter.js/classes/export.MatterNode.md +++ b/docs/matter.js/classes/export.MatterNode.md @@ -20,22 +20,11 @@ Abstract base class that represents a node in the matter ecosystem. - [constructor](export.MatterNode.md#constructor) -### Properties - -- [ipv4Disabled](export.MatterNode.md#ipv4disabled) -- [rootEndpoint](export.MatterNode.md#rootendpoint) - ### Methods -- [addEndpoint](export.MatterNode.md#addendpoint) -- [addRootClusterClient](export.MatterNode.md#addrootclusterclient) -- [addRootClusterServer](export.MatterNode.md#addrootclusterserver) - [close](export.MatterNode.md#close) -- [getChildEndpoint](export.MatterNode.md#getchildendpoint) - [getPort](export.MatterNode.md#getport) -- [getRootClusterClient](export.MatterNode.md#getrootclusterclient) -- [getRootClusterServer](export.MatterNode.md#getrootclusterserver) -- [getRootEndpoint](export.MatterNode.md#getrootendpoint) +- [initialize](export.MatterNode.md#initialize) - [setMdnsBroadcaster](export.MatterNode.md#setmdnsbroadcaster) - [setMdnsScanner](export.MatterNode.md#setmdnsscanner) - [start](export.MatterNode.md#start) @@ -46,110 +35,8 @@ Abstract base class that represents a node in the matter ecosystem. • **new MatterNode**() -## Properties - -### ipv4Disabled - -• **ipv4Disabled**: `boolean` = `false` - -#### Defined in - -packages/matter.js/src/MatterNode.ts:22 - -___ - -### rootEndpoint - -• `Protected` `Readonly` **rootEndpoint**: [`RootEndpoint`](device_export.RootEndpoint.md) - -#### Defined in - -packages/matter.js/src/MatterNode.ts:21 - ## Methods -### addEndpoint - -▸ `Protected` **addEndpoint**(`endpoint`): `void` - -Add a child endpoint to the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpoint` | [`Endpoint`](device_export.Endpoint.md) | Endpoint to add | - -#### Returns - -`void` - -#### Defined in - -packages/matter.js/src/MatterNode.ts:87 - -___ - -### addRootClusterClient - -▸ **addRootClusterClient**<`F`, `A`, `C`, `E`\>(`cluster`): `void` - -Add a cluster client to the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | -| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | -| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> | ClusterClient object to add | - -#### Returns - -`void` - -#### Defined in - -packages/matter.js/src/MatterNode.ts:53 - -___ - -### addRootClusterServer - -▸ **addRootClusterServer**<`A`, `E`\>(`cluster`): `void` - -Add a cluster to the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | -| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> | ClusterServer object to add | - -#### Returns - -`void` - -#### Defined in - -packages/matter.js/src/MatterNode.ts:29 - -___ - ### close ▸ `Abstract` **close**(): `Promise`<`void`\> @@ -160,29 +47,7 @@ ___ #### Defined in -packages/matter.js/src/MatterNode.ts:101 - -___ - -### getChildEndpoint - -▸ `Protected` **getChildEndpoint**(`endpointId`): `undefined` \| [`Endpoint`](device_export.Endpoint.md) - -Get a child endpoint from the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `endpointId` | [`EndpointNumber`](../modules/datatype_export.md#endpointnumber) | Endpoint ID of the child endpoint to get | - -#### Returns - -`undefined` \| [`Endpoint`](device_export.Endpoint.md) - -#### Defined in - -packages/matter.js/src/MatterNode.ts:97 +[packages/matter.js/src/MatterNode.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterNode.ts#L14) ___ @@ -196,87 +61,27 @@ ___ #### Defined in -packages/matter.js/src/MatterNode.ts:103 +[packages/matter.js/src/MatterNode.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterNode.ts#L16) ___ -### getRootClusterClient - -▸ **getRootClusterClient**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> - -Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user. +### initialize -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | -| `SF` | extends [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<`F`\> | -| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | -| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | +▸ `Abstract` **initialize**(`ipv4Disabled`): `void` #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`Cluster`](../modules/cluster_export.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterClient to get or undefined if not existing | - -#### Returns - -`undefined` \| [`ClusterClientObj`](../modules/cluster_export.md#clusterclientobj)<`F`, `A`, `C`, `E`\> - -#### Defined in - -packages/matter.js/src/MatterNode.ts:64 - -___ - -### getRootClusterServer - -▸ **getRootClusterServer**<`F`, `SF`, `A`, `C`, `E`\>(`cluster`): `undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> - -Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user. - -#### Type parameters - | Name | Type | | :------ | :------ | -| `F` | extends [`BitSchema`](../modules/schema_export.md#bitschema) | -| `SF` | extends [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<`F`\> | -| `A` | extends [`Attributes`](../interfaces/cluster_export.Attributes.md) | -| `C` | extends [`Commands`](../interfaces/cluster_export.Commands.md) | -| `E` | extends [`Events`](../interfaces/cluster_export.Events.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cluster` | [`Cluster`](../modules/cluster_export.md#cluster)<`F`, `SF`, `A`, `C`, `E`\> | ClusterServer to get or undefined if not existing | - -#### Returns - -`undefined` \| [`ClusterServerObj`](../modules/cluster_export.md#clusterserverobj)<`A`, `E`\> - -#### Defined in - -packages/matter.js/src/MatterNode.ts:38 - -___ - -### getRootEndpoint - -▸ **getRootEndpoint**(): [`RootEndpoint`](device_export.RootEndpoint.md) - -Get the root endpoint of the node. +| `ipv4Disabled` | `boolean` | #### Returns -[`RootEndpoint`](device_export.RootEndpoint.md) +`void` #### Defined in -packages/matter.js/src/MatterNode.ts:77 +[packages/matter.js/src/MatterNode.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterNode.ts#L18) ___ @@ -296,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/MatterNode.ts:107 +[packages/matter.js/src/MatterNode.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterNode.ts#L22) ___ @@ -316,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/MatterNode.ts:109 +[packages/matter.js/src/MatterNode.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterNode.ts#L24) ___ @@ -330,4 +135,4 @@ ___ #### Defined in -packages/matter.js/src/MatterNode.ts:105 +[packages/matter.js/src/MatterNode.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterNode.ts#L20) diff --git a/docs/matter.js/classes/export.MatterServer.md b/docs/matter.js/classes/export.MatterServer.md index c54d03314e..c83b3fd24c 100644 --- a/docs/matter.js/classes/export.MatterServer.md +++ b/docs/matter.js/classes/export.MatterServer.md @@ -15,10 +15,12 @@ by reusing MDNS scanner and broadcaster ### Properties +- [formerlyUsedPorts](export.MatterServer.md#formerlyusedports) - [mdnsBroadcaster](export.MatterServer.md#mdnsbroadcaster) - [mdnsScanner](export.MatterServer.md#mdnsscanner) - [nodes](export.MatterServer.md#nodes) - [options](export.MatterServer.md#options) +- [started](export.MatterServer.md#started) - [storageManager](export.MatterServer.md#storagemanager) ### Accessors @@ -30,7 +32,10 @@ by reusing MDNS scanner and broadcaster - [addCommissioningController](export.MatterServer.md#addcommissioningcontroller) - [addCommissioningServer](export.MatterServer.md#addcommissioningserver) - [close](export.MatterServer.md#close) +- [getNextMatterPort](export.MatterServer.md#getnextmatterport) - [prepareNode](export.MatterServer.md#preparenode) +- [removeCommissioningController](export.MatterServer.md#removecommissioningcontroller) +- [removeCommissioningServer](export.MatterServer.md#removecommissioningserver) - [start](export.MatterServer.md#start) ## Constructors @@ -50,17 +55,27 @@ Create a new Matter server instance #### Defined in -packages/matter.js/src/MatterServer.ts:51 +[packages/matter.js/src/MatterServer.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L68) ## Properties +### formerlyUsedPorts + +• `Private` `Readonly` **formerlyUsedPorts**: `number`[] + +#### Defined in + +[packages/matter.js/src/MatterServer.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L60) + +___ + ### mdnsBroadcaster • `Private` `Optional` **mdnsBroadcaster**: [`MdnsBroadcaster`](mdns_export.MdnsBroadcaster.md) #### Defined in -packages/matter.js/src/MatterServer.ts:43 +[packages/matter.js/src/MatterServer.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L58) ___ @@ -70,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/MatterServer.ts:42 +[packages/matter.js/src/MatterServer.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L57) ___ @@ -80,7 +95,7 @@ ___ #### Defined in -packages/matter.js/src/MatterServer.ts:40 +[packages/matter.js/src/MatterServer.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L55) ___ @@ -92,7 +107,17 @@ Optional MatterServer options #### Defined in -packages/matter.js/src/MatterServer.ts:53 +[packages/matter.js/src/MatterServer.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L70) + +___ + +### started + +• `Private` **started**: `boolean` = `false` + +#### Defined in + +[packages/matter.js/src/MatterServer.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L54) ___ @@ -104,7 +129,7 @@ Storage manager instance to use for all nodes #### Defined in -packages/matter.js/src/MatterServer.ts:52 +[packages/matter.js/src/MatterServer.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L69) ## Accessors @@ -118,13 +143,13 @@ packages/matter.js/src/MatterServer.ts:52 #### Defined in -packages/matter.js/src/MatterServer.ts:56 +[packages/matter.js/src/MatterServer.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L73) ## Methods ### addCommissioningController -▸ **addCommissioningController**(`commissioningController`, `nodeOptions?`): `void` +▸ **addCommissioningController**(`commissioningController`, `nodeOptions?`): `Promise`<`void`\> Add a Controller node to the server @@ -137,17 +162,17 @@ Add a Controller node to the server #### Returns -`void` +`Promise`<`void`\> #### Defined in -packages/matter.js/src/MatterServer.ts:90 +[packages/matter.js/src/MatterServer.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L171) ___ ### addCommissioningServer -▸ **addCommissioningServer**(`commissioningServer`, `nodeOptions?`): `void` +▸ **addCommissioningServer**(`commissioningServer`, `nodeOptions?`): `Promise`<`void`\> Add a CommissioningServer node to the server @@ -160,11 +185,11 @@ Add a CommissioningServer node to the server #### Returns -`void` +`Promise`<`void`\> #### Defined in -packages/matter.js/src/MatterServer.ts:66 +[packages/matter.js/src/MatterServer.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L126) ___ @@ -180,13 +205,33 @@ Close the server and all nodes #### Defined in -packages/matter.js/src/MatterServer.ts:132 +[packages/matter.js/src/MatterServer.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L247) + +___ + +### getNextMatterPort + +▸ `Private` **getNextMatterPort**(`desiredPort?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `desiredPort?` | `number` | + +#### Returns + +`number` + +#### Defined in + +[packages/matter.js/src/MatterServer.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L77) ___ ### prepareNode -▸ `Private` **prepareNode**(`node`): `void` +▸ `Private` **prepareNode**(`node`): `Promise`<`void`\> #### Parameters @@ -196,11 +241,58 @@ ___ #### Returns -`void` +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/MatterServer.ts:231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L231) + +___ + +### removeCommissioningController + +▸ **removeCommissioningController**(`commissioningController`, `destroyStorage?`): `Promise`<`void`\> + +Remove a Controller node from the server, close the Controller and optionally destroy the storage context. + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `commissioningController` | [`CommissioningController`](export.CommissioningController.md) | `undefined` | Controller node to remove | +| `destroyStorage` | `boolean` | `false` | If true the storage context will be destroyed | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/MatterServer.ts:191](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L191) + +___ + +### removeCommissioningServer + +▸ **removeCommissioningServer**(`commissioningServer`, `destroyStorage?`): `Promise`<`void`\> + +Remove a CommissioningServer node from the server, close the CommissioningServer and optionally destroy the +storage context. + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `commissioningServer` | [`CommissioningServer`](export.CommissioningServer.md) | `undefined` | CommissioningServer node to remove | +| `destroyStorage` | `boolean` | `false` | If true the storage context will be destroyed | + +#### Returns + +`Promise`<`void`\> #### Defined in -packages/matter.js/src/MatterServer.ts:119 +[packages/matter.js/src/MatterServer.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L142) ___ @@ -217,4 +309,4 @@ be announced/paired immediately. #### Defined in -packages/matter.js/src/MatterServer.ts:102 +[packages/matter.js/src/MatterServer.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L212) diff --git a/docs/matter.js/classes/export._internal_.Base38Schema.md b/docs/matter.js/classes/export._internal_.Base38Schema.md index 73cf73fc8b..bc7a50b40c 100644 --- a/docs/matter.js/classes/export._internal_.Base38Schema.md +++ b/docs/matter.js/classes/export._internal_.Base38Schema.md @@ -63,7 +63,7 @@ Decodes the encoded data using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/schema/Base38Schema.ts:84 +[packages/matter.js/src/schema/Base38Schema.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Base38Schema.ts#L84) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -packages/matter.js/src/schema/Base38Schema.ts:45 +[packages/matter.js/src/schema/Base38Schema.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Base38Schema.ts#L45) ___ @@ -135,7 +135,7 @@ Encodes the value using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -packages/matter.js/src/schema/Base38Schema.ts:35 +[packages/matter.js/src/schema/Base38Schema.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Base38Schema.ts#L35) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -packages/matter.js/src/schema/Base38Schema.ts:16 +[packages/matter.js/src/schema/Base38Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Base38Schema.ts#L16) ___ @@ -206,4 +206,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/export._internal_.DimmableBaseDevice.md b/docs/matter.js/classes/export._internal_.DimmableBaseDevice.md index 524addc9b5..cf3a6e0d10 100644 --- a/docs/matter.js/classes/export._internal_.DimmableBaseDevice.md +++ b/docs/matter.js/classes/export._internal_.DimmableBaseDevice.md @@ -62,6 +62,7 @@ - [removeChildEndpoint](export._internal_.DimmableBaseDevice.md#removechildendpoint) - [removeCommandHandler](export._internal_.DimmableBaseDevice.md#removecommandhandler) - [removeFromStructure](export._internal_.DimmableBaseDevice.md#removefromstructure) +- [setBridgedDeviceReachability](export._internal_.DimmableBaseDevice.md#setbridgeddevicereachability) - [setCurrentLevel](export._internal_.DimmableBaseDevice.md#setcurrentlevel) - [setDeviceTypes](export._internal_.DimmableBaseDevice.md#setdevicetypes) - [setOnOff](export._internal_.DimmableBaseDevice.md#setonoff) @@ -90,13 +91,13 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/util/NamedHandler.ts:39 +[packages/matter.js/src/util/NamedHandler.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L39) ## Properties ### commandHandler -• `Protected` **commandHandler**: [`NamedHandler`](export._internal_.NamedHandler.md)<`any`\> +• `Protected` **commandHandler**: [`NamedHandler`](util_export.NamedHandler.md)<`any`\> #### Inherited from @@ -106,7 +107,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:126 +[packages/matter.js/src/device/Device.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L168) ___ @@ -122,7 +123,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:125 +[packages/matter.js/src/device/Device.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L167) ___ @@ -140,7 +141,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:53 +[packages/matter.js/src/device/Endpoint.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L53) ___ @@ -156,7 +157,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:37 +[packages/matter.js/src/device/Endpoint.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L37) ___ @@ -172,7 +173,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:39 +[packages/matter.js/src/device/Endpoint.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L39) ___ @@ -188,7 +189,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:38 +[packages/matter.js/src/device/Endpoint.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L38) ## Methods @@ -218,7 +219,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:183 +[packages/matter.js/src/device/Device.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L225) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -250,7 +251,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ▸ `Protected` **_executeHandler**<`K`\>(`action`, `...args`): `Promise`<`void`\> @@ -282,7 +283,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/util/NamedHandler.ts:42 +[packages/matter.js/src/util/NamedHandler.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L42) ___ @@ -308,7 +309,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:256 +[packages/matter.js/src/device/Endpoint.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L256) ___ @@ -343,7 +344,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:173 +[packages/matter.js/src/device/Endpoint.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L173) ___ @@ -376,7 +377,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:146 +[packages/matter.js/src/device/Endpoint.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L146) ___ @@ -392,7 +393,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to add a handler for | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be executed when the command is received | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be executed when the command is received | #### Returns @@ -406,7 +407,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:160 +[packages/matter.js/src/device/Device.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L202) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -438,7 +439,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ▸ **addCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -470,7 +471,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/util/NamedHandler.ts:40 +[packages/matter.js/src/util/NamedHandler.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L40) ___ @@ -492,7 +493,7 @@ Adds a listener for the CurrentLevel attribute #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:71 +[packages/matter.js/src/device/DimmableDevices.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L71) ___ @@ -519,7 +520,7 @@ extendPublicHandlerMethods<typeof OnOffBaseDevice, DimmableDeviceCommands\> #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:29 +[packages/matter.js/src/device/DimmableDevices.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L29) ___ @@ -546,7 +547,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:106 +[packages/matter.js/src/device/Endpoint.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L106) ___ @@ -575,7 +576,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:136 +[packages/matter.js/src/device/OnOffDevices.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L136) ___ @@ -602,7 +603,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:126 +[packages/matter.js/src/device/Endpoint.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L126) ___ @@ -638,7 +639,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:198 +[packages/matter.js/src/device/Device.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L240) ___ @@ -674,7 +675,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:187 +[packages/matter.js/src/device/Device.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L229) ___ @@ -694,7 +695,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:93 +[packages/matter.js/src/device/Endpoint.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L93) ___ @@ -714,7 +715,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:280 +[packages/matter.js/src/device/Endpoint.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L283) ___ @@ -734,7 +735,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:340 +[packages/matter.js/src/device/Endpoint.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L343) ___ @@ -754,7 +755,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:336 +[packages/matter.js/src/device/Endpoint.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L339) ___ @@ -780,7 +781,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:262 +[packages/matter.js/src/device/Endpoint.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L265) ___ @@ -800,7 +801,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:266 +[packages/matter.js/src/device/Endpoint.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L269) ___ @@ -836,7 +837,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:229 +[packages/matter.js/src/device/Device.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L271) ___ @@ -862,7 +863,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:212 +[packages/matter.js/src/device/Endpoint.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L212) ___ @@ -898,7 +899,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:209 +[packages/matter.js/src/device/Device.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L251) ___ @@ -924,7 +925,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:208 +[packages/matter.js/src/device/Endpoint.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L208) ___ @@ -938,7 +939,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:58 +[packages/matter.js/src/device/DimmableDevices.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L58) ___ @@ -958,7 +959,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:236 +[packages/matter.js/src/device/Endpoint.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L236) ___ @@ -978,7 +979,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:99 +[packages/matter.js/src/device/Endpoint.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L99) ___ @@ -998,7 +999,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:116 +[packages/matter.js/src/device/OnOffDevices.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L116) ___ @@ -1034,7 +1035,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:226 +[packages/matter.js/src/device/Endpoint.ts:226](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L226) ___ @@ -1070,7 +1071,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:216 +[packages/matter.js/src/device/Endpoint.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L216) ___ @@ -1096,7 +1097,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:270 +[packages/matter.js/src/device/Endpoint.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L273) ___ @@ -1112,7 +1113,7 @@ The base class do not expose any commands! | Name | Type | Description | | :------ | :------ | :------ | | `command` | `never` | Command name to remove the handler from | -| `handler` | [`HandlerFunction`](../modules/export._internal_.md#handlerfunction) | Handler function to be removed | +| `handler` | [`HandlerFunction`](../modules/util_export.md#handlerfunction) | Handler function to be removed | #### Returns @@ -1126,7 +1127,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Device.ts:171 +[packages/matter.js/src/device/Device.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L213) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -1158,7 +1159,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ▸ **removeCommandHandler**<`K`\>(`action`, `handler`): `void` @@ -1190,7 +1191,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/util/NamedHandler.ts:41 +[packages/matter.js/src/util/NamedHandler.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L41) ___ @@ -1210,7 +1211,36 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:85 +[packages/matter.js/src/device/Endpoint.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L85) + +___ + +### setBridgedDeviceReachability + +▸ **setBridgedDeviceReachability**(`reachable`): `void` + +Set the reachability of the device exposed via the bridge. If this is a device inside a composed device the +reachability needs to be set there. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `reachable` | `boolean` | true if reachable, false otherwise | + +#### Returns + +`void` + +#### Inherited from + +extendPublicHandlerMethods( + OnOffBaseDevice, +).setBridgedDeviceReachability + +#### Defined in + +[packages/matter.js/src/device/Device.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L296) ___ @@ -1230,7 +1260,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:62 +[packages/matter.js/src/device/DimmableDevices.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L62) ___ @@ -1256,7 +1286,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:240 +[packages/matter.js/src/device/Endpoint.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L240) ___ @@ -1285,7 +1315,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:112 +[packages/matter.js/src/device/OnOffDevices.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L112) ___ @@ -1311,7 +1341,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:80 +[packages/matter.js/src/device/Endpoint.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L80) ___ @@ -1334,7 +1364,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:124 +[packages/matter.js/src/device/OnOffDevices.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L124) ___ @@ -1354,7 +1384,7 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:344 +[packages/matter.js/src/device/Endpoint.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L347) ___ @@ -1374,4 +1404,4 @@ extendPublicHandlerMethods( #### Defined in -packages/matter.js/src/device/Endpoint.ts:302 +[packages/matter.js/src/device/Endpoint.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L305) diff --git a/docs/matter.js/classes/export._internal_.EventHandler.md b/docs/matter.js/classes/export._internal_.EventHandler.md index 3c2cd9b11e..41ac993d8f 100644 --- a/docs/matter.js/classes/export._internal_.EventHandler.md +++ b/docs/matter.js/classes/export._internal_.EventHandler.md @@ -40,7 +40,7 @@ to handle subscriptions (TBD) #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:54 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L54) ## Properties @@ -50,7 +50,7 @@ packages/matter.js/src/protocol/interaction/EventHandler.ts:54 #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:46 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L46) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:45 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L45) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:48 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L48) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:47 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L47) ## Methods @@ -102,7 +102,7 @@ packages/matter.js/src/protocol/interaction/EventHandler.ts:47 #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:99 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L99) ___ @@ -123,7 +123,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:60 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L60) ___ @@ -153,4 +153,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:86 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L86) diff --git a/docs/matter.js/classes/export._internal_.GaloisField.md b/docs/matter.js/classes/export._internal_.GaloisField.md index 622a1edc55..5e2f992124 100644 --- a/docs/matter.js/classes/export._internal_.GaloisField.md +++ b/docs/matter.js/classes/export._internal_.GaloisField.md @@ -40,7 +40,7 @@ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:14 +[packages/matter.js/src/math/ReedSolomon.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L14) ## Properties @@ -50,7 +50,7 @@ packages/matter.js/src/math/ReedSolomon.ts:14 #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:10 +[packages/matter.js/src/math/ReedSolomon.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L10) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:11 +[packages/matter.js/src/math/ReedSolomon.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L11) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:15 +[packages/matter.js/src/math/ReedSolomon.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L15) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:12 +[packages/matter.js/src/math/ReedSolomon.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L12) ## Methods @@ -101,7 +101,7 @@ packages/matter.js/src/math/ReedSolomon.ts:12 #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:32 +[packages/matter.js/src/math/ReedSolomon.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L32) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:58 +[packages/matter.js/src/math/ReedSolomon.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L58) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:37 +[packages/matter.js/src/math/ReedSolomon.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L37) ___ @@ -164,4 +164,4 @@ ___ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:54 +[packages/matter.js/src/math/ReedSolomon.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L54) diff --git a/docs/matter.js/classes/export._internal_.InteractionMessenger.md b/docs/matter.js/classes/export._internal_.InteractionMessenger.md index 198919e38e..568d2865be 100644 --- a/docs/matter.js/classes/export._internal_.InteractionMessenger.md +++ b/docs/matter.js/classes/export._internal_.InteractionMessenger.md @@ -58,7 +58,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L95) ## Properties @@ -68,7 +68,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L95) ## Methods @@ -82,7 +82,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:118 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L125) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:133 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L140) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:106 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L113) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:90 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L97) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:94 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L101) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:122 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L129) ___ @@ -192,4 +192,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:101 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L108) diff --git a/docs/matter.js/classes/export._internal_.ManualPairingCodeSchema.md b/docs/matter.js/classes/export._internal_.ManualPairingCodeSchema.md index 3515c386cd..8c274a451b 100644 --- a/docs/matter.js/classes/export._internal_.ManualPairingCodeSchema.md +++ b/docs/matter.js/classes/export._internal_.ManualPairingCodeSchema.md @@ -61,7 +61,7 @@ Decodes the encoded data using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:99 +[packages/matter.js/src/schema/PairingCodeSchema.ts:100](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L100) ___ @@ -111,7 +111,7 @@ Encodes the value using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:83 +[packages/matter.js/src/schema/PairingCodeSchema.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L84) ___ @@ -161,4 +161,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/export._internal_.MatterController.md b/docs/matter.js/classes/export._internal_.MatterController.md index cacc9e4d41..cf829e142a 100644 --- a/docs/matter.js/classes/export._internal_.MatterController.md +++ b/docs/matter.js/classes/export._internal_.MatterController.md @@ -12,10 +12,12 @@ ### Properties +- [adminVendorId](export._internal_.MatterController.md#adminvendorid) +- [bleScanner](export._internal_.MatterController.md#blescanner) - [caseClient](export._internal_.MatterController.md#caseclient) - [certificateManager](export._internal_.MatterController.md#certificatemanager) - [channelManager](export._internal_.MatterController.md#channelmanager) -- [commissioningOptions](export._internal_.MatterController.md#commissioningoptions) +- [commissionedNodes](export._internal_.MatterController.md#commissionednodes) - [controllerStorage](export._internal_.MatterController.md#controllerstorage) - [exchangeManager](export._internal_.MatterController.md#exchangemanager) - [fabric](export._internal_.MatterController.md#fabric) @@ -23,71 +25,96 @@ - [netInterfaceBle](export._internal_.MatterController.md#netinterfaceble) - [netInterfaceIpv4](export._internal_.MatterController.md#netinterfaceipv4) - [netInterfaceIpv6](export._internal_.MatterController.md#netinterfaceipv6) -- [operationalServerAddress](export._internal_.MatterController.md#operationalserveraddress) - [paseClient](export._internal_.MatterController.md#paseclient) - [sessionClosedCallback](export._internal_.MatterController.md#sessionclosedcallback) - [sessionManager](export._internal_.MatterController.md#sessionmanager) - [storage](export._internal_.MatterController.md#storage) +### Accessors + +- [nodeId](export._internal_.MatterController.md#nodeid) + ### Methods - [addTransportInterface](export._internal_.MatterController.md#addtransportinterface) - [announce](export._internal_.MatterController.md#announce) - [close](export._internal_.MatterController.md#close) +- [collectScanners](export._internal_.MatterController.md#collectscanners) - [commission](export._internal_.MatterController.md#commission) - [commissionDevice](export._internal_.MatterController.md#commissiondevice) -- [commissionViaBle](export._internal_.MatterController.md#commissionviable) - [connect](export._internal_.MatterController.md#connect) +- [connectOrDiscoverNode](export._internal_.MatterController.md#connectordiscovernode) - [createSecureSession](export._internal_.MatterController.md#createsecuresession) -- [discoverDeviceAddressesByIdentifier](export._internal_.MatterController.md#discoverdeviceaddressesbyidentifier) +- [disconnect](export._internal_.MatterController.md#disconnect) - [findResumptionRecordByNodeId](export._internal_.MatterController.md#findresumptionrecordbynodeid) - [getActiveSessionInformation](export._internal_.MatterController.md#getactivesessioninformation) -- [getFabric](export._internal_.MatterController.md#getfabric) +- [getCommissionedNodes](export._internal_.MatterController.md#getcommissionednodes) +- [getLastOperationalAddress](export._internal_.MatterController.md#getlastoperationaladdress) - [getNextAvailableSessionId](export._internal_.MatterController.md#getnextavailablesessionid) -- [getOperationalServerAddress](export._internal_.MatterController.md#getoperationalserveraddress) - [getResumptionRecord](export._internal_.MatterController.md#getresumptionrecord) - [initializePaseSecureChannel](export._internal_.MatterController.md#initializepasesecurechannel) - [isCommissioned](export._internal_.MatterController.md#iscommissioned) -- [iterateServerAddresses](export._internal_.MatterController.md#iterateserveraddresses) - [pair](export._internal_.MatterController.md#pair) +- [reconnectLastKnownAddress](export._internal_.MatterController.md#reconnectlastknownaddress) +- [removeNode](export._internal_.MatterController.md#removenode) - [resume](export._internal_.MatterController.md#resume) - [saveResumptionRecord](export._internal_.MatterController.md#saveresumptionrecord) - [setOperationalServerAddress](export._internal_.MatterController.md#setoperationalserveraddress) +- [storeCommisionedNodes](export._internal_.MatterController.md#storecommisionednodes) - [create](export._internal_.MatterController.md#create) ## Constructors ### constructor -• **new MatterController**(`mdnsScanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `certificateManager`, `fabric`, `storage`, `operationalServerAddress?`, `commissioningOptions?`, `sessionClosedCallback?`) +• **new MatterController**(`mdnsScanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `certificateManager`, `fabric`, `storage`, `adminVendorId`, `sessionClosedCallback?`) #### Parameters | Name | Type | | :------ | :------ | -| `mdnsScanner` | [`Scanner`](../interfaces/common_export.Scanner.md) | +| `mdnsScanner` | [`MdnsScanner`](mdns_export.MdnsScanner.md) | | `netInterfaceIpv4` | `undefined` \| [`NetInterface`](../interfaces/net_export.NetInterface.md) | | `netInterfaceIpv6` | [`NetInterface`](../interfaces/net_export.NetInterface.md) | | `certificateManager` | [`RootCertificateManager`](certificate_export.RootCertificateManager.md) | | `fabric` | [`Fabric`](fabric_export.Fabric.md) | | `storage` | [`StorageContext`](storage_export.StorageContext.md) | -| `operationalServerAddress?` | [`ServerAddressIp`](../modules/common_export.md#serveraddressip) | -| `commissioningOptions?` | [`CommissioningOptions`](../modules/protocol_export.md#commissioningoptions) | +| `adminVendorId` | [`VendorId`](../modules/datatype_export.md#vendorid) | | `sessionClosedCallback?` | (`peerNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid)) => `void` | #### Defined in -packages/matter.js/src/MatterController.ts:133 +[packages/matter.js/src/MatterController.ts:143](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L143) ## Properties +### adminVendorId + +• `Private` `Readonly` **adminVendorId**: [`VendorId`](../modules/datatype_export.md#vendorid) + +#### Defined in + +[packages/matter.js/src/MatterController.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L150) + +___ + +### bleScanner + +• `Private` **bleScanner**: `undefined` \| [`Scanner`](../interfaces/common_export.Scanner.md) + +#### Defined in + +[packages/matter.js/src/MatterController.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L140) + +___ + ### caseClient • `Private` `Readonly` **caseClient**: [`CaseClient`](session_export.CaseClient.md) #### Defined in -packages/matter.js/src/MatterController.ts:128 +[packages/matter.js/src/MatterController.ts:137](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L137) ___ @@ -97,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:137 +[packages/matter.js/src/MatterController.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L147) ___ @@ -107,17 +134,17 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:125 +[packages/matter.js/src/MatterController.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L134) ___ -### commissioningOptions +### commissionedNodes -• `Private` `Readonly` **commissioningOptions**: [`CommissioningOptions`](../modules/protocol_export.md#commissioningoptions) +• `Private` `Readonly` **commissionedNodes**: `Map`<[`NodeId`](../modules/datatype_export.md#nodeid), [`CommissionedNodeDetails`](../modules/export._internal_.md#commissionednodedetails)\> #### Defined in -packages/matter.js/src/MatterController.ts:130 +[packages/matter.js/src/MatterController.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L141) ___ @@ -127,7 +154,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:129 +[packages/matter.js/src/MatterController.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L138) ___ @@ -137,7 +164,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:126 +[packages/matter.js/src/MatterController.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L135) ___ @@ -147,17 +174,17 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:138 +[packages/matter.js/src/MatterController.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L148) ___ ### mdnsScanner -• `Private` `Readonly` **mdnsScanner**: [`Scanner`](../interfaces/common_export.Scanner.md) +• `Private` `Readonly` **mdnsScanner**: [`MdnsScanner`](mdns_export.MdnsScanner.md) #### Defined in -packages/matter.js/src/MatterController.ts:134 +[packages/matter.js/src/MatterController.ts:144](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L144) ___ @@ -167,7 +194,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:131 +[packages/matter.js/src/MatterController.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L139) ___ @@ -177,7 +204,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:135 +[packages/matter.js/src/MatterController.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L145) ___ @@ -187,17 +214,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:136 - -___ - -### operationalServerAddress - -• `Optional` **operationalServerAddress**: [`ServerAddressIp`](../modules/common_export.md#serveraddressip) - -#### Defined in - -packages/matter.js/src/MatterController.ts:140 +[packages/matter.js/src/MatterController.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L146) ___ @@ -207,7 +224,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:127 +[packages/matter.js/src/MatterController.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L136) ___ @@ -231,7 +248,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:142 +[packages/matter.js/src/MatterController.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L151) ___ @@ -241,7 +258,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:124 +[packages/matter.js/src/MatterController.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L133) ___ @@ -251,7 +268,21 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:139 +[packages/matter.js/src/MatterController.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L149) + +## Accessors + +### nodeId + +• `get` **nodeId**(): [`NodeId`](../modules/datatype_export.md#nodeid) + +#### Returns + +[`NodeId`](../modules/datatype_export.md#nodeid) + +#### Defined in + +[packages/matter.js/src/MatterController.ts:186](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L186) ## Methods @@ -271,7 +302,7 @@ packages/matter.js/src/MatterController.ts:139 #### Defined in -packages/matter.js/src/MatterController.ts:166 +[packages/matter.js/src/MatterController.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L190) ___ @@ -285,7 +316,7 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:639 +[packages/matter.js/src/MatterController.ts:709](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L709) ___ @@ -299,13 +330,33 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:643 +[packages/matter.js/src/MatterController.ts:713](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L713) + +___ + +### collectScanners + +▸ **collectScanners**(`discoveryCapabilities?`): [`Scanner`](../interfaces/common_export.Scanner.md)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discoveryCapabilities` | [`TypeFromPartialBitSchema`](../modules/schema_export.md#typefrompartialbitschema)<{ `ble`: [`BitFlag`](../modules/schema_export.md#bitflag-1) ; `onIpNetwork`: [`BitFlag`](../modules/schema_export.md#bitflag-1) ; `softAccessPoint`: [`BitFlag`](../modules/schema_export.md#bitflag-1) }\> | + +#### Returns + +[`Scanner`](../interfaces/common_export.Scanner.md)[] + +#### Defined in + +[packages/matter.js/src/MatterController.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L194) ___ ### commission -▸ **commission**(`identifierData`, `passCode`, `timeoutSeconds?`, `knownAddress?`): `Promise`<[`NodeId`](../modules/datatype_export.md#nodeid)\> +▸ **commission**(`options`): `Promise`<[`NodeId`](../modules/datatype_export.md#nodeid)\> Commission a device by its identifier and the Passcode. If a known address is provided this is tried first before discovering devices in the network. If multiple addresses or devices are found, they are tried all after @@ -315,12 +366,9 @@ request or the passode did not match to any discovered device/address. #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `identifierData` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | `undefined` | -| `passCode` | `number` | `undefined` | -| `timeoutSeconds` | `number` | `30` | -| `knownAddress?` | [`ServerAddress`](../modules/common_export.md#serveraddress) | `undefined` | +| Name | Type | +| :------ | :------ | +| `options` | [`NodeCommissioningOptions`](../modules/export.md#nodecommissioningoptions) | #### Returns @@ -328,13 +376,13 @@ request or the passode did not match to any discovered device/address. #### Defined in -packages/matter.js/src/MatterController.ts:242 +[packages/matter.js/src/MatterController.ts:235](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L235) ___ ### commissionDevice -▸ `Private` **commissionDevice**(`paseSecureMessageChannel`): `Promise`<[`NodeId`](../modules/datatype_export.md#nodeid)\> +▸ `Private` **commissionDevice**(`paseSecureMessageChannel`, `commissioningOptions`): `Promise`<[`NodeId`](../modules/datatype_export.md#nodeid)\> Method to commission a device with a PASE secure channel. It returns the NodeId of the commissioned device on success. @@ -344,6 +392,7 @@ success. | Name | Type | | :------ | :------ | | `paseSecureMessageChannel` | [`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\> | +| `commissioningOptions` | [`CommissioningOptions`](../modules/protocol_export.md#commissioningoptions) | #### Returns @@ -351,59 +400,59 @@ success. #### Defined in -packages/matter.js/src/MatterController.ts:340 +[packages/matter.js/src/MatterController.ts:387](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L387) ___ -### commissionViaBle +### connect + +▸ **connect**(`peerNodeId`, `timeoutSeconds?`): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> -▸ **commissionViaBle**(`identifierData`, `passCode`, `timeoutSeconds?`): `Promise`<[`NodeId`](../modules/datatype_export.md#nodeid)\> +Connect to the device by opening a channel and creating a new CASE session if necessary. +Returns a InteractionClient on success. #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `identifierData` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | `undefined` | -| `passCode` | `number` | `undefined` | -| `timeoutSeconds` | `number` | `30` | +| Name | Type | +| :------ | :------ | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `timeoutSeconds?` | `number` | #### Returns -`Promise`<[`NodeId`](../modules/datatype_export.md#nodeid)\> +`Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> #### Defined in -packages/matter.js/src/MatterController.ts:198 +[packages/matter.js/src/MatterController.ts:637](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L637) ___ -### connect - -▸ **connect**(`nodeId`, `timeoutSeconds?`): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> +### connectOrDiscoverNode -Connect to the device by opening a channel and creating a new CASE session if necessary. -Returns a InteractionClient on success. +▸ `Private` **connectOrDiscoverNode**(`peerNodeId`, `operationalAddress?`, `timeoutSeconds?`): `Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> #### Parameters | Name | Type | | :------ | :------ | -| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `operationalAddress?` | [`ServerAddressIp`](../modules/common_export.md#serveraddressip) | | `timeoutSeconds?` | `number` | #### Returns -`Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> +`Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> #### Defined in -packages/matter.js/src/MatterController.ts:572 +[packages/matter.js/src/MatterController.ts:475](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L475) ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](session_export.SecureSession.md)<[`MatterController`](export._internal_.MatterController.md)\>\> +▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`): `Promise`<[`SecureSession`](session_export.SecureSession.md)<[`MatterController`](export._internal_.MatterController.md)\>\> #### Parameters @@ -417,8 +466,8 @@ ___ | `salt` | `Uint8Array` | | `isInitiator` | `boolean` | | `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `idleRetransmissionTimeoutMs?` | `number` | +| `activeRetransmissionTimeoutMs?` | `number` | #### Returns @@ -426,32 +475,27 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:600 +[packages/matter.js/src/MatterController.ts:662](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L662) ___ -### discoverDeviceAddressesByIdentifier - -▸ `Private` **discoverDeviceAddressesByIdentifier**(`scanner`, `identifier`, `timeoutSeconds?`): `Promise`<[`ServerAddress`](../modules/common_export.md#serveraddress)[]\> +### disconnect -Discovers devices by a provided identifier. It returns after the timeout or if at least one device was found. -The method returns a list of addresses of the discovered devices. +▸ **disconnect**(`nodeId`): `Promise`<`void`\> #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `scanner` | [`Scanner`](../interfaces/common_export.Scanner.md) | `undefined` | -| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | `undefined` | -| `timeoutSeconds` | `number` | `30` | +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns -`Promise`<[`ServerAddress`](../modules/common_export.md#serveraddress)[]\> +`Promise`<`void`\> #### Defined in -packages/matter.js/src/MatterController.ts:174 +[packages/matter.js/src/MatterController.ts:318](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L318) ___ @@ -471,63 +515,69 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:631 +[packages/matter.js/src/MatterController.ts:701](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L701) ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/src/MatterController.ts:652 +[packages/matter.js/src/MatterController.ts:722](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L722) ___ -### getFabric +### getCommissionedNodes -▸ **getFabric**(): [`Fabric`](fabric_export.Fabric.md) +▸ **getCommissionedNodes**(): [`NodeId`](../modules/datatype_export.md#nodeid)[] #### Returns -[`Fabric`](fabric_export.Fabric.md) +[`NodeId`](../modules/datatype_export.md#nodeid)[] #### Defined in -packages/matter.js/src/MatterController.ts:596 +[packages/matter.js/src/MatterController.ts:614](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L614) ___ -### getNextAvailableSessionId +### getLastOperationalAddress -▸ **getNextAvailableSessionId**(): `number` +▸ `Private` **getLastOperationalAddress**(`nodeId`): `undefined` \| [`ServerAddressIp`](../modules/common_export.md#serveraddressip) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns -`number` +`undefined` \| [`ServerAddressIp`](../modules/common_export.md#serveraddressip) #### Defined in -packages/matter.js/src/MatterController.ts:592 +[packages/matter.js/src/MatterController.ts:625](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L625) ___ -### getOperationalServerAddress +### getNextAvailableSessionId -▸ **getOperationalServerAddress**(): `undefined` \| [`ServerAddressIp`](../modules/common_export.md#serveraddressip) +▸ **getNextAvailableSessionId**(): `number` #### Returns -`undefined` \| [`ServerAddressIp`](../modules/common_export.md#serveraddressip) +`number` #### Defined in -packages/matter.js/src/MatterController.ts:564 +[packages/matter.js/src/MatterController.ts:658](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L658) ___ @@ -547,13 +597,13 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:627 +[packages/matter.js/src/MatterController.ts:697](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L697) ___ ### initializePaseSecureChannel -▸ `Private` **initializePaseSecureChannel**(`address`, `passCode`): `Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> +▸ `Private` **initializePaseSecureChannel**(`address`, `passcode`): `Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> Method to start commission process with a PASE pairing. If this not successful and throws an RetransmissionLimitReachedError the address is invalid or the passcode @@ -564,7 +614,7 @@ is wrong. | Name | Type | | :------ | :------ | | `address` | [`ServerAddress`](../modules/common_export.md#serveraddress) | -| `passCode` | `number` | +| `passcode` | `number` | #### Returns @@ -572,87 +622,91 @@ is wrong. #### Defined in -packages/matter.js/src/MatterController.ts:290 +[packages/matter.js/src/MatterController.ts:337](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L337) ___ ### isCommissioned -▸ **isCommissioned**(): ``false`` +▸ **isCommissioned**(): `boolean` #### Returns -``false`` +`boolean` #### Defined in -packages/matter.js/src/MatterController.ts:555 +[packages/matter.js/src/MatterController.ts:610](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L610) ___ -### iterateServerAddresses +### pair -▸ **iterateServerAddresses**<`SA`, `T`, `E`\>(`servers`, `errorType`, `updateNetworkInterfaceFunc`, `func`, `lastKnownServer?`): `Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> +▸ `Private` **pair**(`peerNodeId`, `operationalServerAddress`): `Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> -Helper method to iterate through a list of server addresses and try to execute a method on each of them. If the -method throws a configurable error (or EHOSTUNREACH), the server address list is updated (to also add later -discovered addresses or devices) and then next server address is tried.The result of the first successful method -call is returned. The logic makes sure to only try each unique address (IP/port) once. +Pair with an operational device (already commissioned) and establish a CASE session. -#### Type parameters +#### Parameters | Name | Type | | :------ | :------ | -| `SA` | extends [`ServerAddress`](../modules/common_export.md#serveraddress) | -| `T` | `T` | -| `E` | extends `Error` | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `operationalServerAddress` | [`ServerAddressIp`](../modules/common_export.md#serveraddressip) | + +#### Returns + +`Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> + +#### Defined in + +[packages/matter.js/src/MatterController.ts:565](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L565) + +___ + +### reconnectLastKnownAddress + +▸ `Private` **reconnectLastKnownAddress**(`peerNodeId`, `operationalAddress`): `Promise`<`undefined` \| [`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> #### Parameters | Name | Type | | :------ | :------ | -| `servers` | `SA`[] | -| `errorType` | [`ClassExtends`](../modules/util_export.md#classextends)<`E`\> | -| `updateNetworkInterfaceFunc` | () => `Promise`<`SA`[]\> | -| `func` | (`server`: `SA`) => `Promise`<`T`\> | -| `lastKnownServer?` | `SA` | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `operationalAddress` | [`ServerAddressIp`](../modules/common_export.md#serveraddressip) | #### Returns -`Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> +`Promise`<`undefined` \| [`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> #### Defined in -packages/matter.js/src/MatterController.ts:408 +[packages/matter.js/src/MatterController.ts:452](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L452) ___ -### pair - -▸ **pair**(`peerNodeId`, `operationalServerAddress`): `Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> +### removeNode -Pair with an operational device (already commissioned) and establish a CASE session. +▸ **removeNode**(`nodeId`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | -| `operationalServerAddress` | [`ServerAddressIp`](../modules/common_export.md#serveraddressip) | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns -`Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> +`Promise`<`void`\> #### Defined in -packages/matter.js/src/MatterController.ts:510 +[packages/matter.js/src/MatterController.ts:323](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L323) ___ ### resume -▸ **resume**(`peerNodeId`, `timeoutSeconds?`): `Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> +▸ `Private` **resume**(`peerNodeId`, `timeoutSeconds?`): `Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<[`MatterController`](export._internal_.MatterController.md)\>\> Resume a device connection and establish a CASE session that was previously paired with the controller. This method will try to connect to the device using the previously used server address (if set). If that fails, the @@ -661,10 +715,10 @@ It returns the operational MessageChannel on success. #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | `undefined` | -| `timeoutSeconds` | `number` | `60` | +| Name | Type | +| :------ | :------ | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `timeoutSeconds?` | `number` | #### Returns @@ -672,7 +726,7 @@ It returns the operational MessageChannel on success. #### Defined in -packages/matter.js/src/MatterController.ts:469 +[packages/matter.js/src/MatterController.ts:546](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L546) ___ @@ -692,19 +746,34 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:635 +[packages/matter.js/src/MatterController.ts:705](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L705) ___ ### setOperationalServerAddress -▸ **setOperationalServerAddress**(`address`): `void` +▸ `Private` **setOperationalServerAddress**(`nodeId`, `operationalServerAddress`): `void` #### Parameters | Name | Type | | :------ | :------ | -| `address` | [`ServerAddressIp`](../modules/common_export.md#serveraddressip) | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `operationalServerAddress` | [`ServerAddressIp`](../modules/common_export.md#serveraddressip) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/MatterController.ts:618](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L618) + +___ + +### storeCommisionedNodes + +▸ `Private` **storeCommisionedNodes**(): `void` #### Returns @@ -712,25 +781,26 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:559 +[packages/matter.js/src/MatterController.ts:629](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L629) ___ ### create -▸ `Static` **create**(`scanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `storage`, `operationalServerAddress?`, `commissioningOptions?`, `sessionClosedCallback?`): `Promise`<[`MatterController`](export._internal_.MatterController.md)\> +▸ `Static` **create**(`scanner`, `netInterfaceIpv4`, `netInterfaceIpv6`, `storage`, `sessionClosedCallback?`, `adminVendorId?`, `adminFabricId?`, `adminFabricIndex?`): `Promise`<[`MatterController`](export._internal_.MatterController.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `scanner` | [`Scanner`](../interfaces/common_export.Scanner.md) | +| `scanner` | [`MdnsScanner`](mdns_export.MdnsScanner.md) | | `netInterfaceIpv4` | `undefined` \| [`NetInterface`](../interfaces/net_export.NetInterface.md) | | `netInterfaceIpv6` | [`NetInterface`](../interfaces/net_export.NetInterface.md) | | `storage` | [`StorageContext`](storage_export.StorageContext.md) | -| `operationalServerAddress?` | [`ServerAddressIp`](../modules/common_export.md#serveraddressip) | -| `commissioningOptions?` | [`CommissioningOptions`](../modules/protocol_export.md#commissioningoptions) | | `sessionClosedCallback?` | (`peerNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid)) => `void` | +| `adminVendorId` | [`VendorId`](../modules/datatype_export.md#vendorid) | +| `adminFabricId` | [`FabricId`](../modules/datatype_export.md#fabricid) | +| `adminFabricIndex` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | #### Returns @@ -738,4 +808,4 @@ ___ #### Defined in -packages/matter.js/src/MatterController.ts:71 +[packages/matter.js/src/MatterController.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L82) diff --git a/docs/matter.js/classes/export._internal_.MatterDevice.md b/docs/matter.js/classes/export._internal_.MatterDevice.md index 2f71ec4abd..d1fc168803 100644 --- a/docs/matter.js/classes/export._internal_.MatterDevice.md +++ b/docs/matter.js/classes/export._internal_.MatterDevice.md @@ -18,18 +18,19 @@ - [announcementStartedTime](export._internal_.MatterDevice.md#announcementstartedtime) - [broadcasters](export._internal_.MatterDevice.md#broadcasters) - [channelManager](export._internal_.MatterDevice.md#channelmanager) +- [commissioningChangedCallback](export._internal_.MatterDevice.md#commissioningchangedcallback) - [deviceName](export._internal_.MatterDevice.md#devicename) - [deviceType](export._internal_.MatterDevice.md#devicetype) - [discriminator](export._internal_.MatterDevice.md#discriminator) - [exchangeManager](export._internal_.MatterDevice.md#exchangemanager) - [fabricManager](export._internal_.MatterDevice.md#fabricmanager) - [failSafeContext](export._internal_.MatterDevice.md#failsafecontext) -- [initialCommissioningCallback](export._internal_.MatterDevice.md#initialcommissioningcallback) - [initialPasscode](export._internal_.MatterDevice.md#initialpasscode) - [isClosing](export._internal_.MatterDevice.md#isclosing) - [productId](export._internal_.MatterDevice.md#productid) - [scanners](export._internal_.MatterDevice.md#scanners) - [secureChannelProtocol](export._internal_.MatterDevice.md#securechannelprotocol) +- [sessionChangedCallback](export._internal_.MatterDevice.md#sessionchangedcallback) - [sessionManager](export._internal_.MatterDevice.md#sessionmanager) - [storage](export._internal_.MatterDevice.md#storage) - [transportInterfaces](export._internal_.MatterDevice.md#transportinterfaces) @@ -48,7 +49,6 @@ - [announceAsCommissionable](export._internal_.MatterDevice.md#announceascommissionable) - [armFailSafe](export._internal_.MatterDevice.md#armfailsafe) - [assertFailSafeArmed](export._internal_.MatterDevice.md#assertfailsafearmed) -- [closeSession](export._internal_.MatterDevice.md#closesession) - [completeCommission](export._internal_.MatterDevice.md#completecommission) - [createSecureSession](export._internal_.MatterDevice.md#createsecuresession) - [endCommissioning](export._internal_.MatterDevice.md#endcommissioning) @@ -63,10 +63,11 @@ - [getFailSafeContext](export._internal_.MatterDevice.md#getfailsafecontext) - [getNextAvailableSessionId](export._internal_.MatterDevice.md#getnextavailablesessionid) - [getNextFabricIndex](export._internal_.MatterDevice.md#getnextfabricindex) +- [hasBroadcaster](export._internal_.MatterDevice.md#hasbroadcaster) +- [hasProtocolHandler](export._internal_.MatterDevice.md#hasprotocolhandler) - [initiateExchange](export._internal_.MatterDevice.md#initiateexchange) - [isCommissioned](export._internal_.MatterDevice.md#iscommissioned) - [isFailsafeArmed](export._internal_.MatterDevice.md#isfailsafearmed) -- [processSessionsToClose](export._internal_.MatterDevice.md#processsessionstoclose) - [removePaseSession](export._internal_.MatterDevice.md#removepasesession) - [saveResumptionRecord](export._internal_.MatterDevice.md#saveresumptionrecord) - [sendCommissionableAnnouncement](export._internal_.MatterDevice.md#sendcommissionableannouncement) @@ -80,7 +81,7 @@ ### constructor -• **new MatterDevice**(`deviceName`, `deviceType`, `vendorId`, `productId`, `discriminator`, `initialPasscode`, `storage`, `initialCommissioningCallback`) +• **new MatterDevice**(`deviceName`, `deviceType`, `vendorId`, `productId`, `discriminator`, `initialPasscode`, `storage`, `commissioningChangedCallback`, `sessionChangedCallback`) #### Parameters @@ -93,11 +94,12 @@ | `discriminator` | `number` | | `initialPasscode` | `number` | | `storage` | [`StorageContext`](storage_export.StorageContext.md) | -| `initialCommissioningCallback` | () => `void` | +| `commissioningChangedCallback` | (`fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex)) => `void` | +| `sessionChangedCallback` | (`fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex)) => `void` | #### Defined in -packages/matter.js/src/MatterDevice.ts:73 +[packages/matter.js/src/MatterDevice.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L71) ## Properties @@ -115,7 +117,7 @@ packages/matter.js/src/MatterDevice.ts:73 #### Defined in -packages/matter.js/src/MatterDevice.ts:67 +[packages/matter.js/src/MatterDevice.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L65) ___ @@ -125,7 +127,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:66 +[packages/matter.js/src/MatterDevice.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L64) ___ @@ -135,7 +137,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:68 +[packages/matter.js/src/MatterDevice.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L66) ___ @@ -145,7 +147,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:69 +[packages/matter.js/src/MatterDevice.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L67) ___ @@ -155,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:59 +[packages/matter.js/src/MatterDevice.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L57) ___ @@ -165,7 +167,31 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:63 +[packages/matter.js/src/MatterDevice.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L61) + +___ + +### commissioningChangedCallback + +• `Private` `Readonly` **commissioningChangedCallback**: (`fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex)) => `void` + +#### Type declaration + +▸ (`fabricIndex`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `fabricIndex` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | + +##### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/MatterDevice.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L79) ___ @@ -175,7 +201,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:74 +[packages/matter.js/src/MatterDevice.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L72) ___ @@ -185,7 +211,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:75 +[packages/matter.js/src/MatterDevice.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L73) ___ @@ -195,7 +221,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:78 +[packages/matter.js/src/MatterDevice.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L76) ___ @@ -205,7 +231,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:64 +[packages/matter.js/src/MatterDevice.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L62) ___ @@ -215,7 +241,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:61 +[packages/matter.js/src/MatterDevice.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L59) ___ @@ -225,25 +251,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:71 - -___ - -### initialCommissioningCallback - -• `Private` `Readonly` **initialCommissioningCallback**: () => `void` - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -packages/matter.js/src/MatterDevice.ts:81 +[packages/matter.js/src/MatterDevice.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L69) ___ @@ -253,7 +261,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:79 +[packages/matter.js/src/MatterDevice.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L77) ___ @@ -263,7 +271,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:70 +[packages/matter.js/src/MatterDevice.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L68) ___ @@ -273,7 +281,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:77 +[packages/matter.js/src/MatterDevice.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L75) ___ @@ -283,7 +291,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:58 +[packages/matter.js/src/MatterDevice.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L56) ___ @@ -293,7 +301,31 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:65 +[packages/matter.js/src/MatterDevice.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L63) + +___ + +### sessionChangedCallback + +• `Private` `Readonly` **sessionChangedCallback**: (`fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex)) => `void` + +#### Type declaration + +▸ (`fabricIndex`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `fabricIndex` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | + +##### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/MatterDevice.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L80) ___ @@ -303,7 +335,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:62 +[packages/matter.js/src/MatterDevice.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L60) ___ @@ -313,7 +345,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:80 +[packages/matter.js/src/MatterDevice.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L78) ___ @@ -323,7 +355,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:60 +[packages/matter.js/src/MatterDevice.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L58) ___ @@ -333,7 +365,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:76 +[packages/matter.js/src/MatterDevice.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L74) ## Methods @@ -353,7 +385,7 @@ packages/matter.js/src/MatterDevice.ts:76 #### Defined in -packages/matter.js/src/MatterDevice.ts:100 +[packages/matter.js/src/MatterDevice.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L107) ___ @@ -373,7 +405,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:271 +[packages/matter.js/src/MatterDevice.ts:299](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L299) ___ @@ -393,7 +425,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:111 +[packages/matter.js/src/MatterDevice.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L122) ___ @@ -413,7 +445,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:95 +[packages/matter.js/src/MatterDevice.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L98) ___ @@ -433,7 +465,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:105 +[packages/matter.js/src/MatterDevice.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L112) ___ @@ -453,7 +485,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:529 +[packages/matter.js/src/MatterDevice.ts:524](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L524) ___ @@ -475,7 +507,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:510 +[packages/matter.js/src/MatterDevice.ts:505](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L505) ___ @@ -495,7 +527,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:130 +[packages/matter.js/src/MatterDevice.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L141) ___ @@ -517,7 +549,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:185 +[packages/matter.js/src/MatterDevice.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L190) ___ @@ -540,7 +572,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:441 +[packages/matter.js/src/MatterDevice.ts:436](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L436) ___ @@ -560,27 +592,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:351 - -___ - -### closeSession - -▸ `Private` **closeSession**(`session`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `session` | [`SecureSession`](session_export.SecureSession.md)<`any`\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -packages/matter.js/src/MatterDevice.ts:329 +[packages/matter.js/src/MatterDevice.ts:346](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L346) ___ @@ -594,13 +606,13 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:484 +[packages/matter.js/src/MatterDevice.ts:479](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L479) ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](session_export.SecureSession.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\>\> +▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`): `Promise`<[`SecureSession`](session_export.SecureSession.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\>\> #### Parameters @@ -614,8 +626,8 @@ ___ | `salt` | `Uint8Array` | | `isInitiator` | `boolean` | | `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `idleRetransmissionTimeoutMs?` | `number` | +| `activeRetransmissionTimeoutMs?` | `number` | #### Returns @@ -623,7 +635,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:229 +[packages/matter.js/src/MatterDevice.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L234) ___ @@ -637,7 +649,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:549 +[packages/matter.js/src/MatterDevice.ts:544](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L544) ___ @@ -651,7 +663,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:571 +[packages/matter.js/src/MatterDevice.ts:567](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L567) ___ @@ -665,7 +677,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:359 +[packages/matter.js/src/MatterDevice.ts:354](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L354) ___ @@ -687,7 +699,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:575 +[packages/matter.js/src/MatterDevice.ts:571](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L571) ___ @@ -708,7 +720,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:258 +[packages/matter.js/src/MatterDevice.ts:285](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L285) ___ @@ -728,21 +740,21 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:305 +[packages/matter.js/src/MatterDevice.ts:331](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L331) ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/src/MatterDevice.ts:611 +[packages/matter.js/src/MatterDevice.ts:607](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L607) ___ @@ -762,7 +774,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:297 +[packages/matter.js/src/MatterDevice.ts:323](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L323) ___ @@ -776,7 +788,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:480 +[packages/matter.js/src/MatterDevice.ts:475](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L475) ___ @@ -790,7 +802,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:475 +[packages/matter.js/src/MatterDevice.ts:470](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L470) ___ @@ -804,7 +816,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:225 +[packages/matter.js/src/MatterDevice.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L230) ___ @@ -818,35 +830,39 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:267 +[packages/matter.js/src/MatterDevice.ts:295](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L295) ___ -### initiateExchange +### hasBroadcaster -▸ **initiateExchange**(`fabric`, `nodeId`, `protocolId`): [`MessageExchange`](protocol_export.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> +▸ **hasBroadcaster**(`broadcaster`): `boolean` #### Parameters | Name | Type | | :------ | :------ | -| `fabric` | [`Fabric`](fabric_export.Fabric.md) | -| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | -| `protocolId` | `number` | +| `broadcaster` | [`InstanceBroadcaster`](../interfaces/common_export.InstanceBroadcaster.md) | #### Returns -[`MessageExchange`](protocol_export.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> +`boolean` #### Defined in -packages/matter.js/src/MatterDevice.ts:301 +[packages/matter.js/src/MatterDevice.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L103) ___ -### isCommissioned +### hasProtocolHandler -▸ **isCommissioned**(): `boolean` +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | #### Returns @@ -854,13 +870,35 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:506 +[packages/matter.js/src/MatterDevice.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L118) ___ -### isFailsafeArmed +### initiateExchange -▸ **isFailsafeArmed**(): `boolean` +▸ **initiateExchange**(`fabric`, `nodeId`, `protocolId`): [`MessageExchange`](protocol_export.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](fabric_export.Fabric.md) | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `protocolId` | `number` | + +#### Returns + +[`MessageExchange`](protocol_export.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> + +#### Defined in + +[packages/matter.js/src/MatterDevice.ts:327](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L327) + +___ + +### isCommissioned + +▸ **isCommissioned**(): `boolean` #### Returns @@ -868,21 +906,21 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:471 +[packages/matter.js/src/MatterDevice.ts:501](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L501) ___ -### processSessionsToClose +### isFailsafeArmed -▸ **processSessionsToClose**(): `Promise`<`void`\> +▸ **isFailsafeArmed**(): `boolean` #### Returns -`Promise`<`void`\> +`boolean` #### Defined in -packages/matter.js/src/MatterDevice.ts:322 +[packages/matter.js/src/MatterDevice.ts:466](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L466) ___ @@ -896,7 +934,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:313 +[packages/matter.js/src/MatterDevice.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L339) ___ @@ -916,7 +954,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:309 +[packages/matter.js/src/MatterDevice.ts:335](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L335) ___ @@ -937,7 +975,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:206 +[packages/matter.js/src/MatterDevice.ts:211](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L211) ___ @@ -958,7 +996,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:290 +[packages/matter.js/src/MatterDevice.ts:316](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L316) ___ @@ -972,7 +1010,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:116 +[packages/matter.js/src/MatterDevice.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L127) ___ @@ -986,7 +1024,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:120 +[packages/matter.js/src/MatterDevice.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L131) ___ @@ -1000,7 +1038,7 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:593 +[packages/matter.js/src/MatterDevice.ts:589](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L589) ___ @@ -1020,4 +1058,4 @@ ___ #### Defined in -packages/matter.js/src/MatterDevice.ts:262 +[packages/matter.js/src/MatterDevice.ts:289](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterDevice.ts#L289) diff --git a/docs/matter.js/classes/export._internal_.MdnsInstanceBroadcaster.md b/docs/matter.js/classes/export._internal_.MdnsInstanceBroadcaster.md index 813cd0c907..852943738f 100644 --- a/docs/matter.js/classes/export._internal_.MdnsInstanceBroadcaster.md +++ b/docs/matter.js/classes/export._internal_.MdnsInstanceBroadcaster.md @@ -46,7 +46,7 @@ This class is handing MDNS Announcements for one instance of a device aka "port" #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:19 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L19) ## Properties @@ -56,7 +56,7 @@ packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:19 #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:20 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L20) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:21 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L21) ## Methods @@ -86,7 +86,7 @@ Send out announcements for this instance. #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:41 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L41) ___ @@ -106,7 +106,7 @@ Expire all announcements. #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:53 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L53) ___ @@ -126,7 +126,7 @@ Expire the announcement for this commissioning instance. #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:49 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L49) ___ @@ -146,7 +146,7 @@ Expire the announcement for this operative instance. #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:45 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L45) ___ @@ -173,7 +173,7 @@ Set a commissionable mode and details to announce a commissionable device. #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:24 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L24) ___ @@ -199,7 +199,7 @@ Set the Broadcaster data to announce a Commissioner (aka Commissioner discovery) #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:37 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L37) ___ @@ -226,4 +226,4 @@ Set the Broadcaster Data to announce a device for operative discovery (aka "alre #### Defined in -packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:29 +[packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsInstanceBroadcaster.ts#L29) diff --git a/docs/matter.js/classes/export._internal_.ModelTraversal-1.md b/docs/matter.js/classes/export._internal_.ModelTraversal-1.md new file mode 100644 index 0000000000..3deb19adfb --- /dev/null +++ b/docs/matter.js/classes/export._internal_.ModelTraversal-1.md @@ -0,0 +1,631 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [export](../modules/export.md) / [](../modules/export._internal_.md) / ModelTraversal + +# Class: ModelTraversal + +[export](../modules/export.md).[](../modules/export._internal_.md).ModelTraversal + +This class performs lookups of models in the scope of a specific model. We +use a class so the lookup can maintain state and guard against circular +references. + +Any logic that requires traversal of a multi-model ownership or inheritance +should use this class. + +Note that we don't currently utilize any kind of index when we perform +search. Not currently a problem but may need to address if it becomes too +inefficient. + +## Table of contents + +### Constructors + +- [constructor](export._internal_.ModelTraversal-1.md#constructor) + +### Properties + +- [dismissed](export._internal_.ModelTraversal-1.md#dismissed) +- [operationDepth](export._internal_.ModelTraversal-1.md#operationdepth) + +### Methods + +- [findAspect](export._internal_.ModelTraversal-1.md#findaspect) +- [findBase](export._internal_.ModelTraversal-1.md#findbase) +- [findBitDefinition](export._internal_.ModelTraversal-1.md#findbitdefinition) +- [findConstraint](export._internal_.ModelTraversal-1.md#findconstraint) +- [findDefiningModel](export._internal_.ModelTraversal-1.md#finddefiningmodel) +- [findGlobalBase](export._internal_.ModelTraversal-1.md#findglobalbase) +- [findLocal](export._internal_.ModelTraversal-1.md#findlocal) +- [findMember](export._internal_.ModelTraversal-1.md#findmember) +- [findMembers](export._internal_.ModelTraversal-1.md#findmembers) +- [findMetabase](export._internal_.ModelTraversal-1.md#findmetabase) +- [findOwner](export._internal_.ModelTraversal-1.md#findowner) +- [findReferences](export._internal_.ModelTraversal-1.md#findreferences) +- [findResponse](export._internal_.ModelTraversal-1.md#findresponse) +- [findRoot](export._internal_.ModelTraversal-1.md#findroot) +- [findShadow](export._internal_.ModelTraversal-1.md#findshadow) +- [findType](export._internal_.ModelTraversal-1.md#findtype) +- [findXref](export._internal_.ModelTraversal-1.md#findxref) +- [getTypeName](export._internal_.ModelTraversal-1.md#gettypename) +- [instanceOf](export._internal_.ModelTraversal-1.md#instanceof) +- [operation](export._internal_.ModelTraversal-1.md#operation) +- [operationWithDismissal](export._internal_.ModelTraversal-1.md#operationwithdismissal) +- [visit](export._internal_.ModelTraversal-1.md#visit) +- [visitInheritance](export._internal_.ModelTraversal-1.md#visitinheritance) + +## Constructors + +### constructor + +• **new ModelTraversal**() + +## Properties + +### dismissed + +• `Private` `Optional` **dismissed**: `Set`<[`Model`](model.Model-1.md)\> + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L29) + +___ + +### operationDepth + +• `Private` **operationDepth**: `number` = `0` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L28) + +## Methods + +### findAspect + +▸ **findAspect**(`model`, `symbol`): `undefined` \| [`Aspect`](model.Aspect.md)<`any`\> + +Get an aspect that reflects extension of any shadowed aspects. Note +that this searches parent's inheritance and the model's inheritance. +This is because aspects can be inherited by overriding an element in +the parent or by direct type inheritance. Aspects in shadowed elements +take priority as they are presumably more specific. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | +| `symbol` | `symbol` | + +#### Returns + +`undefined` \| [`Aspect`](model.Aspect.md)<`any`\> + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L264) + +___ + +### findBase + +▸ **findBase**(`model`): `undefined` \| [`Model`](model.Model-1.md) + +Find the model a model derives from, if any. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L138) + +___ + +### findBitDefinition + +▸ **findBitDefinition**(`scope`, `bit`): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Search inherited scope for a bit definition. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `undefined` \| [`Model`](model.Model-1.md) | +| `bit` | `number` | + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:387](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L387) + +___ + +### findConstraint + +▸ **findConstraint**(`model`, `symbol`, `field?`): `undefined` \| [`Constraint`](model.Constraint-1.md) + +Constraint aspects are specialized because we infer constraint fields +that are referenced in other models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | [`ValueModel`](model.ValueModel.md) | +| `symbol` | `symbol` | +| `field?` | ``"max"`` \| ``"min"`` \| ``"value"`` | + +#### Returns + +`undefined` \| [`Constraint`](model.Constraint-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:298](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L298) + +___ + +### findDefiningModel + +▸ **findDefiningModel**(`model`): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Find the model this model derives from that has children, if any. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`ValueModel`](model.ValueModel.md) | + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L216) + +___ + +### findGlobalBase + +▸ **findGlobalBase**(`model`): `undefined` \| [`Model`](model.Model-1.md) + +Find the first global model this model derives from, if any. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L160) + +___ + +### findLocal + +▸ `Private` **findLocal**(`scope`, `key`, `allowedTags`): `undefined` \| [`Model`](model.Model-1.md) + +Search for a direct child by name. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | [`Model`](model.Model-1.md) | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:551](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L551) + +___ + +### findMember + +▸ **findMember**(`scope`, `key`, `allowedTags`): `undefined` \| [`Model`](model.Model-1.md) + +Search inherited scope for a named member. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `undefined` \| [`Model`](model.Model-1.md) | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:351](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L351) + +___ + +### findMembers + +▸ **findMembers**(`scope`, `allowedTags`): [`Model`](model.Model-1.md)[] + +Retrieve all children of a specific type, inherited or otherwise. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | [`Model`](model.Model-1.md) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:370](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L370) + +___ + +### findMetabase + +▸ **findMetabase**(`model`): `undefined` \| [`Model`](model.Model-1.md) + +Find the model in my inheritance hierarchy that has semantic meaning. +This will be the first inherited model with a metatype. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L126) + +___ + +### findOwner + +▸ **findOwner**<`T`\>(`constructor`, `model`): `undefined` \| `T` + +Find an owning model of a specific type. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`undefined` \| `T` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:490](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L490) + +___ + +### findReferences + +▸ **findReferences**(`scope`, `type`): [`Model`](model.Model-1.md)[] + +Find all children of a node that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `undefined` \| [`Model`](model.Model-1.md) | +| `type` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:453](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L453) + +___ + +### findResponse + +▸ **findResponse**(`command`): `undefined` \| [`Model`](model.Model-1.md) + +Find the response model for a command. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `command` | [`CommandModel`](model.CommandModel.md) | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:444](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L444) + +___ + +### findRoot + +▸ **findRoot**(`model`): `undefined` \| [`Model`](model.Model-1.md) + +Find the root model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:503](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L503) + +___ + +### findShadow + +▸ **findShadow**(`model`): `undefined` \| [`Model`](model.Model-1.md) + +Find a child in the parent's inheritance hierarchy with the same tag +and ID/name. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L234) + +___ + +### findType + +▸ **findType**(`scope`, `name`, `tag`): `undefined` \| [`Model`](model.Model-1.md) + +Search inherited and structural type scope for a named type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scope` | `undefined` \| [`Model`](model.Model-1.md) | +| `name` | `string` | +| `tag` | [`ElementTag`](../enums/model.ElementTag.md) | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:413](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L413) + +___ + +### findXref + +▸ **findXref**(`model`): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +Find an xref from this model or a parent. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:201](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L201) + +___ + +### getTypeName + +▸ **getTypeName**(`model`): `undefined` \| `string` + +Determine the type for a model. This is the string name of the base +model. Usually this is simply the type field but we infer the type of +some datatypes based on their parent's type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L68) + +___ + +### instanceOf + +▸ **instanceOf**(`model`, `other`): `boolean` + +Determine whether this model derives from another. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | +| `other` | `undefined` \| [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L179) + +___ + +### operation + +▸ **operation**<`T`\>(`operator`, `toDismiss?`): `T` + +Perform an operation with iteration tracking. If iteration depth limit + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operator` | () => `T` | +| `toDismiss?` | [`Model`](model.Model-1.md) | + +#### Returns + +`T` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L34) + +___ + +### operationWithDismissal + +▸ **operationWithDismissal**<`T`\>(`toDismiss`, `operator`): `T` + +Perform an operation with a model dismissed from consideration for type +lookup. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `toDismiss` | `undefined` \| [`Model`](model.Model-1.md) | +| `operator` | () => `T` | + +#### Returns + +`T` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L59) + +___ + +### visit + +▸ **visit**(`model`, `visitor`): `undefined` \| `boolean` + +Visit all nodes in the model tree. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | [`Model`](model.Model-1.md) | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:518](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L518) + +___ + +### visitInheritance + +▸ **visitInheritance**(`model`, `visitor`): `undefined` \| `boolean` + +Visit all nodes in the inheritance hierarchy until the visitor returns false. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | `undefined` \| [`Model`](model.Model-1.md) | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:535](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L535) diff --git a/docs/matter.js/classes/export._internal_.QrPairingCodeSchema.md b/docs/matter.js/classes/export._internal_.QrPairingCodeSchema.md index 29b799f55a..1378f774e1 100644 --- a/docs/matter.js/classes/export._internal_.QrPairingCodeSchema.md +++ b/docs/matter.js/classes/export._internal_.QrPairingCodeSchema.md @@ -61,7 +61,7 @@ Decodes the encoded data using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:65 +[packages/matter.js/src/schema/PairingCodeSchema.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L66) ___ @@ -111,7 +111,7 @@ Encodes the value using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:61 +[packages/matter.js/src/schema/PairingCodeSchema.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L62) ___ @@ -161,4 +161,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/export._internal_.UdpConnection.md b/docs/matter.js/classes/export._internal_.UdpConnection.md index f977c056ca..56ca3db462 100644 --- a/docs/matter.js/classes/export._internal_.UdpConnection.md +++ b/docs/matter.js/classes/export._internal_.UdpConnection.md @@ -50,7 +50,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/net/UdpInterface.ts:43 +[packages/matter.js/src/net/UdpInterface.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L43) ## Properties @@ -60,7 +60,7 @@ packages/matter.js/src/net/UdpInterface.ts:43 #### Defined in -packages/matter.js/src/net/UdpInterface.ts:45 +[packages/matter.js/src/net/UdpInterface.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L45) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpInterface.ts:46 +[packages/matter.js/src/net/UdpInterface.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L46) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpInterface.ts:44 +[packages/matter.js/src/net/UdpInterface.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L44) ## Accessors @@ -98,7 +98,7 @@ packages/matter.js/src/net/UdpInterface.ts:44 #### Defined in -packages/matter.js/src/net/UdpInterface.ts:53 +[packages/matter.js/src/net/UdpInterface.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L53) ## Methods @@ -116,7 +116,7 @@ packages/matter.js/src/net/UdpInterface.ts:53 #### Defined in -packages/matter.js/src/net/UdpInterface.ts:57 +[packages/matter.js/src/net/UdpInterface.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L57) ___ @@ -140,4 +140,4 @@ ___ #### Defined in -packages/matter.js/src/net/UdpInterface.ts:49 +[packages/matter.js/src/net/UdpInterface.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L49) diff --git a/docs/matter.js/classes/fabric_export.Fabric.md b/docs/matter.js/classes/fabric_export.Fabric.md index 976ff410f5..eb621d0bf6 100644 --- a/docs/matter.js/classes/fabric_export.Fabric.md +++ b/docs/matter.js/classes/fabric_export.Fabric.md @@ -84,7 +84,7 @@ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:57 +[packages/matter.js/src/fabric/Fabric.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L57) ## Properties @@ -94,7 +94,7 @@ packages/matter.js/src/fabric/Fabric.ts:57 #### Defined in -packages/matter.js/src/fabric/Fabric.ts:59 +[packages/matter.js/src/fabric/Fabric.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L59) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:58 +[packages/matter.js/src/fabric/Fabric.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L58) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:67 +[packages/matter.js/src/fabric/Fabric.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L67) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:69 +[packages/matter.js/src/fabric/Fabric.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L69) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:64 +[packages/matter.js/src/fabric/Fabric.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L64) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:71 +[packages/matter.js/src/fabric/Fabric.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L71) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:60 +[packages/matter.js/src/fabric/Fabric.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L60) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:70 +[packages/matter.js/src/fabric/Fabric.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L70) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:62 +[packages/matter.js/src/fabric/Fabric.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L62) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:68 +[packages/matter.js/src/fabric/Fabric.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L68) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:55 +[packages/matter.js/src/fabric/Fabric.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L55) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:54 +[packages/matter.js/src/fabric/Fabric.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L54) ___ @@ -214,7 +214,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:66 +[packages/matter.js/src/fabric/Fabric.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L66) ___ @@ -224,7 +224,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:61 +[packages/matter.js/src/fabric/Fabric.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L61) ___ @@ -234,7 +234,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:63 +[packages/matter.js/src/fabric/Fabric.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L63) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:65 +[packages/matter.js/src/fabric/Fabric.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L65) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:52 +[packages/matter.js/src/fabric/Fabric.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L52) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:50 +[packages/matter.js/src/fabric/Fabric.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L50) ## Methods @@ -284,7 +284,7 @@ packages/matter.js/src/fabric/Fabric.ts:50 #### Defined in -packages/matter.js/src/fabric/Fabric.ts:158 +[packages/matter.js/src/fabric/Fabric.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L158) ___ @@ -304,7 +304,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:147 +[packages/matter.js/src/fabric/Fabric.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L147) ___ @@ -324,7 +324,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:162 +[packages/matter.js/src/fabric/Fabric.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L162) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:212 +[packages/matter.js/src/fabric/Fabric.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L212) ___ @@ -365,7 +365,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:200 +[packages/matter.js/src/fabric/Fabric.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L200) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:138 +[packages/matter.js/src/fabric/Fabric.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L138) ___ @@ -401,6 +401,7 @@ ___ | Name | Type | | :------ | :------ | | `fabricId` | [`FabricId`](../modules/datatype_export.md#fabricid) | +| `fabricIndex` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | | `label` | `string` | | `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | | `rootNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | @@ -408,7 +409,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:224 +[packages/matter.js/src/fabric/Fabric.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L224) ___ @@ -422,7 +423,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:121 +[packages/matter.js/src/fabric/Fabric.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L121) ___ @@ -442,7 +443,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:217 +[packages/matter.js/src/fabric/Fabric.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L217) ___ @@ -469,7 +470,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:184 +[packages/matter.js/src/fabric/Fabric.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L184) ___ @@ -490,7 +491,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:208 +[packages/matter.js/src/fabric/Fabric.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L208) ___ @@ -511,7 +512,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:134 +[packages/matter.js/src/fabric/Fabric.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L134) ___ @@ -525,13 +526,19 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:180 +[packages/matter.js/src/fabric/Fabric.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L180) ___ ### remove -▸ **remove**(): `Promise`<`void`\> +▸ **remove**(`currentSessionId?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `currentSessionId?` | `number` | #### Returns @@ -539,7 +546,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:173 +[packages/matter.js/src/fabric/Fabric.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L173) ___ @@ -559,7 +566,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:151 +[packages/matter.js/src/fabric/Fabric.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L151) ___ @@ -579,7 +586,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:116 +[packages/matter.js/src/fabric/Fabric.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L116) ___ @@ -599,7 +606,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:169 +[packages/matter.js/src/fabric/Fabric.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L169) ___ @@ -627,7 +634,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:192 +[packages/matter.js/src/fabric/Fabric.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L192) ___ @@ -647,7 +654,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:125 +[packages/matter.js/src/fabric/Fabric.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L125) ___ @@ -661,7 +668,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:77 +[packages/matter.js/src/fabric/Fabric.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L77) ___ @@ -682,7 +689,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:129 +[packages/matter.js/src/fabric/Fabric.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L129) ___ @@ -702,4 +709,4 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:97 +[packages/matter.js/src/fabric/Fabric.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L97) diff --git a/docs/matter.js/classes/fabric_export.FabricBuilder.md b/docs/matter.js/classes/fabric_export.FabricBuilder.md index 260d3c3207..c85f43c878 100644 --- a/docs/matter.js/classes/fabric_export.FabricBuilder.md +++ b/docs/matter.js/classes/fabric_export.FabricBuilder.md @@ -57,7 +57,7 @@ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:241 +[packages/matter.js/src/fabric/Fabric.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L242) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:246 +[packages/matter.js/src/fabric/Fabric.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L247) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:245 +[packages/matter.js/src/fabric/Fabric.ts:246](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L246) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:239 +[packages/matter.js/src/fabric/Fabric.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L240) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:236 +[packages/matter.js/src/fabric/Fabric.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L237) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:247 +[packages/matter.js/src/fabric/Fabric.ts:248](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L248) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:242 +[packages/matter.js/src/fabric/Fabric.ts:243](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L243) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:240 +[packages/matter.js/src/fabric/Fabric.ts:241](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L241) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:238 +[packages/matter.js/src/fabric/Fabric.ts:239](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L239) ___ @@ -147,7 +147,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:243 +[packages/matter.js/src/fabric/Fabric.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L244) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:244 +[packages/matter.js/src/fabric/Fabric.ts:245](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L245) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:237 +[packages/matter.js/src/fabric/Fabric.ts:238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L238) ## Methods @@ -187,7 +187,7 @@ packages/matter.js/src/fabric/Fabric.ts:237 #### Defined in -packages/matter.js/src/fabric/Fabric.ts:326 +[packages/matter.js/src/fabric/Fabric.ts:327](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L327) ___ @@ -201,7 +201,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:257 +[packages/matter.js/src/fabric/Fabric.ts:258](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L258) ___ @@ -215,7 +215,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:322 +[packages/matter.js/src/fabric/Fabric.ts:323](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L323) ___ @@ -229,7 +229,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:253 +[packages/matter.js/src/fabric/Fabric.ts:254](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L254) ___ @@ -243,7 +243,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:318 +[packages/matter.js/src/fabric/Fabric.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L319) ___ @@ -257,7 +257,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:249 +[packages/matter.js/src/fabric/Fabric.ts:250](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L250) ___ @@ -271,7 +271,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:267 +[packages/matter.js/src/fabric/Fabric.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L268) ___ @@ -291,7 +291,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:302 +[packages/matter.js/src/fabric/Fabric.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L303) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:311 +[packages/matter.js/src/fabric/Fabric.ts:312](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L312) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:297 +[packages/matter.js/src/fabric/Fabric.ts:298](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L298) ___ @@ -351,7 +351,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:282 +[packages/matter.js/src/fabric/Fabric.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L283) ___ @@ -371,7 +371,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:271 +[packages/matter.js/src/fabric/Fabric.ts:272](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L272) ___ @@ -391,7 +391,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:261 +[packages/matter.js/src/fabric/Fabric.ts:262](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L262) ___ @@ -411,7 +411,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:292 +[packages/matter.js/src/fabric/Fabric.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L293) ___ @@ -431,4 +431,4 @@ ___ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:287 +[packages/matter.js/src/fabric/Fabric.ts:288](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L288) diff --git a/docs/matter.js/classes/fabric_export.FabricManager.md b/docs/matter.js/classes/fabric_export.FabricManager.md index b8d0cb3db8..d31fa007bc 100644 --- a/docs/matter.js/classes/fabric_export.FabricManager.md +++ b/docs/matter.js/classes/fabric_export.FabricManager.md @@ -12,6 +12,7 @@ ### Properties +- [fabricRemoveCallback](fabric_export.FabricManager.md#fabricremovecallback) - [fabricStorage](fabric_export.FabricManager.md#fabricstorage) - [fabrics](fabric_export.FabricManager.md#fabrics) - [nextFabricIndex](fabric_export.FabricManager.md#nextfabricindex) @@ -31,27 +32,53 @@ ### constructor -• **new FabricManager**(`storage`) +• **new FabricManager**(`storage`, `fabricRemoveCallback?`) #### Parameters | Name | Type | | :------ | :------ | | `storage` | [`StorageContext`](storage_export.StorageContext.md) | +| `fabricRemoveCallback?` | (`fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex), `peerNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid)) => `void` | #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:22 +[packages/matter.js/src/fabric/FabricManager.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L23) ## Properties +### fabricRemoveCallback + +• `Private` `Optional` `Readonly` **fabricRemoveCallback**: (`fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex), `peerNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid)) => `void` + +#### Type declaration + +▸ (`fabricIndex`, `peerNodeId`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `fabricIndex` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | + +##### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/fabric/FabricManager.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L25) + +___ + ### fabricStorage • `Private` `Readonly` **fabricStorage**: [`StorageContext`](storage_export.StorageContext.md) #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:20 +[packages/matter.js/src/fabric/FabricManager.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L21) ___ @@ -61,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:19 +[packages/matter.js/src/fabric/FabricManager.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L20) ___ @@ -71,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:18 +[packages/matter.js/src/fabric/FabricManager.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L19) ## Methods @@ -91,7 +118,7 @@ packages/matter.js/src/fabric/FabricManager.ts:18 #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:48 +[packages/matter.js/src/fabric/FabricManager.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L52) ___ @@ -112,7 +139,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:71 +[packages/matter.js/src/fabric/FabricManager.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L77) ___ @@ -126,7 +153,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:67 +[packages/matter.js/src/fabric/FabricManager.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L73) ___ @@ -140,7 +167,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:29 +[packages/matter.js/src/fabric/FabricManager.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L33) ___ @@ -154,7 +181,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:40 +[packages/matter.js/src/fabric/FabricManager.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L44) ___ @@ -174,7 +201,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:58 +[packages/matter.js/src/fabric/FabricManager.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L62) ___ @@ -194,7 +221,7 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:91 +[packages/matter.js/src/fabric/FabricManager.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L97) ___ @@ -214,4 +241,4 @@ ___ #### Defined in -packages/matter.js/src/fabric/FabricManager.ts:81 +[packages/matter.js/src/fabric/FabricManager.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/FabricManager.ts#L87) diff --git a/docs/matter.js/classes/log_export.DiagnosticDictionary.md b/docs/matter.js/classes/log_export.DiagnosticDictionary.md index 527b505364..6414682b01 100644 --- a/docs/matter.js/classes/log_export.DiagnosticDictionary.md +++ b/docs/matter.js/classes/log_export.DiagnosticDictionary.md @@ -38,7 +38,7 @@ Create a new dictionary with optional entry values. #### Defined in -packages/matter.js/src/log/Logger.ts:214 +[packages/matter.js/src/log/Logger.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L214) ## Properties @@ -54,7 +54,7 @@ the entries as [ "KEY", value ] tuples #### Defined in -packages/matter.js/src/log/Logger.ts:214 +[packages/matter.js/src/log/Logger.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L214) ## Methods @@ -79,7 +79,7 @@ the formatted value #### Defined in -packages/matter.js/src/log/Logger.ts:223 +[packages/matter.js/src/log/Logger.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L223) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:234 +[packages/matter.js/src/log/Logger.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L234) diff --git a/docs/matter.js/classes/log_export.Logger.md b/docs/matter.js/classes/log_export.Logger.md index a419ee826b..e27bcff4db 100644 --- a/docs/matter.js/classes/log_export.Logger.md +++ b/docs/matter.js/classes/log_export.Logger.md @@ -44,6 +44,7 @@ Logger.format = Format.ANSI enables colorization via ANSI escape sequences in de - [warn](log_export.Logger.md#warn) - [dict](log_export.Logger.md#dict) - [get](log_export.Logger.md#get) +- [maskString](log_export.Logger.md#maskstring) - [nest](log_export.Logger.md#nest) - [nestAsync](log_export.Logger.md#nestasync) - [toJSON](log_export.Logger.md#tojson) @@ -62,7 +63,7 @@ Logger.format = Format.ANSI enables colorization via ANSI escape sequences in de #### Defined in -packages/matter.js/src/log/Logger.ts:341 +[packages/matter.js/src/log/Logger.ts:353](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L353) ## Properties @@ -72,7 +73,7 @@ packages/matter.js/src/log/Logger.ts:341 #### Defined in -packages/matter.js/src/log/Logger.ts:341 +[packages/matter.js/src/log/Logger.ts:353](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L353) ___ @@ -82,7 +83,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:254 +[packages/matter.js/src/log/Logger.ts:254](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L254) ___ @@ -107,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:253 +[packages/matter.js/src/log/Logger.ts:253](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L253) ___ @@ -134,7 +135,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:252 +[packages/matter.js/src/log/Logger.ts:252](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L252) ___ @@ -148,7 +149,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:255 +[packages/matter.js/src/log/Logger.ts:255](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L255) ___ @@ -158,7 +159,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:256 +[packages/matter.js/src/log/Logger.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L256) ## Accessors @@ -180,7 +181,7 @@ Set logFormatter using configuration-style format name. #### Defined in -packages/matter.js/src/log/Logger.ts:263 +[packages/matter.js/src/log/Logger.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L263) ## Methods @@ -200,7 +201,7 @@ packages/matter.js/src/log/Logger.ts:263 #### Defined in -packages/matter.js/src/log/Logger.ts:343 +[packages/matter.js/src/log/Logger.ts:355](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L355) ___ @@ -220,7 +221,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:346 +[packages/matter.js/src/log/Logger.ts:358](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L358) ___ @@ -240,7 +241,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:347 +[packages/matter.js/src/log/Logger.ts:359](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L359) ___ @@ -260,7 +261,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:344 +[packages/matter.js/src/log/Logger.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L356) ___ @@ -281,7 +282,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:349 +[packages/matter.js/src/log/Logger.ts:361](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L361) ___ @@ -301,7 +302,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:345 +[packages/matter.js/src/log/Logger.ts:357](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L357) ___ @@ -323,7 +324,7 @@ Shortcut for new DiagnosticDictionary(). #### Defined in -packages/matter.js/src/log/Logger.ts:312 +[packages/matter.js/src/log/Logger.ts:324](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L324) ___ @@ -347,7 +348,32 @@ a new facility #### Defined in -packages/matter.js/src/log/Logger.ts:285 +[packages/matter.js/src/log/Logger.ts:285](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L285) + +___ + +### maskString + +▸ `Static` **maskString**(`str`, `maskChar?`, `unmaskedLength?`): `string` + +Mask a string with a given character. If unmaskedLength is provided then these number of characters will be +shown unmasked. + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `str` | `string` | `undefined` | String to mask | +| `maskChar` | `string` | `"*"` | character to mask with | +| `unmaskedLength?` | `number` | `undefined` | number of characters to show unmasked in the beginning | + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/log/Logger.ts:315](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L315) ___ @@ -376,7 +402,7 @@ indented while the context executes. #### Defined in -packages/matter.js/src/log/Logger.ts:320 +[packages/matter.js/src/log/Logger.ts:332](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L332) ___ @@ -398,7 +424,7 @@ Async version of nest(). #### Defined in -packages/matter.js/src/log/Logger.ts:332 +[packages/matter.js/src/log/Logger.ts:344](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L344) ___ @@ -422,4 +448,4 @@ the stringified value #### Defined in -packages/matter.js/src/log/Logger.ts:295 +[packages/matter.js/src/log/Logger.ts:295](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L295) diff --git a/docs/matter.js/classes/math_export.ReedSolomon.md b/docs/matter.js/classes/math_export.ReedSolomon.md index 0d3b70b709..3ed143929d 100644 --- a/docs/matter.js/classes/math_export.ReedSolomon.md +++ b/docs/matter.js/classes/math_export.ReedSolomon.md @@ -33,7 +33,7 @@ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:73 +[packages/matter.js/src/math/ReedSolomon.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L73) ## Methods @@ -54,7 +54,7 @@ packages/matter.js/src/math/ReedSolomon.ts:73 #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:75 +[packages/matter.js/src/math/ReedSolomon.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L75) ___ @@ -74,4 +74,4 @@ ___ #### Defined in -packages/matter.js/src/math/ReedSolomon.ts:93 +[packages/matter.js/src/math/ReedSolomon.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/ReedSolomon.ts#L93) diff --git a/docs/matter.js/classes/math_export.Verhoeff.md b/docs/matter.js/classes/math_export.Verhoeff.md index 5367e9727e..3480e6af5a 100644 --- a/docs/matter.js/classes/math_export.Verhoeff.md +++ b/docs/matter.js/classes/math_export.Verhoeff.md @@ -40,7 +40,7 @@ Verhoeff algorithm to compute a checksum. #### Defined in -packages/matter.js/src/math/Verhoeff.ts:26 +[packages/matter.js/src/math/Verhoeff.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/Verhoeff.ts#L26) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -packages/matter.js/src/math/Verhoeff.ts:14 +[packages/matter.js/src/math/Verhoeff.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/Verhoeff.ts#L14) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -packages/matter.js/src/math/Verhoeff.ts:27 +[packages/matter.js/src/math/Verhoeff.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/Verhoeff.ts#L27) ## Methods @@ -80,4 +80,4 @@ packages/matter.js/src/math/Verhoeff.ts:27 #### Defined in -packages/matter.js/src/math/Verhoeff.ts:38 +[packages/matter.js/src/math/Verhoeff.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/math/Verhoeff.ts#L38) diff --git a/docs/matter.js/classes/mdns_export.MdnsBroadcaster.md b/docs/matter.js/classes/mdns_export.MdnsBroadcaster.md index 1c1ad9ff3a..98b1210abe 100644 --- a/docs/matter.js/classes/mdns_export.MdnsBroadcaster.md +++ b/docs/matter.js/classes/mdns_export.MdnsBroadcaster.md @@ -27,6 +27,7 @@ This class is handing MDNS Announcements for multiple instances/devices - [expireAllAnnouncements](mdns_export.MdnsBroadcaster.md#expireallannouncements) - [expireCommissioningAnnouncement](mdns_export.MdnsBroadcaster.md#expirecommissioningannouncement) - [expireFabricAnnouncement](mdns_export.MdnsBroadcaster.md#expirefabricannouncement) +- [getIpRecords](mdns_export.MdnsBroadcaster.md#getiprecords) - [setCommissionMode](mdns_export.MdnsBroadcaster.md#setcommissionmode) - [setCommissionerInfo](mdns_export.MdnsBroadcaster.md#setcommissionerinfo) - [setFabrics](mdns_export.MdnsBroadcaster.md#setfabrics) @@ -48,7 +49,7 @@ This class is handing MDNS Announcements for multiple instances/devices #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:66 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L66) ## Properties @@ -58,7 +59,7 @@ packages/matter.js/src/mdns/MdnsBroadcaster.ts:66 #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:63 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L63) ___ @@ -68,7 +69,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:64 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L64) ___ @@ -78,7 +79,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:68 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L68) ___ @@ -88,7 +89,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:67 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L67) ___ @@ -98,7 +99,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:62 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L62) ## Methods @@ -118,7 +119,7 @@ packages/matter.js/src/mdns/MdnsBroadcaster.ts:62 #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:316 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:314](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L314) ___ @@ -132,7 +133,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:345 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L343) ___ @@ -152,7 +153,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:334 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:332](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L332) ___ @@ -172,7 +173,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:327 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:325](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L325) ___ @@ -192,7 +193,28 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:320 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:318](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L318) + +___ + +### getIpRecords + +▸ `Private` **getIpRecords**(`hostname`, `ips`): [`DnsRecord`](../modules/codec_export.md#dnsrecord)<`any`\>[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `hostname` | `string` | +| `ips` | `string`[] | + +#### Returns + +[`DnsRecord`](../modules/codec_export.md#dnsrecord)<`any`\>[] + +#### Defined in + +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L95) ___ @@ -216,7 +238,7 @@ Set the Broadcaster data to announce a device ready for commissioning in a speci #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:96 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L112) ___ @@ -239,7 +261,7 @@ Set the Broadcaster data to announce a Commissioner (aka Commissioner discovery) #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:255 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:259](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L259) ___ @@ -263,7 +285,7 @@ Set the Broadcaster Data to announce a device for operative discovery (aka "alre #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:185 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:195](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L195) ___ @@ -284,7 +306,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:71 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L71) ___ @@ -306,4 +328,4 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsBroadcaster.ts:54 +[packages/matter.js/src/mdns/MdnsBroadcaster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsBroadcaster.ts#L54) diff --git a/docs/matter.js/classes/mdns_export.MdnsScanner.md b/docs/matter.js/classes/mdns_export.MdnsScanner.md index 901ba701b5..b91ab29e6a 100644 --- a/docs/matter.js/classes/mdns_export.MdnsScanner.md +++ b/docs/matter.js/classes/mdns_export.MdnsScanner.md @@ -20,6 +20,7 @@ It sends out queries to discover various types of Matter device types and listen ### Properties - [activeAnnounceQueries](mdns_export.MdnsScanner.md#activeannouncequeries) +- [closing](mdns_export.MdnsScanner.md#closing) - [commissionableDeviceRecords](mdns_export.MdnsScanner.md#commissionabledevicerecords) - [enableIpv4](mdns_export.MdnsScanner.md#enableipv4) - [multicastServer](mdns_export.MdnsScanner.md#multicastserver) @@ -32,16 +33,20 @@ It sends out queries to discover various types of Matter device types and listen ### Methods - [buildCommissionableQueryIdentifier](mdns_export.MdnsScanner.md#buildcommissionablequeryidentifier) +- [cancelCommissionableDeviceDiscovery](mdns_export.MdnsScanner.md#cancelcommissionabledevicediscovery) +- [cancelOperationalDeviceDiscovery](mdns_export.MdnsScanner.md#canceloperationaldevicediscovery) - [close](mdns_export.MdnsScanner.md#close) - [createOperationalMatterQName](mdns_export.MdnsScanner.md#createoperationalmatterqname) - [expire](mdns_export.MdnsScanner.md#expire) - [extractInstanceId](mdns_export.MdnsScanner.md#extractinstanceid) - [findCommissionableDevices](mdns_export.MdnsScanner.md#findcommissionabledevices) +- [findCommissionableDevicesContinuously](mdns_export.MdnsScanner.md#findcommissionabledevicescontinuously) - [findCommissionableQueryIdentifier](mdns_export.MdnsScanner.md#findcommissionablequeryidentifier) - [findOperationalDevice](mdns_export.MdnsScanner.md#findoperationaldevice) - [finishWaiter](mdns_export.MdnsScanner.md#finishwaiter) - [getActiveQueryEarlierAnswers](mdns_export.MdnsScanner.md#getactivequeryearlieranswers) - [getCommissionableDeviceRecords](mdns_export.MdnsScanner.md#getcommissionabledevicerecords) +- [getCommissionableQueryRecords](mdns_export.MdnsScanner.md#getcommissionablequeryrecords) - [getDiscoveredCommissionableDevices](mdns_export.MdnsScanner.md#getdiscoveredcommissionabledevices) - [getDiscoveredOperationalDevices](mdns_export.MdnsScanner.md#getdiscoveredoperationaldevices) - [getOperationalDeviceRecords](mdns_export.MdnsScanner.md#getoperationaldevicerecords) @@ -49,6 +54,7 @@ It sends out queries to discover various types of Matter device types and listen - [handleDnsMessage](mdns_export.MdnsScanner.md#handlednsmessage) - [handleIpRecords](mdns_export.MdnsScanner.md#handleiprecords) - [handleOperationalSrvRecord](mdns_export.MdnsScanner.md#handleoperationalsrvrecord) +- [hasWaiter](mdns_export.MdnsScanner.md#haswaiter) - [parseCommissionableTxtRecord](mdns_export.MdnsScanner.md#parsecommissionabletxtrecord) - [registerWaiterPromise](mdns_export.MdnsScanner.md#registerwaiterpromise) - [removeQuery](mdns_export.MdnsScanner.md#removequery) @@ -72,7 +78,7 @@ It sends out queries to discover various types of Matter device types and listen #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:88 +[packages/matter.js/src/mdns/MdnsScanner.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L96) ## Properties @@ -82,7 +88,17 @@ packages/matter.js/src/mdns/MdnsScanner.ts:88 #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:79 +[packages/matter.js/src/mdns/MdnsScanner.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L79) + +___ + +### closing + +• `Private` **closing**: `boolean` = `false` + +#### Defined in + +[packages/matter.js/src/mdns/MdnsScanner.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L94) ___ @@ -92,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:84 +[packages/matter.js/src/mdns/MdnsScanner.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L84) ___ @@ -102,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:90 +[packages/matter.js/src/mdns/MdnsScanner.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L98) ___ @@ -112,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:89 +[packages/matter.js/src/mdns/MdnsScanner.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L97) ___ @@ -122,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:81 +[packages/matter.js/src/mdns/MdnsScanner.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L81) ___ @@ -132,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:83 +[packages/matter.js/src/mdns/MdnsScanner.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L83) ___ @@ -142,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:86 +[packages/matter.js/src/mdns/MdnsScanner.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L93) ___ @@ -152,17 +168,17 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:80 +[packages/matter.js/src/mdns/MdnsScanner.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L80) ___ ### recordWaiters -• `Private` `Readonly` **recordWaiters**: `Map`<`string`, { `resolver`: () => `void` ; `timer`: [`Timer`](../interfaces/time_export.Timer.md) }\> +• `Private` `Readonly` **recordWaiters**: `Map`<`string`, { `resolveOnUpdatedRecords`: `boolean` ; `resolver`: () => `void` ; `timer?`: [`Timer`](../interfaces/time_export.Timer.md) }\> #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:85 +[packages/matter.js/src/mdns/MdnsScanner.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L85) ## Methods @@ -185,7 +201,55 @@ Some identifiers are identical to the official DNS-SD identifiers, others are cu #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:359 +[packages/matter.js/src/mdns/MdnsScanner.ts:396](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L396) + +___ + +### cancelCommissionableDeviceDiscovery + +▸ **cancelCommissionableDeviceDiscovery**(`identifier`): `void` + +Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would +be over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Implementation of + +[Scanner](../interfaces/common_export.Scanner.md).[cancelCommissionableDeviceDiscovery](../interfaces/common_export.Scanner.md#cancelcommissionabledevicediscovery) + +#### Defined in + +[packages/matter.js/src/mdns/MdnsScanner.ts:346](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L346) + +___ + +### cancelOperationalDeviceDiscovery + +▸ **cancelOperationalDeviceDiscovery**(`fabric`, `nodeId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](fabric_export.Fabric.md) | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/mdns/MdnsScanner.ts:341](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L341) ___ @@ -205,7 +269,7 @@ Close all connects, end all timers and resolve all pending promises. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:518 +[packages/matter.js/src/mdns/MdnsScanner.ts:571](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L571) ___ @@ -226,7 +290,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:279 +[packages/matter.js/src/mdns/MdnsScanner.ts:302](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L302) ___ @@ -240,13 +304,13 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:715 +[packages/matter.js/src/mdns/MdnsScanner.ts:839](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L839) ___ ### extractInstanceId -▸ **extractInstanceId**(`instanceName`): `string` +▸ `Private` **extractInstanceId**(`instanceName`): `string` #### Parameters @@ -260,20 +324,20 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:379 +[packages/matter.js/src/mdns/MdnsScanner.ts:416](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L416) ___ ### findCommissionableDevices -▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> +▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> -Discovers commissionalble devices based on a defined identifier. If an already discovered device matched the -query it is returned directly and no query is triggered. This works because the commissionable device records -that are announced into the network are always stored already. If no record can be found a query is registered -and sent out and the promise gets fulfilled as soon as one device is found. More might be added later and can -be requested ny the getCommissionableDevices method. If no device is discovered the promise is fulfilled after -the timeout period. +Discovers commissionable devices based on a defined identifier for maximal given timeout, but returns the +first found entries. If already a discovered device matches in the cache the response is returned directly and +no query is triggered. If no record exists a query is sent out and the promise gets fulfilled as soon as at least +one device is found. If no device is discovered in the defined timeframe an empty array is returned. When the +promise got fulfilled no more queries are send out, but more device entries might be added when discovered later. +These can be requested by the getCommissionableDevices method. #### Parameters @@ -281,6 +345,7 @@ the timeout period. | :------ | :------ | :------ | | `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | `undefined` | | `timeoutSeconds` | `number` | `5` | +| `ignoreExistingRecords` | `boolean` | `false` | #### Returns @@ -292,7 +357,35 @@ the timeout period. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:445 +[packages/matter.js/src/mdns/MdnsScanner.ts:508](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L508) + +___ + +### findCommissionableDevicesContinuously + +▸ **findCommissionableDevicesContinuously**(`identifier`, `callback`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> + +Discovers commissionable devices based on a defined identifier and returns the first found entries. If already a + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | `undefined` | +| `callback` | (`device`: [`CommissionableDevice`](../modules/common_export.md#commissionabledevice)) => `void` | `undefined` | +| `timeoutSeconds` | `number` | `900` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> + +#### Implementation of + +[Scanner](../interfaces/common_export.Scanner.md).[findCommissionableDevicesContinuously](../interfaces/common_export.Scanner.md#findcommissionabledevicescontinuously) + +#### Defined in + +[packages/matter.js/src/mdns/MdnsScanner.ts:534](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L534) ___ @@ -315,13 +408,13 @@ Check all options for a query identifier and return the most relevant one with a #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:390 +[packages/matter.js/src/mdns/MdnsScanner.ts:427](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L427) ___ ### findOperationalDevice -▸ **findOperationalDevice**(`«destructured»`, `nodeId`, `timeoutSeconds?`): `Promise`<[`ServerAddressIp`](../modules/common_export.md#serveraddressip)[]\> +▸ **findOperationalDevice**(`«destructured»`, `nodeId`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`ServerAddressIp`](../modules/common_export.md#serveraddressip)[]\> Method to find an operational device (already commissioned) and return a promise with the list of discovered IP/ports or an empty array if not found. @@ -332,7 +425,8 @@ IP/ports or an empty array if not found. | :------ | :------ | :------ | | `«destructured»` | [`Fabric`](fabric_export.Fabric.md) | `undefined` | | `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | `undefined` | -| `timeoutSeconds` | `number` | `5` | +| `timeoutSeconds?` | `number` | `undefined` | +| `ignoreExistingRecords` | `boolean` | `false` | #### Returns @@ -344,13 +438,13 @@ IP/ports or an empty array if not found. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:288 +[packages/matter.js/src/mdns/MdnsScanner.ts:311](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L311) ___ ### finishWaiter -▸ `Private` **finishWaiter**(`queryId`, `resolvePromise?`): `void` +▸ `Private` **finishWaiter**(`queryId`, `resolvePromise`, `isUpdatedRecord?`): `void` Remove a waiter promise for a specific queryId and stop the connected timer. If required also resolve the promise. @@ -360,7 +454,8 @@ promise. | Name | Type | Default value | | :------ | :------ | :------ | | `queryId` | `string` | `undefined` | -| `resolvePromise` | `boolean` | `false` | +| `resolvePromise` | `boolean` | `undefined` | +| `isUpdatedRecord` | `boolean` | `false` | #### Returns @@ -368,7 +463,7 @@ promise. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:267 +[packages/matter.js/src/mdns/MdnsScanner.ts:282](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L282) ___ @@ -382,13 +477,13 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:188 +[packages/matter.js/src/mdns/MdnsScanner.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L196) ___ ### getCommissionableDeviceRecords -▸ `Private` **getCommissionableDeviceRecords**(`identifier`): { `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/common_export.md#serveraddressip)[] ; `expires`: `undefined` = undefined; `instanceId`: `string` }[] +▸ `Private` **getCommissionableDeviceRecords**(`identifier`): { `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/common_export.md#serveraddressip)[] ; `deviceIdentifier`: `string` ; `expires`: `undefined` = undefined; `instanceId`: `string` }[] Returns the metadata and list of all target addresses (IP/port) discovered for a queried commissionable device record. @@ -401,17 +496,37 @@ record. #### Returns -{ `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/common_export.md#serveraddressip)[] ; `expires`: `undefined` = undefined; `instanceId`: `string` }[] +{ `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/common_export.md#serveraddressip)[] ; `deviceIdentifier`: `string` ; `expires`: `undefined` = undefined; `instanceId`: `string` }[] #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:322 +[packages/matter.js/src/mdns/MdnsScanner.ts:359](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L359) + +___ + +### getCommissionableQueryRecords + +▸ `Private` **getCommissionableQueryRecords**(`identifier`): [`DnsQuery`](../modules/codec_export.md#dnsquery)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | + +#### Returns + +[`DnsQuery`](../modules/codec_export.md#dnsquery)[] + +#### Defined in + +[packages/matter.js/src/mdns/MdnsScanner.ts:477](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L477) ___ ### getDiscoveredCommissionableDevices -▸ **getDiscoveredCommissionableDevices**(`identifier`): { `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/common_export.md#serveraddressip)[] ; `expires`: `undefined` = undefined; `instanceId`: `string` }[] +▸ **getDiscoveredCommissionableDevices**(`identifier`): { `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/common_export.md#serveraddressip)[] ; `deviceIdentifier`: `string` ; `expires`: `undefined` = undefined; `instanceId`: `string` }[] Return already discovered commissionable devices and return them. Does not send out new DNS-SD queries. @@ -423,7 +538,7 @@ Return already discovered commissionable devices and return them. Does not send #### Returns -{ `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/common_export.md#serveraddressip)[] ; `expires`: `undefined` = undefined; `instanceId`: `string` }[] +{ `CM`: `number` ; `D`: `number` ; `DN?`: `string` ; `DT?`: `number` ; `P?`: `number` ; `PH?`: `number` ; `PI?`: `string` ; `RI?`: `string` ; `SAI?`: `number` ; `SD`: `number` ; `SII?`: `number` ; `T?`: `number` ; `V?`: `number` ; `VP?`: `string` ; `addresses`: [`ServerAddressIp`](../modules/common_export.md#serveraddressip)[] ; `deviceIdentifier`: `string` ; `expires`: `undefined` = undefined; `instanceId`: `string` }[] #### Implementation of @@ -431,7 +546,7 @@ Return already discovered commissionable devices and return them. Does not send #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:511 +[packages/matter.js/src/mdns/MdnsScanner.ts:564](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L564) ___ @@ -459,7 +574,7 @@ DNS-SD queries. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:314 +[packages/matter.js/src/mdns/MdnsScanner.ts:351](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L351) ___ @@ -481,7 +596,7 @@ Returns the list of all targets (IP/port) discovered for a queried operational d #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:210 +[packages/matter.js/src/mdns/MdnsScanner.ts:218](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L218) ___ @@ -503,7 +618,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:602 +[packages/matter.js/src/mdns/MdnsScanner.ts:689](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L689) ___ @@ -528,13 +643,13 @@ It will parse the message and check if it contains relevant discovery records. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:529 +[packages/matter.js/src/mdns/MdnsScanner.ts:586](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L586) ___ ### handleIpRecords -▸ `Private` **handleIpRecords**(`answers`, `target`, `netInterface`): `string`[] +▸ `Private` **handleIpRecords**(`answers`, `target`, `netInterface`): { `ttl`: `number` ; `value`: `string` }[] #### Parameters @@ -546,17 +661,17 @@ ___ #### Returns -`string`[] +{ `ttl`: `number` ; `value`: `string` }[] #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:544 +[packages/matter.js/src/mdns/MdnsScanner.ts:602](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L602) ___ ### handleOperationalSrvRecord -▸ `Private` **handleOperationalSrvRecord**(`answers`, `formerAnswers`, `netInterface`): `undefined` \| `boolean` +▸ `Private` **handleOperationalSrvRecord**(`answers`, `formerAnswers`, `netInterface`): `boolean` #### Parameters @@ -568,11 +683,33 @@ ___ #### Returns -`undefined` \| `boolean` +`boolean` + +#### Defined in + +[packages/matter.js/src/mdns/MdnsScanner.ts:618](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L618) + +___ + +### hasWaiter + +▸ `Private` **hasWaiter**(`queryId`): `boolean` + +Returns weather a waiter promise is registered for a specific queryId. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `queryId` | `string` | + +#### Returns + +`boolean` #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:555 +[packages/matter.js/src/mdns/MdnsScanner.ts:298](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L298) ___ @@ -592,23 +729,24 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:693 +[packages/matter.js/src/mdns/MdnsScanner.ts:817](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L817) ___ ### registerWaiterPromise -▸ `Private` **registerWaiterPromise**(`queryId`, `timeoutSeconds`): `Promise`<{ `promise`: `Promise`<`void`\> }\> +▸ `Private` **registerWaiterPromise**(`queryId`, `timeoutSeconds?`, `resolveOnUpdatedRecords?`): `Promise`<{ `promise`: `Promise`<`void`\> }\> Registers a deferred promise for a specific queryId together with a timeout and return the promise. The promise will be resolved when the timer runs out latest. #### Parameters -| Name | Type | -| :------ | :------ | -| `queryId` | `string` | -| `timeoutSeconds` | `number` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `queryId` | `string` | `undefined` | +| `timeoutSeconds?` | `number` | `undefined` | +| `resolveOnUpdatedRecords` | `boolean` | `true` | #### Returns @@ -616,7 +754,7 @@ The promise will be resolved when the timer runs out latest. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:255 +[packages/matter.js/src/mdns/MdnsScanner.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L263) ___ @@ -639,7 +777,7 @@ out. If it was the last query announcing will stop completely. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:196 +[packages/matter.js/src/mdns/MdnsScanner.ts:204](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L204) ___ @@ -658,7 +796,7 @@ packets and the query is sent as Truncated query. #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:105 +[packages/matter.js/src/mdns/MdnsScanner.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L113) ___ @@ -683,7 +821,7 @@ out. When entry already exists the query is overwritten and answers are always a #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:176 +[packages/matter.js/src/mdns/MdnsScanner.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L184) ___ @@ -705,7 +843,7 @@ Sort the list of found IP/ports and make sure link-local IPv6 addresses come fir #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:227 +[packages/matter.js/src/mdns/MdnsScanner.ts:235](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L235) ___ @@ -727,4 +865,4 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:66 +[packages/matter.js/src/mdns/MdnsScanner.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L66) diff --git a/docs/matter.js/classes/mdns_export.MdnsServer.md b/docs/matter.js/classes/mdns_export.MdnsServer.md index 67c68fc28f..db4b386caf 100644 --- a/docs/matter.js/classes/mdns_export.MdnsServer.md +++ b/docs/matter.js/classes/mdns_export.MdnsServer.md @@ -50,7 +50,7 @@ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:63 +[packages/matter.js/src/mdns/MdnsServer.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L63) ## Properties @@ -60,7 +60,7 @@ packages/matter.js/src/mdns/MdnsServer.ts:63 #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:64 +[packages/matter.js/src/mdns/MdnsServer.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L64) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:65 +[packages/matter.js/src/mdns/MdnsServer.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L65) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:49 +[packages/matter.js/src/mdns/MdnsServer.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L49) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:61 +[packages/matter.js/src/mdns/MdnsServer.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L61) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:51 +[packages/matter.js/src/mdns/MdnsServer.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L51) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:50 +[packages/matter.js/src/mdns/MdnsServer.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L50) ## Methods @@ -130,7 +130,7 @@ packages/matter.js/src/mdns/MdnsServer.ts:50 #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:230 +[packages/matter.js/src/mdns/MdnsServer.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L230) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:166 +[packages/matter.js/src/mdns/MdnsServer.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L166) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:72 +[packages/matter.js/src/mdns/MdnsServer.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L72) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:76 +[packages/matter.js/src/mdns/MdnsServer.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L76) ___ @@ -207,7 +207,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:294 +[packages/matter.js/src/mdns/MdnsServer.ts:294](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L294) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:245 +[packages/matter.js/src/mdns/MdnsServer.ts:245](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L245) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:300 +[packages/matter.js/src/mdns/MdnsServer.ts:300](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L300) ___ @@ -264,7 +264,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:84 +[packages/matter.js/src/mdns/MdnsServer.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L84) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:80 +[packages/matter.js/src/mdns/MdnsServer.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L80) ___ @@ -308,7 +308,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:304 +[packages/matter.js/src/mdns/MdnsServer.ts:304](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L304) ___ @@ -330,7 +330,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:180 +[packages/matter.js/src/mdns/MdnsServer.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L180) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:284 +[packages/matter.js/src/mdns/MdnsServer.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L284) ___ @@ -374,4 +374,4 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:36 +[packages/matter.js/src/mdns/MdnsServer.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L36) diff --git a/docs/matter.js/classes/model.Access-1.md b/docs/matter.js/classes/model.Access-1.md new file mode 100644 index 0000000000..23d1503a83 --- /dev/null +++ b/docs/matter.js/classes/model.Access-1.md @@ -0,0 +1,396 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / Access + +# Class: Access + +[model](../modules/model.md).Access + +An operational representation of "access" as defined by the Matter +specification. + +"Access" controls the operations a remote party may perform on a data field +or cluster element. + +## Hierarchy + +- [`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Access.md#definition)\> + + ↳ **`Access`** + +## Implements + +- [`Ast`](../modules/model.Access.md#ast) + +## Table of contents + +### Constructors + +- [constructor](model.Access-1.md#constructor) + +### Properties + +- [definition](model.Access-1.md#definition) +- [errors](model.Access-1.md#errors) +- [fabric](model.Access-1.md#fabric) +- [readPriv](model.Access-1.md#readpriv) +- [rw](model.Access-1.md#rw) +- [timed](model.Access-1.md#timed) +- [writePriv](model.Access-1.md#writepriv) + +### Accessors + +- [empty](model.Access-1.md#empty) +- [readable](model.Access-1.md#readable) +- [valid](model.Access-1.md#valid) +- [writable](model.Access-1.md#writable) + +### Methods + +- [equals](model.Access-1.md#equals) +- [error](model.Access-1.md#error) +- [extend](model.Access-1.md#extend) +- [set](model.Access-1.md#set) +- [toString](model.Access-1.md#tostring) +- [valueOf](model.Access-1.md#valueof) +- [parse](model.Access-1.md#parse) + +## Constructors + +### constructor + +• **new Access**(`definition`) + +Initialize from an Access.Definition or the access control DSL defined +by the Matter Specification. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Definition`](../modules/model.Access.md#definition) | + +#### Overrides + +[Aspect](model.Aspect.md).[constructor](model.Aspect.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L41) + +## Properties + +### definition + +• **definition**: [`Definition`](../modules/model.Access.md#definition) + +#### Inherited from + +[Aspect](model.Aspect.md).[definition](model.Aspect.md#definition) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L17) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Aspect](model.Aspect.md).[errors](model.Aspect.md#errors) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L18) + +___ + +### fabric + +• `Optional` **fabric**: [`Fabric`](../enums/model.Access.Fabric.md) + +#### Implementation of + +Access.Ast.fabric + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L20) + +___ + +### readPriv + +• `Optional` **readPriv**: [`Privilege`](../enums/model.Access.Privilege.md) + +#### Implementation of + +Access.Ast.readPriv + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L18) + +___ + +### rw + +• `Optional` **rw**: [`Rw`](../enums/model.Access.Rw.md) + +#### Implementation of + +Access.Ast.rw + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L17) + +___ + +### timed + +• `Optional` **timed**: `boolean` + +#### Implementation of + +Access.Ast.timed + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L21) + +___ + +### writePriv + +• `Optional` **writePriv**: [`Privilege`](../enums/model.Access.Privilege.md) + +#### Implementation of + +Access.Ast.writePriv + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L19) + +## Accessors + +### empty + +• `get` **empty**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Aspect.empty + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L31) + +___ + +### readable + +• `get` **readable**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L23) + +___ + +### valid + +• `get` **valid**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Aspect.valid + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L20) + +___ + +### writable + +• `get` **writable**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L27) + +## Methods + +### equals + +▸ **equals**(`other`): `boolean` + +Test for logical equivalence. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Aspect](model.Aspect.md).[equals](model.Aspect.md#equals) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L40) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Aspect](model.Aspect.md).[error](model.Aspect.md#error) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L54) + +___ + +### extend + +▸ **extend**(`other`): [`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Access.md#definition)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`Definition`](../modules/model.Access.md#definition) | + +#### Returns + +[`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Access.md#definition)\> + +#### Inherited from + +[Aspect](model.Aspect.md).[extend](model.Aspect.md#extend) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L65) + +___ + +### set + +▸ `Private` **set**(`flags`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `flags` | [`Flags`](../modules/model.Access.md#flags) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L167) + +___ + +### toString + +▸ **toString**(): `string` + +Displays access using the standard Matter syntax. + +#### Returns + +`string` + +#### Overrides + +[Aspect](model.Aspect.md).[toString](model.Aspect.md#tostring) + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L135) + +___ + +### valueOf + +▸ **valueOf**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[Aspect](model.Aspect.md).[valueOf](model.Aspect.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L47) + +___ + +### parse + +▸ `Static` **parse**(`access`, `definition`): [`Flags`](../modules/model.Access.md#flags) + +Parses standard Matter access syntax into an AccessFlag set. Extremely +lenient. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `access` | [`Access`](model.Access-1.md) | +| `definition` | `string` | + +#### Returns + +[`Flags`](../modules/model.Access.md#flags) + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L57) diff --git a/docs/matter.js/classes/model.Aspect.md b/docs/matter.js/classes/model.Aspect.md new file mode 100644 index 0000000000..f48b7b4af3 --- /dev/null +++ b/docs/matter.js/classes/model.Aspect.md @@ -0,0 +1,212 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / Aspect + +# Class: Aspect + +[model](../modules/model.md).Aspect + +An "aspect" is metadata about a Matter element that affects implementation +behavior. Aspects are mostly "qualities" in the Matter specification except +for "constraint" which is not formally described as a quality. + +## Type parameters + +| Name | +| :------ | +| `D` | + +## Hierarchy + +- **`Aspect`** + + ↳ [`Access`](model.Access-1.md) + + ↳ [`Conformance`](model.Conformance-1.md) + + ↳ [`Constraint`](model.Constraint-1.md) + + ↳ [`Quality`](model.Quality-1.md) + +## Table of contents + +### Constructors + +- [constructor](model.Aspect.md#constructor) + +### Properties + +- [definition](model.Aspect.md#definition) +- [errors](model.Aspect.md#errors) + +### Accessors + +- [empty](model.Aspect.md#empty) +- [valid](model.Aspect.md#valid) + +### Methods + +- [equals](model.Aspect.md#equals) +- [error](model.Aspect.md#error) +- [extend](model.Aspect.md#extend) +- [toString](model.Aspect.md#tostring) +- [valueOf](model.Aspect.md#valueof) + +## Constructors + +### constructor + +• **new Aspect**<`D`\>(`definition`) + +#### Type parameters + +| Name | +| :------ | +| `D` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | `D` | + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L24) + +## Properties + +### definition + +• **definition**: `D` + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L17) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L18) + +## Accessors + +### empty + +• `get` **empty**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L28) + +___ + +### valid + +• `get` **valid**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L20) + +## Methods + +### equals + +▸ **equals**(`other`): `boolean` + +Test for logical equivalence. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | `any` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L40) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L54) + +___ + +### extend + +▸ **extend**(`other`): [`Aspect`](model.Aspect.md)<`D`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | `Exclude`<`D`, ``"string"``\> | + +#### Returns + +[`Aspect`](model.Aspect.md)<`D`\> + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L65) + +___ + +### toString + +▸ `Abstract` **toString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L52) + +___ + +### valueOf + +▸ **valueOf**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L47) diff --git a/docs/matter.js/classes/model.AttributeModel.md b/docs/matter.js/classes/model.AttributeModel.md new file mode 100644 index 0000000000..1cfb8c273b --- /dev/null +++ b/docs/matter.js/classes/model.AttributeModel.md @@ -0,0 +1,1666 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / AttributeModel + +# Class: AttributeModel + +[model](../modules/model.md).AttributeModel + +Each ValueElement has a corresponding implementation that derives from +this class. + +## Hierarchy + +- [`ValueModel`](model.ValueModel.md) + + ↳ **`AttributeModel`** + +## Implements + +- [`AttributeElement`](../modules/model.md#attributeelement) + +## Table of contents + +### Constructors + +- [constructor](model.AttributeModel.md#constructor) + +### Properties + +- [byteSize](model.AttributeModel.md#bytesize) +- [default](model.AttributeModel.md#default) +- [description](model.AttributeModel.md#description) +- [details](model.AttributeModel.md#details) +- [errors](model.AttributeModel.md#errors) +- [global](model.AttributeModel.md#global) +- [id](model.AttributeModel.md#id) +- [isType](model.AttributeModel.md#istype) +- [isTypeScope](model.AttributeModel.md#istypescope) +- [metatype](model.AttributeModel.md#metatype) +- [name](model.AttributeModel.md#name) +- [tag](model.AttributeModel.md#tag) +- [type](model.AttributeModel.md#type) +- [xref](model.AttributeModel.md#xref) +- [Tag](model.AttributeModel.md#tag-1) +- [constructors](model.AttributeModel.md#constructors) + +### Accessors + +- [access](model.AttributeModel.md#access) +- [allowedBaseTags](model.AttributeModel.md#allowedbasetags) +- [base](model.AttributeModel.md#base) +- [children](model.AttributeModel.md#children) +- [conformance](model.AttributeModel.md#conformance) +- [constraint](model.AttributeModel.md#constraint) +- [definingModel](model.AttributeModel.md#definingmodel) +- [deprecated](model.AttributeModel.md#deprecated) +- [directMetatype](model.AttributeModel.md#directmetatype) +- [disallowed](model.AttributeModel.md#disallowed) +- [effectiveAccess](model.AttributeModel.md#effectiveaccess) +- [effectiveConformance](model.AttributeModel.md#effectiveconformance) +- [effectiveConstraint](model.AttributeModel.md#effectiveconstraint) +- [effectiveDefault](model.AttributeModel.md#effectivedefault) +- [effectiveId](model.AttributeModel.md#effectiveid) +- [effectiveMetatype](model.AttributeModel.md#effectivemetatype) +- [effectiveQuality](model.AttributeModel.md#effectivequality) +- [effectiveType](model.AttributeModel.md#effectivetype) +- [effectiveXref](model.AttributeModel.md#effectivexref) +- [elements](model.AttributeModel.md#elements) +- [fabricScoped](model.AttributeModel.md#fabricscoped) +- [fixed](model.AttributeModel.md#fixed) +- [globalBase](model.AttributeModel.md#globalbase) +- [key](model.AttributeModel.md#key) +- [listEntry](model.AttributeModel.md#listentry) +- [mandatory](model.AttributeModel.md#mandatory) +- [members](model.AttributeModel.md#members) +- [metabase](model.AttributeModel.md#metabase) +- [nullable](model.AttributeModel.md#nullable) +- [overridesShadow](model.AttributeModel.md#overridesshadow) +- [parent](model.AttributeModel.md#parent) +- [path](model.AttributeModel.md#path) +- [primitiveBase](model.AttributeModel.md#primitivebase) +- [quality](model.AttributeModel.md#quality) +- [shadow](model.AttributeModel.md#shadow) +- [valid](model.AttributeModel.md#valid) +- [validationAspects](model.AttributeModel.md#validationaspects) +- [writable](model.AttributeModel.md#writable) + +### Methods + +- [add](model.AttributeModel.md#add) +- [all](model.AttributeModel.md#all) +- [bitDefinition](model.AttributeModel.md#bitdefinition) +- [error](model.AttributeModel.md#error) +- [get](model.AttributeModel.md#get) +- [instanceOf](model.AttributeModel.md#instanceof) +- [is](model.AttributeModel.md#is) +- [member](model.AttributeModel.md#member) +- [owner](model.AttributeModel.md#owner) +- [references](model.AttributeModel.md#references) +- [toJSON](model.AttributeModel.md#tojson) +- [valueOf](model.AttributeModel.md#valueof) +- [visit](model.AttributeModel.md#visit) +- [create](model.AttributeModel.md#create) + +## Constructors + +### constructor + +• **new AttributeModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.AttributeElement.md#properties) | + +#### Overrides + +[ValueModel](model.ValueModel.md).[constructor](model.ValueModel.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/AttributeModel.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/AttributeModel.ts#L28) + +## Properties + +### byteSize + +• `Optional` **byteSize**: [`Size`](../modules/model.ValueElement.md#size) + +#### Implementation of + +AttributeElement.byteSize + +#### Inherited from + +[ValueModel](model.ValueModel.md).[byteSize](model.ValueModel.md#bytesize) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L30) + +___ + +### default + +• `Optional` **default**: [`FieldValue`](../modules/model.md#fieldvalue) + +#### Implementation of + +AttributeElement.default + +#### Inherited from + +[ValueModel](model.ValueModel.md).[default](model.ValueModel.md#default) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L31) + +___ + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +AttributeElement.description + +#### Inherited from + +[ValueModel](model.ValueModel.md).[description](model.ValueModel.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +AttributeElement.details + +#### Inherited from + +[ValueModel](model.ValueModel.md).[details](model.ValueModel.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[errors](model.ValueModel.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +AttributeElement.global + +#### Inherited from + +[ValueModel](model.ValueModel.md).[global](model.ValueModel.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• **id**: `number` + +#### Implementation of + +AttributeElement.id + +#### Overrides + +[ValueModel](model.ValueModel.md).[id](model.ValueModel.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/AttributeModel.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/AttributeModel.ts#L14) + +___ + +### isType + +• `Optional` **isType**: `boolean` = `true` + +Indicates that an element defines a datatype. + +#### Inherited from + +[ValueModel](model.ValueModel.md).[isType](model.ValueModel.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L33) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[ValueModel](model.ValueModel.md).[isTypeScope](model.ValueModel.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### metatype + +• `Optional` **metatype**: [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[metatype](model.ValueModel.md#metatype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L32) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +AttributeElement.name + +#### Inherited from + +[ValueModel](model.ValueModel.md).[name](model.ValueModel.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• **tag**: [`Attribute`](../enums/model.ElementTag.md#attribute) = `AttributeElement.Tag` + +#### Implementation of + +AttributeElement.tag + +#### Overrides + +[ValueModel](model.ValueModel.md).[tag](model.ValueModel.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/AttributeModel.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/AttributeModel.ts#L13) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +AttributeElement.type + +#### Inherited from + +[ValueModel](model.ValueModel.md).[type](model.ValueModel.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +AttributeElement.xref + +#### Inherited from + +[ValueModel](model.ValueModel.md).[xref](model.ValueModel.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### Tag + +▪ `Static` **Tag**: [`ElementTag`](../enums/model.ElementTag.md) = `AttributeElement.Tag` + +#### Defined in + +[packages/matter.js/src/model/models/AttributeModel.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/AttributeModel.ts#L36) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[constructors](model.ValueModel.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### access + +• `get` **access**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Implementation of + +AttributeElement.access + +#### Inherited from + +ValueModel.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L63) + +• `set` **access**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Access`](model.Access-1.md) \| [`Definition`](../modules/model.Access.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +AttributeElement.access + +#### Inherited from + +ValueModel.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L66) + +___ + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +ValueModels may derive from models of the same type or from generic +Datatype models. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +ValueModel.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L180) + +___ + +### base + +• `get` **base**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +ValueModels may only derive from ValueModels. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.base + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L172) + +___ + +### children + +• `get` **children**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Children of models are always models. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Implementation of + +AttributeElement.children + +#### Inherited from + +ValueModel.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L35) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`DatatypeElement`](../modules/model.md#datatypeelement) \| [`DatatypeModel`](model.DatatypeModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +AttributeElement.children + +#### Inherited from + +ValueModel.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L39) + +___ + +### conformance + +• `get` **conformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Implementation of + +AttributeElement.conformance + +#### Inherited from + +ValueModel.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L53) + +• `set` **conformance**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Conformance`](model.Conformance-1.md) \| [`Definition`](../modules/model.Conformance.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +AttributeElement.conformance + +#### Inherited from + +ValueModel.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L56) + +___ + +### constraint + +• `get` **constraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Implementation of + +AttributeElement.constraint + +#### Inherited from + +ValueModel.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L43) + +• `set` **constraint**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Constraint`](model.Constraint-1.md) \| [`Definition`](../modules/model.Constraint.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +AttributeElement.constraint + +#### Inherited from + +ValueModel.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L46) + +___ + +### definingModel + +• `get` **definingModel**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the first derived ancestor with children, if any. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.definingModel + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L158) + +___ + +### deprecated + +• `get` **deprecated**(): `boolean` + +Is this model deprecated? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.deprecated + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L220) + +___ + +### directMetatype + +• `get` **directMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The metatype for this model's type, ignoring inheritance. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +ValueModel.directMetatype + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L149) + +___ + +### disallowed + +• `get` **disallowed**(): `boolean` + +Is this model disallowed? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.disallowed + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L227) + +___ + +### effectiveAccess + +• `get` **effectiveAccess**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Inherited from + +ValueModel.effectiveAccess + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L69) + +___ + +### effectiveConformance + +• `get` **effectiveConformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Inherited from + +ValueModel.effectiveConformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L59) + +___ + +### effectiveConstraint + +• `get` **effectiveConstraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Inherited from + +ValueModel.effectiveConstraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L49) + +___ + +### effectiveDefault + +• `get` **effectiveDefault**(): `any` + +The value to use as a default. The "default" field has a manually +supplied value but this property decodes the default and/or generates +a default from subfields. + +#### Returns + +`any` + +#### Inherited from + +ValueModel.effectiveDefault + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L142) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +ValueModel.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveMetatype + +• `get` **effectiveMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The working metatype for this object. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +ValueModel.effectiveMetatype + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L130) + +___ + +### effectiveQuality + +• `get` **effectiveQuality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Inherited from + +ValueModel.effectiveQuality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L79) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +The "effective type" may be inferred from context. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +ValueModel.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L119) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +ValueModel.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +ValueModel.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### fabricScoped + +• `get` **fabricScoped**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/AttributeModel.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/AttributeModel.ts#L20) + +___ + +### fixed + +• `get` **fixed**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/AttributeModel.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/AttributeModel.ts#L24) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +ValueModel.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### listEntry + +• `get` **listEntry**(): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Get the entry type for lists, if any. + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Inherited from + +ValueModel.listEntry + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L165) + +___ + +### mandatory + +• `get` **mandatory**(): `boolean` + +Is this model mandatory? This supports a limited subset of conformance +and is only appropriate for field conformance. + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.mandatory + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L242) + +___ + +### members + +• `get` **members**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Retrieve all datatype members. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Inherited from + +ValueModel.members + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L190) + +___ + +### metabase + +• `get` **metabase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Metatype is only present on global types with specific semantic meaning. +This model is significant because it gives us information about how to +manipulate the data. This accessor retrieves this model. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.metabase + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L88) + +___ + +### nullable + +• `get` **nullable**(): `boolean` + +Can this model be omitted? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.nullable + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L234) + +___ + +### overridesShadow + +• `get` **overridesShadow**(): `undefined` \| ``true`` + +Determine whether this element overrides key properties of its shadow. + +#### Returns + +`undefined` \| ``true`` + +#### Inherited from + +ValueModel.overridesShadow + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L263) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +ValueModel.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +ValueModel.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### primitiveBase + +• `get` **primitiveBase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the primitive type for this value model. This is an integer type +for enums and bitmaps. Otherwise it's the metabase. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.primitiveBase + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L96) + +___ + +### quality + +• `get` **quality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Implementation of + +AttributeElement.quality + +#### Inherited from + +ValueModel.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L73) + +• `set` **quality**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Quality`](model.Quality-1.md) \| [`Definition`](../modules/model.Quality.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +AttributeElement.quality + +#### Inherited from + +ValueModel.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L76) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +___ + +### validationAspects + +• `get` **validationAspects**(): [`Aspect`](model.Aspect.md)<`any`\>[] + +Collect constraints and conformance for this type and all base types. + +#### Returns + +[`Aspect`](model.Aspect.md)<`any`\>[] + +#### Inherited from + +ValueModel.validationAspects + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L197) + +___ + +### writable + +• `get` **writable**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/AttributeModel.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/AttributeModel.ts#L16) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[add](model.ValueModel.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[all](model.ValueModel.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### bitDefinition + +▸ **bitDefinition**(`bit`): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Search the inheritance chain for a bitmap field defining a specific bit. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bit` | `number` | + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[bitDefinition](model.ValueModel.md#bitdefinition) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:289](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L289) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[error](model.ValueModel.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[get](model.ValueModel.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[instanceOf](model.ValueModel.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[is](model.ValueModel.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[member](model.ValueModel.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[owner](model.ValueModel.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[references](model.ValueModel.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[toJSON](model.ValueModel.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[valueOf](model.ValueModel.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L293) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[visit](model.ValueModel.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[create](model.ValueModel.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.ClusterModel-1.md b/docs/matter.js/classes/model.ClusterModel-1.md new file mode 100644 index 0000000000..1474a0b9e2 --- /dev/null +++ b/docs/matter.js/classes/model.ClusterModel-1.md @@ -0,0 +1,1051 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / ClusterModel + +# Class: ClusterModel + +[model](../modules/model.md).ClusterModel + +A "model" is a class that implements runtime functionality associated with +the corresponding element type. + +## Hierarchy + +- [`Model`](model.Model-1.md) + + ↳ **`ClusterModel`** + +## Table of contents + +### Constructors + +- [constructor](model.ClusterModel-1.md#constructor) + +### Properties + +- [classification](model.ClusterModel-1.md#classification) +- [description](model.ClusterModel-1.md#description) +- [details](model.ClusterModel-1.md#details) +- [errors](model.ClusterModel-1.md#errors) +- [global](model.ClusterModel-1.md#global) +- [id](model.ClusterModel-1.md#id) +- [isType](model.ClusterModel-1.md#istype) +- [isTypeScope](model.ClusterModel-1.md#istypescope) +- [name](model.ClusterModel-1.md#name) +- [singleton](model.ClusterModel-1.md#singleton) +- [tag](model.ClusterModel-1.md#tag) +- [type](model.ClusterModel-1.md#type) +- [xref](model.ClusterModel-1.md#xref) +- [constructors](model.ClusterModel-1.md#constructors) + +### Accessors + +- [allowedBaseTags](model.ClusterModel-1.md#allowedbasetags) +- [attributes](model.ClusterModel-1.md#attributes) +- [base](model.ClusterModel-1.md#base) +- [children](model.ClusterModel-1.md#children) +- [commands](model.ClusterModel-1.md#commands) +- [datatypes](model.ClusterModel-1.md#datatypes) +- [effectiveId](model.ClusterModel-1.md#effectiveid) +- [effectiveType](model.ClusterModel-1.md#effectivetype) +- [effectiveXref](model.ClusterModel-1.md#effectivexref) +- [elements](model.ClusterModel-1.md#elements) +- [events](model.ClusterModel-1.md#events) +- [featureMap](model.ClusterModel-1.md#featuremap) +- [features](model.ClusterModel-1.md#features) +- [globalBase](model.ClusterModel-1.md#globalbase) +- [key](model.ClusterModel-1.md#key) +- [parent](model.ClusterModel-1.md#parent) +- [path](model.ClusterModel-1.md#path) +- [revision](model.ClusterModel-1.md#revision) +- [shadow](model.ClusterModel-1.md#shadow) +- [valid](model.ClusterModel-1.md#valid) + +### Methods + +- [add](model.ClusterModel-1.md#add) +- [all](model.ClusterModel-1.md#all) +- [error](model.ClusterModel-1.md#error) +- [get](model.ClusterModel-1.md#get) +- [instanceOf](model.ClusterModel-1.md#instanceof) +- [is](model.ClusterModel-1.md#is) +- [member](model.ClusterModel-1.md#member) +- [owner](model.ClusterModel-1.md#owner) +- [references](model.ClusterModel-1.md#references) +- [toJSON](model.ClusterModel-1.md#tojson) +- [valueOf](model.ClusterModel-1.md#valueof) +- [visit](model.ClusterModel-1.md#visit) +- [create](model.ClusterModel-1.md#create) + +## Constructors + +### constructor + +• **new ClusterModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.ClusterElement.md#properties) | + +#### Overrides + +[Model](model.Model-1.md).[constructor](model.Model-1.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L63) + +## Properties + +### classification + +• `Optional` **classification**: [`Classification`](../enums/model.ClusterElement.Classification.md) + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L18) + +___ + +### description + +• `Optional` **description**: `string` + +#### Inherited from + +[Model](model.Model-1.md).[description](model.Model-1.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Inherited from + +[Model](model.Model-1.md).[details](model.Model-1.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Model](model.Model-1.md).[errors](model.Model-1.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Inherited from + +[Model](model.Model-1.md).[global](model.Model-1.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• `Optional` **id**: `number` + +#### Overrides + +[Model](model.Model-1.md).[id](model.Model-1.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L17) + +___ + +### isType + +• `Optional` **isType**: `boolean` + +Indicates that an element defines a datatype. + +#### Inherited from + +[Model](model.Model-1.md).[isType](model.Model-1.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L44) + +___ + +### isTypeScope + +• **isTypeScope**: `boolean` = `true` + +Indicates that an element may have type definitions as children. + +#### Overrides + +[Model](model.Model-1.md).[isTypeScope](model.Model-1.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L19) + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[Model](model.Model-1.md).[name](model.Model-1.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### singleton + +• `Optional` **singleton**: `boolean` + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L20) + +___ + +### tag + +• **tag**: [`Cluster`](../enums/model.ElementTag.md#cluster) = `ClusterElement.Tag` + +#### Overrides + +[Model](model.Model-1.md).[tag](model.Model-1.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L16) + +___ + +### type + +• `Optional` **type**: `string` + +#### Inherited from + +[Model](model.Model-1.md).[type](model.Model-1.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +[Model](model.Model-1.md).[xref](model.Model-1.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[constructors](model.Model-1.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +The set of tags from which this model may derive. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +Model.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L237) + +___ + +### attributes + +• `get` **attributes**(): [`AttributeModel`](model.AttributeModel.md)[] + +#### Returns + +[`AttributeModel`](model.AttributeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L22) + +___ + +### base + +• `get` **base**(): `undefined` \| [`Model`](model.Model-1.md) + +Get a Model for my base type, if any. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.base + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L207) + +___ + +### children + +• `get` **children**(): [`Child`](../modules/model.ClusterModel.md#child)[] + +Children of models are always models. + +#### Returns + +[`Child`](../modules/model.ClusterModel.md#child)[] + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L55) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`Child`](../modules/model.ClusterElement.md#child) \| [`Child`](../modules/model.ClusterModel.md#child))[] | + +#### Returns + +`void` + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L59) + +___ + +### commands + +• `get` **commands**(): [`CommandModel`](model.CommandModel.md)[] + +#### Returns + +[`CommandModel`](model.CommandModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L26) + +___ + +### datatypes + +• `get` **datatypes**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L34) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Model.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +In some circumstances the base type can be inferred. This inference +happens here. + +Does not recurse so only returns the direct base type. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L200) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +Model.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +Model.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### events + +• `get` **events**(): [`EventModel`](model.EventModel.md)[] + +#### Returns + +[`EventModel`](model.EventModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L30) + +___ + +### featureMap + +• `get` **featureMap**(): [`AttributeModel`](model.AttributeModel.md) + +#### Returns + +[`AttributeModel`](model.AttributeModel.md) + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L51) + +___ + +### features + +• `get` **features**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L47) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +Model.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### revision + +• `get` **revision**(): `number` + +#### Returns + +`number` + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L38) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +Model.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[add](model.Model-1.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[Model](model.Model-1.md).[all](model.Model-1.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[error](model.Model-1.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[Model](model.Model-1.md).[get](model.Model-1.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[instanceOf](model.Model-1.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[is](model.Model-1.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[member](model.Model-1.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[Model](model.Model-1.md).[owner](model.Model-1.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[Model](model.Model-1.md).[references](model.Model-1.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[toJSON](model.Model-1.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[valueOf](model.Model-1.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L326) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[Model](model.Model-1.md).[visit](model.Model-1.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[create](model.Model-1.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.CommandModel.md b/docs/matter.js/classes/model.CommandModel.md new file mode 100644 index 0000000000..05248d0f65 --- /dev/null +++ b/docs/matter.js/classes/model.CommandModel.md @@ -0,0 +1,1696 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / CommandModel + +# Class: CommandModel + +[model](../modules/model.md).CommandModel + +Each ValueElement has a corresponding implementation that derives from +this class. + +## Hierarchy + +- [`ValueModel`](model.ValueModel.md) + + ↳ **`CommandModel`** + +## Implements + +- [`CommandElement`](../modules/model.md#commandelement) + +## Table of contents + +### Constructors + +- [constructor](model.CommandModel.md#constructor) + +### Properties + +- [byteSize](model.CommandModel.md#bytesize) +- [default](model.CommandModel.md#default) +- [description](model.CommandModel.md#description) +- [details](model.CommandModel.md#details) +- [direction](model.CommandModel.md#direction) +- [errors](model.CommandModel.md#errors) +- [global](model.CommandModel.md#global) +- [id](model.CommandModel.md#id) +- [isType](model.CommandModel.md#istype) +- [isTypeScope](model.CommandModel.md#istypescope) +- [metatype](model.CommandModel.md#metatype) +- [name](model.CommandModel.md#name) +- [response](model.CommandModel.md#response) +- [tag](model.CommandModel.md#tag) +- [type](model.CommandModel.md#type) +- [xref](model.CommandModel.md#xref) +- [Tag](model.CommandModel.md#tag-1) +- [constructors](model.CommandModel.md#constructors) + +### Accessors + +- [access](model.CommandModel.md#access) +- [allowedBaseTags](model.CommandModel.md#allowedbasetags) +- [base](model.CommandModel.md#base) +- [children](model.CommandModel.md#children) +- [conformance](model.CommandModel.md#conformance) +- [constraint](model.CommandModel.md#constraint) +- [definingModel](model.CommandModel.md#definingmodel) +- [deprecated](model.CommandModel.md#deprecated) +- [directMetatype](model.CommandModel.md#directmetatype) +- [disallowed](model.CommandModel.md#disallowed) +- [effectiveAccess](model.CommandModel.md#effectiveaccess) +- [effectiveConformance](model.CommandModel.md#effectiveconformance) +- [effectiveConstraint](model.CommandModel.md#effectiveconstraint) +- [effectiveDefault](model.CommandModel.md#effectivedefault) +- [effectiveId](model.CommandModel.md#effectiveid) +- [effectiveMetatype](model.CommandModel.md#effectivemetatype) +- [effectiveQuality](model.CommandModel.md#effectivequality) +- [effectiveType](model.CommandModel.md#effectivetype) +- [effectiveXref](model.CommandModel.md#effectivexref) +- [elements](model.CommandModel.md#elements) +- [globalBase](model.CommandModel.md#globalbase) +- [isRequest](model.CommandModel.md#isrequest) +- [isResponse](model.CommandModel.md#isresponse) +- [key](model.CommandModel.md#key) +- [listEntry](model.CommandModel.md#listentry) +- [mandatory](model.CommandModel.md#mandatory) +- [members](model.CommandModel.md#members) +- [metabase](model.CommandModel.md#metabase) +- [nullable](model.CommandModel.md#nullable) +- [overridesShadow](model.CommandModel.md#overridesshadow) +- [parent](model.CommandModel.md#parent) +- [path](model.CommandModel.md#path) +- [primitiveBase](model.CommandModel.md#primitivebase) +- [quality](model.CommandModel.md#quality) +- [responseModel](model.CommandModel.md#responsemodel) +- [shadow](model.CommandModel.md#shadow) +- [valid](model.CommandModel.md#valid) +- [validationAspects](model.CommandModel.md#validationaspects) + +### Methods + +- [add](model.CommandModel.md#add) +- [all](model.CommandModel.md#all) +- [bitDefinition](model.CommandModel.md#bitdefinition) +- [error](model.CommandModel.md#error) +- [get](model.CommandModel.md#get) +- [instanceOf](model.CommandModel.md#instanceof) +- [is](model.CommandModel.md#is) +- [member](model.CommandModel.md#member) +- [owner](model.CommandModel.md#owner) +- [references](model.CommandModel.md#references) +- [toJSON](model.CommandModel.md#tojson) +- [valueOf](model.CommandModel.md#valueof) +- [visit](model.CommandModel.md#visit) +- [create](model.CommandModel.md#create) + +## Constructors + +### constructor + +• **new CommandModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.CommandElement.md#properties) | + +#### Overrides + +[ValueModel](model.ValueModel.md).[constructor](model.ValueModel.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L39) + +## Properties + +### byteSize + +• `Optional` **byteSize**: [`Size`](../modules/model.ValueElement.md#size) + +#### Implementation of + +CommandElement.byteSize + +#### Inherited from + +[ValueModel](model.ValueModel.md).[byteSize](model.ValueModel.md#bytesize) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L30) + +___ + +### default + +• `Optional` **default**: [`FieldValue`](../modules/model.md#fieldvalue) + +#### Implementation of + +CommandElement.default + +#### Inherited from + +[ValueModel](model.ValueModel.md).[default](model.ValueModel.md#default) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L31) + +___ + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +CommandElement.description + +#### Inherited from + +[ValueModel](model.ValueModel.md).[description](model.ValueModel.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +CommandElement.details + +#### Inherited from + +[ValueModel](model.ValueModel.md).[details](model.ValueModel.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### direction + +• `Optional` **direction**: [`Direction`](../enums/model.CommandElement.Direction.md) + +#### Implementation of + +CommandElement.direction + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L16) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[errors](model.ValueModel.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +CommandElement.global + +#### Inherited from + +[ValueModel](model.ValueModel.md).[global](model.ValueModel.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• **id**: `number` + +#### Implementation of + +CommandElement.id + +#### Overrides + +[ValueModel](model.ValueModel.md).[id](model.ValueModel.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L15) + +___ + +### isType + +• `Optional` **isType**: `boolean` = `true` + +Indicates that an element defines a datatype. + +#### Inherited from + +[ValueModel](model.ValueModel.md).[isType](model.ValueModel.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L33) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[ValueModel](model.ValueModel.md).[isTypeScope](model.ValueModel.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### metatype + +• `Optional` **metatype**: [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[metatype](model.ValueModel.md#metatype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L32) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +CommandElement.name + +#### Inherited from + +[ValueModel](model.ValueModel.md).[name](model.ValueModel.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### response + +• `Optional` **response**: `string` + +#### Implementation of + +CommandElement.response + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L17) + +___ + +### tag + +• **tag**: [`Command`](../enums/model.ElementTag.md#command) = `CommandElement.Tag` + +#### Implementation of + +CommandElement.tag + +#### Overrides + +[ValueModel](model.ValueModel.md).[tag](model.ValueModel.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L14) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +CommandElement.type + +#### Inherited from + +[ValueModel](model.ValueModel.md).[type](model.ValueModel.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +CommandElement.xref + +#### Inherited from + +[ValueModel](model.ValueModel.md).[xref](model.ValueModel.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### Tag + +▪ `Static` **Tag**: [`ElementTag`](../enums/model.ElementTag.md) = `CommandElement.Tag` + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L47) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[constructors](model.ValueModel.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### access + +• `get` **access**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Implementation of + +CommandElement.access + +#### Inherited from + +ValueModel.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L63) + +• `set` **access**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Access`](model.Access-1.md) \| [`Definition`](../modules/model.Access.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +CommandElement.access + +#### Inherited from + +ValueModel.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L66) + +___ + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +ValueModels may derive from models of the same type or from generic +Datatype models. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +ValueModel.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L180) + +___ + +### base + +• `get` **base**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +ValueModels may only derive from ValueModels. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.base + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L172) + +___ + +### children + +• `get` **children**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Children of models are always models. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Implementation of + +CommandElement.children + +#### Inherited from + +ValueModel.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L35) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`DatatypeElement`](../modules/model.md#datatypeelement) \| [`DatatypeModel`](model.DatatypeModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +CommandElement.children + +#### Inherited from + +ValueModel.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L39) + +___ + +### conformance + +• `get` **conformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Implementation of + +CommandElement.conformance + +#### Inherited from + +ValueModel.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L53) + +• `set` **conformance**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Conformance`](model.Conformance-1.md) \| [`Definition`](../modules/model.Conformance.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +CommandElement.conformance + +#### Inherited from + +ValueModel.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L56) + +___ + +### constraint + +• `get` **constraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Implementation of + +CommandElement.constraint + +#### Inherited from + +ValueModel.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L43) + +• `set` **constraint**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Constraint`](model.Constraint-1.md) \| [`Definition`](../modules/model.Constraint.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +CommandElement.constraint + +#### Inherited from + +ValueModel.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L46) + +___ + +### definingModel + +• `get` **definingModel**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the first derived ancestor with children, if any. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.definingModel + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L158) + +___ + +### deprecated + +• `get` **deprecated**(): `boolean` + +Is this model deprecated? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.deprecated + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L220) + +___ + +### directMetatype + +• `get` **directMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The metatype for this model's type, ignoring inheritance. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +ValueModel.directMetatype + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L149) + +___ + +### disallowed + +• `get` **disallowed**(): `boolean` + +Is this model disallowed? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.disallowed + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L227) + +___ + +### effectiveAccess + +• `get` **effectiveAccess**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Inherited from + +ValueModel.effectiveAccess + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L69) + +___ + +### effectiveConformance + +• `get` **effectiveConformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Inherited from + +ValueModel.effectiveConformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L59) + +___ + +### effectiveConstraint + +• `get` **effectiveConstraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Inherited from + +ValueModel.effectiveConstraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L49) + +___ + +### effectiveDefault + +• `get` **effectiveDefault**(): `any` + +The value to use as a default. The "default" field has a manually +supplied value but this property decodes the default and/or generates +a default from subfields. + +#### Returns + +`any` + +#### Inherited from + +ValueModel.effectiveDefault + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L142) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +ValueModel.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveMetatype + +• `get` **effectiveMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The working metatype for this object. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +ValueModel.effectiveMetatype + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L130) + +___ + +### effectiveQuality + +• `get` **effectiveQuality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Inherited from + +ValueModel.effectiveQuality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L79) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +The "effective type" may be inferred from context. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +ValueModel.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L119) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +ValueModel.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +ValueModel.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### isRequest + +• `get` **isRequest**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L19) + +___ + +### isResponse + +• `get` **isResponse**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L23) + +___ + +### key + +• `get` **key**(): `string` + +Commands may re-use the ID for request and response so identification +requires the ID in conjunction with the direction. + +#### Returns + +`string` + +#### Overrides + +ValueModel.key + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L35) + +___ + +### listEntry + +• `get` **listEntry**(): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Get the entry type for lists, if any. + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Inherited from + +ValueModel.listEntry + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L165) + +___ + +### mandatory + +• `get` **mandatory**(): `boolean` + +Is this model mandatory? This supports a limited subset of conformance +and is only appropriate for field conformance. + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.mandatory + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L242) + +___ + +### members + +• `get` **members**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Retrieve all datatype members. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Inherited from + +ValueModel.members + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L190) + +___ + +### metabase + +• `get` **metabase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Metatype is only present on global types with specific semantic meaning. +This model is significant because it gives us information about how to +manipulate the data. This accessor retrieves this model. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.metabase + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L88) + +___ + +### nullable + +• `get` **nullable**(): `boolean` + +Can this model be omitted? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.nullable + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L234) + +___ + +### overridesShadow + +• `get` **overridesShadow**(): `undefined` \| ``true`` + +Determine whether this element overrides key properties of its shadow. + +#### Returns + +`undefined` \| ``true`` + +#### Inherited from + +ValueModel.overridesShadow + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L263) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +ValueModel.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +ValueModel.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### primitiveBase + +• `get` **primitiveBase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the primitive type for this value model. This is an integer type +for enums and bitmaps. Otherwise it's the metabase. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.primitiveBase + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L96) + +___ + +### quality + +• `get` **quality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Implementation of + +CommandElement.quality + +#### Inherited from + +ValueModel.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L73) + +• `set` **quality**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Quality`](model.Quality-1.md) \| [`Definition`](../modules/model.Quality.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +CommandElement.quality + +#### Inherited from + +ValueModel.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L76) + +___ + +### responseModel + +• `get` **responseModel**(): `undefined` \| [`Model`](model.Model-1.md) + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/CommandModel.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/CommandModel.ts#L27) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +___ + +### validationAspects + +• `get` **validationAspects**(): [`Aspect`](model.Aspect.md)<`any`\>[] + +Collect constraints and conformance for this type and all base types. + +#### Returns + +[`Aspect`](model.Aspect.md)<`any`\>[] + +#### Inherited from + +ValueModel.validationAspects + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L197) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[add](model.ValueModel.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[all](model.ValueModel.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### bitDefinition + +▸ **bitDefinition**(`bit`): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Search the inheritance chain for a bitmap field defining a specific bit. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bit` | `number` | + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[bitDefinition](model.ValueModel.md#bitdefinition) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:289](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L289) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[error](model.ValueModel.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[get](model.ValueModel.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[instanceOf](model.ValueModel.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[is](model.ValueModel.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[member](model.ValueModel.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[owner](model.ValueModel.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[references](model.ValueModel.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[toJSON](model.ValueModel.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[valueOf](model.ValueModel.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L293) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[visit](model.ValueModel.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[create](model.ValueModel.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.Conformance-1.md b/docs/matter.js/classes/model.Conformance-1.md new file mode 100644 index 0000000000..6302cc5f18 --- /dev/null +++ b/docs/matter.js/classes/model.Conformance-1.md @@ -0,0 +1,289 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / Conformance + +# Class: Conformance + +[model](../modules/model.md).Conformance + +An operational view of conformance as defined by the Matter Specification. + +We extend the specification's syntax to add ">", "<", ">=" and "<=". These +are required to encode some portions of the specification that are described +in prose. + +"Conformance" controls when a data field or cluster element is allowed or +required. + +## Hierarchy + +- [`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Conformance.md#definition)\> + + ↳ **`Conformance`** + +## Table of contents + +### Constructors + +- [constructor](model.Conformance-1.md#constructor) + +### Properties + +- [ast](model.Conformance-1.md#ast) +- [definition](model.Conformance-1.md#definition) +- [errors](model.Conformance-1.md#errors) + +### Accessors + +- [empty](model.Conformance-1.md#empty) +- [type](model.Conformance-1.md#type) +- [valid](model.Conformance-1.md#valid) + +### Methods + +- [equals](model.Conformance-1.md#equals) +- [error](model.Conformance-1.md#error) +- [extend](model.Conformance-1.md#extend) +- [toString](model.Conformance-1.md#tostring) +- [validateReferences](model.Conformance-1.md#validatereferences) +- [valueOf](model.Conformance-1.md#valueof) + +## Constructors + +### constructor + +• **new Conformance**(`definition`) + +Initialize from a Conformance.Definition or the conformance DSL defined +by the Matter Specification. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Definition`](../modules/model.Conformance.md#definition) | + +#### Overrides + +[Aspect](model.Aspect.md).[constructor](model.Aspect.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L35) + +## Properties + +### ast + +• **ast**: [`Ast`](../modules/model.Conformance.md#ast) + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L21) + +___ + +### definition + +• **definition**: [`Definition`](../modules/model.Conformance.md#definition) + +#### Inherited from + +[Aspect](model.Aspect.md).[definition](model.Aspect.md#definition) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L17) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Aspect](model.Aspect.md).[errors](model.Aspect.md#errors) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L18) + +## Accessors + +### empty + +• `get` **empty**(): `boolean` + +#### Returns + +`boolean` + +#### Overrides + +Aspect.empty + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L27) + +___ + +### type + +• `get` **type**(): [`Empty`](../enums/model.Conformance.Special.md#empty) \| [`Desc`](../enums/model.Conformance.Special.md#desc) \| [`Name`](../enums/model.Conformance.Special.md#name) \| [`Value`](../enums/model.Conformance.Special.md#value) \| [`Choice`](../enums/model.Conformance.Special.md#choice) \| [`Group`](../enums/model.Conformance.Special.md#group) \| [`OptionalIf`](../enums/model.Conformance.Special.md#optionalif) \| [`Flag`](../enums/model.Conformance.Flag.md) \| [`NOT`](../enums/model.Conformance.Operator.md#not) \| [`EQ`](../enums/model.Conformance.Operator.md#eq) \| [`NE`](../enums/model.Conformance.Operator.md#ne) \| [`OR`](../enums/model.Conformance.Operator.md#or) \| [`XOR`](../enums/model.Conformance.Operator.md#xor) \| [`AND`](../enums/model.Conformance.Operator.md#and) \| [`GT`](../enums/model.Conformance.Operator.md#gt) \| [`LT`](../enums/model.Conformance.Operator.md#lt) \| [`GTE`](../enums/model.Conformance.Operator.md#gte) \| [`LTE`](../enums/model.Conformance.Operator.md#lte) + +#### Returns + +[`Empty`](../enums/model.Conformance.Special.md#empty) \| [`Desc`](../enums/model.Conformance.Special.md#desc) \| [`Name`](../enums/model.Conformance.Special.md#name) \| [`Value`](../enums/model.Conformance.Special.md#value) \| [`Choice`](../enums/model.Conformance.Special.md#choice) \| [`Group`](../enums/model.Conformance.Special.md#group) \| [`OptionalIf`](../enums/model.Conformance.Special.md#optionalif) \| [`Flag`](../enums/model.Conformance.Flag.md) \| [`NOT`](../enums/model.Conformance.Operator.md#not) \| [`EQ`](../enums/model.Conformance.Operator.md#eq) \| [`NE`](../enums/model.Conformance.Operator.md#ne) \| [`OR`](../enums/model.Conformance.Operator.md#or) \| [`XOR`](../enums/model.Conformance.Operator.md#xor) \| [`AND`](../enums/model.Conformance.Operator.md#and) \| [`GT`](../enums/model.Conformance.Operator.md#gt) \| [`LT`](../enums/model.Conformance.Operator.md#lt) \| [`GTE`](../enums/model.Conformance.Operator.md#gte) \| [`LTE`](../enums/model.Conformance.Operator.md#lte) + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L23) + +___ + +### valid + +• `get` **valid**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Aspect.valid + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L20) + +## Methods + +### equals + +▸ **equals**(`other`): `boolean` + +Test for logical equivalence. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Aspect](model.Aspect.md).[equals](model.Aspect.md#equals) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L40) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Aspect](model.Aspect.md).[error](model.Aspect.md#error) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L54) + +___ + +### extend + +▸ **extend**(`other`): [`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Conformance.md#definition)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`Definition`](../modules/model.Conformance.md#definition) | + +#### Returns + +[`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Conformance.md#definition)\> + +#### Inherited from + +[Aspect](model.Aspect.md).[extend](model.Aspect.md#extend) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L65) + +___ + +### toString + +▸ **toString**(): `string` + +#### Returns + +`string` + +#### Overrides + +[Aspect](model.Aspect.md).[toString](model.Aspect.md#tostring) + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L68) + +___ + +### validateReferences + +▸ **validateReferences**(`lookup`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lookup` | [`ReferenceResolver`](../modules/model.Conformance.md#referenceresolver)<`boolean`\> | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L64) + +___ + +### valueOf + +▸ **valueOf**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[Aspect](model.Aspect.md).[valueOf](model.Aspect.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L47) diff --git a/docs/matter.js/classes/model.Constraint-1.md b/docs/matter.js/classes/model.Constraint-1.md new file mode 100644 index 0000000000..f4d0bcde21 --- /dev/null +++ b/docs/matter.js/classes/model.Constraint-1.md @@ -0,0 +1,358 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / Constraint + +# Class: Constraint + +[model](../modules/model.md).Constraint + +An operational view of constraints as defined by the Matter specification. + +A "constraint" limits possible data values. + +Formally a constraint is not considered a quality by the specification. +It is handled similarly to qualities, though, so we keep it in the same +section. + +## Hierarchy + +- [`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Constraint.md#definition)\> + + ↳ **`Constraint`** + +## Implements + +- [`Ast`](../modules/model.Constraint.md#ast) + +## Table of contents + +### Constructors + +- [constructor](model.Constraint-1.md#constructor) + +### Properties + +- [definition](model.Constraint-1.md#definition) +- [desc](model.Constraint-1.md#desc) +- [entry](model.Constraint-1.md#entry) +- [errors](model.Constraint-1.md#errors) +- [max](model.Constraint-1.md#max) +- [min](model.Constraint-1.md#min) +- [parts](model.Constraint-1.md#parts) +- [value](model.Constraint-1.md#value) + +### Accessors + +- [empty](model.Constraint-1.md#empty) +- [valid](model.Constraint-1.md#valid) + +### Methods + +- [equals](model.Constraint-1.md#equals) +- [error](model.Constraint-1.md#error) +- [extend](model.Constraint-1.md#extend) +- [test](model.Constraint-1.md#test) +- [toString](model.Constraint-1.md#tostring) +- [valueOf](model.Constraint-1.md#valueof) + +## Constructors + +### constructor + +• **new Constraint**(`definition`) + +Initialize from a Constraint.Definition or the constraint DSL defined +by the Matter Specification. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Definition`](../modules/model.Constraint.md#definition) | + +#### Overrides + +[Aspect](model.Aspect.md).[constructor](model.Aspect.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L32) + +## Properties + +### definition + +• **definition**: [`Definition`](../modules/model.Constraint.md#definition) + +#### Inherited from + +[Aspect](model.Aspect.md).[definition](model.Aspect.md#definition) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L17) + +___ + +### desc + +• `Optional` **desc**: `boolean` + +#### Implementation of + +Constraint.Ast.desc + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L21) + +___ + +### entry + +• `Optional` **entry**: [`Constraint`](model.Constraint-1.md) + +#### Implementation of + +Constraint.Ast.entry + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L25) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Aspect](model.Aspect.md).[errors](model.Aspect.md#errors) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L18) + +___ + +### max + +• `Optional` **max**: [`FieldValue`](../modules/model.md#fieldvalue) + +#### Implementation of + +Constraint.Ast.max + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L24) + +___ + +### min + +• `Optional` **min**: [`FieldValue`](../modules/model.md#fieldvalue) + +#### Implementation of + +Constraint.Ast.min + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L23) + +___ + +### parts + +• `Optional` **parts**: [`Constraint`](model.Constraint-1.md)[] + +#### Implementation of + +Constraint.Ast.parts + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L26) + +___ + +### value + +• `Optional` **value**: [`FieldValue`](../modules/model.md#fieldvalue) + +#### Implementation of + +Constraint.Ast.value + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L22) + +## Accessors + +### empty + +• `get` **empty**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Aspect.empty + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L28) + +___ + +### valid + +• `get` **valid**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Aspect.valid + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L20) + +## Methods + +### equals + +▸ **equals**(`other`): `boolean` + +Test for logical equivalence. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Aspect](model.Aspect.md).[equals](model.Aspect.md#equals) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L40) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Aspect](model.Aspect.md).[error](model.Aspect.md#error) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L54) + +___ + +### extend + +▸ **extend**(`other`): [`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Constraint.md#definition)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`Definition`](../modules/model.Constraint.md#definition) | + +#### Returns + +[`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Constraint.md#definition)\> + +#### Inherited from + +[Aspect](model.Aspect.md).[extend](model.Aspect.md#extend) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L65) + +___ + +### test + +▸ **test**(`value`): `boolean` + +Test a value against a constraint. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`FieldValue`](../modules/model.md#fieldvalue) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L55) + +___ + +### toString + +▸ **toString**(): `string` + +#### Returns + +`string` + +#### Overrides + +[Aspect](model.Aspect.md).[toString](model.Aspect.md#tostring) + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L83) + +___ + +### valueOf + +▸ **valueOf**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[Aspect](model.Aspect.md).[valueOf](model.Aspect.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L47) diff --git a/docs/matter.js/classes/model.DatatypeModel.md b/docs/matter.js/classes/model.DatatypeModel.md new file mode 100644 index 0000000000..4601b47ec1 --- /dev/null +++ b/docs/matter.js/classes/model.DatatypeModel.md @@ -0,0 +1,1618 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / DatatypeModel + +# Class: DatatypeModel + +[model](../modules/model.md).DatatypeModel + +Each ValueElement has a corresponding implementation that derives from +this class. + +## Hierarchy + +- [`ValueModel`](model.ValueModel.md) + + ↳ **`DatatypeModel`** + +## Implements + +- [`DatatypeElement`](../modules/model.md#datatypeelement) + +## Table of contents + +### Constructors + +- [constructor](model.DatatypeModel.md#constructor) + +### Properties + +- [byteSize](model.DatatypeModel.md#bytesize) +- [default](model.DatatypeModel.md#default) +- [description](model.DatatypeModel.md#description) +- [details](model.DatatypeModel.md#details) +- [errors](model.DatatypeModel.md#errors) +- [global](model.DatatypeModel.md#global) +- [id](model.DatatypeModel.md#id) +- [isType](model.DatatypeModel.md#istype) +- [isTypeScope](model.DatatypeModel.md#istypescope) +- [metatype](model.DatatypeModel.md#metatype) +- [name](model.DatatypeModel.md#name) +- [tag](model.DatatypeModel.md#tag) +- [type](model.DatatypeModel.md#type) +- [xref](model.DatatypeModel.md#xref) +- [constructors](model.DatatypeModel.md#constructors) + +### Accessors + +- [access](model.DatatypeModel.md#access) +- [allowedBaseTags](model.DatatypeModel.md#allowedbasetags) +- [base](model.DatatypeModel.md#base) +- [children](model.DatatypeModel.md#children) +- [conformance](model.DatatypeModel.md#conformance) +- [constraint](model.DatatypeModel.md#constraint) +- [definingModel](model.DatatypeModel.md#definingmodel) +- [deprecated](model.DatatypeModel.md#deprecated) +- [directMetatype](model.DatatypeModel.md#directmetatype) +- [disallowed](model.DatatypeModel.md#disallowed) +- [effectiveAccess](model.DatatypeModel.md#effectiveaccess) +- [effectiveConformance](model.DatatypeModel.md#effectiveconformance) +- [effectiveConstraint](model.DatatypeModel.md#effectiveconstraint) +- [effectiveDefault](model.DatatypeModel.md#effectivedefault) +- [effectiveId](model.DatatypeModel.md#effectiveid) +- [effectiveMetatype](model.DatatypeModel.md#effectivemetatype) +- [effectiveQuality](model.DatatypeModel.md#effectivequality) +- [effectiveType](model.DatatypeModel.md#effectivetype) +- [effectiveXref](model.DatatypeModel.md#effectivexref) +- [elements](model.DatatypeModel.md#elements) +- [globalBase](model.DatatypeModel.md#globalbase) +- [key](model.DatatypeModel.md#key) +- [listEntry](model.DatatypeModel.md#listentry) +- [mandatory](model.DatatypeModel.md#mandatory) +- [members](model.DatatypeModel.md#members) +- [metabase](model.DatatypeModel.md#metabase) +- [nullable](model.DatatypeModel.md#nullable) +- [overridesShadow](model.DatatypeModel.md#overridesshadow) +- [parent](model.DatatypeModel.md#parent) +- [path](model.DatatypeModel.md#path) +- [primitiveBase](model.DatatypeModel.md#primitivebase) +- [quality](model.DatatypeModel.md#quality) +- [shadow](model.DatatypeModel.md#shadow) +- [valid](model.DatatypeModel.md#valid) +- [validationAspects](model.DatatypeModel.md#validationaspects) + +### Methods + +- [add](model.DatatypeModel.md#add) +- [all](model.DatatypeModel.md#all) +- [bitDefinition](model.DatatypeModel.md#bitdefinition) +- [error](model.DatatypeModel.md#error) +- [get](model.DatatypeModel.md#get) +- [instanceOf](model.DatatypeModel.md#instanceof) +- [is](model.DatatypeModel.md#is) +- [member](model.DatatypeModel.md#member) +- [owner](model.DatatypeModel.md#owner) +- [references](model.DatatypeModel.md#references) +- [toJSON](model.DatatypeModel.md#tojson) +- [valueOf](model.DatatypeModel.md#valueof) +- [visit](model.DatatypeModel.md#visit) +- [create](model.DatatypeModel.md#create) + +## Constructors + +### constructor + +• **new DatatypeModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.DatatypeElement.md#properties) | + +#### Overrides + +[ValueModel](model.ValueModel.md).[constructor](model.ValueModel.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/DatatypeModel.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DatatypeModel.ts#L16) + +## Properties + +### byteSize + +• `Optional` **byteSize**: [`Size`](../modules/model.ValueElement.md#size) + +#### Implementation of + +DatatypeElement.byteSize + +#### Inherited from + +[ValueModel](model.ValueModel.md).[byteSize](model.ValueModel.md#bytesize) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L30) + +___ + +### default + +• `Optional` **default**: [`FieldValue`](../modules/model.md#fieldvalue) + +#### Implementation of + +DatatypeElement.default + +#### Inherited from + +[ValueModel](model.ValueModel.md).[default](model.ValueModel.md#default) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L31) + +___ + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +DatatypeElement.description + +#### Inherited from + +[ValueModel](model.ValueModel.md).[description](model.ValueModel.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +DatatypeElement.details + +#### Inherited from + +[ValueModel](model.ValueModel.md).[details](model.ValueModel.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[errors](model.ValueModel.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +DatatypeElement.global + +#### Inherited from + +[ValueModel](model.ValueModel.md).[global](model.ValueModel.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• `Optional` **id**: `number` + +#### Implementation of + +DatatypeElement.id + +#### Overrides + +[ValueModel](model.ValueModel.md).[id](model.ValueModel.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/DatatypeModel.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DatatypeModel.ts#L14) + +___ + +### isType + +• `Optional` **isType**: `boolean` = `true` + +Indicates that an element defines a datatype. + +#### Inherited from + +[ValueModel](model.ValueModel.md).[isType](model.ValueModel.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L33) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[ValueModel](model.ValueModel.md).[isTypeScope](model.ValueModel.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### metatype + +• `Optional` **metatype**: [`Metatype`](../enums/model.Metatype-1.md) + +#### Implementation of + +DatatypeElement.metatype + +#### Inherited from + +[ValueModel](model.ValueModel.md).[metatype](model.ValueModel.md#metatype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L32) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +DatatypeElement.name + +#### Inherited from + +[ValueModel](model.ValueModel.md).[name](model.ValueModel.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• **tag**: [`Datatype`](../enums/model.ElementTag.md#datatype) = `DatatypeElement.Tag` + +#### Implementation of + +DatatypeElement.tag + +#### Overrides + +[ValueModel](model.ValueModel.md).[tag](model.ValueModel.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/DatatypeModel.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DatatypeModel.ts#L13) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +DatatypeElement.type + +#### Inherited from + +[ValueModel](model.ValueModel.md).[type](model.ValueModel.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +DatatypeElement.xref + +#### Inherited from + +[ValueModel](model.ValueModel.md).[xref](model.ValueModel.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[constructors](model.ValueModel.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### access + +• `get` **access**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Implementation of + +DatatypeElement.access + +#### Inherited from + +ValueModel.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L63) + +• `set` **access**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Access`](model.Access-1.md) \| [`Definition`](../modules/model.Access.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +DatatypeElement.access + +#### Inherited from + +ValueModel.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L66) + +___ + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +ValueModels may derive from models of the same type or from generic +Datatype models. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +ValueModel.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L180) + +___ + +### base + +• `get` **base**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +ValueModels may only derive from ValueModels. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.base + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L172) + +___ + +### children + +• `get` **children**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Children of models are always models. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Implementation of + +DatatypeElement.children + +#### Inherited from + +ValueModel.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L35) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`DatatypeElement`](../modules/model.md#datatypeelement) \| [`DatatypeModel`](model.DatatypeModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +DatatypeElement.children + +#### Inherited from + +ValueModel.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L39) + +___ + +### conformance + +• `get` **conformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Implementation of + +DatatypeElement.conformance + +#### Inherited from + +ValueModel.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L53) + +• `set` **conformance**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Conformance`](model.Conformance-1.md) \| [`Definition`](../modules/model.Conformance.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +DatatypeElement.conformance + +#### Inherited from + +ValueModel.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L56) + +___ + +### constraint + +• `get` **constraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Implementation of + +DatatypeElement.constraint + +#### Inherited from + +ValueModel.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L43) + +• `set` **constraint**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Constraint`](model.Constraint-1.md) \| [`Definition`](../modules/model.Constraint.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +DatatypeElement.constraint + +#### Inherited from + +ValueModel.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L46) + +___ + +### definingModel + +• `get` **definingModel**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the first derived ancestor with children, if any. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.definingModel + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L158) + +___ + +### deprecated + +• `get` **deprecated**(): `boolean` + +Is this model deprecated? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.deprecated + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L220) + +___ + +### directMetatype + +• `get` **directMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The metatype for this model's type, ignoring inheritance. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +ValueModel.directMetatype + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L149) + +___ + +### disallowed + +• `get` **disallowed**(): `boolean` + +Is this model disallowed? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.disallowed + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L227) + +___ + +### effectiveAccess + +• `get` **effectiveAccess**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Inherited from + +ValueModel.effectiveAccess + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L69) + +___ + +### effectiveConformance + +• `get` **effectiveConformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Inherited from + +ValueModel.effectiveConformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L59) + +___ + +### effectiveConstraint + +• `get` **effectiveConstraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Inherited from + +ValueModel.effectiveConstraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L49) + +___ + +### effectiveDefault + +• `get` **effectiveDefault**(): `any` + +The value to use as a default. The "default" field has a manually +supplied value but this property decodes the default and/or generates +a default from subfields. + +#### Returns + +`any` + +#### Inherited from + +ValueModel.effectiveDefault + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L142) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Datatypes parented by other datatypes can omit their ID. In this case +we use their index within the parent as the ID. + +Note that this is only true for fields. For named datatypes that appear +directly under the cluster the name is the canonical key. + +#### Returns + +`undefined` \| `number` + +#### Overrides + +ValueModel.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/DatatypeModel.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DatatypeModel.ts#L27) + +___ + +### effectiveMetatype + +• `get` **effectiveMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The working metatype for this object. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +ValueModel.effectiveMetatype + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L130) + +___ + +### effectiveQuality + +• `get` **effectiveQuality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Inherited from + +ValueModel.effectiveQuality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L79) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +The "effective type" may be inferred from context. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +ValueModel.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L119) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +ValueModel.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +ValueModel.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +The key for bitmap fields is actually the constraint which defines the +bit range. All other datatypes use the default key. + +#### Returns + +`undefined` \| `string` + +#### Overrides + +ValueModel.key + +#### Defined in + +[packages/matter.js/src/model/models/DatatypeModel.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DatatypeModel.ts#L43) + +___ + +### listEntry + +• `get` **listEntry**(): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Get the entry type for lists, if any. + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Inherited from + +ValueModel.listEntry + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L165) + +___ + +### mandatory + +• `get` **mandatory**(): `boolean` + +Is this model mandatory? This supports a limited subset of conformance +and is only appropriate for field conformance. + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.mandatory + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L242) + +___ + +### members + +• `get` **members**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Retrieve all datatype members. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Inherited from + +ValueModel.members + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L190) + +___ + +### metabase + +• `get` **metabase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Metatype is only present on global types with specific semantic meaning. +This model is significant because it gives us information about how to +manipulate the data. This accessor retrieves this model. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.metabase + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L88) + +___ + +### nullable + +• `get` **nullable**(): `boolean` + +Can this model be omitted? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.nullable + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L234) + +___ + +### overridesShadow + +• `get` **overridesShadow**(): `undefined` \| ``true`` + +Determine whether this element overrides key properties of its shadow. + +#### Returns + +`undefined` \| ``true`` + +#### Inherited from + +ValueModel.overridesShadow + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L263) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +ValueModel.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +ValueModel.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### primitiveBase + +• `get` **primitiveBase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the primitive type for this value model. This is an integer type +for enums and bitmaps. Otherwise it's the metabase. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.primitiveBase + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L96) + +___ + +### quality + +• `get` **quality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Implementation of + +DatatypeElement.quality + +#### Inherited from + +ValueModel.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L73) + +• `set` **quality**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Quality`](model.Quality-1.md) \| [`Definition`](../modules/model.Quality.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +DatatypeElement.quality + +#### Inherited from + +ValueModel.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L76) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +___ + +### validationAspects + +• `get` **validationAspects**(): [`Aspect`](model.Aspect.md)<`any`\>[] + +Collect constraints and conformance for this type and all base types. + +#### Returns + +[`Aspect`](model.Aspect.md)<`any`\>[] + +#### Inherited from + +ValueModel.validationAspects + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L197) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[add](model.ValueModel.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[all](model.ValueModel.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### bitDefinition + +▸ **bitDefinition**(`bit`): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Search the inheritance chain for a bitmap field defining a specific bit. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bit` | `number` | + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[bitDefinition](model.ValueModel.md#bitdefinition) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:289](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L289) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[error](model.ValueModel.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[get](model.ValueModel.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[instanceOf](model.ValueModel.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[is](model.ValueModel.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[member](model.ValueModel.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[owner](model.ValueModel.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[references](model.ValueModel.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[toJSON](model.ValueModel.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[valueOf](model.ValueModel.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L293) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[visit](model.ValueModel.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[create](model.ValueModel.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.DeviceTypeModel.md b/docs/matter.js/classes/model.DeviceTypeModel.md new file mode 100644 index 0000000000..a18fde7a23 --- /dev/null +++ b/docs/matter.js/classes/model.DeviceTypeModel.md @@ -0,0 +1,1009 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / DeviceTypeModel + +# Class: DeviceTypeModel + +[model](../modules/model.md).DeviceTypeModel + +A "model" is a class that implements runtime functionality associated with +the corresponding element type. + +## Hierarchy + +- [`Model`](model.Model-1.md) + + ↳ **`DeviceTypeModel`** + +## Implements + +- [`DeviceTypeElement`](../modules/model.md#devicetypeelement) + +## Table of contents + +### Constructors + +- [constructor](model.DeviceTypeModel.md#constructor) + +### Properties + +- [classification](model.DeviceTypeModel.md#classification) +- [description](model.DeviceTypeModel.md#description) +- [details](model.DeviceTypeModel.md#details) +- [errors](model.DeviceTypeModel.md#errors) +- [global](model.DeviceTypeModel.md#global) +- [id](model.DeviceTypeModel.md#id) +- [isType](model.DeviceTypeModel.md#istype) +- [isTypeScope](model.DeviceTypeModel.md#istypescope) +- [name](model.DeviceTypeModel.md#name) +- [revision](model.DeviceTypeModel.md#revision) +- [tag](model.DeviceTypeModel.md#tag) +- [type](model.DeviceTypeModel.md#type) +- [xref](model.DeviceTypeModel.md#xref) +- [constructors](model.DeviceTypeModel.md#constructors) + +### Accessors + +- [allowedBaseTags](model.DeviceTypeModel.md#allowedbasetags) +- [base](model.DeviceTypeModel.md#base) +- [children](model.DeviceTypeModel.md#children) +- [effectiveId](model.DeviceTypeModel.md#effectiveid) +- [effectiveType](model.DeviceTypeModel.md#effectivetype) +- [effectiveXref](model.DeviceTypeModel.md#effectivexref) +- [elements](model.DeviceTypeModel.md#elements) +- [globalBase](model.DeviceTypeModel.md#globalbase) +- [key](model.DeviceTypeModel.md#key) +- [parent](model.DeviceTypeModel.md#parent) +- [path](model.DeviceTypeModel.md#path) +- [requirements](model.DeviceTypeModel.md#requirements) +- [shadow](model.DeviceTypeModel.md#shadow) +- [valid](model.DeviceTypeModel.md#valid) + +### Methods + +- [add](model.DeviceTypeModel.md#add) +- [all](model.DeviceTypeModel.md#all) +- [error](model.DeviceTypeModel.md#error) +- [get](model.DeviceTypeModel.md#get) +- [instanceOf](model.DeviceTypeModel.md#instanceof) +- [is](model.DeviceTypeModel.md#is) +- [member](model.DeviceTypeModel.md#member) +- [owner](model.DeviceTypeModel.md#owner) +- [references](model.DeviceTypeModel.md#references) +- [toJSON](model.DeviceTypeModel.md#tojson) +- [valueOf](model.DeviceTypeModel.md#valueof) +- [visit](model.DeviceTypeModel.md#visit) +- [create](model.DeviceTypeModel.md#create) + +## Constructors + +### constructor + +• **new DeviceTypeModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.DeviceTypeElement.md#properties) | + +#### Overrides + +[Model](model.Model-1.md).[constructor](model.Model-1.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/DeviceTypeModel.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DeviceTypeModel.ts#L31) + +## Properties + +### classification + +• **classification**: [`Classification`](../enums/model.DeviceTypeElement.Classification.md) + +#### Implementation of + +DeviceTypeElement.classification + +#### Defined in + +[packages/matter.js/src/model/models/DeviceTypeModel.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DeviceTypeModel.ts#L16) + +___ + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +DeviceTypeElement.description + +#### Inherited from + +[Model](model.Model-1.md).[description](model.Model-1.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +DeviceTypeElement.details + +#### Inherited from + +[Model](model.Model-1.md).[details](model.Model-1.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Model](model.Model-1.md).[errors](model.Model-1.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +DeviceTypeElement.global + +#### Inherited from + +[Model](model.Model-1.md).[global](model.Model-1.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• **id**: `number` + +#### Implementation of + +DeviceTypeElement.id + +#### Overrides + +[Model](model.Model-1.md).[id](model.Model-1.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/DeviceTypeModel.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DeviceTypeModel.ts#L15) + +___ + +### isType + +• `Optional` **isType**: `boolean` + +Indicates that an element defines a datatype. + +#### Inherited from + +[Model](model.Model-1.md).[isType](model.Model-1.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L44) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[Model](model.Model-1.md).[isTypeScope](model.Model-1.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +DeviceTypeElement.name + +#### Inherited from + +[Model](model.Model-1.md).[name](model.Model-1.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### revision + +• **revision**: `number` + +#### Defined in + +[packages/matter.js/src/model/models/DeviceTypeModel.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DeviceTypeModel.ts#L17) + +___ + +### tag + +• **tag**: [`DeviceType`](../enums/model.ElementTag.md#devicetype) = `DeviceTypeElement.Tag` + +#### Implementation of + +DeviceTypeElement.tag + +#### Overrides + +[Model](model.Model-1.md).[tag](model.Model-1.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/DeviceTypeModel.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DeviceTypeModel.ts#L14) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +DeviceTypeElement.type + +#### Inherited from + +[Model](model.Model-1.md).[type](model.Model-1.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +DeviceTypeElement.xref + +#### Inherited from + +[Model](model.Model-1.md).[xref](model.Model-1.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[constructors](model.Model-1.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +The set of tags from which this model may derive. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +Model.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L237) + +___ + +### base + +• `get` **base**(): `undefined` \| [`Model`](model.Model-1.md) + +Get a Model for my base type, if any. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.base + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L207) + +___ + +### children + +• `get` **children**(): ([`DatatypeModel`](model.DatatypeModel.md) \| [`RequirementModel`](model.RequirementModel.md))[] + +Children of models are always models. + +#### Returns + +([`DatatypeModel`](model.DatatypeModel.md) \| [`RequirementModel`](model.RequirementModel.md))[] + +#### Implementation of + +DeviceTypeElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/DeviceTypeModel.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DeviceTypeModel.ts#L23) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`DatatypeElement`](../modules/model.md#datatypeelement) \| [`RequirementElement`](../modules/model.md#requirementelement) \| [`DatatypeModel`](model.DatatypeModel.md) \| [`RequirementModel`](model.RequirementModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +DeviceTypeElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/DeviceTypeModel.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DeviceTypeModel.ts#L27) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Model.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +In some circumstances the base type can be inferred. This inference +happens here. + +Does not recurse so only returns the direct base type. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L200) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +Model.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +Model.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +Model.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### requirements + +• `get` **requirements**(): [`RequirementModel`](model.RequirementModel.md)[] + +#### Returns + +[`RequirementModel`](model.RequirementModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/DeviceTypeModel.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/DeviceTypeModel.ts#L19) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +Model.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[add](model.Model-1.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[Model](model.Model-1.md).[all](model.Model-1.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[error](model.Model-1.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[Model](model.Model-1.md).[get](model.Model-1.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[instanceOf](model.Model-1.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[is](model.Model-1.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[member](model.Model-1.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[Model](model.Model-1.md).[owner](model.Model-1.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[Model](model.Model-1.md).[references](model.Model-1.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[toJSON](model.Model-1.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[valueOf](model.Model-1.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L326) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[Model](model.Model-1.md).[visit](model.Model-1.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[create](model.Model-1.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.EndpointModel.md b/docs/matter.js/classes/model.EndpointModel.md new file mode 100644 index 0000000000..1ce4ade613 --- /dev/null +++ b/docs/matter.js/classes/model.EndpointModel.md @@ -0,0 +1,983 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / EndpointModel + +# Class: EndpointModel + +[model](../modules/model.md).EndpointModel + +A "model" is a class that implements runtime functionality associated with +the corresponding element type. + +## Hierarchy + +- [`Model`](model.Model-1.md) + + ↳ **`EndpointModel`** + +## Implements + +- [`EndpointElement`](../modules/model.md#endpointelement) + +## Table of contents + +### Constructors + +- [constructor](model.EndpointModel.md#constructor) + +### Properties + +- [description](model.EndpointModel.md#description) +- [details](model.EndpointModel.md#details) +- [errors](model.EndpointModel.md#errors) +- [global](model.EndpointModel.md#global) +- [id](model.EndpointModel.md#id) +- [isType](model.EndpointModel.md#istype) +- [isTypeScope](model.EndpointModel.md#istypescope) +- [name](model.EndpointModel.md#name) +- [tag](model.EndpointModel.md#tag) +- [type](model.EndpointModel.md#type) +- [xref](model.EndpointModel.md#xref) +- [constructors](model.EndpointModel.md#constructors) + +### Accessors + +- [allowedBaseTags](model.EndpointModel.md#allowedbasetags) +- [base](model.EndpointModel.md#base) +- [children](model.EndpointModel.md#children) +- [deviceTypes](model.EndpointModel.md#devicetypes) +- [effectiveId](model.EndpointModel.md#effectiveid) +- [effectiveType](model.EndpointModel.md#effectivetype) +- [effectiveXref](model.EndpointModel.md#effectivexref) +- [elements](model.EndpointModel.md#elements) +- [globalBase](model.EndpointModel.md#globalbase) +- [key](model.EndpointModel.md#key) +- [parent](model.EndpointModel.md#parent) +- [path](model.EndpointModel.md#path) +- [shadow](model.EndpointModel.md#shadow) +- [valid](model.EndpointModel.md#valid) + +### Methods + +- [add](model.EndpointModel.md#add) +- [all](model.EndpointModel.md#all) +- [error](model.EndpointModel.md#error) +- [get](model.EndpointModel.md#get) +- [instanceOf](model.EndpointModel.md#instanceof) +- [is](model.EndpointModel.md#is) +- [member](model.EndpointModel.md#member) +- [owner](model.EndpointModel.md#owner) +- [references](model.EndpointModel.md#references) +- [toJSON](model.EndpointModel.md#tojson) +- [valueOf](model.EndpointModel.md#valueof) +- [visit](model.EndpointModel.md#visit) +- [create](model.EndpointModel.md#create) + +## Constructors + +### constructor + +• **new EndpointModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.EndpointElement.md#properties) | + +#### Overrides + +[Model](model.Model-1.md).[constructor](model.Model-1.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/EndpointModel.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EndpointModel.ts#L27) + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +EndpointElement.description + +#### Inherited from + +[Model](model.Model-1.md).[description](model.Model-1.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +EndpointElement.details + +#### Inherited from + +[Model](model.Model-1.md).[details](model.Model-1.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Model](model.Model-1.md).[errors](model.Model-1.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +EndpointElement.global + +#### Inherited from + +[Model](model.Model-1.md).[global](model.Model-1.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• **id**: `number` + +#### Implementation of + +EndpointElement.id + +#### Overrides + +[Model](model.Model-1.md).[id](model.Model-1.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/EndpointModel.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EndpointModel.ts#L13) + +___ + +### isType + +• `Optional` **isType**: `boolean` + +Indicates that an element defines a datatype. + +#### Inherited from + +[Model](model.Model-1.md).[isType](model.Model-1.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L44) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[Model](model.Model-1.md).[isTypeScope](model.Model-1.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +EndpointElement.name + +#### Inherited from + +[Model](model.Model-1.md).[name](model.Model-1.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• **tag**: [`Endpoint`](../enums/model.ElementTag.md#endpoint) = `EndpointElement.Tag` + +#### Implementation of + +EndpointElement.tag + +#### Overrides + +[Model](model.Model-1.md).[tag](model.Model-1.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/EndpointModel.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EndpointModel.ts#L12) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +EndpointElement.type + +#### Inherited from + +[Model](model.Model-1.md).[type](model.Model-1.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +EndpointElement.xref + +#### Inherited from + +[Model](model.Model-1.md).[xref](model.Model-1.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[constructors](model.Model-1.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +The set of tags from which this model may derive. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +Model.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L237) + +___ + +### base + +• `get` **base**(): `undefined` \| [`Model`](model.Model-1.md) + +Get a Model for my base type, if any. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.base + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L207) + +___ + +### children + +• `get` **children**(): [`DeviceTypeModel`](model.DeviceTypeModel.md)[] + +Children of models are always models. + +#### Returns + +[`DeviceTypeModel`](model.DeviceTypeModel.md)[] + +#### Implementation of + +EndpointElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/EndpointModel.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EndpointModel.ts#L19) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`DeviceTypeElement`](../modules/model.md#devicetypeelement) \| [`DeviceTypeModel`](model.DeviceTypeModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +EndpointElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/EndpointModel.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EndpointModel.ts#L23) + +___ + +### deviceTypes + +• `get` **deviceTypes**(): [`DeviceTypeModel`](model.DeviceTypeModel.md)[] + +#### Returns + +[`DeviceTypeModel`](model.DeviceTypeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/EndpointModel.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EndpointModel.ts#L15) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Model.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +In some circumstances the base type can be inferred. This inference +happens here. + +Does not recurse so only returns the direct base type. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L200) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +Model.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +Model.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +Model.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +Model.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[add](model.Model-1.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[Model](model.Model-1.md).[all](model.Model-1.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[error](model.Model-1.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[Model](model.Model-1.md).[get](model.Model-1.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[instanceOf](model.Model-1.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[is](model.Model-1.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[member](model.Model-1.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[Model](model.Model-1.md).[owner](model.Model-1.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[Model](model.Model-1.md).[references](model.Model-1.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[toJSON](model.Model-1.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[valueOf](model.Model-1.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L326) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[Model](model.Model-1.md).[visit](model.Model-1.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[create](model.Model-1.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.EventModel.md b/docs/matter.js/classes/model.EventModel.md new file mode 100644 index 0000000000..e315f9220c --- /dev/null +++ b/docs/matter.js/classes/model.EventModel.md @@ -0,0 +1,1636 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / EventModel + +# Class: EventModel + +[model](../modules/model.md).EventModel + +Each ValueElement has a corresponding implementation that derives from +this class. + +## Hierarchy + +- [`ValueModel`](model.ValueModel.md) + + ↳ **`EventModel`** + +## Implements + +- [`EventElement`](../modules/model.md#eventelement) + +## Table of contents + +### Constructors + +- [constructor](model.EventModel.md#constructor) + +### Properties + +- [byteSize](model.EventModel.md#bytesize) +- [default](model.EventModel.md#default) +- [description](model.EventModel.md#description) +- [details](model.EventModel.md#details) +- [errors](model.EventModel.md#errors) +- [global](model.EventModel.md#global) +- [id](model.EventModel.md#id) +- [isType](model.EventModel.md#istype) +- [isTypeScope](model.EventModel.md#istypescope) +- [metatype](model.EventModel.md#metatype) +- [name](model.EventModel.md#name) +- [priority](model.EventModel.md#priority) +- [tag](model.EventModel.md#tag) +- [type](model.EventModel.md#type) +- [xref](model.EventModel.md#xref) +- [Tag](model.EventModel.md#tag-1) +- [constructors](model.EventModel.md#constructors) + +### Accessors + +- [access](model.EventModel.md#access) +- [allowedBaseTags](model.EventModel.md#allowedbasetags) +- [base](model.EventModel.md#base) +- [children](model.EventModel.md#children) +- [conformance](model.EventModel.md#conformance) +- [constraint](model.EventModel.md#constraint) +- [definingModel](model.EventModel.md#definingmodel) +- [deprecated](model.EventModel.md#deprecated) +- [directMetatype](model.EventModel.md#directmetatype) +- [disallowed](model.EventModel.md#disallowed) +- [effectiveAccess](model.EventModel.md#effectiveaccess) +- [effectiveConformance](model.EventModel.md#effectiveconformance) +- [effectiveConstraint](model.EventModel.md#effectiveconstraint) +- [effectiveDefault](model.EventModel.md#effectivedefault) +- [effectiveId](model.EventModel.md#effectiveid) +- [effectiveMetatype](model.EventModel.md#effectivemetatype) +- [effectiveQuality](model.EventModel.md#effectivequality) +- [effectiveType](model.EventModel.md#effectivetype) +- [effectiveXref](model.EventModel.md#effectivexref) +- [elements](model.EventModel.md#elements) +- [globalBase](model.EventModel.md#globalbase) +- [key](model.EventModel.md#key) +- [listEntry](model.EventModel.md#listentry) +- [mandatory](model.EventModel.md#mandatory) +- [members](model.EventModel.md#members) +- [metabase](model.EventModel.md#metabase) +- [nullable](model.EventModel.md#nullable) +- [overridesShadow](model.EventModel.md#overridesshadow) +- [parent](model.EventModel.md#parent) +- [path](model.EventModel.md#path) +- [primitiveBase](model.EventModel.md#primitivebase) +- [quality](model.EventModel.md#quality) +- [shadow](model.EventModel.md#shadow) +- [valid](model.EventModel.md#valid) +- [validationAspects](model.EventModel.md#validationaspects) + +### Methods + +- [add](model.EventModel.md#add) +- [all](model.EventModel.md#all) +- [bitDefinition](model.EventModel.md#bitdefinition) +- [error](model.EventModel.md#error) +- [get](model.EventModel.md#get) +- [instanceOf](model.EventModel.md#instanceof) +- [is](model.EventModel.md#is) +- [member](model.EventModel.md#member) +- [owner](model.EventModel.md#owner) +- [references](model.EventModel.md#references) +- [toJSON](model.EventModel.md#tojson) +- [valueOf](model.EventModel.md#valueof) +- [visit](model.EventModel.md#visit) +- [create](model.EventModel.md#create) + +## Constructors + +### constructor + +• **new EventModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.EventElement.md#properties) | + +#### Overrides + +[ValueModel](model.ValueModel.md).[constructor](model.ValueModel.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/EventModel.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EventModel.ts#L17) + +## Properties + +### byteSize + +• `Optional` **byteSize**: [`Size`](../modules/model.ValueElement.md#size) + +#### Implementation of + +EventElement.byteSize + +#### Inherited from + +[ValueModel](model.ValueModel.md).[byteSize](model.ValueModel.md#bytesize) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L30) + +___ + +### default + +• `Optional` **default**: [`FieldValue`](../modules/model.md#fieldvalue) + +#### Implementation of + +EventElement.default + +#### Inherited from + +[ValueModel](model.ValueModel.md).[default](model.ValueModel.md#default) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L31) + +___ + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +EventElement.description + +#### Inherited from + +[ValueModel](model.ValueModel.md).[description](model.ValueModel.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +EventElement.details + +#### Inherited from + +[ValueModel](model.ValueModel.md).[details](model.ValueModel.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[errors](model.ValueModel.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +EventElement.global + +#### Inherited from + +[ValueModel](model.ValueModel.md).[global](model.ValueModel.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• **id**: `number` + +#### Implementation of + +EventElement.id + +#### Overrides + +[ValueModel](model.ValueModel.md).[id](model.ValueModel.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/EventModel.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EventModel.ts#L14) + +___ + +### isType + +• `Optional` **isType**: `boolean` = `true` + +Indicates that an element defines a datatype. + +#### Inherited from + +[ValueModel](model.ValueModel.md).[isType](model.ValueModel.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L33) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[ValueModel](model.ValueModel.md).[isTypeScope](model.ValueModel.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### metatype + +• `Optional` **metatype**: [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[metatype](model.ValueModel.md#metatype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L32) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +EventElement.name + +#### Inherited from + +[ValueModel](model.ValueModel.md).[name](model.ValueModel.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### priority + +• `Optional` **priority**: [`Priority`](../enums/model.EventElement.Priority.md) + +#### Implementation of + +EventElement.priority + +#### Defined in + +[packages/matter.js/src/model/models/EventModel.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EventModel.ts#L15) + +___ + +### tag + +• **tag**: [`Event`](../enums/model.ElementTag.md#event) = `EventElement.Tag` + +#### Implementation of + +EventElement.tag + +#### Overrides + +[ValueModel](model.ValueModel.md).[tag](model.ValueModel.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/EventModel.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EventModel.ts#L13) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +EventElement.type + +#### Inherited from + +[ValueModel](model.ValueModel.md).[type](model.ValueModel.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +EventElement.xref + +#### Inherited from + +[ValueModel](model.ValueModel.md).[xref](model.ValueModel.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### Tag + +▪ `Static` **Tag**: [`ElementTag`](../enums/model.ElementTag.md) = `EventElement.Tag` + +#### Defined in + +[packages/matter.js/src/model/models/EventModel.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/EventModel.ts#L25) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[constructors](model.ValueModel.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### access + +• `get` **access**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Implementation of + +EventElement.access + +#### Inherited from + +ValueModel.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L63) + +• `set` **access**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Access`](model.Access-1.md) \| [`Definition`](../modules/model.Access.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +EventElement.access + +#### Inherited from + +ValueModel.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L66) + +___ + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +ValueModels may derive from models of the same type or from generic +Datatype models. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +ValueModel.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L180) + +___ + +### base + +• `get` **base**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +ValueModels may only derive from ValueModels. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.base + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L172) + +___ + +### children + +• `get` **children**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Children of models are always models. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Implementation of + +EventElement.children + +#### Inherited from + +ValueModel.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L35) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`DatatypeElement`](../modules/model.md#datatypeelement) \| [`DatatypeModel`](model.DatatypeModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +EventElement.children + +#### Inherited from + +ValueModel.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L39) + +___ + +### conformance + +• `get` **conformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Implementation of + +EventElement.conformance + +#### Inherited from + +ValueModel.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L53) + +• `set` **conformance**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Conformance`](model.Conformance-1.md) \| [`Definition`](../modules/model.Conformance.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +EventElement.conformance + +#### Inherited from + +ValueModel.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L56) + +___ + +### constraint + +• `get` **constraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Implementation of + +EventElement.constraint + +#### Inherited from + +ValueModel.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L43) + +• `set` **constraint**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Constraint`](model.Constraint-1.md) \| [`Definition`](../modules/model.Constraint.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +EventElement.constraint + +#### Inherited from + +ValueModel.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L46) + +___ + +### definingModel + +• `get` **definingModel**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the first derived ancestor with children, if any. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.definingModel + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L158) + +___ + +### deprecated + +• `get` **deprecated**(): `boolean` + +Is this model deprecated? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.deprecated + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L220) + +___ + +### directMetatype + +• `get` **directMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The metatype for this model's type, ignoring inheritance. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +ValueModel.directMetatype + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L149) + +___ + +### disallowed + +• `get` **disallowed**(): `boolean` + +Is this model disallowed? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.disallowed + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L227) + +___ + +### effectiveAccess + +• `get` **effectiveAccess**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Inherited from + +ValueModel.effectiveAccess + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L69) + +___ + +### effectiveConformance + +• `get` **effectiveConformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Inherited from + +ValueModel.effectiveConformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L59) + +___ + +### effectiveConstraint + +• `get` **effectiveConstraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Inherited from + +ValueModel.effectiveConstraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L49) + +___ + +### effectiveDefault + +• `get` **effectiveDefault**(): `any` + +The value to use as a default. The "default" field has a manually +supplied value but this property decodes the default and/or generates +a default from subfields. + +#### Returns + +`any` + +#### Inherited from + +ValueModel.effectiveDefault + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L142) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +ValueModel.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveMetatype + +• `get` **effectiveMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The working metatype for this object. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Inherited from + +ValueModel.effectiveMetatype + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L130) + +___ + +### effectiveQuality + +• `get` **effectiveQuality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Inherited from + +ValueModel.effectiveQuality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L79) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +The "effective type" may be inferred from context. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +ValueModel.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L119) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +ValueModel.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +ValueModel.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +ValueModel.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### listEntry + +• `get` **listEntry**(): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Get the entry type for lists, if any. + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Inherited from + +ValueModel.listEntry + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L165) + +___ + +### mandatory + +• `get` **mandatory**(): `boolean` + +Is this model mandatory? This supports a limited subset of conformance +and is only appropriate for field conformance. + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.mandatory + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L242) + +___ + +### members + +• `get` **members**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Retrieve all datatype members. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Inherited from + +ValueModel.members + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L190) + +___ + +### metabase + +• `get` **metabase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Metatype is only present on global types with specific semantic meaning. +This model is significant because it gives us information about how to +manipulate the data. This accessor retrieves this model. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.metabase + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L88) + +___ + +### nullable + +• `get` **nullable**(): `boolean` + +Can this model be omitted? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.nullable + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L234) + +___ + +### overridesShadow + +• `get` **overridesShadow**(): `undefined` \| ``true`` + +Determine whether this element overrides key properties of its shadow. + +#### Returns + +`undefined` \| ``true`` + +#### Inherited from + +ValueModel.overridesShadow + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L263) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +ValueModel.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +ValueModel.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### primitiveBase + +• `get` **primitiveBase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the primitive type for this value model. This is an integer type +for enums and bitmaps. Otherwise it's the metabase. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Inherited from + +ValueModel.primitiveBase + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L96) + +___ + +### quality + +• `get` **quality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Implementation of + +EventElement.quality + +#### Inherited from + +ValueModel.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L73) + +• `set` **quality**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Quality`](model.Quality-1.md) \| [`Definition`](../modules/model.Quality.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +EventElement.quality + +#### Inherited from + +ValueModel.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L76) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +ValueModel.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +ValueModel.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +___ + +### validationAspects + +• `get` **validationAspects**(): [`Aspect`](model.Aspect.md)<`any`\>[] + +Collect constraints and conformance for this type and all base types. + +#### Returns + +[`Aspect`](model.Aspect.md)<`any`\>[] + +#### Inherited from + +ValueModel.validationAspects + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L197) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[add](model.ValueModel.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[all](model.ValueModel.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### bitDefinition + +▸ **bitDefinition**(`bit`): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Search the inheritance chain for a bitmap field defining a specific bit. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bit` | `number` | + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[bitDefinition](model.ValueModel.md#bitdefinition) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:289](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L289) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[error](model.ValueModel.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[get](model.ValueModel.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[instanceOf](model.ValueModel.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[is](model.ValueModel.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[member](model.ValueModel.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[owner](model.ValueModel.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[ValueModel](model.ValueModel.md).[references](model.ValueModel.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[toJSON](model.ValueModel.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[valueOf](model.ValueModel.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L293) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[ValueModel](model.ValueModel.md).[visit](model.ValueModel.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[ValueModel](model.ValueModel.md).[create](model.ValueModel.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.FabricModel.md b/docs/matter.js/classes/model.FabricModel.md new file mode 100644 index 0000000000..5d60114752 --- /dev/null +++ b/docs/matter.js/classes/model.FabricModel.md @@ -0,0 +1,983 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / FabricModel + +# Class: FabricModel + +[model](../modules/model.md).FabricModel + +A "model" is a class that implements runtime functionality associated with +the corresponding element type. + +## Hierarchy + +- [`Model`](model.Model-1.md) + + ↳ **`FabricModel`** + +## Implements + +- [`FabricElement`](../modules/model.md#fabricelement) + +## Table of contents + +### Constructors + +- [constructor](model.FabricModel.md#constructor) + +### Properties + +- [description](model.FabricModel.md#description) +- [details](model.FabricModel.md#details) +- [errors](model.FabricModel.md#errors) +- [global](model.FabricModel.md#global) +- [id](model.FabricModel.md#id) +- [isType](model.FabricModel.md#istype) +- [isTypeScope](model.FabricModel.md#istypescope) +- [name](model.FabricModel.md#name) +- [tag](model.FabricModel.md#tag) +- [type](model.FabricModel.md#type) +- [xref](model.FabricModel.md#xref) +- [constructors](model.FabricModel.md#constructors) + +### Accessors + +- [allowedBaseTags](model.FabricModel.md#allowedbasetags) +- [base](model.FabricModel.md#base) +- [children](model.FabricModel.md#children) +- [effectiveId](model.FabricModel.md#effectiveid) +- [effectiveType](model.FabricModel.md#effectivetype) +- [effectiveXref](model.FabricModel.md#effectivexref) +- [elements](model.FabricModel.md#elements) +- [globalBase](model.FabricModel.md#globalbase) +- [key](model.FabricModel.md#key) +- [nodes](model.FabricModel.md#nodes) +- [parent](model.FabricModel.md#parent) +- [path](model.FabricModel.md#path) +- [shadow](model.FabricModel.md#shadow) +- [valid](model.FabricModel.md#valid) + +### Methods + +- [add](model.FabricModel.md#add) +- [all](model.FabricModel.md#all) +- [error](model.FabricModel.md#error) +- [get](model.FabricModel.md#get) +- [instanceOf](model.FabricModel.md#instanceof) +- [is](model.FabricModel.md#is) +- [member](model.FabricModel.md#member) +- [owner](model.FabricModel.md#owner) +- [references](model.FabricModel.md#references) +- [toJSON](model.FabricModel.md#tojson) +- [valueOf](model.FabricModel.md#valueof) +- [visit](model.FabricModel.md#visit) +- [create](model.FabricModel.md#create) + +## Constructors + +### constructor + +• **new FabricModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.FabricElement.md#properties) | + +#### Overrides + +[Model](model.Model-1.md).[constructor](model.Model-1.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/FabricModel.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/FabricModel.ts#L27) + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +FabricElement.description + +#### Inherited from + +[Model](model.Model-1.md).[description](model.Model-1.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +FabricElement.details + +#### Inherited from + +[Model](model.Model-1.md).[details](model.Model-1.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Model](model.Model-1.md).[errors](model.Model-1.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +FabricElement.global + +#### Inherited from + +[Model](model.Model-1.md).[global](model.Model-1.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• **id**: `number` + +#### Implementation of + +FabricElement.id + +#### Overrides + +[Model](model.Model-1.md).[id](model.Model-1.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/FabricModel.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/FabricModel.ts#L13) + +___ + +### isType + +• `Optional` **isType**: `boolean` + +Indicates that an element defines a datatype. + +#### Inherited from + +[Model](model.Model-1.md).[isType](model.Model-1.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L44) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[Model](model.Model-1.md).[isTypeScope](model.Model-1.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +FabricElement.name + +#### Inherited from + +[Model](model.Model-1.md).[name](model.Model-1.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• **tag**: [`Fabric`](../enums/model.ElementTag.md#fabric) = `FabricElement.Tag` + +#### Implementation of + +FabricElement.tag + +#### Overrides + +[Model](model.Model-1.md).[tag](model.Model-1.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/FabricModel.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/FabricModel.ts#L12) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +FabricElement.type + +#### Inherited from + +[Model](model.Model-1.md).[type](model.Model-1.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +FabricElement.xref + +#### Inherited from + +[Model](model.Model-1.md).[xref](model.Model-1.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[constructors](model.Model-1.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +The set of tags from which this model may derive. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +Model.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L237) + +___ + +### base + +• `get` **base**(): `undefined` \| [`Model`](model.Model-1.md) + +Get a Model for my base type, if any. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.base + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L207) + +___ + +### children + +• `get` **children**(): [`NodeModel`](model.NodeModel.md)[] + +Children of models are always models. + +#### Returns + +[`NodeModel`](model.NodeModel.md)[] + +#### Implementation of + +FabricElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/FabricModel.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/FabricModel.ts#L19) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`NodeElement`](../modules/model.md#nodeelement) \| [`NodeModel`](model.NodeModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +FabricElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/FabricModel.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/FabricModel.ts#L23) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Model.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +In some circumstances the base type can be inferred. This inference +happens here. + +Does not recurse so only returns the direct base type. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L200) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +Model.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +Model.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### nodes + +• `get` **nodes**(): [`NodeModel`](model.NodeModel.md)[] + +#### Returns + +[`NodeModel`](model.NodeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/FabricModel.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/FabricModel.ts#L15) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +Model.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +Model.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[add](model.Model-1.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[Model](model.Model-1.md).[all](model.Model-1.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[error](model.Model-1.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[Model](model.Model-1.md).[get](model.Model-1.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[instanceOf](model.Model-1.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[is](model.Model-1.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[member](model.Model-1.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[Model](model.Model-1.md).[owner](model.Model-1.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[Model](model.Model-1.md).[references](model.Model-1.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[toJSON](model.Model-1.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[valueOf](model.Model-1.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L326) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[Model](model.Model-1.md).[visit](model.Model-1.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[create](model.Model-1.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.FeatureSet-1.md b/docs/matter.js/classes/model.FeatureSet-1.md new file mode 100644 index 0000000000..72373e5a2c --- /dev/null +++ b/docs/matter.js/classes/model.FeatureSet-1.md @@ -0,0 +1,110 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / FeatureSet + +# Class: FeatureSet + +[model](../modules/model.md).FeatureSet + +A "feature set" is a set of features for a cluster. The names of features +present appear in this set. + +## Hierarchy + +- `Set`<[`Flag`](../modules/model.FeatureSet.md#flag)\> + + ↳ **`FeatureSet`** + +## Table of contents + +### Constructors + +- [constructor](model.FeatureSet-1.md#constructor) + +### Accessors + +- [array](model.FeatureSet-1.md#array) +- [record](model.FeatureSet-1.md#record) + +### Methods + +- [map](model.FeatureSet-1.md#map) + +## Constructors + +### constructor + +• **new FeatureSet**(`definition?`) + +Create a new feature set from an iterable that returns active names or +from an object of the form { [featureName: string]: true } + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition?` | [`Definition`](../modules/model.FeatureSet.md#definition) | + +#### Overrides + +Set<FeatureSet.Flag\>.constructor + +#### Defined in + +[packages/matter.js/src/model/definitions/FeatureSet.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FeatureSet.ts#L16) + +## Accessors + +### array + +• `get` **array**(): `string`[] + +Access features as an array of feature names. + +#### Returns + +`string`[] + +#### Defined in + +[packages/matter.js/src/model/definitions/FeatureSet.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FeatureSet.ts#L28) + +___ + +### record + +• `get` **record**(): `Object` + +Access features as an object mapping feature name -> true. + +#### Returns + +`Object` + +#### Defined in + +[packages/matter.js/src/model/definitions/FeatureSet.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FeatureSet.ts#L35) + +## Methods + +### map + +▸ **map**<`T`\>(`fn`): `T`[] + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fn` | (`name`: `string`) => `T` | + +#### Returns + +`T`[] + +#### Defined in + +[packages/matter.js/src/model/definitions/FeatureSet.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FeatureSet.ts#L39) diff --git a/docs/matter.js/classes/model.MatterModel-1.md b/docs/matter.js/classes/model.MatterModel-1.md new file mode 100644 index 0000000000..992cee575e --- /dev/null +++ b/docs/matter.js/classes/model.MatterModel-1.md @@ -0,0 +1,1068 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / MatterModel + +# Class: MatterModel + +[model](../modules/model.md).MatterModel + +The root of a Matter model. + +## Hierarchy + +- [`Model`](model.Model-1.md) + + ↳ **`MatterModel`** + +## Implements + +- [`MatterElement`](../modules/model.md#matterelement) + +## Table of contents + +### Constructors + +- [constructor](model.MatterModel-1.md#constructor) + +### Properties + +- [description](model.MatterModel-1.md#description) +- [details](model.MatterModel-1.md#details) +- [errors](model.MatterModel-1.md#errors) +- [global](model.MatterModel-1.md#global) +- [id](model.MatterModel-1.md#id) +- [isType](model.MatterModel-1.md#istype) +- [isTypeScope](model.MatterModel-1.md#istypescope) +- [name](model.MatterModel-1.md#name) +- [tag](model.MatterModel-1.md#tag) +- [type](model.MatterModel-1.md#type) +- [version](model.MatterModel-1.md#version) +- [xref](model.MatterModel-1.md#xref) +- [constructors](model.MatterModel-1.md#constructors) + +### Accessors + +- [allowedBaseTags](model.MatterModel-1.md#allowedbasetags) +- [attributes](model.MatterModel-1.md#attributes) +- [base](model.MatterModel-1.md#base) +- [children](model.MatterModel-1.md#children) +- [clusters](model.MatterModel-1.md#clusters) +- [datatypes](model.MatterModel-1.md#datatypes) +- [deviceTypes](model.MatterModel-1.md#devicetypes) +- [effectiveId](model.MatterModel-1.md#effectiveid) +- [effectiveType](model.MatterModel-1.md#effectivetype) +- [effectiveXref](model.MatterModel-1.md#effectivexref) +- [elements](model.MatterModel-1.md#elements) +- [fabrics](model.MatterModel-1.md#fabrics) +- [globalBase](model.MatterModel-1.md#globalbase) +- [key](model.MatterModel-1.md#key) +- [parent](model.MatterModel-1.md#parent) +- [path](model.MatterModel-1.md#path) +- [shadow](model.MatterModel-1.md#shadow) +- [valid](model.MatterModel-1.md#valid) + +### Methods + +- [add](model.MatterModel-1.md#add) +- [all](model.MatterModel-1.md#all) +- [error](model.MatterModel-1.md#error) +- [get](model.MatterModel-1.md#get) +- [instanceOf](model.MatterModel-1.md#instanceof) +- [is](model.MatterModel-1.md#is) +- [member](model.MatterModel-1.md#member) +- [owner](model.MatterModel-1.md#owner) +- [references](model.MatterModel-1.md#references) +- [toJSON](model.MatterModel-1.md#tojson) +- [valueOf](model.MatterModel-1.md#valueof) +- [visit](model.MatterModel-1.md#visit) +- [create](model.MatterModel-1.md#create) + +## Constructors + +### constructor + +• **new MatterModel**(`definition?`, `globals?`) + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `definition` | [`Properties`](../modules/model.MatterElement.md#properties) | `Matter` | +| `globals` | ([`AttributeElement`](../modules/model.md#attributeelement) \| [`DatatypeElement`](../modules/model.md#datatypeelement))[] | `undefined` | + +#### Overrides + +[Model](model.Model-1.md).[constructor](model.Model-1.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L67) + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +MatterElement.description + +#### Inherited from + +[Model](model.Model-1.md).[description](model.Model-1.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +MatterElement.details + +#### Inherited from + +[Model](model.Model-1.md).[details](model.Model-1.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Model](model.Model-1.md).[errors](model.Model-1.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +MatterElement.global + +#### Inherited from + +[Model](model.Model-1.md).[global](model.Model-1.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• `Optional` **id**: `number` + +#### Implementation of + +MatterElement.id + +#### Inherited from + +[Model](model.Model-1.md).[id](model.Model-1.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L23) + +___ + +### isType + +• `Optional` **isType**: `boolean` + +Indicates that an element defines a datatype. + +#### Inherited from + +[Model](model.Model-1.md).[isType](model.Model-1.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L44) + +___ + +### isTypeScope + +• **isTypeScope**: `boolean` = `true` + +Indicates that an element may have type definitions as children. + +#### Overrides + +[Model](model.Model-1.md).[isTypeScope](model.Model-1.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L21) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +MatterElement.name + +#### Inherited from + +[Model](model.Model-1.md).[name](model.Model-1.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• **tag**: [`Matter`](../enums/model.ElementTag.md#matter) = `MatterElement.Tag` + +#### Implementation of + +MatterElement.tag + +#### Overrides + +[Model](model.Model-1.md).[tag](model.Model-1.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L20) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +MatterElement.type + +#### Inherited from + +[Model](model.Model-1.md).[type](model.Model-1.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### version + +• `Optional` **version**: `string` + +#### Implementation of + +MatterElement.version + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L22) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +MatterElement.xref + +#### Inherited from + +[Model](model.Model-1.md).[xref](model.Model-1.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[constructors](model.Model-1.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +The set of tags from which this model may derive. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +Model.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L237) + +___ + +### attributes + +• `get` **attributes**(): [`AttributeModel`](model.AttributeModel.md)[] + +Global attributes. + +#### Returns + +[`AttributeModel`](model.AttributeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L48) + +___ + +### base + +• `get` **base**(): `undefined` \| [`Model`](model.Model-1.md) + +Get a Model for my base type, if any. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.base + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L207) + +___ + +### children + +• `get` **children**(): [`Child`](../modules/model.MatterModel.md#child)[] + +Children of models are always models. + +#### Returns + +[`Child`](../modules/model.MatterModel.md#child)[] + +#### Implementation of + +MatterElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L59) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`Child`](../modules/model.MatterElement.md#child) \| [`Child`](../modules/model.MatterModel.md#child))[] | + +#### Returns + +`void` + +#### Implementation of + +MatterElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L63) + +___ + +### clusters + +• `get` **clusters**(): [`ClusterModel`](model.ClusterModel-1.md)[] + +Clusters. + +#### Returns + +[`ClusterModel`](model.ClusterModel-1.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L27) + +___ + +### datatypes + +• `get` **datatypes**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Global datatypes. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L41) + +___ + +### deviceTypes + +• `get` **deviceTypes**(): [`DeviceTypeModel`](model.DeviceTypeModel.md)[] + +Device types. + +#### Returns + +[`DeviceTypeModel`](model.DeviceTypeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L34) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Model.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +In some circumstances the base type can be inferred. This inference +happens here. + +Does not recurse so only returns the direct base type. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L200) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +Model.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +Model.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### fabrics + +• `get` **fabrics**(): [`FabricModel`](model.FabricModel.md)[] + +Fabrics. + +#### Returns + +[`FabricModel`](model.FabricModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L55) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +Model.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +Model.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[add](model.Model-1.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[Model](model.Model-1.md).[all](model.Model-1.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[error](model.Model-1.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[Model](model.Model-1.md).[get](model.Model-1.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[instanceOf](model.Model-1.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[is](model.Model-1.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[member](model.Model-1.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[Model](model.Model-1.md).[owner](model.Model-1.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[Model](model.Model-1.md).[references](model.Model-1.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[toJSON](model.Model-1.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[valueOf](model.Model-1.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L326) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[Model](model.Model-1.md).[visit](model.Model-1.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[create](model.Model-1.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.Model-1.md b/docs/matter.js/classes/model.Model-1.md new file mode 100644 index 0000000000..01ab3eaeb8 --- /dev/null +++ b/docs/matter.js/classes/model.Model-1.md @@ -0,0 +1,796 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / Model + +# Class: Model + +[model](../modules/model.md).Model + +A "model" is a class that implements runtime functionality associated with +the corresponding element type. + +## Hierarchy + +- **`Model`** + + ↳ [`ClusterModel`](model.ClusterModel-1.md) + + ↳ [`DeviceTypeModel`](model.DeviceTypeModel.md) + + ↳ [`EndpointModel`](model.EndpointModel.md) + + ↳ [`FabricModel`](model.FabricModel.md) + + ↳ [`MatterModel`](model.MatterModel-1.md) + + ↳ [`NodeModel`](model.NodeModel.md) + + ↳ [`RequirementModel`](model.RequirementModel.md) + + ↳ [`ValueModel`](model.ValueModel.md) + +## Table of contents + +### Constructors + +- [constructor](model.Model-1.md#constructor) + +### Properties + +- [[CHILDREN]](model.Model-1.md#[children]) +- [[PARENT]](model.Model-1.md#[parent]) +- [description](model.Model-1.md#description) +- [details](model.Model-1.md#details) +- [errors](model.Model-1.md#errors) +- [global](model.Model-1.md#global) +- [id](model.Model-1.md#id) +- [isType](model.Model-1.md#istype) +- [isTypeScope](model.Model-1.md#istypescope) +- [name](model.Model-1.md#name) +- [tag](model.Model-1.md#tag) +- [type](model.Model-1.md#type) +- [xref](model.Model-1.md#xref) +- [constructors](model.Model-1.md#constructors) + +### Accessors + +- [allowedBaseTags](model.Model-1.md#allowedbasetags) +- [base](model.Model-1.md#base) +- [children](model.Model-1.md#children) +- [effectiveId](model.Model-1.md#effectiveid) +- [effectiveType](model.Model-1.md#effectivetype) +- [effectiveXref](model.Model-1.md#effectivexref) +- [elements](model.Model-1.md#elements) +- [globalBase](model.Model-1.md#globalbase) +- [key](model.Model-1.md#key) +- [parent](model.Model-1.md#parent) +- [path](model.Model-1.md#path) +- [shadow](model.Model-1.md#shadow) +- [valid](model.Model-1.md#valid) + +### Methods + +- [add](model.Model-1.md#add) +- [all](model.Model-1.md#all) +- [error](model.Model-1.md#error) +- [get](model.Model-1.md#get) +- [instanceOf](model.Model-1.md#instanceof) +- [is](model.Model-1.md#is) +- [member](model.Model-1.md#member) +- [owner](model.Model-1.md#owner) +- [references](model.Model-1.md#references) +- [toJSON](model.Model-1.md#tojson) +- [valueOf](model.Model-1.md#valueof) +- [visit](model.Model-1.md#visit) +- [create](model.Model-1.md#create) + +## Constructors + +### constructor + +• **new Model**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`BaseElement`](../modules/model.md#baseelement) | + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:377](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L377) + +## Properties + +### [CHILDREN] + +• `Private` **[CHILDREN]**: `any`[] + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L46) + +___ + +### [PARENT] + +• `Private` `Optional` **[PARENT]**: [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L47) + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• `Optional` **id**: `number` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L23) + +___ + +### isType + +• `Optional` **isType**: `boolean` + +Indicates that an element defines a datatype. + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L44) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### name + +• **name**: `string` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• `Readonly` `Abstract` **tag**: [`ElementTag`](../enums/model.ElementTag.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L22) + +___ + +### type + +• `Optional` **type**: `string` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +The set of tags from which this model may derive. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L237) + +___ + +### base + +• `get` **base**(): `undefined` \| [`Model`](model.Model-1.md) + +Get a Model for my base type, if any. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L207) + +___ + +### children + +• `get` **children**(): [`Model`](model.Model-1.md)[] + +Children of models are always models. + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L127) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:137](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L137) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +In some circumstances the base type can be inferred. This inference +happens here. + +Does not recurse so only returns the direct base type. + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L200) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L326) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.Model.CrossReference.md b/docs/matter.js/classes/model.Model.CrossReference.md new file mode 100644 index 0000000000..c2177d04c1 --- /dev/null +++ b/docs/matter.js/classes/model.Model.CrossReference.md @@ -0,0 +1,118 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Model](../modules/model.Model.md) / CrossReference + +# Class: CrossReference + +[model](../modules/model.md).[Model](../modules/model.Model.md).CrossReference + +## Implements + +- [`CrossReference`](../modules/model.Specification.md#crossreference) + +## Table of contents + +### Constructors + +- [constructor](model.Model.CrossReference.md#constructor) + +### Properties + +- [document](model.Model.CrossReference.md#document) +- [section](model.Model.CrossReference.md#section) +- [instances](model.Model.CrossReference.md#instances) + +### Methods + +- [toString](model.Model.CrossReference.md#tostring) +- [get](model.Model.CrossReference.md#get) + +## Constructors + +### constructor + +• `Private` **new CrossReference**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | [`CrossReference`](../modules/model.Specification.md#crossreference) | + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:413](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L413) + +## Properties + +### document + +• **document**: [`Specification`](../enums/model.Specification-1.md) + +#### Implementation of + +Specification.CrossReference.document + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:409](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L409) + +___ + +### section + +• **section**: `string` + +#### Implementation of + +Specification.CrossReference.section + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:410](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L410) + +___ + +### instances + +▪ `Static` `Private` **instances**: `Object` + +#### Index signature + +▪ [key: `string`]: [`CrossReference`](model.Model.CrossReference.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:411](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L411) + +## Methods + +### toString + +▸ **toString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:418](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L418) + +___ + +### get + +▸ `Static` **get**(`xref`): [`CrossReference`](model.Model.CrossReference.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `xref` | [`CrossReference`](../modules/model.Specification.md#crossreference) | + +#### Returns + +[`CrossReference`](model.Model.CrossReference.md) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:422](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L422) diff --git a/docs/matter.js/classes/model.ModelVariantTraversal.md b/docs/matter.js/classes/model.ModelVariantTraversal.md new file mode 100644 index 0000000000..b2bbe0a471 --- /dev/null +++ b/docs/matter.js/classes/model.ModelVariantTraversal.md @@ -0,0 +1,259 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / ModelVariantTraversal + +# Class: ModelVariantTraversal + +[model](../modules/model.md).ModelVariantTraversal + +Visits multiple model hierarchies simultaneously and builds state. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | `void` | + +## Table of contents + +### Constructors + +- [constructor](model.ModelVariantTraversal.md#constructor) + +### Properties + +- [clusterState](model.ModelVariantTraversal.md#clusterstate) +- [modelTraversal](model.ModelVariantTraversal.md#modeltraversal) +- [sourceNames](model.ModelVariantTraversal.md#sourcenames) +- [visiting](model.ModelVariantTraversal.md#visiting) + +### Methods + +- [createVariantDetail](model.ModelVariantTraversal.md#createvariantdetail) +- [enterCluster](model.ModelVariantTraversal.md#entercluster) +- [getCanonicalName](model.ModelVariantTraversal.md#getcanonicalname) +- [mapChildren](model.ModelVariantTraversal.md#mapchildren) +- [traverse](model.ModelVariantTraversal.md#traverse) +- [visit](model.ModelVariantTraversal.md#visit) +- [visitVariants](model.ModelVariantTraversal.md#visitvariants) + +## Constructors + +### constructor + +• **new ModelVariantTraversal**<`S`\>(`sourceNames`) + +Create a new visitor. Must list the valid names of sources. The order +of this list implies the priority used for choosing a name when multiple +model variants have different names. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | `void` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `sourceNames` | `string`[] | + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L67) + +## Properties + +### clusterState + +• `Protected` **clusterState**: `undefined` \| [`ClusterState`](../modules/export._internal_.md#clusterstate) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L58) + +___ + +### modelTraversal + +• `Private` **modelTraversal**: [`ModelTraversal`](export._internal_.ModelTraversal-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L60) + +___ + +### sourceNames + +• `Private` **sourceNames**: `string`[] + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L67) + +___ + +### visiting + +• `Private` **visiting**: `boolean` = `false` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L59) + +## Methods + +### createVariantDetail + +▸ `Private` **createVariantDetail**(`map`): [`VariantDetail`](../interfaces/model.VariantDetail.md) + +Create a VariantDetail from a VariantMap. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `map` | [`VariantMap`](../modules/model.md#variantmap) | + +#### Returns + +[`VariantDetail`](../interfaces/model.VariantDetail.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L268) + +___ + +### enterCluster + +▸ `Protected` **enterCluster**(`variants`): `boolean` + +Determine if we are entering a cluster and install cluster state if so. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variants` | [`VariantDetail`](../interfaces/model.VariantDetail.md) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L128) + +___ + +### getCanonicalName + +▸ `Protected` **getCanonicalName**(`model`): `string` + +Get the canonical name for a model. Within cluster scope alternate +names may be selected, otherwise the name of the model is returned. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | [`Model`](model.Model-1.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L115) + +___ + +### mapChildren + +▸ `Private` **mapChildren**(`variants`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variants` | [`VariantDetail`](../interfaces/model.VariantDetail.md) | + +#### Returns + +`Object` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L197) + +___ + +### traverse + +▸ **traverse**(`variants`): `S` + +Initiate traversal. The class is stateful so this call should not be +invoked while traversal is ongoing. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variants` | [`TraverseMap`](../modules/model.md#traversemap) | + +#### Returns + +`S` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L73) + +___ + +### visit + +▸ `Protected` `Abstract` **visit**(`variants`, `recurse`): `S` + +This is the primary callback. It is invoked for every set of variants +during traversal. It may optionally return state that is returned +from traverse(). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variants` | [`VariantDetail`](../interfaces/model.VariantDetail.md) | the set of equivalent models | +| `recurse` | () => `S`[] | call this function to recurse into variant children | + +#### Returns + +`S` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L109) + +___ + +### visitVariants + +▸ `Private` **visitVariants**(`variants`): `S` + +This is the function that actually recurses during the visit. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variants` | [`VariantDetail`](../interfaces/model.VariantDetail.md) | + +#### Returns + +`S` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L141) diff --git a/docs/matter.js/classes/model.NodeModel.md b/docs/matter.js/classes/model.NodeModel.md new file mode 100644 index 0000000000..2bd21cd7fc --- /dev/null +++ b/docs/matter.js/classes/model.NodeModel.md @@ -0,0 +1,983 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / NodeModel + +# Class: NodeModel + +[model](../modules/model.md).NodeModel + +A "model" is a class that implements runtime functionality associated with +the corresponding element type. + +## Hierarchy + +- [`Model`](model.Model-1.md) + + ↳ **`NodeModel`** + +## Implements + +- [`NodeElement`](../modules/model.md#nodeelement) + +## Table of contents + +### Constructors + +- [constructor](model.NodeModel.md#constructor) + +### Properties + +- [description](model.NodeModel.md#description) +- [details](model.NodeModel.md#details) +- [errors](model.NodeModel.md#errors) +- [global](model.NodeModel.md#global) +- [id](model.NodeModel.md#id) +- [isType](model.NodeModel.md#istype) +- [isTypeScope](model.NodeModel.md#istypescope) +- [name](model.NodeModel.md#name) +- [tag](model.NodeModel.md#tag) +- [type](model.NodeModel.md#type) +- [xref](model.NodeModel.md#xref) +- [constructors](model.NodeModel.md#constructors) + +### Accessors + +- [allowedBaseTags](model.NodeModel.md#allowedbasetags) +- [base](model.NodeModel.md#base) +- [children](model.NodeModel.md#children) +- [effectiveId](model.NodeModel.md#effectiveid) +- [effectiveType](model.NodeModel.md#effectivetype) +- [effectiveXref](model.NodeModel.md#effectivexref) +- [elements](model.NodeModel.md#elements) +- [endpoints](model.NodeModel.md#endpoints) +- [globalBase](model.NodeModel.md#globalbase) +- [key](model.NodeModel.md#key) +- [parent](model.NodeModel.md#parent) +- [path](model.NodeModel.md#path) +- [shadow](model.NodeModel.md#shadow) +- [valid](model.NodeModel.md#valid) + +### Methods + +- [add](model.NodeModel.md#add) +- [all](model.NodeModel.md#all) +- [error](model.NodeModel.md#error) +- [get](model.NodeModel.md#get) +- [instanceOf](model.NodeModel.md#instanceof) +- [is](model.NodeModel.md#is) +- [member](model.NodeModel.md#member) +- [owner](model.NodeModel.md#owner) +- [references](model.NodeModel.md#references) +- [toJSON](model.NodeModel.md#tojson) +- [valueOf](model.NodeModel.md#valueof) +- [visit](model.NodeModel.md#visit) +- [create](model.NodeModel.md#create) + +## Constructors + +### constructor + +• **new NodeModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.NodeElement.md#properties) | + +#### Overrides + +[Model](model.Model-1.md).[constructor](model.Model-1.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/NodeModel.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/NodeModel.ts#L27) + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +NodeElement.description + +#### Inherited from + +[Model](model.Model-1.md).[description](model.Model-1.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +NodeElement.details + +#### Inherited from + +[Model](model.Model-1.md).[details](model.Model-1.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Model](model.Model-1.md).[errors](model.Model-1.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +NodeElement.global + +#### Inherited from + +[Model](model.Model-1.md).[global](model.Model-1.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• **id**: `number` + +#### Implementation of + +NodeElement.id + +#### Overrides + +[Model](model.Model-1.md).[id](model.Model-1.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/NodeModel.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/NodeModel.ts#L13) + +___ + +### isType + +• `Optional` **isType**: `boolean` + +Indicates that an element defines a datatype. + +#### Inherited from + +[Model](model.Model-1.md).[isType](model.Model-1.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L44) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[Model](model.Model-1.md).[isTypeScope](model.Model-1.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +NodeElement.name + +#### Inherited from + +[Model](model.Model-1.md).[name](model.Model-1.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• **tag**: [`Node`](../enums/model.ElementTag.md#node) = `NodeElement.Tag` + +#### Implementation of + +NodeElement.tag + +#### Overrides + +[Model](model.Model-1.md).[tag](model.Model-1.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/NodeModel.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/NodeModel.ts#L12) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +NodeElement.type + +#### Inherited from + +[Model](model.Model-1.md).[type](model.Model-1.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +NodeElement.xref + +#### Inherited from + +[Model](model.Model-1.md).[xref](model.Model-1.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[constructors](model.Model-1.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +The set of tags from which this model may derive. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +Model.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L237) + +___ + +### base + +• `get` **base**(): `undefined` \| [`Model`](model.Model-1.md) + +Get a Model for my base type, if any. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.base + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L207) + +___ + +### children + +• `get` **children**(): [`EndpointModel`](model.EndpointModel.md)[] + +Children of models are always models. + +#### Returns + +[`EndpointModel`](model.EndpointModel.md)[] + +#### Implementation of + +NodeElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/NodeModel.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/NodeModel.ts#L19) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`EndpointElement`](../modules/model.md#endpointelement) \| [`EndpointModel`](model.EndpointModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +NodeElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/NodeModel.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/NodeModel.ts#L23) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Model.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +In some circumstances the base type can be inferred. This inference +happens here. + +Does not recurse so only returns the direct base type. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L200) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +Model.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +Model.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### endpoints + +• `get` **endpoints**(): [`EndpointModel`](model.EndpointModel.md)[] + +#### Returns + +[`EndpointModel`](model.EndpointModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/NodeModel.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/NodeModel.ts#L15) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +Model.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +Model.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[add](model.Model-1.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[Model](model.Model-1.md).[all](model.Model-1.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[error](model.Model-1.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[Model](model.Model-1.md).[get](model.Model-1.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[instanceOf](model.Model-1.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[is](model.Model-1.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[member](model.Model-1.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[Model](model.Model-1.md).[owner](model.Model-1.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[Model](model.Model-1.md).[references](model.Model-1.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[toJSON](model.Model-1.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[valueOf](model.Model-1.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L326) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[Model](model.Model-1.md).[visit](model.Model-1.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[create](model.Model-1.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.Quality-1.md b/docs/matter.js/classes/model.Quality-1.md new file mode 100644 index 0000000000..27ce5c24bf --- /dev/null +++ b/docs/matter.js/classes/model.Quality-1.md @@ -0,0 +1,387 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / Quality + +# Class: Quality + +[model](../modules/model.md).Quality + +An operational representation of "other quality" as defined by the Matter +specification. + +"Other qualities" are defined behaviors of data fields and cluster elements +that do not involve access or conformance. + +## Hierarchy + +- [`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Quality.md#definition)\> + + ↳ **`Quality`** + +## Implements + +- [`Ast`](../modules/model.Quality.md#ast) + +## Table of contents + +### Constructors + +- [constructor](model.Quality-1.md#constructor) + +### Properties + +- [changesOmitted](model.Quality-1.md#changesomitted) +- [definition](model.Quality-1.md#definition) +- [disallowed](model.Quality-1.md#disallowed) +- [errors](model.Quality-1.md#errors) +- [fixed](model.Quality-1.md#fixed) +- [nonvolatile](model.Quality-1.md#nonvolatile) +- [nullable](model.Quality-1.md#nullable) +- [reportable](model.Quality-1.md#reportable) +- [scene](model.Quality-1.md#scene) +- [singleton](model.Quality-1.md#singleton) + +### Accessors + +- [empty](model.Quality-1.md#empty) +- [valid](model.Quality-1.md#valid) + +### Methods + +- [equals](model.Quality-1.md#equals) +- [error](model.Quality-1.md#error) +- [extend](model.Quality-1.md#extend) +- [parse](model.Quality-1.md#parse) +- [toString](model.Quality-1.md#tostring) +- [valueOf](model.Quality-1.md#valueof) + +## Constructors + +### constructor + +• **new Quality**(`definition`) + +Initialize from a Quality.All definition or a string conforming to the +"other quality" DSL defined in the Matter specification. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Definition`](../modules/model.Quality.md#definition) | + +#### Overrides + +[Aspect](model.Aspect.md).[constructor](model.Aspect.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L30) + +## Properties + +### changesOmitted + +• `Optional` **changesOmitted**: `boolean` + +#### Implementation of + +Quality.Ast.changesOmitted + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L20) + +___ + +### definition + +• **definition**: [`Definition`](../modules/model.Quality.md#definition) + +#### Inherited from + +[Aspect](model.Aspect.md).[definition](model.Aspect.md#definition) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L17) + +___ + +### disallowed + +• `Optional` **disallowed**: [`AllProperties`](../modules/model.Quality.md#allproperties) + +#### Implementation of + +Quality.Ast.disallowed + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L24) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Aspect](model.Aspect.md).[errors](model.Aspect.md#errors) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L18) + +___ + +### fixed + +• `Optional` **fixed**: `boolean` + +#### Implementation of + +Quality.Ast.fixed + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L19) + +___ + +### nonvolatile + +• `Optional` **nonvolatile**: `boolean` + +#### Implementation of + +Quality.Ast.nonvolatile + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L18) + +___ + +### nullable + +• `Optional` **nullable**: `boolean` + +#### Implementation of + +Quality.Ast.nullable + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L17) + +___ + +### reportable + +• `Optional` **reportable**: `boolean` + +#### Implementation of + +Quality.Ast.reportable + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L22) + +___ + +### scene + +• `Optional` **scene**: `boolean` + +#### Implementation of + +Quality.Ast.scene + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L21) + +___ + +### singleton + +• `Optional` **singleton**: `boolean` + +#### Implementation of + +Quality.Ast.singleton + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L23) + +## Accessors + +### empty + +• `get` **empty**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Aspect.empty + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L28) + +___ + +### valid + +• `get` **valid**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +Aspect.valid + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L20) + +## Methods + +### equals + +▸ **equals**(`other`): `boolean` + +Test for logical equivalence. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Aspect](model.Aspect.md).[equals](model.Aspect.md#equals) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L40) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Aspect](model.Aspect.md).[error](model.Aspect.md#error) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L54) + +___ + +### extend + +▸ **extend**(`other`): [`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Quality.md#definition)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`Definition`](../modules/model.Quality.md#definition) | + +#### Returns + +[`Aspect`](model.Aspect.md)<[`Definition`](../modules/model.Quality.md#definition)\> + +#### Inherited from + +[Aspect](model.Aspect.md).[extend](model.Aspect.md#extend) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L65) + +___ + +### parse + +▸ `Private` **parse**(`quality`, `definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `quality` | [`Quality`](model.Quality-1.md) | +| `definition` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L42) + +___ + +### toString + +▸ **toString**(): `string` + +Display quality using standard Matter syntax. + +#### Returns + +`string` + +#### Overrides + +[Aspect](model.Aspect.md).[toString](model.Aspect.md#tostring) + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L83) + +___ + +### valueOf + +▸ **valueOf**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[Aspect](model.Aspect.md).[valueOf](model.Aspect.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/aspects/Aspect.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Aspect.ts#L47) diff --git a/docs/matter.js/classes/model.RequirementModel.md b/docs/matter.js/classes/model.RequirementModel.md new file mode 100644 index 0000000000..3d74b4a01c --- /dev/null +++ b/docs/matter.js/classes/model.RequirementModel.md @@ -0,0 +1,1139 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / RequirementModel + +# Class: RequirementModel + +[model](../modules/model.md).RequirementModel + +A "model" is a class that implements runtime functionality associated with +the corresponding element type. + +## Hierarchy + +- [`Model`](model.Model-1.md) + + ↳ **`RequirementModel`** + +## Implements + +- [`RequirementElement`](../modules/model.md#requirementelement) + +## Table of contents + +### Constructors + +- [constructor](model.RequirementModel.md#constructor) + +### Properties + +- [description](model.RequirementModel.md#description) +- [details](model.RequirementModel.md#details) +- [element](model.RequirementModel.md#element) +- [errors](model.RequirementModel.md#errors) +- [global](model.RequirementModel.md#global) +- [id](model.RequirementModel.md#id) +- [isType](model.RequirementModel.md#istype) +- [isTypeScope](model.RequirementModel.md#istypescope) +- [name](model.RequirementModel.md#name) +- [tag](model.RequirementModel.md#tag) +- [type](model.RequirementModel.md#type) +- [xref](model.RequirementModel.md#xref) +- [constructors](model.RequirementModel.md#constructors) + +### Accessors + +- [access](model.RequirementModel.md#access) +- [allowedBaseTags](model.RequirementModel.md#allowedbasetags) +- [base](model.RequirementModel.md#base) +- [children](model.RequirementModel.md#children) +- [conformance](model.RequirementModel.md#conformance) +- [constraint](model.RequirementModel.md#constraint) +- [effectiveId](model.RequirementModel.md#effectiveid) +- [effectiveType](model.RequirementModel.md#effectivetype) +- [effectiveXref](model.RequirementModel.md#effectivexref) +- [elements](model.RequirementModel.md#elements) +- [globalBase](model.RequirementModel.md#globalbase) +- [key](model.RequirementModel.md#key) +- [parent](model.RequirementModel.md#parent) +- [path](model.RequirementModel.md#path) +- [quality](model.RequirementModel.md#quality) +- [shadow](model.RequirementModel.md#shadow) +- [valid](model.RequirementModel.md#valid) + +### Methods + +- [add](model.RequirementModel.md#add) +- [all](model.RequirementModel.md#all) +- [error](model.RequirementModel.md#error) +- [get](model.RequirementModel.md#get) +- [instanceOf](model.RequirementModel.md#instanceof) +- [is](model.RequirementModel.md#is) +- [member](model.RequirementModel.md#member) +- [owner](model.RequirementModel.md#owner) +- [references](model.RequirementModel.md#references) +- [toJSON](model.RequirementModel.md#tojson) +- [valueOf](model.RequirementModel.md#valueof) +- [visit](model.RequirementModel.md#visit) +- [create](model.RequirementModel.md#create) + +## Constructors + +### constructor + +• **new RequirementModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`BaseElement`](../modules/model.md#baseelement) | + +#### Inherited from + +[Model](model.Model-1.md).[constructor](model.Model-1.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:377](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L377) + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +RequirementElement.description + +#### Inherited from + +[Model](model.Model-1.md).[description](model.Model-1.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +RequirementElement.details + +#### Inherited from + +[Model](model.Model-1.md).[details](model.Model-1.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### element + +• **element**: [`ElementType`](../enums/model.RequirementElement.ElementType.md) + +#### Implementation of + +RequirementElement.element + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L20) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Model](model.Model-1.md).[errors](model.Model-1.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +RequirementElement.global + +#### Inherited from + +[Model](model.Model-1.md).[global](model.Model-1.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• `Optional` **id**: `number` + +#### Implementation of + +RequirementElement.id + +#### Inherited from + +[Model](model.Model-1.md).[id](model.Model-1.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L23) + +___ + +### isType + +• `Optional` **isType**: `boolean` + +Indicates that an element defines a datatype. + +#### Inherited from + +[Model](model.Model-1.md).[isType](model.Model-1.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L44) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[Model](model.Model-1.md).[isTypeScope](model.Model-1.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +RequirementElement.name + +#### Inherited from + +[Model](model.Model-1.md).[name](model.Model-1.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• **tag**: [`Requirement`](../enums/model.ElementTag.md#requirement) = `RequirementElement.Tag` + +#### Implementation of + +RequirementElement.tag + +#### Overrides + +[Model](model.Model-1.md).[tag](model.Model-1.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L19) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +RequirementElement.type + +#### Inherited from + +[Model](model.Model-1.md).[type](model.Model-1.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +RequirementElement.xref + +#### Inherited from + +[Model](model.Model-1.md).[xref](model.Model-1.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[constructors](model.Model-1.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### access + +• `get` **access**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Implementation of + +RequirementElement.access + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L34) + +• `set` **access**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Access`](model.Access-1.md) \| [`Definition`](../modules/model.Access.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +RequirementElement.access + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L37) + +___ + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +The set of tags from which this model may derive. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Inherited from + +Model.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L237) + +___ + +### base + +• `get` **base**(): `undefined` \| [`Model`](model.Model-1.md) + +Get a Model for my base type, if any. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.base + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L207) + +___ + +### children + +• `get` **children**(): ([`DatatypeModel`](model.DatatypeModel.md) \| [`RequirementModel`](model.RequirementModel.md))[] + +Children of models are always models. + +#### Returns + +([`DatatypeModel`](model.DatatypeModel.md) \| [`RequirementModel`](model.RequirementModel.md))[] + +#### Implementation of + +RequirementElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L26) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`DatatypeElement`](../modules/model.md#datatypeelement) \| [`RequirementElement`](../modules/model.md#requirementelement) \| [`DatatypeModel`](model.DatatypeModel.md) \| [`RequirementModel`](model.RequirementModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +RequirementElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L30) + +___ + +### conformance + +• `get` **conformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Implementation of + +RequirementElement.conformance + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L48) + +• `set` **conformance**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Conformance`](model.Conformance-1.md) \| [`Definition`](../modules/model.Conformance.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +RequirementElement.conformance + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L51) + +___ + +### constraint + +• `get` **constraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Implementation of + +RequirementElement.constraint + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L41) + +• `set` **constraint**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Constraint`](model.Constraint-1.md) \| [`Definition`](../modules/model.Constraint.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +RequirementElement.constraint + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L44) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Model.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +In some circumstances the base type can be inferred. This inference +happens here. + +Does not recurse so only returns the direct base type. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L200) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +Model.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +Model.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`string` + +#### Overrides + +Model.key + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L22) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +Model.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### quality + +• `get` **quality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Implementation of + +RequirementElement.quality + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L55) + +• `set` **quality**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Quality`](model.Quality-1.md) \| [`Definition`](../modules/model.Quality.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +RequirementElement.quality + +#### Defined in + +[packages/matter.js/src/model/models/RequirementModel.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/RequirementModel.ts#L58) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +Model.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[add](model.Model-1.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[Model](model.Model-1.md).[all](model.Model-1.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[error](model.Model-1.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[Model](model.Model-1.md).[get](model.Model-1.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[instanceOf](model.Model-1.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[is](model.Model-1.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[member](model.Model-1.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[Model](model.Model-1.md).[owner](model.Model-1.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[Model](model.Model-1.md).[references](model.Model-1.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[toJSON](model.Model-1.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[valueOf](model.Model-1.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L326) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[Model](model.Model-1.md).[visit](model.Model-1.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[create](model.Model-1.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/model.ValidateModel.Result.md b/docs/matter.js/classes/model.ValidateModel.Result.md new file mode 100644 index 0000000000..038532e376 --- /dev/null +++ b/docs/matter.js/classes/model.ValidateModel.Result.md @@ -0,0 +1,125 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [ValidateModel](../modules/model.ValidateModel.md) / Result + +# Class: Result + +[model](../modules/model.md).[ValidateModel](../modules/model.ValidateModel.md).Result + +## Table of contents + +### Constructors + +- [constructor](model.ValidateModel.Result.md#constructor) + +### Properties + +- [elementCount](model.ValidateModel.Result.md#elementcount) +- [errorCounts](model.ValidateModel.Result.md#errorcounts) +- [errors](model.ValidateModel.Result.md#errors) +- [invalidElementCount](model.ValidateModel.Result.md#invalidelementcount) +- [model](model.ValidateModel.Result.md#model) + +### Accessors + +- [invalidElementPercent](model.ValidateModel.Result.md#invalidelementpercent) + +### Methods + +- [report](model.ValidateModel.Result.md#report) + +## Constructors + +### constructor + +• **new Result**(`model`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | [`Model`](model.Model-1.md) | + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L92) + +## Properties + +### elementCount + +• **elementCount**: `number` = `0` + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L83) + +___ + +### errorCounts + +• **errorCounts**: `Object` = `{}` + +#### Index signature + +▪ [name: `string`]: `number` + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L85) + +___ + +### errors + +• **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L86) + +___ + +### invalidElementCount + +• **invalidElementCount**: `number` = `0` + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L84) + +___ + +### model + +• **model**: [`Model`](model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L92) + +## Accessors + +### invalidElementPercent + +• `get` **invalidElementPercent**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L88) + +## Methods + +### report + +▸ **report**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L94) diff --git a/docs/matter.js/classes/model.ValueModel.md b/docs/matter.js/classes/model.ValueModel.md new file mode 100644 index 0000000000..7a36a871e1 --- /dev/null +++ b/docs/matter.js/classes/model.ValueModel.md @@ -0,0 +1,1494 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / ValueModel + +# Class: ValueModel + +[model](../modules/model.md).ValueModel + +Each ValueElement has a corresponding implementation that derives from +this class. + +## Hierarchy + +- [`Model`](model.Model-1.md) + + ↳ **`ValueModel`** + + ↳↳ [`AttributeModel`](model.AttributeModel.md) + + ↳↳ [`CommandModel`](model.CommandModel.md) + + ↳↳ [`DatatypeModel`](model.DatatypeModel.md) + + ↳↳ [`EventModel`](model.EventModel.md) + +## Implements + +- [`ValueElement`](../modules/model.md#valueelement) + +## Table of contents + +### Constructors + +- [constructor](model.ValueModel.md#constructor) + +### Properties + +- [byteSize](model.ValueModel.md#bytesize) +- [default](model.ValueModel.md#default) +- [description](model.ValueModel.md#description) +- [details](model.ValueModel.md#details) +- [errors](model.ValueModel.md#errors) +- [global](model.ValueModel.md#global) +- [id](model.ValueModel.md#id) +- [isType](model.ValueModel.md#istype) +- [isTypeScope](model.ValueModel.md#istypescope) +- [metatype](model.ValueModel.md#metatype) +- [name](model.ValueModel.md#name) +- [tag](model.ValueModel.md#tag) +- [type](model.ValueModel.md#type) +- [xref](model.ValueModel.md#xref) +- [constructors](model.ValueModel.md#constructors) + +### Accessors + +- [access](model.ValueModel.md#access) +- [allowedBaseTags](model.ValueModel.md#allowedbasetags) +- [base](model.ValueModel.md#base) +- [children](model.ValueModel.md#children) +- [conformance](model.ValueModel.md#conformance) +- [constraint](model.ValueModel.md#constraint) +- [definingModel](model.ValueModel.md#definingmodel) +- [deprecated](model.ValueModel.md#deprecated) +- [directMetatype](model.ValueModel.md#directmetatype) +- [disallowed](model.ValueModel.md#disallowed) +- [effectiveAccess](model.ValueModel.md#effectiveaccess) +- [effectiveConformance](model.ValueModel.md#effectiveconformance) +- [effectiveConstraint](model.ValueModel.md#effectiveconstraint) +- [effectiveDefault](model.ValueModel.md#effectivedefault) +- [effectiveId](model.ValueModel.md#effectiveid) +- [effectiveMetatype](model.ValueModel.md#effectivemetatype) +- [effectiveQuality](model.ValueModel.md#effectivequality) +- [effectiveType](model.ValueModel.md#effectivetype) +- [effectiveXref](model.ValueModel.md#effectivexref) +- [elements](model.ValueModel.md#elements) +- [globalBase](model.ValueModel.md#globalbase) +- [key](model.ValueModel.md#key) +- [listEntry](model.ValueModel.md#listentry) +- [mandatory](model.ValueModel.md#mandatory) +- [members](model.ValueModel.md#members) +- [metabase](model.ValueModel.md#metabase) +- [nullable](model.ValueModel.md#nullable) +- [overridesShadow](model.ValueModel.md#overridesshadow) +- [parent](model.ValueModel.md#parent) +- [path](model.ValueModel.md#path) +- [primitiveBase](model.ValueModel.md#primitivebase) +- [quality](model.ValueModel.md#quality) +- [shadow](model.ValueModel.md#shadow) +- [valid](model.ValueModel.md#valid) +- [validationAspects](model.ValueModel.md#validationaspects) + +### Methods + +- [add](model.ValueModel.md#add) +- [all](model.ValueModel.md#all) +- [bitDefinition](model.ValueModel.md#bitdefinition) +- [error](model.ValueModel.md#error) +- [get](model.ValueModel.md#get) +- [instanceOf](model.ValueModel.md#instanceof) +- [is](model.ValueModel.md#is) +- [member](model.ValueModel.md#member) +- [owner](model.ValueModel.md#owner) +- [references](model.ValueModel.md#references) +- [toJSON](model.ValueModel.md#tojson) +- [valueOf](model.ValueModel.md#valueof) +- [visit](model.ValueModel.md#visit) +- [create](model.ValueModel.md#create) + +## Constructors + +### constructor + +• **new ValueModel**(`definition`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](../modules/model.ValueElement.md#properties) | + +#### Overrides + +[Model](model.Model-1.md).[constructor](model.Model-1.md#constructor) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:307](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L307) + +## Properties + +### byteSize + +• `Optional` **byteSize**: [`Size`](../modules/model.ValueElement.md#size) + +#### Implementation of + +ValueElement.byteSize + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L30) + +___ + +### default + +• `Optional` **default**: [`FieldValue`](../modules/model.md#fieldvalue) + +#### Implementation of + +ValueElement.default + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L31) + +___ + +### description + +• `Optional` **description**: `string` + +#### Implementation of + +ValueElement.description + +#### Inherited from + +[Model](model.Model-1.md).[description](model.Model-1.md#description) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L26) + +___ + +### details + +• `Optional` **details**: `string` + +#### Implementation of + +ValueElement.details + +#### Inherited from + +[Model](model.Model-1.md).[details](model.Model-1.md#details) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L27) + +___ + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Inherited from + +[Model](model.Model-1.md).[errors](model.Model-1.md#errors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L29) + +___ + +### global + +• `Optional` **global**: `boolean` + +Flag set on elements loaded from Globals. + +#### Implementation of + +ValueElement.global + +#### Inherited from + +[Model](model.Model-1.md).[global](model.Model-1.md#global) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L34) + +___ + +### id + +• `Optional` **id**: `number` + +#### Implementation of + +ValueElement.id + +#### Inherited from + +[Model](model.Model-1.md).[id](model.Model-1.md#id) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L23) + +___ + +### isType + +• `Optional` **isType**: `boolean` = `true` + +Indicates that an element defines a datatype. + +#### Overrides + +[Model](model.Model-1.md).[isType](model.Model-1.md#istype) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L33) + +___ + +### isTypeScope + +• `Optional` **isTypeScope**: `boolean` + +Indicates that an element may have type definitions as children. + +#### Inherited from + +[Model](model.Model-1.md).[isTypeScope](model.Model-1.md#istypescope) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L39) + +___ + +### metatype + +• `Optional` **metatype**: [`Metatype`](../enums/model.Metatype-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L32) + +___ + +### name + +• **name**: `string` + +#### Implementation of + +ValueElement.name + +#### Inherited from + +[Model](model.Model-1.md).[name](model.Model-1.md#name) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L24) + +___ + +### tag + +• `Readonly` `Abstract` **tag**: [`ElementTag`](../enums/model.ElementTag.md) + +#### Inherited from + +[Model](model.Model-1.md).[tag](model.Model-1.md#tag) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L22) + +___ + +### type + +• `Optional` **type**: `string` + +#### Implementation of + +ValueElement.type + +#### Inherited from + +[Model](model.Model-1.md).[type](model.Model-1.md#type) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L25) + +___ + +### xref + +• `Optional` **xref**: [`CrossReference`](model.Model.CrossReference.md) + +#### Implementation of + +ValueElement.xref + +#### Inherited from + +[Model](model.Model-1.md).[xref](model.Model-1.md#xref) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L28) + +___ + +### constructors + +▪ `Static` **constructors**: `Object` + +Factory support. Populated by derivatives upon definition. + +#### Index signature + +▪ [type: `string`]: (`definition`: `any`) => [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[constructors](model.Model-1.md#constructors) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L192) + +## Accessors + +### access + +• `get` **access**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Implementation of + +ValueElement.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L63) + +• `set` **access**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Access`](model.Access-1.md) \| [`Definition`](../modules/model.Access.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +ValueElement.access + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L66) + +___ + +### allowedBaseTags + +• `get` **allowedBaseTags**(): [`ElementTag`](../enums/model.ElementTag.md)[] + +ValueModels may derive from models of the same type or from generic +Datatype models. + +#### Returns + +[`ElementTag`](../enums/model.ElementTag.md)[] + +#### Overrides + +Model.allowedBaseTags + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L180) + +___ + +### base + +• `get` **base**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +ValueModels may only derive from ValueModels. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Overrides + +Model.base + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L172) + +___ + +### children + +• `get` **children**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Children of models are always models. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Implementation of + +ValueElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L35) + +• `set` **children**(`children`): `void` + +Children can be added as models or elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `children` | ([`DatatypeElement`](../modules/model.md#datatypeelement) \| [`DatatypeModel`](model.DatatypeModel.md))[] | + +#### Returns + +`void` + +#### Implementation of + +ValueElement.children + +#### Overrides + +Model.children + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L39) + +___ + +### conformance + +• `get` **conformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Implementation of + +ValueElement.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L53) + +• `set` **conformance**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Conformance`](model.Conformance-1.md) \| [`Definition`](../modules/model.Conformance.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +ValueElement.conformance + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L56) + +___ + +### constraint + +• `get` **constraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Implementation of + +ValueElement.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L43) + +• `set` **constraint**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Constraint`](model.Constraint-1.md) \| [`Definition`](../modules/model.Constraint.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +ValueElement.constraint + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L46) + +___ + +### definingModel + +• `get` **definingModel**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the first derived ancestor with children, if any. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L158) + +___ + +### deprecated + +• `get` **deprecated**(): `boolean` + +Is this model deprecated? + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L220) + +___ + +### directMetatype + +• `get` **directMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The metatype for this model's type, ignoring inheritance. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L149) + +___ + +### disallowed + +• `get` **disallowed**(): `boolean` + +Is this model disallowed? + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L227) + +___ + +### effectiveAccess + +• `get` **effectiveAccess**(): [`Access`](model.Access-1.md) + +#### Returns + +[`Access`](model.Access-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L69) + +___ + +### effectiveConformance + +• `get` **effectiveConformance**(): [`Conformance`](model.Conformance-1.md) + +#### Returns + +[`Conformance`](model.Conformance-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L59) + +___ + +### effectiveConstraint + +• `get` **effectiveConstraint**(): [`Constraint`](model.Constraint-1.md) + +#### Returns + +[`Constraint`](model.Constraint-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L49) + +___ + +### effectiveDefault + +• `get` **effectiveDefault**(): `any` + +The value to use as a default. The "default" field has a manually +supplied value but this property decodes the default and/or generates +a default from subfields. + +#### Returns + +`any` + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L142) + +___ + +### effectiveId + +• `get` **effectiveId**(): `undefined` \| `number` + +Allows subclasses to pull a working ID from an alternate source. + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Model.effectiveId + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L112) + +___ + +### effectiveMetatype + +• `get` **effectiveMetatype**(): `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +The working metatype for this object. + +#### Returns + +`undefined` \| [`Metatype`](../enums/model.Metatype-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L130) + +___ + +### effectiveQuality + +• `get` **effectiveQuality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L79) + +___ + +### effectiveType + +• `get` **effectiveType**(): `undefined` \| `string` + +The "effective type" may be inferred from context. + +#### Returns + +`undefined` \| `string` + +#### Overrides + +Model.effectiveType + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L119) + +___ + +### effectiveXref + +• `get` **effectiveXref**(): `undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +A local or parent xref. + +#### Returns + +`undefined` \| [`CrossReference`](model.Model.CrossReference.md) + +#### Inherited from + +Model.effectiveXref + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L230) + +___ + +### elements + +• `get` **elements**(): [`AnyElement`](../modules/model.md#anyelement)[] + +Element view of children. For TypeScript this allows children to be +added as elements. For JavaScript this is identical to children(). + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement)[] + +#### Inherited from + +Model.elements + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L102) + +___ + +### globalBase + +• `get` **globalBase**(): `undefined` \| [`Model`](model.Model-1.md) + +Get the first global base type. This may have semantic meaning more +specific than the base primitive type. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.globalBase + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L223) + +___ + +### key + +• `get` **key**(): `undefined` \| `string` + +Get a string that uniquely identifies this model. This is normally +the effective ID but some models require a generated identifier. + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +Model.key + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L120) + +___ + +### listEntry + +• `get` **listEntry**(): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Get the entry type for lists, if any. + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L165) + +___ + +### mandatory + +• `get` **mandatory**(): `boolean` + +Is this model mandatory? This supports a limited subset of conformance +and is only appropriate for field conformance. + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L242) + +___ + +### members + +• `get` **members**(): [`DatatypeModel`](model.DatatypeModel.md)[] + +Retrieve all datatype members. + +#### Returns + +[`DatatypeModel`](model.DatatypeModel.md)[] + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L190) + +___ + +### metabase + +• `get` **metabase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Metatype is only present on global types with specific semantic meaning. +This model is significant because it gives us information about how to +manipulate the data. This accessor retrieves this model. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L88) + +___ + +### nullable + +• `get` **nullable**(): `boolean` + +Can this model be omitted? + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L234) + +___ + +### overridesShadow + +• `get` **overridesShadow**(): `undefined` \| ``true`` + +Determine whether this element overrides key properties of its shadow. + +#### Returns + +`undefined` \| ``true`` + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L263) + +___ + +### parent + +• `get` **parent**(): `undefined` \| [`Model`](model.Model-1.md) + +The structural parent. This is the model for the element that contains +this element's definition. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L71) + +• `set` **parent**(`parent`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parent` | `undefined` \| [`Model`](model.Model-1.md) | + +#### Returns + +`void` + +#### Inherited from + +Model.parent + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L75) + +___ + +### path + +• `get` **path**(): `string` + +The full path ("." delimited) in the Matter tree. + +#### Returns + +`string` + +#### Inherited from + +Model.path + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L59) + +___ + +### primitiveBase + +• `get` **primitiveBase**(): `undefined` \| [`ValueModel`](model.ValueModel.md) + +Get the primitive type for this value model. This is an integer type +for enums and bitmaps. Otherwise it's the metabase. + +#### Returns + +`undefined` \| [`ValueModel`](model.ValueModel.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L96) + +___ + +### quality + +• `get` **quality**(): [`Quality`](model.Quality-1.md) + +#### Returns + +[`Quality`](model.Quality-1.md) + +#### Implementation of + +ValueElement.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L73) + +• `set` **quality**(`definition`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Quality`](model.Quality-1.md) \| [`Definition`](../modules/model.Quality.md#definition) | + +#### Returns + +`void` + +#### Implementation of + +ValueElement.quality + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L76) + +___ + +### shadow + +• `get` **shadow**(): `undefined` \| [`Model`](model.Model-1.md) + +Get shadow model, if any. A "shadow" is an element in my parent's +inheritance hierarchy that I override. + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +Model.shadow + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L215) + +___ + +### valid + +• `get` **valid**(): `boolean` + +Did validation find errors? + +#### Returns + +`boolean` + +#### Inherited from + +Model.valid + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L52) + +___ + +### validationAspects + +• `get` **validationAspects**(): [`Aspect`](model.Aspect.md)<`any`\>[] + +Collect constraints and conformance for this type and all base types. + +#### Returns + +[`Aspect`](model.Aspect.md)<`any`\>[] + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L197) + +## Methods + +### add + +▸ **add**(`...children`): `void` + +Add a child. children.push works too but only accepts models. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...children` | ([`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md))[] | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[add](model.Model-1.md#add) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L244) + +___ + +### all + +▸ **all**<`T`\>(`constructor`): `T`[] + +Retrieve all models of a specific element type from local scope. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | model class or a predicate object | + +#### Returns + +`T`[] + +#### Inherited from + +[Model](model.Model-1.md).[all](model.Model-1.md#all) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L268) + +___ + +### bitDefinition + +▸ **bitDefinition**(`bit`): `undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +Search the inheritance chain for a bitmap field defining a specific bit. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bit` | `number` | + +#### Returns + +`undefined` \| [`DatatypeModel`](model.DatatypeModel.md) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:289](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L289) + +___ + +### error + +▸ **error**(`code`, `message`): `void` + +Record a validation error for this model. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[Model](model.Model-1.md).[error](model.Model-1.md#error) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L303) + +___ + +### get + +▸ **get**<`T`\>(`constructor`, `key`): `T` + +Retrieve a specific model by ID or name. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | +| `key` | `string` \| `number` | + +#### Returns + +`T` + +#### Inherited from + +[Model](model.Model-1.md).[get](model.Model-1.md#get) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L275) + +___ + +### instanceOf + +▸ **instanceOf**(`other`): `boolean` + +Does this model derive from another? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `other` | [`AnyElement`](../modules/model.md#anyelement) \| [`Model`](model.Model-1.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[instanceOf](model.Model-1.md#instanceof) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L373) + +___ + +### is + +▸ **is**(`key`): `boolean` + +Check identity of element by name or ID. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `undefined` \| [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | + +#### Returns + +`boolean` + +#### Inherited from + +[Model](model.Model-1.md).[is](model.Model-1.md#is) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L291) + +___ + +### member + +▸ **member**(`key`, `allowedTags?`): `undefined` \| [`Model`](model.Model-1.md) + +Search the inheritance chain for a child property. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | [`ElementSelector`](../modules/export._internal_.ModelTraversal.md#elementselector) | +| `allowedTags` | [`ElementTag`](../enums/model.ElementTag.md)[] | + +#### Returns + +`undefined` \| [`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[member](model.Model-1.md#member) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L363) + +___ + +### owner + +▸ **owner**<`T`\>(`constructor`): `undefined` \| `T` + +Retrieve a model of a specific type from the ownership hierarchy. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](model.Model-1.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constructor` | [`Constructor`](../modules/model.Model.md#constructor)<`T`\> | + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[Model](model.Model-1.md).[owner](model.Model-1.md#owner) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L284) + +___ + +### references + +▸ **references**(`type`): [`Model`](model.Model-1.md)[] + +Find all children that reference a specific type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Model`](model.Model-1.md) | + +#### Returns + +[`Model`](model.Model-1.md)[] + +#### Inherited from + +[Model](model.Model-1.md).[references](model.Model-1.md#references) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L356) + +___ + +### toJSON + +▸ **toJSON**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert model to JSON. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Inherited from + +[Model](model.Model-1.md).[toJSON](model.Model-1.md#tojson) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L319) + +___ + +### valueOf + +▸ **valueOf**(): [`AnyElement`](../modules/model.md#anyelement) + +Convert to non-class structure. + +#### Returns + +[`AnyElement`](../modules/model.md#anyelement) + +#### Overrides + +[Model](model.Model-1.md).[valueOf](model.Model-1.md#valueof) + +#### Defined in + +[packages/matter.js/src/model/models/ValueModel.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ValueModel.ts#L293) + +___ + +### visit + +▸ **visit**(`visitor`): `undefined` \| `boolean` + +Apply a function to all tree elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `visitor` | (`model`: [`Model`](model.Model-1.md)) => `boolean` \| `void` | + +#### Returns + +`undefined` \| `boolean` + +#### Inherited from + +[Model](model.Model-1.md).[visit](model.Model-1.md#visit) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:349](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L349) + +___ + +### create + +▸ `Static` **create**(`definition`): [`Model`](model.Model-1.md) + +Create a model for an element. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`AnyElement`](../modules/model.md#anyelement) | + +#### Returns + +[`Model`](model.Model-1.md) + +#### Inherited from + +[Model](model.Model-1.md).[create](model.Model-1.md#create) + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L251) diff --git a/docs/matter.js/classes/net_export.Network.md b/docs/matter.js/classes/net_export.Network.md index 3d69770e95..9e2227ea2e 100644 --- a/docs/matter.js/classes/net_export.Network.md +++ b/docs/matter.js/classes/net_export.Network.md @@ -49,7 +49,7 @@ #### Defined in -packages/matter.js/src/net/Network.ts:13 +[packages/matter.js/src/net/Network.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/Network.ts#L13) ## Methods @@ -63,7 +63,7 @@ packages/matter.js/src/net/Network.ts:13 #### Defined in -packages/matter.js/src/net/Network.ts:21 +[packages/matter.js/src/net/Network.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/Network.ts#L21) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -packages/matter.js/src/net/Network.ts:19 +[packages/matter.js/src/net/Network.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/Network.ts#L19) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -packages/matter.js/src/net/Network.ts:18 +[packages/matter.js/src/net/Network.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/Network.ts#L18) ___ @@ -117,4 +117,4 @@ ___ #### Defined in -packages/matter.js/src/net/Network.ts:17 +[packages/matter.js/src/net/Network.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/Network.ts#L17) diff --git a/docs/matter.js/classes/net_export.NetworkFake.md b/docs/matter.js/classes/net_export.NetworkFake.md index 9717de1eb7..36296e811e 100644 --- a/docs/matter.js/classes/net_export.NetworkFake.md +++ b/docs/matter.js/classes/net_export.NetworkFake.md @@ -48,7 +48,7 @@ #### Defined in -packages/matter.js/src/net/fake/NetworkFake.ts:13 +[packages/matter.js/src/net/fake/NetworkFake.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/NetworkFake.ts#L13) ## Properties @@ -58,7 +58,7 @@ packages/matter.js/src/net/fake/NetworkFake.ts:13 #### Defined in -packages/matter.js/src/net/fake/NetworkFake.ts:15 +[packages/matter.js/src/net/fake/NetworkFake.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/NetworkFake.ts#L15) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/NetworkFake.ts:14 +[packages/matter.js/src/net/fake/NetworkFake.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/NetworkFake.ts#L14) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/matter.js/src/net/Network.ts:13 +[packages/matter.js/src/net/Network.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/Network.ts#L13) ## Methods @@ -108,7 +108,7 @@ packages/matter.js/src/net/Network.ts:13 #### Defined in -packages/matter.js/src/net/Network.ts:21 +[packages/matter.js/src/net/Network.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/Network.ts#L21) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/NetworkFake.ts:28 +[packages/matter.js/src/net/fake/NetworkFake.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/NetworkFake.ts#L28) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/NetworkFake.ts:24 +[packages/matter.js/src/net/fake/NetworkFake.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/NetworkFake.ts#L24) ___ @@ -179,4 +179,4 @@ ___ #### Defined in -packages/matter.js/src/net/fake/NetworkFake.ts:20 +[packages/matter.js/src/net/fake/NetworkFake.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/NetworkFake.ts#L20) diff --git a/docs/matter.js/classes/net_export.SimulatedNetwork.md b/docs/matter.js/classes/net_export.SimulatedNetwork.md index 821483d72f..3172d8f6ec 100644 --- a/docs/matter.js/classes/net_export.SimulatedNetwork.md +++ b/docs/matter.js/classes/net_export.SimulatedNetwork.md @@ -35,7 +35,7 @@ #### Defined in -packages/matter.js/src/net/fake/SimulatedNetwork.ts:21 +[packages/matter.js/src/net/fake/SimulatedNetwork.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/SimulatedNetwork.ts#L21) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/SimulatedNetwork.ts:19 +[packages/matter.js/src/net/fake/SimulatedNetwork.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/SimulatedNetwork.ts#L19) ## Methods @@ -75,7 +75,7 @@ packages/matter.js/src/net/fake/SimulatedNetwork.ts:19 #### Defined in -packages/matter.js/src/net/fake/SimulatedNetwork.ts:36 +[packages/matter.js/src/net/fake/SimulatedNetwork.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/SimulatedNetwork.ts#L36) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/SimulatedNetwork.ts:23 +[packages/matter.js/src/net/fake/SimulatedNetwork.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/SimulatedNetwork.ts#L23) ___ @@ -121,4 +121,4 @@ ___ #### Defined in -packages/matter.js/src/net/fake/SimulatedNetwork.ts:48 +[packages/matter.js/src/net/fake/SimulatedNetwork.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/SimulatedNetwork.ts#L48) diff --git a/docs/matter.js/classes/net_export.UdpChannelFake.md b/docs/matter.js/classes/net_export.UdpChannelFake.md index db1d0a33a5..fb69e58d1c 100644 --- a/docs/matter.js/classes/net_export.UdpChannelFake.md +++ b/docs/matter.js/classes/net_export.UdpChannelFake.md @@ -45,7 +45,7 @@ #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:31 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L31) ## Properties @@ -55,7 +55,7 @@ packages/matter.js/src/net/fake/UdpChannelFake.ts:31 #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:33 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L33) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:29 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L29) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:32 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L32) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:27 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L27) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:28 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L28) ## Methods @@ -113,7 +113,7 @@ packages/matter.js/src/net/fake/UdpChannelFake.ts:28 #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:49 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L49) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:39 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L39) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:45 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L45) ___ @@ -184,4 +184,4 @@ ___ #### Defined in -packages/matter.js/src/net/fake/UdpChannelFake.ts:16 +[packages/matter.js/src/net/fake/UdpChannelFake.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/UdpChannelFake.ts#L16) diff --git a/docs/matter.js/classes/net_export.UdpInterface.md b/docs/matter.js/classes/net_export.UdpInterface.md index ebcbeb4247..026b3a7360 100644 --- a/docs/matter.js/classes/net_export.UdpInterface.md +++ b/docs/matter.js/classes/net_export.UdpInterface.md @@ -41,7 +41,7 @@ A Network interface enhances a TransportInterface with the ability to open a cha #### Defined in -packages/matter.js/src/net/UdpInterface.ts:22 +[packages/matter.js/src/net/UdpInterface.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L22) ## Properties @@ -51,7 +51,7 @@ packages/matter.js/src/net/UdpInterface.ts:22 #### Defined in -packages/matter.js/src/net/UdpInterface.ts:22 +[packages/matter.js/src/net/UdpInterface.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L22) ## Methods @@ -69,7 +69,7 @@ packages/matter.js/src/net/UdpInterface.ts:22 #### Defined in -packages/matter.js/src/net/UdpInterface.ts:37 +[packages/matter.js/src/net/UdpInterface.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L37) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpInterface.ts:32 +[packages/matter.js/src/net/UdpInterface.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L32) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpInterface.ts:24 +[packages/matter.js/src/net/UdpInterface.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L24) ___ @@ -140,4 +140,4 @@ ___ #### Defined in -packages/matter.js/src/net/UdpInterface.ts:16 +[packages/matter.js/src/net/UdpInterface.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpInterface.ts#L16) diff --git a/docs/matter.js/classes/net_export.UdpMulticastServer.md b/docs/matter.js/classes/net_export.UdpMulticastServer.md index a4c9351ee1..56bd24bf2f 100644 --- a/docs/matter.js/classes/net_export.UdpMulticastServer.md +++ b/docs/matter.js/classes/net_export.UdpMulticastServer.md @@ -49,7 +49,7 @@ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:50 +[packages/matter.js/src/net/UdpMulticastServer.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L60) ## Properties @@ -59,7 +59,7 @@ packages/matter.js/src/net/UdpMulticastServer.ts:50 #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:52 +[packages/matter.js/src/net/UdpMulticastServer.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L62) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:53 +[packages/matter.js/src/net/UdpMulticastServer.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L63) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:44 +[packages/matter.js/src/net/UdpMulticastServer.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L54) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:54 +[packages/matter.js/src/net/UdpMulticastServer.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L64) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:57 +[packages/matter.js/src/net/UdpMulticastServer.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L67) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:51 +[packages/matter.js/src/net/UdpMulticastServer.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L61) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:55 +[packages/matter.js/src/net/UdpMulticastServer.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L65) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:56 +[packages/matter.js/src/net/UdpMulticastServer.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L66) ## Methods @@ -143,7 +143,7 @@ packages/matter.js/src/net/UdpMulticastServer.ts:56 #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:116 +[packages/matter.js/src/net/UdpMulticastServer.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L126) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:108 +[packages/matter.js/src/net/UdpMulticastServer.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L118) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:60 +[packages/matter.js/src/net/UdpMulticastServer.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L70) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:69 +[packages/matter.js/src/net/UdpMulticastServer.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L79) ___ @@ -226,4 +226,4 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:24 +[packages/matter.js/src/net/UdpMulticastServer.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L24) diff --git a/docs/matter.js/classes/protocol_export.ChannelManager.md b/docs/matter.js/classes/protocol_export.ChannelManager.md index 7cb9b43f6c..0d4454f83c 100644 --- a/docs/matter.js/classes/protocol_export.ChannelManager.md +++ b/docs/matter.js/classes/protocol_export.ChannelManager.md @@ -21,6 +21,7 @@ - [getChannel](protocol_export.ChannelManager.md#getchannel) - [getChannelForSession](protocol_export.ChannelManager.md#getchannelforsession) - [getChannelKey](protocol_export.ChannelManager.md#getchannelkey) +- [getOrCreateAsPaseChannel](protocol_export.ChannelManager.md#getorcreateaspasechannel) - [getOrCreateChannel](protocol_export.ChannelManager.md#getorcreatechannel) - [removeChannel](protocol_export.ChannelManager.md#removechannel) - [setChannel](protocol_export.ChannelManager.md#setchannel) @@ -39,7 +40,7 @@ #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:19 +[packages/matter.js/src/protocol/ChannelManager.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L22) ___ @@ -49,7 +50,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:20 +[packages/matter.js/src/protocol/ChannelManager.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L23) ## Methods @@ -63,7 +64,7 @@ packages/matter.js/src/protocol/ChannelManager.ts:20 #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:76 +[packages/matter.js/src/protocol/ChannelManager.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L110) ___ @@ -84,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:30 +[packages/matter.js/src/protocol/ChannelManager.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L45) ___ @@ -104,7 +105,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:36 +[packages/matter.js/src/protocol/ChannelManager.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L51) ___ @@ -125,13 +126,13 @@ ___ #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:22 +[packages/matter.js/src/protocol/ChannelManager.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L25) ___ -### getOrCreateChannel +### getOrCreateAsPaseChannel -▸ **getOrCreateChannel**(`byteArrayChannel`, `session`): [`MessageChannel`](protocol_export.MessageChannel.md)<`any`\> +▸ `Private` **getOrCreateAsPaseChannel**(`byteArrayChannel`, `session`): [`MessageChannel`](protocol_export.MessageChannel.md)<`any`\> #### Parameters @@ -146,13 +147,34 @@ ___ #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:53 +[packages/matter.js/src/protocol/ChannelManager.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L77) + +___ + +### getOrCreateChannel + +▸ **getOrCreateChannel**(`byteArrayChannel`, `session`): `Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `byteArrayChannel` | [`Channel`](../interfaces/common_export.Channel.md)<`Uint8Array`\> | +| `session` | [`Session`](../interfaces/session_export.Session.md)<`any`\> | + +#### Returns + +`Promise`<[`MessageChannel`](protocol_export.MessageChannel.md)<`any`\>\> + +#### Defined in + +[packages/matter.js/src/protocol/ChannelManager.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L87) ___ ### removeChannel -▸ **removeChannel**(`fabric`, `nodeId`): `void` +▸ **removeChannel**(`fabric`, `nodeId`): `Promise`<`void`\> #### Parameters @@ -163,17 +185,17 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:49 +[packages/matter.js/src/protocol/ChannelManager.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L68) ___ ### setChannel -▸ **setChannel**(`fabric`, `nodeId`, `channel`): `void` +▸ **setChannel**(`fabric`, `nodeId`, `channel`): `Promise`<`void`\> #### Parameters @@ -185,8 +207,8 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Defined in -packages/matter.js/src/protocol/ChannelManager.ts:26 +[packages/matter.js/src/protocol/ChannelManager.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ChannelManager.ts#L29) diff --git a/docs/matter.js/classes/protocol_export.ControllerCommissioner.md b/docs/matter.js/classes/protocol_export.ControllerCommissioner.md index 2c8db08f5e..6baab635a5 100644 --- a/docs/matter.js/classes/protocol_export.ControllerCommissioner.md +++ b/docs/matter.js/classes/protocol_export.ControllerCommissioner.md @@ -14,6 +14,7 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp ### Properties +- [adminVendorId](protocol_export.ControllerCommissioner.md#adminvendorid) - [certificateManager](protocol_export.ControllerCommissioner.md#certificatemanager) - [clusterClients](protocol_export.ControllerCommissioner.md#clusterclients) - [collectedCommissioningData](protocol_export.ControllerCommissioner.md#collectedcommissioningdata) @@ -27,6 +28,7 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp - [interactionClient](protocol_export.ControllerCommissioner.md#interactionclient) - [lastBreadcrumb](protocol_export.ControllerCommissioner.md#lastbreadcrumb) - [lastFailSafeTime](protocol_export.ControllerCommissioner.md#lastfailsafetime) +- [nodeId](protocol_export.ControllerCommissioner.md#nodeid) - [reconnectWithDeviceCallback](protocol_export.ControllerCommissioner.md#reconnectwithdevicecallback) ### Methods @@ -40,6 +42,7 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp - [configureRegulatoryInformation](protocol_export.ControllerCommissioner.md#configureregulatoryinformation) - [deviceAttestation](protocol_export.ControllerCommissioner.md#deviceattestation) - [ensureGeneralCommissioningSuccess](protocol_export.ControllerCommissioner.md#ensuregeneralcommissioningsuccess) +- [ensureOperationalCredentialsSuccess](protocol_export.ControllerCommissioner.md#ensureoperationalcredentialssuccess) - [executeCommissioning](protocol_export.ControllerCommissioner.md#executecommissioning) - [getClusterClient](protocol_export.ControllerCommissioner.md#getclusterclient) - [getCommissioningStepResult](protocol_export.ControllerCommissioner.md#getcommissioningstepresult) @@ -56,7 +59,7 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp ### constructor -• **new ControllerCommissioner**(`interactionClient`, `certificateManager`, `fabric`, `commissioningOptions`, `reconnectWithDeviceCallback`) +• **new ControllerCommissioner**(`interactionClient`, `certificateManager`, `fabric`, `commissioningOptions`, `nodeId`, `adminVendorId`, `reconnectWithDeviceCallback`) #### Parameters @@ -66,21 +69,33 @@ Class to abstract the Device commission flow in a step wise way as defined in Sp | `certificateManager` | [`RootCertificateManager`](certificate_export.RootCertificateManager.md) | | `fabric` | [`Fabric`](fabric_export.Fabric.md) | | `commissioningOptions` | [`CommissioningOptions`](../modules/protocol_export.md#commissioningoptions) | -| `reconnectWithDeviceCallback` | (`peerNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid)) => `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `adminVendorId` | [`VendorId`](../modules/datatype_export.md#vendorid) | +| `reconnectWithDeviceCallback` | () => `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> | #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:140 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L138) ## Properties +### adminVendorId + +• `Private` `Readonly` **adminVendorId**: [`VendorId`](../modules/datatype_export.md#vendorid) + +#### Defined in + +[packages/matter.js/src/protocol/ControllerCommissioner.ts:144](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L144) + +___ + ### certificateManager • `Private` `Readonly` **certificateManager**: [`RootCertificateManager`](certificate_export.RootCertificateManager.md) #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:142 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L140) ___ @@ -90,7 +105,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:132 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L130) ___ @@ -100,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:137 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L135) ___ @@ -110,7 +125,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:134 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:132](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L132) ___ @@ -120,7 +135,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:144 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L142) ___ @@ -130,7 +145,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:133 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L131) ___ @@ -140,7 +155,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:131 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L129) ___ @@ -150,7 +165,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:130 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L128) ___ @@ -160,7 +175,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:143 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L141) ___ @@ -170,7 +185,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:138 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L136) ___ @@ -180,7 +195,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:141 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L139) ___ @@ -190,7 +205,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:136 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L134) ___ @@ -200,23 +215,27 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:135 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L133) ___ -### reconnectWithDeviceCallback +### nodeId -• `Private` `Readonly` **reconnectWithDeviceCallback**: (`peerNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid)) => `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> +• `Private` `Readonly` **nodeId**: [`NodeId`](../modules/datatype_export.md#nodeid) -#### Type declaration +#### Defined in -▸ (`peerNodeId`): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> +[packages/matter.js/src/protocol/ControllerCommissioner.ts:143](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L143) -##### Parameters +___ -| Name | Type | -| :------ | :------ | -| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +### reconnectWithDeviceCallback + +• `Private` `Readonly` **reconnectWithDeviceCallback**: () => `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> + +#### Type declaration + +▸ (): `Promise`<[`InteractionClient`](protocol_interaction_export.InteractionClient.md)\> ##### Returns @@ -224,7 +243,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:145 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L145) ## Methods @@ -246,7 +265,7 @@ invoking the ArmFailSafe command. #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:445 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:464](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L464) ___ @@ -271,7 +290,7 @@ the Commissionee using the AddTrustedRootCertificate and AddNOC commands. #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:633 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:652](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L652) ___ @@ -291,7 +310,7 @@ the commissioning process. #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:1040 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:1065](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L1065) ___ @@ -311,7 +330,7 @@ its desired access control policies. #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:680 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:705](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L705) ___ @@ -325,7 +344,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:864 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:889](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L889) ___ @@ -339,7 +358,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:731 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:756](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L756) ___ @@ -360,7 +379,7 @@ The regulatory information is configured using SetRegulatoryConfig (see Section #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:489 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:508](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L508) ___ @@ -378,7 +397,7 @@ Commissioner SHALL establish the authenticity of the Commissionee as a certified #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:580 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:599](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L599) ___ @@ -401,7 +420,30 @@ Helper method to check for errorCode/debugTest responses and throw error on fail #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:360 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:379](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L379) + +___ + +### ensureOperationalCredentialsSuccess + +▸ `Private` **ensureOperationalCredentialsSuccess**(`context`, `«destructured»`): `void` + +Helper method to check for errorCode/debugTest responses and throw error on failure + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | `string` | +| `«destructured»` | [`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `debugText`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`string`\> ; `fabricIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`FabricIndex`](../modules/datatype_export.md#fabricindex)\> ; `statusCode`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`NodeOperationalCertStatus`](../enums/cluster_export.OperationalCredentials.NodeOperationalCertStatus.md)\> }\> | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/ControllerCommissioner.ts:360](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L360) ___ @@ -412,7 +454,7 @@ ___ Execute the commissioning process in the defined order. The steps are sorted before execution based on the step number and sub step number. If >50% of the failsafe time has passed, the failsafe timer is re-armed (50% of 60s default are 30s and each -action is allowed to take 30s at minimum based on specs) +action is allowed to take 30s at minimum based on specs). #### Returns @@ -420,7 +462,7 @@ action is allowed to take 30s at minimum based on specs) #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:279 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:279](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L279) ___ @@ -454,7 +496,7 @@ Helper method to create ClusterClients. If not feature specific and for the Root #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:154 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L154) ___ @@ -475,7 +517,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:355 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:355](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L355) ___ @@ -491,7 +533,7 @@ Initial Step to receive some common data used by other steps #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:373 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:392](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L392) ___ @@ -507,7 +549,7 @@ Initialize commissioning steps and add them in the default order #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:185 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:185](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L185) ___ @@ -528,7 +570,7 @@ the Commissioner itself, or another Node to which the Commissioner has delegated #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:1021 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:1046](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L1046) ___ @@ -542,7 +584,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:469 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:488](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L488) ___ @@ -563,7 +605,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:351 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:351](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L351) ___ @@ -577,7 +619,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:344 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:344](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L344) ___ @@ -598,7 +640,7 @@ command (see Section 11.16.9.1, “SetUtcTime Command”) while timezone and DST #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:561 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:580](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L580) ___ @@ -623,4 +665,4 @@ command (see Section 11.8.7.9, “ConnectNetwork Command”) unless the Commissi #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:701 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:726](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L726) diff --git a/docs/matter.js/classes/protocol_export.ControllerDiscovery.md b/docs/matter.js/classes/protocol_export.ControllerDiscovery.md new file mode 100644 index 0000000000..3586d9118d --- /dev/null +++ b/docs/matter.js/classes/protocol_export.ControllerDiscovery.md @@ -0,0 +1,179 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [protocol/export](../modules/protocol_export.md) / ControllerDiscovery + +# Class: ControllerDiscovery + +[protocol/export](../modules/protocol_export.md).ControllerDiscovery + +## Table of contents + +### Constructors + +- [constructor](protocol_export.ControllerDiscovery.md#constructor) + +### Methods + +- [cancelCommissionableDeviceDiscovery](protocol_export.ControllerDiscovery.md#cancelcommissionabledevicediscovery) +- [cancelOperationalDeviceDiscovery](protocol_export.ControllerDiscovery.md#canceloperationaldevicediscovery) +- [discoverCommissionableDevices](protocol_export.ControllerDiscovery.md#discovercommissionabledevices) +- [discoverDeviceAddressesByIdentifier](protocol_export.ControllerDiscovery.md#discoverdeviceaddressesbyidentifier) +- [discoverOperationalDevice](protocol_export.ControllerDiscovery.md#discoveroperationaldevice) +- [iterateServerAddresses](protocol_export.ControllerDiscovery.md#iterateserveraddresses) + +## Constructors + +### constructor + +• **new ControllerDiscovery**() + +## Methods + +### cancelCommissionableDeviceDiscovery + +▸ `Static` **cancelCommissionableDeviceDiscovery**(`scanner`, `identifier?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scanner` | [`Scanner`](../interfaces/common_export.Scanner.md) | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/ControllerDiscovery.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerDiscovery.ts#L130) + +___ + +### cancelOperationalDeviceDiscovery + +▸ `Static` **cancelOperationalDeviceDiscovery**(`fabric`, `peerNodeId`, `scanner`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](fabric_export.Fabric.md) | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `scanner` | [`MdnsScanner`](mdns_export.MdnsScanner.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/ControllerDiscovery.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerDiscovery.ts#L126) + +___ + +### discoverCommissionableDevices + +▸ `Static` **discoverCommissionableDevices**(`scanners`, `timeoutSeconds`, `identifier?`, `discoveredCallback?`): `Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scanners` | [`Scanner`](../interfaces/common_export.Scanner.md)[] | +| `timeoutSeconds` | `number` | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | +| `discoveredCallback?` | (`device`: [`CommissionableDevice`](../modules/common_export.md#commissionabledevice)) => `void` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> + +#### Defined in + +[packages/matter.js/src/protocol/ControllerDiscovery.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerDiscovery.ts#L62) + +___ + +### discoverDeviceAddressesByIdentifier + +▸ `Static` **discoverDeviceAddressesByIdentifier**(`scanners`, `identifier`, `timeoutSeconds?`): `Promise`<[`ServerAddress`](../modules/common_export.md#serveraddress)[]\> + +Discovers devices by a provided identifier and a list of scanners (e.g. IP and BLE in parallel). +It returns after the timeout or if at least one device was found. +The method returns a list of addresses of the discovered devices. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `scanners` | [`Scanner`](../interfaces/common_export.Scanner.md)[] | `undefined` | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | `undefined` | +| `timeoutSeconds` | `number` | `30` | + +#### Returns + +`Promise`<[`ServerAddress`](../modules/common_export.md#serveraddress)[]\> + +#### Defined in + +[packages/matter.js/src/protocol/ControllerDiscovery.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerDiscovery.ts#L30) + +___ + +### discoverOperationalDevice + +▸ `Static` **discoverOperationalDevice**(`fabric`, `peerNodeId`, `scanner`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`ServerAddressIp`](../modules/common_export.md#serveraddressip)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabric` | [`Fabric`](fabric_export.Fabric.md) | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `scanner` | [`MdnsScanner`](mdns_export.MdnsScanner.md) | +| `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | + +#### Returns + +`Promise`<[`ServerAddressIp`](../modules/common_export.md#serveraddressip)[]\> + +#### Defined in + +[packages/matter.js/src/protocol/ControllerDiscovery.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerDiscovery.ts#L105) + +___ + +### iterateServerAddresses + +▸ `Static` **iterateServerAddresses**<`SA`, `T`, `E`\>(`servers`, `errorType`, `updateNetworkInterfaceFunc`, `func`, `lastKnownServer?`): `Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> + +Helper method to iterate through a list of server addresses and try to execute a method on each of them. If the +method throws a configurable error (or EHOSTUNREACH), the server address list is updated (to also add later +discovered addresses or devices) and then next server address is tried.The result of the first successful method +call is returned. The logic makes sure to only try each unique address (IP/port) once. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `SA` | extends [`ServerAddress`](../modules/common_export.md#serveraddress) | +| `T` | `T` | +| `E` | extends `Error` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `servers` | `SA`[] | +| `errorType` | [`ClassExtends`](../modules/util_export.md#classextends)<`E`\> | +| `updateNetworkInterfaceFunc` | () => `Promise`<`SA`[]\> | +| `func` | (`server`: `SA`) => `Promise`<`T`\> | +| `lastKnownServer?` | `SA` | + +#### Returns + +`Promise`<{ `result`: `T` ; `resultAddress`: `SA` }\> + +#### Defined in + +[packages/matter.js/src/protocol/ControllerDiscovery.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerDiscovery.ts#L140) diff --git a/docs/matter.js/classes/protocol_export.DiscoveryError.md b/docs/matter.js/classes/protocol_export.DiscoveryError.md new file mode 100644 index 0000000000..67234a6749 --- /dev/null +++ b/docs/matter.js/classes/protocol_export.DiscoveryError.md @@ -0,0 +1,39 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [protocol/export](../modules/protocol_export.md) / DiscoveryError + +# Class: DiscoveryError + +[protocol/export](../modules/protocol_export.md).DiscoveryError + +Error base class for all errors thrown by this library. + +## Hierarchy + +- [`MatterError`](common_export.MatterError.md) + + ↳ **`DiscoveryError`** + +## Table of contents + +### Constructors + +- [constructor](protocol_export.DiscoveryError.md#constructor) + +## Constructors + +### constructor + +• **new DiscoveryError**(`message?`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Inherited from + +[MatterError](common_export.MatterError.md).[constructor](common_export.MatterError.md#constructor) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1073 diff --git a/docs/matter.js/classes/protocol_export.ExchangeCounter.md b/docs/matter.js/classes/protocol_export.ExchangeCounter.md index 4b8e1f6f85..6d1fa83b79 100644 --- a/docs/matter.js/classes/protocol_export.ExchangeCounter.md +++ b/docs/matter.js/classes/protocol_export.ExchangeCounter.md @@ -32,7 +32,7 @@ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:134 +[packages/matter.js/src/protocol/ExchangeManager.ts:222](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L222) ## Methods @@ -46,4 +46,4 @@ packages/matter.js/src/protocol/ExchangeManager.ts:134 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:136 +[packages/matter.js/src/protocol/ExchangeManager.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L224) diff --git a/docs/matter.js/classes/protocol_export.ExchangeManager.md b/docs/matter.js/classes/protocol_export.ExchangeManager.md index 9d388d5fb6..8d85fbc8f8 100644 --- a/docs/matter.js/classes/protocol_export.ExchangeManager.md +++ b/docs/matter.js/classes/protocol_export.ExchangeManager.md @@ -19,6 +19,7 @@ ### Properties - [channelManager](protocol_export.ExchangeManager.md#channelmanager) +- [closingSessions](protocol_export.ExchangeManager.md#closingsessions) - [exchangeCounter](protocol_export.ExchangeManager.md#exchangecounter) - [exchanges](protocol_export.ExchangeManager.md#exchanges) - [messageCounter](protocol_export.ExchangeManager.md#messagecounter) @@ -31,6 +32,10 @@ - [addProtocolHandler](protocol_export.ExchangeManager.md#addprotocolhandler) - [addTransportInterface](protocol_export.ExchangeManager.md#addtransportinterface) - [close](protocol_export.ExchangeManager.md#close) +- [closeSession](protocol_export.ExchangeManager.md#closesession) +- [deleteExchange](protocol_export.ExchangeManager.md#deleteexchange) +- [getProtocolHandler](protocol_export.ExchangeManager.md#getprotocolhandler) +- [hasProtocolHandler](protocol_export.ExchangeManager.md#hasprotocolhandler) - [initiateExchange](protocol_export.ExchangeManager.md#initiateexchange) - [initiateExchangeWithChannel](protocol_export.ExchangeManager.md#initiateexchangewithchannel) - [onMessage](protocol_export.ExchangeManager.md#onmessage) @@ -56,7 +61,7 @@ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:57 +[packages/matter.js/src/protocol/ExchangeManager.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L66) ## Properties @@ -66,7 +71,17 @@ packages/matter.js/src/protocol/ExchangeManager.ts:57 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:59 +[packages/matter.js/src/protocol/ExchangeManager.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L68) + +___ + +### closingSessions + +• `Private` `Readonly` **closingSessions**: `Set`<`number`\> + +#### Defined in + +[packages/matter.js/src/protocol/ExchangeManager.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L64) ___ @@ -76,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:51 +[packages/matter.js/src/protocol/ExchangeManager.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L59) ___ @@ -86,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:53 +[packages/matter.js/src/protocol/ExchangeManager.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L61) ___ @@ -96,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:52 +[packages/matter.js/src/protocol/ExchangeManager.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L60) ___ @@ -106,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:54 +[packages/matter.js/src/protocol/ExchangeManager.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L62) ___ @@ -116,7 +131,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:58 +[packages/matter.js/src/protocol/ExchangeManager.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L67) ___ @@ -126,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:55 +[packages/matter.js/src/protocol/ExchangeManager.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L63) ## Methods @@ -146,7 +161,7 @@ packages/matter.js/src/protocol/ExchangeManager.ts:55 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:70 +[packages/matter.js/src/protocol/ExchangeManager.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L87) ___ @@ -166,7 +181,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:62 +[packages/matter.js/src/protocol/ExchangeManager.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L71) ___ @@ -180,7 +195,87 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:89 +[packages/matter.js/src/protocol/ExchangeManager.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L109) + +___ + +### closeSession + +▸ **closeSession**(`session`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `session` | [`SecureSession`](session_export.SecureSession.md)<`any`\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/protocol/ExchangeManager.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L179) + +___ + +### deleteExchange + +▸ **deleteExchange**(`exchangeIndex`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `exchangeIndex` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/protocol/ExchangeManager.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L160) + +___ + +### getProtocolHandler + +▸ **getProtocolHandler**(`protocolId`): `undefined` \| [`ProtocolHandler`](../interfaces/protocol_export.ProtocolHandler.md)<`ContextT`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`undefined` \| [`ProtocolHandler`](../interfaces/protocol_export.ProtocolHandler.md)<`ContextT`\> + +#### Defined in + +[packages/matter.js/src/protocol/ExchangeManager.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L83) + +___ + +### hasProtocolHandler + +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/protocol/ExchangeManager.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L79) ___ @@ -202,7 +297,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:74 +[packages/matter.js/src/protocol/ExchangeManager.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L94) ___ @@ -223,7 +318,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:78 +[packages/matter.js/src/protocol/ExchangeManager.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L98) ___ @@ -244,4 +339,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:100 +[packages/matter.js/src/protocol/ExchangeManager.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L123) diff --git a/docs/matter.js/classes/protocol_export.ExchangeProvider.md b/docs/matter.js/classes/protocol_export.ExchangeProvider.md index d837955389..75987d3883 100644 --- a/docs/matter.js/classes/protocol_export.ExchangeProvider.md +++ b/docs/matter.js/classes/protocol_export.ExchangeProvider.md @@ -23,6 +23,8 @@ ### Methods - [addProtocolHandler](protocol_export.ExchangeProvider.md#addprotocolhandler) +- [getProtocolHandler](protocol_export.ExchangeProvider.md#getprotocolhandler) +- [hasProtocolHandler](protocol_export.ExchangeProvider.md#hasprotocolhandler) - [initiateExchange](protocol_export.ExchangeProvider.md#initiateexchange) - [reconnectChannel](protocol_export.ExchangeProvider.md#reconnectchannel) @@ -42,7 +44,7 @@ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:158 +[packages/matter.js/src/protocol/ExchangeManager.ts:246](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L246) ## Properties @@ -52,7 +54,7 @@ packages/matter.js/src/protocol/ExchangeManager.ts:158 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:160 +[packages/matter.js/src/protocol/ExchangeManager.ts:248](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L248) ___ @@ -62,7 +64,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:159 +[packages/matter.js/src/protocol/ExchangeManager.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L247) ___ @@ -80,7 +82,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:161 +[packages/matter.js/src/protocol/ExchangeManager.ts:249](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L249) ## Accessors @@ -94,7 +96,7 @@ packages/matter.js/src/protocol/ExchangeManager.ts:161 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:178 +[packages/matter.js/src/protocol/ExchangeManager.ts:274](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L274) ## Methods @@ -114,7 +116,47 @@ packages/matter.js/src/protocol/ExchangeManager.ts:178 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:164 +[packages/matter.js/src/protocol/ExchangeManager.ts:260](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L260) + +___ + +### getProtocolHandler + +▸ **getProtocolHandler**(`protocolId`): `undefined` \| [`ProtocolHandler`](../interfaces/protocol_export.ProtocolHandler.md)<[`MatterController`](export._internal_.MatterController.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`undefined` \| [`ProtocolHandler`](../interfaces/protocol_export.ProtocolHandler.md)<[`MatterController`](export._internal_.MatterController.md)\> + +#### Defined in + +[packages/matter.js/src/protocol/ExchangeManager.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L256) + +___ + +### hasProtocolHandler + +▸ **hasProtocolHandler**(`protocolId`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `protocolId` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/protocol/ExchangeManager.ts:252](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L252) ___ @@ -128,7 +170,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:168 +[packages/matter.js/src/protocol/ExchangeManager.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L264) ___ @@ -142,4 +184,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:172 +[packages/matter.js/src/protocol/ExchangeManager.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L268) diff --git a/docs/matter.js/classes/protocol_export.MessageChannel.md b/docs/matter.js/classes/protocol_export.MessageChannel.md index 81976799a8..be59ab5c99 100644 --- a/docs/matter.js/classes/protocol_export.MessageChannel.md +++ b/docs/matter.js/classes/protocol_export.MessageChannel.md @@ -29,6 +29,7 @@ SPDX-License-Identifier: Apache-2.0 - [channel](protocol_export.MessageChannel.md#channel) - [closeCallback](protocol_export.MessageChannel.md#closecallback) +- [closed](protocol_export.MessageChannel.md#closed) - [session](protocol_export.MessageChannel.md#session) ### Accessors @@ -58,11 +59,11 @@ SPDX-License-Identifier: Apache-2.0 | :------ | :------ | | `channel` | [`Channel`](../interfaces/common_export.Channel.md)<`Uint8Array`\> | | `session` | [`Session`](../interfaces/session_export.Session.md)<`ContextT`\> | -| `closeCallback?` | () => `void` | +| `closeCallback?` | () => `Promise`<`void`\> | #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:27 +[packages/matter.js/src/protocol/ExchangeManager.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L31) ## Properties @@ -72,25 +73,35 @@ packages/matter.js/src/protocol/ExchangeManager.ts:27 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:28 +[packages/matter.js/src/protocol/ExchangeManager.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L32) ___ ### closeCallback -• `Private` `Optional` `Readonly` **closeCallback**: () => `void` +• `Private` `Optional` `Readonly` **closeCallback**: () => `Promise`<`void`\> #### Type declaration -▸ (): `void` +▸ (): `Promise`<`void`\> ##### Returns -`void` +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/protocol/ExchangeManager.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L34) + +___ + +### closed + +• **closed**: `boolean` = `false` #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:30 +[packages/matter.js/src/protocol/ExchangeManager.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L30) ___ @@ -100,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:29 +[packages/matter.js/src/protocol/ExchangeManager.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L33) ## Accessors @@ -118,7 +129,7 @@ packages/matter.js/src/protocol/ExchangeManager.ts:29 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:40 +[packages/matter.js/src/protocol/ExchangeManager.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L44) ## Methods @@ -136,7 +147,7 @@ packages/matter.js/src/protocol/ExchangeManager.ts:40 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:44 +[packages/matter.js/src/protocol/ExchangeManager.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L48) ___ @@ -160,4 +171,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:33 +[packages/matter.js/src/protocol/ExchangeManager.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L37) diff --git a/docs/matter.js/classes/protocol_export.MessageCounter.md b/docs/matter.js/classes/protocol_export.MessageCounter.md index 403849b3de..03a8892cbc 100644 --- a/docs/matter.js/classes/protocol_export.MessageCounter.md +++ b/docs/matter.js/classes/protocol_export.MessageCounter.md @@ -32,7 +32,7 @@ #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:146 +[packages/matter.js/src/protocol/ExchangeManager.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L234) ## Methods @@ -46,4 +46,4 @@ packages/matter.js/src/protocol/ExchangeManager.ts:146 #### Defined in -packages/matter.js/src/protocol/ExchangeManager.ts:148 +[packages/matter.js/src/protocol/ExchangeManager.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ExchangeManager.ts#L236) diff --git a/docs/matter.js/classes/protocol_export.MessageExchange.md b/docs/matter.js/classes/protocol_export.MessageExchange.md index fccc9b29a6..bccd51b75c 100644 --- a/docs/matter.js/classes/protocol_export.MessageExchange.md +++ b/docs/matter.js/classes/protocol_export.MessageExchange.md @@ -84,11 +84,11 @@ | `peerNodeId` | `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) | | `exchangeId` | `number` | | `protocolId` | `number` | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:125 +[packages/matter.js/src/protocol/MessageExchange.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L125) ## Properties @@ -98,7 +98,7 @@ packages/matter.js/src/protocol/MessageExchange.ts:125 #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:113 +[packages/matter.js/src/protocol/MessageExchange.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L113) ___ @@ -108,25 +108,25 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:127 +[packages/matter.js/src/protocol/MessageExchange.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L127) ___ ### closeCallback -• `Private` `Readonly` **closeCallback**: () => `void` +• `Private` `Readonly` **closeCallback**: () => `Promise`<`void`\> #### Type declaration -▸ (): `void` +▸ (): `Promise`<`void`\> ##### Returns -`void` +`Promise`<`void`\> #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:135 +[packages/matter.js/src/protocol/MessageExchange.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L135) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:122 +[packages/matter.js/src/protocol/MessageExchange.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L122) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:133 +[packages/matter.js/src/protocol/MessageExchange.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L133) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:114 +[packages/matter.js/src/protocol/MessageExchange.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L114) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:129 +[packages/matter.js/src/protocol/MessageExchange.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L129) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:128 +[packages/matter.js/src/protocol/MessageExchange.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L128) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:116 +[packages/matter.js/src/protocol/MessageExchange.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L116) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:131 +[packages/matter.js/src/protocol/MessageExchange.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L131) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:132 +[packages/matter.js/src/protocol/MessageExchange.ts:132](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L132) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:130 +[packages/matter.js/src/protocol/MessageExchange.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L130) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:134 +[packages/matter.js/src/protocol/MessageExchange.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L134) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:117 +[packages/matter.js/src/protocol/MessageExchange.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L117) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:115 +[packages/matter.js/src/protocol/MessageExchange.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L115) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:121 +[packages/matter.js/src/protocol/MessageExchange.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L121) ___ @@ -266,7 +266,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:120 +[packages/matter.js/src/protocol/MessageExchange.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L120) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:119 +[packages/matter.js/src/protocol/MessageExchange.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L119) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:118 +[packages/matter.js/src/protocol/MessageExchange.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L118) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:126 +[packages/matter.js/src/protocol/MessageExchange.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L126) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:123 +[packages/matter.js/src/protocol/MessageExchange.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L123) ## Methods @@ -320,7 +320,7 @@ packages/matter.js/src/protocol/MessageExchange.ts:123 #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:374 +[packages/matter.js/src/protocol/MessageExchange.ts:376](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L376) ___ @@ -334,21 +334,21 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:394 +[packages/matter.js/src/protocol/MessageExchange.ts:396](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L396) ___ ### closeInternal -▸ `Private` **closeInternal**(): `void` +▸ `Private` **closeInternal**(): `Promise`<`void`\> #### Returns -`void` +`Promise`<`void`\> #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:407 +[packages/matter.js/src/protocol/MessageExchange.ts:411](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L411) ___ @@ -362,7 +362,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:345 +[packages/matter.js/src/protocol/MessageExchange.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L347) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:298 +[packages/matter.js/src/protocol/MessageExchange.ts:300](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L300) ___ @@ -400,7 +400,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:386 +[packages/matter.js/src/protocol/MessageExchange.ts:388](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L388) ___ @@ -414,7 +414,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:390 +[packages/matter.js/src/protocol/MessageExchange.ts:392](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L392) ___ @@ -428,7 +428,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:382 +[packages/matter.js/src/protocol/MessageExchange.ts:384](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L384) ___ @@ -442,7 +442,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:279 +[packages/matter.js/src/protocol/MessageExchange.ts:281](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L281) ___ @@ -462,7 +462,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:154 +[packages/matter.js/src/protocol/MessageExchange.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L156) ___ @@ -484,7 +484,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:310 +[packages/matter.js/src/protocol/MessageExchange.ts:312](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L312) ___ @@ -506,7 +506,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:214 +[packages/matter.js/src/protocol/MessageExchange.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L216) ___ @@ -526,7 +526,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:356 +[packages/matter.js/src/protocol/MessageExchange.ts:358](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L358) ___ @@ -547,7 +547,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:283 +[packages/matter.js/src/protocol/MessageExchange.ts:285](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L285) ___ @@ -568,7 +568,7 @@ ___ | `channel` | [`MessageChannel`](protocol_export.MessageChannel.md)<`ContextT`\> | | `messageCounter` | [`MessageCounter`](protocol_export.MessageCounter.md) | | `initialMessage` | [`Message`](../interfaces/codec_export.Message.md) | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Returns @@ -576,7 +576,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:70 +[packages/matter.js/src/protocol/MessageExchange.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L70) ___ @@ -598,7 +598,7 @@ ___ | `exchangeId` | `number` | | `protocolId` | `number` | | `messageCounter` | [`MessageCounter`](protocol_export.MessageCounter.md) | -| `closeCallback` | () => `void` | +| `closeCallback` | () => `Promise`<`void`\> | #### Returns @@ -606,4 +606,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:91 +[packages/matter.js/src/protocol/MessageExchange.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L91) diff --git a/docs/matter.js/classes/protocol_export.UnexpectedMessageError.md b/docs/matter.js/classes/protocol_export.UnexpectedMessageError.md index c9e61d40f0..3f10c1ce33 100644 --- a/docs/matter.js/classes/protocol_export.UnexpectedMessageError.md +++ b/docs/matter.js/classes/protocol_export.UnexpectedMessageError.md @@ -41,7 +41,7 @@ Error base class for all errors thrown by this library. #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:28 +[packages/matter.js/src/protocol/MessageExchange.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L28) ## Properties @@ -51,4 +51,4 @@ packages/matter.js/src/protocol/MessageExchange.ts:28 #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:30 +[packages/matter.js/src/protocol/MessageExchange.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L30) diff --git a/docs/matter.js/classes/protocol_interaction_export.IncomingInteractionClientMessenger.md b/docs/matter.js/classes/protocol_interaction_export.IncomingInteractionClientMessenger.md index 978aeed51a..b01d796c38 100644 --- a/docs/matter.js/classes/protocol_interaction_export.IncomingInteractionClientMessenger.md +++ b/docs/matter.js/classes/protocol_interaction_export.IncomingInteractionClientMessenger.md @@ -51,7 +51,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L95) ## Properties @@ -65,7 +65,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L95) ## Methods @@ -83,7 +83,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:118 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L125) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:133 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L140) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:106 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L113) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:342 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:344](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L344) ___ @@ -165,7 +165,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:90 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L97) ___ @@ -189,7 +189,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:94 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L101) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:122 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L129) ___ @@ -231,4 +231,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:101 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L108) diff --git a/docs/matter.js/classes/protocol_interaction_export.InteractionClient.md b/docs/matter.js/classes/protocol_interaction_export.InteractionClient.md index 7eb9c2afb3..d789ecf9c8 100644 --- a/docs/matter.js/classes/protocol_interaction_export.InteractionClient.md +++ b/docs/matter.js/classes/protocol_interaction_export.InteractionClient.md @@ -13,9 +13,11 @@ ### Properties - [exchangeProvider](protocol_interaction_export.InteractionClient.md#exchangeprovider) +- [nodeId](protocol_interaction_export.InteractionClient.md#nodeid) +- [ownSubscriptionIds](protocol_interaction_export.InteractionClient.md#ownsubscriptionids) - [subscribedClusterDataVersions](protocol_interaction_export.InteractionClient.md#subscribedclusterdataversions) - [subscribedLocalValues](protocol_interaction_export.InteractionClient.md#subscribedlocalvalues) -- [subscriptionListeners](protocol_interaction_export.InteractionClient.md#subscriptionlisteners) +- [subscriptionClient](protocol_interaction_export.InteractionClient.md#subscriptionclient) ### Accessors @@ -23,6 +25,7 @@ ### Methods +- [close](protocol_interaction_export.InteractionClient.md#close) - [getAllAttributes](protocol_interaction_export.InteractionClient.md#getallattributes) - [getAllAttributesAndEvents](protocol_interaction_export.InteractionClient.md#getallattributesandevents) - [getAllEvents](protocol_interaction_export.InteractionClient.md#getallevents) @@ -35,6 +38,9 @@ - [invoke](protocol_interaction_export.InteractionClient.md#invoke) - [invokeWithSuppressedResponse](protocol_interaction_export.InteractionClient.md#invokewithsuppressedresponse) - [processReadRequest](protocol_interaction_export.InteractionClient.md#processreadrequest) +- [registerSubscriptionListener](protocol_interaction_export.InteractionClient.md#registersubscriptionlistener) +- [registerSubscriptionUpdateTimer](protocol_interaction_export.InteractionClient.md#registersubscriptionupdatetimer) +- [removeSubscription](protocol_interaction_export.InteractionClient.md#removesubscription) - [setAttribute](protocol_interaction_export.InteractionClient.md#setattribute) - [setMultipleAttributes](protocol_interaction_export.InteractionClient.md#setmultipleattributes) - [subscribeAllAttributesAndEvents](protocol_interaction_export.InteractionClient.md#subscribeallattributesandevents) @@ -47,17 +53,18 @@ ### constructor -• **new InteractionClient**(`exchangeProvider`) +• **new InteractionClient**(`exchangeProvider`, `nodeId`) #### Parameters | Name | Type | | :------ | :------ | | `exchangeProvider` | [`ExchangeProvider`](protocol_export.ExchangeProvider.md) | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:96 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L133) ## Properties @@ -67,7 +74,27 @@ packages/matter.js/src/protocol/interaction/InteractionClient.ts:96 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:96 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L134) + +___ + +### nodeId + +• `Readonly` **nodeId**: [`NodeId`](../modules/datatype_export.md#nodeid) + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L135) + +___ + +### ownSubscriptionIds + +• `Private` `Readonly` **ownSubscriptionIds**: `Set`<`number`\> + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L130) ___ @@ -77,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:94 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L129) ___ @@ -87,17 +114,17 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:93 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L128) ___ -### subscriptionListeners +### subscriptionClient -• `Private` `Readonly` **subscriptionListeners**: `Map`<`number`, (`dataReport`: [`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeReports`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeData`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `data`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TlvStream`](../modules/tlv_export.md#tlvstream)\> ; `dataVersion`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number`\> ; `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`AttributeId`](../modules/datatype_export.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> }\>\> ; `attributeStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`AttributeId`](../modules/datatype_export.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `eventReports`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `eventData`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `data`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TlvStream`](../modules/tlv_export.md#tlvstream)\> ; `deltaEpochTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `deltaSystemTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `epochTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `eventNumber`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number` \| `bigint`\> ; `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EventId`](../modules/datatype_export.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `priority`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`EventPriority`](../enums/cluster_export.EventPriority.md)\> ; `systemTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> }\>\> ; `eventStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EventId`](../modules/datatype_export.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `interactionModelRevision`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> ; `moreChunkedMessages`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `subscriptionId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number`\> ; `suppressResponse`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> }\>) => `void`\> +• `Private` `Readonly` **subscriptionClient**: [`SubscriptionClient`](protocol_interaction_export.SubscriptionClient.md) #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:92 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L131) ## Accessors @@ -111,10 +138,24 @@ packages/matter.js/src/protocol/interaction/InteractionClient.ts:92 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:920 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:1030](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L1030) ## Methods +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:1022](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L1022) + +___ + ### getAllAttributes ▸ **getAllAttributes**(`options?`): `Promise`<[`DecodedAttributeReportValue`](../modules/protocol_interaction_export.md#decodedattributereportvalue)<`any`\>[]\> @@ -133,7 +174,7 @@ packages/matter.js/src/protocol/interaction/InteractionClient.ts:920 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:101 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L162) ___ @@ -156,7 +197,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:128 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:189](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L189) ___ @@ -178,7 +219,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:117 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:178](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L178) ___ @@ -209,7 +250,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:223 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L284) ___ @@ -240,7 +281,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:241 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:302](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L302) ___ @@ -272,7 +313,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:272 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:333](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L333) ___ @@ -295,7 +336,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:152 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L213) ___ @@ -320,7 +361,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:175 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L236) ___ @@ -343,7 +384,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:164 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L225) ___ @@ -376,7 +417,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:759 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:839](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L839) ___ @@ -408,7 +449,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:857 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:937](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L937) ___ @@ -429,7 +470,70 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:289 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:350](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L350) + +___ + +### registerSubscriptionListener + +▸ **registerSubscriptionListener**(`subscriptionId`, `listener`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | +| `listener` | (`dataReport`: [`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeReports`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeData`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `data`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TlvStream`](../modules/tlv_export.md#tlvstream)\> ; `dataVersion`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number`\> ; `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`AttributeId`](../modules/datatype_export.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> }\>\> ; `attributeStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`AttributeId`](../modules/datatype_export.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `eventReports`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `eventData`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `data`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TlvStream`](../modules/tlv_export.md#tlvstream)\> ; `deltaEpochTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `deltaSystemTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `epochTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `eventNumber`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number` \| `bigint`\> ; `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EventId`](../modules/datatype_export.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `priority`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`EventPriority`](../enums/cluster_export.EventPriority.md)\> ; `systemTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> }\>\> ; `eventStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EventId`](../modules/datatype_export.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `interactionModelRevision`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> ; `moreChunkedMessages`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `subscriptionId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number`\> ; `suppressResponse`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> }\>) => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L151) + +___ + +### registerSubscriptionUpdateTimer + +▸ `Private` **registerSubscriptionUpdateTimer**(`subscriptionId`, `maxInterval`, `updateTimeoutHandler`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | +| `maxInterval` | `number` | +| `updateTimeoutHandler` | [`TimerCallback`](../modules/time_export.md#timercallback) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:1000](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L1000) + +___ + +### removeSubscription + +▸ **removeSubscription**(`subscriptionId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L156) ___ @@ -464,7 +568,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:333 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:394](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L394) ___ @@ -488,7 +592,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:369 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:430](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L430) ___ @@ -510,6 +614,7 @@ ___ | `options.keepSubscriptions?` | `boolean` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/time_export.md#timercallback) | #### Returns @@ -517,7 +622,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:583 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:654](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L654) ___ @@ -545,6 +650,7 @@ ___ | `options.listener?` | (`value`: [`AttributeJsType`](../modules/cluster_export.md#attributejstype)<`A`\>, `version`: `number`) => `void` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/time_export.md#timercallback) | #### Returns @@ -552,7 +658,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:438 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:499](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L499) ___ @@ -581,6 +687,7 @@ ___ | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | | `options.minimumEventNumber?` | `number` \| `bigint` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/time_export.md#timercallback) | #### Returns @@ -588,7 +695,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:517 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:583](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L583) ___ @@ -611,6 +718,7 @@ ___ | `options.keepSubscriptions?` | `boolean` | | `options.maxIntervalCeilingSeconds` | `number` | | `options.minIntervalFloorSeconds` | `number` | +| `options.updateTimeoutHandler?` | [`TimerCallback`](../modules/time_export.md#timercallback) | #### Returns @@ -618,7 +726,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:622 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:696](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L696) ___ @@ -644,4 +752,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:911 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:991](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L991) diff --git a/docs/matter.js/classes/protocol_interaction_export.InteractionClientMessenger.md b/docs/matter.js/classes/protocol_interaction_export.InteractionClientMessenger.md index 84c62ffe09..c00be5da55 100644 --- a/docs/matter.js/classes/protocol_interaction_export.InteractionClientMessenger.md +++ b/docs/matter.js/classes/protocol_interaction_export.InteractionClientMessenger.md @@ -57,7 +57,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:372 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:379](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L379) ## Properties @@ -71,7 +71,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:372 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L95) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:372 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:379](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L379) ## Methods @@ -99,7 +99,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:372 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:118 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L125) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:133 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L140) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:106 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L113) ___ @@ -159,7 +159,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:342 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:344](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L344) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:484 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:494](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L494) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:472 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:482](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L482) ___ @@ -248,7 +248,7 @@ Implements a send method with an automatic reconnection mechanism #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:377 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:384](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L384) ___ @@ -269,7 +269,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:431 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:441](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L441) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:394 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:404](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L404) ___ @@ -313,7 +313,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:94 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L101) ___ @@ -333,7 +333,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:404 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:414](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L414) ___ @@ -353,7 +353,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:465 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:475](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L475) ___ @@ -373,7 +373,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:451 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:461](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L461) ___ @@ -397,7 +397,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:122 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L129) ___ @@ -415,4 +415,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:101 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L108) diff --git a/docs/matter.js/classes/protocol_interaction_export.InteractionEndpointStructure.md b/docs/matter.js/classes/protocol_interaction_export.InteractionEndpointStructure.md index 2fcb7c1ecb..52b500dc61 100644 --- a/docs/matter.js/classes/protocol_interaction_export.InteractionEndpointStructure.md +++ b/docs/matter.js/classes/protocol_interaction_export.InteractionEndpointStructure.md @@ -60,7 +60,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:37 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L37) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:36 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L36) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:41 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L41) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:40 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L40) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:35 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L35) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:39 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L39) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:38 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L38) ## Methods @@ -134,7 +134,7 @@ packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:38 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:43 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L43) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:53 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L53) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:192 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L192) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:224 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L224) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:184 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L184) ___ @@ -234,7 +234,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:212 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L212) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:283 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L283) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:176 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:176](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L176) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:204 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:204](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L204) ___ @@ -316,7 +316,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:254 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:254](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L254) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:200 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L200) ___ @@ -359,7 +359,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:188 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:188](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L188) ___ @@ -381,7 +381,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:220 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L220) ___ @@ -401,7 +401,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:180 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L180) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:208 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L208) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:59 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L59) ___ @@ -463,7 +463,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:66 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L66) ___ @@ -483,7 +483,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:158 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L158) ___ @@ -503,7 +503,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:172 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L172) ___ @@ -523,7 +523,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:162 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L162) ___ @@ -547,7 +547,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:122 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L122) ___ @@ -567,7 +567,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:118 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L118) ___ @@ -587,4 +587,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:74 +[packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionEndpointStructure.ts#L74) diff --git a/docs/matter.js/classes/protocol_interaction_export.InteractionServer.md b/docs/matter.js/classes/protocol_interaction_export.InteractionServer.md index 419a6659d3..ba980fc67d 100644 --- a/docs/matter.js/classes/protocol_interaction_export.InteractionServer.md +++ b/docs/matter.js/classes/protocol_interaction_export.InteractionServer.md @@ -51,7 +51,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:136 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L136) ## Properties @@ -61,7 +61,7 @@ packages/matter.js/src/protocol/interaction/InteractionServer.ts:136 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:130 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L130) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:132 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:132](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L132) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:134 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L134) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:131 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L131) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:138 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L138) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:137 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:137](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L137) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:133 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L133) ## Methods @@ -133,9 +133,13 @@ packages/matter.js/src/protocol/interaction/InteractionServer.ts:133 `Promise`<`void`\> +#### Implementation of + +[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[close](../interfaces/protocol_export.ProtocolHandler.md#close) + #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:863 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:863](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L863) ___ @@ -153,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:141 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L141) ___ @@ -175,7 +179,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:686 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:686](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L686) ___ @@ -196,7 +200,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:173 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L173) ___ @@ -218,7 +222,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:537 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:537](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L537) ___ @@ -239,7 +243,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:851 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:851](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L851) ___ @@ -261,7 +265,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:324 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:324](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L324) ___ @@ -285,7 +289,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:162 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L162) ___ @@ -305,4 +309,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:145 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L145) diff --git a/docs/matter.js/classes/protocol_interaction_export.InteractionServerMessenger.md b/docs/matter.js/classes/protocol_interaction_export.InteractionServerMessenger.md index 1c0951a194..d5125be458 100644 --- a/docs/matter.js/classes/protocol_interaction_export.InteractionServerMessenger.md +++ b/docs/matter.js/classes/protocol_interaction_export.InteractionServerMessenger.md @@ -51,7 +51,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L95) ## Properties @@ -65,7 +65,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L95) ## Methods @@ -83,7 +83,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:88 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:118 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L125) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:133 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L140) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:139 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L146) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:106 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L113) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:90 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L97) ___ @@ -198,7 +198,7 @@ messages and send them out based on the size. #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:219 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:221](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L221) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:306 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:308](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L308) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:94 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L101) ___ @@ -266,7 +266,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:122 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L129) ___ @@ -284,4 +284,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:101 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L108) diff --git a/docs/matter.js/classes/protocol_interaction_export.StatusResponseError.md b/docs/matter.js/classes/protocol_interaction_export.StatusResponseError.md index 79654a716c..88c68ef580 100644 --- a/docs/matter.js/classes/protocol_interaction_export.StatusResponseError.md +++ b/docs/matter.js/classes/protocol_interaction_export.StatusResponseError.md @@ -43,7 +43,7 @@ Error base Class for all errors related to the status response messages. #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:72 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L79) ## Properties @@ -53,7 +53,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:72 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:75 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L82) ___ @@ -63,4 +63,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:74 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L81) diff --git a/docs/matter.js/classes/protocol_interaction_export.SubscriptionClient.md b/docs/matter.js/classes/protocol_interaction_export.SubscriptionClient.md index 7a45cfb3b8..ca29fbfff9 100644 --- a/docs/matter.js/classes/protocol_interaction_export.SubscriptionClient.md +++ b/docs/matter.js/classes/protocol_interaction_export.SubscriptionClient.md @@ -17,27 +17,27 @@ ### Properties - [subscriptionListeners](protocol_interaction_export.SubscriptionClient.md#subscriptionlisteners) +- [subscriptionUpdateTimers](protocol_interaction_export.SubscriptionClient.md#subscriptionupdatetimers) ### Methods +- [close](protocol_interaction_export.SubscriptionClient.md#close) - [getId](protocol_interaction_export.SubscriptionClient.md#getid) - [onNewExchange](protocol_interaction_export.SubscriptionClient.md#onnewexchange) +- [registerSubscriptionListener](protocol_interaction_export.SubscriptionClient.md#registersubscriptionlistener) +- [registerSubscriptionUpdateTimer](protocol_interaction_export.SubscriptionClient.md#registersubscriptionupdatetimer) +- [removeSubscriptionListener](protocol_interaction_export.SubscriptionClient.md#removesubscriptionlistener) +- [removeSubscriptionUpdateTimer](protocol_interaction_export.SubscriptionClient.md#removesubscriptionupdatetimer) ## Constructors ### constructor -• **new SubscriptionClient**(`subscriptionListeners`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `subscriptionListeners` | `Map`<`number`, (`dataReport`: [`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeReports`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeData`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `data`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TlvStream`](../modules/tlv_export.md#tlvstream)\> ; `dataVersion`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number`\> ; `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`AttributeId`](../modules/datatype_export.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> }\>\> ; `attributeStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`AttributeId`](../modules/datatype_export.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `eventReports`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `eventData`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `data`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TlvStream`](../modules/tlv_export.md#tlvstream)\> ; `deltaEpochTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `deltaSystemTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `epochTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `eventNumber`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number` \| `bigint`\> ; `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EventId`](../modules/datatype_export.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `priority`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`EventPriority`](../enums/cluster_export.EventPriority.md)\> ; `systemTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> }\>\> ; `eventStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EventId`](../modules/datatype_export.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `interactionModelRevision`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> ; `moreChunkedMessages`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `subscriptionId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number`\> ; `suppressResponse`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> }\>) => `void`\> | +• **new SubscriptionClient**() #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:63 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L67) ## Properties @@ -47,10 +47,38 @@ packages/matter.js/src/protocol/interaction/InteractionClient.ts:63 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:63 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L64) + +___ + +### subscriptionUpdateTimers + +• `Private` `Readonly` **subscriptionUpdateTimers**: `Map`<`number`, [`Timer`](../interfaces/time_export.Timer.md)\> + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L65) ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[close](../interfaces/protocol_export.ProtocolHandler.md#close) + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L119) + +___ + ### getId ▸ **getId**(): `number` @@ -65,7 +93,7 @@ packages/matter.js/src/protocol/interaction/InteractionClient.ts:63 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:65 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L69) ___ @@ -89,4 +117,86 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:69 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L90) + +___ + +### registerSubscriptionListener + +▸ **registerSubscriptionListener**(`subscriptionId`, `listener`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | +| `listener` | (`dataReport`: [`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeReports`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeData`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `data`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TlvStream`](../modules/tlv_export.md#tlvstream)\> ; `dataVersion`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number`\> ; `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`AttributeId`](../modules/datatype_export.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> }\>\> ; `attributeStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `attributeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`AttributeId`](../modules/datatype_export.md#attributeid)\> ; `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `enableTagCompression`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `listIndex`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<``null`` \| `number`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `eventReports`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `eventData`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `data`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TlvStream`](../modules/tlv_export.md#tlvstream)\> ; `deltaEpochTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `deltaSystemTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `epochTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> ; `eventNumber`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number` \| `bigint`\> ; `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EventId`](../modules/datatype_export.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `priority`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`EventPriority`](../enums/cluster_export.EventPriority.md)\> ; `systemTimestamp`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number` \| `bigint`\> }\>\> ; `eventStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `path`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`ClusterId`](../modules/datatype_export.md#clusterid)\> ; `endpointId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EndpointNumber`](../modules/datatype_export.md#endpointnumber)\> ; `eventId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`EventId`](../modules/datatype_export.md#eventid)\> ; `isUrgent`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `nodeId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`NodeId`](../modules/datatype_export.md#nodeid)\> }\>\> ; `status`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `clusterStatus`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> ; `status`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<[`StatusCode`](../enums/protocol_interaction_export.StatusCode.md)\> }\>\> }\>\> }\>[]\> ; `interactionModelRevision`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> ; `moreChunkedMessages`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> ; `subscriptionId`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`number`\> ; `suppressResponse`: [`OptionalFieldType`](../interfaces/tlv_export.OptionalFieldType.md)<`boolean`\> }\>) => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L73) + +___ + +### registerSubscriptionUpdateTimer + +▸ **registerSubscriptionUpdateTimer**(`subscriptionId`, `timer`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | +| `timer` | [`Timer`](../interfaces/time_export.Timer.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L81) + +___ + +### removeSubscriptionListener + +▸ **removeSubscriptionListener**(`subscriptionId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L77) + +___ + +### removeSubscriptionUpdateTimer + +▸ **removeSubscriptionUpdateTimer**(`subscriptionId`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `subscriptionId` | `number` | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L85) diff --git a/docs/matter.js/classes/protocol_interaction_export.SubscriptionHandler.md b/docs/matter.js/classes/protocol_interaction_export.SubscriptionHandler.md index d241fe6d8f..0ffaee3c75 100644 --- a/docs/matter.js/classes/protocol_interaction_export.SubscriptionHandler.md +++ b/docs/matter.js/classes/protocol_interaction_export.SubscriptionHandler.md @@ -89,7 +89,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:99 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L99) ## Properties @@ -99,7 +99,7 @@ packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:99 #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:72 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L72) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:103 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L103) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:114 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L114) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:104 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:104](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L104) ___ @@ -147,7 +147,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:102 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L102) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:106 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L106) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:107 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L107) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:79 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L79) ___ @@ -187,7 +187,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:105 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L105) ___ @@ -197,7 +197,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:92 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L92) ___ @@ -207,7 +207,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:108 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L108) ___ @@ -217,7 +217,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:67 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L67) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:87 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L87) ___ @@ -237,7 +237,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:90 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L90) ___ @@ -247,7 +247,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:89 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L89) ___ @@ -257,7 +257,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:70 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L70) ___ @@ -267,7 +267,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:71 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L71) ___ @@ -277,7 +277,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:93 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L93) ___ @@ -287,7 +287,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:69 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L69) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:88 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L88) ___ @@ -307,7 +307,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:96 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L96) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:97 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L97) ___ @@ -327,7 +327,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:86 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L86) ___ @@ -337,7 +337,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:95 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L95) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:91 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L91) ___ @@ -357,7 +357,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:101 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L101) ___ @@ -367,7 +367,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:100 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:100](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L100) ___ @@ -377,7 +377,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:68 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L68) ## Methods @@ -391,7 +391,7 @@ packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:68 #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:339 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L339) ___ @@ -420,7 +420,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:514 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:514](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L514) ___ @@ -441,7 +441,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:555 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:555](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L555) ___ @@ -468,7 +468,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:134 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L134) ___ @@ -496,7 +496,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:534 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:534](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L534) ___ @@ -510,7 +510,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:545 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:545](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L545) ___ @@ -524,7 +524,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:331 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:331](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L331) ___ @@ -538,7 +538,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:335 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:335](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L335) ___ @@ -555,7 +555,7 @@ sending by 50ms in any case to mke sure to catch all updates. #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:355 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:355](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L355) ___ @@ -574,7 +574,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:166 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L166) ___ @@ -593,7 +593,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:249 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:249](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L249) ___ @@ -613,7 +613,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:427 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:427](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L427) ___ @@ -629,7 +629,7 @@ Determine all attributes that have changed since the last update and send them t #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:383 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:383](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L383) ___ @@ -650,7 +650,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:571 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:571](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L571) ___ @@ -670,7 +670,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:236 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L236) ___ @@ -690,7 +690,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:295 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:295](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L295) ___ @@ -709,4 +709,4 @@ controller. The data of newly added events are not sent automatically. #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:314 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:314](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L314) diff --git a/docs/matter.js/classes/protocol_securechannel_export.ChannelStatusResponseError.md b/docs/matter.js/classes/protocol_securechannel_export.ChannelStatusResponseError.md index 1faad4547a..ac0e8625b3 100644 --- a/docs/matter.js/classes/protocol_securechannel_export.ChannelStatusResponseError.md +++ b/docs/matter.js/classes/protocol_securechannel_export.ChannelStatusResponseError.md @@ -43,7 +43,7 @@ Error base Class for all errors related to the status response messages. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:21 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L21) ## Properties @@ -53,7 +53,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:21 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:23 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L23) ___ @@ -63,4 +63,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:24 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L24) diff --git a/docs/matter.js/classes/protocol_securechannel_export.SecureChannelMessenger.md b/docs/matter.js/classes/protocol_securechannel_export.SecureChannelMessenger.md index a208313d65..3998ea8d9c 100644 --- a/docs/matter.js/classes/protocol_securechannel_export.SecureChannelMessenger.md +++ b/docs/matter.js/classes/protocol_securechannel_export.SecureChannelMessenger.md @@ -66,7 +66,7 @@ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Properties @@ -76,7 +76,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Methods @@ -90,7 +90,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L75) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L71) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L33) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L44) ___ @@ -179,7 +179,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L53) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L67) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L59) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:79 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L79) ___ @@ -249,7 +249,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L63) ___ @@ -269,7 +269,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L95) ___ @@ -283,4 +283,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L48) diff --git a/docs/matter.js/classes/protocol_securechannel_export.SecureChannelProtocol.md b/docs/matter.js/classes/protocol_securechannel_export.SecureChannelProtocol.md index 171f87dcc7..61fd9650c7 100644 --- a/docs/matter.js/classes/protocol_securechannel_export.SecureChannelProtocol.md +++ b/docs/matter.js/classes/protocol_securechannel_export.SecureChannelProtocol.md @@ -4,9 +4,11 @@ [protocol/securechannel/export](../modules/protocol_securechannel_export.md).SecureChannelProtocol -## Implements +## Hierarchy -- [`ProtocolHandler`](../interfaces/protocol_export.ProtocolHandler.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> +- [`StatusReportOnlySecureChannelProtocol`](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md) + + ↳ **`SecureChannelProtocol`** ## Table of contents @@ -22,6 +24,7 @@ ### Methods +- [close](protocol_securechannel_export.SecureChannelProtocol.md#close) - [getId](protocol_securechannel_export.SecureChannelProtocol.md#getid) - [handleInitialStatusReport](protocol_securechannel_export.SecureChannelProtocol.md#handleinitialstatusreport) - [onNewExchange](protocol_securechannel_export.SecureChannelProtocol.md#onnewexchange) @@ -41,9 +44,13 @@ | :------ | :------ | | `commissioningCancelledCallback` | () => `Promise`<`void`\> | +#### Overrides + +[StatusReportOnlySecureChannelProtocol](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md).[constructor](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#constructor) + #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L90) ## Properties @@ -53,7 +60,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:29 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L88) ___ @@ -71,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L90) ___ @@ -81,10 +88,28 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:28 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L87) ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[StatusReportOnlySecureChannelProtocol](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md).[close](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#close) + +#### Defined in + +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L81) + +___ + ### getId ▸ **getId**(): `number` @@ -93,13 +118,13 @@ packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:28 `number` -#### Implementation of +#### Inherited from -[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[getId](../interfaces/protocol_export.ProtocolHandler.md#getid) +[StatusReportOnlySecureChannelProtocol](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md).[getId](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#getid) #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:33 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L27) ___ @@ -111,16 +136,20 @@ ___ | Name | Type | | :------ | :------ | -| `exchange` | [`MessageExchange`](protocol_export.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> | +| `exchange` | [`MessageExchange`](protocol_export.MessageExchange.md)<`any`\> | | `message` | [`Message`](../interfaces/codec_export.Message.md) | #### Returns `Promise`<`void`\> +#### Inherited from + +[StatusReportOnlySecureChannelProtocol](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md).[handleInitialStatusReport](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#handleinitialstatusreport) + #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:82 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L45) ___ @@ -132,20 +161,20 @@ ___ | Name | Type | | :------ | :------ | -| `exchange` | [`MessageExchange`](protocol_export.MessageExchange.md)<[`MatterDevice`](export._internal_.MatterDevice.md)\> | +| `exchange` | [`MessageExchange`](protocol_export.MessageExchange.md)<`any`\> | | `message` | [`Message`](../interfaces/codec_export.Message.md) | #### Returns `Promise`<`void`\> -#### Implementation of +#### Overrides -[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[onNewExchange](../interfaces/protocol_export.ProtocolHandler.md#onnewexchange) +[StatusReportOnlySecureChannelProtocol](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md).[onNewExchange](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#onnewexchange) #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:45 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L102) ___ @@ -159,7 +188,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:41 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L98) ___ @@ -179,7 +208,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:37 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L94) ___ @@ -200,4 +229,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:118 +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L134) diff --git a/docs/matter.js/classes/protocol_securechannel_export.SecureChannelStatusMessageSchema.md b/docs/matter.js/classes/protocol_securechannel_export.SecureChannelStatusMessageSchema.md index e516d00838..3be0d91aa3 100644 --- a/docs/matter.js/classes/protocol_securechannel_export.SecureChannelStatusMessageSchema.md +++ b/docs/matter.js/classes/protocol_securechannel_export.SecureChannelStatusMessageSchema.md @@ -61,7 +61,7 @@ Decodes the encoded data using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts:28 +[packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts#L28) ___ @@ -117,7 +117,7 @@ Encodes the value using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts:20 +[packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts#L20) ___ @@ -167,4 +167,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md b/docs/matter.js/classes/protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md new file mode 100644 index 0000000000..f61921dd33 --- /dev/null +++ b/docs/matter.js/classes/protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md @@ -0,0 +1,116 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [protocol/securechannel/export](../modules/protocol_securechannel_export.md) / StatusReportOnlySecureChannelProtocol + +# Class: StatusReportOnlySecureChannelProtocol + +[protocol/securechannel/export](../modules/protocol_securechannel_export.md).StatusReportOnlySecureChannelProtocol + +## Hierarchy + +- **`StatusReportOnlySecureChannelProtocol`** + + ↳ [`SecureChannelProtocol`](protocol_securechannel_export.SecureChannelProtocol.md) + +## Implements + +- [`ProtocolHandler`](../interfaces/protocol_export.ProtocolHandler.md)<`any`\> + +## Table of contents + +### Constructors + +- [constructor](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#constructor) + +### Methods + +- [close](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#close) +- [getId](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#getid) +- [handleInitialStatusReport](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#handleinitialstatusreport) +- [onNewExchange](protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md#onnewexchange) + +## Constructors + +### constructor + +• **new StatusReportOnlySecureChannelProtocol**() + +## Methods + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[close](../interfaces/protocol_export.ProtocolHandler.md#close) + +#### Defined in + +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L81) + +___ + +### getId + +▸ **getId**(): `number` + +#### Returns + +`number` + +#### Implementation of + +[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[getId](../interfaces/protocol_export.ProtocolHandler.md#getid) + +#### Defined in + +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L27) + +___ + +### handleInitialStatusReport + +▸ **handleInitialStatusReport**(`exchange`, `message`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `exchange` | [`MessageExchange`](protocol_export.MessageExchange.md)<`any`\> | +| `message` | [`Message`](../interfaces/codec_export.Message.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L45) + +___ + +### onNewExchange + +▸ **onNewExchange**(`exchange`, `message`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `exchange` | [`MessageExchange`](protocol_export.MessageExchange.md)<`any`\> | +| `message` | [`Message`](../interfaces/codec_export.Message.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[onNewExchange](../interfaces/protocol_export.ProtocolHandler.md#onnewexchange) + +#### Defined in + +[packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelProtocol.ts#L31) diff --git a/docs/matter.js/classes/schema_export.BitmapSchemaInternal.md b/docs/matter.js/classes/schema_export.BitmapSchemaInternal.md index a056498f4e..97ce1c87fc 100644 --- a/docs/matter.js/classes/schema_export.BitmapSchemaInternal.md +++ b/docs/matter.js/classes/schema_export.BitmapSchemaInternal.md @@ -61,7 +61,7 @@ Define a schema to encode / decode convert type T to type E. #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:61 +[packages/matter.js/src/schema/BitmapSchema.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L61) ## Properties @@ -71,7 +71,7 @@ packages/matter.js/src/schema/BitmapSchema.ts:61 #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:61 +[packages/matter.js/src/schema/BitmapSchema.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L61) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:59 +[packages/matter.js/src/schema/BitmapSchema.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L59) ## Methods @@ -108,7 +108,7 @@ Decodes the encoded data using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:97 +[packages/matter.js/src/schema/BitmapSchema.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L97) ___ @@ -159,7 +159,7 @@ provided, rest is unset. #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:77 +[packages/matter.js/src/schema/BitmapSchema.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L77) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:81 +[packages/matter.js/src/schema/BitmapSchema.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L81) ___ @@ -209,4 +209,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/schema_export.ByteArrayBitmapSchemaInternal.md b/docs/matter.js/classes/schema_export.ByteArrayBitmapSchemaInternal.md index 788ab0522d..cbbf847617 100644 --- a/docs/matter.js/classes/schema_export.ByteArrayBitmapSchemaInternal.md +++ b/docs/matter.js/classes/schema_export.ByteArrayBitmapSchemaInternal.md @@ -62,7 +62,7 @@ Define a schema to encode / decode convert type T to type E. #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:116 +[packages/matter.js/src/schema/BitmapSchema.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L116) ## Properties @@ -72,7 +72,7 @@ packages/matter.js/src/schema/BitmapSchema.ts:116 #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:116 +[packages/matter.js/src/schema/BitmapSchema.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L116) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:113 +[packages/matter.js/src/schema/BitmapSchema.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L113) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:114 +[packages/matter.js/src/schema/BitmapSchema.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L114) ## Methods @@ -119,7 +119,7 @@ Decodes the encoded data using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:164 +[packages/matter.js/src/schema/BitmapSchema.ts:164](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L164) ___ @@ -169,7 +169,7 @@ Encodes the value using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:139 +[packages/matter.js/src/schema/BitmapSchema.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L139) ___ @@ -219,4 +219,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/schema_export.QrCodeSchema.md b/docs/matter.js/classes/schema_export.QrCodeSchema.md index cda7993bbb..a1ba5942ca 100644 --- a/docs/matter.js/classes/schema_export.QrCodeSchema.md +++ b/docs/matter.js/classes/schema_export.QrCodeSchema.md @@ -24,6 +24,7 @@ Define a schema to encode / decode convert type T to type E. - [decodeInternal](schema_export.QrCodeSchema.md#decodeinternal) - [encode](schema_export.QrCodeSchema.md#encode) - [encodeInternal](schema_export.QrCodeSchema.md#encodeinternal) +- [get](schema_export.QrCodeSchema.md#get) - [getCode](schema_export.QrCodeSchema.md#getcode) - [validate](schema_export.QrCodeSchema.md#validate) @@ -62,7 +63,7 @@ Decodes the encoded data using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -86,7 +87,7 @@ ___ #### Defined in -packages/matter.js/src/schema/QrCodeSchema.ts:208 +[packages/matter.js/src/schema/QrCodeSchema.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/QrCodeSchema.ts#L208) ___ @@ -112,7 +113,7 @@ Encodes the value using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -136,7 +137,27 @@ ___ #### Defined in -packages/matter.js/src/schema/QrCodeSchema.ts:99 +[packages/matter.js/src/schema/QrCodeSchema.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/QrCodeSchema.ts#L99) + +___ + +### get + +▸ **get**(`code`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/schema/QrCodeSchema.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/QrCodeSchema.ts#L212) ___ @@ -156,7 +177,7 @@ ___ #### Defined in -packages/matter.js/src/schema/QrCodeSchema.ts:202 +[packages/matter.js/src/schema/QrCodeSchema.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/QrCodeSchema.ts#L202) ___ @@ -182,4 +203,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/schema_export.Schema.md b/docs/matter.js/classes/schema_export.Schema.md index 0a70f3365a..8165c3446c 100644 --- a/docs/matter.js/classes/schema_export.Schema.md +++ b/docs/matter.js/classes/schema_export.Schema.md @@ -81,7 +81,7 @@ Decodes the encoded data using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/schema/Schema.ts:25 +[packages/matter.js/src/schema/Schema.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L25) ___ @@ -123,7 +123,7 @@ Encodes the value using the schema. #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/schema/Schema.ts:24 +[packages/matter.js/src/schema/Schema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L24) ___ @@ -165,4 +165,4 @@ Optional validator that can be used to enforce constraints on the data before en #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/session_export.CaseClient.md b/docs/matter.js/classes/session_export.CaseClient.md index 3654e3919c..ff811f9a24 100644 --- a/docs/matter.js/classes/session_export.CaseClient.md +++ b/docs/matter.js/classes/session_export.CaseClient.md @@ -41,4 +41,4 @@ #### Defined in -packages/matter.js/src/session/case/CaseClient.ts:35 +[packages/matter.js/src/session/case/CaseClient.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseClient.ts#L35) diff --git a/docs/matter.js/classes/session_export.CaseClientMessenger.md b/docs/matter.js/classes/session_export.CaseClientMessenger.md index 207e3395e8..0d72c3a58b 100644 --- a/docs/matter.js/classes/session_export.CaseClientMessenger.md +++ b/docs/matter.js/classes/session_export.CaseClientMessenger.md @@ -54,7 +54,7 @@ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Properties @@ -68,7 +68,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Methods @@ -86,7 +86,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L75) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L71) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L33) ___ @@ -159,7 +159,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L44) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessenger.ts:40 +[packages/matter.js/src/session/case/CaseMessenger.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessenger.ts#L40) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L53) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L67) ___ @@ -247,7 +247,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L59) ___ @@ -267,7 +267,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessenger.ts:36 +[packages/matter.js/src/session/case/CaseMessenger.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessenger.ts#L36) ___ @@ -287,7 +287,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessenger.ts:57 +[packages/matter.js/src/session/case/CaseMessenger.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessenger.ts#L57) ___ @@ -305,7 +305,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L63) ___ @@ -329,7 +329,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L95) ___ @@ -347,4 +347,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L48) diff --git a/docs/matter.js/classes/session_export.CaseServer.md b/docs/matter.js/classes/session_export.CaseServer.md index 71c208bec8..77552ec695 100644 --- a/docs/matter.js/classes/session_export.CaseServer.md +++ b/docs/matter.js/classes/session_export.CaseServer.md @@ -16,6 +16,7 @@ ### Methods +- [close](session_export.CaseServer.md#close) - [getId](session_export.CaseServer.md#getid) - [handleSigma1](session_export.CaseServer.md#handlesigma1) - [onNewExchange](session_export.CaseServer.md#onnewexchange) @@ -28,6 +29,24 @@ ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[close](../interfaces/protocol_export.ProtocolHandler.md#close) + +#### Defined in + +[packages/matter.js/src/session/case/CaseServer.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseServer.ts#L212) + +___ + ### getId ▸ **getId**(): `number` @@ -42,7 +61,7 @@ #### Defined in -packages/matter.js/src/session/case/CaseServer.ts:45 +[packages/matter.js/src/session/case/CaseServer.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseServer.ts#L45) ___ @@ -63,7 +82,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseServer.ts:49 +[packages/matter.js/src/session/case/CaseServer.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseServer.ts#L49) ___ @@ -87,4 +106,4 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseServer.ts:35 +[packages/matter.js/src/session/case/CaseServer.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseServer.ts#L35) diff --git a/docs/matter.js/classes/session_export.CaseServerMessenger.md b/docs/matter.js/classes/session_export.CaseServerMessenger.md index b1004e7866..5da736e1b9 100644 --- a/docs/matter.js/classes/session_export.CaseServerMessenger.md +++ b/docs/matter.js/classes/session_export.CaseServerMessenger.md @@ -55,7 +55,7 @@ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Properties @@ -69,7 +69,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Methods @@ -87,7 +87,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L75) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L71) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L33) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L44) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessenger.ts:16 +[packages/matter.js/src/session/case/CaseMessenger.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessenger.ts#L16) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessenger.ts:29 +[packages/matter.js/src/session/case/CaseMessenger.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessenger.ts#L29) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L53) ___ @@ -238,7 +238,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L67) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L59) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessenger.ts:21 +[packages/matter.js/src/session/case/CaseMessenger.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessenger.ts#L21) ___ @@ -302,7 +302,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessenger.ts:25 +[packages/matter.js/src/session/case/CaseMessenger.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessenger.ts#L25) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L63) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L95) ___ @@ -362,4 +362,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L48) diff --git a/docs/matter.js/classes/session_export.PaseClient.md b/docs/matter.js/classes/session_export.PaseClient.md index 7bafd61db5..4b3564663a 100644 --- a/docs/matter.js/classes/session_export.PaseClient.md +++ b/docs/matter.js/classes/session_export.PaseClient.md @@ -13,6 +13,9 @@ ### Methods - [pair](session_export.PaseClient.md#pair) +- [generatePakePasscodeVerifier](session_export.PaseClient.md#generatepakepasscodeverifier) +- [generateRandomDiscriminator](session_export.PaseClient.md#generaterandomdiscriminator) +- [generateRandomPasscode](session_export.PaseClient.md#generaterandompasscode) ## Constructors @@ -40,4 +43,53 @@ #### Defined in -packages/matter.js/src/session/pase/PaseClient.ts:20 +[packages/matter.js/src/session/pase/PaseClient.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseClient.ts#L39) + +___ + +### generatePakePasscodeVerifier + +▸ `Static` **generatePakePasscodeVerifier**(`setupPinCode`, `pbkdfParameters`): `Promise`<`Uint8Array`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `setupPinCode` | `number` | +| `pbkdfParameters` | [`PbkdfParameters`](../interfaces/crypto_export.PbkdfParameters.md) | + +#### Returns + +`Promise`<`Uint8Array`\> + +#### Defined in + +[packages/matter.js/src/session/pase/PaseClient.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseClient.ts#L21) + +___ + +### generateRandomDiscriminator + +▸ `Static` **generateRandomDiscriminator**(): `number` + +#### Returns + +`number` + +#### Defined in + +[packages/matter.js/src/session/pase/PaseClient.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseClient.ts#L35) + +___ + +### generateRandomPasscode + +▸ `Static` **generateRandomPasscode**(): `number` + +#### Returns + +`number` + +#### Defined in + +[packages/matter.js/src/session/pase/PaseClient.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseClient.ts#L26) diff --git a/docs/matter.js/classes/session_export.PaseClientMessenger.md b/docs/matter.js/classes/session_export.PaseClientMessenger.md index 9ce18b34fa..0f0f0abdb8 100644 --- a/docs/matter.js/classes/session_export.PaseClientMessenger.md +++ b/docs/matter.js/classes/session_export.PaseClientMessenger.md @@ -56,7 +56,7 @@ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Properties @@ -70,7 +70,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Methods @@ -88,7 +88,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L75) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L71) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L33) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L44) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:67 +[packages/matter.js/src/session/pase/PaseMessenger.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L67) ___ @@ -189,7 +189,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:58 +[packages/matter.js/src/session/pase/PaseMessenger.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L58) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L53) ___ @@ -239,7 +239,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L67) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L59) ___ @@ -283,7 +283,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:63 +[packages/matter.js/src/session/pase/PaseMessenger.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L63) ___ @@ -303,7 +303,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:71 +[packages/matter.js/src/session/pase/PaseMessenger.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L71) ___ @@ -323,7 +323,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:54 +[packages/matter.js/src/session/pase/PaseMessenger.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L54) ___ @@ -341,7 +341,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L63) ___ @@ -365,7 +365,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L95) ___ @@ -383,4 +383,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L48) diff --git a/docs/matter.js/classes/session_export.PaseServer.md b/docs/matter.js/classes/session_export.PaseServer.md index 2cc8e3d8c9..55c65664fb 100644 --- a/docs/matter.js/classes/session_export.PaseServer.md +++ b/docs/matter.js/classes/session_export.PaseServer.md @@ -25,6 +25,7 @@ ### Methods - [cancelPairing](session_export.PaseServer.md#cancelpairing) +- [close](session_export.PaseServer.md#close) - [getId](session_export.PaseServer.md#getid) - [handlePairingRequest](session_export.PaseServer.md#handlepairingrequest) - [onNewExchange](session_export.PaseServer.md#onnewexchange) @@ -47,7 +48,7 @@ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:44 +[packages/matter.js/src/session/pase/PaseServer.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L44) ## Properties @@ -57,7 +58,7 @@ packages/matter.js/src/session/pase/PaseServer.ts:44 #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:46 +[packages/matter.js/src/session/pase/PaseServer.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L46) ___ @@ -67,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:31 +[packages/matter.js/src/session/pase/PaseServer.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L31) ___ @@ -77,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:30 +[packages/matter.js/src/session/pase/PaseServer.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L30) ___ @@ -87,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:47 +[packages/matter.js/src/session/pase/PaseServer.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L47) ___ @@ -97,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:45 +[packages/matter.js/src/session/pase/PaseServer.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L45) ## Methods @@ -118,7 +119,25 @@ packages/matter.js/src/session/pase/PaseServer.ts:45 #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:149 +[packages/matter.js/src/session/pase/PaseServer.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L149) + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ProtocolHandler](../interfaces/protocol_export.ProtocolHandler.md).[close](../interfaces/protocol_export.ProtocolHandler.md#close) + +#### Defined in + +[packages/matter.js/src/session/pase/PaseServer.ts:159](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L159) ___ @@ -136,7 +155,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:50 +[packages/matter.js/src/session/pase/PaseServer.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L50) ___ @@ -157,7 +176,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:74 +[packages/matter.js/src/session/pase/PaseServer.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L74) ___ @@ -181,7 +200,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:54 +[packages/matter.js/src/session/pase/PaseServer.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L54) ___ @@ -202,7 +221,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:33 +[packages/matter.js/src/session/pase/PaseServer.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L33) ___ @@ -223,4 +242,4 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseServer.ts:38 +[packages/matter.js/src/session/pase/PaseServer.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseServer.ts#L38) diff --git a/docs/matter.js/classes/session_export.PaseServerMessenger.md b/docs/matter.js/classes/session_export.PaseServerMessenger.md index 1c6274cbc8..8e426b0b36 100644 --- a/docs/matter.js/classes/session_export.PaseServerMessenger.md +++ b/docs/matter.js/classes/session_export.PaseServerMessenger.md @@ -56,7 +56,7 @@ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Properties @@ -70,7 +70,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L31) ## Methods @@ -88,7 +88,7 @@ packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:31 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L75) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L71) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L33) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L44) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:40 +[packages/matter.js/src/session/pase/PaseMessenger.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L40) ___ @@ -189,7 +189,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:48 +[packages/matter.js/src/session/pase/PaseMessenger.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L48) ___ @@ -203,7 +203,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:31 +[packages/matter.js/src/session/pase/PaseMessenger.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L31) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L53) ___ @@ -253,7 +253,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L67) ___ @@ -277,7 +277,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L59) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:44 +[packages/matter.js/src/session/pase/PaseMessenger.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L44) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:36 +[packages/matter.js/src/session/pase/PaseMessenger.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L36) ___ @@ -335,7 +335,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L63) ___ @@ -359,7 +359,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L95) ___ @@ -377,4 +377,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessenger.ts#L48) diff --git a/docs/matter.js/classes/session_export.SecureSession.md b/docs/matter.js/classes/session_export.SecureSession.md index 630f184d84..9e24d09f46 100644 --- a/docs/matter.js/classes/session_export.SecureSession.md +++ b/docs/matter.js/classes/session_export.SecureSession.md @@ -22,6 +22,8 @@ ### Properties +- [\_closingAfterExchangeFinished](session_export.SecureSession.md#_closingafterexchangefinished) +- [\_sendCloseMessageWhenClosing](session_export.SecureSession.md#_sendclosemessagewhenclosing) - [activeRetransmissionTimeoutMs](session_export.SecureSession.md#activeretransmissiontimeoutms) - [activeTimestamp](session_export.SecureSession.md#activetimestamp) - [attestationKey](session_export.SecureSession.md#attestationkey) @@ -35,13 +37,16 @@ - [peerNodeId](session_export.SecureSession.md#peernodeid) - [peerSessionId](session_export.SecureSession.md#peersessionid) - [retransmissionRetries](session_export.SecureSession.md#retransmissionretries) +- [subscriptionChangedCallback](session_export.SecureSession.md#subscriptionchangedcallback) - [subscriptions](session_export.SecureSession.md#subscriptions) - [timestamp](session_export.SecureSession.md#timestamp) ### Accessors +- [closingAfterExchangeFinished](session_export.SecureSession.md#closingafterexchangefinished) - [name](session_export.SecureSession.md#name) - [numberOfActiveSubscriptions](session_export.SecureSession.md#numberofactivesubscriptions) +- [sendCloseMessageWhenClosing](session_export.SecureSession.md#sendclosemessagewhenclosing) ### Methods @@ -74,7 +79,7 @@ ### constructor -• **new SecureSession**<`T`\>(`context`, `id`, `fabric`, `peerNodeId`, `peerSessionId`, `_sharedSecret`, `decryptKey`, `encryptKey`, `attestationKey`, `closeCallback`, `idleRetransmissionTimeoutMs?`, `activeRetransmissionTimeoutMs?`, `retransmissionRetries?`) +• **new SecureSession**<`T`\>(`args`) #### Type parameters @@ -84,35 +89,56 @@ #### Parameters -| Name | Type | Default value | -| :------ | :------ | :------ | -| `context` | `T` | `undefined` | -| `id` | `number` | `undefined` | -| `fabric` | `undefined` \| [`Fabric`](fabric_export.Fabric.md) | `undefined` | -| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | `undefined` | -| `peerSessionId` | `number` | `undefined` | -| `_sharedSecret` | `Uint8Array` | `undefined` | -| `decryptKey` | `Uint8Array` | `undefined` | -| `encryptKey` | `Uint8Array` | `undefined` | -| `attestationKey` | `Uint8Array` | `undefined` | -| `closeCallback` | (`sendClose`: `boolean`) => `Promise`<`void`\> | `undefined` | -| `idleRetransmissionTimeoutMs` | `number` | `DEFAULT_IDLE_RETRANSMISSION_TIMEOUT_MS` | -| `activeRetransmissionTimeoutMs` | `number` | `DEFAULT_ACTIVE_RETRANSMISSION_TIMEOUT_MS` | -| `retransmissionRetries` | `number` | `DEFAULT_RETRANSMISSION_RETRIES` | +| Name | Type | +| :------ | :------ | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.attestationKey` | `Uint8Array` | +| `args.closeCallback` | () => `Promise`<`void`\> | +| `args.context` | `T` | +| `args.decryptKey` | `Uint8Array` | +| `args.encryptKey` | `Uint8Array` | +| `args.fabric` | `undefined` \| [`Fabric`](fabric_export.Fabric.md) | +| `args.id` | `number` | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.retransmissionRetries?` | `number` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Defined in -packages/matter.js/src/session/SecureSession.ts:77 +[packages/matter.js/src/session/SecureSession.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L108) ## Properties +### \_closingAfterExchangeFinished + +• `Private` **\_closingAfterExchangeFinished**: `boolean` = `false` + +#### Defined in + +[packages/matter.js/src/session/SecureSession.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L37) + +___ + +### \_sendCloseMessageWhenClosing + +• `Private` **\_sendCloseMessageWhenClosing**: `boolean` = `true` + +#### Defined in + +[packages/matter.js/src/session/SecureSession.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L38) + +___ + ### activeRetransmissionTimeoutMs -• `Private` `Readonly` **activeRetransmissionTimeoutMs**: `number` = `DEFAULT_ACTIVE_RETRANSMISSION_TIMEOUT_MS` +• `Private` `Readonly` **activeRetransmissionTimeoutMs**: `number` #### Defined in -packages/matter.js/src/session/SecureSession.ts:89 +[packages/matter.js/src/session/SecureSession.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L50) ___ @@ -122,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:36 +[packages/matter.js/src/session/SecureSession.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L36) ___ @@ -132,23 +158,17 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:86 +[packages/matter.js/src/session/SecureSession.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L46) ___ ### closeCallback -• `Private` `Readonly` **closeCallback**: (`sendClose`: `boolean`) => `Promise`<`void`\> +• `Private` `Readonly` **closeCallback**: () => `Promise`<`void`\> #### Type declaration -▸ (`sendClose`): `Promise`<`void`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `sendClose` | `boolean` | +▸ (): `Promise`<`void`\> ##### Returns @@ -156,7 +176,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:87 +[packages/matter.js/src/session/SecureSession.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L47) ___ @@ -166,7 +186,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:78 +[packages/matter.js/src/session/SecureSession.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L39) ___ @@ -176,7 +196,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:84 +[packages/matter.js/src/session/SecureSession.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L44) ___ @@ -186,7 +206,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:85 +[packages/matter.js/src/session/SecureSession.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L45) ___ @@ -196,7 +216,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:80 +[packages/matter.js/src/session/SecureSession.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L41) ___ @@ -206,17 +226,17 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:79 +[packages/matter.js/src/session/SecureSession.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L40) ___ ### idleRetransmissionTimeoutMs -• `Private` `Readonly` **idleRetransmissionTimeoutMs**: `number` = `DEFAULT_IDLE_RETRANSMISSION_TIMEOUT_MS` +• `Private` `Readonly` **idleRetransmissionTimeoutMs**: `number` #### Defined in -packages/matter.js/src/session/SecureSession.ts:88 +[packages/matter.js/src/session/SecureSession.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L49) ___ @@ -226,7 +246,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:81 +[packages/matter.js/src/session/SecureSession.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L42) ___ @@ -236,17 +256,35 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:82 +[packages/matter.js/src/session/SecureSession.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L43) ___ ### retransmissionRetries -• `Private` `Readonly` **retransmissionRetries**: `number` = `DEFAULT_RETRANSMISSION_RETRIES` +• `Private` `Readonly` **retransmissionRetries**: `number` + +#### Defined in + +[packages/matter.js/src/session/SecureSession.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L51) + +___ + +### subscriptionChangedCallback + +• `Private` `Readonly` **subscriptionChangedCallback**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` #### Defined in -packages/matter.js/src/session/SecureSession.ts:90 +[packages/matter.js/src/session/SecureSession.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L48) ___ @@ -256,7 +294,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:34 +[packages/matter.js/src/session/SecureSession.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L34) ___ @@ -266,10 +304,28 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:35 +[packages/matter.js/src/session/SecureSession.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L35) ## Accessors +### closingAfterExchangeFinished + +• `get` **closingAfterExchangeFinished**(): `boolean` + +#### Returns + +`boolean` + +#### Implementation of + +[Session](../interfaces/session_export.Session.md).[closingAfterExchangeFinished](../interfaces/session_export.Session.md#closingafterexchangefinished) + +#### Defined in + +[packages/matter.js/src/session/SecureSession.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L161) + +___ + ### name • `get` **name**(): `string` @@ -284,7 +340,7 @@ packages/matter.js/src/session/SecureSession.ts:35 #### Defined in -packages/matter.js/src/session/SecureSession.ts:166 +[packages/matter.js/src/session/SecureSession.ts:238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L238) ___ @@ -298,7 +354,21 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:200 +[packages/matter.js/src/session/SecureSession.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L273) + +___ + +### sendCloseMessageWhenClosing + +• `get` **sendCloseMessageWhenClosing**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/session/SecureSession.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L165) ## Methods @@ -318,7 +388,7 @@ packages/matter.js/src/session/SecureSession.ts:200 #### Defined in -packages/matter.js/src/session/SecureSession.ts:152 +[packages/matter.js/src/session/SecureSession.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L224) ___ @@ -338,7 +408,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:195 +[packages/matter.js/src/session/SecureSession.ts:267](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L267) ___ @@ -358,13 +428,19 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:212 +[packages/matter.js/src/session/SecureSession.ts:286](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L286) ___ ### close -▸ **close**(): `Promise`<`void`\> +▸ **close**(`closeAfterExchangeFinished?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -372,7 +448,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:108 +[packages/matter.js/src/session/SecureSession.ts:177](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L177) ___ @@ -396,21 +472,22 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:124 +[packages/matter.js/src/session/SecureSession.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L196) ___ ### destroy -▸ **destroy**(`sendClose`): `Promise`<`void`\> +▸ **destroy**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> Destroys a session. Outstanding subscription data will be discarded. #### Parameters -| Name | Type | -| :------ | :------ | -| `sendClose` | `boolean` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `sendClose` | `boolean` | `undefined` | +| `closeAfterExchangeFinished` | `boolean` | `true` | #### Returns @@ -422,7 +499,7 @@ Destroys a session. Outstanding subscription data will be discarded. #### Defined in -packages/matter.js/src/session/SecureSession.ts:226 +[packages/matter.js/src/session/SecureSession.ts:300](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L300) ___ @@ -446,21 +523,22 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:134 +[packages/matter.js/src/session/SecureSession.ts:206](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L206) ___ ### end -▸ **end**(`sendClose`): `Promise`<`void`\> +▸ **end**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> Ends a session. Outstanding subscription data will be flushed before the session is destroyed. #### Parameters -| Name | Type | -| :------ | :------ | -| `sendClose` | `boolean` | +| Name | Type | Default value | +| :------ | :------ | :------ | +| `sendClose` | `boolean` | `undefined` | +| `closeAfterExchangeFinished` | `boolean` | `false` | #### Returns @@ -472,7 +550,7 @@ Ends a session. Outstanding subscription data will be flushed before the session #### Defined in -packages/matter.js/src/session/SecureSession.ts:220 +[packages/matter.js/src/session/SecureSession.ts:294](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L294) ___ @@ -494,7 +572,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:232 +[packages/matter.js/src/session/SecureSession.ts:315](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L315) ___ @@ -512,7 +590,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:159 +[packages/matter.js/src/session/SecureSession.ts:231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L231) ___ @@ -526,7 +604,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:144 +[packages/matter.js/src/session/SecureSession.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L216) ___ @@ -544,7 +622,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:175 +[packages/matter.js/src/session/SecureSession.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L247) ___ @@ -558,7 +636,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:148 +[packages/matter.js/src/session/SecureSession.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L220) ___ @@ -576,7 +654,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:179 +[packages/matter.js/src/session/SecureSession.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L251) ___ @@ -600,7 +678,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:170 +[packages/matter.js/src/session/SecureSession.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L242) ___ @@ -618,7 +696,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:187 +[packages/matter.js/src/session/SecureSession.ts:259](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L259) ___ @@ -636,7 +714,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:191 +[packages/matter.js/src/session/SecureSession.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L263) ___ @@ -654,7 +732,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:183 +[packages/matter.js/src/session/SecureSession.ts:255](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L255) ___ @@ -672,7 +750,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:104 +[packages/matter.js/src/session/SecureSession.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L173) ___ @@ -690,7 +768,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:120 +[packages/matter.js/src/session/SecureSession.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L192) ___ @@ -708,7 +786,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:100 +[packages/matter.js/src/session/SecureSession.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L169) ___ @@ -732,7 +810,7 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:112 +[packages/matter.js/src/session/SecureSession.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L184) ___ @@ -752,13 +830,13 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:204 +[packages/matter.js/src/session/SecureSession.ts:277](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L277) ___ ### create -▸ `Static` **create**<`T`\>(`context`, `id`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `closeCallback`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`): `Promise`<[`SecureSession`](session_export.SecureSession.md)<`T`\>\> +▸ `Static` **create**<`T`\>(`args`): `Promise`<[`SecureSession`](session_export.SecureSession.md)<`T`\>\> #### Type parameters @@ -770,18 +848,20 @@ ___ | Name | Type | | :------ | :------ | -| `context` | `T` | -| `id` | `number` | -| `fabric` | `undefined` \| [`Fabric`](fabric_export.Fabric.md) | -| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | -| `peerSessionId` | `number` | -| `sharedSecret` | `Uint8Array` | -| `salt` | `Uint8Array` | -| `isInitiator` | `boolean` | -| `isResumption` | `boolean` | -| `closeCallback` | (`sendClose`: `boolean`) => `Promise`<`void`\> | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.closeCallback` | () => `Promise`<`void`\> | +| `args.context` | `T` | +| `args.fabric` | `undefined` \| [`Fabric`](fabric_export.Fabric.md) | +| `args.id` | `number` | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.isInitiator` | `boolean` | +| `args.isResumption` | `boolean` | +| `args.peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.salt` | `Uint8Array` | +| `args.sharedSecret` | `Uint8Array` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Returns @@ -789,4 +869,4 @@ ___ #### Defined in -packages/matter.js/src/session/SecureSession.ts:38 +[packages/matter.js/src/session/SecureSession.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L53) diff --git a/docs/matter.js/classes/session_export.SessionManager.md b/docs/matter.js/classes/session_export.SessionManager.md index 5d909f4ab0..72e1aef38a 100644 --- a/docs/matter.js/classes/session_export.SessionManager.md +++ b/docs/matter.js/classes/session_export.SessionManager.md @@ -23,7 +23,6 @@ - [resumptionRecords](session_export.SessionManager.md#resumptionrecords) - [sessionStorage](session_export.SessionManager.md#sessionstorage) - [sessions](session_export.SessionManager.md#sessions) -- [sessionsToClose](session_export.SessionManager.md#sessionstoclose) - [unsecureSession](session_export.SessionManager.md#unsecuresession) ### Methods @@ -37,9 +36,10 @@ - [getPaseSession](session_export.SessionManager.md#getpasesession) - [getSession](session_export.SessionManager.md#getsession) - [getSessionForNode](session_export.SessionManager.md#getsessionfornode) -- [getSessionsToClose](session_export.SessionManager.md#getsessionstoclose) - [getUnsecureSession](session_export.SessionManager.md#getunsecuresession) - [initFromStorage](session_export.SessionManager.md#initfromstorage) +- [removeAllSessionsForNode](session_export.SessionManager.md#removeallsessionsfornode) +- [removeResumptionRecord](session_export.SessionManager.md#removeresumptionrecord) - [removeSession](session_export.SessionManager.md#removesession) - [saveResumptionRecord](session_export.SessionManager.md#saveresumptionrecord) - [storeResumptionRecords](session_export.SessionManager.md#storeresumptionrecords) @@ -66,7 +66,7 @@ #### Defined in -packages/matter.js/src/session/SessionManager.ts:48 +[packages/matter.js/src/session/SessionManager.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L47) ## Properties @@ -76,7 +76,7 @@ packages/matter.js/src/session/SessionManager.ts:48 #### Defined in -packages/matter.js/src/session/SessionManager.ts:49 +[packages/matter.js/src/session/SessionManager.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L48) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:43 +[packages/matter.js/src/session/SessionManager.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L43) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:44 +[packages/matter.js/src/session/SessionManager.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L44) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:45 +[packages/matter.js/src/session/SessionManager.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L45) ___ @@ -116,17 +116,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:42 - -___ - -### sessionsToClose - -• `Private` `Readonly` **sessionsToClose**: [`SecureSession`](session_export.SecureSession.md)<`any`\>[] - -#### Defined in - -packages/matter.js/src/session/SessionManager.ts:46 +[packages/matter.js/src/session/SessionManager.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L42) ___ @@ -136,7 +126,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:41 +[packages/matter.js/src/session/SessionManager.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L41) ## Methods @@ -150,29 +140,31 @@ packages/matter.js/src/session/SessionManager.ts:41 #### Defined in -packages/matter.js/src/session/SessionManager.ts:217 +[packages/matter.js/src/session/SessionManager.ts:232](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L232) ___ ### createSecureSession -▸ **createSecureSession**(`sessionId`, `fabric`, `peerNodeId`, `peerSessionId`, `sharedSecret`, `salt`, `isInitiator`, `isResumption`, `idleRetransTimeoutMs?`, `activeRetransTimeoutMs?`, `closeCallback?`): `Promise`<[`SecureSession`](session_export.SecureSession.md)<`ContextT`\>\> +▸ **createSecureSession**(`args`): `Promise`<[`SecureSession`](session_export.SecureSession.md)<`ContextT`\>\> #### Parameters | Name | Type | | :------ | :------ | -| `sessionId` | `number` | -| `fabric` | `undefined` \| [`Fabric`](fabric_export.Fabric.md) | -| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | -| `peerSessionId` | `number` | -| `sharedSecret` | `Uint8Array` | -| `salt` | `Uint8Array` | -| `isInitiator` | `boolean` | -| `isResumption` | `boolean` | -| `idleRetransTimeoutMs?` | `number` | -| `activeRetransTimeoutMs?` | `number` | -| `closeCallback?` | (`sendClose`: `boolean`) => `Promise`<`void`\> | +| `args` | `Object` | +| `args.activeRetransmissionTimeoutMs?` | `number` | +| `args.closeCallback?` | () => `Promise`<`void`\> | +| `args.fabric` | `undefined` \| [`Fabric`](fabric_export.Fabric.md) | +| `args.idleRetransmissionTimeoutMs?` | `number` | +| `args.isInitiator` | `boolean` | +| `args.isResumption` | `boolean` | +| `args.peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | +| `args.peerSessionId` | `number` | +| `args.salt` | `Uint8Array` | +| `args.sessionId` | `number` | +| `args.sharedSecret` | `Uint8Array` | +| `args.subscriptionChangedCallback?` | () => `void` | #### Returns @@ -180,7 +172,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:57 +[packages/matter.js/src/session/SessionManager.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L56) ___ @@ -200,7 +192,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:147 +[packages/matter.js/src/session/SessionManager.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L162) ___ @@ -220,21 +212,21 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:151 +[packages/matter.js/src/session/SessionManager.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L166) ___ ### getActiveSessionInformation -▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +▸ **getActiveSessionInformation**(): { `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] #### Returns -{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] +{ `fabric`: `undefined` \| { `fabricId`: [`FabricId`](../modules/datatype_export.md#fabricid) ; `fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex) ; `label`: `string` ; `nodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootNodeId`: [`NodeId`](../modules/datatype_export.md#nodeid) ; `rootVendorId`: [`VendorId`](../modules/datatype_export.md#vendorid) } ; `isPeerActive`: `boolean` ; `lastActiveTimestamp`: `undefined` \| `number` ; `lastInteractionTimestamp`: `undefined` \| `number` ; `name`: `string` = session.name; `nodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `numberOfActiveSubscriptions`: `number` ; `peerNodeId`: `undefined` \| [`NodeId`](../modules/datatype_export.md#nodeid) ; `secure`: `boolean` }[] #### Defined in -packages/matter.js/src/session/SessionManager.ts:201 +[packages/matter.js/src/session/SessionManager.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L216) ___ @@ -248,7 +240,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:113 +[packages/matter.js/src/session/SessionManager.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L118) ___ @@ -262,7 +254,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:128 +[packages/matter.js/src/session/SessionManager.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L133) ___ @@ -282,7 +274,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:124 +[packages/matter.js/src/session/SessionManager.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L129) ___ @@ -303,47 +295,74 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:134 +[packages/matter.js/src/session/SessionManager.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L139) ___ -### getSessionsToClose +### getUnsecureSession -▸ **getSessionsToClose**(): [`SecureSession`](session_export.SecureSession.md)<`any`\>[] +▸ **getUnsecureSession**(): [`UnsecureSession`](session_export.UnsecureSession.md)<`ContextT`\> #### Returns -[`SecureSession`](session_export.SecureSession.md)<`any`\>[] +[`UnsecureSession`](session_export.UnsecureSession.md)<`ContextT`\> #### Defined in -packages/matter.js/src/session/SessionManager.ts:99 +[packages/matter.js/src/session/SessionManager.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L158) ___ -### getUnsecureSession +### initFromStorage -▸ **getUnsecureSession**(): [`UnsecureSession`](session_export.UnsecureSession.md)<`ContextT`\> +▸ **initFromStorage**(`fabrics`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fabrics` | [`Fabric`](fabric_export.Fabric.md)[] | #### Returns -[`UnsecureSession`](session_export.UnsecureSession.md)<`ContextT`\> +`void` #### Defined in -packages/matter.js/src/session/SessionManager.ts:143 +[packages/matter.js/src/session/SessionManager.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L197) ___ -### initFromStorage +### removeAllSessionsForNode -▸ **initFromStorage**(`fabrics`): `void` +▸ **removeAllSessionsForNode**(`nodeId`, `sendClose?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | `undefined` | +| `sendClose` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/session/SessionManager.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L148) + +___ + +### removeResumptionRecord + +▸ **removeResumptionRecord**(`peerNodeId`): `void` #### Parameters | Name | Type | | :------ | :------ | -| `fabrics` | [`Fabric`](fabric_export.Fabric.md)[] | +| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns @@ -351,28 +370,27 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:182 +[packages/matter.js/src/session/SessionManager.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L113) ___ ### removeSession -▸ **removeSession**(`sessionId`, `peerNodeId`): `Promise`<`void`\> +▸ **removeSession**(`sessionId`): `void` #### Parameters | Name | Type | | :------ | :------ | | `sessionId` | `number` | -| `peerNodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | #### Returns -`Promise`<`void`\> +`void` #### Defined in -packages/matter.js/src/session/SessionManager.ts:106 +[packages/matter.js/src/session/SessionManager.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L109) ___ @@ -392,7 +410,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:155 +[packages/matter.js/src/session/SessionManager.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L170) ___ @@ -406,7 +424,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:169 +[packages/matter.js/src/session/SessionManager.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L184) ___ @@ -426,4 +444,4 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:160 +[packages/matter.js/src/session/SessionManager.ts:175](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L175) diff --git a/docs/matter.js/classes/session_export.UnsecureSession.md b/docs/matter.js/classes/session_export.UnsecureSession.md index da8e9e91ca..d075b7bca0 100644 --- a/docs/matter.js/classes/session_export.UnsecureSession.md +++ b/docs/matter.js/classes/session_export.UnsecureSession.md @@ -22,6 +22,7 @@ ### Properties +- [closingAfterExchangeFinished](session_export.UnsecureSession.md#closingafterexchangefinished) - [context](session_export.UnsecureSession.md#context) - [initiatorNodeId](session_export.UnsecureSession.md#initiatornodeid) @@ -69,17 +70,31 @@ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:24 +[packages/matter.js/src/session/UnsecureSession.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L25) ## Properties +### closingAfterExchangeFinished + +• `Readonly` **closingAfterExchangeFinished**: ``false`` + +#### Implementation of + +[Session](../interfaces/session_export.Session.md).[closingAfterExchangeFinished](../interfaces/session_export.Session.md#closingafterexchangefinished) + +#### Defined in + +[packages/matter.js/src/session/UnsecureSession.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L23) + +___ + ### context • `Private` `Readonly` **context**: `T` #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:24 +[packages/matter.js/src/session/UnsecureSession.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L25) ___ @@ -89,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:22 +[packages/matter.js/src/session/UnsecureSession.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L22) ## Accessors @@ -107,7 +122,7 @@ packages/matter.js/src/session/UnsecureSession.ts:22 #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:58 +[packages/matter.js/src/session/UnsecureSession.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L59) ## Methods @@ -131,19 +146,13 @@ packages/matter.js/src/session/UnsecureSession.ts:58 #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:42 +[packages/matter.js/src/session/UnsecureSession.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L43) ___ ### destroy -▸ **destroy**(`_sendClose`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_sendClose` | `boolean` | +▸ **destroy**(): `Promise`<`void`\> #### Returns @@ -155,7 +164,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:90 +[packages/matter.js/src/session/UnsecureSession.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L91) ___ @@ -179,7 +188,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:46 +[packages/matter.js/src/session/UnsecureSession.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L47) ___ @@ -203,7 +212,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:94 +[packages/matter.js/src/session/UnsecureSession.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L95) ___ @@ -221,7 +230,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:98 +[packages/matter.js/src/session/UnsecureSession.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L99) ___ @@ -235,7 +244,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:50 +[packages/matter.js/src/session/UnsecureSession.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L51) ___ @@ -253,7 +262,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:70 +[packages/matter.js/src/session/UnsecureSession.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L71) ___ @@ -271,7 +280,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:74 +[packages/matter.js/src/session/UnsecureSession.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L75) ___ @@ -295,7 +304,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:62 +[packages/matter.js/src/session/UnsecureSession.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L63) ___ @@ -313,7 +322,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:82 +[packages/matter.js/src/session/UnsecureSession.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L83) ___ @@ -331,7 +340,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:86 +[packages/matter.js/src/session/UnsecureSession.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L87) ___ @@ -349,7 +358,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:78 +[packages/matter.js/src/session/UnsecureSession.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L79) ___ @@ -367,7 +376,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:30 +[packages/matter.js/src/session/UnsecureSession.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L31) ___ @@ -385,7 +394,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:38 +[packages/matter.js/src/session/UnsecureSession.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L39) ___ @@ -403,7 +412,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:26 +[packages/matter.js/src/session/UnsecureSession.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L27) ___ @@ -427,7 +436,7 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:34 +[packages/matter.js/src/session/UnsecureSession.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L35) ___ @@ -447,4 +456,4 @@ ___ #### Defined in -packages/matter.js/src/session/UnsecureSession.ts:54 +[packages/matter.js/src/session/UnsecureSession.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/UnsecureSession.ts#L55) diff --git a/docs/matter.js/classes/storage_export.Storage.md b/docs/matter.js/classes/storage_export.Storage.md index 4b1e97b376..a69d6169fc 100644 --- a/docs/matter.js/classes/storage_export.Storage.md +++ b/docs/matter.js/classes/storage_export.Storage.md @@ -16,10 +16,12 @@ ### Methods +- [clearAll](storage_export.Storage.md#clearall) - [close](storage_export.Storage.md#close) - [delete](storage_export.Storage.md#delete) - [get](storage_export.Storage.md#get) - [initialize](storage_export.Storage.md#initialize) +- [keys](storage_export.Storage.md#keys) - [set](storage_export.Storage.md#set) ## Constructors @@ -30,6 +32,26 @@ ## Methods +### clearAll + +▸ `Abstract` **clearAll**(`contexts`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/storage/Storage.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/Storage.ts#L18) + +___ + ### close ▸ `Abstract` **close**(): `Promise`<`void`\> @@ -40,7 +62,7 @@ #### Defined in -packages/matter.js/src/storage/Storage.ts:13 +[packages/matter.js/src/storage/Storage.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/Storage.ts#L13) ___ @@ -61,7 +83,7 @@ ___ #### Defined in -packages/matter.js/src/storage/Storage.ts:16 +[packages/matter.js/src/storage/Storage.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/Storage.ts#L16) ___ @@ -88,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/storage/Storage.ts:14 +[packages/matter.js/src/storage/Storage.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/Storage.ts#L14) ___ @@ -102,7 +124,27 @@ ___ #### Defined in -packages/matter.js/src/storage/Storage.ts:12 +[packages/matter.js/src/storage/Storage.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/Storage.ts#L12) + +___ + +### keys + +▸ `Abstract` **keys**(`contexts`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`string`[] + +#### Defined in + +[packages/matter.js/src/storage/Storage.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/Storage.ts#L17) ___ @@ -130,4 +172,4 @@ ___ #### Defined in -packages/matter.js/src/storage/Storage.ts:15 +[packages/matter.js/src/storage/Storage.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/Storage.ts#L15) diff --git a/docs/matter.js/classes/storage_export.StorageBackendMemory.md b/docs/matter.js/classes/storage_export.StorageBackendMemory.md index 5516d643a8..d65af3f7af 100644 --- a/docs/matter.js/classes/storage_export.StorageBackendMemory.md +++ b/docs/matter.js/classes/storage_export.StorageBackendMemory.md @@ -21,11 +21,13 @@ ### Methods - [clear](storage_export.StorageBackendMemory.md#clear) +- [clearAll](storage_export.StorageBackendMemory.md#clearall) - [close](storage_export.StorageBackendMemory.md#close) - [createContextKey](storage_export.StorageBackendMemory.md#createcontextkey) - [delete](storage_export.StorageBackendMemory.md#delete) - [get](storage_export.StorageBackendMemory.md#get) - [initialize](storage_export.StorageBackendMemory.md#initialize) +- [keys](storage_export.StorageBackendMemory.md#keys) - [set](storage_export.StorageBackendMemory.md#set) ## Constructors @@ -42,7 +44,7 @@ #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:11 +[packages/matter.js/src/storage/StorageBackendMemory.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L11) ## Properties @@ -52,7 +54,7 @@ packages/matter.js/src/storage/StorageBackendMemory.ts:11 #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:11 +[packages/matter.js/src/storage/StorageBackendMemory.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L11) ## Methods @@ -66,7 +68,31 @@ packages/matter.js/src/storage/StorageBackendMemory.ts:11 #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:28 +[packages/matter.js/src/storage/StorageBackendMemory.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L28) + +___ + +### clearAll + +▸ **clearAll**(`contexts`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`void` + +#### Implementation of + +[Storage](storage_export.Storage.md).[clearAll](storage_export.Storage.md#clearall) + +#### Defined in + +[packages/matter.js/src/storage/StorageBackendMemory.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L56) ___ @@ -84,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:24 +[packages/matter.js/src/storage/StorageBackendMemory.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L24) ___ @@ -104,7 +130,7 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:13 +[packages/matter.js/src/storage/StorageBackendMemory.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L13) ___ @@ -129,7 +155,7 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:46 +[packages/matter.js/src/storage/StorageBackendMemory.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L46) ___ @@ -160,7 +186,7 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:32 +[packages/matter.js/src/storage/StorageBackendMemory.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L32) ___ @@ -178,7 +204,31 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:20 +[packages/matter.js/src/storage/StorageBackendMemory.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L20) + +___ + +### keys + +▸ **keys**(`contexts`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `contexts` | `string`[] | + +#### Returns + +`string`[] + +#### Implementation of + +[Storage](storage_export.Storage.md).[keys](storage_export.Storage.md#keys) + +#### Defined in + +[packages/matter.js/src/storage/StorageBackendMemory.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L51) ___ @@ -210,4 +260,4 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageBackendMemory.ts:37 +[packages/matter.js/src/storage/StorageBackendMemory.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageBackendMemory.ts#L37) diff --git a/docs/matter.js/classes/storage_export.StorageContext.md b/docs/matter.js/classes/storage_export.StorageContext.md index baa7b9de97..137c76065f 100644 --- a/docs/matter.js/classes/storage_export.StorageContext.md +++ b/docs/matter.js/classes/storage_export.StorageContext.md @@ -17,10 +17,13 @@ ### Methods +- [clear](storage_export.StorageContext.md#clear) +- [clearAll](storage_export.StorageContext.md#clearall) - [createContext](storage_export.StorageContext.md#createcontext) - [delete](storage_export.StorageContext.md#delete) - [get](storage_export.StorageContext.md#get) - [has](storage_export.StorageContext.md#has) +- [keys](storage_export.StorageContext.md#keys) - [set](storage_export.StorageContext.md#set) ## Constructors @@ -38,7 +41,7 @@ #### Defined in -packages/matter.js/src/storage/StorageContext.ts:11 +[packages/matter.js/src/storage/StorageContext.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L11) ## Properties @@ -48,7 +51,7 @@ packages/matter.js/src/storage/StorageContext.ts:11 #### Defined in -packages/matter.js/src/storage/StorageContext.ts:13 +[packages/matter.js/src/storage/StorageContext.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L13) ___ @@ -58,10 +61,42 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageContext.ts:12 +[packages/matter.js/src/storage/StorageContext.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L12) ## Methods +### clear + +▸ **clear**(): `void` + +Clears all keys in this context + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/storage/StorageContext.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L50) + +___ + +### clearAll + +▸ **clearAll**(): `void` + +Clears all keys in this context and all created sub-contexts. + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/storage/StorageContext.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L57) + +___ + ### createContext ▸ **createContext**(`context`): [`StorageContext`](storage_export.StorageContext.md) @@ -78,7 +113,7 @@ packages/matter.js/src/storage/StorageContext.ts:12 #### Defined in -packages/matter.js/src/storage/StorageContext.ts:39 +[packages/matter.js/src/storage/StorageContext.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L39) ___ @@ -98,7 +133,7 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageContext.ts:35 +[packages/matter.js/src/storage/StorageContext.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L35) ___ @@ -125,7 +160,7 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageContext.ts:16 +[packages/matter.js/src/storage/StorageContext.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L16) ___ @@ -145,7 +180,21 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageContext.ts:27 +[packages/matter.js/src/storage/StorageContext.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L27) + +___ + +### keys + +▸ **keys**(): `string`[] + +#### Returns + +`string`[] + +#### Defined in + +[packages/matter.js/src/storage/StorageContext.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L45) ___ @@ -172,4 +221,4 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageContext.ts:31 +[packages/matter.js/src/storage/StorageContext.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageContext.ts#L31) diff --git a/docs/matter.js/classes/storage_export.StorageManager.md b/docs/matter.js/classes/storage_export.StorageManager.md index aea20a73fc..425a7565b1 100644 --- a/docs/matter.js/classes/storage_export.StorageManager.md +++ b/docs/matter.js/classes/storage_export.StorageManager.md @@ -35,7 +35,7 @@ #### Defined in -packages/matter.js/src/storage/StorageManager.ts:13 +[packages/matter.js/src/storage/StorageManager.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageManager.ts#L13) ## Properties @@ -45,7 +45,7 @@ packages/matter.js/src/storage/StorageManager.ts:13 #### Defined in -packages/matter.js/src/storage/StorageManager.ts:11 +[packages/matter.js/src/storage/StorageManager.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageManager.ts#L11) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageManager.ts:13 +[packages/matter.js/src/storage/StorageManager.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageManager.ts#L13) ## Methods @@ -69,7 +69,7 @@ packages/matter.js/src/storage/StorageManager.ts:13 #### Defined in -packages/matter.js/src/storage/StorageManager.ts:20 +[packages/matter.js/src/storage/StorageManager.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageManager.ts#L20) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageManager.ts:24 +[packages/matter.js/src/storage/StorageManager.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageManager.ts#L24) ___ @@ -103,4 +103,4 @@ ___ #### Defined in -packages/matter.js/src/storage/StorageManager.ts:15 +[packages/matter.js/src/storage/StorageManager.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StorageManager.ts#L15) diff --git a/docs/matter.js/classes/time_export.Time.md b/docs/matter.js/classes/time_export.Time.md index 8426b5b4ed..dd2e5f5d42 100644 --- a/docs/matter.js/classes/time_export.Time.md +++ b/docs/matter.js/classes/time_export.Time.md @@ -48,7 +48,7 @@ #### Defined in -packages/matter.js/src/time/Time.ts:12 +[packages/matter.js/src/time/Time.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L12) ## Methods @@ -71,7 +71,7 @@ Returns a timer that will periodically call callback at intervalMs intervals. #### Defined in -packages/matter.js/src/time/Time.ts:26 +[packages/matter.js/src/time/Time.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L26) ___ @@ -94,7 +94,7 @@ Returns a timer that will call callback after durationMs has passed. #### Defined in -packages/matter.js/src/time/Time.ts:21 +[packages/matter.js/src/time/Time.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L21) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/time/Time.ts:14 +[packages/matter.js/src/time/Time.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L14) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -packages/matter.js/src/time/Time.ts:17 +[packages/matter.js/src/time/Time.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L17) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/time/Time.ts:27 +[packages/matter.js/src/time/Time.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L27) ___ @@ -164,7 +164,7 @@ ___ #### Defined in -packages/matter.js/src/time/Time.ts:22 +[packages/matter.js/src/time/Time.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L22) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/time/Time.ts:15 +[packages/matter.js/src/time/Time.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L15) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -packages/matter.js/src/time/Time.ts:18 +[packages/matter.js/src/time/Time.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L18) ___ @@ -212,4 +212,4 @@ ___ #### Defined in -packages/matter.js/src/time/Time.ts:30 +[packages/matter.js/src/time/Time.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L30) diff --git a/docs/matter.js/classes/tlv_export.AnySchema.md b/docs/matter.js/classes/tlv_export.AnySchema.md index 4e73e9a209..c7ecfae7c6 100644 --- a/docs/matter.js/classes/tlv_export.AnySchema.md +++ b/docs/matter.js/classes/tlv_export.AnySchema.md @@ -72,7 +72,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:112 +[packages/matter.js/src/tlv/TlvAny.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L112) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:161 +[packages/matter.js/src/tlv/TlvAny.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L161) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:125 +[packages/matter.js/src/tlv/TlvAny.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L125) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:180 +[packages/matter.js/src/tlv/TlvAny.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L180) ___ @@ -178,7 +178,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -202,7 +202,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -231,7 +231,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -256,7 +256,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:66 +[packages/matter.js/src/tlv/TlvAny.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L66) ___ @@ -279,7 +279,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:70 +[packages/matter.js/src/tlv/TlvAny.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L70) ___ @@ -305,7 +305,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -329,7 +329,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -353,7 +353,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -379,7 +379,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:38 +[packages/matter.js/src/tlv/TlvAny.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L38) ___ @@ -399,7 +399,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:13 +[packages/matter.js/src/tlv/TlvAny.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L13) ___ @@ -426,7 +426,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -452,7 +452,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -476,4 +476,4 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:100 +[packages/matter.js/src/tlv/TlvAny.ts:100](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L100) diff --git a/docs/matter.js/classes/tlv_export.ArraySchema.md b/docs/matter.js/classes/tlv_export.ArraySchema.md index a201892693..88e48afa7f 100644 --- a/docs/matter.js/classes/tlv_export.ArraySchema.md +++ b/docs/matter.js/classes/tlv_export.ArraySchema.md @@ -77,7 +77,7 @@ TlvSchema<T[]\>.constructor #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:30 +[packages/matter.js/src/tlv/TlvArray.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L30) ## Properties @@ -87,7 +87,7 @@ packages/matter.js/src/tlv/TlvArray.ts:30 #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:31 +[packages/matter.js/src/tlv/TlvArray.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L31) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:33 +[packages/matter.js/src/tlv/TlvArray.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L33) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:32 +[packages/matter.js/src/tlv/TlvArray.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L32) ## Methods @@ -134,7 +134,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -155,7 +155,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:90 +[packages/matter.js/src/tlv/TlvArray.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L90) ___ @@ -179,7 +179,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -203,7 +203,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -232,7 +232,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -257,7 +257,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:44 +[packages/matter.js/src/tlv/TlvArray.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L44) ___ @@ -283,7 +283,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -303,7 +303,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:116 +[packages/matter.js/src/tlv/TlvArray.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L116) ___ @@ -327,7 +327,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -351,7 +351,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -377,7 +377,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:38 +[packages/matter.js/src/tlv/TlvArray.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L38) ___ @@ -404,7 +404,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:57 +[packages/matter.js/src/tlv/TlvArray.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L57) ___ @@ -430,7 +430,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:72 +[packages/matter.js/src/tlv/TlvArray.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L72) ___ @@ -454,4 +454,4 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:81 +[packages/matter.js/src/tlv/TlvArray.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L81) diff --git a/docs/matter.js/classes/tlv_export.BooleanSchema.md b/docs/matter.js/classes/tlv_export.BooleanSchema.md index 7c3d093baa..641b732169 100644 --- a/docs/matter.js/classes/tlv_export.BooleanSchema.md +++ b/docs/matter.js/classes/tlv_export.BooleanSchema.md @@ -72,7 +72,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -96,7 +96,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -120,7 +120,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -149,7 +149,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -174,7 +174,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvBoolean.ts:22 +[packages/matter.js/src/tlv/TlvBoolean.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvBoolean.ts#L22) ___ @@ -200,7 +200,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -224,7 +224,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -248,7 +248,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -274,7 +274,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvBoolean.ts:18 +[packages/matter.js/src/tlv/TlvBoolean.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvBoolean.ts#L18) ___ @@ -301,7 +301,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -327,7 +327,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -351,4 +351,4 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvBoolean.ts:27 +[packages/matter.js/src/tlv/TlvBoolean.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvBoolean.ts#L27) diff --git a/docs/matter.js/classes/tlv_export.NoArgumentsSchema.md b/docs/matter.js/classes/tlv_export.NoArgumentsSchema.md index 01f89e0c3b..4f22e2cef6 100644 --- a/docs/matter.js/classes/tlv_export.NoArgumentsSchema.md +++ b/docs/matter.js/classes/tlv_export.NoArgumentsSchema.md @@ -68,7 +68,7 @@ VoidSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -92,7 +92,7 @@ VoidSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -116,7 +116,7 @@ VoidSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvVoid.ts:19 +[packages/matter.js/src/tlv/TlvVoid.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvVoid.ts#L19) ___ @@ -145,7 +145,7 @@ VoidSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -170,7 +170,7 @@ VoidSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvVoid.ts:23 +[packages/matter.js/src/tlv/TlvVoid.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvVoid.ts#L23) ___ @@ -196,7 +196,7 @@ VoidSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -220,7 +220,7 @@ VoidSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -244,7 +244,7 @@ VoidSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -270,7 +270,7 @@ VoidSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvNoArguments.ts:19 +[packages/matter.js/src/tlv/TlvNoArguments.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNoArguments.ts#L19) ___ @@ -297,7 +297,7 @@ VoidSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -323,7 +323,7 @@ VoidSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -347,4 +347,4 @@ VoidSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvVoid.ts:27 +[packages/matter.js/src/tlv/TlvVoid.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvVoid.ts#L27) diff --git a/docs/matter.js/classes/tlv_export.NullableSchema.md b/docs/matter.js/classes/tlv_export.NullableSchema.md index f740fdaf27..8ad7d333c6 100644 --- a/docs/matter.js/classes/tlv_export.NullableSchema.md +++ b/docs/matter.js/classes/tlv_export.NullableSchema.md @@ -71,7 +71,7 @@ TlvSchema<T \| null\>.constructor #### Defined in -packages/matter.js/src/tlv/TlvNullable.ts:17 +[packages/matter.js/src/tlv/TlvNullable.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNullable.ts#L17) ## Properties @@ -81,7 +81,7 @@ packages/matter.js/src/tlv/TlvNullable.ts:17 #### Defined in -packages/matter.js/src/tlv/TlvNullable.ts:17 +[packages/matter.js/src/tlv/TlvNullable.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNullable.ts#L17) ## Methods @@ -108,7 +108,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -132,7 +132,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -156,7 +156,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -185,7 +185,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -210,7 +210,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvNullable.ts:29 +[packages/matter.js/src/tlv/TlvNullable.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNullable.ts#L29) ___ @@ -236,7 +236,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -260,7 +260,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -284,7 +284,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -310,7 +310,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvNullable.ts:21 +[packages/matter.js/src/tlv/TlvNullable.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNullable.ts#L21) ___ @@ -337,7 +337,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvNullable.ts:38 +[packages/matter.js/src/tlv/TlvNullable.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNullable.ts#L38) ___ @@ -363,7 +363,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvNullable.ts:45 +[packages/matter.js/src/tlv/TlvNullable.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNullable.ts#L45) ___ @@ -387,4 +387,4 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvNullable.ts:34 +[packages/matter.js/src/tlv/TlvNullable.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNullable.ts#L34) diff --git a/docs/matter.js/classes/tlv_export.ObjectSchema.md b/docs/matter.js/classes/tlv_export.ObjectSchema.md index a6f0e7da47..271a5dd0be 100644 --- a/docs/matter.js/classes/tlv_export.ObjectSchema.md +++ b/docs/matter.js/classes/tlv_export.ObjectSchema.md @@ -74,7 +74,7 @@ TlvSchema<TypeFromFields<F\>\>.constructor #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:49 +[packages/matter.js/src/tlv/TlvObject.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L49) ## Properties @@ -84,7 +84,7 @@ packages/matter.js/src/tlv/TlvObject.ts:49 #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:47 +[packages/matter.js/src/tlv/TlvObject.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L47) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:50 +[packages/matter.js/src/tlv/TlvObject.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L50) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:51 +[packages/matter.js/src/tlv/TlvObject.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L51) ## Methods @@ -131,7 +131,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -155,7 +155,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -179,7 +179,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -208,7 +208,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -233,7 +233,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:77 +[packages/matter.js/src/tlv/TlvObject.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L77) ___ @@ -259,7 +259,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -283,7 +283,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -307,7 +307,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -333,7 +333,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:61 +[packages/matter.js/src/tlv/TlvObject.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L61) ___ @@ -360,7 +360,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:122 +[packages/matter.js/src/tlv/TlvObject.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L122) ___ @@ -386,7 +386,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:143 +[packages/matter.js/src/tlv/TlvObject.ts:143](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L143) ___ @@ -410,4 +410,4 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:109 +[packages/matter.js/src/tlv/TlvObject.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L109) diff --git a/docs/matter.js/classes/tlv_export.StringSchema.md b/docs/matter.js/classes/tlv_export.StringSchema.md index eca5750e59..47c127f3b5 100644 --- a/docs/matter.js/classes/tlv_export.StringSchema.md +++ b/docs/matter.js/classes/tlv_export.StringSchema.md @@ -76,7 +76,7 @@ TlvSchema<TlvToPrimitive[T]\>.constructor #### Defined in -packages/matter.js/src/tlv/TlvString.ts:26 +[packages/matter.js/src/tlv/TlvString.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L26) ## Properties @@ -86,7 +86,7 @@ packages/matter.js/src/tlv/TlvString.ts:26 #### Defined in -packages/matter.js/src/tlv/TlvString.ts:29 +[packages/matter.js/src/tlv/TlvString.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L29) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvString.ts:28 +[packages/matter.js/src/tlv/TlvString.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L28) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvString.ts:27 +[packages/matter.js/src/tlv/TlvString.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L27) ## Methods @@ -126,7 +126,7 @@ packages/matter.js/src/tlv/TlvString.ts:27 #### Defined in -packages/matter.js/src/tlv/TlvString.ts:58 +[packages/matter.js/src/tlv/TlvString.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L58) ___ @@ -153,7 +153,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -177,7 +177,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -201,7 +201,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -230,7 +230,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -255,7 +255,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvString.ts:42 +[packages/matter.js/src/tlv/TlvString.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L42) ___ @@ -281,7 +281,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -305,7 +305,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -329,7 +329,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -355,7 +355,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvString.ts:36 +[packages/matter.js/src/tlv/TlvString.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L36) ___ @@ -382,7 +382,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -408,7 +408,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -432,4 +432,4 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvString.ts:47 +[packages/matter.js/src/tlv/TlvString.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L47) diff --git a/docs/matter.js/classes/tlv_export.TlvArrayReader.md b/docs/matter.js/classes/tlv_export.TlvArrayReader.md index 3eb5dc2705..b937880a9c 100644 --- a/docs/matter.js/classes/tlv_export.TlvArrayReader.md +++ b/docs/matter.js/classes/tlv_export.TlvArrayReader.md @@ -38,7 +38,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:79 +[packages/matter.js/src/tlv/TlvSchema.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L79) ## Properties @@ -48,7 +48,7 @@ packages/matter.js/src/tlv/TlvSchema.ts:79 #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:77 +[packages/matter.js/src/tlv/TlvSchema.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L77) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:79 +[packages/matter.js/src/tlv/TlvSchema.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L79) ## Methods @@ -89,7 +89,7 @@ packages/matter.js/src/tlv/TlvSchema.ts:79 #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:86 +[packages/matter.js/src/tlv/TlvSchema.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L86) ___ @@ -107,4 +107,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:81 +[packages/matter.js/src/tlv/TlvSchema.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L81) diff --git a/docs/matter.js/classes/tlv_export.TlvArrayWriter.md b/docs/matter.js/classes/tlv_export.TlvArrayWriter.md index 8f7827f5b0..f896cb8ef7 100644 --- a/docs/matter.js/classes/tlv_export.TlvArrayWriter.md +++ b/docs/matter.js/classes/tlv_export.TlvArrayWriter.md @@ -38,7 +38,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:61 +[packages/matter.js/src/tlv/TlvSchema.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L61) ## Methods @@ -52,7 +52,7 @@ packages/matter.js/src/tlv/TlvSchema.ts:61 #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:71 +[packages/matter.js/src/tlv/TlvSchema.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L71) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:67 +[packages/matter.js/src/tlv/TlvSchema.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L67) ___ @@ -108,4 +108,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:63 +[packages/matter.js/src/tlv/TlvSchema.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L63) diff --git a/docs/matter.js/classes/tlv_export.TlvByteArrayReader.md b/docs/matter.js/classes/tlv_export.TlvByteArrayReader.md index ba348c1cf6..a358654874 100644 --- a/docs/matter.js/classes/tlv_export.TlvByteArrayReader.md +++ b/docs/matter.js/classes/tlv_export.TlvByteArrayReader.md @@ -37,7 +37,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:125 +[packages/matter.js/src/tlv/TlvSchema.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L125) ## Properties @@ -47,7 +47,7 @@ packages/matter.js/src/tlv/TlvSchema.ts:125 #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:123 +[packages/matter.js/src/tlv/TlvSchema.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L123) ## Methods @@ -78,7 +78,7 @@ packages/matter.js/src/tlv/TlvSchema.ts:123 #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:133 +[packages/matter.js/src/tlv/TlvSchema.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L133) ___ @@ -101,4 +101,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:129 +[packages/matter.js/src/tlv/TlvSchema.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L129) diff --git a/docs/matter.js/classes/tlv_export.TlvByteArrayWriter.md b/docs/matter.js/classes/tlv_export.TlvByteArrayWriter.md index f95f91f54c..be560bfbc2 100644 --- a/docs/matter.js/classes/tlv_export.TlvByteArrayWriter.md +++ b/docs/matter.js/classes/tlv_export.TlvByteArrayWriter.md @@ -38,7 +38,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:107 +[packages/matter.js/src/tlv/TlvSchema.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L107) ## Methods @@ -52,7 +52,7 @@ packages/matter.js/src/tlv/TlvSchema.ts:107 #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:117 +[packages/matter.js/src/tlv/TlvSchema.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L117) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:113 +[packages/matter.js/src/tlv/TlvSchema.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L113) ___ @@ -108,4 +108,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:109 +[packages/matter.js/src/tlv/TlvSchema.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L109) diff --git a/docs/matter.js/classes/tlv_export.TlvCodec.md b/docs/matter.js/classes/tlv_export.TlvCodec.md index efcdee5b15..40ddd89ebf 100644 --- a/docs/matter.js/classes/tlv_export.TlvCodec.md +++ b/docs/matter.js/classes/tlv_export.TlvCodec.md @@ -49,7 +49,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:129 +[packages/matter.js/src/tlv/TlvCodec.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L129) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:422 +[packages/matter.js/src/tlv/TlvCodec.ts:422](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L422) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:342 +[packages/matter.js/src/tlv/TlvCodec.ts:342](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L342) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:457 +[packages/matter.js/src/tlv/TlvCodec.ts:457](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L457) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:117 +[packages/matter.js/src/tlv/TlvCodec.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L117) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:179 +[packages/matter.js/src/tlv/TlvCodec.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L179) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:206 +[packages/matter.js/src/tlv/TlvCodec.ts:206](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L206) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:159 +[packages/matter.js/src/tlv/TlvCodec.ts:159](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L159) ___ @@ -234,7 +234,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:154 +[packages/matter.js/src/tlv/TlvCodec.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L154) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:370 +[packages/matter.js/src/tlv/TlvCodec.ts:370](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L370) ___ @@ -288,7 +288,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:292 +[packages/matter.js/src/tlv/TlvCodec.ts:292](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L292) ___ @@ -310,4 +310,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:444 +[packages/matter.js/src/tlv/TlvCodec.ts:444](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L444) diff --git a/docs/matter.js/classes/tlv_export.TlvNumberSchema.md b/docs/matter.js/classes/tlv_export.TlvNumberSchema.md index b7615d311c..fecafca7f0 100644 --- a/docs/matter.js/classes/tlv_export.TlvNumberSchema.md +++ b/docs/matter.js/classes/tlv_export.TlvNumberSchema.md @@ -61,7 +61,7 @@ TlvNumericSchema<number\>.constructor #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:89 +[packages/matter.js/src/tlv/TlvNumber.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L89) ## Properties @@ -89,7 +89,7 @@ TlvNumericSchema.lengthProvider #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:40 +[packages/matter.js/src/tlv/TlvNumber.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L40) ___ @@ -103,7 +103,7 @@ TlvNumericSchema.max #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:42 +[packages/matter.js/src/tlv/TlvNumber.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L42) ___ @@ -117,7 +117,7 @@ TlvNumericSchema.min #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:41 +[packages/matter.js/src/tlv/TlvNumber.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L41) ___ @@ -131,7 +131,7 @@ TlvNumericSchema.type #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:39 +[packages/matter.js/src/tlv/TlvNumber.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L39) ## Methods @@ -155,7 +155,7 @@ TlvNumericSchema.bound #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:103 +[packages/matter.js/src/tlv/TlvNumber.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L103) ___ @@ -182,7 +182,7 @@ TlvNumericSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -206,7 +206,7 @@ TlvNumericSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -230,7 +230,7 @@ TlvNumericSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -259,7 +259,7 @@ TlvNumericSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -284,7 +284,7 @@ TlvNumericSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:98 +[packages/matter.js/src/tlv/TlvNumber.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L98) ___ @@ -310,7 +310,7 @@ TlvNumericSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -334,7 +334,7 @@ TlvNumericSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -358,7 +358,7 @@ TlvNumericSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -384,7 +384,7 @@ TlvNumericSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:47 +[packages/matter.js/src/tlv/TlvNumber.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L47) ___ @@ -411,7 +411,7 @@ TlvNumericSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -437,7 +437,7 @@ TlvNumericSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -461,7 +461,7 @@ TlvNumericSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:107 +[packages/matter.js/src/tlv/TlvNumber.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L107) ___ @@ -485,4 +485,4 @@ TlvNumericSchema.validateBoundaries #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:65 +[packages/matter.js/src/tlv/TlvNumber.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L65) diff --git a/docs/matter.js/classes/tlv_export.TlvNumericSchema.md b/docs/matter.js/classes/tlv_export.TlvNumericSchema.md index 4521cd71f0..fa7079b1cc 100644 --- a/docs/matter.js/classes/tlv_export.TlvNumericSchema.md +++ b/docs/matter.js/classes/tlv_export.TlvNumericSchema.md @@ -81,7 +81,7 @@ TlvSchema<T\>.constructor #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:38 +[packages/matter.js/src/tlv/TlvNumber.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L38) ## Properties @@ -105,7 +105,7 @@ packages/matter.js/src/tlv/TlvNumber.ts:38 #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:40 +[packages/matter.js/src/tlv/TlvNumber.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L40) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:42 +[packages/matter.js/src/tlv/TlvNumber.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L42) ___ @@ -125,7 +125,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:41 +[packages/matter.js/src/tlv/TlvNumber.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L41) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:39 +[packages/matter.js/src/tlv/TlvNumber.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L39) ## Methods @@ -157,7 +157,7 @@ Restrict value range. #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:73 +[packages/matter.js/src/tlv/TlvNumber.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L73) ___ @@ -184,7 +184,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -208,7 +208,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -232,7 +232,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -261,7 +261,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -286,7 +286,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:53 +[packages/matter.js/src/tlv/TlvNumber.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L53) ___ @@ -312,7 +312,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -336,7 +336,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -360,7 +360,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -386,7 +386,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:47 +[packages/matter.js/src/tlv/TlvNumber.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L47) ___ @@ -413,7 +413,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -439,7 +439,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -463,7 +463,7 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:59 +[packages/matter.js/src/tlv/TlvNumber.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L59) ___ @@ -483,4 +483,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:65 +[packages/matter.js/src/tlv/TlvNumber.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L65) diff --git a/docs/matter.js/classes/tlv_export.TlvSchema.md b/docs/matter.js/classes/tlv_export.TlvSchema.md index cfcb987b84..4728ca96ba 100644 --- a/docs/matter.js/classes/tlv_export.TlvSchema.md +++ b/docs/matter.js/classes/tlv_export.TlvSchema.md @@ -108,7 +108,7 @@ Schema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -136,7 +136,7 @@ Schema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -160,7 +160,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -189,7 +189,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -214,7 +214,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:39 +[packages/matter.js/src/tlv/TlvSchema.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L39) ___ @@ -244,7 +244,7 @@ Schema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -272,7 +272,7 @@ Schema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -296,7 +296,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -322,7 +322,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:41 +[packages/matter.js/src/tlv/TlvSchema.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L41) ___ @@ -349,7 +349,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -375,7 +375,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -405,4 +405,4 @@ Schema.validate #### Defined in -packages/matter.js/src/schema/Schema.ts:28 +[packages/matter.js/src/schema/Schema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L28) diff --git a/docs/matter.js/classes/tlv_export.TlvWrapper.md b/docs/matter.js/classes/tlv_export.TlvWrapper.md index f4198d80ce..0a5abb0ca5 100644 --- a/docs/matter.js/classes/tlv_export.TlvWrapper.md +++ b/docs/matter.js/classes/tlv_export.TlvWrapper.md @@ -71,7 +71,7 @@ TlvSchema<O\>.constructor #### Defined in -packages/matter.js/src/tlv/TlvWrapper.ts:11 +[packages/matter.js/src/tlv/TlvWrapper.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvWrapper.ts#L11) ## Properties @@ -81,7 +81,7 @@ packages/matter.js/src/tlv/TlvWrapper.ts:11 #### Defined in -packages/matter.js/src/tlv/TlvWrapper.ts:12 +[packages/matter.js/src/tlv/TlvWrapper.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvWrapper.ts#L12) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvWrapper.ts:14 +[packages/matter.js/src/tlv/TlvWrapper.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvWrapper.ts#L14) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvWrapper.ts:13 +[packages/matter.js/src/tlv/TlvWrapper.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvWrapper.ts#L13) ## Methods @@ -156,7 +156,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -180,7 +180,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -204,7 +204,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:30 +[packages/matter.js/src/tlv/TlvSchema.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L30) ___ @@ -233,7 +233,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -258,7 +258,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvWrapper.ts:19 +[packages/matter.js/src/tlv/TlvWrapper.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvWrapper.ts#L19) ___ @@ -284,7 +284,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -308,7 +308,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -332,7 +332,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -358,7 +358,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvWrapper.ts:23 +[packages/matter.js/src/tlv/TlvWrapper.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvWrapper.ts#L23) ___ @@ -385,7 +385,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -411,7 +411,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -435,4 +435,4 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvWrapper.ts:27 +[packages/matter.js/src/tlv/TlvWrapper.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvWrapper.ts#L27) diff --git a/docs/matter.js/classes/tlv_export.VoidSchema.md b/docs/matter.js/classes/tlv_export.VoidSchema.md index 0ade7eaa64..f12c38078a 100644 --- a/docs/matter.js/classes/tlv_export.VoidSchema.md +++ b/docs/matter.js/classes/tlv_export.VoidSchema.md @@ -70,7 +70,7 @@ TlvSchema.decode #### Defined in -packages/matter.js/src/schema/Schema.ts:16 +[packages/matter.js/src/schema/Schema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L16) ___ @@ -94,7 +94,7 @@ TlvSchema.decodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:14 +[packages/matter.js/src/tlv/TlvSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L14) ___ @@ -118,7 +118,7 @@ TlvSchema.decodeTlv #### Defined in -packages/matter.js/src/tlv/TlvVoid.ts:19 +[packages/matter.js/src/tlv/TlvVoid.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvVoid.ts#L19) ___ @@ -147,7 +147,7 @@ TlvSchema.decodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:34 +[packages/matter.js/src/tlv/TlvSchema.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L34) ___ @@ -172,7 +172,7 @@ TlvSchema.decodeTlvInternalValue #### Defined in -packages/matter.js/src/tlv/TlvVoid.ts:23 +[packages/matter.js/src/tlv/TlvVoid.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvVoid.ts#L23) ___ @@ -198,7 +198,7 @@ TlvSchema.encode #### Defined in -packages/matter.js/src/schema/Schema.ts:10 +[packages/matter.js/src/schema/Schema.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Schema.ts#L10) ___ @@ -222,7 +222,7 @@ TlvSchema.encodeInternal #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:18 +[packages/matter.js/src/tlv/TlvSchema.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L18) ___ @@ -246,7 +246,7 @@ TlvSchema.encodeTlv #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:24 +[packages/matter.js/src/tlv/TlvSchema.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L24) ___ @@ -272,7 +272,7 @@ TlvSchema.encodeTlvInternal #### Defined in -packages/matter.js/src/tlv/TlvVoid.ts:15 +[packages/matter.js/src/tlv/TlvVoid.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvVoid.ts#L15) ___ @@ -299,7 +299,7 @@ TlvSchema.injectField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:43 +[packages/matter.js/src/tlv/TlvSchema.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L43) ___ @@ -325,7 +325,7 @@ TlvSchema.removeField #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:47 +[packages/matter.js/src/tlv/TlvSchema.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L47) ___ @@ -349,4 +349,4 @@ TlvSchema.validate #### Defined in -packages/matter.js/src/tlv/TlvVoid.ts:27 +[packages/matter.js/src/tlv/TlvVoid.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvVoid.ts#L27) diff --git a/docs/matter.js/classes/util_export.Cache.md b/docs/matter.js/classes/util_export.Cache.md index 28a7ec8205..04d08f168d 100644 --- a/docs/matter.js/classes/util_export.Cache.md +++ b/docs/matter.js/classes/util_export.Cache.md @@ -21,6 +21,7 @@ - [expirationMs](util_export.Cache.md#expirationms) - [expireCallback](util_export.Cache.md#expirecallback) - [generator](util_export.Cache.md#generator) +- [knownKeys](util_export.Cache.md#knownkeys) - [periodicTimer](util_export.Cache.md#periodictimer) - [timestamps](util_export.Cache.md#timestamps) - [values](util_export.Cache.md#values) @@ -56,7 +57,7 @@ #### Defined in -packages/matter.js/src/util/Cache.ts:16 +[packages/matter.js/src/util/Cache.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L17) ## Properties @@ -66,7 +67,7 @@ packages/matter.js/src/util/Cache.ts:16 #### Defined in -packages/matter.js/src/util/Cache.ts:18 +[packages/matter.js/src/util/Cache.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L19) ___ @@ -91,7 +92,7 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:19 +[packages/matter.js/src/util/Cache.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L20) ___ @@ -115,7 +116,17 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:17 +[packages/matter.js/src/util/Cache.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L18) + +___ + +### knownKeys + +• `Private` `Readonly` **knownKeys**: `Set`<`string`\> + +#### Defined in + +[packages/matter.js/src/util/Cache.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L12) ___ @@ -125,7 +136,7 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:14 +[packages/matter.js/src/util/Cache.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L15) ___ @@ -135,7 +146,7 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:13 +[packages/matter.js/src/util/Cache.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L14) ___ @@ -145,7 +156,7 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:12 +[packages/matter.js/src/util/Cache.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L13) ## Methods @@ -159,7 +170,7 @@ packages/matter.js/src/util/Cache.ts:12 #### Defined in -packages/matter.js/src/util/Cache.ts:48 +[packages/matter.js/src/util/Cache.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L50) ___ @@ -173,7 +184,7 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:56 +[packages/matter.js/src/util/Cache.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L58) ___ @@ -193,7 +204,7 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:39 +[packages/matter.js/src/util/Cache.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L41) ___ @@ -207,7 +218,7 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:61 +[packages/matter.js/src/util/Cache.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L64) ___ @@ -227,7 +238,7 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:24 +[packages/matter.js/src/util/Cache.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L25) ___ @@ -241,4 +252,4 @@ ___ #### Defined in -packages/matter.js/src/util/Cache.ts:35 +[packages/matter.js/src/util/Cache.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Cache.ts#L37) diff --git a/docs/matter.js/classes/util_export.DataReader.md b/docs/matter.js/classes/util_export.DataReader.md index 3273bc36d9..2ed610c490 100644 --- a/docs/matter.js/classes/util_export.DataReader.md +++ b/docs/matter.js/classes/util_export.DataReader.md @@ -66,7 +66,7 @@ Reader that auto-increments its offset after each read. #### Defined in -packages/matter.js/src/util/DataReader.ts:15 +[packages/matter.js/src/util/DataReader.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L15) ## Properties @@ -76,7 +76,7 @@ packages/matter.js/src/util/DataReader.ts:15 #### Defined in -packages/matter.js/src/util/DataReader.ts:16 +[packages/matter.js/src/util/DataReader.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L16) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:12 +[packages/matter.js/src/util/DataReader.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L12) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:11 +[packages/matter.js/src/util/DataReader.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L11) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:13 +[packages/matter.js/src/util/DataReader.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L13) ## Methods @@ -120,7 +120,7 @@ packages/matter.js/src/util/DataReader.ts:13 #### Defined in -packages/matter.js/src/util/DataReader.ts:81 +[packages/matter.js/src/util/DataReader.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L81) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:92 +[packages/matter.js/src/util/DataReader.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L92) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:77 +[packages/matter.js/src/util/DataReader.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L77) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:73 +[packages/matter.js/src/util/DataReader.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L73) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:68 +[packages/matter.js/src/util/DataReader.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L68) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:59 +[packages/matter.js/src/util/DataReader.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L59) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:55 +[packages/matter.js/src/util/DataReader.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L55) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:43 +[packages/matter.js/src/util/DataReader.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L43) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:47 +[packages/matter.js/src/util/DataReader.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L47) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:51 +[packages/matter.js/src/util/DataReader.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L51) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:39 +[packages/matter.js/src/util/DataReader.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L39) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:27 +[packages/matter.js/src/util/DataReader.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L27) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:31 +[packages/matter.js/src/util/DataReader.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L31) ___ @@ -314,7 +314,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:35 +[packages/matter.js/src/util/DataReader.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L35) ___ @@ -328,7 +328,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:23 +[packages/matter.js/src/util/DataReader.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L23) ___ @@ -348,7 +348,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:63 +[packages/matter.js/src/util/DataReader.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L63) ___ @@ -368,4 +368,4 @@ ___ #### Defined in -packages/matter.js/src/util/DataReader.ts:85 +[packages/matter.js/src/util/DataReader.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataReader.ts#L85) diff --git a/docs/matter.js/classes/util_export.DataWriter.md b/docs/matter.js/classes/util_export.DataWriter.md index 9b6f3751c7..b1cf7b1c10 100644 --- a/docs/matter.js/classes/util_export.DataWriter.md +++ b/docs/matter.js/classes/util_export.DataWriter.md @@ -59,7 +59,7 @@ Writer that auto-increments its offset after each write. #### Defined in -packages/matter.js/src/util/DataWriter.ts:17 +[packages/matter.js/src/util/DataWriter.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L17) ## Properties @@ -69,7 +69,7 @@ packages/matter.js/src/util/DataWriter.ts:17 #### Defined in -packages/matter.js/src/util/DataWriter.ts:15 +[packages/matter.js/src/util/DataWriter.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L15) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:14 +[packages/matter.js/src/util/DataWriter.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L14) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:13 +[packages/matter.js/src/util/DataWriter.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L13) ## Methods @@ -103,7 +103,7 @@ packages/matter.js/src/util/DataWriter.ts:13 #### Defined in -packages/matter.js/src/util/DataWriter.ts:94 +[packages/matter.js/src/util/DataWriter.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L94) ___ @@ -123,7 +123,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:89 +[packages/matter.js/src/util/DataWriter.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L89) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:82 +[packages/matter.js/src/util/DataWriter.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L82) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:75 +[packages/matter.js/src/util/DataWriter.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L75) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:54 +[packages/matter.js/src/util/DataWriter.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L54) ___ @@ -203,7 +203,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:61 +[packages/matter.js/src/util/DataWriter.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L61) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:68 +[packages/matter.js/src/util/DataWriter.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L68) ___ @@ -243,7 +243,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:47 +[packages/matter.js/src/util/DataWriter.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L47) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:26 +[packages/matter.js/src/util/DataWriter.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L26) ___ @@ -283,7 +283,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:33 +[packages/matter.js/src/util/DataWriter.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L33) ___ @@ -303,7 +303,7 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:40 +[packages/matter.js/src/util/DataWriter.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L40) ___ @@ -323,4 +323,4 @@ ___ #### Defined in -packages/matter.js/src/util/DataWriter.ts:21 +[packages/matter.js/src/util/DataWriter.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DataWriter.ts#L21) diff --git a/docs/matter.js/classes/export._internal_.NamedHandler.md b/docs/matter.js/classes/util_export.NamedHandler.md similarity index 60% rename from docs/matter.js/classes/export._internal_.NamedHandler.md rename to docs/matter.js/classes/util_export.NamedHandler.md index e719ea3fc5..2b291b40ff 100644 --- a/docs/matter.js/classes/export._internal_.NamedHandler.md +++ b/docs/matter.js/classes/util_export.NamedHandler.md @@ -1,31 +1,31 @@ -[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [export](../modules/export.md) / [](../modules/export._internal_.md) / NamedHandler +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [util/export](../modules/util_export.md) / NamedHandler # Class: NamedHandler -[export](../modules/export.md).[](../modules/export._internal_.md).NamedHandler +[util/export](../modules/util_export.md).NamedHandler ## Type parameters | Name | Type | | :------ | :------ | -| `H` | extends `Record` | +| `H` | extends `Record` | ## Table of contents ### Constructors -- [constructor](export._internal_.NamedHandler.md#constructor) +- [constructor](util_export.NamedHandler.md#constructor) ### Properties -- [handler](export._internal_.NamedHandler.md#handler) +- [handler](util_export.NamedHandler.md#handler) ### Methods -- [addHandler](export._internal_.NamedHandler.md#addhandler) -- [executeHandler](export._internal_.NamedHandler.md#executehandler) -- [hasHandler](export._internal_.NamedHandler.md#hashandler) -- [removeHandler](export._internal_.NamedHandler.md#removehandler) +- [addHandler](util_export.NamedHandler.md#addhandler) +- [executeHandler](util_export.NamedHandler.md#executehandler) +- [hasHandler](util_export.NamedHandler.md#hashandler) +- [removeHandler](util_export.NamedHandler.md#removehandler) ## Constructors @@ -37,7 +37,7 @@ | Name | Type | | :------ | :------ | -| `H` | extends `Record` | +| `H` | extends `Record` | ## Properties @@ -47,7 +47,7 @@ #### Defined in -packages/matter.js/src/util/NamedHandler.ts:10 +[packages/matter.js/src/util/NamedHandler.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L10) ## Methods @@ -74,7 +74,7 @@ packages/matter.js/src/util/NamedHandler.ts:10 #### Defined in -packages/matter.js/src/util/NamedHandler.ts:16 +[packages/matter.js/src/util/NamedHandler.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L16) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/util/NamedHandler.ts:20 +[packages/matter.js/src/util/NamedHandler.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L20) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -packages/matter.js/src/util/NamedHandler.ts:12 +[packages/matter.js/src/util/NamedHandler.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L12) ___ @@ -154,4 +154,4 @@ ___ #### Defined in -packages/matter.js/src/util/NamedHandler.ts:28 +[packages/matter.js/src/util/NamedHandler.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L28) diff --git a/docs/matter.js/classes/util_export.Queue.md b/docs/matter.js/classes/util_export.Queue.md index 1506590cae..5a1ed15636 100644 --- a/docs/matter.js/classes/util_export.Queue.md +++ b/docs/matter.js/classes/util_export.Queue.md @@ -52,7 +52,7 @@ #### Defined in -packages/matter.js/src/util/Queue.ts:17 +[packages/matter.js/src/util/Queue.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Queue.ts#L17) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/matter.js/src/util/Queue.ts:16 +[packages/matter.js/src/util/Queue.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Queue.ts#L16) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/util/Queue.ts:15 +[packages/matter.js/src/util/Queue.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Queue.ts#L15) ## Methods @@ -94,7 +94,7 @@ packages/matter.js/src/util/Queue.ts:15 #### Defined in -packages/matter.js/src/util/Queue.ts:46 +[packages/matter.js/src/util/Queue.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Queue.ts#L46) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/util/Queue.ts:19 +[packages/matter.js/src/util/Queue.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Queue.ts#L19) ___ @@ -142,4 +142,4 @@ ___ #### Defined in -packages/matter.js/src/util/Queue.ts:35 +[packages/matter.js/src/util/Queue.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Queue.ts#L35) diff --git a/docs/matter.js/enums/cluster_export.AccessControl.AccessControlEntryAuthMode.md b/docs/matter.js/enums/cluster_export.AccessControl.AccessControlEntryAuthMode.md index 8832be19bd..783d6e2c4f 100644 --- a/docs/matter.js/enums/cluster_export.AccessControl.AccessControlEntryAuthMode.md +++ b/docs/matter.js/enums/cluster_export.AccessControl.AccessControlEntryAuthMode.md @@ -26,7 +26,7 @@ Certificate authenticated session #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:90 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L90) ___ @@ -38,7 +38,7 @@ Group authenticated session #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:95 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L95) ___ @@ -50,4 +50,4 @@ Passcode authenticated session #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:85 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L85) diff --git a/docs/matter.js/enums/cluster_export.AccessControl.AccessControlEntryPrivilege.md b/docs/matter.js/enums/cluster_export.AccessControl.AccessControlEntryPrivilege.md index 103adb5fb9..d7ccf45167 100644 --- a/docs/matter.js/enums/cluster_export.AccessControl.AccessControlEntryPrivilege.md +++ b/docs/matter.js/enums/cluster_export.AccessControl.AccessControlEntryPrivilege.md @@ -38,7 +38,7 @@ This value implicitly grants Manage, Operate, Proxy View & View privileges #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:75 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L75) ___ @@ -56,7 +56,7 @@ This value implicitly grants Operate & View privileges #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:66 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L66) ___ @@ -74,7 +74,7 @@ This value implicitly grants View privileges #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:57 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L57) ___ @@ -86,7 +86,7 @@ Can read and observe all (as seen by a Proxy) #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:48 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L48) ___ @@ -98,4 +98,4 @@ Can read and observe all (except Access Control Cluster and as seen by a non-Pro #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:43 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L43) diff --git a/docs/matter.js/enums/cluster_export.AccessControl.ChangeType.md b/docs/matter.js/enums/cluster_export.AccessControl.ChangeType.md index bd4fc753d4..89f61ab6ce 100644 --- a/docs/matter.js/enums/cluster_export.AccessControl.ChangeType.md +++ b/docs/matter.js/enums/cluster_export.AccessControl.ChangeType.md @@ -26,7 +26,7 @@ Entry or extension was added #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:243 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:243](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L243) ___ @@ -38,7 +38,7 @@ Entry or extension was changed #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:238 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L238) ___ @@ -50,4 +50,4 @@ Entry or extension was removed #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:248 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:248](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L248) diff --git a/docs/matter.js/enums/cluster_export.AccessLevel.md b/docs/matter.js/enums/cluster_export.AccessLevel.md index 3fba1ea27d..a5ac03b4a6 100644 --- a/docs/matter.js/enums/cluster_export.AccessLevel.md +++ b/docs/matter.js/enums/cluster_export.AccessLevel.md @@ -21,7 +21,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:29 +[packages/matter.js/src/cluster/Cluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L29) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:28 +[packages/matter.js/src/cluster/Cluster.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L28) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:27 +[packages/matter.js/src/cluster/Cluster.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L27) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:26 +[packages/matter.js/src/cluster/Cluster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L26) diff --git a/docs/matter.js/enums/cluster_export.Actions.ActionError.md b/docs/matter.js/enums/cluster_export.Actions.ActionError.md index dfbd7b2c5d..db4d4d8a90 100644 --- a/docs/matter.js/enums/cluster_export.Actions.ActionError.md +++ b/docs/matter.js/enums/cluster_export.Actions.ActionError.md @@ -25,7 +25,7 @@ The action was interrupted by another command or interaction #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:508 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:508](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L508) ___ @@ -37,4 +37,4 @@ Other reason not listed in the row(s) below #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:503 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:503](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L503) diff --git a/docs/matter.js/enums/cluster_export.Actions.ActionState.md b/docs/matter.js/enums/cluster_export.Actions.ActionState.md index 3005cc2c39..35a2b2b331 100644 --- a/docs/matter.js/enums/cluster_export.Actions.ActionState.md +++ b/docs/matter.js/enums/cluster_export.Actions.ActionState.md @@ -29,7 +29,7 @@ The action is active #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:192 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L192) ___ @@ -41,7 +41,7 @@ The action has been disabled #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:202 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L202) ___ @@ -53,7 +53,7 @@ The action is not active #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:187 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:187](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L187) ___ @@ -65,4 +65,4 @@ The action has been paused #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:197 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L197) diff --git a/docs/matter.js/enums/cluster_export.Actions.ActionType.md b/docs/matter.js/enums/cluster_export.Actions.ActionType.md index 4e690dbfaa..1a27e80657 100644 --- a/docs/matter.js/enums/cluster_export.Actions.ActionType.md +++ b/docs/matter.js/enums/cluster_export.Actions.ActionType.md @@ -39,7 +39,7 @@ Example: flash all lights in the house when CO sensor triggers. #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:108 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L108) ___ @@ -58,7 +58,7 @@ started, stopped, paused, resumed. Example: see example 3. #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:72 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L72) ___ @@ -80,7 +80,7 @@ Example: lock the doors when the server’s system has detected no one is at hom #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:85 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L85) ___ @@ -100,7 +100,7 @@ Example: play a pattern on the lights in the living room if there is someone in #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:96 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L96) ___ @@ -112,7 +112,7 @@ Use this only when none of the other values applies #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:34 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L34) ___ @@ -137,7 +137,7 @@ Example: see examples 1 and 2. #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:50 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L50) ___ @@ -158,4 +158,4 @@ Example: see example 4. #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:62 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L62) diff --git a/docs/matter.js/enums/cluster_export.Actions.EndpointListType.md b/docs/matter.js/enums/cluster_export.Actions.EndpointListType.md index 58daa904a6..d0930a254f 100644 --- a/docs/matter.js/enums/cluster_export.Actions.EndpointListType.md +++ b/docs/matter.js/enums/cluster_export.Actions.EndpointListType.md @@ -37,7 +37,7 @@ not use this for anything else than just to know which endpoints would be affect #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:278 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:278](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L278) ___ @@ -59,7 +59,7 @@ adds a bridged device or creates a new room). #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:291 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L291) ___ @@ -82,4 +82,4 @@ control as a group, so Matter controllers could provide the user with a way to d #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:305 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L305) diff --git a/docs/matter.js/enums/cluster_export.AdministratorCommissioning.CommissioningWindowStatus.md b/docs/matter.js/enums/cluster_export.AdministratorCommissioning.CommissioningWindowStatus.md index 0350cc1187..a012094c43 100644 --- a/docs/matter.js/enums/cluster_export.AdministratorCommissioning.CommissioningWindowStatus.md +++ b/docs/matter.js/enums/cluster_export.AdministratorCommissioning.CommissioningWindowStatus.md @@ -26,7 +26,7 @@ A Basic Commissioning Method window is open #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:39 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L39) ___ @@ -38,7 +38,7 @@ An Enhanced Commissioning Method window is open #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:34 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L34) ___ @@ -50,4 +50,4 @@ Commissioning window not open #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:29 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L29) diff --git a/docs/matter.js/enums/cluster_export.AdministratorCommissioning.Feature.md b/docs/matter.js/enums/cluster_export.AdministratorCommissioning.Feature.md index 707b33ec4a..02efd6e427 100644 --- a/docs/matter.js/enums/cluster_export.AdministratorCommissioning.Feature.md +++ b/docs/matter.js/enums/cluster_export.AdministratorCommissioning.Feature.md @@ -28,4 +28,4 @@ Node supports Basic Commissioning Method. #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:151 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L151) diff --git a/docs/matter.js/enums/cluster_export.AdministratorCommissioning.StatusCode.md b/docs/matter.js/enums/cluster_export.AdministratorCommissioning.StatusCode.md index e97bd9e7fd..e6f6c512eb 100644 --- a/docs/matter.js/enums/cluster_export.AdministratorCommissioning.StatusCode.md +++ b/docs/matter.js/enums/cluster_export.AdministratorCommissioning.StatusCode.md @@ -26,7 +26,7 @@ Could not be completed because another commissioning is in progress #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:116 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L116) ___ @@ -42,7 +42,7 @@ Provided PAKE parameters were incorrectly formatted or otherwise invalid #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:123 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L123) ___ @@ -58,4 +58,4 @@ No commissioning window was currently open #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:130 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L130) diff --git a/docs/matter.js/enums/cluster_export.ApplicationBasic.ApplicationStatus.md b/docs/matter.js/enums/cluster_export.ApplicationBasic.ApplicationStatus.md index 41b6fc670d..bb8d4472a7 100644 --- a/docs/matter.js/enums/cluster_export.ApplicationBasic.ApplicationStatus.md +++ b/docs/matter.js/enums/cluster_export.ApplicationBasic.ApplicationStatus.md @@ -27,7 +27,7 @@ Application is running but not visible to the user. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:65 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L65) ___ @@ -39,7 +39,7 @@ Application is running, is visible to the user, and is the active target for inp #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:60 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L60) ___ @@ -51,7 +51,7 @@ Application is running and visible, but is not the active target for input. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:70 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L70) ___ @@ -63,4 +63,4 @@ Application is not running. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:55 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L55) diff --git a/docs/matter.js/enums/cluster_export.ApplicationLauncher.Feature.md b/docs/matter.js/enums/cluster_export.ApplicationLauncher.Feature.md index 6cdae6756c..42eded345a 100644 --- a/docs/matter.js/enums/cluster_export.ApplicationLauncher.Feature.md +++ b/docs/matter.js/enums/cluster_export.ApplicationLauncher.Feature.md @@ -29,4 +29,4 @@ supported application catalogs #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:165 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L165) diff --git a/docs/matter.js/enums/cluster_export.ApplicationLauncher.Status.md b/docs/matter.js/enums/cluster_export.ApplicationLauncher.Status.md index a0b78c636a..411bf0cfba 100644 --- a/docs/matter.js/enums/cluster_export.ApplicationLauncher.Status.md +++ b/docs/matter.js/enums/cluster_export.ApplicationLauncher.Status.md @@ -26,7 +26,7 @@ Requested app is not available. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:96 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L96) ___ @@ -38,7 +38,7 @@ Command succeeded #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:91 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L91) ___ @@ -50,4 +50,4 @@ Video platform unable to honor command. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:101 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L101) diff --git a/docs/matter.js/enums/cluster_export.AudioOutput.Feature.md b/docs/matter.js/enums/cluster_export.AudioOutput.Feature.md index b232bb7beb..4259f4a84f 100644 --- a/docs/matter.js/enums/cluster_export.AudioOutput.Feature.md +++ b/docs/matter.js/enums/cluster_export.AudioOutput.Feature.md @@ -28,4 +28,4 @@ Supports updates to output names #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:91 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L91) diff --git a/docs/matter.js/enums/cluster_export.AudioOutput.OutputType.md b/docs/matter.js/enums/cluster_export.AudioOutput.OutputType.md index ac11e7a1b2..fdbb35a1cb 100644 --- a/docs/matter.js/enums/cluster_export.AudioOutput.OutputType.md +++ b/docs/matter.js/enums/cluster_export.AudioOutput.OutputType.md @@ -29,7 +29,7 @@ The type of output, expressed as an enum, with the following values: #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:30 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L30) ___ @@ -41,7 +41,7 @@ HDMI #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:28 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L28) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:32 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L32) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:33 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L33) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:31 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L31) ___ @@ -81,4 +81,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:34 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L34) diff --git a/docs/matter.js/enums/cluster_export.BasicInformation.Color.md b/docs/matter.js/enums/cluster_export.BasicInformation.Color.md index bef2dbe413..335355ed9e 100644 --- a/docs/matter.js/enums/cluster_export.BasicInformation.Color.md +++ b/docs/matter.js/enums/cluster_export.BasicInformation.Color.md @@ -38,7 +38,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:81 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L81) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:71 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L71) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:79 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L79) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:88 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L88) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:87 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L87) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:89 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L89) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:83 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L83) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:91 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L91) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:78 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L78) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:73 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L73) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:80 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L80) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:75 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L75) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:72 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L72) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:86 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L86) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:77 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L77) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:76 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L76) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:82 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L82) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:90 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L90) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:74 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L74) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:85 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L85) ___ @@ -238,4 +238,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:84 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L84) diff --git a/docs/matter.js/enums/cluster_export.BasicInformation.ProductFinish.md b/docs/matter.js/enums/cluster_export.BasicInformation.ProductFinish.md index 42e2baffc6..9319d0722e 100644 --- a/docs/matter.js/enums/cluster_export.BasicInformation.ProductFinish.md +++ b/docs/matter.js/enums/cluster_export.BasicInformation.ProductFinish.md @@ -23,7 +23,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:67 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L67) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:63 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L63) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:62 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L62) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:65 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L65) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:66 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L66) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:64 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L64) diff --git a/docs/matter.js/enums/cluster_export.BridgedDeviceBasicInformation.Color.md b/docs/matter.js/enums/cluster_export.BridgedDeviceBasicInformation.Color.md index 4728c1d4b3..f13831dd5a 100644 --- a/docs/matter.js/enums/cluster_export.BridgedDeviceBasicInformation.Color.md +++ b/docs/matter.js/enums/cluster_export.BridgedDeviceBasicInformation.Color.md @@ -38,7 +38,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:50 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L49) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:40 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L39) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:48 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L47) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:57 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L56) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:56 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L55) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:58 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L57) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:52 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L51) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:60 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L59) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:47 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L46) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:42 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L41) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:49 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L48) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:44 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L43) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:41 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L40) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:55 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L54) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:46 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L45) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:45 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L44) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:51 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L50) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:59 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L58) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:43 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L42) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:54 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L53) ___ @@ -238,4 +238,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:53 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L52) diff --git a/docs/matter.js/enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md b/docs/matter.js/enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md index 3509e4f41d..b903e01bd3 100644 --- a/docs/matter.js/enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md +++ b/docs/matter.js/enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md @@ -23,7 +23,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:36 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L35) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:32 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L31) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:31 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L30) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:34 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L33) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:35 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L34) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:33 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L32) diff --git a/docs/matter.js/enums/cluster_export.Channel.Feature.md b/docs/matter.js/enums/cluster_export.Channel.Feature.md index aea64821f8..7c112c910a 100644 --- a/docs/matter.js/enums/cluster_export.Channel.Feature.md +++ b/docs/matter.js/enums/cluster_export.Channel.Feature.md @@ -29,7 +29,7 @@ Provides list of available channels. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:207 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L207) ___ @@ -43,4 +43,4 @@ Provides lineup info, which is a reference to an external source of lineup infor #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:214 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L214) diff --git a/docs/matter.js/enums/cluster_export.Channel.LineupInfoType.md b/docs/matter.js/enums/cluster_export.Channel.LineupInfoType.md index 89a58d9a85..87136781e4 100644 --- a/docs/matter.js/enums/cluster_export.Channel.LineupInfoType.md +++ b/docs/matter.js/enums/cluster_export.Channel.LineupInfoType.md @@ -24,4 +24,4 @@ MultiSystemOperator #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:113 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L113) diff --git a/docs/matter.js/enums/cluster_export.Channel.Status.md b/docs/matter.js/enums/cluster_export.Channel.Status.md index 2f7ccd6048..10906f386b 100644 --- a/docs/matter.js/enums/cluster_export.Channel.Status.md +++ b/docs/matter.js/enums/cluster_export.Channel.Status.md @@ -26,7 +26,7 @@ More than one equal match for the ChannelInfoStruct passed in. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:167 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L167) ___ @@ -38,7 +38,7 @@ No matches for the ChannelInfoStruct passed in. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:172 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L172) ___ @@ -50,4 +50,4 @@ Command succeeded #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:162 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L162) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.Action.md b/docs/matter.js/enums/cluster_export.ColorControl.Action.md index a721a39443..77975a4118 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.Action.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.Action.md @@ -26,7 +26,7 @@ The value of ColorControl.action #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:675 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:675](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L675) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:676 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:676](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L676) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:674 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:674](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L674) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.ColorControlDirection.md b/docs/matter.js/enums/cluster_export.ColorControl.ColorControlDirection.md index e209ebc281..198a9ff28a 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.ColorControlDirection.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.ColorControlDirection.md @@ -25,7 +25,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:121 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L121) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:119 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L119) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:118 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L118) ___ @@ -55,4 +55,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:120 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L120) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.ColorLoopSetDirection.md b/docs/matter.js/enums/cluster_export.ColorControl.ColorLoopSetDirection.md index 537777c58b..485604044f 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.ColorLoopSetDirection.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.ColorLoopSetDirection.md @@ -25,7 +25,7 @@ The value of ColorControl.direction #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:685 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:685](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L685) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:686 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:686](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L686) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.ColorMode.md b/docs/matter.js/enums/cluster_export.ColorControl.ColorMode.md index 806d98e562..69ada9f812 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.ColorMode.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.ColorMode.md @@ -26,7 +26,7 @@ The value of the ColorControl colorMode attribute #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:50 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L50) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:48 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L48) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:49 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L49) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.DriftCompensation.md b/docs/matter.js/enums/cluster_export.ColorControl.DriftCompensation.md index f2197c32dc..7c2d1cfd3a 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.DriftCompensation.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.DriftCompensation.md @@ -28,7 +28,7 @@ The value of the ColorControl driftCompensation attribute #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:35 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L35) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:39 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L39) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:38 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L38) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:36 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L36) ___ @@ -68,4 +68,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:37 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L37) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.EnhancedColorMode.md b/docs/matter.js/enums/cluster_export.ColorControl.EnhancedColorMode.md index 4c72c2ece2..d944920f3d 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.EnhancedColorMode.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.EnhancedColorMode.md @@ -27,7 +27,7 @@ The value of the ColorControl enhancedColorMode attribute #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:68 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L68) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:66 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L66) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:67 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L67) ___ @@ -57,4 +57,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:69 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L69) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.Feature.md b/docs/matter.js/enums/cluster_export.ColorControl.Feature.md index fe7135bacb..b1c9708671 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.Feature.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.Feature.md @@ -32,7 +32,7 @@ Color loop is supported. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:788 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:788](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L788) ___ @@ -46,7 +46,7 @@ Supports specification of color temperature. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:802 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:802](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L802) ___ @@ -60,7 +60,7 @@ Enhanced hue is supported. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:781 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:781](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L781) ___ @@ -74,7 +74,7 @@ Supports color specification via hue/saturation. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:774 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:774](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L774) ___ @@ -88,4 +88,4 @@ Supports color specification via XY. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:795 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:795](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L795) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.MoveMode.md b/docs/matter.js/enums/cluster_export.ColorControl.MoveMode.md index 3fe8683c0b..f075019432 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.MoveMode.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.MoveMode.md @@ -24,7 +24,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:162 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L162) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:160 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L160) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:161 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L161) diff --git a/docs/matter.js/enums/cluster_export.ColorControl.StepMode.md b/docs/matter.js/enums/cluster_export.ColorControl.StepMode.md index 4bf280c618..251917cafc 100644 --- a/docs/matter.js/enums/cluster_export.ColorControl.StepMode.md +++ b/docs/matter.js/enums/cluster_export.ColorControl.StepMode.md @@ -23,7 +23,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:198 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L198) ___ @@ -33,4 +33,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:197 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L197) diff --git a/docs/matter.js/enums/cluster_export.ContentLauncher.Feature.md b/docs/matter.js/enums/cluster_export.ContentLauncher.Feature.md index 44279a9ec4..c48a802860 100644 --- a/docs/matter.js/enums/cluster_export.ContentLauncher.Feature.md +++ b/docs/matter.js/enums/cluster_export.ContentLauncher.Feature.md @@ -29,7 +29,7 @@ Device supports content search (non-app specific) #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:443 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:443](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L443) ___ @@ -43,4 +43,4 @@ Device supports basic URL-based file playback #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:450 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:450](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L450) diff --git a/docs/matter.js/enums/cluster_export.ContentLauncher.MetricType.md b/docs/matter.js/enums/cluster_export.ContentLauncher.MetricType.md index 750375a66b..1c19a08a8c 100644 --- a/docs/matter.js/enums/cluster_export.ContentLauncher.MetricType.md +++ b/docs/matter.js/enums/cluster_export.ContentLauncher.MetricType.md @@ -33,7 +33,7 @@ integer final value. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:57 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L57) ___ @@ -49,4 +49,4 @@ This value is used for dimensions defined in a number of Pixels. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:46 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L46) diff --git a/docs/matter.js/enums/cluster_export.ContentLauncher.Parameter.md b/docs/matter.js/enums/cluster_export.ContentLauncher.Parameter.md index c45f13d882..fd95be3f94 100644 --- a/docs/matter.js/enums/cluster_export.ContentLauncher.Parameter.md +++ b/docs/matter.js/enums/cluster_export.ContentLauncher.Parameter.md @@ -37,7 +37,7 @@ Actor represents an actor credited in video media content; for example, “Gaby #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:261 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:261](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L261) ___ @@ -49,7 +49,7 @@ Channel represents the identifying data for a television channel; for example, " #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:266 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:266](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L266) ___ @@ -61,7 +61,7 @@ A character represented in video media content; for example, “Snow White” #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:271 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L271) ___ @@ -73,7 +73,7 @@ A director of the video media content; for example, “Spike Lee” #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:276 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:276](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L276) ___ @@ -87,7 +87,7 @@ entity. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:283 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L283) ___ @@ -103,7 +103,7 @@ of the MOVIE MediaType, rather than attempting to match to a single title. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:292 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:292](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L292) ___ @@ -115,7 +115,7 @@ Genre represents the genre of video media content such as action, drama or comed #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:297 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:297](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L297) ___ @@ -127,7 +127,7 @@ League represents the categorical information for a sporting league; for example #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:302 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:302](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L302) ___ @@ -139,7 +139,7 @@ Popularity indicates whether the user asks for popular content. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:307 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:307](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L307) ___ @@ -151,7 +151,7 @@ The provider (MSP) the user wants this media to be played on; for example, "Netf #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:312 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:312](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L312) ___ @@ -163,7 +163,7 @@ Sport represents the categorical information of a sport; for example, football #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:317 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:317](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L317) ___ @@ -176,7 +176,7 @@ Washington Huskies" #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:323 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:323](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L323) ___ @@ -189,7 +189,7 @@ The type of content requested. Supported types are "Movie", "MovieSeries", "TVSe #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:329 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:329](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L329) ___ @@ -202,4 +202,4 @@ Sea". #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:335 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:335](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L335) diff --git a/docs/matter.js/enums/cluster_export.ContentLauncher.Status.md b/docs/matter.js/enums/cluster_export.ContentLauncher.Status.md index f919c9006d..090e7717cf 100644 --- a/docs/matter.js/enums/cluster_export.ContentLauncher.Status.md +++ b/docs/matter.js/enums/cluster_export.ContentLauncher.Status.md @@ -26,7 +26,7 @@ Requested URL returned 401 error code. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:228 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:228](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L228) ___ @@ -38,7 +38,7 @@ Command succeeded #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:218 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:218](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L218) ___ @@ -50,4 +50,4 @@ Requested URL could not be reached by device. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:223 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L223) diff --git a/docs/matter.js/enums/cluster_export.DiagnosticLogs.Intent.md b/docs/matter.js/enums/cluster_export.DiagnosticLogs.Intent.md index e7e6ea60d1..875e2262ee 100644 --- a/docs/matter.js/enums/cluster_export.DiagnosticLogs.Intent.md +++ b/docs/matter.js/enums/cluster_export.DiagnosticLogs.Intent.md @@ -33,7 +33,7 @@ Node. #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:49 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L49) ___ @@ -52,7 +52,7 @@ support to an end-user. #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:29 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L29) ___ @@ -71,4 +71,4 @@ currently commissioned (and/or connected) or has previously been commissioned (a #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:39 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L39) diff --git a/docs/matter.js/enums/cluster_export.DiagnosticLogs.Status.md b/docs/matter.js/enums/cluster_export.DiagnosticLogs.Status.md index e192c08aff..252ecbfaf0 100644 --- a/docs/matter.js/enums/cluster_export.DiagnosticLogs.Status.md +++ b/docs/matter.js/enums/cluster_export.DiagnosticLogs.Status.md @@ -35,7 +35,7 @@ Client SHOULD re-attempt the request later. #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:180 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L180) ___ @@ -53,7 +53,7 @@ shall be used if the Node is denying the current transfer of diagnostic logs for #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:189 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:189](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L189) ___ @@ -73,7 +73,7 @@ LogContent field. #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:160 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L160) ___ @@ -92,7 +92,7 @@ transfer. #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:170 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L170) ___ @@ -110,4 +110,4 @@ shall be used if diagnostic logs will be or are being transferred. #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:149 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L149) diff --git a/docs/matter.js/enums/cluster_export.DiagnosticLogs.TransferProtocol.md b/docs/matter.js/enums/cluster_export.DiagnosticLogs.TransferProtocol.md index 806836c06a..c25ef5d572 100644 --- a/docs/matter.js/enums/cluster_export.DiagnosticLogs.TransferProtocol.md +++ b/docs/matter.js/enums/cluster_export.DiagnosticLogs.TransferProtocol.md @@ -31,7 +31,7 @@ shall be used by a Client to request that logs are transferred using BDX as defi #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:72 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L72) ___ @@ -49,4 +49,4 @@ shall be used by a Client to request that logs are transferred using the LogCont #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:63 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L63) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.AlarmCode.md b/docs/matter.js/enums/cluster_export.DoorLock.AlarmCode.md index 0a3323b5bd..913d9380f5 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.AlarmCode.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.AlarmCode.md @@ -33,7 +33,7 @@ Door ajar #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:291 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L291) ___ @@ -45,7 +45,7 @@ Forced Door Open under Door Locked Condition #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:286 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:286](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L286) ___ @@ -57,7 +57,7 @@ Force User SOS alarm #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:296 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L296) ___ @@ -69,7 +69,7 @@ Tamper Alarm - front escutcheon removed from main #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:281 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:281](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L281) ___ @@ -81,7 +81,7 @@ Lock Reset to Factory Defaults #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:266 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:266](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L266) ___ @@ -93,7 +93,7 @@ Locking Mechanism Jammed #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:261 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:261](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L261) ___ @@ -105,7 +105,7 @@ Lock Radio Power Cycled #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:271 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L271) ___ @@ -117,4 +117,4 @@ Tamper Alarm - wrong code entry limit #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:276 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:276](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L276) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.CredentialRule.md b/docs/matter.js/enums/cluster_export.DoorLock.CredentialRule.md index d7f91ba5dd..44e0d4d533 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.CredentialRule.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.CredentialRule.md @@ -27,7 +27,7 @@ particular user. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:709 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:709](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L709) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:708 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:708](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L708) ___ @@ -47,4 +47,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:710 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:710](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L710) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.CredentialType.md b/docs/matter.js/enums/cluster_export.DoorLock.CredentialType.md index 14599319e4..eae10841cd 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.CredentialType.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.CredentialType.md @@ -29,7 +29,7 @@ The Credential Type enum shall indicate the credential type. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:361 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:361](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L361) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:360 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:360](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L360) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:359 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:359](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L359) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:357 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:357](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L357) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:356 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L356) ___ @@ -79,4 +79,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:358 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:358](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L358) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.DataOperationType.md b/docs/matter.js/enums/cluster_export.DoorLock.DataOperationType.md index 46279b9078..cc70525959 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.DataOperationType.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.DataOperationType.md @@ -28,7 +28,7 @@ Data is being added or was added #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:588 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:588](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L588) ___ @@ -40,7 +40,7 @@ Data is being cleared or was cleared #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:593 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:593](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L593) ___ @@ -52,4 +52,4 @@ Data is being modified or was modified #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:598 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:598](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L598) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.DlStatus.md b/docs/matter.js/enums/cluster_export.DoorLock.DlStatus.md index 442f1311a0..cc454ce5fe 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.DlStatus.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.DlStatus.md @@ -24,7 +24,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:775 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:775](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L775) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:774 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:774](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L774) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:777 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:777](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L777) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:779 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:779](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L779) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:776 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:776](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L776) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:778 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:778](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L778) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:773 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:773](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L773) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.DoorState.md b/docs/matter.js/enums/cluster_export.DoorLock.DoorState.md index 3f392d2339..848bcd28ac 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.DoorState.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.DoorState.md @@ -33,7 +33,7 @@ Door state is ajar #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:555 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:555](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L555) ___ @@ -45,7 +45,7 @@ Door state is closed #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:535 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:535](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L535) ___ @@ -57,7 +57,7 @@ Door state is currently forced open #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:545 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:545](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L545) ___ @@ -69,7 +69,7 @@ Door state is jammed #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:540 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:540](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L540) ___ @@ -81,7 +81,7 @@ Door state is open #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:530 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:530](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L530) ___ @@ -93,4 +93,4 @@ Door state is invalid for unspecified reason #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:550 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:550](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L550) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.Feature.md b/docs/matter.js/enums/cluster_export.DoorLock.Feature.md index 1049224e92..cb13eb56f3 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.Feature.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.Feature.md @@ -39,7 +39,7 @@ PIN codes over- the-air supported for lock/unlock operations #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1245 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1245](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1245) ___ @@ -53,7 +53,7 @@ Lock supports a door position sensor that indicates door’s state #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1231 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1231) ___ @@ -67,7 +67,7 @@ Lock supports face related credentials (face, iris, retina) #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1238 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1238) ___ @@ -81,7 +81,7 @@ Lock supports finger related credentials (fingerprint, finger vein) #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1210 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1210](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1210) ___ @@ -95,7 +95,7 @@ Lock supports holiday schedules #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1273 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1273) ___ @@ -109,7 +109,7 @@ Lock supports local/on-lock logging when Events are not supported #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1217 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1217) ___ @@ -123,7 +123,7 @@ Operation and Programming Notifications #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1259 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1259](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1259) ___ @@ -137,7 +137,7 @@ Lock supports PIN credentials (via keypad, or over- the-air) #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1196 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1196) ___ @@ -151,7 +151,7 @@ Lock supports RFID credentials #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1203 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1203](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1203) ___ @@ -165,7 +165,7 @@ Lock supports the user commands and database #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1252 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1252](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1252) ___ @@ -179,7 +179,7 @@ Lock supports week day user access schedules #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1224 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1224) ___ @@ -193,4 +193,4 @@ Lock supports year day user access schedules #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1266 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1266](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1266) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.LockDataType.md b/docs/matter.js/enums/cluster_export.DoorLock.LockDataType.md index a20337cf81..a704e9da05 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.LockDataType.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.LockDataType.md @@ -36,7 +36,7 @@ Lock user face information was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:875 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:875](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L875) ___ @@ -48,7 +48,7 @@ Lock user finger-vein information was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:870 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:870](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L870) ___ @@ -60,7 +60,7 @@ Lock user fingerprint was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:865 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:865](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L865) ___ @@ -72,7 +72,7 @@ Lock holiday schedule was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:850 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:850](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L850) ___ @@ -84,7 +84,7 @@ Lock user PIN code was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:855 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:855](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L855) ___ @@ -96,7 +96,7 @@ Lock programming PIN code was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:830 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:830](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L830) ___ @@ -108,7 +108,7 @@ Lock user RFID code was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:860 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:860](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L860) ___ @@ -120,7 +120,7 @@ Unspecified or manufacturer specific lock user data added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:825 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:825](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L825) ___ @@ -132,7 +132,7 @@ Lock user index was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:835 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:835](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L835) ___ @@ -144,7 +144,7 @@ Lock user week day schedule was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:840 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:840](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L840) ___ @@ -156,4 +156,4 @@ Lock user year day schedule was added, cleared, or modified. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:845 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:845](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L845) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.LockOperationType.md b/docs/matter.js/enums/cluster_export.DoorLock.LockOperationType.md index 53d3f6051d..f8ef859f7b 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.LockOperationType.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.LockOperationType.md @@ -27,7 +27,7 @@ The LockOperationType enumeration shall indicate the type of Lock operation perf #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:322 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:322](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L322) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:319 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L319) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:321 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:321](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L321) ___ @@ -57,4 +57,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:320 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:320](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L320) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.LockState.md b/docs/matter.js/enums/cluster_export.DoorLock.LockState.md index bb35956cda..4f15deb500 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.LockState.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.LockState.md @@ -28,7 +28,7 @@ Lock state is fully locked #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:50 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L50) ___ @@ -40,7 +40,7 @@ Lock state is not fully locked #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:45 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L45) ___ @@ -52,4 +52,4 @@ Lock state is fully unlocked #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:55 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L55) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.LockType.md b/docs/matter.js/enums/cluster_export.DoorLock.LockType.md index 61ff3f591e..d96372ee37 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.LockType.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.LockType.md @@ -36,7 +36,7 @@ Physical lock type is cylindrical lock #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:97 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L97) ___ @@ -48,7 +48,7 @@ Physical lock type is dead latch #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:112 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L112) ___ @@ -60,7 +60,7 @@ Physical lock type is dead bolt #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:67 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L67) ___ @@ -72,7 +72,7 @@ Physical lock type is door furniture #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:117 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L117) ___ @@ -84,7 +84,7 @@ Physical lock type is interconnected lock #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:107 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L107) ___ @@ -96,7 +96,7 @@ Physical lock type is latch bolt #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:92 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L92) ___ @@ -108,7 +108,7 @@ Physical lock type is magnetic #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:72 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L72) ___ @@ -120,7 +120,7 @@ Physical lock type is mortise #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:82 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L82) ___ @@ -132,7 +132,7 @@ Physical lock type is other #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:77 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L77) ___ @@ -144,7 +144,7 @@ Physical lock type is rim #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:87 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L87) ___ @@ -156,4 +156,4 @@ Physical lock type is tubular lock #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:102 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L102) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.OperatingMode.md b/docs/matter.js/enums/cluster_export.DoorLock.OperatingMode.md index 21d2bb90e9..84afba7438 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.OperatingMode.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.OperatingMode.md @@ -43,7 +43,7 @@ Commands. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:163 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L163) ___ @@ -59,7 +59,7 @@ The lock operates normally. All interfaces are enabled. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:138 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L138) ___ @@ -76,7 +76,7 @@ validation (e.g. a lock for a business during work hours). #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:171 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L171) ___ @@ -94,7 +94,7 @@ users, presumably inside the property, will have control over the entrance. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:154 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L154) ___ @@ -110,4 +110,4 @@ Only remote interaction is enabled. The keypad shall only be operable by the mas #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:145 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L145) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.OperationError.md b/docs/matter.js/enums/cluster_export.DoorLock.OperationError.md index 3318448de9..56836447d0 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.OperationError.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.OperationError.md @@ -28,7 +28,7 @@ The OperationError enumeration shall indicate the error cause of the Lock/Unlock #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:451 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:451](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L451) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:453 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:453](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L453) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:450 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:450](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L450) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:452 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:452](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L452) ___ @@ -68,4 +68,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:449 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:449](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L449) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.OperationSource.md b/docs/matter.js/enums/cluster_export.DoorLock.OperationSource.md index afa8afd296..457bba6744 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.OperationSource.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.OperationSource.md @@ -40,7 +40,7 @@ For example, code of “1, 2, 3, 4” shall be represented as 0x31, 0x32, 0x33, #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:342 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:342](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L342) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:347 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:347](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L347) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:343 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L343) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:341 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:341](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L341) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:339 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L339) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:340 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:340](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L340) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:345 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:345](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L345) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:346 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:346](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L346) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:344 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:344](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L344) ___ @@ -130,4 +130,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:338 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L338) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.UserStatus.md b/docs/matter.js/enums/cluster_export.DoorLock.UserStatus.md index 9034e49c76..1c7ea4f0db 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.UserStatus.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.UserStatus.md @@ -26,7 +26,7 @@ The UserStatus enum used in various commands shall indicate what the status is f #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:607 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:607](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L607) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:609 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:609](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L609) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:608 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:608](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L608) diff --git a/docs/matter.js/enums/cluster_export.DoorLock.UserType.md b/docs/matter.js/enums/cluster_export.DoorLock.UserType.md index 7a929190f6..b9ee720647 100644 --- a/docs/matter.js/enums/cluster_export.DoorLock.UserType.md +++ b/docs/matter.js/enums/cluster_export.DoorLock.UserType.md @@ -40,7 +40,7 @@ UserStatus value to OccupiedDisabled automatically. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:671 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:671](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L671) ___ @@ -59,7 +59,7 @@ timeout across reboots such that the ExpiringUserTimeout is honored. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:681 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:681](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L681) ___ @@ -76,7 +76,7 @@ to allow a notified Node to alert emergency services or contacts on the user acc #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:663 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:663](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L663) ___ @@ -93,7 +93,7 @@ lock to generate the appropriate event notification to any bound devices. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:655 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:655](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L655) ___ @@ -111,7 +111,7 @@ only user that can disable the user interface (keypad, remote, etc…). #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:647 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:647](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L647) ___ @@ -130,7 +130,7 @@ over-the-air for the lock/unlock commands. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:698 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:698](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L698) ___ @@ -146,7 +146,7 @@ User access is restricted by Week Day and/or Year Day schedule. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:688 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:688](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L688) ___ @@ -162,7 +162,7 @@ User has access 24/7 provided proper PIN or RFID is supplied (e.g., owner). #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:623 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:623](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L623) ___ @@ -179,7 +179,7 @@ cleaning worker). #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:638 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:638](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L638) ___ @@ -195,4 +195,4 @@ User has ability to open lock within a specific time period (e.g., guest). #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:630 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:630](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L630) diff --git a/docs/matter.js/enums/cluster_export.EthernetNetworkDiagnostics.Feature.md b/docs/matter.js/enums/cluster_export.EthernetNetworkDiagnostics.Feature.md index 28a46d669a..b5b8e3e1dc 100644 --- a/docs/matter.js/enums/cluster_export.EthernetNetworkDiagnostics.Feature.md +++ b/docs/matter.js/enums/cluster_export.EthernetNetworkDiagnostics.Feature.md @@ -30,7 +30,7 @@ transmission of packets on the ethernet interface. #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:93 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L93) ___ @@ -44,4 +44,4 @@ Node makes available the counts for the number of received and transmitted packe #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:85 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L85) diff --git a/docs/matter.js/enums/cluster_export.EthernetNetworkDiagnostics.PHYRate.md b/docs/matter.js/enums/cluster_export.EthernetNetworkDiagnostics.PHYRate.md index 29d4a51ca1..b5c5dd61de 100644 --- a/docs/matter.js/enums/cluster_export.EthernetNetworkDiagnostics.PHYRate.md +++ b/docs/matter.js/enums/cluster_export.EthernetNetworkDiagnostics.PHYRate.md @@ -33,7 +33,7 @@ PHY rate is 100Gbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:61 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L61) ___ @@ -45,7 +45,7 @@ PHY rate is 100Mbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:31 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L31) ___ @@ -57,7 +57,7 @@ PHY rate is 10Gbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:51 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L51) ___ @@ -69,7 +69,7 @@ PHY rate is 10Mbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:26 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L26) ___ @@ -81,7 +81,7 @@ PHY rate is 1Gbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:36 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L36) ___ @@ -93,7 +93,7 @@ PHY rate is 200Gbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:66 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L66) ___ @@ -105,7 +105,7 @@ PHY rate is 2.5Gbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:41 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L41) ___ @@ -117,7 +117,7 @@ PHY rate is 400Gbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:71 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L71) ___ @@ -129,7 +129,7 @@ PHY rate is 40Gbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:56 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L56) ___ @@ -141,4 +141,4 @@ PHY rate is 5Gbps #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:46 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L46) diff --git a/docs/matter.js/enums/cluster_export.EventPriority.md b/docs/matter.js/enums/cluster_export.EventPriority.md index 9e23562732..2d0f367d3a 100644 --- a/docs/matter.js/enums/cluster_export.EventPriority.md +++ b/docs/matter.js/enums/cluster_export.EventPriority.md @@ -26,7 +26,7 @@ Interfaces and helper methods to define a cluster event #### Defined in -packages/matter.js/src/cluster/Cluster.ts:710 +[packages/matter.js/src/cluster/Cluster.ts:710](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L710) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:708 +[packages/matter.js/src/cluster/Cluster.ts:708](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L708) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:709 +[packages/matter.js/src/cluster/Cluster.ts:709](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L709) diff --git a/docs/matter.js/enums/cluster_export.FanControl.FanMode.md b/docs/matter.js/enums/cluster_export.FanControl.FanMode.md index 6f9e4a07ad..81e76f6e95 100644 --- a/docs/matter.js/enums/cluster_export.FanControl.FanMode.md +++ b/docs/matter.js/enums/cluster_export.FanControl.FanMode.md @@ -46,7 +46,7 @@ These attributes shall indicate the current state of the fan while this attribut #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:84 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L84) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:66 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L66) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:64 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L64) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:65 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L65) ___ @@ -126,7 +126,7 @@ corresponding range as defined in Speed Rules>: #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:62 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L62) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:67 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L67) ___ @@ -146,4 +146,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:86 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L86) diff --git a/docs/matter.js/enums/cluster_export.FanControl.FanModeSequence.md b/docs/matter.js/enums/cluster_export.FanControl.FanModeSequence.md index e3e0987136..030ae6de19 100644 --- a/docs/matter.js/enums/cluster_export.FanControl.FanModeSequence.md +++ b/docs/matter.js/enums/cluster_export.FanControl.FanModeSequence.md @@ -29,7 +29,7 @@ The value of the FanControl fanModeSequence attribute #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:96 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L96) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:98 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L98) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:95 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L95) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:97 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L97) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:100 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:100](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L100) ___ @@ -79,4 +79,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:99 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L99) diff --git a/docs/matter.js/enums/cluster_export.FanControl.Feature.md b/docs/matter.js/enums/cluster_export.FanControl.Feature.md index 07fb469c5e..1b7f561ab1 100644 --- a/docs/matter.js/enums/cluster_export.FanControl.Feature.md +++ b/docs/matter.js/enums/cluster_export.FanControl.Feature.md @@ -31,7 +31,7 @@ Automatic mode supported for fan speed #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:149 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L149) ___ @@ -45,7 +45,7 @@ MultiSpeed #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:142 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L142) ___ @@ -59,7 +59,7 @@ Rocking movement supported #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:156 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L156) ___ @@ -73,4 +73,4 @@ Wind emulation supported #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:163 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L163) diff --git a/docs/matter.js/enums/cluster_export.FaultInjection.FaultType.md b/docs/matter.js/enums/cluster_export.FaultInjection.FaultType.md index 8fefa55a5a..4a3481f7c1 100644 --- a/docs/matter.js/enums/cluster_export.FaultInjection.FaultType.md +++ b/docs/matter.js/enums/cluster_export.FaultInjection.FaultType.md @@ -22,7 +22,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:21 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L21) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:20 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L20) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:19 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L19) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:18 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L18) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:17 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L17) diff --git a/docs/matter.js/enums/cluster_export.GeneralCommissioning.CommissioningError.md b/docs/matter.js/enums/cluster_export.GeneralCommissioning.CommissioningError.md index 9f7d297ed0..94353043b0 100644 --- a/docs/matter.js/enums/cluster_export.GeneralCommissioning.CommissioningError.md +++ b/docs/matter.js/enums/cluster_export.GeneralCommissioning.CommissioningError.md @@ -31,7 +31,7 @@ associated with the current fail- safe context. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:112 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L112) ___ @@ -43,7 +43,7 @@ Executed CommissioningComplete outside CASE session. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:101 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L101) ___ @@ -55,7 +55,7 @@ Executed CommissioningComplete when there was no active Fail-Safe context. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:106 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L106) ___ @@ -67,7 +67,7 @@ No error #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:90 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L90) ___ @@ -80,4 +80,4 @@ have proper configuration. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:96 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L96) diff --git a/docs/matter.js/enums/cluster_export.GeneralCommissioning.RegulatoryLocationType.md b/docs/matter.js/enums/cluster_export.GeneralCommissioning.RegulatoryLocationType.md index b0daeba80c..83f5b1466c 100644 --- a/docs/matter.js/enums/cluster_export.GeneralCommissioning.RegulatoryLocationType.md +++ b/docs/matter.js/enums/cluster_export.GeneralCommissioning.RegulatoryLocationType.md @@ -29,7 +29,7 @@ Indoor only #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:58 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L58) ___ @@ -41,7 +41,7 @@ Indoor/Outdoor #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:68 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L68) ___ @@ -53,4 +53,4 @@ Outdoor only #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:63 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L63) diff --git a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.BootReason.md b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.BootReason.md index a10042f22b..73961c6e5d 100644 --- a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.BootReason.md +++ b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.BootReason.md @@ -30,7 +30,7 @@ The Node has rebooted as the result of a brown-out of the Node’s power supply. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:150 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L150) ___ @@ -42,7 +42,7 @@ The Node has rebooted as the result of a hardware watchdog timer. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:160 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L160) ___ @@ -54,7 +54,7 @@ The Node has booted as the result of physical interaction with the device result #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:145 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L145) ___ @@ -66,7 +66,7 @@ The Node has rebooted as the result of a software initiated reboot. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:170 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L170) ___ @@ -78,7 +78,7 @@ The Node has rebooted as the result of a completed software update. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:165 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L165) ___ @@ -90,7 +90,7 @@ The Node has rebooted as the result of a software watchdog timer. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:155 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L155) ___ @@ -102,4 +102,4 @@ The Node is unable to identify the Power-On reason as one of the other provided #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:140 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L140) diff --git a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.HardwareFault.md b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.HardwareFault.md index eadad0d944..fa5cc7bb44 100644 --- a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.HardwareFault.md +++ b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.HardwareFault.md @@ -34,7 +34,7 @@ The Node has encountered a fault with at least one of its audio outputs. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:215 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L215) ___ @@ -46,7 +46,7 @@ The Node has encountered an over-temperature fault that is not resettable. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:200 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L200) ___ @@ -58,7 +58,7 @@ The Node has encountered a fault with its non-volatile memory. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:225 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L225) ___ @@ -70,7 +70,7 @@ The Node has encountered a fault with at least one of its power sources. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:205 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:205](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L205) ___ @@ -82,7 +82,7 @@ The Node has encountered a fault with at least one of its radios. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:185 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:185](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L185) ___ @@ -94,7 +94,7 @@ The Node has encountered an over-temperature fault that is resettable. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:195 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:195](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L195) ___ @@ -106,7 +106,7 @@ The Node has encountered a fault with at least one of its sensors. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:190 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L190) ___ @@ -118,7 +118,7 @@ The Node has encountered disallowed physical tampering. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:230 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L230) ___ @@ -130,7 +130,7 @@ The Node has encountered an unspecified fault. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:180 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L180) ___ @@ -142,7 +142,7 @@ The Node has encountered a fault with at least one of its user interfaces. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:220 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L220) ___ @@ -154,4 +154,4 @@ The Node has encountered a fault with at least one of its visual displays. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:210 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:210](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L210) diff --git a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.InterfaceType.md b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.InterfaceType.md index 06d940fb68..e2c5943b4b 100644 --- a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.InterfaceType.md +++ b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.InterfaceType.md @@ -28,7 +28,7 @@ Indicates a Cellular interface. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:51 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L51) ___ @@ -40,7 +40,7 @@ Indicates a Ethernet interface. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:46 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L46) ___ @@ -52,7 +52,7 @@ Indicates a Thread interface. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:56 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L56) ___ @@ -64,7 +64,7 @@ Indicates an interface of an unspecified type. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:36 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L36) ___ @@ -76,4 +76,4 @@ Indicates a Wi-Fi interface. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:41 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L41) diff --git a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.NetworkFault.md b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.NetworkFault.md index c8cd417ade..7ff5a737c7 100644 --- a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.NetworkFault.md +++ b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.NetworkFault.md @@ -27,7 +27,7 @@ The Node has encountered a network fault as a result of a failure to establish a #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:295 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:295](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L295) ___ @@ -39,7 +39,7 @@ The Node has encountered a network fault as a result of a hardware failure. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:285 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:285](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L285) ___ @@ -51,7 +51,7 @@ The Node has encountered a network fault as a result of a jammed network. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:290 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:290](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L290) ___ @@ -63,4 +63,4 @@ The Node has encountered an unspecified fault. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:280 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:280](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L280) diff --git a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.RadioFault.md b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.RadioFault.md index 5eb769dd5b..4acd673959 100644 --- a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.RadioFault.md +++ b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.RadioFault.md @@ -30,7 +30,7 @@ The Node has encountered a fault with its BLE radio. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:265 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L265) ___ @@ -42,7 +42,7 @@ The Node has encountered a fault with its cellular radio. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:250 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:250](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L250) ___ @@ -54,7 +54,7 @@ The Node has encountered a fault with its Ethernet controller. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:270 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:270](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L270) ___ @@ -66,7 +66,7 @@ The Node has encountered a fault with its NFC radio. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:260 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:260](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L260) ___ @@ -78,7 +78,7 @@ The Node has encountered a fault with its802.15.4 radio. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:255 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:255](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L255) ___ @@ -90,7 +90,7 @@ The Node has encountered an unspecified radio fault. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:240 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L240) ___ @@ -102,4 +102,4 @@ The Node has encountered a fault with its Wi-Fi radio. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:245 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:245](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L245) diff --git a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.StatusCode.md b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.StatusCode.md index 6ccbc0887f..67f134f7fc 100644 --- a/docs/matter.js/enums/cluster_export.GeneralDiagnostics.StatusCode.md +++ b/docs/matter.js/enums/cluster_export.GeneralDiagnostics.StatusCode.md @@ -24,4 +24,4 @@ Provided EnableKey does not match the previously configured value. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:415 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:415](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L415) diff --git a/docs/matter.js/enums/cluster_export.GroupKeyManagement.Feature.md b/docs/matter.js/enums/cluster_export.GroupKeyManagement.Feature.md index a272d9385c..4611302e79 100644 --- a/docs/matter.js/enums/cluster_export.GroupKeyManagement.Feature.md +++ b/docs/matter.js/enums/cluster_export.GroupKeyManagement.Feature.md @@ -28,4 +28,4 @@ The ability to support CacheAndSync security policy and MCSP. #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:260 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:260](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L260) diff --git a/docs/matter.js/enums/cluster_export.GroupKeyManagement.GroupKeyMulticastPolicy.md b/docs/matter.js/enums/cluster_export.GroupKeyManagement.GroupKeyMulticastPolicy.md index 75aa6e556f..f33118fc99 100644 --- a/docs/matter.js/enums/cluster_export.GroupKeyManagement.GroupKeyMulticastPolicy.md +++ b/docs/matter.js/enums/cluster_export.GroupKeyManagement.GroupKeyMulticastPolicy.md @@ -31,7 +31,7 @@ The 16-bit Group Identifier of the Multicast Address shall be 0xFFFF. #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:117 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L117) ___ @@ -49,4 +49,4 @@ The 16-bit Group Identifier of the Multicast Address shall be the Group ID of th #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:108 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L108) diff --git a/docs/matter.js/enums/cluster_export.GroupKeyManagement.GroupKeySecurityPolicy.md b/docs/matter.js/enums/cluster_export.GroupKeyManagement.GroupKeySecurityPolicy.md index 10851031cb..414041686d 100644 --- a/docs/matter.js/enums/cluster_export.GroupKeyManagement.GroupKeySecurityPolicy.md +++ b/docs/matter.js/enums/cluster_export.GroupKeyManagement.GroupKeySecurityPolicy.md @@ -25,7 +25,7 @@ Message counter synchronization using cache-and-sync #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:94 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L94) ___ @@ -37,4 +37,4 @@ Message counter synchronization using trust-first #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:89 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L89) diff --git a/docs/matter.js/enums/cluster_export.Groups.Feature.md b/docs/matter.js/enums/cluster_export.Groups.Feature.md index 3c409943e7..7dddbfcb2d 100644 --- a/docs/matter.js/enums/cluster_export.Groups.Feature.md +++ b/docs/matter.js/enums/cluster_export.Groups.Feature.md @@ -28,4 +28,4 @@ The ability to store a name for a group. #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:152 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L152) diff --git a/docs/matter.js/enums/cluster_export.Identify.EffectIdentifier.md b/docs/matter.js/enums/cluster_export.Identify.EffectIdentifier.md index 5849a493f3..a381344460 100644 --- a/docs/matter.js/enums/cluster_export.Identify.EffectIdentifier.md +++ b/docs/matter.js/enums/cluster_export.Identify.EffectIdentifier.md @@ -31,7 +31,7 @@ e.g., Light is turned on/off once. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:76 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L76) ___ @@ -43,7 +43,7 @@ e.g., Light is turned on/off over 1 second and repeated 15 times. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:81 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L81) ___ @@ -56,7 +56,7 @@ e.g., Colored light turns orange for 8 seconds; non-colored light switches to th #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:92 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L92) ___ @@ -69,7 +69,7 @@ above), first complete the current 1s breathe effect and then terminate the effe #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:98 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L98) ___ @@ -81,7 +81,7 @@ e.g., Colored light turns green for 1 second; non-colored light flashes twice. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:86 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L86) ___ @@ -93,4 +93,4 @@ Terminate the effect as soon as possible. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:103 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L103) diff --git a/docs/matter.js/enums/cluster_export.Identify.EffectVariant.md b/docs/matter.js/enums/cluster_export.Identify.EffectVariant.md index d4eaf25bfb..f06ea5bff9 100644 --- a/docs/matter.js/enums/cluster_export.Identify.EffectVariant.md +++ b/docs/matter.js/enums/cluster_export.Identify.EffectVariant.md @@ -24,4 +24,4 @@ The value of Identify.effectVariant #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:112 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L112) diff --git a/docs/matter.js/enums/cluster_export.Identify.Feature.md b/docs/matter.js/enums/cluster_export.Identify.Feature.md index fcac6dad28..434ba931c3 100644 --- a/docs/matter.js/enums/cluster_export.Identify.Feature.md +++ b/docs/matter.js/enums/cluster_export.Identify.Feature.md @@ -28,4 +28,4 @@ Multicast query for identification state #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:173 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L173) diff --git a/docs/matter.js/enums/cluster_export.Identify.IdentifyType.md b/docs/matter.js/enums/cluster_export.Identify.IdentifyType.md index 389cee5d70..94c3cab446 100644 --- a/docs/matter.js/enums/cluster_export.Identify.IdentifyType.md +++ b/docs/matter.js/enums/cluster_export.Identify.IdentifyType.md @@ -32,7 +32,7 @@ relay. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:57 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L57) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:46 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L46) ___ @@ -54,7 +54,7 @@ Presentation will be visible on display screen. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:51 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L51) ___ @@ -66,7 +66,7 @@ Light output of a lighting product. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:39 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L39) ___ @@ -78,7 +78,7 @@ No presentation. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:34 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L34) ___ @@ -90,4 +90,4 @@ Typically a small LED. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:44 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L44) diff --git a/docs/matter.js/enums/cluster_export.KeypadInput.CecKeyCode.md b/docs/matter.js/enums/cluster_export.KeypadInput.CecKeyCode.md index 4a3b2d4b2f..a078bb7b4a 100644 --- a/docs/matter.js/enums/cluster_export.KeypadInput.CecKeyCode.md +++ b/docs/matter.js/enums/cluster_export.KeypadInput.CecKeyCode.md @@ -103,7 +103,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:76 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L76) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:72 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L72) ___ @@ -123,7 +123,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:52 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L52) ___ @@ -133,7 +133,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:51 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L51) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:49 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L49) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:29 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L29) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:103 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L103) ___ @@ -173,7 +173,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:56 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L56) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:47 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L47) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:20 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L20) ___ @@ -203,7 +203,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:70 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L70) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:79 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L79) ___ @@ -223,7 +223,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:48 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L48) ___ @@ -233,7 +233,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:31 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L31) ___ @@ -243,7 +243,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:98 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L98) ___ @@ -253,7 +253,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:99 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L99) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:100 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:100](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L100) ___ @@ -273,7 +273,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:101 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L101) ___ @@ -283,7 +283,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:102 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L102) ___ @@ -293,7 +293,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:69 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L69) ___ @@ -303,7 +303,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:30 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L30) ___ @@ -313,7 +313,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:71 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L71) ___ @@ -323,7 +323,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:57 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L57) ___ @@ -333,7 +333,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:81 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L81) ___ @@ -343,7 +343,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:55 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L55) ___ @@ -353,7 +353,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:21 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L21) ___ @@ -363,7 +363,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:26 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L26) ___ @@ -373,7 +373,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:25 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L25) ___ @@ -383,7 +383,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:33 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L33) ___ @@ -393,7 +393,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:32 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L32) ___ @@ -403,7 +403,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:63 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L63) ___ @@ -413,7 +413,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:89 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L89) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:50 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L50) ___ @@ -433,7 +433,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:37 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L37) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:35 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L35) ___ @@ -453,7 +453,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:36 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L36) ___ @@ -463,7 +463,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:34 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L34) ___ @@ -473,7 +473,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:38 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L38) ___ @@ -483,7 +483,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:39 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L39) ___ @@ -493,7 +493,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:40 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L40) ___ @@ -503,7 +503,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:41 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L41) ___ @@ -513,7 +513,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:42 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L42) ___ @@ -523,7 +523,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:43 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L43) ___ @@ -533,7 +533,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:44 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L44) ___ @@ -543,7 +543,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:45 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L45) ___ @@ -553,7 +553,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:46 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L46) ___ @@ -563,7 +563,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:59 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L59) ___ @@ -573,7 +573,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:58 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L58) ___ @@ -583,7 +583,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:66 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L66) ___ @@ -593,7 +593,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:85 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L85) ___ @@ -603,7 +603,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:74 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L74) ___ @@ -613,7 +613,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:87 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L87) ___ @@ -623,7 +623,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:64 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L64) ___ @@ -633,7 +633,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:84 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L84) ___ @@ -643,7 +643,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:60 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L60) ___ @@ -653,7 +653,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:96 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L96) ___ @@ -663,7 +663,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:97 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L97) ___ @@ -673,7 +673,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:95 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L95) ___ @@ -683,7 +683,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:53 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L53) ___ @@ -693,7 +693,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:67 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L67) ___ @@ -703,7 +703,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:86 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L86) ___ @@ -713,7 +713,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:75 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L75) ___ @@ -723,7 +723,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:90 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L90) ___ @@ -733,7 +733,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:68 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L68) ___ @@ -743,7 +743,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:22 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L22) ___ @@ -753,7 +753,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:24 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L24) ___ @@ -763,7 +763,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:23 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L23) ___ @@ -773,7 +773,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:27 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L27) ___ @@ -783,7 +783,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:18 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L18) ___ @@ -793,7 +793,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:94 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L94) ___ @@ -803,7 +803,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:93 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L93) ___ @@ -813,7 +813,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:82 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L82) ___ @@ -823,7 +823,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:92 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L92) ___ @@ -833,7 +833,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:83 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L83) ___ @@ -843,7 +843,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:28 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L28) ___ @@ -853,7 +853,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:54 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L54) ___ @@ -863,7 +863,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:65 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L65) ___ @@ -873,7 +873,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:88 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L88) ___ @@ -883,7 +883,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:73 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L73) ___ @@ -893,7 +893,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:77 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L77) ___ @@ -903,7 +903,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:80 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L80) ___ @@ -913,7 +913,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:91 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L91) ___ @@ -923,7 +923,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:19 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L19) ___ @@ -933,7 +933,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:78 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L78) ___ @@ -943,7 +943,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:62 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L62) ___ @@ -953,4 +953,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:61 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L61) diff --git a/docs/matter.js/enums/cluster_export.KeypadInput.Feature.md b/docs/matter.js/enums/cluster_export.KeypadInput.Feature.md index 29186d1f63..b52e02538b 100644 --- a/docs/matter.js/enums/cluster_export.KeypadInput.Feature.md +++ b/docs/matter.js/enums/cluster_export.KeypadInput.Feature.md @@ -30,7 +30,7 @@ Supports CEC keys 0x0A (Settings) and 0x09 (Home) #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:172 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L172) ___ @@ -44,7 +44,7 @@ Supports UP, DOWN, LEFT, RIGHT, SELECT, BACK, EXIT, MENU #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:165 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L165) ___ @@ -58,4 +58,4 @@ Supports numeric input 0..9 #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:179 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L179) diff --git a/docs/matter.js/enums/cluster_export.KeypadInput.Status.md b/docs/matter.js/enums/cluster_export.KeypadInput.Status.md index e9b0a39c6c..21bdc57a42 100644 --- a/docs/matter.js/enums/cluster_export.KeypadInput.Status.md +++ b/docs/matter.js/enums/cluster_export.KeypadInput.Status.md @@ -26,7 +26,7 @@ Command failed: Requested key code is invalid in the context of the responder’ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:137 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:137](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L137) ___ @@ -38,7 +38,7 @@ Command succeeded #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:127 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L127) ___ @@ -50,4 +50,4 @@ Command failed: Key code is not supported. #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:132 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:132](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L132) diff --git a/docs/matter.js/enums/cluster_export.LevelControl.Feature.md b/docs/matter.js/enums/cluster_export.LevelControl.Feature.md index 041aced5a1..fe8701ded1 100644 --- a/docs/matter.js/enums/cluster_export.LevelControl.Feature.md +++ b/docs/matter.js/enums/cluster_export.LevelControl.Feature.md @@ -31,7 +31,7 @@ control. #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:187 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:187](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L187) ___ @@ -45,7 +45,7 @@ Behavior that supports lighting applications #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:179 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L179) ___ @@ -59,4 +59,4 @@ Dependency with the On/Off cluster #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:172 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L172) diff --git a/docs/matter.js/enums/cluster_export.LevelControl.MoveMode.md b/docs/matter.js/enums/cluster_export.LevelControl.MoveMode.md index 912f2a05c4..9f5f5aeed4 100644 --- a/docs/matter.js/enums/cluster_export.LevelControl.MoveMode.md +++ b/docs/matter.js/enums/cluster_export.LevelControl.MoveMode.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:47 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L47) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:46 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L46) diff --git a/docs/matter.js/enums/cluster_export.LevelControl.StepMode.md b/docs/matter.js/enums/cluster_export.LevelControl.StepMode.md index 072bbfc5da..5f283a67e6 100644 --- a/docs/matter.js/enums/cluster_export.LevelControl.StepMode.md +++ b/docs/matter.js/enums/cluster_export.LevelControl.StepMode.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:81 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L81) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:80 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L80) diff --git a/docs/matter.js/enums/cluster_export.MediaInput.Feature.md b/docs/matter.js/enums/cluster_export.MediaInput.Feature.md index 92be8df723..1a21429c71 100644 --- a/docs/matter.js/enums/cluster_export.MediaInput.Feature.md +++ b/docs/matter.js/enums/cluster_export.MediaInput.Feature.md @@ -28,4 +28,4 @@ Supports updates to the input names #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:114 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L114) diff --git a/docs/matter.js/enums/cluster_export.MediaInput.InputType.md b/docs/matter.js/enums/cluster_export.MediaInput.InputType.md index 9216f0b45c..1a09af1798 100644 --- a/docs/matter.js/enums/cluster_export.MediaInput.InputType.md +++ b/docs/matter.js/enums/cluster_export.MediaInput.InputType.md @@ -35,7 +35,7 @@ The type of input, expressed as an enum, with the following values: #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:31 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L31) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:32 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L32) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:33 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L33) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:34 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L34) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:35 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L35) ___ @@ -87,7 +87,7 @@ Indicates content not coming from a physical input. #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:29 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L29) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:36 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L36) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:37 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L37) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:41 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L41) ___ @@ -127,7 +127,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:39 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L39) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:40 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L40) ___ @@ -147,4 +147,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:38 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L38) diff --git a/docs/matter.js/enums/cluster_export.MediaPlayback.Feature.md b/docs/matter.js/enums/cluster_export.MediaPlayback.Feature.md index 165be08425..0f9e1ee129 100644 --- a/docs/matter.js/enums/cluster_export.MediaPlayback.Feature.md +++ b/docs/matter.js/enums/cluster_export.MediaPlayback.Feature.md @@ -30,7 +30,7 @@ example a "seek bar". Adds support for Attributes and Commands related to advanc #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:200 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L200) ___ @@ -44,4 +44,4 @@ Support for commands to support variable speed playback on media that supports i #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:207 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L207) diff --git a/docs/matter.js/enums/cluster_export.MediaPlayback.PlaybackState.md b/docs/matter.js/enums/cluster_export.MediaPlayback.PlaybackState.md index 3488e4291d..712aa07465 100644 --- a/docs/matter.js/enums/cluster_export.MediaPlayback.PlaybackState.md +++ b/docs/matter.js/enums/cluster_export.MediaPlayback.PlaybackState.md @@ -27,7 +27,7 @@ Media is not currently buffering and playback will start when buffer has been fi #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:42 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L42) ___ @@ -39,7 +39,7 @@ Media is not currently playing #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:37 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L37) ___ @@ -51,7 +51,7 @@ Media is currently paused #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:32 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L32) ___ @@ -63,4 +63,4 @@ Media is currently playing (includes FF and REW) #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:27 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L27) diff --git a/docs/matter.js/enums/cluster_export.MediaPlayback.Status.md b/docs/matter.js/enums/cluster_export.MediaPlayback.Status.md index 064cfd7a2c..77611f0766 100644 --- a/docs/matter.js/enums/cluster_export.MediaPlayback.Status.md +++ b/docs/matter.js/enums/cluster_export.MediaPlayback.Status.md @@ -29,7 +29,7 @@ Command failed: Requested playback command is invalid in the current playback st #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:57 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L57) ___ @@ -41,7 +41,7 @@ Command failed: This endpoint is not active for playback. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:68 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L68) ___ @@ -54,7 +54,7 @@ attempting to fast-forward during a commercial might return NotAllowed. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:63 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L63) ___ @@ -67,7 +67,7 @@ the media. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:80 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L80) ___ @@ -80,7 +80,7 @@ fastest speed supported by the server in the respective direction. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:74 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L74) ___ @@ -92,4 +92,4 @@ Command succeeded #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:52 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L52) diff --git a/docs/matter.js/enums/cluster_export.ModeSelect.Feature.md b/docs/matter.js/enums/cluster_export.ModeSelect.Feature.md index 0997b6f6df..8b5d6ce5fd 100644 --- a/docs/matter.js/enums/cluster_export.ModeSelect.Feature.md +++ b/docs/matter.js/enums/cluster_export.ModeSelect.Feature.md @@ -28,4 +28,4 @@ Dependency with the On/Off cluster #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:114 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L114) diff --git a/docs/matter.js/enums/cluster_export.NetworkCommissioning.Feature.md b/docs/matter.js/enums/cluster_export.NetworkCommissioning.Feature.md index 75d1f70af8..8f8a316207 100644 --- a/docs/matter.js/enums/cluster_export.NetworkCommissioning.Feature.md +++ b/docs/matter.js/enums/cluster_export.NetworkCommissioning.Feature.md @@ -30,7 +30,7 @@ Ethernet related features #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:587 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:587](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L587) ___ @@ -44,7 +44,7 @@ Thread related features #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:580 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:580](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L580) ___ @@ -58,4 +58,4 @@ Wi-Fi related features #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:573 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:573](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L573) diff --git a/docs/matter.js/enums/cluster_export.NetworkCommissioning.NetworkCommissioningStatus.md b/docs/matter.js/enums/cluster_export.NetworkCommissioning.NetworkCommissioningStatus.md index 3ae6edacc3..2e76d28eb5 100644 --- a/docs/matter.js/enums/cluster_export.NetworkCommissioning.NetworkCommissioningStatus.md +++ b/docs/matter.js/enums/cluster_export.NetworkCommissioning.NetworkCommissioningStatus.md @@ -36,7 +36,7 @@ Cannot associate due to authentication failure #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:107 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L107) ___ @@ -48,7 +48,7 @@ A collection would exceed its size limit #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:82 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L82) ___ @@ -60,7 +60,7 @@ The NetworkID is already among the collection of added networks #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:92 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L92) ___ @@ -72,7 +72,7 @@ Failure to bind Wi-Fi <-> IP interfaces #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:127 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L127) ___ @@ -84,7 +84,7 @@ Failure to generate an IPv6 address #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:122 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L122) ___ @@ -96,7 +96,7 @@ The NetworkID is not among the collection of added networks #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:87 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L87) ___ @@ -108,7 +108,7 @@ Cannot find AP: SSID Not found #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:97 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L97) ___ @@ -120,7 +120,7 @@ Other association failure #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:117 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L117) ___ @@ -132,7 +132,7 @@ Value Outside Range #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:77 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L77) ___ @@ -144,7 +144,7 @@ Cannot find AP: Mismatch on band/channels/regulatory domain / 2.4GHz vs 5GHz #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:102 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L102) ___ @@ -156,7 +156,7 @@ OK, no error #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:72 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L72) ___ @@ -168,7 +168,7 @@ Unknown error #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:132 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:132](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L132) ___ @@ -180,4 +180,4 @@ Cannot associate due to unsupported security mode #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:112 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L112) diff --git a/docs/matter.js/enums/cluster_export.NetworkCommissioning.WiFiBand.md b/docs/matter.js/enums/cluster_export.NetworkCommissioning.WiFiBand.md index 3d29260346..c9525fb560 100644 --- a/docs/matter.js/enums/cluster_export.NetworkCommissioning.WiFiBand.md +++ b/docs/matter.js/enums/cluster_export.NetworkCommissioning.WiFiBand.md @@ -31,7 +31,7 @@ WiFiInterfaceScanResultStruct. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:203 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:203](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L203) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:208 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L208) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:213 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L213) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:223 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L223) ___ @@ -79,4 +79,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:218 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:218](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L218) diff --git a/docs/matter.js/enums/cluster_export.OccupancySensing.OccupancySensorType.md b/docs/matter.js/enums/cluster_export.OccupancySensing.OccupancySensorType.md index 10b1b7403e..929b1ce08c 100644 --- a/docs/matter.js/enums/cluster_export.OccupancySensing.OccupancySensorType.md +++ b/docs/matter.js/enums/cluster_export.OccupancySensing.OccupancySensorType.md @@ -27,7 +27,7 @@ Indicates a physical contact sensor. #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:51 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L51) ___ @@ -39,7 +39,7 @@ Indicates a passive infrared sensor. #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:36 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L36) ___ @@ -51,7 +51,7 @@ Indicates a passive infrared and ultrasonic sensor. #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:46 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L46) ___ @@ -63,4 +63,4 @@ Indicates a ultrasonic sensor. #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:41 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L41) diff --git a/docs/matter.js/enums/cluster_export.OnOff.Feature.md b/docs/matter.js/enums/cluster_export.OnOff.Feature.md index 8b6b3a2a89..189ba3bf2f 100644 --- a/docs/matter.js/enums/cluster_export.OnOff.Feature.md +++ b/docs/matter.js/enums/cluster_export.OnOff.Feature.md @@ -28,4 +28,4 @@ Behavior that supports lighting applications. #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:124 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L124) diff --git a/docs/matter.js/enums/cluster_export.OnOff.OnOffEffectIdentifier.md b/docs/matter.js/enums/cluster_export.OnOff.OnOffEffectIdentifier.md index ecddde2b66..03fca89577 100644 --- a/docs/matter.js/enums/cluster_export.OnOff.OnOffEffectIdentifier.md +++ b/docs/matter.js/enums/cluster_export.OnOff.OnOffEffectIdentifier.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:42 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L42) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:43 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L43) diff --git a/docs/matter.js/enums/cluster_export.OnOff.StartUpOnOff.md b/docs/matter.js/enums/cluster_export.OnOff.StartUpOnOff.md index 753fbd62c3..fca489374e 100644 --- a/docs/matter.js/enums/cluster_export.OnOff.StartUpOnOff.md +++ b/docs/matter.js/enums/cluster_export.OnOff.StartUpOnOff.md @@ -26,7 +26,7 @@ Set the OnOff attribute to FALSE #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:27 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L27) ___ @@ -38,7 +38,7 @@ Set the OnOff attribute to TRUE #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:32 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L32) ___ @@ -51,4 +51,4 @@ previous value of the OnOff attribute is equal to TRUE, set the OnOff attribute #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:38 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L38) diff --git a/docs/matter.js/enums/cluster_export.OnOffSwitchConfiguration.SwitchActions.md b/docs/matter.js/enums/cluster_export.OnOffSwitchConfiguration.SwitchActions.md index 4efc867254..6b99187159 100644 --- a/docs/matter.js/enums/cluster_export.OnOffSwitchConfiguration.SwitchActions.md +++ b/docs/matter.js/enums/cluster_export.OnOffSwitchConfiguration.SwitchActions.md @@ -22,7 +22,7 @@ The value of the OnOffSwitchConfiguration switchActions attribute #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:28 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L28) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:27 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L27) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:29 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L29) diff --git a/docs/matter.js/enums/cluster_export.OnOffSwitchConfiguration.SwitchType.md b/docs/matter.js/enums/cluster_export.OnOffSwitchConfiguration.SwitchType.md index f146a6b7d0..f52af4bc38 100644 --- a/docs/matter.js/enums/cluster_export.OnOffSwitchConfiguration.SwitchType.md +++ b/docs/matter.js/enums/cluster_export.OnOffSwitchConfiguration.SwitchType.md @@ -22,7 +22,7 @@ The value of the OnOffSwitchConfiguration switchType attribute #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:19 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L19) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:20 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L20) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:18 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L18) diff --git a/docs/matter.js/enums/cluster_export.OperationalCredentials.CertificateChainType.md b/docs/matter.js/enums/cluster_export.OperationalCredentials.CertificateChainType.md index 3a379112cc..9e07e5ef2f 100644 --- a/docs/matter.js/enums/cluster_export.OperationalCredentials.CertificateChainType.md +++ b/docs/matter.js/enums/cluster_export.OperationalCredentials.CertificateChainType.md @@ -28,7 +28,7 @@ Request the DER- encoded DAC certificate #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:163 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L163) ___ @@ -40,4 +40,4 @@ Request the DER- encoded PAI certificate #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:168 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L168) diff --git a/docs/matter.js/enums/cluster_export.OperationalCredentials.NodeOperationalCertStatus.md b/docs/matter.js/enums/cluster_export.OperationalCredentials.NodeOperationalCertStatus.md index ff0ebd0c88..55370f1b9f 100644 --- a/docs/matter.js/enums/cluster_export.OperationalCredentials.NodeOperationalCertStatus.md +++ b/docs/matter.js/enums/cluster_export.OperationalCredentials.NodeOperationalCertStatus.md @@ -37,7 +37,7 @@ Trying to AddNOC instead of UpdateNOC against an existing Fabric. #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:416 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:416](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L416) ___ @@ -49,7 +49,7 @@ Invalid CaseAdminSubject field for an AddNOC command. #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:411 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:411](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L411) ___ @@ -61,7 +61,7 @@ FabricIndex argument is invalid. #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:426 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:426](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L426) ___ @@ -73,7 +73,7 @@ Any other validation error in NOC chain #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:396 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:396](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L396) ___ @@ -85,7 +85,7 @@ The Node Operational ID in the NOC is not formatted correctly. #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:391 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:391](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L391) ___ @@ -97,7 +97,7 @@ Public Key in the NOC does not match the public key in the NOCSR #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:386 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:386](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L386) ___ @@ -109,7 +109,7 @@ Label already exists on another Fabric. #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:421 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:421](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L421) ___ @@ -121,7 +121,7 @@ No record of prior CSR for which this NOC could match #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:401 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:401](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L401) ___ @@ -133,7 +133,7 @@ OK, no error #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:381 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:381](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L381) ___ @@ -145,4 +145,4 @@ NOCs table full, cannot add another one #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:406 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:406](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L406) diff --git a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.ApplyUpdateAction.md b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.ApplyUpdateAction.md index 26a1b5bdb9..bc37acceeb 100644 --- a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.ApplyUpdateAction.md +++ b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.ApplyUpdateAction.md @@ -29,7 +29,7 @@ Wait at least the given delay time. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:131 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L131) ___ @@ -41,7 +41,7 @@ The OTA Provider is conveying a desire to rescind a previously provided Software #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:136 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L136) ___ @@ -53,4 +53,4 @@ Apply the update. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:126 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L126) diff --git a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.DownloadProtocol.md b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.DownloadProtocol.md index 5726949b96..e2c9744103 100644 --- a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.DownloadProtocol.md +++ b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.DownloadProtocol.md @@ -31,7 +31,7 @@ Indicates support for asynchronous BDX. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:36 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L36) ___ @@ -43,7 +43,7 @@ Indicates support for synchronous BDX. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:31 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L31) ___ @@ -55,7 +55,7 @@ Indicates support for HTTPS. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:41 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L41) ___ @@ -67,4 +67,4 @@ Indicates support for vendor specific protocol. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:46 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L46) diff --git a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.Status.md b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.Status.md index 4e9e848135..7a10c92729 100644 --- a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.Status.md +++ b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateProvider.Status.md @@ -29,7 +29,7 @@ Indicates OTA Provider may have an update, but it is not ready yet. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:79 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L79) ___ @@ -41,7 +41,7 @@ Indicates that the requested download protocol is not supported by the OTA Provi #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:89 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L89) ___ @@ -53,7 +53,7 @@ Indicates that there is definitely no update currently available from the OTA Pr #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:84 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L84) ___ @@ -65,4 +65,4 @@ Indicates that the OTA Provider has an update available. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:74 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L74) diff --git a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.AnnouncementReason.md b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.AnnouncementReason.md index 53ff51b5eb..a77303e820 100644 --- a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.AnnouncementReason.md +++ b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.AnnouncementReason.md @@ -26,7 +26,7 @@ An OTA Provider is announcing its presence. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:100 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:100](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L100) ___ @@ -39,7 +39,7 @@ be available. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:106 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L106) ___ @@ -52,4 +52,4 @@ be available, which contains an update that needs to be applied urgently. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:112 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L112) diff --git a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.ChangeReason.md b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.ChangeReason.md index ad28d09fc9..0d75832208 100644 --- a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.ChangeReason.md +++ b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.ChangeReason.md @@ -30,7 +30,7 @@ The reason for a state change is a request by the OTA Provider to wait. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:158 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L158) ___ @@ -42,7 +42,7 @@ The reason for a state change is the failure of a prior operation. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:148 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L148) ___ @@ -54,7 +54,7 @@ The reason for a state change is the success of a prior operation. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:143 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:143](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L143) ___ @@ -66,7 +66,7 @@ The reason for a state change is a time-out. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:153 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L153) ___ @@ -78,4 +78,4 @@ The reason for a state change is unknown. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:138 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L138) diff --git a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.UpdateState.md b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.UpdateState.md index 4b22fee77c..ccb040ddbe 100644 --- a/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.UpdateState.md +++ b/docs/matter.js/enums/cluster_export.OtaSoftwareUpdateRequestor.UpdateState.md @@ -32,7 +32,7 @@ Indicate a Node currently in the process of verifying and applying a software up #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:75 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L75) ___ @@ -44,7 +44,7 @@ Indicate a Node waiting caused by AwaitNextAction response. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:80 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L80) ___ @@ -56,7 +56,7 @@ Indicate a Node waiting after a Busy response. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:65 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L65) ___ @@ -68,7 +68,7 @@ Indicate a Node is capable of user consent. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:90 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L90) ___ @@ -80,7 +80,7 @@ Indicate a Node currently in the process of downloading a software update. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:70 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L70) ___ @@ -92,7 +92,7 @@ Indicate a Node not yet in the process of software update. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:55 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L55) ___ @@ -104,7 +104,7 @@ Indicate a Node in the process of querying an OTA Provider. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:60 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L60) ___ @@ -116,7 +116,7 @@ Indicate a Node in the process of recovering to a previous version. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:85 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L85) ___ @@ -128,4 +128,4 @@ Current state is not yet determined. #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:50 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L50) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.BatApprovedChemistry.md b/docs/matter.js/enums/cluster_export.PowerSource.BatApprovedChemistry.md index e62ee3a364..3b6ff01b49 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.BatApprovedChemistry.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.BatApprovedChemistry.md @@ -56,7 +56,7 @@ Cell chemistry is alkaline #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:608 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:608](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L608) ___ @@ -68,7 +68,7 @@ Cell chemistry is lead acid #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:683 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:683](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L683) ___ @@ -80,7 +80,7 @@ Cell chemistry is lithium carbon fluoride #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:613 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:613](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L613) ___ @@ -92,7 +92,7 @@ Cell chemistry is lithium chromium oxide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:618 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:618](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L618) ___ @@ -104,7 +104,7 @@ Cell chemistry is lithium cobalt oxide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:688 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:688](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L688) ___ @@ -116,7 +116,7 @@ Cell chemistry is lithium copper oxide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:623 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:623](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L623) ___ @@ -128,7 +128,7 @@ Cell chemistry is lithium ion #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:693 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:693](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L693) ___ @@ -140,7 +140,7 @@ Cell chemistry is lithium ion polymer #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:698 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:698](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L698) ___ @@ -152,7 +152,7 @@ Cell chemistry is lithium iron disulfide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:628 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:628](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L628) ___ @@ -164,7 +164,7 @@ Cell chemistry is lithium iron phosphate #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:703 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:703](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L703) ___ @@ -176,7 +176,7 @@ Cell chemistry is lithium manganese dioxide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:633 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:633](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L633) ___ @@ -188,7 +188,7 @@ Cell chemistry is lithium sulfur #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:708 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:708](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L708) ___ @@ -200,7 +200,7 @@ Cell chemistry is lithium thionyl chloride #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:638 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:638](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L638) ___ @@ -212,7 +212,7 @@ Cell chemistry is lithium titanate #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:713 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:713](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L713) ___ @@ -224,7 +224,7 @@ Cell chemistry is magnesium #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:643 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:643](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L643) ___ @@ -236,7 +236,7 @@ Cell chemistry is mercury oxide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:648 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:648](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L648) ___ @@ -248,7 +248,7 @@ Cell chemistry is nickel cadmium #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:718 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:718](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L718) ___ @@ -260,7 +260,7 @@ Cell chemistry is nickel hydrogen #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:723 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:723](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L723) ___ @@ -272,7 +272,7 @@ Cell chemistry is nickel iron #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:728 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:728](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L728) ___ @@ -284,7 +284,7 @@ Cell chemistry is nickel metal hydride #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:733 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:733](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L733) ___ @@ -296,7 +296,7 @@ Cell chemistry is nickel oxyhydride #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:653 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:653](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L653) ___ @@ -308,7 +308,7 @@ Cell chemistry is nickel zinc #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:738 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:738](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L738) ___ @@ -320,7 +320,7 @@ Cell chemistry is silver oxide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:658 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:658](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L658) ___ @@ -332,7 +332,7 @@ Cell chemistry is silver zinc #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:743 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:743](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L743) ___ @@ -344,7 +344,7 @@ Cell chemistry is sodium ion #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:748 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:748](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L748) ___ @@ -356,7 +356,7 @@ Cell chemistry is sodium sulfur #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:753 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:753](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L753) ___ @@ -368,7 +368,7 @@ Cell chemistry is unspecified or unknown #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:603 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:603](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L603) ___ @@ -380,7 +380,7 @@ Cell chemistry is zinc air #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:663 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:663](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L663) ___ @@ -392,7 +392,7 @@ Cell chemistry is zinc bromide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:758 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:758](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L758) ___ @@ -404,7 +404,7 @@ Cell chemistry is zinc carbon #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:668 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:668](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L668) ___ @@ -416,7 +416,7 @@ Cell chemistry is zinc cerium #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:763 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:763](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L763) ___ @@ -428,7 +428,7 @@ Cell chemistry is zinc chloride #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:673 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:673](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L673) ___ @@ -440,4 +440,4 @@ Cell chemistry is zinc manganese dioxide #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:678 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:678](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L678) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.BatChargeFault.md b/docs/matter.js/enums/cluster_export.PowerSource.BatChargeFault.md index 100e5f8ca2..23afebddb1 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.BatChargeFault.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.BatChargeFault.md @@ -34,7 +34,7 @@ The Node detects the ambient temperature is below the nominal range for this bat #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:808 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:808](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L808) ___ @@ -46,7 +46,7 @@ The Node detects the ambient temperature is above the nominal range for this bat #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:803 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:803](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L803) ___ @@ -58,7 +58,7 @@ The Node detects this battery source is not present. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:823 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:823](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L823) ___ @@ -70,7 +70,7 @@ The Node detects this battery source is over voltage. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:828 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:828](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L828) ___ @@ -82,7 +82,7 @@ The Node detects the temperature of this battery source is below the nominal ran #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:818 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:818](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L818) ___ @@ -94,7 +94,7 @@ The Node detects the temperature of this battery source is above the nominal ran #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:813 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:813](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L813) ___ @@ -106,7 +106,7 @@ The Node detects this battery source is under voltage. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:833 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:833](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L833) ___ @@ -118,7 +118,7 @@ The Node detects the charger for this battery source is over voltage. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:838 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:838](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L838) ___ @@ -130,7 +130,7 @@ The Node detects the charger for this battery source is under voltage. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:843 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:843](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L843) ___ @@ -142,7 +142,7 @@ The Node detects a charging safety timeout for this battery source. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:848 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:848](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L848) ___ @@ -154,4 +154,4 @@ The Node detects an unspecified fault on this battery source. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:798 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:798](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L798) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.BatChargeLevel.md b/docs/matter.js/enums/cluster_export.PowerSource.BatChargeLevel.md index 5e0d091b9f..dee9a78426 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.BatChargeLevel.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.BatChargeLevel.md @@ -26,7 +26,7 @@ Charge level is critical, immediate intervention is required #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:128 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L128) ___ @@ -38,7 +38,7 @@ Charge level is nominal #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:118 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L118) ___ @@ -50,4 +50,4 @@ Charge level is low, intervention may soon be required. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:123 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L123) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.BatChargeState.md b/docs/matter.js/enums/cluster_export.PowerSource.BatChargeState.md index b569ab4bfd..43fa178a41 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.BatChargeState.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.BatChargeState.md @@ -27,7 +27,7 @@ The battery is at full charge #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:783 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:783](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L783) ___ @@ -39,7 +39,7 @@ The battery is charging #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:778 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:778](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L778) ___ @@ -51,7 +51,7 @@ The battery is not charging #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:788 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:788](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L788) ___ @@ -63,4 +63,4 @@ Unable to determine the charging state #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:773 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:773](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L773) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.BatCommonDesignation.md b/docs/matter.js/enums/cluster_export.PowerSource.BatCommonDesignation.md index 888b1cf1c7..35e88e4a3b 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.BatCommonDesignation.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.BatCommonDesignation.md @@ -104,7 +104,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:233 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:233](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L233) ___ @@ -116,7 +116,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:308 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:308](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L308) ___ @@ -128,7 +128,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:313 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:313](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L313) ___ @@ -140,7 +140,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:348 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:348](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L348) ___ @@ -152,7 +152,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:318 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:318](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L318) ___ @@ -164,7 +164,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:323 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:323](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L323) ___ @@ -176,7 +176,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:293 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L293) ___ @@ -188,7 +188,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:218 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:218](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L218) ___ @@ -200,7 +200,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:328 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:328](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L328) ___ @@ -212,7 +212,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:223 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L223) ___ @@ -224,7 +224,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:228 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:228](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L228) ___ @@ -236,7 +236,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:243 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:243](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L243) ___ @@ -248,7 +248,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:478 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:478](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L478) ___ @@ -260,7 +260,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:483 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:483](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L483) ___ @@ -272,7 +272,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:273 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L273) ___ @@ -284,7 +284,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:278 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:278](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L278) ___ @@ -296,7 +296,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:488 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:488](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L488) ___ @@ -308,7 +308,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:473 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:473](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L473) ___ @@ -320,7 +320,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:493 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:493](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L493) ___ @@ -332,7 +332,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:203 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:203](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L203) ___ @@ -344,7 +344,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:198 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L198) ___ @@ -356,7 +356,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:238 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L238) ___ @@ -368,7 +368,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:498 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:498](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L498) ___ @@ -380,7 +380,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:248 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:248](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L248) ___ @@ -392,7 +392,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:283 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L283) ___ @@ -404,7 +404,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:208 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L208) ___ @@ -416,7 +416,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:338 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L338) ___ @@ -428,7 +428,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:343 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L343) ___ @@ -440,7 +440,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:353 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:353](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L353) ___ @@ -452,7 +452,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:358 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:358](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L358) ___ @@ -464,7 +464,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:213 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L213) ___ @@ -476,7 +476,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:288 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:288](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L288) ___ @@ -488,7 +488,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:503 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:503](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L503) ___ @@ -500,7 +500,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:508 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:508](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L508) ___ @@ -512,7 +512,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:513 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:513](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L513) ___ @@ -524,7 +524,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:518 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:518](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L518) ___ @@ -536,7 +536,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:523 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:523](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L523) ___ @@ -548,7 +548,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:528 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:528](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L528) ___ @@ -560,7 +560,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:533 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:533](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L533) ___ @@ -572,7 +572,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:538 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:538](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L538) ___ @@ -584,7 +584,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:543 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:543](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L543) ___ @@ -596,7 +596,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:553 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:553](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L553) ___ @@ -608,7 +608,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:558 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:558](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L558) ___ @@ -620,7 +620,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:563 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:563](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L563) ___ @@ -632,7 +632,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:568 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:568](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L568) ___ @@ -644,7 +644,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:573 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:573](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L573) ___ @@ -656,7 +656,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:578 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:578](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L578) ___ @@ -668,7 +668,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:583 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:583](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L583) ___ @@ -680,7 +680,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:588 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:588](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L588) ___ @@ -692,7 +692,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:593 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:593](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L593) ___ @@ -704,7 +704,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:298 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:298](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L298) ___ @@ -716,7 +716,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:303 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L303) ___ @@ -728,7 +728,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:253 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:253](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L253) ___ @@ -740,7 +740,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:333 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:333](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L333) ___ @@ -752,7 +752,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:468 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:468](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L468) ___ @@ -764,7 +764,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:258 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:258](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L258) ___ @@ -776,7 +776,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:263 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L263) ___ @@ -788,7 +788,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:548 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:548](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L548) ___ @@ -800,7 +800,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:363 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L363) ___ @@ -812,7 +812,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:368 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:368](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L368) ___ @@ -824,7 +824,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:373 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:373](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L373) ___ @@ -836,7 +836,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:378 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:378](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L378) ___ @@ -848,7 +848,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:383 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:383](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L383) ___ @@ -860,7 +860,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:453 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:453](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L453) ___ @@ -872,7 +872,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:388 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:388](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L388) ___ @@ -884,7 +884,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:393 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:393](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L393) ___ @@ -896,7 +896,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:398 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:398](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L398) ___ @@ -908,7 +908,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:403 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:403](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L403) ___ @@ -920,7 +920,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:408 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:408](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L408) ___ @@ -932,7 +932,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:413 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:413](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L413) ___ @@ -944,7 +944,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:418 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:418](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L418) ___ @@ -956,7 +956,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:423 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:423](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L423) ___ @@ -968,7 +968,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:428 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:428](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L428) ___ @@ -980,7 +980,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:433 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:433](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L433) ___ @@ -992,7 +992,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:438 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:438](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L438) ___ @@ -1004,7 +1004,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:443 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:443](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L443) ___ @@ -1016,7 +1016,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:448 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:448](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L448) ___ @@ -1028,7 +1028,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:463 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:463](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L463) ___ @@ -1040,7 +1040,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:458 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:458](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L458) ___ @@ -1052,7 +1052,7 @@ Common type is as specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:268 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L268) ___ @@ -1064,4 +1064,4 @@ Common type is unknown or unspecified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:193 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:193](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L193) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.BatFault.md b/docs/matter.js/enums/cluster_export.PowerSource.BatFault.md index 02e82258c7..94e9a07280 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.BatFault.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.BatFault.md @@ -26,7 +26,7 @@ The Node detects the temperature of this battery power source is above ideal ope #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:168 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L168) ___ @@ -38,7 +38,7 @@ The Node detects the temperature of this battery power source is below ideal ope #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:173 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L173) ___ @@ -50,4 +50,4 @@ The Node detects an unspecified fault on this battery power source. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:163 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L163) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.BatReplaceability.md b/docs/matter.js/enums/cluster_export.PowerSource.BatReplaceability.md index b2f6a0da91..faaf9a8495 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.BatReplaceability.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.BatReplaceability.md @@ -27,7 +27,7 @@ The battery is replaceable by an authorized factory technician. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:153 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L153) ___ @@ -39,7 +39,7 @@ The battery is not replaceable. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:143 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:143](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L143) ___ @@ -51,7 +51,7 @@ The replaceability is unspecified or unknown. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:138 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L138) ___ @@ -63,4 +63,4 @@ The battery is replaceable by the user or customer. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:148 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L148) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.Feature.md b/docs/matter.js/enums/cluster_export.PowerSource.Feature.md index 2382428a2f..e9a91eddf9 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.Feature.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.Feature.md @@ -31,7 +31,7 @@ A battery power source #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:879 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:879](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L879) ___ @@ -45,7 +45,7 @@ A rechargeable battery power source (requires Battery feature) #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:886 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:886](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L886) ___ @@ -59,7 +59,7 @@ A replaceable battery power source (requires Battery feature) #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:893 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:893](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L893) ___ @@ -73,4 +73,4 @@ A wired power source #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:872 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:872](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L872) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.PowerSourceStatus.md b/docs/matter.js/enums/cluster_export.PowerSource.PowerSourceStatus.md index 2b963550be..0531c0ad1c 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.PowerSourceStatus.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.PowerSourceStatus.md @@ -27,7 +27,7 @@ Indicate the source is available and currently supplying power #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:40 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L40) ___ @@ -39,7 +39,7 @@ Indicate the source is available, but is not currently supplying power #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:45 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L45) ___ @@ -51,7 +51,7 @@ Indicate the source is not currently available to supply power #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:50 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L50) ___ @@ -63,4 +63,4 @@ Indicate the source status is not specified #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:35 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L35) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.WiredCurrentType.md b/docs/matter.js/enums/cluster_export.PowerSource.WiredCurrentType.md index 1b3e724c43..abb14cc066 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.WiredCurrentType.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.WiredCurrentType.md @@ -25,7 +25,7 @@ Indicates AC current #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:60 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L60) ___ @@ -37,4 +37,4 @@ Indicates DC current #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:65 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L65) diff --git a/docs/matter.js/enums/cluster_export.PowerSource.WiredFault.md b/docs/matter.js/enums/cluster_export.PowerSource.WiredFault.md index 814d412f9d..22e1650baa 100644 --- a/docs/matter.js/enums/cluster_export.PowerSource.WiredFault.md +++ b/docs/matter.js/enums/cluster_export.PowerSource.WiredFault.md @@ -26,7 +26,7 @@ The Node detects the supplied voltage is above maximum supported value for this #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:80 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L80) ___ @@ -38,7 +38,7 @@ The Node detects the supplied voltage is below maximum supported value for this #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:85 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L85) ___ @@ -50,4 +50,4 @@ The Node detects an unspecified fault on this wired power source. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:75 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L75) diff --git a/docs/matter.js/enums/cluster_export.PressureMeasurement.Feature.md b/docs/matter.js/enums/cluster_export.PressureMeasurement.Feature.md index 0a09dfb8b4..802ebeaf83 100644 --- a/docs/matter.js/enums/cluster_export.PressureMeasurement.Feature.md +++ b/docs/matter.js/enums/cluster_export.PressureMeasurement.Feature.md @@ -28,4 +28,4 @@ The cluster is capable of extended range and resolution #### Defined in -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:28 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L28) diff --git a/docs/matter.js/enums/cluster_export.PulseWidthModulation.Feature.md b/docs/matter.js/enums/cluster_export.PulseWidthModulation.Feature.md index 841021232f..9117de2415 100644 --- a/docs/matter.js/enums/cluster_export.PulseWidthModulation.Feature.md +++ b/docs/matter.js/enums/cluster_export.PulseWidthModulation.Feature.md @@ -31,7 +31,7 @@ control. #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:141 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L141) ___ @@ -45,7 +45,7 @@ Behavior that supports lighting applications #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:133 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L133) ___ @@ -59,4 +59,4 @@ Dependency with the On/Off cluster #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:126 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L126) diff --git a/docs/matter.js/enums/cluster_export.PulseWidthModulation.MoveMode.md b/docs/matter.js/enums/cluster_export.PulseWidthModulation.MoveMode.md index 31d26b8800..34ef977233 100644 --- a/docs/matter.js/enums/cluster_export.PulseWidthModulation.MoveMode.md +++ b/docs/matter.js/enums/cluster_export.PulseWidthModulation.MoveMode.md @@ -25,7 +25,7 @@ The value of PulseWidthModulation.moveMode #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:53 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L53) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:52 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L52) diff --git a/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.ControlMode.md b/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.ControlMode.md index 18ce784122..f3637f9028 100644 --- a/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.ControlMode.md +++ b/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.ControlMode.md @@ -38,7 +38,7 @@ pump is entirely determined by the pump. #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:209 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L209) ___ @@ -59,7 +59,7 @@ MaxMeasuredValue] attributes of the remote flow sensor. #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:185 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:185](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L185) ___ @@ -80,7 +80,7 @@ MaxConstPressure] attributes. In case of a remote pressure sensor, this will be #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:162 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L162) ___ @@ -99,7 +99,7 @@ attributes. #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:150 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L150) ___ @@ -120,7 +120,7 @@ attributes. In case of a remote temperature sensor, this will be the range deriv #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:197 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L197) ___ @@ -140,4 +140,4 @@ flow ⇒ lower internal setpoint). #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:173 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L173) diff --git a/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.Feature.md b/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.Feature.md index 151f6576fe..8b2c2a619e 100644 --- a/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.Feature.md +++ b/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.Feature.md @@ -34,7 +34,7 @@ Supports operating in automatic mode #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:258 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:258](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L258) ___ @@ -48,7 +48,7 @@ Supports operating in compensated pressure mode #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:230 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L230) ___ @@ -62,7 +62,7 @@ Supports operating in constant flow mode #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:237 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L237) ___ @@ -76,7 +76,7 @@ Supports operating in constant pressure mode #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:223 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L223) ___ @@ -90,7 +90,7 @@ Supports operating in constant speed mode #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:244 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L244) ___ @@ -104,7 +104,7 @@ Supports operating in constant temperature mode #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:251 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L251) ___ @@ -118,4 +118,4 @@ Supports operating using local settings #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:265 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L265) diff --git a/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.OperationMode.md b/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.OperationMode.md index ceaac58b0b..b47c21685d 100644 --- a/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.OperationMode.md +++ b/docs/matter.js/enums/cluster_export.PumpConfigurationAndControl.OperationMode.md @@ -27,7 +27,7 @@ This value sets the pump to run with the local settings of the pump, regardless #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:135 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L135) ___ @@ -39,7 +39,7 @@ This value sets the pump to run at its maximum possible speed. #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:130 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L130) ___ @@ -51,7 +51,7 @@ This value sets the pump to run at the minimum possible speed it can without bei #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:125 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L125) ___ @@ -71,4 +71,4 @@ between 0% and 100%, e.g., by means of the Level Control cluster #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:120 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L120) diff --git a/docs/matter.js/enums/cluster_export.Scenes.Feature.md b/docs/matter.js/enums/cluster_export.Scenes.Feature.md index 57d64c41b8..abacdd12a4 100644 --- a/docs/matter.js/enums/cluster_export.Scenes.Feature.md +++ b/docs/matter.js/enums/cluster_export.Scenes.Feature.md @@ -28,4 +28,4 @@ The ability to store a name for a scene. #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:332 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:332](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L332) diff --git a/docs/matter.js/enums/cluster_export.SoftwareDiagnostics.Feature.md b/docs/matter.js/enums/cluster_export.SoftwareDiagnostics.Feature.md index eefd7c49c5..c1b9141f23 100644 --- a/docs/matter.js/enums/cluster_export.SoftwareDiagnostics.Feature.md +++ b/docs/matter.js/enums/cluster_export.SoftwareDiagnostics.Feature.md @@ -28,4 +28,4 @@ Node makes available the metrics for high watermark related to memory consumptio #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:106 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L106) diff --git a/docs/matter.js/enums/cluster_export.Switch.Feature.md b/docs/matter.js/enums/cluster_export.Switch.Feature.md index 85cb5d2b9c..98a6d41c97 100644 --- a/docs/matter.js/enums/cluster_export.Switch.Feature.md +++ b/docs/matter.js/enums/cluster_export.Switch.Feature.md @@ -30,7 +30,7 @@ LatchingSwitch #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:81 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L81) ___ @@ -42,7 +42,7 @@ MomentarySwitch #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:86 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L86) ___ @@ -54,7 +54,7 @@ MomentarySwitchLongPress #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:96 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L96) ___ @@ -66,7 +66,7 @@ MomentarySwitchMultiPress #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:101 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L101) ___ @@ -78,4 +78,4 @@ MomentarySwitchRelease #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:91 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L91) diff --git a/docs/matter.js/enums/cluster_export.TargetNavigator.Status.md b/docs/matter.js/enums/cluster_export.TargetNavigator.Status.md index 36b99dd3bc..bf6b562219 100644 --- a/docs/matter.js/enums/cluster_export.TargetNavigator.Status.md +++ b/docs/matter.js/enums/cluster_export.TargetNavigator.Status.md @@ -26,7 +26,7 @@ Target request is not allowed in current state. #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:79 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L79) ___ @@ -38,7 +38,7 @@ Command succeeded #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:69 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L69) ___ @@ -50,4 +50,4 @@ Requested target was not found in the TargetList #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:74 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L74) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.AcCapacityFormat.md b/docs/matter.js/enums/cluster_export.Thermostat.AcCapacityFormat.md index 3596db862b..004a7a23ef 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.AcCapacityFormat.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.AcCapacityFormat.md @@ -26,4 +26,4 @@ British Thermal Unit per Hour #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:404 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:404](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L404) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.AcCompressorType.md b/docs/matter.js/enums/cluster_export.Thermostat.AcCompressorType.md index 32089770c2..2e3cb4d968 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.AcCompressorType.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.AcCompressorType.md @@ -29,7 +29,7 @@ Max working ambient 43 °C #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:318 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:318](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L318) ___ @@ -41,7 +41,7 @@ Max working ambient 35 °C #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:323 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:323](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L323) ___ @@ -53,7 +53,7 @@ Max working ambient 52 °C #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:328 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:328](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L328) ___ @@ -65,4 +65,4 @@ Unknown compressor type #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:313 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:313](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L313) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.AcLouverPosition.md b/docs/matter.js/enums/cluster_export.Thermostat.AcLouverPosition.md index d2de70dae4..64836cf47b 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.AcLouverPosition.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.AcLouverPosition.md @@ -30,7 +30,7 @@ Fully Closed #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:372 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:372](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L372) ___ @@ -42,7 +42,7 @@ Half Open #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:387 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:387](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L387) ___ @@ -54,7 +54,7 @@ Fully Open #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:377 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:377](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L377) ___ @@ -66,7 +66,7 @@ Quarter Open #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:382 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:382](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L382) ___ @@ -78,4 +78,4 @@ Three Quarters Open #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:392 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:392](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L392) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.AcRefrigerantType.md b/docs/matter.js/enums/cluster_export.Thermostat.AcRefrigerantType.md index 163b99e164..1282d0db1f 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.AcRefrigerantType.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.AcRefrigerantType.md @@ -29,7 +29,7 @@ R22 Refrigerant #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:291 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L291) ___ @@ -41,7 +41,7 @@ R407c Refrigerant #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:301 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:301](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L301) ___ @@ -53,7 +53,7 @@ R410a Refrigerant #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:296 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L296) ___ @@ -65,4 +65,4 @@ Unknown Refrigerant Type #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:286 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:286](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L286) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.AcType.md b/docs/matter.js/enums/cluster_export.Thermostat.AcType.md index 8bb2e269a4..814d3ced41 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.AcType.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.AcType.md @@ -30,7 +30,7 @@ Cooling and Fixed Speed #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:259 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:259](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L259) ___ @@ -42,7 +42,7 @@ Cooling and Inverter #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:269 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:269](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L269) ___ @@ -54,7 +54,7 @@ Heat Pump and Fixed Speed #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:264 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L264) ___ @@ -66,7 +66,7 @@ Heat Pump and Inverter #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:274 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:274](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L274) ___ @@ -78,4 +78,4 @@ Unknown AC Type #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:254 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:254](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L254) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.ControlSequenceOfOperation.md b/docs/matter.js/enums/cluster_export.Thermostat.ControlSequenceOfOperation.md index 982eb64b05..e0b359cf8d 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.ControlSequenceOfOperation.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.ControlSequenceOfOperation.md @@ -31,7 +31,7 @@ All modes are possible #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:82 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L82) ___ @@ -43,7 +43,7 @@ All modes are possible #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:87 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L87) ___ @@ -55,7 +55,7 @@ Heat and Emergency are not possible #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:62 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L62) ___ @@ -67,7 +67,7 @@ Heat and Emergency are not possible #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:67 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L67) ___ @@ -79,7 +79,7 @@ Cool and precooling (see Terms) are not possible #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:72 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L72) ___ @@ -91,4 +91,4 @@ Cool and precooling are not possible #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:77 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L77) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.Feature.md b/docs/matter.js/enums/cluster_export.Thermostat.Feature.md index bcab34754a..455e29ff8c 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.Feature.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.Feature.md @@ -34,7 +34,7 @@ Supports a System Mode of Auto #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:566 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:566](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L566) ___ @@ -48,7 +48,7 @@ Thermostat is capable of managing a cooling device #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:538 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:538](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L538) ___ @@ -62,7 +62,7 @@ Thermostat is capable of managing a heating device #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:531 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:531](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L531) ___ @@ -76,7 +76,7 @@ Thermostat does not expose the LocalTemperature Value in the LocalTemperature at #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:573 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:573](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L573) ___ @@ -90,7 +90,7 @@ Supports Occupied and Unoccupied setpoints #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:545 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:545](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L545) ___ @@ -104,7 +104,7 @@ Supports remote configuration of a weekly schedule of setpoint transitions #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:552 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:552](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L552) ___ @@ -118,4 +118,4 @@ Supports configurable setback (or span) #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:559 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:559](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L559) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.SetpointAdjustMode.md b/docs/matter.js/enums/cluster_export.Thermostat.SetpointAdjustMode.md index f1ce1ab139..2b99417d19 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.SetpointAdjustMode.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.SetpointAdjustMode.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:410 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:410](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L410) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:409 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:409](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L409) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:408 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:408](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L408) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.SetpointChangeSource.md b/docs/matter.js/enums/cluster_export.Thermostat.SetpointChangeSource.md index 262e67dc79..f5a6230a32 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.SetpointChangeSource.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.SetpointChangeSource.md @@ -28,7 +28,7 @@ Externally-initiated setpoint change (e.g., DRLC cluster command, attribute writ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:242 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L242) ___ @@ -40,7 +40,7 @@ Manual, user-initiated setpoint change via the thermostat #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:232 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:232](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L232) ___ @@ -52,4 +52,4 @@ Schedule/internal programming-initiated setpoint change #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:237 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L237) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.StartOfWeek.md b/docs/matter.js/enums/cluster_export.Thermostat.StartOfWeek.md index d0b5638f01..7dfc98cb67 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.StartOfWeek.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.StartOfWeek.md @@ -30,7 +30,7 @@ The value of the Thermostat startOfWeek attribute #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:452 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:452](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L452) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:448 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:448](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L448) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:453 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:453](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L453) ___ @@ -60,7 +60,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:447 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:447](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L447) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:451 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:451](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L451) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:449 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:449](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L449) ___ @@ -90,4 +90,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:450 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:450](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L450) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.SystemMode.md b/docs/matter.js/enums/cluster_export.Thermostat.SystemMode.md index 7c3f0bf1c4..8d0ac62e47 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.SystemMode.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.SystemMode.md @@ -34,7 +34,7 @@ Demand is generated for either Cooling or Heating, as required #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:104 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:104](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L104) ___ @@ -46,7 +46,7 @@ Demand is only generated for Cooling #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:109 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L109) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:127 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L127) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:119 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L119) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:126 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L126) ___ @@ -90,7 +90,7 @@ Demand is only generated for Heating #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:114 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L114) ___ @@ -102,7 +102,7 @@ The Thermostat does not generate demand for Cooling or Heating #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:99 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L99) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:124 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L124) ___ @@ -124,4 +124,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:128 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L128) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.TemperatureSetpointHold.md b/docs/matter.js/enums/cluster_export.Thermostat.TemperatureSetpointHold.md index d4323af34d..16578be85c 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.TemperatureSetpointHold.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.TemperatureSetpointHold.md @@ -27,7 +27,7 @@ Follow scheduling program #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:151 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L151) ___ @@ -39,4 +39,4 @@ Maintain current setpoint, regardless of schedule transitions #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:156 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L156) diff --git a/docs/matter.js/enums/cluster_export.Thermostat.ThermostatRunningMode.md b/docs/matter.js/enums/cluster_export.Thermostat.ThermostatRunningMode.md index 5a9f465a4f..8067acd666 100644 --- a/docs/matter.js/enums/cluster_export.Thermostat.ThermostatRunningMode.md +++ b/docs/matter.js/enums/cluster_export.Thermostat.ThermostatRunningMode.md @@ -26,7 +26,7 @@ The value of the Thermostat thermostatRunningMode attribute #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:437 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:437](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L437) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:438 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:438](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L438) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:436 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:436](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L436) diff --git a/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.KeypadLockout.md b/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.KeypadLockout.md index 6db49de8fb..be44ddb3ed 100644 --- a/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.KeypadLockout.md +++ b/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.KeypadLockout.md @@ -31,7 +31,7 @@ Level 1 reduced functionality #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:46 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L46) ___ @@ -43,7 +43,7 @@ Level 2 reduced functionality #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:51 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L51) ___ @@ -55,7 +55,7 @@ Level 3 reduced functionality #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:56 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L56) ___ @@ -67,7 +67,7 @@ Level 4 reduced functionality #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:61 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L61) ___ @@ -79,7 +79,7 @@ Least functionality available to the user #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:66 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L66) ___ @@ -91,4 +91,4 @@ All functionality available to the user #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:41 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L41) diff --git a/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.md b/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.md index ffd561397f..78b0eb814e 100644 --- a/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.md +++ b/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.ScheduleProgrammingVisibility.md @@ -27,7 +27,7 @@ Local schedule programming functionality is disabled at the thermostat #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:83 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L83) ___ @@ -39,4 +39,4 @@ Local schedule programming functionality is enabled at the thermostat #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:78 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L78) diff --git a/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.md b/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.md index 8fa49814f9..68236e3127 100644 --- a/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.md +++ b/docs/matter.js/enums/cluster_export.ThermostatUserInterfaceConfiguration.TemperatureDisplayMode.md @@ -27,7 +27,7 @@ Temperature displayed in °C #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:24 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L24) ___ @@ -39,4 +39,4 @@ Temperature displayed in °F #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:29 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L29) diff --git a/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.ConnectionStatus.md b/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.ConnectionStatus.md index a680719a6c..659393fa6d 100644 --- a/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.ConnectionStatus.md +++ b/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.ConnectionStatus.md @@ -25,7 +25,7 @@ Node is connected #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:403 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:403](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L403) ___ @@ -37,4 +37,4 @@ Node is not connected #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:408 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:408](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L408) diff --git a/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.Feature.md b/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.Feature.md index cd93cd265d..a925f7ab5b 100644 --- a/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.Feature.md +++ b/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.Feature.md @@ -32,7 +32,7 @@ of packets on the Thread interface. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:460 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:460](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L460) ___ @@ -46,7 +46,7 @@ Server supports the counts for various MAC layer happenings. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:474 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:474](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L474) ___ @@ -60,7 +60,7 @@ Server supports the counts for various MLE layer happenings. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:467 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:467](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L467) ___ @@ -74,4 +74,4 @@ Server supports the counts for the number of received and transmitted packets on #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:452 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:452](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L452) diff --git a/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.NetworkFault.md b/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.NetworkFault.md index 2251e55ad5..f03141689d 100644 --- a/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.NetworkFault.md +++ b/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.NetworkFault.md @@ -27,7 +27,7 @@ Indicates there has been Thread hardware failure. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:388 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:388](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L388) ___ @@ -39,7 +39,7 @@ Indicates the Thread link is down. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:383 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:383](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L383) ___ @@ -51,7 +51,7 @@ Indicates the Thread network is jammed. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:393 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:393](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L393) ___ @@ -63,4 +63,4 @@ Indicates an unspecified fault. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:378 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:378](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L378) diff --git a/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.RoutingRole.md b/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.RoutingRole.md index 99db3ecc93..18112b522d 100644 --- a/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.RoutingRole.md +++ b/docs/matter.js/enums/cluster_export.ThreadNetworkDiagnostics.RoutingRole.md @@ -30,7 +30,7 @@ The Node acts as an End Device without RX- off-when-idle sleepy radio behavior. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:53 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L53) ___ @@ -42,7 +42,7 @@ The Node acts as a Leader Device. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:68 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L68) ___ @@ -54,7 +54,7 @@ The Node acts as an Router Eligible End Device. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:58 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L58) ___ @@ -66,7 +66,7 @@ The Node acts as a Router Device. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:63 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L63) ___ @@ -78,7 +78,7 @@ The Node acts as a Sleepy End Device with RX-off-when-idle sleepy radio behavior #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:48 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L48) ___ @@ -91,7 +91,7 @@ or operational. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:43 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L43) ___ @@ -103,4 +103,4 @@ Unspecified routing role. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:37 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L37) diff --git a/docs/matter.js/enums/cluster_export.TimeFormatLocalization.CalendarType.md b/docs/matter.js/enums/cluster_export.TimeFormatLocalization.CalendarType.md index d09a78312f..4ff2b32a4f 100644 --- a/docs/matter.js/enums/cluster_export.TimeFormatLocalization.CalendarType.md +++ b/docs/matter.js/enums/cluster_export.TimeFormatLocalization.CalendarType.md @@ -35,7 +35,7 @@ Dates conveyed using the Buddhist calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:40 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L40) ___ @@ -47,7 +47,7 @@ Dates conveyed using the Chinese calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:45 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L45) ___ @@ -59,7 +59,7 @@ Dates conveyed using the Coptic calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:50 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L50) ___ @@ -71,7 +71,7 @@ Dates conveyed using the Ethiopian calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:55 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L55) ___ @@ -83,7 +83,7 @@ Dates conveyed using the Gregorian calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:60 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L60) ___ @@ -95,7 +95,7 @@ Dates conveyed using the Hebrew calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:65 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L65) ___ @@ -107,7 +107,7 @@ Dates conveyed using the Indian calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:70 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L70) ___ @@ -119,7 +119,7 @@ Dates conveyed using the Islamic calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:75 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L75) ___ @@ -131,7 +131,7 @@ Dates conveyed using the Japanese calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:80 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L80) ___ @@ -143,7 +143,7 @@ Dates conveyed using the Korean calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:85 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L85) ___ @@ -155,7 +155,7 @@ Dates conveyed using the Persian calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:90 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L90) ___ @@ -167,4 +167,4 @@ Dates conveyed using the Taiwanese calendar #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:95 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L95) diff --git a/docs/matter.js/enums/cluster_export.TimeFormatLocalization.Feature.md b/docs/matter.js/enums/cluster_export.TimeFormatLocalization.Feature.md index 13c5960c1e..e6c81fa00b 100644 --- a/docs/matter.js/enums/cluster_export.TimeFormatLocalization.Feature.md +++ b/docs/matter.js/enums/cluster_export.TimeFormatLocalization.Feature.md @@ -28,4 +28,4 @@ The Node can be configured to use different calendar formats when conveying valu #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:109 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L109) diff --git a/docs/matter.js/enums/cluster_export.TimeFormatLocalization.HourFormat.md b/docs/matter.js/enums/cluster_export.TimeFormatLocalization.HourFormat.md index 58bea98bae..82aa7e2cbe 100644 --- a/docs/matter.js/enums/cluster_export.TimeFormatLocalization.HourFormat.md +++ b/docs/matter.js/enums/cluster_export.TimeFormatLocalization.HourFormat.md @@ -25,7 +25,7 @@ Time conveyed with a 12-hour clock #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:25 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L25) ___ @@ -37,4 +37,4 @@ Time conveyed with a 24-hour clock #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:30 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L30) diff --git a/docs/matter.js/enums/cluster_export.TimeSync.Feature.md b/docs/matter.js/enums/cluster_export.TimeSync.Feature.md index ef147a3885..cf14244f6f 100644 --- a/docs/matter.js/enums/cluster_export.TimeSync.Feature.md +++ b/docs/matter.js/enums/cluster_export.TimeSync.Feature.md @@ -30,7 +30,7 @@ Server supports an NTP or SNTP client. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:278 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:278](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L278) ___ @@ -44,7 +44,7 @@ Server supports an NTP server role. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:285 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:285](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L285) ___ @@ -58,4 +58,4 @@ Server supports time zone. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:271 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L271) diff --git a/docs/matter.js/enums/cluster_export.TimeSync.Granularity.md b/docs/matter.js/enums/cluster_export.TimeSync.Granularity.md index 7ac16c2194..16289bc58e 100644 --- a/docs/matter.js/enums/cluster_export.TimeSync.Granularity.md +++ b/docs/matter.js/enums/cluster_export.TimeSync.Granularity.md @@ -29,7 +29,7 @@ protocol such as PTP, or has built-in GNSS. UTC time is accurate to ± 10 μs. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:66 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L66) ___ @@ -43,7 +43,7 @@ is accurate to ± 50ms. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:60 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L60) ___ @@ -56,7 +56,7 @@ occurred such that the clock error is now > 5 seconds. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:47 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L47) ___ @@ -69,7 +69,7 @@ on the Last Known Good UTC Time only. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:41 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L41) ___ @@ -82,4 +82,4 @@ accurate to ± 5 seconds. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:53 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L53) diff --git a/docs/matter.js/enums/cluster_export.TimeSync.StatusCode.md b/docs/matter.js/enums/cluster_export.TimeSync.StatusCode.md index 7ff0d875df..cf44f11841 100644 --- a/docs/matter.js/enums/cluster_export.TimeSync.StatusCode.md +++ b/docs/matter.js/enums/cluster_export.TimeSync.StatusCode.md @@ -24,4 +24,4 @@ Server rejected the attempt to set the UTC time #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:194 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L194) diff --git a/docs/matter.js/enums/cluster_export.TimeSync.TimeSource.md b/docs/matter.js/enums/cluster_export.TimeSync.TimeSource.md index 2ac492d163..bcfa873c92 100644 --- a/docs/matter.js/enums/cluster_export.TimeSync.TimeSource.md +++ b/docs/matter.js/enums/cluster_export.TimeSync.TimeSource.md @@ -40,7 +40,7 @@ Server received time from the Section 11.16.9.1, “SetUtcTime Command”. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:86 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L86) ___ @@ -53,7 +53,7 @@ connection). #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:147 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L147) ___ @@ -65,7 +65,7 @@ NTP from a servers within the Fabric. None of the servers used NTS. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:111 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L111) ___ @@ -77,7 +77,7 @@ NTP from a server within the Fabric. NTS is used on at least one server. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:136 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L136) ___ @@ -89,7 +89,7 @@ SNTP from a server within the Fabric. NTS is not used. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:106 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L106) ___ @@ -101,7 +101,7 @@ SNTP from a server within the Fabric. NTS is used. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:131 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L131) ___ @@ -113,7 +113,7 @@ Time synchronization comes from a GNSS source. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:157 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L157) ___ @@ -125,7 +125,7 @@ NTP from multiple servers on Fabric and external. None of the servers used NTS. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:116 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L116) ___ @@ -137,7 +137,7 @@ NTP from multiple servers on the Fabric and external. NTS is used on at least on #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:141 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L141) ___ @@ -149,7 +149,7 @@ Synchronized time by querying the Time Cluster of another Node. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:91 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L91) ___ @@ -161,7 +161,7 @@ NTP from servers not in the Fabric. None of the servers used NTS. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:101 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L101) ___ @@ -173,7 +173,7 @@ NTP from servers not in the Fabric. NTS is used on at least one server. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:126 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L126) ___ @@ -185,7 +185,7 @@ SNTP from a server not in the Fabric. NTS is not used. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:96 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L96) ___ @@ -197,7 +197,7 @@ SNTP from a server not in the Fabric. NTS is used. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:121 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L121) ___ @@ -209,7 +209,7 @@ Server is not currently synchronized with a UTC Time source. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:76 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L76) ___ @@ -221,7 +221,7 @@ Time synchronization comes from PTP. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:152 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L152) ___ @@ -233,4 +233,4 @@ Server uses an unlisted time source. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:81 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L81) diff --git a/docs/matter.js/enums/cluster_export.UnitLocalization.Feature.md b/docs/matter.js/enums/cluster_export.UnitLocalization.Feature.md index f6f807aaad..954f60b722 100644 --- a/docs/matter.js/enums/cluster_export.UnitLocalization.Feature.md +++ b/docs/matter.js/enums/cluster_export.UnitLocalization.Feature.md @@ -28,4 +28,4 @@ The Node can be configured to use different units of temperature when conveying #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:48 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L48) diff --git a/docs/matter.js/enums/cluster_export.UnitLocalization.TempUnit.md b/docs/matter.js/enums/cluster_export.UnitLocalization.TempUnit.md index 4ca860e20d..02d7ffa3f4 100644 --- a/docs/matter.js/enums/cluster_export.UnitLocalization.TempUnit.md +++ b/docs/matter.js/enums/cluster_export.UnitLocalization.TempUnit.md @@ -26,7 +26,7 @@ Temperature conveyed in Celsius #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:29 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L29) ___ @@ -38,7 +38,7 @@ Temperature conveyed in Fahrenheit #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:24 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L24) ___ @@ -50,4 +50,4 @@ Temperature conveyed in Kelvin #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:34 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L34) diff --git a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.AssociationFailureCause.md b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.AssociationFailureCause.md index 29c5fe4a61..70974849c1 100644 --- a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.AssociationFailureCause.md +++ b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.AssociationFailureCause.md @@ -27,7 +27,7 @@ An error occurred during association. #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:124 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L124) ___ @@ -39,7 +39,7 @@ An error occurred during authentication. #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:129 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L129) ___ @@ -51,7 +51,7 @@ The specified SSID could not be found. #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:134 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L134) ___ @@ -63,4 +63,4 @@ The reason for the failure is unknown. #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:119 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L119) diff --git a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.ConnectionStatus.md b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.ConnectionStatus.md index 60a197b1a1..c6d4606629 100644 --- a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.ConnectionStatus.md +++ b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.ConnectionStatus.md @@ -25,7 +25,7 @@ Indicate the node is connected #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:175 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:175](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L175) ___ @@ -37,4 +37,4 @@ Indicate the node is not connected #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:180 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L180) diff --git a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.Feature.md b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.Feature.md index 51607b2902..de16334727 100644 --- a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.Feature.md +++ b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.Feature.md @@ -30,7 +30,7 @@ transmission of packets on the Wi-Fi interface. #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:209 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L209) ___ @@ -44,4 +44,4 @@ Node makes available the counts for the number of received and transmitted packe #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:201 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:201](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L201) diff --git a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.SecurityType.md b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.SecurityType.md index eef9da118c..4f8d307c84 100644 --- a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.SecurityType.md +++ b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.SecurityType.md @@ -29,7 +29,7 @@ Indicate the usage of no Wi-Fi security #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:39 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L39) ___ @@ -41,7 +41,7 @@ Indicate the usage of an unspecified Wi-Fi security type #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:34 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L34) ___ @@ -53,7 +53,7 @@ Indicate the usage of WEP Wi-Fi security #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:44 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L44) ___ @@ -65,7 +65,7 @@ Indicate the usage of WPA Wi-Fi security #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:49 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L49) ___ @@ -77,7 +77,7 @@ Indicate the usage of WPA2 Wi-Fi security #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:54 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L54) ___ @@ -89,4 +89,4 @@ Indicate the usage of WPA3 Wi-Fi security #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:59 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L59) diff --git a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.WiFiVersion.md b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.WiFiVersion.md index a89eef660b..198a6d271e 100644 --- a/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.WiFiVersion.md +++ b/docs/matter.js/enums/cluster_export.WiFiNetworkDiagnostics.WiFiVersion.md @@ -29,7 +29,7 @@ Indicate the network interface is currently using 802.11a against the wireless a #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:69 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L69) ___ @@ -41,7 +41,7 @@ Indicate the network interface is currently using 802.11ac against the wireless #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:89 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L89) ___ @@ -53,7 +53,7 @@ Indicate the network interface is currently using 802.11ax against the wireless #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:94 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L94) ___ @@ -65,7 +65,7 @@ Indicate the network interface is currently using 802.11b against the wireless a #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:74 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L74) ___ @@ -77,7 +77,7 @@ Indicate the network interface is currently using 802.11g against the wireless a #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:79 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L79) ___ @@ -89,4 +89,4 @@ Indicate the network interface is currently using 802.11n against the wireless a #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:84 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L84) diff --git a/docs/matter.js/enums/cluster_export.WindowCovering.EndProductType.md b/docs/matter.js/enums/cluster_export.WindowCovering.EndProductType.md index 38ae408e9f..65c1a0f7d1 100644 --- a/docs/matter.js/enums/cluster_export.WindowCovering.EndProductType.md +++ b/docs/matter.js/enums/cluster_export.WindowCovering.EndProductType.md @@ -48,7 +48,7 @@ The value of the WindowCovering endProductType attribute #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:168 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L168) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:169 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L169) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:151 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L151) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:154 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L154) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:165 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L165) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:162 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L162) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:167 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L167) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:159 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:159](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L159) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:161 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:161](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L161) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:163 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L163) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:164 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:164](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L164) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:155 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L155) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:156 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L156) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:153 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L153) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:149 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L149) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:166 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L166) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:150 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L150) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:157 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L157) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:172 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L172) ___ @@ -238,7 +238,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:171 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L171) ___ @@ -248,7 +248,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:158 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L158) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:170 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L170) ___ @@ -268,7 +268,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:173 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L173) ___ @@ -278,7 +278,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:160 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L160) ___ @@ -288,4 +288,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:152 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L152) diff --git a/docs/matter.js/enums/cluster_export.WindowCovering.Feature.md b/docs/matter.js/enums/cluster_export.WindowCovering.Feature.md index 71c386ac1f..1c56f9da4b 100644 --- a/docs/matter.js/enums/cluster_export.WindowCovering.Feature.md +++ b/docs/matter.js/enums/cluster_export.WindowCovering.Feature.md @@ -32,7 +32,7 @@ Absolute positioning is supported. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:352 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:352](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L352) ___ @@ -46,7 +46,7 @@ Lift Control and behavior for lifting/sliding window coverings #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:331 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:331](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L331) ___ @@ -60,7 +60,7 @@ Position Aware lift control is supported. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:345 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:345](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L345) ___ @@ -74,7 +74,7 @@ Position Aware tilt control is supported. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:359 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:359](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L359) ___ @@ -88,4 +88,4 @@ Tilt Control and behavior for tilting window coverings #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:338 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L338) diff --git a/docs/matter.js/enums/cluster_export.WindowCovering.MovementStatus.md b/docs/matter.js/enums/cluster_export.WindowCovering.MovementStatus.md index b44efc91f8..bf1fcfe0a8 100644 --- a/docs/matter.js/enums/cluster_export.WindowCovering.MovementStatus.md +++ b/docs/matter.js/enums/cluster_export.WindowCovering.MovementStatus.md @@ -24,7 +24,7 @@ Covering is moving from open to closed #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:140 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L140) ___ @@ -36,7 +36,7 @@ Covering is moving from closed to open #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:135 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L135) ___ @@ -48,4 +48,4 @@ Covering is not moving #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:130 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L130) diff --git a/docs/matter.js/enums/cluster_export.WindowCovering.WindowCoveringType.md b/docs/matter.js/enums/cluster_export.WindowCovering.WindowCoveringType.md index 46b051dabc..6e080f740c 100644 --- a/docs/matter.js/enums/cluster_export.WindowCovering.WindowCoveringType.md +++ b/docs/matter.js/enums/cluster_export.WindowCovering.WindowCoveringType.md @@ -34,7 +34,7 @@ The value of the WindowCovering type attribute #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:46 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L46) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:45 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L45) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:50 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L50) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:41 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L41) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:42 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L42) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:43 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L43) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:44 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L44) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:47 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L47) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:49 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L49) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:48 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L48) ___ @@ -134,4 +134,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:51 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L51) diff --git a/docs/matter.js/enums/codec_export.BtpHeaderBits.md b/docs/matter.js/enums/codec_export.BtpHeaderBits.md index 0faac7fd8f..308d75a2d9 100644 --- a/docs/matter.js/enums/codec_export.BtpHeaderBits.md +++ b/docs/matter.js/enums/codec_export.BtpHeaderBits.md @@ -23,7 +23,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:59 +[packages/matter.js/src/codec/BtpCodec.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L59) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:62 +[packages/matter.js/src/codec/BtpCodec.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L62) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:61 +[packages/matter.js/src/codec/BtpCodec.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L61) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:60 +[packages/matter.js/src/codec/BtpCodec.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L60) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:57 +[packages/matter.js/src/codec/BtpCodec.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L57) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:58 +[packages/matter.js/src/codec/BtpCodec.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L58) diff --git a/docs/matter.js/enums/codec_export.BtpOpcode.md b/docs/matter.js/enums/codec_export.BtpOpcode.md index b25fdaad26..0cf9a9fd1c 100644 --- a/docs/matter.js/enums/codec_export.BtpOpcode.md +++ b/docs/matter.js/enums/codec_export.BtpOpcode.md @@ -18,4 +18,4 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:66 +[packages/matter.js/src/codec/BtpCodec.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L66) diff --git a/docs/matter.js/enums/codec_export.DerType.md b/docs/matter.js/enums/codec_export.DerType.md index e12a296d53..3524c07a62 100644 --- a/docs/matter.js/enums/codec_export.DerType.md +++ b/docs/matter.js/enums/codec_export.DerType.md @@ -26,7 +26,7 @@ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:19 +[packages/matter.js/src/codec/DerCodec.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L19) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:17 +[packages/matter.js/src/codec/DerCodec.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L17) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:21 +[packages/matter.js/src/codec/DerCodec.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L21) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:20 +[packages/matter.js/src/codec/DerCodec.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L20) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:23 +[packages/matter.js/src/codec/DerCodec.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L23) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:24 +[packages/matter.js/src/codec/DerCodec.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L24) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:22 +[packages/matter.js/src/codec/DerCodec.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L22) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:18 +[packages/matter.js/src/codec/DerCodec.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L18) ___ @@ -106,4 +106,4 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:25 +[packages/matter.js/src/codec/DerCodec.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L25) diff --git a/docs/matter.js/enums/codec_export.DnsMessageType.md b/docs/matter.js/enums/codec_export.DnsMessageType.md index 45d1b39fc5..230c83eb53 100644 --- a/docs/matter.js/enums/codec_export.DnsMessageType.md +++ b/docs/matter.js/enums/codec_export.DnsMessageType.md @@ -21,7 +21,7 @@ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:103 +[packages/matter.js/src/codec/DnsCodec.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L103) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:105 +[packages/matter.js/src/codec/DnsCodec.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L105) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:104 +[packages/matter.js/src/codec/DnsCodec.ts:104](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L104) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:106 +[packages/matter.js/src/codec/DnsCodec.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L106) diff --git a/docs/matter.js/enums/codec_export.DnsRecordClass.md b/docs/matter.js/enums/codec_export.DnsRecordClass.md index 6ebb141cd5..634ef78d0c 100644 --- a/docs/matter.js/enums/codec_export.DnsRecordClass.md +++ b/docs/matter.js/enums/codec_export.DnsRecordClass.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:121 +[packages/matter.js/src/codec/DnsCodec.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L121) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:120 +[packages/matter.js/src/codec/DnsCodec.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L120) diff --git a/docs/matter.js/enums/codec_export.DnsRecordType.md b/docs/matter.js/enums/codec_export.DnsRecordType.md index ec5fc420d1..22641d8acc 100644 --- a/docs/matter.js/enums/codec_export.DnsRecordType.md +++ b/docs/matter.js/enums/codec_export.DnsRecordType.md @@ -24,7 +24,7 @@ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:110 +[packages/matter.js/src/codec/DnsCodec.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L110) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:113 +[packages/matter.js/src/codec/DnsCodec.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L113) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:116 +[packages/matter.js/src/codec/DnsCodec.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L116) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:115 +[packages/matter.js/src/codec/DnsCodec.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L115) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:111 +[packages/matter.js/src/codec/DnsCodec.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L111) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:114 +[packages/matter.js/src/codec/DnsCodec.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L114) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:112 +[packages/matter.js/src/codec/DnsCodec.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L112) diff --git a/docs/matter.js/enums/codec_export.SessionType.md b/docs/matter.js/enums/codec_export.SessionType.md index 4dce7d1458..3d9db7f65c 100644 --- a/docs/matter.js/enums/codec_export.SessionType.md +++ b/docs/matter.js/enums/codec_export.SessionType.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:50 +[packages/matter.js/src/codec/MessageCodec.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L50) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:51 +[packages/matter.js/src/codec/MessageCodec.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L51) diff --git a/docs/matter.js/enums/crypto_export.CurveType.md b/docs/matter.js/enums/crypto_export.CurveType.md index 6d18c90e7e..b31ecafa6e 100644 --- a/docs/matter.js/enums/crypto_export.CurveType.md +++ b/docs/matter.js/enums/crypto_export.CurveType.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/crypto/Key.ts:42 +[packages/matter.js/src/crypto/Key.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L42) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Key.ts:43 +[packages/matter.js/src/crypto/Key.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L43) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/crypto/Key.ts:44 +[packages/matter.js/src/crypto/Key.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L44) diff --git a/docs/matter.js/enums/crypto_export.KeyType.md b/docs/matter.js/enums/crypto_export.KeyType.md index a6bf3184d1..b843f0f307 100644 --- a/docs/matter.js/enums/crypto_export.KeyType.md +++ b/docs/matter.js/enums/crypto_export.KeyType.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/crypto/Key.ts:36 +[packages/matter.js/src/crypto/Key.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L36) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Key.ts:37 +[packages/matter.js/src/crypto/Key.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L37) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/crypto/Key.ts:38 +[packages/matter.js/src/crypto/Key.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L38) diff --git a/docs/matter.js/enums/device_export.DeviceClasses.md b/docs/matter.js/enums/device_export.DeviceClasses.md index 97a2f9d32d..250265f592 100644 --- a/docs/matter.js/enums/device_export.DeviceClasses.md +++ b/docs/matter.js/enums/device_export.DeviceClasses.md @@ -37,7 +37,7 @@ Application devices types are typically the most datatype endpoints on a node an #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:24 +[packages/matter.js/src/device/DeviceTypes.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L24) ___ @@ -50,7 +50,7 @@ its power source is available to the Bridge #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:62 +[packages/matter.js/src/device/DeviceTypes.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L62) ___ @@ -62,7 +62,7 @@ There exists a client application cluster on the endpoint. #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:41 +[packages/matter.js/src/device/DeviceTypes.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L41) ___ @@ -74,7 +74,7 @@ The device type is composed of 2 or more device types. #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:47 +[packages/matter.js/src/device/DeviceTypes.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L47) ___ @@ -89,7 +89,7 @@ application device type. #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:38 +[packages/matter.js/src/device/DeviceTypes.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L38) ___ @@ -101,7 +101,7 @@ The endpoint is an Initiator for Zigbee EZ-Mode Finding & Binding. #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:53 +[packages/matter.js/src/device/DeviceTypes.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L53) ___ @@ -113,7 +113,7 @@ The endpoint is a Target for Zigbee EZ-Mode Finding & Binding. #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:56 +[packages/matter.js/src/device/DeviceTypes.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L56) ___ @@ -125,7 +125,7 @@ Composed device type that is composed of 2 or more endpoints with the same devic #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:50 +[packages/matter.js/src/device/DeviceTypes.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L50) ___ @@ -137,7 +137,7 @@ Node device type. #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:18 +[packages/matter.js/src/device/DeviceTypes.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L18) ___ @@ -149,7 +149,7 @@ There exists a server application cluster on the endpoint. #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:44 +[packages/matter.js/src/device/DeviceTypes.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L44) ___ @@ -162,4 +162,4 @@ A Simple device type supports local control that is persistent, independent, and #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:30 +[packages/matter.js/src/device/DeviceTypes.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L30) diff --git a/docs/matter.js/enums/device_export.NodeStateInformation.md b/docs/matter.js/enums/device_export.NodeStateInformation.md new file mode 100644 index 0000000000..03bce7d42a --- /dev/null +++ b/docs/matter.js/enums/device_export.NodeStateInformation.md @@ -0,0 +1,78 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [device/export](../modules/device_export.md) / NodeStateInformation + +# Enumeration: NodeStateInformation + +[device/export](../modules/device_export.md).NodeStateInformation + +## Table of contents + +### Enumeration Members + +- [Connected](device_export.NodeStateInformation.md#connected) +- [Disconnected](device_export.NodeStateInformation.md#disconnected) +- [Reconnecting](device_export.NodeStateInformation.md#reconnecting) +- [StructureChanged](device_export.NodeStateInformation.md#structurechanged) +- [WaitingForDeviceDiscovery](device_export.NodeStateInformation.md#waitingfordevicediscovery) + +## Enumeration Members + +### Connected + +• **Connected** = ``0`` + +Node is connected and all data is up-to-date. + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L63) + +___ + +### Disconnected + +• **Disconnected** = ``1`` + +Node is disconnected. Data are stale and interactions will most likely return an error. If controller instance +is still active then the device will be reconnected once it is available again. + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L69) + +___ + +### Reconnecting + +• **Reconnecting** = ``2`` + +Node is reconnecting. Data are stale. It is yet unknown if the reconnection is successful. + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L72) + +___ + +### StructureChanged + +• **StructureChanged** = ``4`` + +Node structure has changed (Endpoints got added or also removed). Data are up-to-date. +This State information will only be fired when the subscribeAllAttributesAndEvents option is set to true. + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L84) + +___ + +### WaitingForDeviceDiscovery + +• **WaitingForDeviceDiscovery** = ``3`` + +The node could not be connected and the controller is now waiting for a MDNS announcement and tries every 10 +minutes to reconnect. + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L78) diff --git a/docs/matter.js/enums/export._internal_.CommissioningStepResultCode.md b/docs/matter.js/enums/export._internal_.CommissioningStepResultCode.md index ef38ad548b..6bdf5c3c88 100644 --- a/docs/matter.js/enums/export._internal_.CommissioningStepResultCode.md +++ b/docs/matter.js/enums/export._internal_.CommissioningStepResultCode.md @@ -4,7 +4,7 @@ [export](../modules/export.md).[](../modules/export._internal_.md).CommissioningStepResultCode -Result code of a single commissioning step +Result code of a single commissioning step. ## Table of contents @@ -22,7 +22,7 @@ Result code of a single commissioning step #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:66 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L68) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:67 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L69) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:65 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L67) diff --git a/docs/matter.js/enums/export._internal_.TagControl.md b/docs/matter.js/enums/export._internal_.TagControl.md index c4f585d593..f851f45ee1 100644 --- a/docs/matter.js/enums/export._internal_.TagControl.md +++ b/docs/matter.js/enums/export._internal_.TagControl.md @@ -31,7 +31,7 @@ TLV element tag control. #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:87 +[packages/matter.js/src/tlv/TlvCodec.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L87) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:89 +[packages/matter.js/src/tlv/TlvCodec.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L89) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:90 +[packages/matter.js/src/tlv/TlvCodec.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L90) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:88 +[packages/matter.js/src/tlv/TlvCodec.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L88) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:93 +[packages/matter.js/src/tlv/TlvCodec.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L93) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:94 +[packages/matter.js/src/tlv/TlvCodec.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L94) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:91 +[packages/matter.js/src/tlv/TlvCodec.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L91) ___ @@ -101,4 +101,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:92 +[packages/matter.js/src/tlv/TlvCodec.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L92) diff --git a/docs/matter.js/enums/log_export.Format.md b/docs/matter.js/enums/log_export.Format.md index a70696de2a..514ecf3500 100644 --- a/docs/matter.js/enums/log_export.Format.md +++ b/docs/matter.js/enums/log_export.Format.md @@ -24,7 +24,7 @@ Format log messages using ANSI escape codes #### Defined in -packages/matter.js/src/log/Logger.ts:27 +[packages/matter.js/src/log/Logger.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L27) ___ @@ -36,7 +36,7 @@ Format log messages using HTML tags #### Defined in -packages/matter.js/src/log/Logger.ts:30 +[packages/matter.js/src/log/Logger.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L30) ___ @@ -48,4 +48,4 @@ Generate text only #### Defined in -packages/matter.js/src/log/Logger.ts:24 +[packages/matter.js/src/log/Logger.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L24) diff --git a/docs/matter.js/enums/log_export.Level.md b/docs/matter.js/enums/log_export.Level.md index 8bc5a709ba..09f142e032 100644 --- a/docs/matter.js/enums/log_export.Level.md +++ b/docs/matter.js/enums/log_export.Level.md @@ -22,7 +22,7 @@ #### Defined in -packages/matter.js/src/log/Logger.ts:12 +[packages/matter.js/src/log/Logger.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L12) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:15 +[packages/matter.js/src/log/Logger.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L15) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:16 +[packages/matter.js/src/log/Logger.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L16) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:13 +[packages/matter.js/src/log/Logger.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L13) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -packages/matter.js/src/log/Logger.ts:14 +[packages/matter.js/src/log/Logger.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L14) diff --git a/docs/matter.js/enums/mdns_export.AnnouncementType.md b/docs/matter.js/enums/mdns_export.AnnouncementType.md index 53b04b71c7..d71b4d2bdd 100644 --- a/docs/matter.js/enums/mdns_export.AnnouncementType.md +++ b/docs/matter.js/enums/mdns_export.AnnouncementType.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:31 +[packages/matter.js/src/mdns/MdnsServer.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L31) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:32 +[packages/matter.js/src/mdns/MdnsServer.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L32) diff --git a/docs/matter.js/enums/model.Access.Fabric.md b/docs/matter.js/enums/model.Access.Fabric.md new file mode 100644 index 0000000000..c74cd49707 --- /dev/null +++ b/docs/matter.js/enums/model.Access.Fabric.md @@ -0,0 +1,51 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Access](../modules/model.Access.md) / Fabric + +# Enumeration: Fabric + +[model](../modules/model.md).[Access](../modules/model.Access.md).Fabric + +Affect of fabric on access. + +## Table of contents + +### Enumeration Members + +- [Scoped](model.Access.Fabric.md#scoped) +- [Sensitive](model.Access.Fabric.md#sensitive) +- [Unaware](model.Access.Fabric.md#unaware) + +## Enumeration Members + +### Scoped + +• **Scoped** = ``"F"`` + +Writable only by scoped fabric. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:277](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L277) + +___ + +### Sensitive + +• **Sensitive** = ``"S"`` + +Readable and writable only by scoped fabric. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:282](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L282) + +___ + +### Unaware + +• **Unaware** = ``"U"`` + +Extension - allows for override of fabric specification. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:272](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L272) diff --git a/docs/matter.js/enums/model.Access.Privilege.md b/docs/matter.js/enums/model.Access.Privilege.md new file mode 100644 index 0000000000..b0b9b339f5 --- /dev/null +++ b/docs/matter.js/enums/model.Access.Privilege.md @@ -0,0 +1,64 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Access](../modules/model.Access.md) / Privilege + +# Enumeration: Privilege + +[model](../modules/model.md).[Access](../modules/model.Access.md).Privilege + +Privilege required for access. + +## Table of contents + +### Enumeration Members + +- [Administer](model.Access.Privilege.md#administer) +- [Manage](model.Access.Privilege.md#manage) +- [Operate](model.Access.Privilege.md#operate) +- [View](model.Access.Privilege.md#view) + +## Enumeration Members + +### Administer + +• **Administer** = ``"A"`` + +Administer privilege. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:307](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L307) + +___ + +### Manage + +• **Manage** = ``"M"`` + +Manage privilege. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:302](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L302) + +___ + +### Operate + +• **Operate** = ``"O"`` + +Operate privilege. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:297](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L297) + +___ + +### View + +• **View** = ``"V"`` + +View privilege. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:292](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L292) diff --git a/docs/matter.js/enums/model.Access.PrivilegeName.md b/docs/matter.js/enums/model.Access.PrivilegeName.md new file mode 100644 index 0000000000..6962517d01 --- /dev/null +++ b/docs/matter.js/enums/model.Access.PrivilegeName.md @@ -0,0 +1,56 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Access](../modules/model.Access.md) / PrivilegeName + +# Enumeration: PrivilegeName + +[model](../modules/model.md).[Access](../modules/model.Access.md).PrivilegeName + +Reverse map of Privilege. + +## Table of contents + +### Enumeration Members + +- [A](model.Access.PrivilegeName.md#a) +- [M](model.Access.PrivilegeName.md#m) +- [O](model.Access.PrivilegeName.md#o) +- [V](model.Access.PrivilegeName.md#v) + +## Enumeration Members + +### A + +• **A** = ``"Administer"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:317](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L317) + +___ + +### M + +• **M** = ``"Manage"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:316](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L316) + +___ + +### O + +• **O** = ``"Operate"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:315](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L315) + +___ + +### V + +• **V** = ``"View"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:314](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L314) diff --git a/docs/matter.js/enums/model.Access.Rw.md b/docs/matter.js/enums/model.Access.Rw.md new file mode 100644 index 0000000000..a3fa897adb --- /dev/null +++ b/docs/matter.js/enums/model.Access.Rw.md @@ -0,0 +1,64 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Access](../modules/model.Access.md) / Rw + +# Enumeration: Rw + +[model](../modules/model.md).[Access](../modules/model.Access.md).Rw + +Types of read/write access. + +## Table of contents + +### Enumeration Members + +- [Read](model.Access.Rw.md#read) +- [ReadWrite](model.Access.Rw.md#readwrite) +- [ReadWriteOption](model.Access.Rw.md#readwriteoption) +- [Write](model.Access.Rw.md#write) + +## Enumeration Members + +### Read + +• **Read** = ``"R"`` + +Read access. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L247) + +___ + +### ReadWrite + +• **ReadWrite** = ``"RW"`` + +Read and mandatory write acess. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:257](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L257) + +___ + +### ReadWriteOption + +• **ReadWriteOption** = ``"R[W]"`` + +Read and optional write access. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:262](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L262) + +___ + +### Write + +• **Write** = ``"W"`` + +Write access. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:252](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L252) diff --git a/docs/matter.js/enums/model.Access.Timed.md b/docs/matter.js/enums/model.Access.Timed.md new file mode 100644 index 0000000000..6cbd5fa0e5 --- /dev/null +++ b/docs/matter.js/enums/model.Access.Timed.md @@ -0,0 +1,25 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Access](../modules/model.Access.md) / Timed + +# Enumeration: Timed + +[model](../modules/model.md).[Access](../modules/model.Access.md).Timed + +Timed access requirement. + +## Table of contents + +### Enumeration Members + +- [Required](model.Access.Timed.md#required) + +## Enumeration Members + +### Required + +• **Required** = ``"T"`` + +Timed access required. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:337](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L337) diff --git a/docs/matter.js/enums/model.ClusterElement.Classification.md b/docs/matter.js/enums/model.ClusterElement.Classification.md new file mode 100644 index 0000000000..5253fc6e3d --- /dev/null +++ b/docs/matter.js/enums/model.ClusterElement.Classification.md @@ -0,0 +1,43 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [ClusterElement](../modules/model.ClusterElement.md) / Classification + +# Enumeration: Classification + +[model](../modules/model.md).[ClusterElement](../modules/model.ClusterElement.md).Classification + +## Table of contents + +### Enumeration Members + +- [Application](model.ClusterElement.Classification.md#application) +- [EndpointUtility](model.ClusterElement.Classification.md#endpointutility) +- [NodeUtility](model.ClusterElement.Classification.md#nodeutility) + +## Enumeration Members + +### Application + +• **Application** = ``"application"`` + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L48) + +___ + +### EndpointUtility + +• **EndpointUtility** = ``"endpoint"`` + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L46) + +___ + +### NodeUtility + +• **NodeUtility** = ``"node"`` + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L47) diff --git a/docs/matter.js/enums/model.CommandElement.Direction.md b/docs/matter.js/enums/model.CommandElement.Direction.md new file mode 100644 index 0000000000..3f651e802d --- /dev/null +++ b/docs/matter.js/enums/model.CommandElement.Direction.md @@ -0,0 +1,34 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [CommandElement](../modules/model.CommandElement.md) / Direction + +# Enumeration: Direction + +[model](../modules/model.md).[CommandElement](../modules/model.CommandElement.md).Direction + +Indicates request vs response command. + +## Table of contents + +### Enumeration Members + +- [Request](model.CommandElement.Direction.md#request) +- [Response](model.CommandElement.Direction.md#response) + +## Enumeration Members + +### Request + +• **Request** = ``"request"`` + +#### Defined in + +[packages/matter.js/src/model/elements/CommandElement.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L37) + +___ + +### Response + +• **Response** = ``"response"`` + +#### Defined in + +[packages/matter.js/src/model/elements/CommandElement.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L38) diff --git a/docs/matter.js/enums/model.Conformance.Flag.md b/docs/matter.js/enums/model.Conformance.Flag.md new file mode 100644 index 0000000000..2ce440c208 --- /dev/null +++ b/docs/matter.js/enums/model.Conformance.Flag.md @@ -0,0 +1,65 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Conformance](../modules/model.Conformance.md) / Flag + +# Enumeration: Flag + +[model](../modules/model.md).[Conformance](../modules/model.Conformance.md).Flag + +## Table of contents + +### Enumeration Members + +- [Deprecated](model.Conformance.Flag.md#deprecated) +- [Disallowed](model.Conformance.Flag.md#disallowed) +- [Mandatory](model.Conformance.Flag.md#mandatory) +- [Optional](model.Conformance.Flag.md#optional) +- [Provisional](model.Conformance.Flag.md#provisional) + +## Enumeration Members + +### Deprecated + +• **Deprecated** = ``"D"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L158) + +___ + +### Disallowed + +• **Disallowed** = ``"X"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:159](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L159) + +___ + +### Mandatory + +• **Mandatory** = ``"M"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L155) + +___ + +### Optional + +• **Optional** = ``"O"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L156) + +___ + +### Provisional + +• **Provisional** = ``"P"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L157) diff --git a/docs/matter.js/enums/model.Conformance.Operator.md b/docs/matter.js/enums/model.Conformance.Operator.md new file mode 100644 index 0000000000..358aa526d1 --- /dev/null +++ b/docs/matter.js/enums/model.Conformance.Operator.md @@ -0,0 +1,131 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Conformance](../modules/model.Conformance.md) / Operator + +# Enumeration: Operator + +[model](../modules/model.md).[Conformance](../modules/model.Conformance.md).Operator + +## Table of contents + +### Enumeration Members + +- [AND](model.Conformance.Operator.md#and) +- [DOT](model.Conformance.Operator.md#dot) +- [EQ](model.Conformance.Operator.md#eq) +- [GT](model.Conformance.Operator.md#gt) +- [GTE](model.Conformance.Operator.md#gte) +- [LT](model.Conformance.Operator.md#lt) +- [LTE](model.Conformance.Operator.md#lte) +- [NE](model.Conformance.Operator.md#ne) +- [NOT](model.Conformance.Operator.md#not) +- [OR](model.Conformance.Operator.md#or) +- [XOR](model.Conformance.Operator.md#xor) + +## Enumeration Members + +### AND + +• **AND** = ``"&"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L168) + +___ + +### DOT + +• **DOT** = ``"."`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L169) + +___ + +### EQ + +• **EQ** = ``"=="`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:164](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L164) + +___ + +### GT + +• **GT** = ``">"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L170) + +___ + +### GTE + +• **GTE** = ``">="`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L172) + +___ + +### LT + +• **LT** = ``"<"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L171) + +___ + +### LTE + +• **LTE** = ``"<="`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L173) + +___ + +### NE + +• **NE** = ``"!="`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L165) + +___ + +### NOT + +• **NOT** = ``"!"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L163) + +___ + +### OR + +• **OR** = ``"|"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L166) + +___ + +### XOR + +• **XOR** = ``"^"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L167) diff --git a/docs/matter.js/enums/model.Conformance.Special.md b/docs/matter.js/enums/model.Conformance.Special.md new file mode 100644 index 0000000000..8e0ed064b1 --- /dev/null +++ b/docs/matter.js/enums/model.Conformance.Special.md @@ -0,0 +1,87 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Conformance](../modules/model.Conformance.md) / Special + +# Enumeration: Special + +[model](../modules/model.md).[Conformance](../modules/model.Conformance.md).Special + +## Table of contents + +### Enumeration Members + +- [Choice](model.Conformance.Special.md#choice) +- [Desc](model.Conformance.Special.md#desc) +- [Empty](model.Conformance.Special.md#empty) +- [Group](model.Conformance.Special.md#group) +- [Name](model.Conformance.Special.md#name) +- [OptionalIf](model.Conformance.Special.md#optionalif) +- [Value](model.Conformance.Special.md#value) + +## Enumeration Members + +### Choice + +• **Choice** = ``"choice"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L149) + +___ + +### Desc + +• **Desc** = ``"desc"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L146) + +___ + +### Empty + +• **Empty** = ``"empty"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L145) + +___ + +### Group + +• **Group** = ``"group"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L150) + +___ + +### Name + +• **Name** = ``"name"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L147) + +___ + +### OptionalIf + +• **OptionalIf** = ``"optionalIf"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L151) + +___ + +### Value + +• **Value** = ``"value"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L148) diff --git a/docs/matter.js/enums/model.DeviceTypeElement.Classification.md b/docs/matter.js/enums/model.DeviceTypeElement.Classification.md new file mode 100644 index 0000000000..807e523b14 --- /dev/null +++ b/docs/matter.js/enums/model.DeviceTypeElement.Classification.md @@ -0,0 +1,65 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [DeviceTypeElement](../modules/model.DeviceTypeElement.md) / Classification + +# Enumeration: Classification + +[model](../modules/model.md).[DeviceTypeElement](../modules/model.DeviceTypeElement.md).Classification + +## Table of contents + +### Enumeration Members + +- [Base](model.DeviceTypeElement.Classification.md#base) +- [Dynamic](model.DeviceTypeElement.Classification.md#dynamic) +- [Node](model.DeviceTypeElement.Classification.md#node) +- [Simple](model.DeviceTypeElement.Classification.md#simple) +- [Utility](model.DeviceTypeElement.Classification.md#utility) + +## Enumeration Members + +### Base + +• **Base** = ``"base"`` + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L35) + +___ + +### Dynamic + +• **Dynamic** = ``"dynamic"`` + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L39) + +___ + +### Node + +• **Node** = ``"node"`` + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L36) + +___ + +### Simple + +• **Simple** = ``"simple"`` + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L38) + +___ + +### Utility + +• **Utility** = ``"utility"`` + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L37) diff --git a/docs/matter.js/enums/model.ElementTag.md b/docs/matter.js/enums/model.ElementTag.md new file mode 100644 index 0000000000..2cb4093d01 --- /dev/null +++ b/docs/matter.js/enums/model.ElementTag.md @@ -0,0 +1,135 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / ElementTag + +# Enumeration: ElementTag + +[model](../modules/model.md).ElementTag + +Types of elements per the Matter specification. + +We use "tag" to differentiate elements so we can use "type" for datatypes. + +## Table of contents + +### Enumeration Members + +- [Attribute](model.ElementTag.md#attribute) +- [Cluster](model.ElementTag.md#cluster) +- [Command](model.ElementTag.md#command) +- [Datatype](model.ElementTag.md#datatype) +- [DeviceType](model.ElementTag.md#devicetype) +- [Endpoint](model.ElementTag.md#endpoint) +- [Event](model.ElementTag.md#event) +- [Fabric](model.ElementTag.md#fabric) +- [Matter](model.ElementTag.md#matter) +- [Node](model.ElementTag.md#node) +- [Requirement](model.ElementTag.md#requirement) + +## Enumeration Members + +### Attribute + +• **Attribute** = ``"attribute"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L19) + +___ + +### Cluster + +• **Cluster** = ``"cluster"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L16) + +___ + +### Command + +• **Command** = ``"command"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L17) + +___ + +### Datatype + +• **Datatype** = ``"datatype"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L21) + +___ + +### DeviceType + +• **DeviceType** = ``"deviceType"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L20) + +___ + +### Endpoint + +• **Endpoint** = ``"endpoint"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L15) + +___ + +### Event + +• **Event** = ``"event"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L18) + +___ + +### Fabric + +• **Fabric** = ``"fabric"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L13) + +___ + +### Matter + +• **Matter** = ``"matter"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L28) + +___ + +### Node + +• **Node** = ``"node"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L14) + +___ + +### Requirement + +• **Requirement** = ``"requirement"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/ElementTag.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/ElementTag.ts#L25) diff --git a/docs/matter.js/enums/model.EventElement.Priority.md b/docs/matter.js/enums/model.EventElement.Priority.md new file mode 100644 index 0000000000..43c167e96d --- /dev/null +++ b/docs/matter.js/enums/model.EventElement.Priority.md @@ -0,0 +1,45 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [EventElement](../modules/model.EventElement.md) / Priority + +# Enumeration: Priority + +[model](../modules/model.md).[EventElement](../modules/model.EventElement.md).Priority + +Event priority as defined in Matter specification. + +## Table of contents + +### Enumeration Members + +- [Critical](model.EventElement.Priority.md#critical) +- [Debug](model.EventElement.Priority.md#debug) +- [Info](model.EventElement.Priority.md#info) + +## Enumeration Members + +### Critical + +• **Critical** = ``"critical"`` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L37) + +___ + +### Debug + +• **Debug** = ``"debug"`` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L35) + +___ + +### Info + +• **Info** = ``"info"`` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L36) diff --git a/docs/matter.js/enums/model.EventElement.PriorityId.md b/docs/matter.js/enums/model.EventElement.PriorityId.md new file mode 100644 index 0000000000..1dfe8ad3d1 --- /dev/null +++ b/docs/matter.js/enums/model.EventElement.PriorityId.md @@ -0,0 +1,45 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [EventElement](../modules/model.EventElement.md) / PriorityId + +# Enumeration: PriorityId + +[model](../modules/model.md).[EventElement](../modules/model.EventElement.md).PriorityId + +Event priority mapped to official ID. + +## Table of contents + +### Enumeration Members + +- [critical](model.EventElement.PriorityId.md#critical) +- [debug](model.EventElement.PriorityId.md#debug) +- [info](model.EventElement.PriorityId.md#info) + +## Enumeration Members + +### critical + +• **critical** = ``2`` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L46) + +___ + +### debug + +• **debug** = ``0`` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L44) + +___ + +### info + +• **info** = ``1`` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L45) diff --git a/docs/matter.js/enums/model.Metatype-1.md b/docs/matter.js/enums/model.Metatype-1.md new file mode 100644 index 0000000000..cbcc04f15e --- /dev/null +++ b/docs/matter.js/enums/model.Metatype-1.md @@ -0,0 +1,133 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / Metatype + +# Enumeration: Metatype + +[model](../modules/model.md).Metatype + +General groupings of Matter types. + +## Table of contents + +### Enumeration Members + +- [any](model.Metatype-1.md#any) +- [array](model.Metatype-1.md#array) +- [bitmap](model.Metatype-1.md#bitmap) +- [boolean](model.Metatype-1.md#boolean) +- [bytes](model.Metatype-1.md#bytes) +- [date](model.Metatype-1.md#date) +- [enum](model.Metatype-1.md#enum) +- [float](model.Metatype-1.md#float) +- [integer](model.Metatype-1.md#integer) +- [object](model.Metatype-1.md#object) +- [string](model.Metatype-1.md#string) + +## Enumeration Members + +### any + +• **any** = ``"any"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L14) + +___ + +### array + +• **array** = ``"array"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L21) + +___ + +### bitmap + +• **bitmap** = ``"bitmap"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L16) + +___ + +### boolean + +• **boolean** = ``"boolean"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L15) + +___ + +### bytes + +• **bytes** = ``"bytes"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L20) + +___ + +### date + +• **date** = ``"date"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L24) + +___ + +### enum + +• **enum** = ``"enum"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L17) + +___ + +### float + +• **float** = ``"float"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L19) + +___ + +### integer + +• **integer** = ``"integer"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L18) + +___ + +### object + +• **object** = ``"object"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L22) + +___ + +### string + +• **string** = ``"string"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L23) diff --git a/docs/matter.js/enums/model.Quality.Field.md b/docs/matter.js/enums/model.Quality.Field.md new file mode 100644 index 0000000000..a8b7f8d1e5 --- /dev/null +++ b/docs/matter.js/enums/model.Quality.Field.md @@ -0,0 +1,89 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Quality](../modules/model.Quality.md) / Field + +# Enumeration: Field + +[model](../modules/model.md).[Quality](../modules/model.Quality.md).Field + +All qualities designated as "other qualities" in the Matter specification. + +## Table of contents + +### Enumeration Members + +- [changesOmitted](model.Quality.Field.md#changesomitted) +- [fixed](model.Quality.Field.md#fixed) +- [nonvolatile](model.Quality.Field.md#nonvolatile) +- [nullable](model.Quality.Field.md#nullable) +- [reportable](model.Quality.Field.md#reportable) +- [scene](model.Quality.Field.md#scene) +- [singleton](model.Quality.Field.md#singleton) + +## Enumeration Members + +### changesOmitted + +• **changesOmitted** = ``"C"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L112) + +___ + +### fixed + +• **fixed** = ``"F"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L109) + +___ + +### nonvolatile + +• **nonvolatile** = ``"N"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L108) + +___ + +### nullable + +• **nullable** = ``"X"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L107) + +___ + +### reportable + +• **reportable** = ``"P"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L111) + +___ + +### scene + +• **scene** = ``"S"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L110) + +___ + +### singleton + +• **singleton** = ``"I"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L113) diff --git a/docs/matter.js/enums/model.Quality.Flag.md b/docs/matter.js/enums/model.Quality.Flag.md new file mode 100644 index 0000000000..6444407d40 --- /dev/null +++ b/docs/matter.js/enums/model.Quality.Flag.md @@ -0,0 +1,89 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Quality](../modules/model.Quality.md) / Flag + +# Enumeration: Flag + +[model](../modules/model.md).[Quality](../modules/model.Quality.md).Flag + +Quality flags and the logical field they map to. + +## Table of contents + +### Enumeration Members + +- [C](model.Quality.Flag.md#c) +- [F](model.Quality.Flag.md#f) +- [I](model.Quality.Flag.md#i) +- [N](model.Quality.Flag.md#n) +- [P](model.Quality.Flag.md#p) +- [S](model.Quality.Flag.md#s) +- [X](model.Quality.Flag.md#x) + +## Enumeration Members + +### C + +• **C** = ``"changesOmitted"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L125) + +___ + +### F + +• **F** = ``"fixed"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L122) + +___ + +### I + +• **I** = ``"singleton"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L126) + +___ + +### N + +• **N** = ``"nonvolatile"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L121) + +___ + +### P + +• **P** = ``"reportable"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L124) + +___ + +### S + +• **S** = ``"scene"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L123) + +___ + +### X + +• **X** = ``"nullable"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L120) diff --git a/docs/matter.js/enums/model.RequirementElement.ElementType.md b/docs/matter.js/enums/model.RequirementElement.ElementType.md new file mode 100644 index 0000000000..97f4207622 --- /dev/null +++ b/docs/matter.js/enums/model.RequirementElement.ElementType.md @@ -0,0 +1,87 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [RequirementElement](../modules/model.RequirementElement.md) / ElementType + +# Enumeration: ElementType + +[model](../modules/model.md).[RequirementElement](../modules/model.RequirementElement.md).ElementType + +## Table of contents + +### Enumeration Members + +- [Attribute](model.RequirementElement.ElementType.md#attribute) +- [ClientCluster](model.RequirementElement.ElementType.md#clientcluster) +- [Command](model.RequirementElement.ElementType.md#command) +- [CommandField](model.RequirementElement.ElementType.md#commandfield) +- [Event](model.RequirementElement.ElementType.md#event) +- [Feature](model.RequirementElement.ElementType.md#feature) +- [ServerCluster](model.RequirementElement.ElementType.md#servercluster) + +## Enumeration Members + +### Attribute + +• **Attribute** = ``"attribute"`` + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L46) + +___ + +### ClientCluster + +• **ClientCluster** = ``"clientCluster"`` + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L43) + +___ + +### Command + +• **Command** = ``"command"`` + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L47) + +___ + +### CommandField + +• **CommandField** = ``"commandField"`` + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L49) + +___ + +### Event + +• **Event** = ``"event"`` + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L48) + +___ + +### Feature + +• **Feature** = ``"feature"`` + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L45) + +___ + +### ServerCluster + +• **ServerCluster** = ``"serverCluster"`` + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L44) diff --git a/docs/matter.js/enums/model.Specification-1.md b/docs/matter.js/enums/model.Specification-1.md new file mode 100644 index 0000000000..a5010c6844 --- /dev/null +++ b/docs/matter.js/enums/model.Specification-1.md @@ -0,0 +1,45 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / Specification + +# Enumeration: Specification + +[model](../modules/model.md).Specification + +The Matter specification documents. + +## Table of contents + +### Enumeration Members + +- [Cluster](model.Specification-1.md#cluster) +- [Core](model.Specification-1.md#core) +- [Device](model.Specification-1.md#device) + +## Enumeration Members + +### Cluster + +• **Cluster** = ``"cluster"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Specification.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Specification.ts#L12) + +___ + +### Core + +• **Core** = ``"core"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Specification.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Specification.ts#L11) + +___ + +### Device + +• **Device** = ``"device"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Specification.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Specification.ts#L13) diff --git a/docs/matter.js/enums/model.Specification.Names.md b/docs/matter.js/enums/model.Specification.Names.md new file mode 100644 index 0000000000..ab04a07aa9 --- /dev/null +++ b/docs/matter.js/enums/model.Specification.Names.md @@ -0,0 +1,45 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [Specification](../modules/model.Specification.md) / Names + +# Enumeration: Names + +[model](../modules/model.md).[Specification](../modules/model.Specification.md).Names + +Long names for Matter specification documents. + +## Table of contents + +### Enumeration Members + +- [cluster](model.Specification.Names.md#cluster) +- [core](model.Specification.Names.md#core) +- [device](model.Specification.Names.md#device) + +## Enumeration Members + +### cluster + +• **cluster** = ``"Matter Application Cluster Specification"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Specification.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Specification.ts#L22) + +___ + +### core + +• **core** = ``"Matter Core Specification"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Specification.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Specification.ts#L21) + +___ + +### device + +• **device** = ``"Matter Device Library Specification"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/Specification.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Specification.ts#L23) diff --git a/docs/matter.js/enums/model.StatusCode.md b/docs/matter.js/enums/model.StatusCode.md new file mode 100644 index 0000000000..37711a401d --- /dev/null +++ b/docs/matter.js/enums/model.StatusCode.md @@ -0,0 +1,300 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / StatusCode + +# Enumeration: StatusCode + +[model](../modules/model.md).StatusCode + +Glboal status codes defined in Matter specification. + +TODO - extract/merge with StatusCode in InteractionProtocol.ts + +## Table of contents + +### Enumeration Members + +- [Busy](model.StatusCode.md#busy) +- [ConstraintError](model.StatusCode.md#constrainterror) +- [DataVersionMismatch](model.StatusCode.md#dataversionmismatch) +- [FailsafeRequired](model.StatusCode.md#failsaferequired) +- [Failure](model.StatusCode.md#failure) +- [InvalidAction](model.StatusCode.md#invalidaction) +- [InvalidCommand](model.StatusCode.md#invalidcommand) +- [InvalidDataType](model.StatusCode.md#invaliddatatype) +- [InvalidSubscription](model.StatusCode.md#invalidsubscription) +- [NeedsTimedInteraction](model.StatusCode.md#needstimedinteraction) +- [NoUpstreamSubscription](model.StatusCode.md#noupstreamsubscription) +- [NotFound](model.StatusCode.md#notfound) +- [PathsExhausted](model.StatusCode.md#pathsexhausted) +- [ResourceExhausted](model.StatusCode.md#resourceexhausted) +- [Success](model.StatusCode.md#success) +- [TimedRequestMismatch](model.StatusCode.md#timedrequestmismatch) +- [UnreportableAttribute](model.StatusCode.md#unreportableattribute) +- [UnsupportedAccess](model.StatusCode.md#unsupportedaccess) +- [UnsupportedAttribute](model.StatusCode.md#unsupportedattribute) +- [UnsupportedCluster](model.StatusCode.md#unsupportedcluster) +- [UnsupportedCommand](model.StatusCode.md#unsupportedcommand) +- [UnsupportedEndpoint](model.StatusCode.md#unsupportedendpoint) +- [UnsupportedEvent](model.StatusCode.md#unsupportedevent) +- [UnsupportedNode](model.StatusCode.md#unsupportednode) +- [UnsupportedRead](model.StatusCode.md#unsupportedread) +- [UnsupportedWrite](model.StatusCode.md#unsupportedwrite) + +## Enumeration Members + +### Busy + +• **Busy** = ``156`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L31) + +___ + +### ConstraintError + +• **ConstraintError** = ``135`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L22) + +___ + +### DataVersionMismatch + +• **DataVersionMismatch** = ``146`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L29) + +___ + +### FailsafeRequired + +• **FailsafeRequired** = ``202`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L38) + +___ + +### Failure + +• **Failure** = ``1`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L14) + +___ + +### InvalidAction + +• **InvalidAction** = ``128`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L18) + +___ + +### InvalidCommand + +• **InvalidCommand** = ``133`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L20) + +___ + +### InvalidDataType + +• **InvalidDataType** = ``141`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L27) + +___ + +### InvalidSubscription + +• **InvalidSubscription** = ``125`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L15) + +___ + +### NeedsTimedInteraction + +• **NeedsTimedInteraction** = ``198`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L34) + +___ + +### NoUpstreamSubscription + +• **NoUpstreamSubscription** = ``197`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L33) + +___ + +### NotFound + +• **NotFound** = ``139`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L25) + +___ + +### PathsExhausted + +• **PathsExhausted** = ``200`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L36) + +___ + +### ResourceExhausted + +• **ResourceExhausted** = ``137`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L24) + +___ + +### Success + +• **Success** = ``0`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L13) + +___ + +### TimedRequestMismatch + +• **TimedRequestMismatch** = ``201`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L37) + +___ + +### UnreportableAttribute + +• **UnreportableAttribute** = ``140`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L26) + +___ + +### UnsupportedAccess + +• **UnsupportedAccess** = ``126`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L16) + +___ + +### UnsupportedAttribute + +• **UnsupportedAttribute** = ``134`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L21) + +___ + +### UnsupportedCluster + +• **UnsupportedCluster** = ``195`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L32) + +___ + +### UnsupportedCommand + +• **UnsupportedCommand** = ``129`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L19) + +___ + +### UnsupportedEndpoint + +• **UnsupportedEndpoint** = ``127`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L17) + +___ + +### UnsupportedEvent + +• **UnsupportedEvent** = ``199`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L35) + +___ + +### UnsupportedNode + +• **UnsupportedNode** = ``155`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L30) + +___ + +### UnsupportedRead + +• **UnsupportedRead** = ``143`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L28) + +___ + +### UnsupportedWrite + +• **UnsupportedWrite** = ``136`` + +#### Defined in + +[packages/matter.js/src/model/definitions/StatusCode.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/StatusCode.ts#L23) diff --git a/docs/matter.js/enums/model.ValueElement.Metatype.md b/docs/matter.js/enums/model.ValueElement.Metatype.md new file mode 100644 index 0000000000..0e3c3d012c --- /dev/null +++ b/docs/matter.js/enums/model.ValueElement.Metatype.md @@ -0,0 +1,34 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / [ValueElement](../modules/model.ValueElement.md) / Metatype + +# Enumeration: Metatype + +[model](../modules/model.md).[ValueElement](../modules/model.ValueElement.md).Metatype + +The general type of datatype (ignoring size). + +## Table of contents + +### Enumeration Members + +- [bool](model.ValueElement.Metatype.md#bool) +- [map](model.ValueElement.Metatype.md#map) + +## Enumeration Members + +### bool + +• **bool** = ``0`` + +#### Defined in + +[packages/matter.js/src/model/elements/ValueElement.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L85) + +___ + +### map + +• **map** = ``1`` + +#### Defined in + +[packages/matter.js/src/model/elements/ValueElement.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L86) diff --git a/docs/matter.js/enums/protocol_interaction_export.MessageType.md b/docs/matter.js/enums/protocol_interaction_export.MessageType.md index 86683c3dbc..6f1c673792 100644 --- a/docs/matter.js/enums/protocol_interaction_export.MessageType.md +++ b/docs/matter.js/enums/protocol_interaction_export.MessageType.md @@ -27,7 +27,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:55 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L62) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:56 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L63) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:49 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L56) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:52 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L59) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:48 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L55) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:50 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L57) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:51 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L58) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:57 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L64) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:53 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L60) ___ @@ -117,4 +117,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:54 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L61) diff --git a/docs/matter.js/enums/protocol_interaction_export.StatusCode.md b/docs/matter.js/enums/protocol_interaction_export.StatusCode.md index e0c743300e..fca6c57fe8 100644 --- a/docs/matter.js/enums/protocol_interaction_export.StatusCode.md +++ b/docs/matter.js/enums/protocol_interaction_export.StatusCode.md @@ -48,7 +48,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:43 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L43) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:33 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L33) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:40 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L40) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:50 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L50) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:25 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L25) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:29 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L29) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:31 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L31) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:38 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L38) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:26 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L26) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:46 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L46) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:45 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L45) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:36 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L36) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:48 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L48) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:35 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L35) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:24 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L24) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:49 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L49) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:41 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L41) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:37 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L37) ___ @@ -228,7 +228,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:27 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L27) ___ @@ -238,7 +238,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:32 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L32) ___ @@ -248,7 +248,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:44 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L44) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:30 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L30) ___ @@ -268,7 +268,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:28 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L28) ___ @@ -278,7 +278,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:47 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L47) ___ @@ -288,7 +288,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:42 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L42) ___ @@ -298,7 +298,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:39 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L39) ___ @@ -308,4 +308,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:34 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L34) diff --git a/docs/matter.js/enums/protocol_securechannel_export.GeneralStatusCode.md b/docs/matter.js/enums/protocol_securechannel_export.GeneralStatusCode.md index 595eb32db5..e70f4de35b 100644 --- a/docs/matter.js/enums/protocol_securechannel_export.GeneralStatusCode.md +++ b/docs/matter.js/enums/protocol_securechannel_export.GeneralStatusCode.md @@ -36,7 +36,7 @@ Failure, may be due to a concurrency error. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:66 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L66) ___ @@ -48,7 +48,7 @@ The sender attempted to create something that already exists. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:75 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L75) ___ @@ -60,7 +60,7 @@ Operation was rejected by the system because the system is in an invalid state. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:39 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L39) ___ @@ -72,7 +72,7 @@ A request was unrecognized or malformed #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:45 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L45) ___ @@ -84,7 +84,7 @@ Device is busy and cannot handle this request at this time. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:57 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L57) ___ @@ -96,7 +96,7 @@ Context-specific signal to proceed #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:63 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L63) ___ @@ -108,7 +108,7 @@ Unrecoverable data loss or corruption has occurred. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:81 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L81) ___ @@ -120,7 +120,7 @@ Generic failure, additional details may be included in the protocol specific sta #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:36 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L36) ___ @@ -132,7 +132,7 @@ An invalid/unsupported argument was provided. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:69 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L69) ___ @@ -144,7 +144,7 @@ Some requested entity was not found. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:72 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L72) ___ @@ -156,7 +156,7 @@ A value was out of a required range #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:42 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L42) ___ @@ -168,7 +168,7 @@ The sender does not have sufficient permissions to execute the requested operati #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:78 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L78) ___ @@ -180,7 +180,7 @@ Insufficient resources to process the given request. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:54 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L54) ___ @@ -192,7 +192,7 @@ Operation completed successfully. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:33 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L33) ___ @@ -204,7 +204,7 @@ A timeout occurred. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:60 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L60) ___ @@ -216,7 +216,7 @@ A request was not expected at this time. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:51 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L51) ___ @@ -228,4 +228,4 @@ An unrecognized or unsupported request was received. #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:48 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L48) diff --git a/docs/matter.js/enums/protocol_securechannel_export.MessageType.md b/docs/matter.js/enums/protocol_securechannel_export.MessageType.md index 51911c94de..62e578cd5b 100644 --- a/docs/matter.js/enums/protocol_securechannel_export.MessageType.md +++ b/docs/matter.js/enums/protocol_securechannel_export.MessageType.md @@ -28,7 +28,7 @@ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:13 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L13) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:14 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L14) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:15 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L15) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:11 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L11) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:12 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L12) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:16 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L16) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:17 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L17) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:19 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L19) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:18 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L18) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:10 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L10) ___ @@ -128,4 +128,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:20 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L20) diff --git a/docs/matter.js/enums/protocol_securechannel_export.ProtocolStatusCode.md b/docs/matter.js/enums/protocol_securechannel_export.ProtocolStatusCode.md index 1788b6627d..137a3f90a3 100644 --- a/docs/matter.js/enums/protocol_securechannel_export.ProtocolStatusCode.md +++ b/docs/matter.js/enums/protocol_securechannel_export.ProtocolStatusCode.md @@ -22,7 +22,7 @@ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:28 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L28) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:27 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L27) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:26 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L26) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:25 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L25) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:24 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L24) diff --git a/docs/matter.js/enums/schema_export.CommissionningFlowType.md b/docs/matter.js/enums/schema_export.CommissionningFlowType.md index 2a0cb9593c..c4e072c060 100644 --- a/docs/matter.js/enums/schema_export.CommissionningFlowType.md +++ b/docs/matter.js/enums/schema_export.CommissionningFlowType.md @@ -24,7 +24,7 @@ Interaction with a vendor-specified means is needed before commissioning. #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:30 +[packages/matter.js/src/schema/PairingCodeSchema.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L31) ___ @@ -36,7 +36,7 @@ When not commissioned, the device always enters commissioning mode upon power-up #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:24 +[packages/matter.js/src/schema/PairingCodeSchema.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L25) ___ @@ -48,4 +48,4 @@ User action required to enter commissioning mode. #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:27 +[packages/matter.js/src/schema/PairingCodeSchema.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L28) diff --git a/docs/matter.js/enums/tlv_export.TlvLength.md b/docs/matter.js/enums/tlv_export.TlvLength.md index 4d89db69a9..d11edafa86 100644 --- a/docs/matter.js/enums/tlv_export.TlvLength.md +++ b/docs/matter.js/enums/tlv_export.TlvLength.md @@ -23,7 +23,7 @@ Byte length of the encoded value or length. #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:49 +[packages/matter.js/src/tlv/TlvCodec.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L49) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:48 +[packages/matter.js/src/tlv/TlvCodec.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L48) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:46 +[packages/matter.js/src/tlv/TlvCodec.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L46) ___ @@ -53,4 +53,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:47 +[packages/matter.js/src/tlv/TlvCodec.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L47) diff --git a/docs/matter.js/enums/tlv_export.TlvType.md b/docs/matter.js/enums/tlv_export.TlvType.md index 629f40737b..d1c1fbabcc 100644 --- a/docs/matter.js/enums/tlv_export.TlvType.md +++ b/docs/matter.js/enums/tlv_export.TlvType.md @@ -34,7 +34,7 @@ TLV element types. #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:39 +[packages/matter.js/src/tlv/TlvCodec.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L39) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:33 +[packages/matter.js/src/tlv/TlvCodec.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L33) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:36 +[packages/matter.js/src/tlv/TlvCodec.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L36) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:41 +[packages/matter.js/src/tlv/TlvCodec.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L41) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:34 +[packages/matter.js/src/tlv/TlvCodec.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L34) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:40 +[packages/matter.js/src/tlv/TlvCodec.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L40) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:37 +[packages/matter.js/src/tlv/TlvCodec.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L37) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:31 +[packages/matter.js/src/tlv/TlvCodec.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L31) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:38 +[packages/matter.js/src/tlv/TlvCodec.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L38) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:32 +[packages/matter.js/src/tlv/TlvCodec.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L32) ___ @@ -134,4 +134,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:35 +[packages/matter.js/src/tlv/TlvCodec.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L35) diff --git a/docs/matter.js/enums/util_export.Endian.md b/docs/matter.js/enums/util_export.Endian.md index a8a189d449..5d2cfff6ef 100644 --- a/docs/matter.js/enums/util_export.Endian.md +++ b/docs/matter.js/enums/util_export.Endian.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/util/ByteArray.ts:79 +[packages/matter.js/src/util/ByteArray.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/ByteArray.ts#L79) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/util/ByteArray.ts:78 +[packages/matter.js/src/util/ByteArray.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/ByteArray.ts#L78) diff --git a/docs/matter.js/interfaces/certificate_export.DeviceAttestationCertificate.md b/docs/matter.js/interfaces/certificate_export.DeviceAttestationCertificate.md index a12f69e85f..197767ce5e 100644 --- a/docs/matter.js/interfaces/certificate_export.DeviceAttestationCertificate.md +++ b/docs/matter.js/interfaces/certificate_export.DeviceAttestationCertificate.md @@ -28,7 +28,7 @@ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:231 +[packages/matter.js/src/certificate/CertificateManager.ts:231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L231) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:232 +[packages/matter.js/src/certificate/CertificateManager.ts:232](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L232) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:233 +[packages/matter.js/src/certificate/CertificateManager.ts:233](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L233) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:218 +[packages/matter.js/src/certificate/CertificateManager.ts:218](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L218) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:224 +[packages/matter.js/src/certificate/CertificateManager.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L224) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:223 +[packages/matter.js/src/certificate/CertificateManager.ts:223](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L223) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:230 +[packages/matter.js/src/certificate/CertificateManager.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L230) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:216 +[packages/matter.js/src/certificate/CertificateManager.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L216) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:244 +[packages/matter.js/src/certificate/CertificateManager.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L244) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:217 +[packages/matter.js/src/certificate/CertificateManager.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L217) ___ @@ -157,4 +157,4 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:225 +[packages/matter.js/src/certificate/CertificateManager.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L225) diff --git a/docs/matter.js/interfaces/certificate_export.ProductAttestationAuthorityCertificate.md b/docs/matter.js/interfaces/certificate_export.ProductAttestationAuthorityCertificate.md index 000155360f..33bb60bca3 100644 --- a/docs/matter.js/interfaces/certificate_export.ProductAttestationAuthorityCertificate.md +++ b/docs/matter.js/interfaces/certificate_export.ProductAttestationAuthorityCertificate.md @@ -28,7 +28,7 @@ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:292 +[packages/matter.js/src/certificate/CertificateManager.ts:292](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L292) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:293 +[packages/matter.js/src/certificate/CertificateManager.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L293) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:294 +[packages/matter.js/src/certificate/CertificateManager.ts:294](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L294) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:281 +[packages/matter.js/src/certificate/CertificateManager.ts:281](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L281) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:286 +[packages/matter.js/src/certificate/CertificateManager.ts:286](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L286) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:285 +[packages/matter.js/src/certificate/CertificateManager.ts:285](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L285) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:291 +[packages/matter.js/src/certificate/CertificateManager.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L291) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:279 +[packages/matter.js/src/certificate/CertificateManager.ts:279](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L279) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:305 +[packages/matter.js/src/certificate/CertificateManager.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L305) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:280 +[packages/matter.js/src/certificate/CertificateManager.ts:280](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L280) ___ @@ -155,4 +155,4 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:287 +[packages/matter.js/src/certificate/CertificateManager.ts:287](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L287) diff --git a/docs/matter.js/interfaces/certificate_export.ProductAttestationIntermediateCertificate.md b/docs/matter.js/interfaces/certificate_export.ProductAttestationIntermediateCertificate.md index bec363d4b6..a51af4f2ac 100644 --- a/docs/matter.js/interfaces/certificate_export.ProductAttestationIntermediateCertificate.md +++ b/docs/matter.js/interfaces/certificate_export.ProductAttestationIntermediateCertificate.md @@ -28,7 +28,7 @@ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:262 +[packages/matter.js/src/certificate/CertificateManager.ts:262](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L262) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:263 +[packages/matter.js/src/certificate/CertificateManager.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L263) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:264 +[packages/matter.js/src/certificate/CertificateManager.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L264) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:250 +[packages/matter.js/src/certificate/CertificateManager.ts:250](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L250) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:255 +[packages/matter.js/src/certificate/CertificateManager.ts:255](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L255) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:254 +[packages/matter.js/src/certificate/CertificateManager.ts:254](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L254) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:261 +[packages/matter.js/src/certificate/CertificateManager.ts:261](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L261) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:248 +[packages/matter.js/src/certificate/CertificateManager.ts:248](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L248) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:275 +[packages/matter.js/src/certificate/CertificateManager.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L275) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:249 +[packages/matter.js/src/certificate/CertificateManager.ts:249](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L249) ___ @@ -156,4 +156,4 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:256 +[packages/matter.js/src/certificate/CertificateManager.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L256) diff --git a/docs/matter.js/interfaces/cluster_export.Attribute.md b/docs/matter.js/interfaces/cluster_export.Attribute.md index 0ffebed119..26ef54e7c5 100644 --- a/docs/matter.js/interfaces/cluster_export.Attribute.md +++ b/docs/matter.js/interfaces/cluster_export.Attribute.md @@ -41,7 +41,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:38 +[packages/matter.js/src/cluster/Cluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L38) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -131,7 +131,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -181,7 +181,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -191,7 +191,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:40 +[packages/matter.js/src/cluster/Cluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L40) ___ @@ -201,4 +201,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.Cluster.md b/docs/matter.js/interfaces/cluster_export.Cluster.md index b6720ec8a6..5eb86aeae0 100644 --- a/docs/matter.js/interfaces/cluster_export.Cluster.md +++ b/docs/matter.js/interfaces/cluster_export.Cluster.md @@ -36,7 +36,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:878 +[packages/matter.js/src/cluster/Cluster.ts:878](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L878) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:879 +[packages/matter.js/src/cluster/Cluster.ts:879](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L879) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:880 +[packages/matter.js/src/cluster/Cluster.ts:880](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L880) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:876 +[packages/matter.js/src/cluster/Cluster.ts:876](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L876) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:873 +[packages/matter.js/src/cluster/Cluster.ts:873](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L873) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:874 +[packages/matter.js/src/cluster/Cluster.ts:874](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L874) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:875 +[packages/matter.js/src/cluster/Cluster.ts:875](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L875) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:877 +[packages/matter.js/src/cluster/Cluster.ts:877](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L877) ___ @@ -116,4 +116,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:881 +[packages/matter.js/src/cluster/Cluster.ts:881](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L881) diff --git a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Cluster.md b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Cluster.md index 2901892b0b..04cbbad3f4 100644 --- a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Cluster.md +++ b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Cluster.md @@ -44,7 +44,7 @@ A Cluster represents a fully formed cluster with features selected. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:69 +[packages/matter.js/src/cluster/ClusterFactory.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L69) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:70 +[packages/matter.js/src/cluster/ClusterFactory.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L70) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:71 +[packages/matter.js/src/cluster/ClusterFactory.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L71) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:93 +[packages/matter.js/src/cluster/ClusterFactory.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L93) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:59 +[packages/matter.js/src/cluster/ClusterFactory.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L59) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:60 +[packages/matter.js/src/cluster/ClusterFactory.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L60) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:61 +[packages/matter.js/src/cluster/ClusterFactory.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L61) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:94 +[packages/matter.js/src/cluster/ClusterFactory.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L94) ___ @@ -156,4 +156,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:95 +[packages/matter.js/src/cluster/ClusterFactory.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L95) diff --git a/docs/matter.js/interfaces/cluster_export.ClusterFactory.ClusterElements.md b/docs/matter.js/interfaces/cluster_export.ClusterFactory.ClusterElements.md index c090e07e91..85a7b093a0 100644 --- a/docs/matter.js/interfaces/cluster_export.ClusterFactory.ClusterElements.md +++ b/docs/matter.js/interfaces/cluster_export.ClusterFactory.ClusterElements.md @@ -31,7 +31,7 @@ a cluster. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:69 +[packages/matter.js/src/cluster/ClusterFactory.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L69) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:70 +[packages/matter.js/src/cluster/ClusterFactory.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L70) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:71 +[packages/matter.js/src/cluster/ClusterFactory.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L71) diff --git a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Component.md b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Component.md index b974937705..c5f493c7f8 100644 --- a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Component.md +++ b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Component.md @@ -47,7 +47,7 @@ ClusterElements.constructor #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:69 +[packages/matter.js/src/cluster/ClusterFactory.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L69) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:70 +[packages/matter.js/src/cluster/ClusterFactory.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L70) ___ @@ -75,4 +75,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:71 +[packages/matter.js/src/cluster/ClusterFactory.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L71) diff --git a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Extensible.md b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Extensible.md index 3277b30a05..985f542146 100644 --- a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Extensible.md +++ b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Extensible.md @@ -54,7 +54,7 @@ Cluster.constructor #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:69 +[packages/matter.js/src/cluster/ClusterFactory.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L69) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:70 +[packages/matter.js/src/cluster/ClusterFactory.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L70) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:71 +[packages/matter.js/src/cluster/ClusterFactory.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L71) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:93 +[packages/matter.js/src/cluster/ClusterFactory.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L93) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:59 +[packages/matter.js/src/cluster/ClusterFactory.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L59) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:60 +[packages/matter.js/src/cluster/ClusterFactory.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L60) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:61 +[packages/matter.js/src/cluster/ClusterFactory.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L61) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:94 +[packages/matter.js/src/cluster/ClusterFactory.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L94) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:95 +[packages/matter.js/src/cluster/ClusterFactory.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L95) ___ @@ -176,4 +176,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:149 +[packages/matter.js/src/cluster/ClusterFactory.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L149) diff --git a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Features.md b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Features.md index c2c539962b..d60427b5d6 100644 --- a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Features.md +++ b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Features.md @@ -34,7 +34,7 @@ Cluster "features" describe the features supported by a cluster. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:93 +[packages/matter.js/src/cluster/ClusterFactory.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L93) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:94 +[packages/matter.js/src/cluster/ClusterFactory.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L94) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:95 +[packages/matter.js/src/cluster/ClusterFactory.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L95) diff --git a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Identity.md b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Identity.md index fda79e4a2e..4a75b9ae01 100644 --- a/docs/matter.js/interfaces/cluster_export.ClusterFactory.Identity.md +++ b/docs/matter.js/interfaces/cluster_export.ClusterFactory.Identity.md @@ -28,7 +28,7 @@ These fields uniquely identify a cluster. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:59 +[packages/matter.js/src/cluster/ClusterFactory.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L59) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:60 +[packages/matter.js/src/cluster/ClusterFactory.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L60) ___ @@ -48,4 +48,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:61 +[packages/matter.js/src/cluster/ClusterFactory.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L61) diff --git a/docs/matter.js/interfaces/cluster_export.ClusterFactory.TypedComponent.md b/docs/matter.js/interfaces/cluster_export.ClusterFactory.TypedComponent.md index da208cc2f5..7d96a08332 100644 --- a/docs/matter.js/interfaces/cluster_export.ClusterFactory.TypedComponent.md +++ b/docs/matter.js/interfaces/cluster_export.ClusterFactory.TypedComponent.md @@ -28,7 +28,7 @@ A "typed component" is a component with detailed type information. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:84 +[packages/matter.js/src/cluster/ClusterFactory.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L84) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:85 +[packages/matter.js/src/cluster/ClusterFactory.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L85) ___ @@ -48,4 +48,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:86 +[packages/matter.js/src/cluster/ClusterFactory.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L86) diff --git a/docs/matter.js/interfaces/cluster_export.Command.md b/docs/matter.js/interfaces/cluster_export.Command.md index bf5a090afc..8340381e2b 100644 --- a/docs/matter.js/interfaces/cluster_export.Command.md +++ b/docs/matter.js/interfaces/cluster_export.Command.md @@ -35,7 +35,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:604 +[packages/matter.js/src/cluster/Cluster.ts:604](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L604) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:606 +[packages/matter.js/src/cluster/Cluster.ts:606](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L606) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:607 +[packages/matter.js/src/cluster/Cluster.ts:607](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L607) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:599 +[packages/matter.js/src/cluster/Cluster.ts:599](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L599) ___ @@ -75,7 +75,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:608 +[packages/matter.js/src/cluster/Cluster.ts:608](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L608) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:600 +[packages/matter.js/src/cluster/Cluster.ts:600](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L600) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:601 +[packages/matter.js/src/cluster/Cluster.ts:601](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L601) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:602 +[packages/matter.js/src/cluster/Cluster.ts:602](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L602) ___ @@ -115,7 +115,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:603 +[packages/matter.js/src/cluster/Cluster.ts:603](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L603) ___ @@ -125,4 +125,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:605 +[packages/matter.js/src/cluster/Cluster.ts:605](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L605) diff --git a/docs/matter.js/interfaces/cluster_export.ConditionalAttribute.md b/docs/matter.js/interfaces/cluster_export.ConditionalAttribute.md index e3d899a712..b35a17a487 100644 --- a/docs/matter.js/interfaces/cluster_export.ConditionalAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.ConditionalAttribute.md @@ -51,7 +51,7 @@ OptionalAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ OptionalAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ OptionalAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ OptionalAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ OptionalAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:60 +[packages/matter.js/src/cluster/Cluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L60) ___ @@ -121,7 +121,7 @@ OptionalAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ OptionalAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ OptionalAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:56 +[packages/matter.js/src/cluster/Cluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L56) ___ @@ -163,7 +163,7 @@ OptionalAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ OptionalAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ OptionalAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ OptionalAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ OptionalAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ OptionalAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ OptionalAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ OptionalAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:40 +[packages/matter.js/src/cluster/Cluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L40) ___ @@ -275,4 +275,4 @@ OptionalAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.ConditionalCommand.md b/docs/matter.js/interfaces/cluster_export.ConditionalCommand.md index daac754f7a..172d243e9a 100644 --- a/docs/matter.js/interfaces/cluster_export.ConditionalCommand.md +++ b/docs/matter.js/interfaces/cluster_export.ConditionalCommand.md @@ -45,7 +45,7 @@ OptionalCommand.invokeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:604 +[packages/matter.js/src/cluster/Cluster.ts:604](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L604) ___ @@ -59,7 +59,7 @@ OptionalCommand.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:617 +[packages/matter.js/src/cluster/Cluster.ts:617](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L617) ___ @@ -73,7 +73,7 @@ OptionalCommand.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:607 +[packages/matter.js/src/cluster/Cluster.ts:607](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L607) ___ @@ -87,7 +87,7 @@ OptionalCommand.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:612 +[packages/matter.js/src/cluster/Cluster.ts:612](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L612) ___ @@ -101,7 +101,7 @@ OptionalCommand.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:608 +[packages/matter.js/src/cluster/Cluster.ts:608](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L608) ___ @@ -115,7 +115,7 @@ OptionalCommand.requestId #### Defined in -packages/matter.js/src/cluster/Cluster.ts:600 +[packages/matter.js/src/cluster/Cluster.ts:600](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L600) ___ @@ -129,7 +129,7 @@ OptionalCommand.requestSchema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:601 +[packages/matter.js/src/cluster/Cluster.ts:601](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L601) ___ @@ -143,7 +143,7 @@ OptionalCommand.responseId #### Defined in -packages/matter.js/src/cluster/Cluster.ts:602 +[packages/matter.js/src/cluster/Cluster.ts:602](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L602) ___ @@ -157,7 +157,7 @@ OptionalCommand.responseSchema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:603 +[packages/matter.js/src/cluster/Cluster.ts:603](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L603) ___ @@ -171,4 +171,4 @@ OptionalCommand.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:605 +[packages/matter.js/src/cluster/Cluster.ts:605](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L605) diff --git a/docs/matter.js/interfaces/cluster_export.ConditionalEvent.md b/docs/matter.js/interfaces/cluster_export.ConditionalEvent.md index 6b04df3521..56ce133427 100644 --- a/docs/matter.js/interfaces/cluster_export.ConditionalEvent.md +++ b/docs/matter.js/interfaces/cluster_export.ConditionalEvent.md @@ -43,7 +43,7 @@ OptionalEvent.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:714 +[packages/matter.js/src/cluster/Cluster.ts:714](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L714) ___ @@ -57,7 +57,7 @@ OptionalEvent.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:743 +[packages/matter.js/src/cluster/Cluster.ts:743](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L743) ___ @@ -71,7 +71,7 @@ OptionalEvent.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:721 +[packages/matter.js/src/cluster/Cluster.ts:721](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L721) ___ @@ -85,7 +85,7 @@ OptionalEvent.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:739 +[packages/matter.js/src/cluster/Cluster.ts:739](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L739) ___ @@ -99,7 +99,7 @@ OptionalEvent.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:720 +[packages/matter.js/src/cluster/Cluster.ts:720](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L720) ___ @@ -113,7 +113,7 @@ OptionalEvent.priority #### Defined in -packages/matter.js/src/cluster/Cluster.ts:716 +[packages/matter.js/src/cluster/Cluster.ts:716](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L716) ___ @@ -127,7 +127,7 @@ OptionalEvent.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:718 +[packages/matter.js/src/cluster/Cluster.ts:718](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L718) ___ @@ -141,7 +141,7 @@ OptionalEvent.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:715 +[packages/matter.js/src/cluster/Cluster.ts:715](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L715) ___ @@ -155,4 +155,4 @@ OptionalEvent.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:722 +[packages/matter.js/src/cluster/Cluster.ts:722](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L722) diff --git a/docs/matter.js/interfaces/cluster_export.ConditionalFixedAttribute.md b/docs/matter.js/interfaces/cluster_export.ConditionalFixedAttribute.md index 179332e8c0..0e067b445d 100644 --- a/docs/matter.js/interfaces/cluster_export.ConditionalFixedAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.ConditionalFixedAttribute.md @@ -51,7 +51,7 @@ OptionalFixedAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ OptionalFixedAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ OptionalFixedAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:101 +[packages/matter.js/src/cluster/Cluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L101) ___ @@ -93,7 +93,7 @@ OptionalFixedAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ OptionalFixedAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:105 +[packages/matter.js/src/cluster/Cluster.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L105) ___ @@ -121,7 +121,7 @@ OptionalFixedAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ OptionalFixedAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ OptionalFixedAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:56 +[packages/matter.js/src/cluster/Cluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L56) ___ @@ -163,7 +163,7 @@ OptionalFixedAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ OptionalFixedAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ OptionalFixedAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ OptionalFixedAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ OptionalFixedAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ OptionalFixedAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ OptionalFixedAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ OptionalFixedAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:40 +[packages/matter.js/src/cluster/Cluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L40) ___ @@ -275,4 +275,4 @@ OptionalFixedAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.ConditionalWritableAttribute.md b/docs/matter.js/interfaces/cluster_export.ConditionalWritableAttribute.md index 8a1d50d75f..87bb5c94ff 100644 --- a/docs/matter.js/interfaces/cluster_export.ConditionalWritableAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.ConditionalWritableAttribute.md @@ -51,7 +51,7 @@ OptionalWritableAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ OptionalWritableAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ OptionalWritableAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ OptionalWritableAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ OptionalWritableAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:72 +[packages/matter.js/src/cluster/Cluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L72) ___ @@ -121,7 +121,7 @@ OptionalWritableAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ OptionalWritableAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ OptionalWritableAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:56 +[packages/matter.js/src/cluster/Cluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L56) ___ @@ -163,7 +163,7 @@ OptionalWritableAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ OptionalWritableAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ OptionalWritableAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ OptionalWritableAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ OptionalWritableAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ OptionalWritableAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ OptionalWritableAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ OptionalWritableAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:68 +[packages/matter.js/src/cluster/Cluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L68) ___ @@ -275,4 +275,4 @@ OptionalWritableAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.ConditionalWritableFabricScopedAttribute.md b/docs/matter.js/interfaces/cluster_export.ConditionalWritableFabricScopedAttribute.md index 03037b9768..02a73dd794 100644 --- a/docs/matter.js/interfaces/cluster_export.ConditionalWritableFabricScopedAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.ConditionalWritableFabricScopedAttribute.md @@ -51,7 +51,7 @@ OptionalWritableFabricScopedAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ OptionalWritableFabricScopedAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:84 +[packages/matter.js/src/cluster/Cluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L84) ___ @@ -79,7 +79,7 @@ OptionalWritableFabricScopedAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ OptionalWritableFabricScopedAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ OptionalWritableFabricScopedAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:89 +[packages/matter.js/src/cluster/Cluster.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L89) ___ @@ -121,7 +121,7 @@ OptionalWritableFabricScopedAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ OptionalWritableFabricScopedAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ OptionalWritableFabricScopedAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:56 +[packages/matter.js/src/cluster/Cluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L56) ___ @@ -163,7 +163,7 @@ OptionalWritableFabricScopedAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ OptionalWritableFabricScopedAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ OptionalWritableFabricScopedAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ OptionalWritableFabricScopedAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ OptionalWritableFabricScopedAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ OptionalWritableFabricScopedAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ OptionalWritableFabricScopedAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ OptionalWritableFabricScopedAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:68 +[packages/matter.js/src/cluster/Cluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L68) ___ @@ -275,4 +275,4 @@ OptionalWritableFabricScopedAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.Event.md b/docs/matter.js/interfaces/cluster_export.Event.md index 454231e9be..51dd82f86b 100644 --- a/docs/matter.js/interfaces/cluster_export.Event.md +++ b/docs/matter.js/interfaces/cluster_export.Event.md @@ -33,7 +33,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:714 +[packages/matter.js/src/cluster/Cluster.ts:714](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L714) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:719 +[packages/matter.js/src/cluster/Cluster.ts:719](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L719) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:721 +[packages/matter.js/src/cluster/Cluster.ts:721](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L721) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:717 +[packages/matter.js/src/cluster/Cluster.ts:717](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L717) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:720 +[packages/matter.js/src/cluster/Cluster.ts:720](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L720) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:716 +[packages/matter.js/src/cluster/Cluster.ts:716](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L716) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:718 +[packages/matter.js/src/cluster/Cluster.ts:718](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L718) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:715 +[packages/matter.js/src/cluster/Cluster.ts:715](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L715) ___ @@ -113,4 +113,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:722 +[packages/matter.js/src/cluster/Cluster.ts:722](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L722) diff --git a/docs/matter.js/interfaces/cluster_export.FabricScopedAttribute.md b/docs/matter.js/interfaces/cluster_export.FabricScopedAttribute.md index b0b18d50cb..52608ca955 100644 --- a/docs/matter.js/interfaces/cluster_export.FabricScopedAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.FabricScopedAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:76 +[packages/matter.js/src/cluster/Cluster.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L76) ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:38 +[packages/matter.js/src/cluster/Cluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L38) ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:40 +[packages/matter.js/src/cluster/Cluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L40) ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.FixedAttribute.md b/docs/matter.js/interfaces/cluster_export.FixedAttribute.md index 530d2f2e8b..ae54cf8525 100644 --- a/docs/matter.js/interfaces/cluster_export.FixedAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.FixedAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:93 +[packages/matter.js/src/cluster/Cluster.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L93) ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:38 +[packages/matter.js/src/cluster/Cluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L38) ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:40 +[packages/matter.js/src/cluster/Cluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L40) ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.OperationalCredentialsServerConf.md b/docs/matter.js/interfaces/cluster_export.OperationalCredentialsServerConf.md index 2b93b16618..1fe5de4103 100644 --- a/docs/matter.js/interfaces/cluster_export.OperationalCredentialsServerConf.md +++ b/docs/matter.js/interfaces/cluster_export.OperationalCredentialsServerConf.md @@ -21,7 +21,7 @@ #### Defined in -packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:35 +[packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts#L35) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:33 +[packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts#L33) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:34 +[packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts#L34) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:32 +[packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts#L32) diff --git a/docs/matter.js/interfaces/cluster_export.OptionalAttribute.md b/docs/matter.js/interfaces/cluster_export.OptionalAttribute.md index 00cec85415..fbfc289320 100644 --- a/docs/matter.js/interfaces/cluster_export.OptionalAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.OptionalAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:56 +[packages/matter.js/src/cluster/Cluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L56) ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:40 +[packages/matter.js/src/cluster/Cluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L40) ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.OptionalCommand.md b/docs/matter.js/interfaces/cluster_export.OptionalCommand.md index 9ce6bd7879..481cff5a60 100644 --- a/docs/matter.js/interfaces/cluster_export.OptionalCommand.md +++ b/docs/matter.js/interfaces/cluster_export.OptionalCommand.md @@ -45,7 +45,7 @@ Command.invokeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:604 +[packages/matter.js/src/cluster/Cluster.ts:604](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L604) ___ @@ -59,7 +59,7 @@ Command.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:606 +[packages/matter.js/src/cluster/Cluster.ts:606](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L606) ___ @@ -73,7 +73,7 @@ Command.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:607 +[packages/matter.js/src/cluster/Cluster.ts:607](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L607) ___ @@ -87,7 +87,7 @@ Command.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:612 +[packages/matter.js/src/cluster/Cluster.ts:612](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L612) ___ @@ -101,7 +101,7 @@ Command.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:608 +[packages/matter.js/src/cluster/Cluster.ts:608](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L608) ___ @@ -115,7 +115,7 @@ Command.requestId #### Defined in -packages/matter.js/src/cluster/Cluster.ts:600 +[packages/matter.js/src/cluster/Cluster.ts:600](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L600) ___ @@ -129,7 +129,7 @@ Command.requestSchema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:601 +[packages/matter.js/src/cluster/Cluster.ts:601](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L601) ___ @@ -143,7 +143,7 @@ Command.responseId #### Defined in -packages/matter.js/src/cluster/Cluster.ts:602 +[packages/matter.js/src/cluster/Cluster.ts:602](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L602) ___ @@ -157,7 +157,7 @@ Command.responseSchema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:603 +[packages/matter.js/src/cluster/Cluster.ts:603](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L603) ___ @@ -171,4 +171,4 @@ Command.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:605 +[packages/matter.js/src/cluster/Cluster.ts:605](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L605) diff --git a/docs/matter.js/interfaces/cluster_export.OptionalEvent.md b/docs/matter.js/interfaces/cluster_export.OptionalEvent.md index 60199c03e4..3cb3b73444 100644 --- a/docs/matter.js/interfaces/cluster_export.OptionalEvent.md +++ b/docs/matter.js/interfaces/cluster_export.OptionalEvent.md @@ -43,7 +43,7 @@ Event.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:714 +[packages/matter.js/src/cluster/Cluster.ts:714](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L714) ___ @@ -57,7 +57,7 @@ Event.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:719 +[packages/matter.js/src/cluster/Cluster.ts:719](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L719) ___ @@ -71,7 +71,7 @@ Event.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:721 +[packages/matter.js/src/cluster/Cluster.ts:721](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L721) ___ @@ -85,7 +85,7 @@ Event.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:739 +[packages/matter.js/src/cluster/Cluster.ts:739](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L739) ___ @@ -99,7 +99,7 @@ Event.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:720 +[packages/matter.js/src/cluster/Cluster.ts:720](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L720) ___ @@ -113,7 +113,7 @@ Event.priority #### Defined in -packages/matter.js/src/cluster/Cluster.ts:716 +[packages/matter.js/src/cluster/Cluster.ts:716](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L716) ___ @@ -127,7 +127,7 @@ Event.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:718 +[packages/matter.js/src/cluster/Cluster.ts:718](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L718) ___ @@ -141,7 +141,7 @@ Event.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:715 +[packages/matter.js/src/cluster/Cluster.ts:715](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L715) ___ @@ -155,4 +155,4 @@ Event.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:722 +[packages/matter.js/src/cluster/Cluster.ts:722](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L722) diff --git a/docs/matter.js/interfaces/cluster_export.OptionalFixedAttribute.md b/docs/matter.js/interfaces/cluster_export.OptionalFixedAttribute.md index 1601f0c156..8d357fef6d 100644 --- a/docs/matter.js/interfaces/cluster_export.OptionalFixedAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.OptionalFixedAttribute.md @@ -51,7 +51,7 @@ OptionalAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ OptionalAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ OptionalAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:101 +[packages/matter.js/src/cluster/Cluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L101) ___ @@ -93,7 +93,7 @@ OptionalAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ OptionalAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ OptionalAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ OptionalAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ OptionalAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:56 +[packages/matter.js/src/cluster/Cluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L56) ___ @@ -163,7 +163,7 @@ OptionalAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ OptionalAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ OptionalAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ OptionalAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ OptionalAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ OptionalAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ OptionalAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ OptionalAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:40 +[packages/matter.js/src/cluster/Cluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L40) ___ @@ -275,4 +275,4 @@ OptionalAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.OptionalWritableAttribute.md b/docs/matter.js/interfaces/cluster_export.OptionalWritableAttribute.md index 003cc4a9b4..c76a162518 100644 --- a/docs/matter.js/interfaces/cluster_export.OptionalWritableAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.OptionalWritableAttribute.md @@ -51,7 +51,7 @@ OptionalAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ OptionalAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ OptionalAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ OptionalAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ OptionalAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ OptionalAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ OptionalAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ OptionalAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:56 +[packages/matter.js/src/cluster/Cluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L56) ___ @@ -163,7 +163,7 @@ OptionalAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ OptionalAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ OptionalAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ OptionalAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ OptionalAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ OptionalAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ OptionalAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ OptionalAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:68 +[packages/matter.js/src/cluster/Cluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L68) ___ @@ -275,4 +275,4 @@ OptionalAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.OptionalWritableFabricScopedAttribute.md b/docs/matter.js/interfaces/cluster_export.OptionalWritableFabricScopedAttribute.md index 376d626068..1d6fb43320 100644 --- a/docs/matter.js/interfaces/cluster_export.OptionalWritableFabricScopedAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.OptionalWritableFabricScopedAttribute.md @@ -51,7 +51,7 @@ OptionalWritableAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ OptionalWritableAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:84 +[packages/matter.js/src/cluster/Cluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L84) ___ @@ -79,7 +79,7 @@ OptionalWritableAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ OptionalWritableAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ OptionalWritableAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ OptionalWritableAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ OptionalWritableAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ OptionalWritableAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:56 +[packages/matter.js/src/cluster/Cluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L56) ___ @@ -163,7 +163,7 @@ OptionalWritableAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ OptionalWritableAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ OptionalWritableAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ OptionalWritableAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ OptionalWritableAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ OptionalWritableAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ OptionalWritableAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ OptionalWritableAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:68 +[packages/matter.js/src/cluster/Cluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L68) ___ @@ -275,4 +275,4 @@ OptionalWritableAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.UnknownAttribute.md b/docs/matter.js/interfaces/cluster_export.UnknownAttribute.md index b4bb80f6e5..4f15181713 100644 --- a/docs/matter.js/interfaces/cluster_export.UnknownAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.UnknownAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:38 +[packages/matter.js/src/cluster/Cluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L38) ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:566 +[packages/matter.js/src/cluster/Cluster.ts:566](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L566) ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:40 +[packages/matter.js/src/cluster/Cluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L40) ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.UnknownEvent.md b/docs/matter.js/interfaces/cluster_export.UnknownEvent.md index 23c00f17ea..b0a9335c40 100644 --- a/docs/matter.js/interfaces/cluster_export.UnknownEvent.md +++ b/docs/matter.js/interfaces/cluster_export.UnknownEvent.md @@ -42,7 +42,7 @@ Event.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:714 +[packages/matter.js/src/cluster/Cluster.ts:714](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L714) ___ @@ -56,7 +56,7 @@ Event.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:719 +[packages/matter.js/src/cluster/Cluster.ts:719](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L719) ___ @@ -70,7 +70,7 @@ Event.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:721 +[packages/matter.js/src/cluster/Cluster.ts:721](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L721) ___ @@ -84,7 +84,7 @@ Event.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:717 +[packages/matter.js/src/cluster/Cluster.ts:717](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L717) ___ @@ -98,7 +98,7 @@ Event.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:720 +[packages/matter.js/src/cluster/Cluster.ts:720](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L720) ___ @@ -112,7 +112,7 @@ Event.priority #### Defined in -packages/matter.js/src/cluster/Cluster.ts:716 +[packages/matter.js/src/cluster/Cluster.ts:716](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L716) ___ @@ -126,7 +126,7 @@ Event.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:718 +[packages/matter.js/src/cluster/Cluster.ts:718](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L718) ___ @@ -140,7 +140,7 @@ Event.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:715 +[packages/matter.js/src/cluster/Cluster.ts:715](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L715) ___ @@ -154,4 +154,4 @@ Event.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:726 +[packages/matter.js/src/cluster/Cluster.ts:726](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L726) diff --git a/docs/matter.js/interfaces/cluster_export.WritableAttribute.md b/docs/matter.js/interfaces/cluster_export.WritableAttribute.md index 64c5eaf8b2..ad2cfdb96a 100644 --- a/docs/matter.js/interfaces/cluster_export.WritableAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.WritableAttribute.md @@ -51,7 +51,7 @@ Attribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ Attribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ Attribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ Attribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ Attribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ Attribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ Attribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ Attribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:38 +[packages/matter.js/src/cluster/Cluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L38) ___ @@ -163,7 +163,7 @@ Attribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ Attribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ Attribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ Attribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ Attribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ Attribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ Attribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ Attribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:64 +[packages/matter.js/src/cluster/Cluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L64) ___ @@ -275,4 +275,4 @@ Attribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.WritableFabricScopedAttribute.md b/docs/matter.js/interfaces/cluster_export.WritableFabricScopedAttribute.md index fea3789736..58fa0b4767 100644 --- a/docs/matter.js/interfaces/cluster_export.WritableFabricScopedAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.WritableFabricScopedAttribute.md @@ -51,7 +51,7 @@ WritableAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ WritableAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:80 +[packages/matter.js/src/cluster/Cluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L80) ___ @@ -79,7 +79,7 @@ WritableAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:44 +[packages/matter.js/src/cluster/Cluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L44) ___ @@ -93,7 +93,7 @@ WritableAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ WritableAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ WritableAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ WritableAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ WritableAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:38 +[packages/matter.js/src/cluster/Cluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L38) ___ @@ -163,7 +163,7 @@ WritableAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ WritableAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ WritableAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ WritableAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ WritableAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ WritableAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ WritableAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ WritableAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:64 +[packages/matter.js/src/cluster/Cluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L64) ___ @@ -275,4 +275,4 @@ WritableAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/cluster_export.WritableFixedAttribute.md b/docs/matter.js/interfaces/cluster_export.WritableFixedAttribute.md index f6f4790684..e96ec83b4d 100644 --- a/docs/matter.js/interfaces/cluster_export.WritableFixedAttribute.md +++ b/docs/matter.js/interfaces/cluster_export.WritableFixedAttribute.md @@ -51,7 +51,7 @@ WritableAttribute.default #### Defined in -packages/matter.js/src/cluster/Cluster.ts:48 +[packages/matter.js/src/cluster/Cluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L48) ___ @@ -65,7 +65,7 @@ WritableAttribute.fabricScoped #### Defined in -packages/matter.js/src/cluster/Cluster.ts:45 +[packages/matter.js/src/cluster/Cluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L45) ___ @@ -79,7 +79,7 @@ WritableAttribute.fixed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:97 +[packages/matter.js/src/cluster/Cluster.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L97) ___ @@ -93,7 +93,7 @@ WritableAttribute.id #### Defined in -packages/matter.js/src/cluster/Cluster.ts:36 +[packages/matter.js/src/cluster/Cluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L36) ___ @@ -107,7 +107,7 @@ WritableAttribute.isConditional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:49 +[packages/matter.js/src/cluster/Cluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L49) ___ @@ -121,7 +121,7 @@ WritableAttribute.mandatoryIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:51 +[packages/matter.js/src/cluster/Cluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L51) ___ @@ -135,7 +135,7 @@ WritableAttribute.omitChanges #### Defined in -packages/matter.js/src/cluster/Cluster.ts:46 +[packages/matter.js/src/cluster/Cluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L46) ___ @@ -149,7 +149,7 @@ WritableAttribute.optional #### Defined in -packages/matter.js/src/cluster/Cluster.ts:38 +[packages/matter.js/src/cluster/Cluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L38) ___ @@ -163,7 +163,7 @@ WritableAttribute.optionalIf #### Defined in -packages/matter.js/src/cluster/Cluster.ts:50 +[packages/matter.js/src/cluster/Cluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L50) ___ @@ -177,7 +177,7 @@ WritableAttribute.persistent #### Defined in -packages/matter.js/src/cluster/Cluster.ts:42 +[packages/matter.js/src/cluster/Cluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L42) ___ @@ -191,7 +191,7 @@ WritableAttribute.readAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:39 +[packages/matter.js/src/cluster/Cluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L39) ___ @@ -205,7 +205,7 @@ WritableAttribute.scene #### Defined in -packages/matter.js/src/cluster/Cluster.ts:41 +[packages/matter.js/src/cluster/Cluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L41) ___ @@ -219,7 +219,7 @@ WritableAttribute.schema #### Defined in -packages/matter.js/src/cluster/Cluster.ts:37 +[packages/matter.js/src/cluster/Cluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L37) ___ @@ -233,7 +233,7 @@ WritableAttribute.timed #### Defined in -packages/matter.js/src/cluster/Cluster.ts:43 +[packages/matter.js/src/cluster/Cluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L43) ___ @@ -247,7 +247,7 @@ WritableAttribute.unknown #### Defined in -packages/matter.js/src/cluster/Cluster.ts:52 +[packages/matter.js/src/cluster/Cluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L52) ___ @@ -261,7 +261,7 @@ WritableAttribute.writable #### Defined in -packages/matter.js/src/cluster/Cluster.ts:64 +[packages/matter.js/src/cluster/Cluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L64) ___ @@ -275,4 +275,4 @@ WritableAttribute.writeAcl #### Defined in -packages/matter.js/src/cluster/Cluster.ts:47 +[packages/matter.js/src/cluster/Cluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L47) diff --git a/docs/matter.js/interfaces/codec_export.BtpHandshakeRequest.md b/docs/matter.js/interfaces/codec_export.BtpHandshakeRequest.md index 86d8cd5894..33af8bfb9b 100644 --- a/docs/matter.js/interfaces/codec_export.BtpHandshakeRequest.md +++ b/docs/matter.js/interfaces/codec_export.BtpHandshakeRequest.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:16 +[packages/matter.js/src/codec/BtpCodec.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L16) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:17 +[packages/matter.js/src/codec/BtpCodec.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L17) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:15 +[packages/matter.js/src/codec/BtpCodec.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L15) diff --git a/docs/matter.js/interfaces/codec_export.BtpHandshakeResponse.md b/docs/matter.js/interfaces/codec_export.BtpHandshakeResponse.md index 38113dbffe..fbbc39ea8f 100644 --- a/docs/matter.js/interfaces/codec_export.BtpHandshakeResponse.md +++ b/docs/matter.js/interfaces/codec_export.BtpHandshakeResponse.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:22 +[packages/matter.js/src/codec/BtpCodec.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L22) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:21 +[packages/matter.js/src/codec/BtpCodec.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L21) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:23 +[packages/matter.js/src/codec/BtpCodec.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L23) diff --git a/docs/matter.js/interfaces/codec_export.BtpHeader.md b/docs/matter.js/interfaces/codec_export.BtpHeader.md index 06591b0245..4657f88e1d 100644 --- a/docs/matter.js/interfaces/codec_export.BtpHeader.md +++ b/docs/matter.js/interfaces/codec_export.BtpHeader.md @@ -23,7 +23,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:40 +[packages/matter.js/src/codec/BtpCodec.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L40) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:39 +[packages/matter.js/src/codec/BtpCodec.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L39) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:43 +[packages/matter.js/src/codec/BtpCodec.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L43) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:42 +[packages/matter.js/src/codec/BtpCodec.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L42) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:41 +[packages/matter.js/src/codec/BtpCodec.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L41) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:38 +[packages/matter.js/src/codec/BtpCodec.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L38) diff --git a/docs/matter.js/interfaces/codec_export.BtpPacket.md b/docs/matter.js/interfaces/codec_export.BtpPacket.md index 98c887f1a9..ea944a45ef 100644 --- a/docs/matter.js/interfaces/codec_export.BtpPacket.md +++ b/docs/matter.js/interfaces/codec_export.BtpPacket.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:47 +[packages/matter.js/src/codec/BtpCodec.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L47) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:48 +[packages/matter.js/src/codec/BtpCodec.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L48) diff --git a/docs/matter.js/interfaces/codec_export.BtpPacketPayload.md b/docs/matter.js/interfaces/codec_export.BtpPacketPayload.md index 089a5c2a9c..3b4e7099e2 100644 --- a/docs/matter.js/interfaces/codec_export.BtpPacketPayload.md +++ b/docs/matter.js/interfaces/codec_export.BtpPacketPayload.md @@ -27,7 +27,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:27 +[packages/matter.js/src/codec/BtpCodec.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L27) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:29 +[packages/matter.js/src/codec/BtpCodec.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L29) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:30 +[packages/matter.js/src/codec/BtpCodec.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L30) ___ @@ -57,4 +57,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:28 +[packages/matter.js/src/codec/BtpCodec.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L28) diff --git a/docs/matter.js/interfaces/codec_export.DecodedBtpPacket.md b/docs/matter.js/interfaces/codec_export.DecodedBtpPacket.md index b42f18a01a..3f6c6df745 100644 --- a/docs/matter.js/interfaces/codec_export.DecodedBtpPacket.md +++ b/docs/matter.js/interfaces/codec_export.DecodedBtpPacket.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:52 +[packages/matter.js/src/codec/BtpCodec.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L52) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:53 +[packages/matter.js/src/codec/BtpCodec.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L53) diff --git a/docs/matter.js/interfaces/codec_export.DecodedBtpPacketPayload.md b/docs/matter.js/interfaces/codec_export.DecodedBtpPacketPayload.md index 2eae3a186a..a634dddffa 100644 --- a/docs/matter.js/interfaces/codec_export.DecodedBtpPacketPayload.md +++ b/docs/matter.js/interfaces/codec_export.DecodedBtpPacketPayload.md @@ -31,7 +31,7 @@ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:27 +[packages/matter.js/src/codec/BtpCodec.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L27) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:29 +[packages/matter.js/src/codec/BtpCodec.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L29) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:34 +[packages/matter.js/src/codec/BtpCodec.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L34) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -packages/matter.js/src/codec/BtpCodec.ts:28 +[packages/matter.js/src/codec/BtpCodec.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/BtpCodec.ts#L28) diff --git a/docs/matter.js/interfaces/codec_export.Message.md b/docs/matter.js/interfaces/codec_export.Message.md index f6d16a20fe..41ec6178bc 100644 --- a/docs/matter.js/interfaces/codec_export.Message.md +++ b/docs/matter.js/interfaces/codec_export.Message.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:42 +[packages/matter.js/src/codec/MessageCodec.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L42) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:44 +[packages/matter.js/src/codec/MessageCodec.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L44) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:43 +[packages/matter.js/src/codec/MessageCodec.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L43) diff --git a/docs/matter.js/interfaces/codec_export.Packet.md b/docs/matter.js/interfaces/codec_export.Packet.md index e80d1c29e2..852b722eaa 100644 --- a/docs/matter.js/interfaces/codec_export.Packet.md +++ b/docs/matter.js/interfaces/codec_export.Packet.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:38 +[packages/matter.js/src/codec/MessageCodec.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L38) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:37 +[packages/matter.js/src/codec/MessageCodec.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L37) diff --git a/docs/matter.js/interfaces/codec_export.PacketHeader.md b/docs/matter.js/interfaces/codec_export.PacketHeader.md index e98c21cc38..ba027fa12c 100644 --- a/docs/matter.js/interfaces/codec_export.PacketHeader.md +++ b/docs/matter.js/interfaces/codec_export.PacketHeader.md @@ -26,7 +26,7 @@ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:24 +[packages/matter.js/src/codec/MessageCodec.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L24) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:23 +[packages/matter.js/src/codec/MessageCodec.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L23) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:20 +[packages/matter.js/src/codec/MessageCodec.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L20) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:18 +[packages/matter.js/src/codec/MessageCodec.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L18) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:19 +[packages/matter.js/src/codec/MessageCodec.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L19) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:21 +[packages/matter.js/src/codec/MessageCodec.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L21) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:16 +[packages/matter.js/src/codec/MessageCodec.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L16) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:17 +[packages/matter.js/src/codec/MessageCodec.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L17) ___ @@ -106,4 +106,4 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:22 +[packages/matter.js/src/codec/MessageCodec.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L22) diff --git a/docs/matter.js/interfaces/codec_export.PayloadHeader.md b/docs/matter.js/interfaces/codec_export.PayloadHeader.md index b62f6dcbaf..1e6f2b7c92 100644 --- a/docs/matter.js/interfaces/codec_export.PayloadHeader.md +++ b/docs/matter.js/interfaces/codec_export.PayloadHeader.md @@ -23,7 +23,7 @@ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:33 +[packages/matter.js/src/codec/MessageCodec.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L33) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:28 +[packages/matter.js/src/codec/MessageCodec.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L28) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:31 +[packages/matter.js/src/codec/MessageCodec.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L31) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:30 +[packages/matter.js/src/codec/MessageCodec.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L30) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:29 +[packages/matter.js/src/codec/MessageCodec.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L29) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -packages/matter.js/src/codec/MessageCodec.ts:32 +[packages/matter.js/src/codec/MessageCodec.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/MessageCodec.ts#L32) diff --git a/docs/matter.js/interfaces/common_export.Channel.md b/docs/matter.js/interfaces/common_export.Channel.md index c32a11768e..76145c1802 100644 --- a/docs/matter.js/interfaces/common_export.Channel.md +++ b/docs/matter.js/interfaces/common_export.Channel.md @@ -39,7 +39,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/common/Channel.ts:8 +[packages/matter.js/src/common/Channel.ts:8](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Channel.ts#L8) ## Methods @@ -53,7 +53,7 @@ packages/matter.js/src/common/Channel.ts:8 #### Defined in -packages/matter.js/src/common/Channel.ts:10 +[packages/matter.js/src/common/Channel.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Channel.ts#L10) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -packages/matter.js/src/common/Channel.ts:9 +[packages/matter.js/src/common/Channel.ts:9](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Channel.ts#L9) diff --git a/docs/matter.js/interfaces/common_export.InstanceBroadcaster.md b/docs/matter.js/interfaces/common_export.InstanceBroadcaster.md index aa89854c68..e27af0d085 100644 --- a/docs/matter.js/interfaces/common_export.InstanceBroadcaster.md +++ b/docs/matter.js/interfaces/common_export.InstanceBroadcaster.md @@ -36,7 +36,7 @@ Send out announcements for this instance. #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:205 +[packages/matter.js/src/common/InstanceBroadcaster.ts:205](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L205) ___ @@ -52,7 +52,7 @@ Expire all announcements. #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:214 +[packages/matter.js/src/common/InstanceBroadcaster.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L214) ___ @@ -68,7 +68,7 @@ Expire the announcement for this commissioning instance. #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:211 +[packages/matter.js/src/common/InstanceBroadcaster.ts:211](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L211) ___ @@ -84,7 +84,7 @@ Expire the announcement for this operative instance. #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:208 +[packages/matter.js/src/common/InstanceBroadcaster.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L208) ___ @@ -107,7 +107,7 @@ Set a commissionable mode and details to announce a commissionable device. #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:193 +[packages/matter.js/src/common/InstanceBroadcaster.ts:193](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L193) ___ @@ -129,7 +129,7 @@ Set commissioner details to announce a commissioner service for User directed co #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:202 +[packages/matter.js/src/common/InstanceBroadcaster.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L202) ___ @@ -153,4 +153,4 @@ Use expireCommissioningAnnouncements = true when Fabrics are changed after a n c #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:199 +[packages/matter.js/src/common/InstanceBroadcaster.ts:199](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L199) diff --git a/docs/matter.js/interfaces/common_export.Listener.md b/docs/matter.js/interfaces/common_export.Listener.md index 131db84ccc..34fb2b19ba 100644 --- a/docs/matter.js/interfaces/common_export.Listener.md +++ b/docs/matter.js/interfaces/common_export.Listener.md @@ -22,4 +22,4 @@ #### Defined in -packages/matter.js/src/common/TransportInterface.ts:11 +[packages/matter.js/src/common/TransportInterface.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/TransportInterface.ts#L11) diff --git a/docs/matter.js/interfaces/common_export.Scanner.md b/docs/matter.js/interfaces/common_export.Scanner.md index d58ccca80e..561ee5b0a0 100644 --- a/docs/matter.js/interfaces/common_export.Scanner.md +++ b/docs/matter.js/interfaces/common_export.Scanner.md @@ -12,14 +12,39 @@ ### Methods +- [cancelCommissionableDeviceDiscovery](common_export.Scanner.md#cancelcommissionabledevicediscovery) - [close](common_export.Scanner.md#close) - [findCommissionableDevices](common_export.Scanner.md#findcommissionabledevices) +- [findCommissionableDevicesContinuously](common_export.Scanner.md#findcommissionabledevicescontinuously) - [findOperationalDevice](common_export.Scanner.md#findoperationaldevice) - [getDiscoveredCommissionableDevices](common_export.Scanner.md#getdiscoveredcommissionabledevices) - [getDiscoveredOperationalDevices](common_export.Scanner.md#getdiscoveredoperationaldevices) ## Methods +### cancelCommissionableDeviceDiscovery + +▸ **cancelCommissionableDeviceDiscovery**(`identifier`): `void` + +Cancel a running discovery of commissionable devices. The waiter promises are resolved as if the timeout would +be over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/common/Scanner.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L136) + +___ + ### close ▸ **close**(): `void` @@ -32,22 +57,49 @@ Close the scanner server and free resources. #### Defined in -packages/matter.js/src/common/Scanner.ts:114 +[packages/matter.js/src/common/Scanner.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L139) ___ ### findCommissionableDevices -▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> +▸ **findCommissionableDevices**(`identifier`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> + +Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, +vendorId, etc.) and returns as soon as minimum one was found or the timeout is over. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | +| `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | + +#### Returns + +`Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> + +#### Defined in + +[packages/matter.js/src/common/Scanner.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L112) + +___ + +### findCommissionableDevicesContinuously + +▸ **findCommissionableDevicesContinuously**(`identifier`, `callback`, `timeoutSeconds?`): `Promise`<[`CommissionableDevice`](../modules/common_export.md#commissionabledevice)[]\> -Send DNS-SD queries to discover commissionable devices by an provided identifier (e.g. discriminator, -vendorId, etc.) and return them. +Send DNS-SD queries to discover commissionable devices by a provided identifier (e.g. discriminator, +vendorId, etc.) and returns after the timeout is over. For each new discovered device the provided callback is +called when it is discovered. #### Parameters | Name | Type | | :------ | :------ | | `identifier` | [`CommissionableDeviceIdentifiers`](../modules/common_export.md#commissionabledeviceidentifiers) | +| `callback` | (`device`: [`CommissionableDevice`](../modules/common_export.md#commissionabledevice)) => `void` | | `timeoutSeconds?` | `number` | #### Returns @@ -56,13 +108,13 @@ vendorId, etc.) and return them. #### Defined in -packages/matter.js/src/common/Scanner.ts:105 +[packages/matter.js/src/common/Scanner.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L123) ___ ### findOperationalDevice -▸ **findOperationalDevice**(`fabric`, `nodeId`, `timeoutSeconds?`): `Promise`<[`ServerAddressIp`](../modules/common_export.md#serveraddressip)[]\> +▸ **findOperationalDevice**(`fabric`, `nodeId`, `timeoutSeconds?`, `ignoreExistingRecords?`): `Promise`<[`ServerAddressIp`](../modules/common_export.md#serveraddressip)[]\> Send DNS-SD queries to discover the current addresses of an operational paired device by its operational ID and return them. @@ -74,6 +126,7 @@ and return them. | `fabric` | [`Fabric`](../classes/fabric_export.Fabric.md) | | `nodeId` | [`NodeId`](../modules/datatype_export.md#nodeid) | | `timeoutSeconds?` | `number` | +| `ignoreExistingRecords?` | `boolean` | #### Returns @@ -81,7 +134,7 @@ and return them. #### Defined in -packages/matter.js/src/common/Scanner.ts:93 +[packages/matter.js/src/common/Scanner.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L95) ___ @@ -103,7 +156,7 @@ Return already discovered commissionable devices and return them. Does not send #### Defined in -packages/matter.js/src/common/Scanner.ts:111 +[packages/matter.js/src/common/Scanner.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L130) ___ @@ -127,4 +180,4 @@ DNS-SD queries. #### Defined in -packages/matter.js/src/common/Scanner.ts:99 +[packages/matter.js/src/common/Scanner.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L106) diff --git a/docs/matter.js/interfaces/common_export.TransportInterface.md b/docs/matter.js/interfaces/common_export.TransportInterface.md index 9702c38aeb..f78b2d1af7 100644 --- a/docs/matter.js/interfaces/common_export.TransportInterface.md +++ b/docs/matter.js/interfaces/common_export.TransportInterface.md @@ -32,7 +32,7 @@ It can not open new connections. #### Defined in -packages/matter.js/src/common/TransportInterface.ts:20 +[packages/matter.js/src/common/TransportInterface.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/TransportInterface.ts#L20) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -packages/matter.js/src/common/TransportInterface.ts:19 +[packages/matter.js/src/common/TransportInterface.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/TransportInterface.ts#L19) diff --git a/docs/matter.js/interfaces/crypto_export.Key.md b/docs/matter.js/interfaces/crypto_export.Key.md index 9e387f8710..3f81df5a10 100644 --- a/docs/matter.js/interfaces/crypto_export.Key.md +++ b/docs/matter.js/interfaces/crypto_export.Key.md @@ -85,7 +85,7 @@ JsonWebKey.alg #### Defined in -packages/matter.js/src/crypto/Key.ts:107 +[packages/matter.js/src/crypto/Key.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L107) ___ @@ -97,7 +97,7 @@ The key algorithm, alias for JWK "alg" field. #### Defined in -packages/matter.js/src/crypto/Key.ts:79 +[packages/matter.js/src/crypto/Key.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L79) ___ @@ -111,7 +111,7 @@ JsonWebKey.crv #### Defined in -packages/matter.js/src/crypto/Key.ts:108 +[packages/matter.js/src/crypto/Key.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L108) ___ @@ -123,7 +123,7 @@ The elliptic curve type, alias for JWK "crv" field. #### Defined in -packages/matter.js/src/crypto/Key.ts:84 +[packages/matter.js/src/crypto/Key.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L84) ___ @@ -137,7 +137,7 @@ JsonWebKey.d #### Defined in -packages/matter.js/src/crypto/Key.ts:109 +[packages/matter.js/src/crypto/Key.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L109) ___ @@ -151,7 +151,7 @@ JsonWebKey.dp #### Defined in -packages/matter.js/src/crypto/Key.ts:110 +[packages/matter.js/src/crypto/Key.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L110) ___ @@ -165,7 +165,7 @@ JsonWebKey.dq #### Defined in -packages/matter.js/src/crypto/Key.ts:111 +[packages/matter.js/src/crypto/Key.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L111) ___ @@ -179,7 +179,7 @@ JsonWebKey.e #### Defined in -packages/matter.js/src/crypto/Key.ts:112 +[packages/matter.js/src/crypto/Key.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L112) ___ @@ -193,7 +193,7 @@ JsonWebKey.ext #### Defined in -packages/matter.js/src/crypto/Key.ts:113 +[packages/matter.js/src/crypto/Key.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L113) ___ @@ -206,7 +206,7 @@ field. #### Defined in -packages/matter.js/src/crypto/Key.ts:105 +[packages/matter.js/src/crypto/Key.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L105) ___ @@ -220,7 +220,7 @@ JsonWebKey.k #### Defined in -packages/matter.js/src/crypto/Key.ts:114 +[packages/matter.js/src/crypto/Key.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L114) ___ @@ -232,7 +232,7 @@ Alias for keyPairBits that throws if a complete key pair is not present. #### Defined in -packages/matter.js/src/crypto/Key.ts:184 +[packages/matter.js/src/crypto/Key.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L184) ___ @@ -245,7 +245,7 @@ serialization format for legacy reasons. #### Defined in -packages/matter.js/src/crypto/Key.ts:169 +[packages/matter.js/src/crypto/Key.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L169) ___ @@ -259,7 +259,7 @@ JsonWebKey.key\_ops #### Defined in -packages/matter.js/src/crypto/Key.ts:115 +[packages/matter.js/src/crypto/Key.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L115) ___ @@ -273,7 +273,7 @@ JsonWebKey.kty #### Defined in -packages/matter.js/src/crypto/Key.ts:116 +[packages/matter.js/src/crypto/Key.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L116) ___ @@ -287,7 +287,7 @@ JsonWebKey.n #### Defined in -packages/matter.js/src/crypto/Key.ts:117 +[packages/matter.js/src/crypto/Key.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L117) ___ @@ -299,7 +299,7 @@ Operations supported by the key, alias for JWK "key_ops" field. #### Defined in -packages/matter.js/src/crypto/Key.ts:94 +[packages/matter.js/src/crypto/Key.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L94) ___ @@ -313,7 +313,7 @@ JsonWebKey.oth #### Defined in -packages/matter.js/src/crypto/Key.ts:118 +[packages/matter.js/src/crypto/Key.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L118) ___ @@ -327,7 +327,7 @@ JsonWebKey.p #### Defined in -packages/matter.js/src/crypto/Key.ts:119 +[packages/matter.js/src/crypto/Key.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L119) ___ @@ -339,7 +339,7 @@ Import (write-only) of private keys encoded in PKCS #8 format. #### Defined in -packages/matter.js/src/crypto/Key.ts:152 +[packages/matter.js/src/crypto/Key.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L152) ___ @@ -351,7 +351,7 @@ The private key, alias for JWK "d" field. #### Defined in -packages/matter.js/src/crypto/Key.ts:99 +[packages/matter.js/src/crypto/Key.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L99) ___ @@ -364,7 +364,7 @@ base-64 private key. #### Defined in -packages/matter.js/src/crypto/Key.ts:130 +[packages/matter.js/src/crypto/Key.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L130) ___ @@ -376,7 +376,7 @@ Alias for privateBits that throws if no private key is present. #### Defined in -packages/matter.js/src/crypto/Key.ts:179 +[packages/matter.js/src/crypto/Key.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L179) ___ @@ -389,7 +389,7 @@ fields internally. #### Defined in -packages/matter.js/src/crypto/Key.ts:163 +[packages/matter.js/src/crypto/Key.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L163) ___ @@ -401,7 +401,7 @@ Alias for publicBits that throws if no public key is present. #### Defined in -packages/matter.js/src/crypto/Key.ts:174 +[packages/matter.js/src/crypto/Key.ts:174](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L174) ___ @@ -415,7 +415,7 @@ JsonWebKey.q #### Defined in -packages/matter.js/src/crypto/Key.ts:120 +[packages/matter.js/src/crypto/Key.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L120) ___ @@ -429,7 +429,7 @@ JsonWebKey.qi #### Defined in -packages/matter.js/src/crypto/Key.ts:121 +[packages/matter.js/src/crypto/Key.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L121) ___ @@ -441,7 +441,7 @@ Import (write-only) of private keys encoded in SEC1 format. #### Defined in -packages/matter.js/src/crypto/Key.ts:147 +[packages/matter.js/src/crypto/Key.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L147) ___ @@ -453,7 +453,7 @@ Import (write-only) of public keys encoded in SPKI format. #### Defined in -packages/matter.js/src/crypto/Key.ts:157 +[packages/matter.js/src/crypto/Key.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L157) ___ @@ -465,7 +465,7 @@ The key type, alias for JWK "kty" field. #### Defined in -packages/matter.js/src/crypto/Key.ts:89 +[packages/matter.js/src/crypto/Key.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L89) ___ @@ -479,7 +479,7 @@ JsonWebKey.use #### Defined in -packages/matter.js/src/crypto/Key.ts:122 +[packages/matter.js/src/crypto/Key.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L122) ___ @@ -493,7 +493,7 @@ JsonWebKey.x #### Defined in -packages/matter.js/src/crypto/Key.ts:123 +[packages/matter.js/src/crypto/Key.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L123) ___ @@ -506,7 +506,7 @@ x-point on EC public keys. #### Defined in -packages/matter.js/src/crypto/Key.ts:136 +[packages/matter.js/src/crypto/Key.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L136) ___ @@ -520,7 +520,7 @@ JsonWebKey.y #### Defined in -packages/matter.js/src/crypto/Key.ts:124 +[packages/matter.js/src/crypto/Key.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L124) ___ @@ -533,4 +533,4 @@ y-point on EC public keys. #### Defined in -packages/matter.js/src/crypto/Key.ts:142 +[packages/matter.js/src/crypto/Key.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L142) diff --git a/docs/matter.js/interfaces/crypto_export.PbkdfParameters.md b/docs/matter.js/interfaces/crypto_export.PbkdfParameters.md index ef3fd93087..b5fb88fe82 100644 --- a/docs/matter.js/interfaces/crypto_export.PbkdfParameters.md +++ b/docs/matter.js/interfaces/crypto_export.PbkdfParameters.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:20 +[packages/matter.js/src/crypto/Spake2p.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L20) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/crypto/Spake2p.ts:21 +[packages/matter.js/src/crypto/Spake2p.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Spake2p.ts#L21) diff --git a/docs/matter.js/interfaces/crypto_export.PrivateKey.md b/docs/matter.js/interfaces/crypto_export.PrivateKey.md index 05c7fa2d50..0788c44431 100644 --- a/docs/matter.js/interfaces/crypto_export.PrivateKey.md +++ b/docs/matter.js/interfaces/crypto_export.PrivateKey.md @@ -78,7 +78,7 @@ PublicKey.alg #### Defined in -packages/matter.js/src/crypto/Key.ts:107 +[packages/matter.js/src/crypto/Key.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L107) ___ @@ -94,7 +94,7 @@ PublicKey.algorithm #### Defined in -packages/matter.js/src/crypto/Key.ts:79 +[packages/matter.js/src/crypto/Key.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L79) ___ @@ -108,7 +108,7 @@ PublicKey.crv #### Defined in -packages/matter.js/src/crypto/Key.ts:108 +[packages/matter.js/src/crypto/Key.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L108) ___ @@ -122,7 +122,7 @@ PublicKey.curve #### Defined in -packages/matter.js/src/crypto/Key.ts:192 +[packages/matter.js/src/crypto/Key.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L192) ___ @@ -136,7 +136,7 @@ PublicKey.d #### Defined in -packages/matter.js/src/crypto/Key.ts:205 +[packages/matter.js/src/crypto/Key.ts:205](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L205) ___ @@ -150,7 +150,7 @@ PublicKey.dp #### Defined in -packages/matter.js/src/crypto/Key.ts:110 +[packages/matter.js/src/crypto/Key.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L110) ___ @@ -164,7 +164,7 @@ PublicKey.dq #### Defined in -packages/matter.js/src/crypto/Key.ts:111 +[packages/matter.js/src/crypto/Key.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L111) ___ @@ -178,7 +178,7 @@ PublicKey.e #### Defined in -packages/matter.js/src/crypto/Key.ts:112 +[packages/matter.js/src/crypto/Key.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L112) ___ @@ -192,7 +192,7 @@ PublicKey.ext #### Defined in -packages/matter.js/src/crypto/Key.ts:113 +[packages/matter.js/src/crypto/Key.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L113) ___ @@ -209,7 +209,7 @@ PublicKey.extractable #### Defined in -packages/matter.js/src/crypto/Key.ts:105 +[packages/matter.js/src/crypto/Key.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L105) ___ @@ -223,7 +223,7 @@ PublicKey.k #### Defined in -packages/matter.js/src/crypto/Key.ts:114 +[packages/matter.js/src/crypto/Key.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L114) ___ @@ -237,7 +237,7 @@ PublicKey.keyPair #### Defined in -packages/matter.js/src/crypto/Key.ts:208 +[packages/matter.js/src/crypto/Key.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L208) ___ @@ -251,7 +251,7 @@ PublicKey.keyPairBits #### Defined in -packages/matter.js/src/crypto/Key.ts:209 +[packages/matter.js/src/crypto/Key.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L209) ___ @@ -265,7 +265,7 @@ PublicKey.key\_ops #### Defined in -packages/matter.js/src/crypto/Key.ts:115 +[packages/matter.js/src/crypto/Key.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L115) ___ @@ -279,7 +279,7 @@ PublicKey.kty #### Defined in -packages/matter.js/src/crypto/Key.ts:116 +[packages/matter.js/src/crypto/Key.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L116) ___ @@ -293,7 +293,7 @@ PublicKey.n #### Defined in -packages/matter.js/src/crypto/Key.ts:117 +[packages/matter.js/src/crypto/Key.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L117) ___ @@ -309,7 +309,7 @@ PublicKey.operations #### Defined in -packages/matter.js/src/crypto/Key.ts:94 +[packages/matter.js/src/crypto/Key.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L94) ___ @@ -323,7 +323,7 @@ PublicKey.oth #### Defined in -packages/matter.js/src/crypto/Key.ts:118 +[packages/matter.js/src/crypto/Key.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L118) ___ @@ -337,7 +337,7 @@ PublicKey.p #### Defined in -packages/matter.js/src/crypto/Key.ts:119 +[packages/matter.js/src/crypto/Key.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L119) ___ @@ -353,7 +353,7 @@ PublicKey.pkcs8 #### Defined in -packages/matter.js/src/crypto/Key.ts:152 +[packages/matter.js/src/crypto/Key.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L152) ___ @@ -367,7 +367,7 @@ PublicKey.private #### Defined in -packages/matter.js/src/crypto/Key.ts:204 +[packages/matter.js/src/crypto/Key.ts:204](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L204) ___ @@ -381,7 +381,7 @@ PublicKey.privateBits #### Defined in -packages/matter.js/src/crypto/Key.ts:206 +[packages/matter.js/src/crypto/Key.ts:206](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L206) ___ @@ -395,7 +395,7 @@ PublicKey.privateKey #### Defined in -packages/matter.js/src/crypto/Key.ts:207 +[packages/matter.js/src/crypto/Key.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L207) ___ @@ -409,7 +409,7 @@ PublicKey.publicBits #### Defined in -packages/matter.js/src/crypto/Key.ts:197 +[packages/matter.js/src/crypto/Key.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L197) ___ @@ -425,7 +425,7 @@ PublicKey.publicKey #### Defined in -packages/matter.js/src/crypto/Key.ts:174 +[packages/matter.js/src/crypto/Key.ts:174](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L174) ___ @@ -439,7 +439,7 @@ PublicKey.q #### Defined in -packages/matter.js/src/crypto/Key.ts:120 +[packages/matter.js/src/crypto/Key.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L120) ___ @@ -453,7 +453,7 @@ PublicKey.qi #### Defined in -packages/matter.js/src/crypto/Key.ts:121 +[packages/matter.js/src/crypto/Key.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L121) ___ @@ -469,7 +469,7 @@ PublicKey.sec1 #### Defined in -packages/matter.js/src/crypto/Key.ts:147 +[packages/matter.js/src/crypto/Key.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L147) ___ @@ -485,7 +485,7 @@ PublicKey.spki #### Defined in -packages/matter.js/src/crypto/Key.ts:157 +[packages/matter.js/src/crypto/Key.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L157) ___ @@ -499,7 +499,7 @@ PublicKey.type #### Defined in -packages/matter.js/src/crypto/Key.ts:191 +[packages/matter.js/src/crypto/Key.ts:191](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L191) ___ @@ -513,7 +513,7 @@ PublicKey.use #### Defined in -packages/matter.js/src/crypto/Key.ts:122 +[packages/matter.js/src/crypto/Key.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L122) ___ @@ -527,7 +527,7 @@ PublicKey.x #### Defined in -packages/matter.js/src/crypto/Key.ts:193 +[packages/matter.js/src/crypto/Key.ts:193](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L193) ___ @@ -541,7 +541,7 @@ PublicKey.xBits #### Defined in -packages/matter.js/src/crypto/Key.ts:195 +[packages/matter.js/src/crypto/Key.ts:195](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L195) ___ @@ -555,7 +555,7 @@ PublicKey.y #### Defined in -packages/matter.js/src/crypto/Key.ts:194 +[packages/matter.js/src/crypto/Key.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L194) ___ @@ -569,4 +569,4 @@ PublicKey.yBits #### Defined in -packages/matter.js/src/crypto/Key.ts:196 +[packages/matter.js/src/crypto/Key.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L196) diff --git a/docs/matter.js/interfaces/crypto_export.PublicKey.md b/docs/matter.js/interfaces/crypto_export.PublicKey.md index 4df8171412..ca823deaf9 100644 --- a/docs/matter.js/interfaces/crypto_export.PublicKey.md +++ b/docs/matter.js/interfaces/crypto_export.PublicKey.md @@ -78,7 +78,7 @@ Key.alg #### Defined in -packages/matter.js/src/crypto/Key.ts:107 +[packages/matter.js/src/crypto/Key.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L107) ___ @@ -94,7 +94,7 @@ Key.algorithm #### Defined in -packages/matter.js/src/crypto/Key.ts:79 +[packages/matter.js/src/crypto/Key.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L79) ___ @@ -108,7 +108,7 @@ Key.crv #### Defined in -packages/matter.js/src/crypto/Key.ts:108 +[packages/matter.js/src/crypto/Key.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L108) ___ @@ -122,7 +122,7 @@ Key.curve #### Defined in -packages/matter.js/src/crypto/Key.ts:192 +[packages/matter.js/src/crypto/Key.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L192) ___ @@ -136,7 +136,7 @@ Key.d #### Defined in -packages/matter.js/src/crypto/Key.ts:109 +[packages/matter.js/src/crypto/Key.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L109) ___ @@ -150,7 +150,7 @@ Key.dp #### Defined in -packages/matter.js/src/crypto/Key.ts:110 +[packages/matter.js/src/crypto/Key.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L110) ___ @@ -164,7 +164,7 @@ Key.dq #### Defined in -packages/matter.js/src/crypto/Key.ts:111 +[packages/matter.js/src/crypto/Key.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L111) ___ @@ -178,7 +178,7 @@ Key.e #### Defined in -packages/matter.js/src/crypto/Key.ts:112 +[packages/matter.js/src/crypto/Key.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L112) ___ @@ -192,7 +192,7 @@ Key.ext #### Defined in -packages/matter.js/src/crypto/Key.ts:113 +[packages/matter.js/src/crypto/Key.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L113) ___ @@ -209,7 +209,7 @@ Key.extractable #### Defined in -packages/matter.js/src/crypto/Key.ts:105 +[packages/matter.js/src/crypto/Key.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L105) ___ @@ -223,7 +223,7 @@ Key.k #### Defined in -packages/matter.js/src/crypto/Key.ts:114 +[packages/matter.js/src/crypto/Key.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L114) ___ @@ -239,7 +239,7 @@ Key.keyPair #### Defined in -packages/matter.js/src/crypto/Key.ts:184 +[packages/matter.js/src/crypto/Key.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L184) ___ @@ -256,7 +256,7 @@ Key.keyPairBits #### Defined in -packages/matter.js/src/crypto/Key.ts:169 +[packages/matter.js/src/crypto/Key.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L169) ___ @@ -270,7 +270,7 @@ Key.key\_ops #### Defined in -packages/matter.js/src/crypto/Key.ts:115 +[packages/matter.js/src/crypto/Key.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L115) ___ @@ -284,7 +284,7 @@ Key.kty #### Defined in -packages/matter.js/src/crypto/Key.ts:116 +[packages/matter.js/src/crypto/Key.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L116) ___ @@ -298,7 +298,7 @@ Key.n #### Defined in -packages/matter.js/src/crypto/Key.ts:117 +[packages/matter.js/src/crypto/Key.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L117) ___ @@ -314,7 +314,7 @@ Key.operations #### Defined in -packages/matter.js/src/crypto/Key.ts:94 +[packages/matter.js/src/crypto/Key.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L94) ___ @@ -328,7 +328,7 @@ Key.oth #### Defined in -packages/matter.js/src/crypto/Key.ts:118 +[packages/matter.js/src/crypto/Key.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L118) ___ @@ -342,7 +342,7 @@ Key.p #### Defined in -packages/matter.js/src/crypto/Key.ts:119 +[packages/matter.js/src/crypto/Key.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L119) ___ @@ -358,7 +358,7 @@ Key.pkcs8 #### Defined in -packages/matter.js/src/crypto/Key.ts:152 +[packages/matter.js/src/crypto/Key.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L152) ___ @@ -374,7 +374,7 @@ Key.private #### Defined in -packages/matter.js/src/crypto/Key.ts:99 +[packages/matter.js/src/crypto/Key.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L99) ___ @@ -391,7 +391,7 @@ Key.privateBits #### Defined in -packages/matter.js/src/crypto/Key.ts:130 +[packages/matter.js/src/crypto/Key.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L130) ___ @@ -407,7 +407,7 @@ Key.privateKey #### Defined in -packages/matter.js/src/crypto/Key.ts:179 +[packages/matter.js/src/crypto/Key.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L179) ___ @@ -421,7 +421,7 @@ Key.publicBits #### Defined in -packages/matter.js/src/crypto/Key.ts:197 +[packages/matter.js/src/crypto/Key.ts:197](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L197) ___ @@ -437,7 +437,7 @@ Key.publicKey #### Defined in -packages/matter.js/src/crypto/Key.ts:174 +[packages/matter.js/src/crypto/Key.ts:174](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L174) ___ @@ -451,7 +451,7 @@ Key.q #### Defined in -packages/matter.js/src/crypto/Key.ts:120 +[packages/matter.js/src/crypto/Key.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L120) ___ @@ -465,7 +465,7 @@ Key.qi #### Defined in -packages/matter.js/src/crypto/Key.ts:121 +[packages/matter.js/src/crypto/Key.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L121) ___ @@ -481,7 +481,7 @@ Key.sec1 #### Defined in -packages/matter.js/src/crypto/Key.ts:147 +[packages/matter.js/src/crypto/Key.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L147) ___ @@ -497,7 +497,7 @@ Key.spki #### Defined in -packages/matter.js/src/crypto/Key.ts:157 +[packages/matter.js/src/crypto/Key.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L157) ___ @@ -511,7 +511,7 @@ Key.type #### Defined in -packages/matter.js/src/crypto/Key.ts:191 +[packages/matter.js/src/crypto/Key.ts:191](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L191) ___ @@ -525,7 +525,7 @@ Key.use #### Defined in -packages/matter.js/src/crypto/Key.ts:122 +[packages/matter.js/src/crypto/Key.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L122) ___ @@ -539,7 +539,7 @@ Key.x #### Defined in -packages/matter.js/src/crypto/Key.ts:193 +[packages/matter.js/src/crypto/Key.ts:193](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L193) ___ @@ -553,7 +553,7 @@ Key.xBits #### Defined in -packages/matter.js/src/crypto/Key.ts:195 +[packages/matter.js/src/crypto/Key.ts:195](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L195) ___ @@ -567,7 +567,7 @@ Key.y #### Defined in -packages/matter.js/src/crypto/Key.ts:194 +[packages/matter.js/src/crypto/Key.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L194) ___ @@ -581,4 +581,4 @@ Key.yBits #### Defined in -packages/matter.js/src/crypto/Key.ts:196 +[packages/matter.js/src/crypto/Key.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L196) diff --git a/docs/matter.js/interfaces/crypto_export.SymmetricKey.md b/docs/matter.js/interfaces/crypto_export.SymmetricKey.md index 4cb6bb3cd1..c2e3c58337 100644 --- a/docs/matter.js/interfaces/crypto_export.SymmetricKey.md +++ b/docs/matter.js/interfaces/crypto_export.SymmetricKey.md @@ -78,7 +78,7 @@ Key.alg #### Defined in -packages/matter.js/src/crypto/Key.ts:107 +[packages/matter.js/src/crypto/Key.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L107) ___ @@ -94,7 +94,7 @@ Key.algorithm #### Defined in -packages/matter.js/src/crypto/Key.ts:79 +[packages/matter.js/src/crypto/Key.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L79) ___ @@ -108,7 +108,7 @@ Key.crv #### Defined in -packages/matter.js/src/crypto/Key.ts:108 +[packages/matter.js/src/crypto/Key.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L108) ___ @@ -124,7 +124,7 @@ Key.curve #### Defined in -packages/matter.js/src/crypto/Key.ts:84 +[packages/matter.js/src/crypto/Key.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L84) ___ @@ -138,7 +138,7 @@ Key.d #### Defined in -packages/matter.js/src/crypto/Key.ts:218 +[packages/matter.js/src/crypto/Key.ts:218](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L218) ___ @@ -152,7 +152,7 @@ Key.dp #### Defined in -packages/matter.js/src/crypto/Key.ts:110 +[packages/matter.js/src/crypto/Key.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L110) ___ @@ -166,7 +166,7 @@ Key.dq #### Defined in -packages/matter.js/src/crypto/Key.ts:111 +[packages/matter.js/src/crypto/Key.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L111) ___ @@ -180,7 +180,7 @@ Key.e #### Defined in -packages/matter.js/src/crypto/Key.ts:112 +[packages/matter.js/src/crypto/Key.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L112) ___ @@ -194,7 +194,7 @@ Key.ext #### Defined in -packages/matter.js/src/crypto/Key.ts:113 +[packages/matter.js/src/crypto/Key.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L113) ___ @@ -211,7 +211,7 @@ Key.extractable #### Defined in -packages/matter.js/src/crypto/Key.ts:105 +[packages/matter.js/src/crypto/Key.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L105) ___ @@ -225,7 +225,7 @@ Key.k #### Defined in -packages/matter.js/src/crypto/Key.ts:114 +[packages/matter.js/src/crypto/Key.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L114) ___ @@ -241,7 +241,7 @@ Key.keyPair #### Defined in -packages/matter.js/src/crypto/Key.ts:184 +[packages/matter.js/src/crypto/Key.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L184) ___ @@ -258,7 +258,7 @@ Key.keyPairBits #### Defined in -packages/matter.js/src/crypto/Key.ts:169 +[packages/matter.js/src/crypto/Key.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L169) ___ @@ -272,7 +272,7 @@ Key.key\_ops #### Defined in -packages/matter.js/src/crypto/Key.ts:115 +[packages/matter.js/src/crypto/Key.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L115) ___ @@ -286,7 +286,7 @@ Key.kty #### Defined in -packages/matter.js/src/crypto/Key.ts:116 +[packages/matter.js/src/crypto/Key.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L116) ___ @@ -300,7 +300,7 @@ Key.n #### Defined in -packages/matter.js/src/crypto/Key.ts:117 +[packages/matter.js/src/crypto/Key.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L117) ___ @@ -316,7 +316,7 @@ Key.operations #### Defined in -packages/matter.js/src/crypto/Key.ts:94 +[packages/matter.js/src/crypto/Key.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L94) ___ @@ -330,7 +330,7 @@ Key.oth #### Defined in -packages/matter.js/src/crypto/Key.ts:118 +[packages/matter.js/src/crypto/Key.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L118) ___ @@ -344,7 +344,7 @@ Key.p #### Defined in -packages/matter.js/src/crypto/Key.ts:119 +[packages/matter.js/src/crypto/Key.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L119) ___ @@ -360,7 +360,7 @@ Key.pkcs8 #### Defined in -packages/matter.js/src/crypto/Key.ts:152 +[packages/matter.js/src/crypto/Key.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L152) ___ @@ -374,7 +374,7 @@ Key.private #### Defined in -packages/matter.js/src/crypto/Key.ts:217 +[packages/matter.js/src/crypto/Key.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L217) ___ @@ -391,7 +391,7 @@ Key.privateBits #### Defined in -packages/matter.js/src/crypto/Key.ts:130 +[packages/matter.js/src/crypto/Key.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L130) ___ @@ -407,7 +407,7 @@ Key.privateKey #### Defined in -packages/matter.js/src/crypto/Key.ts:179 +[packages/matter.js/src/crypto/Key.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L179) ___ @@ -424,7 +424,7 @@ Key.publicBits #### Defined in -packages/matter.js/src/crypto/Key.ts:163 +[packages/matter.js/src/crypto/Key.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L163) ___ @@ -440,7 +440,7 @@ Key.publicKey #### Defined in -packages/matter.js/src/crypto/Key.ts:174 +[packages/matter.js/src/crypto/Key.ts:174](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L174) ___ @@ -454,7 +454,7 @@ Key.q #### Defined in -packages/matter.js/src/crypto/Key.ts:120 +[packages/matter.js/src/crypto/Key.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L120) ___ @@ -468,7 +468,7 @@ Key.qi #### Defined in -packages/matter.js/src/crypto/Key.ts:121 +[packages/matter.js/src/crypto/Key.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L121) ___ @@ -484,7 +484,7 @@ Key.sec1 #### Defined in -packages/matter.js/src/crypto/Key.ts:147 +[packages/matter.js/src/crypto/Key.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L147) ___ @@ -500,7 +500,7 @@ Key.spki #### Defined in -packages/matter.js/src/crypto/Key.ts:157 +[packages/matter.js/src/crypto/Key.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L157) ___ @@ -514,7 +514,7 @@ Key.type #### Defined in -packages/matter.js/src/crypto/Key.ts:216 +[packages/matter.js/src/crypto/Key.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L216) ___ @@ -528,7 +528,7 @@ Key.use #### Defined in -packages/matter.js/src/crypto/Key.ts:122 +[packages/matter.js/src/crypto/Key.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L122) ___ @@ -542,7 +542,7 @@ Key.x #### Defined in -packages/matter.js/src/crypto/Key.ts:123 +[packages/matter.js/src/crypto/Key.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L123) ___ @@ -559,7 +559,7 @@ Key.xBits #### Defined in -packages/matter.js/src/crypto/Key.ts:136 +[packages/matter.js/src/crypto/Key.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L136) ___ @@ -573,7 +573,7 @@ Key.y #### Defined in -packages/matter.js/src/crypto/Key.ts:124 +[packages/matter.js/src/crypto/Key.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L124) ___ @@ -590,4 +590,4 @@ Key.yBits #### Defined in -packages/matter.js/src/crypto/Key.ts:142 +[packages/matter.js/src/crypto/Key.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L142) diff --git a/docs/matter.js/interfaces/device_export.DeviceTypeDefinition.md b/docs/matter.js/interfaces/device_export.DeviceTypeDefinition.md index 3df4b25e67..62c4f76398 100644 --- a/docs/matter.js/interfaces/device_export.DeviceTypeDefinition.md +++ b/docs/matter.js/interfaces/device_export.DeviceTypeDefinition.md @@ -27,7 +27,7 @@ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:67 +[packages/matter.js/src/device/DeviceTypes.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L67) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:68 +[packages/matter.js/src/device/DeviceTypes.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L68) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:66 +[packages/matter.js/src/device/DeviceTypes.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L66) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:74 +[packages/matter.js/src/device/DeviceTypes.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L74) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:72 +[packages/matter.js/src/device/DeviceTypes.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L72) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:73 +[packages/matter.js/src/device/DeviceTypes.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L73) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:71 +[packages/matter.js/src/device/DeviceTypes.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L71) ___ @@ -97,7 +97,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:70 +[packages/matter.js/src/device/DeviceTypes.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L70) ___ @@ -107,7 +107,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:69 +[packages/matter.js/src/device/DeviceTypes.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L69) ___ @@ -117,4 +117,4 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:75 +[packages/matter.js/src/device/DeviceTypes.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L75) diff --git a/docs/matter.js/interfaces/device_export.EndpointOptions.md b/docs/matter.js/interfaces/device_export.EndpointOptions.md index 512ecfd9b6..492620bfd5 100644 --- a/docs/matter.js/interfaces/device_export.EndpointOptions.md +++ b/docs/matter.js/interfaces/device_export.EndpointOptions.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/device/Endpoint.ts:29 +[packages/matter.js/src/device/Endpoint.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L29) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/device/Endpoint.ts:30 +[packages/matter.js/src/device/Endpoint.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Endpoint.ts#L30) diff --git a/docs/matter.js/interfaces/export.CommissioningControllerOptions.md b/docs/matter.js/interfaces/export.CommissioningControllerOptions.md deleted file mode 100644 index a491da66af..0000000000 --- a/docs/matter.js/interfaces/export.CommissioningControllerOptions.md +++ /dev/null @@ -1,144 +0,0 @@ -[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [export](../modules/export.md) / CommissioningControllerOptions - -# Interface: CommissioningControllerOptions - -[export](../modules/export.md).CommissioningControllerOptions - -Constructor options for the CommissioningController class - -## Table of contents - -### Properties - -- [commissioningOptions](export.CommissioningControllerOptions.md#commissioningoptions) -- [delayedPairing](export.CommissioningControllerOptions.md#delayedpairing) -- [listeningAddressIpv4](export.CommissioningControllerOptions.md#listeningaddressipv4) -- [listeningAddressIpv6](export.CommissioningControllerOptions.md#listeningaddressipv6) -- [localPort](export.CommissioningControllerOptions.md#localport) -- [longDiscriminator](export.CommissioningControllerOptions.md#longdiscriminator) -- [passcode](export.CommissioningControllerOptions.md#passcode) -- [serverAddress](export.CommissioningControllerOptions.md#serveraddress) -- [shortDiscriminator](export.CommissioningControllerOptions.md#shortdiscriminator) -- [subscribeAllAttributes](export.CommissioningControllerOptions.md#subscribeallattributes) -- [subscribeMaxIntervalCeilingSeconds](export.CommissioningControllerOptions.md#subscribemaxintervalceilingseconds) -- [subscribeMinIntervalFloorSeconds](export.CommissioningControllerOptions.md#subscribeminintervalfloorseconds) - -## Properties - -### commissioningOptions - -• `Optional` **commissioningOptions**: [`CommissioningOptions`](../modules/protocol_export.md#commissioningoptions) - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:75 - -___ - -### delayedPairing - -• `Optional` `Readonly` **delayedPairing**: `boolean` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:66 - -___ - -### listeningAddressIpv4 - -• `Optional` `Readonly` **listeningAddressIpv4**: `string` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:63 - -___ - -### listeningAddressIpv6 - -• `Optional` `Readonly` **listeningAddressIpv6**: `string` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:64 - -___ - -### localPort - -• `Optional` `Readonly` **localPort**: `number` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:62 - -___ - -### longDiscriminator - -• `Optional` **longDiscriminator**: `number` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:72 - -___ - -### passcode - -• **passcode**: `number` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:71 - -___ - -### serverAddress - -• `Optional` **serverAddress**: [`ServerAddressIp`](../modules/common_export.md#serveraddressip) - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:61 - -___ - -### shortDiscriminator - -• `Optional` **shortDiscriminator**: `number` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:73 - -___ - -### subscribeAllAttributes - -• `Optional` `Readonly` **subscribeAllAttributes**: `boolean` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:67 - -___ - -### subscribeMaxIntervalCeilingSeconds - -• `Optional` `Readonly` **subscribeMaxIntervalCeilingSeconds**: `number` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:69 - -___ - -### subscribeMinIntervalFloorSeconds - -• `Optional` `Readonly` **subscribeMinIntervalFloorSeconds**: `number` - -#### Defined in - -packages/matter.js/src/CommissioningController.ts:68 diff --git a/docs/matter.js/interfaces/export.CommissioningServerOptions.md b/docs/matter.js/interfaces/export.CommissioningServerOptions.md index 0b6cff9aa4..c4819a72df 100644 --- a/docs/matter.js/interfaces/export.CommissioningServerOptions.md +++ b/docs/matter.js/interfaces/export.CommissioningServerOptions.md @@ -12,9 +12,11 @@ and allows to override the certificates used for the OperationalCredentials clus ### Properties +- [activeSessionsChangedCallback](export.CommissioningServerOptions.md#activesessionschangedcallback) - [additionalBleAdvertisementData](export.CommissioningServerOptions.md#additionalbleadvertisementdata) - [basicInformation](export.CommissioningServerOptions.md#basicinformation) - [certificates](export.CommissioningServerOptions.md#certificates) +- [commissioningChangedCallback](export.CommissioningServerOptions.md#commissioningchangedcallback) - [delayedAnnouncement](export.CommissioningServerOptions.md#delayedannouncement) - [deviceName](export.CommissioningServerOptions.md#devicename) - [deviceType](export.CommissioningServerOptions.md#devicetype) @@ -32,6 +34,34 @@ and allows to override the certificates used for the OperationalCredentials clus ## Properties +### activeSessionsChangedCallback + +• `Optional` **activeSessionsChangedCallback**: (`fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex)) => `void` + +#### Type declaration + +▸ (`fabricIndex`): `void` + +This callback is called when sessions to the device are established, closed or subscriptions get added or +removed. The provided fabricIndex can be used together with getActiveSessionInformation() to get more details +about the open sessions and their status. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `fabricIndex` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | + +##### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/CommissioningServer.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L194) + +___ + ### additionalBleAdvertisementData • `Optional` **additionalBleAdvertisementData**: `Uint8Array` @@ -40,20 +70,20 @@ Optional Vendor specific additional BLE Advertisement data. #### Defined in -packages/matter.js/src/CommissioningServer.ts:129 +[packages/matter.js/src/CommissioningServer.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L129) ___ ### basicInformation -• **basicInformation**: { `productId`: `number` ; `productName`: `string` ; `vendorId`: `number` ; `vendorName`: `string` } \| [`AttributeInitialValues`](../modules/cluster_export.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `capabilityMinima`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](tlv_export.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](tlv_export.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](../modules/cluster_export.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](../modules/cluster_export.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](../modules/cluster_export.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](../modules/cluster_export.md#optionalattribute)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](../modules/cluster_export.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<[`VendorId`](../modules/datatype_export.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/cluster_export.md#globalattributes-1)<{}\>\>\> +• **basicInformation**: { `productId`: `number` ; `productName`: `string` ; `vendorId`: `number` ; `vendorName`: `string` } \| [`AttributeInitialValues`](../modules/cluster_export.md#attributeinitialvalues)<[`Merge`](../modules/util_export.md#merge)<{ `capabilityMinima`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](tlv_export.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](tlv_export.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](../modules/cluster_export.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](../modules/cluster_export.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](../modules/cluster_export.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<[`TypeFromFields`](../modules/tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](../modules/cluster_export.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](../modules/cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<[`VendorId`](../modules/datatype_export.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](../modules/cluster_export.md#fixedattribute)<`string`, `any`\> }, [`GlobalAttributes`](../modules/cluster_export.md#globalattributes-1)<{}\>\>\> Device details to be used for the BasicInformation cluster. Some of the values are initialized with defaults if not set here. #### Defined in -packages/matter.js/src/CommissioningServer.ts:158 +[packages/matter.js/src/CommissioningServer.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L158) ___ @@ -66,7 +96,35 @@ Vendor specific certificates to be used for the OperationalCredentials cluster. #### Defined in -packages/matter.js/src/CommissioningServer.ts:171 +[packages/matter.js/src/CommissioningServer.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L171) + +___ + +### commissioningChangedCallback + +• `Optional` **commissioningChangedCallback**: (`fabricIndex`: [`FabricIndex`](../modules/datatype_export.md#fabricindex)) => `void` + +#### Type declaration + +▸ (`fabricIndex`): `void` + +This callback is called when the device is commissioned or decommissioned to a fabric/controller. The provided +fabricIndex can be used together with getCommissionedFabricInformation() to get more details about the fabric +(or if this fabricIndex is missing it was deleted). + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `fabricIndex` | [`FabricIndex`](../modules/datatype_export.md#fabricindex) | + +##### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/CommissioningServer.ts:187](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L187) ___ @@ -78,7 +136,7 @@ Should the device directly be announced automatically by the MatterServer of man #### Defined in -packages/matter.js/src/CommissioningServer.ts:132 +[packages/matter.js/src/CommissioningServer.ts:132](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L132) ___ @@ -90,7 +148,7 @@ The device name to be used for the BasicInformation cluster. #### Defined in -packages/matter.js/src/CommissioningServer.ts:111 +[packages/matter.js/src/CommissioningServer.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L111) ___ @@ -102,19 +160,19 @@ The device type to be used for the BasicInformation cluster. #### Defined in -packages/matter.js/src/CommissioningServer.ts:114 +[packages/matter.js/src/CommissioningServer.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L114) ___ ### discriminator -• **discriminator**: `number` +• `Optional` **discriminator**: `number` The Discriminator to use for initial commissioning. #### Defined in -packages/matter.js/src/CommissioningServer.ts:123 +[packages/matter.js/src/CommissioningServer.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L123) ___ @@ -126,7 +184,7 @@ The Flow type of the Commissioning flow used in announcements. #### Defined in -packages/matter.js/src/CommissioningServer.ts:126 +[packages/matter.js/src/CommissioningServer.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L126) ___ @@ -139,7 +197,7 @@ Use these options to limit the allowed countries for regulatory configuration. #### Defined in -packages/matter.js/src/CommissioningServer.ts:177 +[packages/matter.js/src/CommissioningServer.ts:177](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L177) ___ @@ -151,7 +209,7 @@ IPv4 listener address, defaults to all interfaces. #### Defined in -packages/matter.js/src/CommissioningServer.ts:105 +[packages/matter.js/src/CommissioningServer.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L105) ___ @@ -163,7 +221,7 @@ IPv6 listener address, defaults to all interfaces. #### Defined in -packages/matter.js/src/CommissioningServer.ts:108 +[packages/matter.js/src/CommissioningServer.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L108) ___ @@ -175,31 +233,31 @@ The next endpoint ID to be assigned to a new endpoint. #### Defined in -packages/matter.js/src/CommissioningServer.ts:117 +[packages/matter.js/src/CommissioningServer.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L117) ___ ### passcode -• **passcode**: `number` +• `Optional` **passcode**: `number` The passcode/pin of the device to use for initial commissioning. #### Defined in -packages/matter.js/src/CommissioningServer.ts:120 +[packages/matter.js/src/CommissioningServer.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L120) ___ ### port -• **port**: `number` +• `Optional` **port**: `number` Port of the server, normally automatically managed. #### Defined in -packages/matter.js/src/CommissioningServer.ts:102 +[packages/matter.js/src/CommissioningServer.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L102) ___ @@ -212,7 +270,7 @@ and inside the range requested by the connected controller. #### Defined in -packages/matter.js/src/CommissioningServer.ts:138 +[packages/matter.js/src/CommissioningServer.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L138) ___ @@ -226,7 +284,7 @@ limits. #### Defined in -packages/matter.js/src/CommissioningServer.ts:145 +[packages/matter.js/src/CommissioningServer.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L145) ___ @@ -240,4 +298,4 @@ powered on in parallel not all send at the same timepoint. #### Defined in -packages/matter.js/src/CommissioningServer.ts:152 +[packages/matter.js/src/CommissioningServer.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L152) diff --git a/docs/matter.js/interfaces/export.DevicePairingInformation.md b/docs/matter.js/interfaces/export.DevicePairingInformation.md index 3c428d6b98..3ac70cb032 100644 --- a/docs/matter.js/interfaces/export.DevicePairingInformation.md +++ b/docs/matter.js/interfaces/export.DevicePairingInformation.md @@ -11,7 +11,6 @@ Represents device pairing information. ### Properties - [manualPairingCode](export.DevicePairingInformation.md#manualpairingcode) -- [qrCode](export.DevicePairingInformation.md#qrcode) - [qrPairingCode](export.DevicePairingInformation.md#qrpairingcode) ## Properties @@ -22,17 +21,7 @@ Represents device pairing information. #### Defined in -packages/matter.js/src/CommissioningServer.ts:90 - -___ - -### qrCode - -• **qrCode**: `string` - -#### Defined in - -packages/matter.js/src/CommissioningServer.ts:92 +[packages/matter.js/src/CommissioningServer.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L91) ___ @@ -42,4 +31,4 @@ ___ #### Defined in -packages/matter.js/src/CommissioningServer.ts:91 +[packages/matter.js/src/CommissioningServer.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L92) diff --git a/docs/matter.js/interfaces/export._internal_.AttributeOptions.md b/docs/matter.js/interfaces/export._internal_.AttributeOptions.md index 18ae839bdf..5ff730efa0 100644 --- a/docs/matter.js/interfaces/export._internal_.AttributeOptions.md +++ b/docs/matter.js/interfaces/export._internal_.AttributeOptions.md @@ -36,7 +36,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:115 +[packages/matter.js/src/cluster/Cluster.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L115) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:113 +[packages/matter.js/src/cluster/Cluster.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L113) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:112 +[packages/matter.js/src/cluster/Cluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L112) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:116 +[packages/matter.js/src/cluster/Cluster.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L116) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:111 +[packages/matter.js/src/cluster/Cluster.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L111) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:114 +[packages/matter.js/src/cluster/Cluster.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L114) ___ @@ -96,4 +96,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:117 +[packages/matter.js/src/cluster/Cluster.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L117) diff --git a/docs/matter.js/interfaces/export._internal_.AttributePathWithValueVersion.md b/docs/matter.js/interfaces/export._internal_.AttributePathWithValueVersion.md index fee801a45e..1deab4117d 100644 --- a/docs/matter.js/interfaces/export._internal_.AttributePathWithValueVersion.md +++ b/docs/matter.js/interfaces/export._internal_.AttributePathWithValueVersion.md @@ -27,7 +27,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:54 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L54) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:55 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L55) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:56 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L56) ___ @@ -57,4 +57,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:57 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L57) diff --git a/docs/matter.js/interfaces/export._internal_.CachedAttributeInfo.md b/docs/matter.js/interfaces/export._internal_.CachedAttributeInfo.md index e7ac0bf4cf..3f83621753 100644 --- a/docs/matter.js/interfaces/export._internal_.CachedAttributeInfo.md +++ b/docs/matter.js/interfaces/export._internal_.CachedAttributeInfo.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:98 +[packages/matter.js/src/cluster/ClusterHelper.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L98) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:99 +[packages/matter.js/src/cluster/ClusterHelper.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L99) diff --git a/docs/matter.js/interfaces/export._internal_.CachedCommandInfo.md b/docs/matter.js/interfaces/export._internal_.CachedCommandInfo.md index d892ad096a..adaf9317d8 100644 --- a/docs/matter.js/interfaces/export._internal_.CachedCommandInfo.md +++ b/docs/matter.js/interfaces/export._internal_.CachedCommandInfo.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:106 +[packages/matter.js/src/cluster/ClusterHelper.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L106) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:107 +[packages/matter.js/src/cluster/ClusterHelper.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L107) diff --git a/docs/matter.js/interfaces/export._internal_.CachedEventInfo.md b/docs/matter.js/interfaces/export._internal_.CachedEventInfo.md index 3819197013..a406be82fa 100644 --- a/docs/matter.js/interfaces/export._internal_.CachedEventInfo.md +++ b/docs/matter.js/interfaces/export._internal_.CachedEventInfo.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:102 +[packages/matter.js/src/cluster/ClusterHelper.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L102) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:103 +[packages/matter.js/src/cluster/ClusterHelper.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L103) diff --git a/docs/matter.js/interfaces/export._internal_.CommandOptions.md b/docs/matter.js/interfaces/export._internal_.CommandOptions.md index 15033a6e99..b4d2f9c1cd 100644 --- a/docs/matter.js/interfaces/export._internal_.CommandOptions.md +++ b/docs/matter.js/interfaces/export._internal_.CommandOptions.md @@ -25,7 +25,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:632 +[packages/matter.js/src/cluster/Cluster.ts:632](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L632) ___ @@ -35,4 +35,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:633 +[packages/matter.js/src/cluster/Cluster.ts:633](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L633) diff --git a/docs/matter.js/interfaces/export._internal_.ConditionalAttributeOptions.md b/docs/matter.js/interfaces/export._internal_.ConditionalAttributeOptions.md index 21bf295697..ed176d8ac9 100644 --- a/docs/matter.js/interfaces/export._internal_.ConditionalAttributeOptions.md +++ b/docs/matter.js/interfaces/export._internal_.ConditionalAttributeOptions.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:115 +[packages/matter.js/src/cluster/Cluster.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L115) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:122 +[packages/matter.js/src/cluster/Cluster.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L122) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:113 +[packages/matter.js/src/cluster/Cluster.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L113) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:121 +[packages/matter.js/src/cluster/Cluster.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L121) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:112 +[packages/matter.js/src/cluster/Cluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L112) ___ @@ -105,7 +105,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:116 +[packages/matter.js/src/cluster/Cluster.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L116) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:111 +[packages/matter.js/src/cluster/Cluster.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L111) ___ @@ -133,7 +133,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:114 +[packages/matter.js/src/cluster/Cluster.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L114) ___ @@ -147,4 +147,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:117 +[packages/matter.js/src/cluster/Cluster.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L117) diff --git a/docs/matter.js/interfaces/export._internal_.ConditionalCommandOptions.md b/docs/matter.js/interfaces/export._internal_.ConditionalCommandOptions.md index f7bea4d7fa..860e8cd6e0 100644 --- a/docs/matter.js/interfaces/export._internal_.ConditionalCommandOptions.md +++ b/docs/matter.js/interfaces/export._internal_.ConditionalCommandOptions.md @@ -37,7 +37,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:632 +[packages/matter.js/src/cluster/Cluster.ts:632](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L632) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:638 +[packages/matter.js/src/cluster/Cluster.ts:638](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L638) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:637 +[packages/matter.js/src/cluster/Cluster.ts:637](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L637) ___ @@ -71,4 +71,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:633 +[packages/matter.js/src/cluster/Cluster.ts:633](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L633) diff --git a/docs/matter.js/interfaces/export._internal_.ConditionalEventOptions.md b/docs/matter.js/interfaces/export._internal_.ConditionalEventOptions.md index da80165e8c..328f14fac7 100644 --- a/docs/matter.js/interfaces/export._internal_.ConditionalEventOptions.md +++ b/docs/matter.js/interfaces/export._internal_.ConditionalEventOptions.md @@ -32,7 +32,7 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:735 +[packages/matter.js/src/cluster/Cluster.ts:735](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L735) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:734 +[packages/matter.js/src/cluster/Cluster.ts:734](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L734) ___ @@ -56,4 +56,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:730 +[packages/matter.js/src/cluster/Cluster.ts:730](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L730) diff --git a/docs/matter.js/interfaces/export._internal_.EventData.md b/docs/matter.js/interfaces/export._internal_.EventData.md index 2a1a2d28c9..6e1a49cb99 100644 --- a/docs/matter.js/interfaces/export._internal_.EventData.md +++ b/docs/matter.js/interfaces/export._internal_.EventData.md @@ -37,7 +37,7 @@ Data of one Event #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:26 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L26) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:30 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L30) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:25 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L25) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:28 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L28) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:27 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L27) ___ @@ -87,4 +87,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:29 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L29) diff --git a/docs/matter.js/interfaces/export._internal_.EventOptions.md b/docs/matter.js/interfaces/export._internal_.EventOptions.md index 7bf526fe82..348d96b07a 100644 --- a/docs/matter.js/interfaces/export._internal_.EventOptions.md +++ b/docs/matter.js/interfaces/export._internal_.EventOptions.md @@ -24,4 +24,4 @@ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:730 +[packages/matter.js/src/cluster/Cluster.ts:730](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L730) diff --git a/docs/matter.js/interfaces/export._internal_.EventPathWithEventData.md b/docs/matter.js/interfaces/export._internal_.EventPathWithEventData.md index c584a46108..853ecf7960 100644 --- a/docs/matter.js/interfaces/export._internal_.EventPathWithEventData.md +++ b/docs/matter.js/interfaces/export._internal_.EventPathWithEventData.md @@ -26,7 +26,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:63 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L63) ___ @@ -36,7 +36,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:61 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L61) ___ @@ -46,4 +46,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:62 +[packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/SubscriptionHandler.ts#L62) diff --git a/docs/matter.js/interfaces/export._internal_.EventStorageData.md b/docs/matter.js/interfaces/export._internal_.EventStorageData.md index 478eb5bec8..51dc14d7f0 100644 --- a/docs/matter.js/interfaces/export._internal_.EventStorageData.md +++ b/docs/matter.js/interfaces/export._internal_.EventStorageData.md @@ -42,7 +42,7 @@ Data of an event which was triggered and stored internally #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:26 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L26) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:30 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L30) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:25 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L25) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:28 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L28) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:27 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L27) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:37 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L37) ___ @@ -122,4 +122,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventHandler.ts:29 +[packages/matter.js/src/protocol/interaction/EventHandler.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventHandler.ts#L29) diff --git a/docs/matter.js/interfaces/export._internal_.MrpParameters.md b/docs/matter.js/interfaces/export._internal_.MrpParameters.md index b82fb5d800..5170325076 100644 --- a/docs/matter.js/interfaces/export._internal_.MrpParameters.md +++ b/docs/matter.js/interfaces/export._internal_.MrpParameters.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/session/Session.ts:26 +[packages/matter.js/src/session/Session.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L26) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:25 +[packages/matter.js/src/session/Session.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L25) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:27 +[packages/matter.js/src/session/Session.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L27) diff --git a/docs/matter.js/interfaces/export._internal_.RecordValidationResult.md b/docs/matter.js/interfaces/export._internal_.RecordValidationResult.md new file mode 100644 index 0000000000..722737f460 --- /dev/null +++ b/docs/matter.js/interfaces/export._internal_.RecordValidationResult.md @@ -0,0 +1,34 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [export](../modules/export.md) / [](../modules/export._internal_.md) / RecordValidationResult + +# Interface: RecordValidationResult + +[export](../modules/export.md).[](../modules/export._internal_.md).RecordValidationResult + +The result of validation. + +## Table of contents + +### Properties + +- [errors](export._internal_.RecordValidationResult.md#errors) +- [valid](export._internal_.RecordValidationResult.md#valid) + +## Properties + +### errors + +• `Optional` **errors**: [`DefinitionError`](../modules/model.md#definitionerror)[] + +#### Defined in + +[packages/matter.js/src/model/logic/record-validation/RecordValidatorInterface.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/record-validation/RecordValidatorInterface.ts#L14) + +___ + +### valid + +• **valid**: `boolean` + +#### Defined in + +[packages/matter.js/src/model/logic/record-validation/RecordValidatorInterface.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/record-validation/RecordValidatorInterface.ts#L13) diff --git a/docs/matter.js/interfaces/export._internal_.RecordValidator.md b/docs/matter.js/interfaces/export._internal_.RecordValidator.md new file mode 100644 index 0000000000..c0f54b4c80 --- /dev/null +++ b/docs/matter.js/interfaces/export._internal_.RecordValidator.md @@ -0,0 +1,48 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [export](../modules/export.md) / [](../modules/export._internal_.md) / RecordValidator + +# Interface: RecordValidator + +[export](../modules/export.md).[](../modules/export._internal_.md).RecordValidator + +Record validation API. + +## Table of contents + +### Methods + +- [logFailure](export._internal_.RecordValidator.md#logfailure) +- [validate](export._internal_.RecordValidator.md#validate) + +## Methods + +### logFailure + +▸ **logFailure**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/logic/record-validation/RecordValidatorInterface.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/record-validation/RecordValidatorInterface.ts#L22) + +___ + +### validate + +▸ **validate**(`record`): [`RecordValidationResult`](export._internal_.RecordValidationResult.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `record` | `Object` | + +#### Returns + +[`RecordValidationResult`](export._internal_.RecordValidationResult.md) + +#### Defined in + +[packages/matter.js/src/model/logic/record-validation/RecordValidatorInterface.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/record-validation/RecordValidatorInterface.ts#L21) diff --git a/docs/matter.js/interfaces/export._internal_.scenesTableEntry.md b/docs/matter.js/interfaces/export._internal_.scenesTableEntry.md index 612365ebab..292e1f2220 100644 --- a/docs/matter.js/interfaces/export._internal_.scenesTableEntry.md +++ b/docs/matter.js/interfaces/export._internal_.scenesTableEntry.md @@ -27,7 +27,7 @@ these attributes for a cluster implemented on the same endpoint. The sum of all #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:37 +[packages/matter.js/src/cluster/server/ScenesServer.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L37) ___ @@ -39,7 +39,7 @@ The identifier, unique within this group, which is used to identify this scene. #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:24 +[packages/matter.js/src/cluster/server/ScenesServer.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L24) ___ @@ -51,7 +51,7 @@ The name of the scene (optional) #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:27 +[packages/matter.js/src/cluster/server/ScenesServer.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L27) ___ @@ -63,7 +63,7 @@ The amount of time, in seconds, it will take for a cluster to change from its cu #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:30 +[packages/matter.js/src/cluster/server/ScenesServer.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L30) ___ @@ -75,7 +75,7 @@ The group identifier for which this scene applies, or 0 if the scene is not asso #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:21 +[packages/matter.js/src/cluster/server/ScenesServer.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L21) ___ @@ -87,4 +87,4 @@ Together with the SceneTransitionTime field, this field allows the transition ti #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:40 +[packages/matter.js/src/cluster/server/ScenesServer.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L40) diff --git a/docs/matter.js/interfaces/model.VariantDetail.md b/docs/matter.js/interfaces/model.VariantDetail.md new file mode 100644 index 0000000000..3c192566ef --- /dev/null +++ b/docs/matter.js/interfaces/model.VariantDetail.md @@ -0,0 +1,65 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](../modules/model.md) / VariantDetail + +# Interface: VariantDetail + +[model](../modules/model.md).VariantDetail + +Supplies operational information about a set of variants. + +## Table of contents + +### Properties + +- [id](model.VariantDetail.md#id) +- [map](model.VariantDetail.md#map) +- [name](model.VariantDetail.md#name) +- [tag](model.VariantDetail.md#tag) + +## Properties + +### id + +• `Optional` **id**: `number` + +The highest priority ID across all variants, if any variant has an +ID. + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L41) + +___ + +### map + +• **map**: [`VariantMap`](../modules/model.md#variantmap) + +The actual variants. + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L51) + +___ + +### name + +• **name**: `string` + +The canonical name to use for the variants. + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L46) + +___ + +### tag + +• **tag**: [`ElementTag`](../enums/model.ElementTag.md) + +The shared tag across all variants. + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L35) diff --git a/docs/matter.js/interfaces/net_export.NetInterface.md b/docs/matter.js/interfaces/net_export.NetInterface.md index 005648e668..80eedb69d6 100644 --- a/docs/matter.js/interfaces/net_export.NetInterface.md +++ b/docs/matter.js/interfaces/net_export.NetInterface.md @@ -40,7 +40,7 @@ A Network interface enhances a TransportInterface with the ability to open a cha #### Defined in -packages/matter.js/src/common/TransportInterface.ts:20 +[packages/matter.js/src/common/TransportInterface.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/TransportInterface.ts#L20) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/matter.js/src/common/TransportInterface.ts:19 +[packages/matter.js/src/common/TransportInterface.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/TransportInterface.ts#L19) ___ @@ -84,4 +84,4 @@ ___ #### Defined in -packages/matter.js/src/net/NetInterface.ts:16 +[packages/matter.js/src/net/NetInterface.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/NetInterface.ts#L16) diff --git a/docs/matter.js/interfaces/net_export.UdpChannel.md b/docs/matter.js/interfaces/net_export.UdpChannel.md index 54471ed0ee..318f98cddf 100644 --- a/docs/matter.js/interfaces/net_export.UdpChannel.md +++ b/docs/matter.js/interfaces/net_export.UdpChannel.md @@ -28,7 +28,7 @@ #### Defined in -packages/matter.js/src/net/UdpChannel.ts:20 +[packages/matter.js/src/net/UdpChannel.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpChannel.ts#L21) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpChannel.ts:18 +[packages/matter.js/src/net/UdpChannel.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpChannel.ts#L19) ___ @@ -70,4 +70,4 @@ ___ #### Defined in -packages/matter.js/src/net/UdpChannel.ts:19 +[packages/matter.js/src/net/UdpChannel.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpChannel.ts#L20) diff --git a/docs/matter.js/interfaces/net_export.UdpChannelOptions.md b/docs/matter.js/interfaces/net_export.UdpChannelOptions.md index 073b17b760..b592b2280e 100644 --- a/docs/matter.js/interfaces/net_export.UdpChannelOptions.md +++ b/docs/matter.js/interfaces/net_export.UdpChannelOptions.md @@ -10,6 +10,7 @@ - [listeningAddress](net_export.UdpChannelOptions.md#listeningaddress) - [listeningPort](net_export.UdpChannelOptions.md#listeningport) +- [membershipAddresses](net_export.UdpChannelOptions.md#membershipaddresses) - [netInterface](net_export.UdpChannelOptions.md#netinterface) - [type](net_export.UdpChannelOptions.md#type) @@ -21,7 +22,7 @@ #### Defined in -packages/matter.js/src/net/UdpChannel.ts:13 +[packages/matter.js/src/net/UdpChannel.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpChannel.ts#L13) ___ @@ -31,7 +32,17 @@ ___ #### Defined in -packages/matter.js/src/net/UdpChannel.ts:11 +[packages/matter.js/src/net/UdpChannel.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpChannel.ts#L11) + +___ + +### membershipAddresses + +• `Optional` **membershipAddresses**: `string`[] + +#### Defined in + +[packages/matter.js/src/net/UdpChannel.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpChannel.ts#L15) ___ @@ -41,7 +52,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpChannel.ts:14 +[packages/matter.js/src/net/UdpChannel.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpChannel.ts#L14) ___ @@ -51,4 +62,4 @@ ___ #### Defined in -packages/matter.js/src/net/UdpChannel.ts:12 +[packages/matter.js/src/net/UdpChannel.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpChannel.ts#L12) diff --git a/docs/matter.js/interfaces/net_export.UdpMulticastServerOptions.md b/docs/matter.js/interfaces/net_export.UdpMulticastServerOptions.md index b36a4f47fd..9bc6db8c88 100644 --- a/docs/matter.js/interfaces/net_export.UdpMulticastServerOptions.md +++ b/docs/matter.js/interfaces/net_export.UdpMulticastServerOptions.md @@ -21,7 +21,7 @@ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:18 +[packages/matter.js/src/net/UdpMulticastServer.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L18) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:19 +[packages/matter.js/src/net/UdpMulticastServer.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L19) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:17 +[packages/matter.js/src/net/UdpMulticastServer.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L17) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -packages/matter.js/src/net/UdpMulticastServer.ts:20 +[packages/matter.js/src/net/UdpMulticastServer.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/UdpMulticastServer.ts#L20) diff --git a/docs/matter.js/interfaces/protocol_export.ProtocolHandler.md b/docs/matter.js/interfaces/protocol_export.ProtocolHandler.md index 5fec33b8e3..c3109f4c06 100644 --- a/docs/matter.js/interfaces/protocol_export.ProtocolHandler.md +++ b/docs/matter.js/interfaces/protocol_export.ProtocolHandler.md @@ -15,18 +15,33 @@ - [`CaseServer`](../classes/session_export.CaseServer.md) - [`InteractionServer`](../classes/protocol_interaction_export.InteractionServer.md) - [`PaseServer`](../classes/session_export.PaseServer.md) -- [`SecureChannelProtocol`](../classes/protocol_securechannel_export.SecureChannelProtocol.md) +- [`StatusReportOnlySecureChannelProtocol`](../classes/protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md) - [`SubscriptionClient`](../classes/protocol_interaction_export.SubscriptionClient.md) ## Table of contents ### Methods +- [close](protocol_export.ProtocolHandler.md#close) - [getId](protocol_export.ProtocolHandler.md#getid) - [onNewExchange](protocol_export.ProtocolHandler.md#onnewexchange) ## Methods +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/matter.js/src/protocol/ProtocolHandler.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ProtocolHandler.ts#L13) + +___ + ### getId ▸ **getId**(): `number` @@ -37,7 +52,7 @@ #### Defined in -packages/matter.js/src/protocol/ProtocolHandler.ts:11 +[packages/matter.js/src/protocol/ProtocolHandler.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ProtocolHandler.ts#L11) ___ @@ -58,4 +73,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/ProtocolHandler.ts:12 +[packages/matter.js/src/protocol/ProtocolHandler.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ProtocolHandler.ts#L12) diff --git a/docs/matter.js/interfaces/protocol_interaction_export.AttributePath.md b/docs/matter.js/interfaces/protocol_interaction_export.AttributePath.md index 62fc51a8a2..f305f64206 100644 --- a/docs/matter.js/interfaces/protocol_interaction_export.AttributePath.md +++ b/docs/matter.js/interfaces/protocol_interaction_export.AttributePath.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:75 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L75) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:74 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L74) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:73 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L73) diff --git a/docs/matter.js/interfaces/protocol_interaction_export.AttributeStatus.md b/docs/matter.js/interfaces/protocol_interaction_export.AttributeStatus.md index 6c982e1169..1ea3801f0f 100644 --- a/docs/matter.js/interfaces/protocol_interaction_export.AttributeStatus.md +++ b/docs/matter.js/interfaces/protocol_interaction_export.AttributeStatus.md @@ -28,7 +28,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:53 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L54) ___ @@ -38,4 +38,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionClient.ts:59 +[packages/matter.js/src/protocol/interaction/InteractionClient.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionClient.ts#L60) diff --git a/docs/matter.js/interfaces/protocol_interaction_export.AttributeWithPath.md b/docs/matter.js/interfaces/protocol_interaction_export.AttributeWithPath.md index f73b4e99b5..d50a39afb5 100644 --- a/docs/matter.js/interfaces/protocol_interaction_export.AttributeWithPath.md +++ b/docs/matter.js/interfaces/protocol_interaction_export.AttributeWithPath.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:86 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L86) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:85 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L85) diff --git a/docs/matter.js/interfaces/protocol_interaction_export.CommandPath.md b/docs/matter.js/interfaces/protocol_interaction_export.CommandPath.md index 580b374bb9..5bba41fdfc 100644 --- a/docs/matter.js/interfaces/protocol_interaction_export.CommandPath.md +++ b/docs/matter.js/interfaces/protocol_interaction_export.CommandPath.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:68 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L68) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:69 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L69) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:67 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L67) diff --git a/docs/matter.js/interfaces/protocol_interaction_export.CommandWithPath.md b/docs/matter.js/interfaces/protocol_interaction_export.CommandWithPath.md index 1c44f9dd5a..8a193983b1 100644 --- a/docs/matter.js/interfaces/protocol_interaction_export.CommandWithPath.md +++ b/docs/matter.js/interfaces/protocol_interaction_export.CommandWithPath.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:96 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L96) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:95 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L95) diff --git a/docs/matter.js/interfaces/protocol_interaction_export.EventPath.md b/docs/matter.js/interfaces/protocol_interaction_export.EventPath.md index c3ffa22af9..0e5b8c0613 100644 --- a/docs/matter.js/interfaces/protocol_interaction_export.EventPath.md +++ b/docs/matter.js/interfaces/protocol_interaction_export.EventPath.md @@ -20,7 +20,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:80 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L80) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:79 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L79) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:81 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L81) diff --git a/docs/matter.js/interfaces/protocol_interaction_export.EventWithPath.md b/docs/matter.js/interfaces/protocol_interaction_export.EventWithPath.md index 608b7e572b..fdc5c8e103 100644 --- a/docs/matter.js/interfaces/protocol_interaction_export.EventWithPath.md +++ b/docs/matter.js/interfaces/protocol_interaction_export.EventWithPath.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:91 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L91) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:90 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L90) diff --git a/docs/matter.js/interfaces/session_export.ResumptionRecord.md b/docs/matter.js/interfaces/session_export.ResumptionRecord.md index a4381323db..68fa6861fc 100644 --- a/docs/matter.js/interfaces/session_export.ResumptionRecord.md +++ b/docs/matter.js/interfaces/session_export.ResumptionRecord.md @@ -21,7 +21,7 @@ #### Defined in -packages/matter.js/src/session/SessionManager.ts:28 +[packages/matter.js/src/session/SessionManager.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L28) ___ @@ -31,7 +31,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:29 +[packages/matter.js/src/session/SessionManager.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L29) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:27 +[packages/matter.js/src/session/SessionManager.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L27) ___ @@ -51,4 +51,4 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:26 +[packages/matter.js/src/session/SessionManager.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L26) diff --git a/docs/matter.js/interfaces/session_export.Session.md b/docs/matter.js/interfaces/session_export.Session.md index 91bda6a2a9..2a13e966f4 100644 --- a/docs/matter.js/interfaces/session_export.Session.md +++ b/docs/matter.js/interfaces/session_export.Session.md @@ -19,6 +19,7 @@ ### Properties +- [closingAfterExchangeFinished](session_export.Session.md#closingafterexchangefinished) - [name](session_export.Session.md#name) ### Methods @@ -41,13 +42,23 @@ ## Properties +### closingAfterExchangeFinished + +• **closingAfterExchangeFinished**: `boolean` + +#### Defined in + +[packages/matter.js/src/session/Session.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L32) + +___ + ### name • **name**: `string` #### Defined in -packages/matter.js/src/session/Session.ts:31 +[packages/matter.js/src/session/Session.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L31) ## Methods @@ -67,19 +78,20 @@ packages/matter.js/src/session/Session.ts:31 #### Defined in -packages/matter.js/src/session/Session.ts:35 +[packages/matter.js/src/session/Session.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L36) ___ ### destroy -▸ **destroy**(`sendClose`): `Promise`<`void`\> +▸ **destroy**(`sendClose`, `closeAfterExchangeFinished?`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | | `sendClose` | `boolean` | +| `closeAfterExchangeFinished?` | `boolean` | #### Returns @@ -87,7 +99,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:44 +[packages/matter.js/src/session/Session.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L45) ___ @@ -107,7 +119,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:36 +[packages/matter.js/src/session/Session.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L37) ___ @@ -127,7 +139,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:43 +[packages/matter.js/src/session/Session.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L44) ___ @@ -141,7 +153,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:47 +[packages/matter.js/src/session/Session.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L48) ___ @@ -155,7 +167,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:38 +[packages/matter.js/src/session/Session.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L39) ___ @@ -169,7 +181,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:39 +[packages/matter.js/src/session/Session.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L40) ___ @@ -183,7 +195,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:37 +[packages/matter.js/src/session/Session.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L38) ___ @@ -197,7 +209,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:41 +[packages/matter.js/src/session/Session.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L42) ___ @@ -211,7 +223,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:42 +[packages/matter.js/src/session/Session.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L43) ___ @@ -225,7 +237,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:40 +[packages/matter.js/src/session/Session.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L41) ___ @@ -239,7 +251,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:34 +[packages/matter.js/src/session/Session.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L35) ___ @@ -253,7 +265,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:46 +[packages/matter.js/src/session/Session.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L47) ___ @@ -267,7 +279,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:33 +[packages/matter.js/src/session/Session.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L34) ___ @@ -287,4 +299,4 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:45 +[packages/matter.js/src/session/Session.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L46) diff --git a/docs/matter.js/interfaces/time_export.Timer.md b/docs/matter.js/interfaces/time_export.Timer.md index 886fcdeeaf..e45a0f10af 100644 --- a/docs/matter.js/interfaces/time_export.Timer.md +++ b/docs/matter.js/interfaces/time_export.Timer.md @@ -25,7 +25,7 @@ Is true if this timer is running. #### Defined in -packages/matter.js/src/time/Time.ts:54 +[packages/matter.js/src/time/Time.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L54) ## Methods @@ -41,7 +41,7 @@ Starts this timer, chainable. #### Defined in -packages/matter.js/src/time/Time.ts:57 +[packages/matter.js/src/time/Time.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L57) ___ @@ -57,4 +57,4 @@ Stops this timer, chainable. #### Defined in -packages/matter.js/src/time/Time.ts:60 +[packages/matter.js/src/time/Time.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L60) diff --git a/docs/matter.js/interfaces/tlv_export.FieldType.md b/docs/matter.js/interfaces/tlv_export.FieldType.md index b655ad62f8..bc1e56eb01 100644 --- a/docs/matter.js/interfaces/tlv_export.FieldType.md +++ b/docs/matter.js/interfaces/tlv_export.FieldType.md @@ -33,7 +33,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:18 +[packages/matter.js/src/tlv/TlvObject.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L18) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:15 +[packages/matter.js/src/tlv/TlvObject.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L15) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:17 +[packages/matter.js/src/tlv/TlvObject.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L17) ___ @@ -63,4 +63,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:16 +[packages/matter.js/src/tlv/TlvObject.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L16) diff --git a/docs/matter.js/interfaces/tlv_export.OptionalFieldType.md b/docs/matter.js/interfaces/tlv_export.OptionalFieldType.md index 5923f20984..05728596d5 100644 --- a/docs/matter.js/interfaces/tlv_export.OptionalFieldType.md +++ b/docs/matter.js/interfaces/tlv_export.OptionalFieldType.md @@ -37,7 +37,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:18 +[packages/matter.js/src/tlv/TlvObject.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L18) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:15 +[packages/matter.js/src/tlv/TlvObject.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L15) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:22 +[packages/matter.js/src/tlv/TlvObject.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L22) ___ @@ -79,4 +79,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:16 +[packages/matter.js/src/tlv/TlvObject.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L16) diff --git a/docs/matter.js/interfaces/tlv_export.TlvReader.md b/docs/matter.js/interfaces/tlv_export.TlvReader.md index c2a0cd8084..af7a7b1cce 100644 --- a/docs/matter.js/interfaces/tlv_export.TlvReader.md +++ b/docs/matter.js/interfaces/tlv_export.TlvReader.md @@ -41,7 +41,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:97 +[packages/matter.js/src/tlv/TlvSchema.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L97) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:95 +[packages/matter.js/src/tlv/TlvSchema.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L95) diff --git a/docs/matter.js/interfaces/tlv_export.TlvWriter.md b/docs/matter.js/interfaces/tlv_export.TlvWriter.md index 73356ea826..953960c233 100644 --- a/docs/matter.js/interfaces/tlv_export.TlvWriter.md +++ b/docs/matter.js/interfaces/tlv_export.TlvWriter.md @@ -41,7 +41,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:103 +[packages/matter.js/src/tlv/TlvSchema.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L103) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:101 +[packages/matter.js/src/tlv/TlvSchema.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L101) diff --git a/docs/matter.js/interfaces/util_export.Stream.md b/docs/matter.js/interfaces/util_export.Stream.md index 0951cd0b38..582b3027f3 100644 --- a/docs/matter.js/interfaces/util_export.Stream.md +++ b/docs/matter.js/interfaces/util_export.Stream.md @@ -33,7 +33,7 @@ #### Defined in -packages/matter.js/src/util/Stream.ts:12 +[packages/matter.js/src/util/Stream.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Stream.ts#L12) ___ @@ -53,4 +53,4 @@ ___ #### Defined in -packages/matter.js/src/util/Stream.ts:13 +[packages/matter.js/src/util/Stream.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Stream.ts#L13) diff --git a/docs/matter.js/modules.md b/docs/matter.js/modules.md index c612698770..72a2a61504 100644 --- a/docs/matter.js/modules.md +++ b/docs/matter.js/modules.md @@ -19,6 +19,7 @@ - [log/export](modules/log_export.md) - [math/export](modules/math_export.md) - [mdns/export](modules/mdns_export.md) +- [model](modules/model.md) - [net/export](modules/net_export.md) - [protocol/export](modules/protocol_export.md) - [protocol/interaction/export](modules/protocol_interaction_export.md) diff --git a/docs/matter.js/modules/ble_export.md b/docs/matter.js/modules/ble_export.md index e4b3d127f2..c45ce0bde0 100644 --- a/docs/matter.js/modules/ble_export.md +++ b/docs/matter.js/modules/ble_export.md @@ -35,7 +35,7 @@ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:11 +[packages/matter.js/src/ble/BleConsts.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L11) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:12 +[packages/matter.js/src/ble/BleConsts.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L12) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:13 +[packages/matter.js/src/ble/BleConsts.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L13) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:10 +[packages/matter.js/src/ble/BleConsts.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L10) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:16 +[packages/matter.js/src/ble/BleConsts.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L16) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:15 +[packages/matter.js/src/ble/BleConsts.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L15) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:21 +[packages/matter.js/src/ble/BleConsts.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L21) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:20 +[packages/matter.js/src/ble/BleConsts.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L20) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:18 +[packages/matter.js/src/ble/BleConsts.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L18) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -packages/matter.js/src/ble/BleConsts.ts:22 +[packages/matter.js/src/ble/BleConsts.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BleConsts.ts#L22) ___ @@ -139,4 +139,4 @@ ___ #### Defined in -packages/matter.js/src/ble/BtpSessionHandler.ts:25 +[packages/matter.js/src/ble/BtpSessionHandler.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/ble/BtpSessionHandler.ts#L25) diff --git a/docs/matter.js/modules/certificate_export.md b/docs/matter.js/modules/certificate_export.md index 065c08adf7..9cf7875351 100644 --- a/docs/matter.js/modules/certificate_export.md +++ b/docs/matter.js/modules/certificate_export.md @@ -59,7 +59,7 @@ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:327 +[packages/matter.js/src/certificate/CertificateManager.ts:327](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L327) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:328 +[packages/matter.js/src/certificate/CertificateManager.ts:328](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L328) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:326 +[packages/matter.js/src/certificate/CertificateManager.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L326) ## Variables @@ -89,7 +89,7 @@ packages/matter.js/src/certificate/CertificateManager.ts:326 #### Defined in -packages/matter.js/src/certificate/ChipPAAuthorities.ts:32 +[packages/matter.js/src/certificate/ChipPAAuthorities.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/ChipPAAuthorities.ts#L32) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/ChipPAAuthorities.ts:25 +[packages/matter.js/src/certificate/ChipPAAuthorities.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/ChipPAAuthorities.ts#L25) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/ChipPAAuthorities.ts:28 +[packages/matter.js/src/certificate/ChipPAAuthorities.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/ChipPAAuthorities.ts#L28) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/ChipPAAuthorities.ts:31 +[packages/matter.js/src/certificate/ChipPAAuthorities.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/ChipPAAuthorities.ts#L31) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/ChipPAAuthorities.ts:19 +[packages/matter.js/src/certificate/ChipPAAuthorities.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/ChipPAAuthorities.ts#L19) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/ChipPAAuthorities.ts:15 +[packages/matter.js/src/certificate/ChipPAAuthorities.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/ChipPAAuthorities.ts#L15) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/ChipPAAuthorities.ts:12 +[packages/matter.js/src/certificate/ChipPAAuthorities.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/ChipPAAuthorities.ts#L12) ___ @@ -159,7 +159,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/ChipPAAuthorities.ts:18 +[packages/matter.js/src/certificate/ChipPAAuthorities.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/ChipPAAuthorities.ts#L18) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:308 +[packages/matter.js/src/certificate/CertificateManager.ts:308](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L308) ___ @@ -179,7 +179,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:177 +[packages/matter.js/src/certificate/CertificateManager.ts:177](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L177) ___ @@ -189,7 +189,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:135 +[packages/matter.js/src/certificate/CertificateManager.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L135) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:95 +[packages/matter.js/src/certificate/CertificateManager.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L95) ## Functions @@ -221,7 +221,7 @@ commonName = ASN.1 OID 2.5.4.3 #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:73 +[packages/matter.js/src/certificate/CertificateManager.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L73) ___ @@ -243,7 +243,7 @@ matter-fabric-id = ASN.1 OID 1.3.6.1.4.1.37244.1.5 #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:85 +[packages/matter.js/src/certificate/CertificateManager.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L85) ___ @@ -265,7 +265,7 @@ matter-icac-id = ASN.1 OID 1.3.6.1.4.1.37244.1.3 #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:79 +[packages/matter.js/src/certificate/CertificateManager.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L79) ___ @@ -287,7 +287,7 @@ matter-node-id = ASN.1 OID 1.3.6.1.4.1.37244.1.1 #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:76 +[packages/matter.js/src/certificate/CertificateManager.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L76) ___ @@ -309,7 +309,7 @@ matter-oid-pid = ASN.1 OID 1.3.6.1.4.1.3724 4.2.2 #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:93 +[packages/matter.js/src/certificate/CertificateManager.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L93) ___ @@ -331,7 +331,7 @@ matter-rcac-id = ASN.1 OID 1.3.6.1.4.1.37244.1.4 #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:82 +[packages/matter.js/src/certificate/CertificateManager.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L82) ___ @@ -353,7 +353,7 @@ matter-oid-vid = ASN.1 OID 1.3.6.1.4.1.37244.2.1 #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:88 +[packages/matter.js/src/certificate/CertificateManager.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L88) ___ @@ -374,7 +374,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:54 +[packages/matter.js/src/certificate/CertificateManager.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L54) ___ @@ -394,4 +394,4 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:50 +[packages/matter.js/src/certificate/CertificateManager.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L50) diff --git a/docs/matter.js/modules/cluster_export.AccessControl.md b/docs/matter.js/modules/cluster_export.AccessControl.md index a5bbea6188..2ae05a74bc 100644 --- a/docs/matter.js/modules/cluster_export.AccessControl.md +++ b/docs/matter.js/modules/cluster_export.AccessControl.md @@ -43,7 +43,7 @@ any other Endpoint of any Node. #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:324 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:324](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L324) ___ @@ -59,7 +59,7 @@ Body of the AccessControl accessControlEntryChanged event #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:256 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L256) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:110 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L110) ___ @@ -89,7 +89,7 @@ Body of the AccessControl accessControlExtensionChanged event #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:303 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L303) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:212 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L212) ___ @@ -117,4 +117,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:101 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L101) diff --git a/docs/matter.js/modules/cluster_export.AccountLogin.md b/docs/matter.js/modules/cluster_export.AccountLogin.md index 706ec7b96d..9216f862f1 100644 --- a/docs/matter.js/modules/cluster_export.AccountLogin.md +++ b/docs/matter.js/modules/cluster_export.AccountLogin.md @@ -32,7 +32,7 @@ Client. #### Defined in -packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:80 +[packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts#L80) ___ @@ -48,7 +48,7 @@ Input to the AccountLogin getSetupPin command #### Defined in -packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:23 +[packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts#L23) ___ @@ -65,7 +65,7 @@ account identified in the request does not match the active account of the runni #### Defined in -packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:39 +[packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts#L39) ___ @@ -81,4 +81,4 @@ Input to the AccountLogin login command #### Defined in -packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:54 +[packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts#L54) diff --git a/docs/matter.js/modules/cluster_export.Actions.md b/docs/matter.js/modules/cluster_export.Actions.md index ee53cd5d36..4ee696a92f 100644 --- a/docs/matter.js/modules/cluster_export.Actions.md +++ b/docs/matter.js/modules/cluster_export.Actions.md @@ -80,7 +80,7 @@ the Interaction Model. #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:566 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:566](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L566) ___ @@ -113,7 +113,7 @@ Note - The bit allocation of this bitmap shall follow the ID’s of the Commands #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:116 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L116) ___ @@ -129,7 +129,7 @@ Body of the Actions actionFailed event #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:516 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:516](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L516) ___ @@ -145,7 +145,7 @@ This data type holds the details of a single action, and contains the data field #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:210 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:210](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L210) ___ @@ -161,7 +161,7 @@ Input to the Actions disableAction command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:456 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:456](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L456) ___ @@ -177,7 +177,7 @@ Input to the Actions disableActionWithDuration command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:466 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:466](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L466) ___ @@ -193,7 +193,7 @@ Input to the Actions enableAction command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:435 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:435](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L435) ___ @@ -209,7 +209,7 @@ Input to the Actions enableActionWithDuration command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:445 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:445](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L445) ___ @@ -234,7 +234,7 @@ This field shall indicate the type of endpoint list, see EndpointListTypeEnum. #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:322 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:322](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L322) ___ @@ -250,7 +250,7 @@ Input to the Actions instantAction command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:340 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:340](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L340) ___ @@ -266,7 +266,7 @@ Input to the Actions instantActionWithTransition command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:350 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:350](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L350) ___ @@ -282,7 +282,7 @@ Input to the Actions pauseAction command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:404 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:404](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L404) ___ @@ -298,7 +298,7 @@ Input to the Actions pauseActionWithDuration command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:414 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:414](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L414) ___ @@ -314,7 +314,7 @@ Input to the Actions resumeAction command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:425 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:425](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L425) ___ @@ -330,7 +330,7 @@ Input to the Actions startAction command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:367 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:367](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L367) ___ @@ -346,7 +346,7 @@ Input to the Actions startActionWithDuration command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:377 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:377](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L377) ___ @@ -362,7 +362,7 @@ Body of the Actions stateChanged event #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:477 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:477](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L477) ___ @@ -378,4 +378,4 @@ Input to the Actions stopAction command #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:394 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:394](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L394) diff --git a/docs/matter.js/modules/cluster_export.AdministratorCommissioning.md b/docs/matter.js/modules/cluster_export.AdministratorCommissioning.md index 71ed4b2867..bc69351bd6 100644 --- a/docs/matter.js/modules/cluster_export.AdministratorCommissioning.md +++ b/docs/matter.js/modules/cluster_export.AdministratorCommissioning.md @@ -39,7 +39,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:359 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:359](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L359) ## Variables @@ -51,7 +51,7 @@ These elements and properties are present in all AdministratorCommissioning clus #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:157 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L157) ___ @@ -63,7 +63,7 @@ A AdministratorCommissioningCluster supports these elements if it supports featu #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:279 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:279](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L279) ___ @@ -88,7 +88,7 @@ AdministratorCommissioningCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:337 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:337](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L337) ___ @@ -103,7 +103,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:371 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:371](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L371) ___ @@ -119,7 +119,7 @@ Input to the AdministratorCommissioning openBasicCommissioningWindow command #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:138 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L138) ___ @@ -135,4 +135,4 @@ Input to the AdministratorCommissioning openCommissioningWindow command #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:47 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L47) diff --git a/docs/matter.js/modules/cluster_export.ApplicationBasic.md b/docs/matter.js/modules/cluster_export.ApplicationBasic.md index 49f31a7751..1644d671cd 100644 --- a/docs/matter.js/modules/cluster_export.ApplicationBasic.md +++ b/docs/matter.js/modules/cluster_export.ApplicationBasic.md @@ -32,7 +32,7 @@ an endpoint (see Device Type Library document). #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:81 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L81) ___ @@ -48,4 +48,4 @@ This indicates a global identifier for an Application given a catalog. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:24 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L24) diff --git a/docs/matter.js/modules/cluster_export.ApplicationLauncher.md b/docs/matter.js/modules/cluster_export.ApplicationLauncher.md index 1edad4ab2a..b40c2699e5 100644 --- a/docs/matter.js/modules/cluster_export.ApplicationLauncher.md +++ b/docs/matter.js/modules/cluster_export.ApplicationLauncher.md @@ -42,7 +42,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:308 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:308](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L308) ## Variables @@ -54,7 +54,7 @@ A ApplicationLauncherCluster supports these elements if it supports feature Appl #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:261 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:261](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L261) ___ @@ -66,7 +66,7 @@ These elements and properties are present in all ApplicationLauncher clusters. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:171 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L171) ___ @@ -87,7 +87,7 @@ ApplicationLauncherCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:286 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:286](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L286) ___ @@ -102,7 +102,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:320 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:320](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L320) ___ @@ -118,7 +118,7 @@ This specifies an app along with its corresponding endpoint. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:53 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L53) ___ @@ -134,7 +134,7 @@ This indicates a global identifier for an Application given a catalog. #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:26 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L26) ___ @@ -150,7 +150,7 @@ Input to the ApplicationLauncher hideApp command #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:144 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:144](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L144) ___ @@ -166,7 +166,7 @@ Input to the ApplicationLauncher launchApp command #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:63 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L63) ___ @@ -182,7 +182,7 @@ This command shall be generated in response to LaunchApp/StopApp/HideApp command #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:109 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L109) ___ @@ -198,4 +198,4 @@ Input to the ApplicationLauncher stopApp command #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:130 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L130) diff --git a/docs/matter.js/modules/cluster_export.AudioOutput.md b/docs/matter.js/modules/cluster_export.AudioOutput.md index 1c0661a51f..f853ce1c23 100644 --- a/docs/matter.js/modules/cluster_export.AudioOutput.md +++ b/docs/matter.js/modules/cluster_export.AudioOutput.md @@ -39,7 +39,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:184 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L184) ## Variables @@ -51,7 +51,7 @@ These elements and properties are present in all AudioOutput clusters. #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:97 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L97) ___ @@ -72,7 +72,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:162 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L162) ___ @@ -87,7 +87,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:196 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L196) ___ @@ -99,7 +99,7 @@ A AudioOutputCluster supports these elements if it supports feature NameUpdates. #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:138 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:138](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L138) ___ @@ -115,7 +115,7 @@ This contains information about an output. #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:42 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L42) ___ @@ -131,7 +131,7 @@ Input to the AudioOutput renameOutput command #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:78 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L78) ___ @@ -147,4 +147,4 @@ Input to the AudioOutput selectOutput command #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:71 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L71) diff --git a/docs/matter.js/modules/cluster_export.BallastConfiguration.md b/docs/matter.js/modules/cluster_export.BallastConfiguration.md index 4eaa3c039e..f5ebe248d6 100644 --- a/docs/matter.js/modules/cluster_export.BallastConfiguration.md +++ b/docs/matter.js/modules/cluster_export.BallastConfiguration.md @@ -33,7 +33,7 @@ The value of the BallastConfiguration ballastStatus attribute #### Defined in -packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:29 +[packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts#L29) ___ @@ -51,7 +51,7 @@ Attributes and commands for configuring a lighting ballast. #### Defined in -packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:45 +[packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts#L45) ___ @@ -73,4 +73,4 @@ The value of the BallastConfiguration lampAlarmMode attribute #### Defined in -packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:36 +[packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts#L36) diff --git a/docs/matter.js/modules/cluster_export.BarrierControl.md b/docs/matter.js/modules/cluster_export.BarrierControl.md index 268c91f205..02264834b1 100644 --- a/docs/matter.js/modules/cluster_export.BarrierControl.md +++ b/docs/matter.js/modules/cluster_export.BarrierControl.md @@ -23,7 +23,7 @@ This cluster provides control of a barrier (garage door). #### Defined in -packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:26 +[packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts#L26) ___ @@ -35,4 +35,4 @@ Input to the BarrierControl barrierControlGoToPercent command #### Defined in -packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:19 +[packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts#L19) diff --git a/docs/matter.js/modules/cluster_export.BasicInformation.md b/docs/matter.js/modules/cluster_export.BasicInformation.md index 2f90783859..10abf9d4f9 100644 --- a/docs/matter.js/modules/cluster_export.BasicInformation.md +++ b/docs/matter.js/modules/cluster_export.BasicInformation.md @@ -24,7 +24,7 @@ ### Cluster -• `Const` **Cluster**: [`Definition`](cluster_export.ClusterFactory.md#definition)<{ `attributes`: { `capabilityMinima`: [`FixedAttribute`](cluster_export.md#fixedattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](cluster_export.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](cluster_export.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](cluster_export.md#fixedattribute)<[`VendorId`](datatype_export.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `fabricIndex`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`FabricIndex`](datatype_export.md#fabricindex)\> }\>, `any`\> ; `reachableChanged`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `startUp`: [`Event`](cluster_export.md#event)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``40`` = 0x28; `name`: ``"BasicInformation"`` = "BasicInformation"; `revision`: ``2`` = 2 }\> +• `Const` **Cluster**: [`Definition`](cluster_export.ClusterFactory.md#definition)<{ `attributes`: { `capabilityMinima`: [`FixedAttribute`](cluster_export.md#fixedattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](cluster_export.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](cluster_export.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](cluster_export.md#fixedattribute)<[`VendorId`](datatype_export.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `fabricIndex`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`FabricIndex`](datatype_export.md#fabricindex)\> }\>, `any`\> ; `reachableChanged`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `startUp`: [`Event`](cluster_export.md#event)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``40`` = 0x28; `name`: ``"BasicInformation"`` = "BasicInformation"; `revision`: ``2`` = 2 }\> Basic Information @@ -38,7 +38,7 @@ number, which apply to the whole Node. #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:151 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:151](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L151) ___ @@ -55,7 +55,7 @@ cluster-specific. #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:38 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L38) ___ @@ -71,7 +71,7 @@ Body of the BasicInformation leave event #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:119 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L119) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:94 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L94) ___ @@ -97,7 +97,7 @@ Body of the BasicInformation reachableChanged event #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:133 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L133) ___ @@ -113,4 +113,4 @@ Body of the BasicInformation startUp event #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:104 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:104](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L104) diff --git a/docs/matter.js/modules/cluster_export.BinaryInputBasic.md b/docs/matter.js/modules/cluster_export.BinaryInputBasic.md index bccc76626f..b949d1f34c 100644 --- a/docs/matter.js/modules/cluster_export.BinaryInputBasic.md +++ b/docs/matter.js/modules/cluster_export.BinaryInputBasic.md @@ -23,4 +23,4 @@ measurement. #### Defined in -packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:22 +[packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts#L22) diff --git a/docs/matter.js/modules/cluster_export.Binding.md b/docs/matter.js/modules/cluster_export.Binding.md index 2d3ff6725c..e49a4a171b 100644 --- a/docs/matter.js/modules/cluster_export.Binding.md +++ b/docs/matter.js/modules/cluster_export.Binding.md @@ -54,7 +54,7 @@ binding target. #### Defined in -packages/matter.js/src/cluster/definitions/BindingCluster.ts:94 +[packages/matter.js/src/cluster/definitions/BindingCluster.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BindingCluster.ts#L94) ___ @@ -68,4 +68,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BindingCluster.ts:24 +[packages/matter.js/src/cluster/definitions/BindingCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BindingCluster.ts#L24) diff --git a/docs/matter.js/modules/cluster_export.BooleanState.md b/docs/matter.js/modules/cluster_export.BooleanState.md index 695f98f7c5..2d6f44891e 100644 --- a/docs/matter.js/modules/cluster_export.BooleanState.md +++ b/docs/matter.js/modules/cluster_export.BooleanState.md @@ -27,7 +27,7 @@ This cluster provides an interface to a boolean state called StateValue. #### Defined in -packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:30 +[packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts#L30) ___ @@ -43,4 +43,4 @@ Body of the BooleanState stateChange event #### Defined in -packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:21 +[packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts#L21) diff --git a/docs/matter.js/modules/cluster_export.BridgedDeviceBasicInformation.md b/docs/matter.js/modules/cluster_export.BridgedDeviceBasicInformation.md index 33397c86fe..c995ce5f27 100644 --- a/docs/matter.js/modules/cluster_export.BridgedDeviceBasicInformation.md +++ b/docs/matter.js/modules/cluster_export.BridgedDeviceBasicInformation.md @@ -22,7 +22,7 @@ ### Cluster -• `Const` **Cluster**: [`Definition`](cluster_export.ClusterFactory.md#definition)<{ `attributes`: { `hardwareVersion`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](cluster_export.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<[`VendorId`](datatype_export.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `reachableChanged`: [`Event`](cluster_export.md#event)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `startUp`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``57`` = 0x39; `name`: ``"BridgedDeviceBasicInformation"`` = "BridgedDeviceBasicInformation"; `revision`: ``2`` = 2 }\> +• `Const` **Cluster**: [`Definition`](cluster_export.ClusterFactory.md#definition)<{ `attributes`: { `hardwareVersion`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](cluster_export.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<[`VendorId`](datatype_export.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `reachableChanged`: [`Event`](cluster_export.md#event)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `startUp`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``57`` = 0x39; `name`: ``"BridgedDeviceBasicInformation"`` = "BridgedDeviceBasicInformation"; `revision`: ``2`` = 2 }\> Bridged Device Basic Information @@ -55,7 +55,7 @@ Bridged Device. See below for Conformance details. #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:110 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L109) ___ @@ -65,7 +65,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:63 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L62) ___ @@ -81,7 +81,7 @@ Body of the BridgedDeviceBasicInformation reachableChanged event #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:80 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L79) ___ @@ -97,4 +97,4 @@ Body of the BridgedDeviceBasicInformation startUp event #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:73 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L72) diff --git a/docs/matter.js/modules/cluster_export.Channel.md b/docs/matter.js/modules/cluster_export.Channel.md index 4e24bf71f2..67c6495abd 100644 --- a/docs/matter.js/modules/cluster_export.Channel.md +++ b/docs/matter.js/modules/cluster_export.Channel.md @@ -45,7 +45,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:363 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L363) ## Variables @@ -57,7 +57,7 @@ These elements and properties are present in all Channel clusters. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:220 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L220) ___ @@ -69,7 +69,7 @@ A ChannelCluster supports these elements if it supports feature ChannelList. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:277 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:277](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L277) ___ @@ -81,7 +81,7 @@ A ChannelCluster supports these elements if it supports features ChannelList or #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:305 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L305) ___ @@ -101,7 +101,7 @@ ChannelCluster supports optional features that you can enable with the ChannelCl #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:332 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:332](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L332) ___ @@ -116,7 +116,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:379 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:379](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L379) ___ @@ -128,7 +128,7 @@ A ChannelCluster supports these elements if it supports feature LineupInfo. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:291 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L291) ___ @@ -144,7 +144,7 @@ Input to the Channel changeChannelByNumber command #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:75 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L75) ___ @@ -160,7 +160,7 @@ Input to the Channel changeChannel command #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:146 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:146](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L146) ___ @@ -176,7 +176,7 @@ This command shall be generated in response to a ChangeChannel command. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:180 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L180) ___ @@ -195,7 +195,7 @@ other formats which can map into these numeric values. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:28 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L28) ___ @@ -212,7 +212,7 @@ LineupName, and PostalCode MUST uniquely identify a lineup. #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:122 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L122) ___ @@ -228,4 +228,4 @@ Input to the Channel skipChannel command #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:96 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L96) diff --git a/docs/matter.js/modules/cluster_export.ClientMonitoring.md b/docs/matter.js/modules/cluster_export.ClientMonitoring.md index c8395c4b4b..ed653cae4c 100644 --- a/docs/matter.js/modules/cluster_export.ClientMonitoring.md +++ b/docs/matter.js/modules/cluster_export.ClientMonitoring.md @@ -25,7 +25,7 @@ Client Monitoring allows for ensuring that listed clients meet the required moni #### Defined in -packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:44 +[packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts#L44) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:18 +[packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts#L18) ___ @@ -47,7 +47,7 @@ Input to the ClientMonitoring registerClientMonitoring command #### Defined in -packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:26 +[packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts#L26) ___ @@ -59,4 +59,4 @@ Input to the ClientMonitoring unregisterClientMonitoring command #### Defined in -packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:34 +[packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts#L34) diff --git a/docs/matter.js/modules/cluster_export.ClusterFactory.md b/docs/matter.js/modules/cluster_export.ClusterFactory.md index 18af000a6b..5b704338af 100644 --- a/docs/matter.js/modules/cluster_export.ClusterFactory.md +++ b/docs/matter.js/modules/cluster_export.ClusterFactory.md @@ -62,7 +62,7 @@ Definition of a cluster attribute. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:43 +[packages/matter.js/src/cluster/ClusterFactory.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L43) ___ @@ -80,7 +80,7 @@ Extract the type of a cluster's attributes. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:316 +[packages/matter.js/src/cluster/ClusterFactory.ts:316](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L316) ___ @@ -92,7 +92,7 @@ Definition of a cluster command. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:48 +[packages/matter.js/src/cluster/ClusterFactory.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L48) ___ @@ -110,7 +110,7 @@ Extract the type of a cluster's commands. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:323 +[packages/matter.js/src/cluster/ClusterFactory.ts:323](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L323) ___ @@ -128,9 +128,9 @@ A "definition" is the fully typed Cluster for a PartialDefinition. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:172 +[packages/matter.js/src/cluster/ClusterFactory.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L172) -packages/matter.js/src/cluster/ClusterFactory.ts:117 +[packages/matter.js/src/cluster/ClusterFactory.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L117) ___ @@ -142,7 +142,7 @@ An "element" is a single attribute, command or event of a cluster. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:155 +[packages/matter.js/src/cluster/ClusterFactory.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L155) ___ @@ -161,7 +161,7 @@ events) of a cluster. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:38 +[packages/matter.js/src/cluster/ClusterFactory.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L38) ___ @@ -173,7 +173,7 @@ Definition of a cluster event. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:53 +[packages/matter.js/src/cluster/ClusterFactory.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L53) ___ @@ -191,7 +191,7 @@ Extract the type of a cluster's events. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:330 +[packages/matter.js/src/cluster/ClusterFactory.ts:330](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L330) ___ @@ -218,7 +218,7 @@ features enabled. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:142 +[packages/matter.js/src/cluster/ClusterFactory.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L142) ___ @@ -230,7 +230,7 @@ A "MutableDefinition" is a Cluster with fields that may be modified. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:134 +[packages/matter.js/src/cluster/ClusterFactory.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L134) ___ @@ -243,7 +243,7 @@ empty elements to be present. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:107 +[packages/matter.js/src/cluster/ClusterFactory.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L107) ## Functions @@ -277,7 +277,7 @@ Create a conditional version of an unconditional element definition. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:298 +[packages/matter.js/src/cluster/ClusterFactory.ts:298](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L298) ___ @@ -305,7 +305,7 @@ Define a cluster component. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:160 +[packages/matter.js/src/cluster/ClusterFactory.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L160) ___ @@ -333,7 +333,7 @@ Define a cluster. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:172 +[packages/matter.js/src/cluster/ClusterFactory.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L172) ___ @@ -363,7 +363,7 @@ Define an extensible cluster. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:192 +[packages/matter.js/src/cluster/ClusterFactory.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L192) ___ @@ -395,7 +395,7 @@ Define a cluster that can only be extended. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:205 +[packages/matter.js/src/cluster/ClusterFactory.ts:205](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L205) ___ @@ -422,7 +422,7 @@ This is used by extenders and does not convey type information. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:217 +[packages/matter.js/src/cluster/ClusterFactory.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L217) ___ @@ -448,7 +448,7 @@ Used by extenders. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:282 +[packages/matter.js/src/cluster/ClusterFactory.ts:282](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L282) ___ @@ -474,4 +474,4 @@ Used by extenders. #### Defined in -packages/matter.js/src/cluster/ClusterFactory.ts:268 +[packages/matter.js/src/cluster/ClusterFactory.ts:268](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterFactory.ts#L268) diff --git a/docs/matter.js/modules/cluster_export.ColorControl.md b/docs/matter.js/modules/cluster_export.ColorControl.md index a24a82685b..1680176bcf 100644 --- a/docs/matter.js/modules/cluster_export.ColorControl.md +++ b/docs/matter.js/modules/cluster_export.ColorControl.md @@ -70,7 +70,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1614 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1614](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1614) ## Variables @@ -82,7 +82,7 @@ These elements and properties are present in all ColorControl clusters. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:808 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:808](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L808) ___ @@ -103,7 +103,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1579 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1579](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1579) ___ @@ -115,7 +115,7 @@ A ColorControlCluster supports these elements if it supports feature ColorLoop. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1494 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1494](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1494) ___ @@ -127,7 +127,7 @@ A ColorControlCluster supports these elements if it supports feature ColorTemper #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1328 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1328](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1328) ___ @@ -142,7 +142,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1636 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1636](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1636) ___ @@ -154,7 +154,7 @@ A ColorControlCluster supports these elements if it supports feature EnhancedHue #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1433 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1433](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1433) ___ @@ -180,7 +180,7 @@ The value of the ColorControl featureMap attribute #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:77 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L77) ___ @@ -192,7 +192,7 @@ A ColorControlCluster supports these elements if it supports feature HueSaturati #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1199 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1199](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1199) ___ @@ -204,7 +204,7 @@ A ColorControlCluster supports these elements if it supports features HueSaturat #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1555 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1555](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1555) ___ @@ -226,7 +226,7 @@ The value of the ColorControl options attribute #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:58 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L58) ___ @@ -242,7 +242,7 @@ Input to the ColorControl colorLoopSet command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:694 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:694](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L694) ___ @@ -258,7 +258,7 @@ Input to the ColorControl enhancedMoveHue command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:562 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:562](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L562) ___ @@ -274,7 +274,7 @@ Input to the ColorControl enhancedMoveToHueAndSaturation command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:627 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:627](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L627) ___ @@ -290,7 +290,7 @@ Input to the ColorControl enhancedMoveToHue command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:529 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:529](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L529) ___ @@ -306,7 +306,7 @@ Input to the ColorControl enhancedStepHue command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:590 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:590](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L590) ___ @@ -322,7 +322,7 @@ Input to the ColorControl moveColor command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:345 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:345](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L345) ___ @@ -338,7 +338,7 @@ Input to the ColorControl moveColorTemperature command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:404 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:404](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L404) ___ @@ -354,7 +354,7 @@ Input to the ColorControl moveHue command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:170 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L170) ___ @@ -370,7 +370,7 @@ Input to the ColorControl moveSaturation command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:255 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:255](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L255) ___ @@ -386,7 +386,7 @@ Input to the ColorControl moveToColor command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:332 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:332](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L332) ___ @@ -402,7 +402,7 @@ Input to the ColorControl moveToColorTemperature command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:392 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:392](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L392) ___ @@ -418,7 +418,7 @@ Input to the ColorControl moveToHueAndSaturation command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:319 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:319](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L319) ___ @@ -434,7 +434,7 @@ Input to the ColorControl moveToHue command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:129 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L129) ___ @@ -450,7 +450,7 @@ Input to the ColorControl moveToSaturation command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:243 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:243](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L243) ___ @@ -466,7 +466,7 @@ Input to the ColorControl stepColor command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:371 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:371](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L371) ___ @@ -482,7 +482,7 @@ Input to the ColorControl stepColorTemperature command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:464 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:464](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L464) ___ @@ -498,7 +498,7 @@ Input to the ColorControl stepHue command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:206 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:206](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L206) ___ @@ -514,7 +514,7 @@ Input to the ColorControl stepSaturation command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:284 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:284](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L284) ___ @@ -530,7 +530,7 @@ Input to the ColorControl stopMoveStep command #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:758 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:758](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L758) ___ @@ -556,7 +556,7 @@ The value of ColorControl.updateFlags #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:660 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:660](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L660) ___ @@ -568,4 +568,4 @@ A ColorControlCluster supports these elements if it supports feature Xy. #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1274 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1274](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1274) diff --git a/docs/matter.js/modules/cluster_export.ContentLauncher.md b/docs/matter.js/modules/cluster_export.ContentLauncher.md index f885ccc95b..fd8ce89eb1 100644 --- a/docs/matter.js/modules/cluster_export.ContentLauncher.md +++ b/docs/matter.js/modules/cluster_export.ContentLauncher.md @@ -50,7 +50,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:578 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:578](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L578) ## Variables @@ -62,7 +62,7 @@ These elements and properties are present in all ContentLauncher clusters. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:456 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:456](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L456) ___ @@ -84,7 +84,7 @@ factory method. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:547 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:547](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L547) ___ @@ -99,7 +99,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:594 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:594](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L594) ___ @@ -111,7 +111,7 @@ A ContentLauncherCluster supports these elements if it supports feature ContentS #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:519 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:519](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L519) ___ @@ -123,7 +123,7 @@ A ContentLauncherCluster supports these elements if it supports features Content #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:534 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:534](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L534) ___ @@ -146,7 +146,7 @@ The value of the ContentLauncher supportedStreamingProtocols attribute #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:25 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L25) ___ @@ -162,7 +162,7 @@ This object defines additional name=value pairs that can be used for identifying #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:343 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L343) ___ @@ -179,7 +179,7 @@ the Video Player during playback. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:134 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L134) ___ @@ -195,7 +195,7 @@ This object defines inputs to a search for content for display or playback. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:392 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:392](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L392) ___ @@ -214,7 +214,7 @@ because we don’t have any other usecases which require this datatype. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:68 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L68) ___ @@ -230,7 +230,7 @@ Input to the ContentLauncher launchContent command #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:408 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:408](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L408) ___ @@ -246,7 +246,7 @@ Input to the ContentLauncher launchUrl command #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:186 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:186](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L186) ___ @@ -264,7 +264,7 @@ WARNING TODO: Data in table above needs a max size #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:238 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L238) ___ @@ -280,7 +280,7 @@ This object defines inputs to a search for content for display or playback. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:364 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:364](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L364) ___ @@ -297,7 +297,7 @@ related properties. #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:97 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L97) ___ @@ -309,4 +309,4 @@ A ContentLauncherCluster supports these elements if it supports feature UrlPlayb #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:481 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:481](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L481) diff --git a/docs/matter.js/modules/cluster_export.Descriptor.md b/docs/matter.js/modules/cluster_export.Descriptor.md index 39ee42daf7..4e921c1ab4 100644 --- a/docs/matter.js/modules/cluster_export.Descriptor.md +++ b/docs/matter.js/modules/cluster_export.Descriptor.md @@ -37,7 +37,7 @@ type. #### Defined in -packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:61 +[packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DescriptorCluster.ts#L61) ___ @@ -54,4 +54,4 @@ Model specification for more information. #### Defined in -packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:26 +[packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DescriptorCluster.ts#L26) diff --git a/docs/matter.js/modules/cluster_export.DiagnosticLogs.md b/docs/matter.js/modules/cluster_export.DiagnosticLogs.md index 7f5e88ee91..671801d485 100644 --- a/docs/matter.js/modules/cluster_export.DiagnosticLogs.md +++ b/docs/matter.js/modules/cluster_export.DiagnosticLogs.md @@ -40,7 +40,7 @@ NOTE Support for Diagnostic Logs cluster is provisional. #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:247 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L247) ___ @@ -56,7 +56,7 @@ Input to the DiagnosticLogs retrieveLogsRequest command #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:80 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L80) ___ @@ -73,4 +73,4 @@ following. #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:198 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L198) diff --git a/docs/matter.js/modules/cluster_export.DoorLock.md b/docs/matter.js/modules/cluster_export.DoorLock.md index bfd59862aa..d5d97fe31d 100644 --- a/docs/matter.js/modules/cluster_export.DoorLock.md +++ b/docs/matter.js/modules/cluster_export.DoorLock.md @@ -109,7 +109,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2494 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2494](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2494) ## Variables @@ -137,7 +137,7 @@ The value of the DoorLock alarmMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:218 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:218](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L218) ___ @@ -149,7 +149,7 @@ These elements and properties are present in all DoorLock clusters. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1279 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1279](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1279) ___ @@ -169,7 +169,7 @@ DoorLockCluster supports optional features that you can enable with the DoorLock #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2420 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2420](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2420) ___ @@ -184,7 +184,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2538 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2538](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2538) ___ @@ -196,7 +196,7 @@ A DoorLockCluster supports these elements if it supports features CredentialOver #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2103 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2103) ___ @@ -220,7 +220,7 @@ The value of the DoorLock credentialRulesSupport attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:577 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:577](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L577) ___ @@ -249,7 +249,7 @@ applies for. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:947 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:947](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L947) ___ @@ -276,7 +276,7 @@ The value of the DoorLock defaultConfigurationRegister attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:192 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L192) ___ @@ -288,7 +288,7 @@ A DoorLockCluster supports these elements if it supports feature DoorPositionSen #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1632 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1632](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1632) ___ @@ -300,7 +300,7 @@ A DoorLockCluster supports these elements if it supports feature HolidaySchedule #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2013 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2013](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2013) ___ @@ -329,7 +329,7 @@ The value of the DoorLock keypadOperationEventMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1091 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1091](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1091) ___ @@ -355,7 +355,7 @@ The value of the DoorLock keypadProgrammingEventMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1107 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1107) ___ @@ -380,7 +380,7 @@ The value of the DoorLock localProgrammingFeatures attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:206 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:206](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L206) ___ @@ -392,7 +392,7 @@ A DoorLockCluster supports these elements if it supports feature Logging. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1679 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1679](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1679) ___ @@ -424,7 +424,7 @@ The value of the DoorLock manualOperationEventMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1135 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1135) ___ @@ -436,7 +436,7 @@ A DoorLockCluster supports these elements if doesn't support feature USR. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2363 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2363) ___ @@ -448,7 +448,7 @@ A DoorLockCluster supports these elements if it supports features Notification a #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2122 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2122) ___ @@ -460,7 +460,7 @@ A DoorLockCluster supports these elements if it supports features Notification a #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2224 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2224) ___ @@ -472,7 +472,7 @@ A DoorLockCluster supports these elements if it supports feature Notification. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2164 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2164](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2164) ___ @@ -485,7 +485,7 @@ FingerCredentials and it doesn't support feature USR. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2312 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2312](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2312) ___ @@ -497,7 +497,7 @@ A DoorLockCluster supports these elements if it supports feature PinCredential. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1835 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1835](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1835) ___ @@ -510,7 +510,7 @@ USR. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2266 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2266](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2266) ___ @@ -522,7 +522,7 @@ A DoorLockCluster supports these elements if it supports features PinCredential #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2062 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2062](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2062) ___ @@ -550,7 +550,7 @@ The value of the DoorLock remoteOperationEventMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1120 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1120) ___ @@ -577,7 +577,7 @@ The value of the DoorLock remoteProgrammingEventMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1154 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1154) ___ @@ -589,7 +589,7 @@ A DoorLockCluster supports these elements if it supports feature RfidCredential. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1883 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1883](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1883) ___ @@ -602,7 +602,7 @@ USR. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2369 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2369](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2369) ___ @@ -630,7 +630,7 @@ The value of the DoorLock rfidOperationEventMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1168 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1168) ___ @@ -654,7 +654,7 @@ The value of the DoorLock rfidProgrammingEventMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1183 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1183) ___ @@ -680,7 +680,7 @@ The value of the DoorLock supportedOperatingModes attribute #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:179 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L179) ___ @@ -696,7 +696,7 @@ Input to the DoorLock clearCredential command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:814 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:814](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L814) ___ @@ -712,7 +712,7 @@ Input to the DoorLock clearHolidaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1084 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1084](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1084) ___ @@ -728,7 +728,7 @@ Input to the DoorLock clearUser command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:756 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:756](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L756) ___ @@ -744,7 +744,7 @@ Input to the DoorLock clearWeekDaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1001 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1001](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1001) ___ @@ -760,7 +760,7 @@ Input to the DoorLock clearYearDaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1044 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1044](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1044) ___ @@ -777,7 +777,7 @@ credential types and their corresponding indices (if any) for the event or user #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:370 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:370](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L370) ___ @@ -793,7 +793,7 @@ Body of the DoorLock doorLockAlarm event #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:304 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:304](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L304) ___ @@ -809,7 +809,7 @@ Body of the DoorLock doorStateChange event #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:563 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:563](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L563) ___ @@ -825,7 +825,7 @@ Input to the DoorLock getCredentialStatus command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:796 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:796](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L796) ___ @@ -839,7 +839,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:801 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:801](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L801) ___ @@ -855,7 +855,7 @@ Input to the DoorLock getHolidaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1066 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1066](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1066) ___ @@ -869,7 +869,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1071 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1071](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1071) ___ @@ -885,7 +885,7 @@ Input to the DoorLock getUser command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:733 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:733](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L733) ___ @@ -899,7 +899,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:738 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:738](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L738) ___ @@ -915,7 +915,7 @@ Input to the DoorLock getWeekDaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:977 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:977](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L977) ___ @@ -929,7 +929,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:985 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:985](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L985) ___ @@ -945,7 +945,7 @@ Input to the DoorLock getYearDaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1023 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1023](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1023) ___ @@ -959,7 +959,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1031 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1031](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1031) ___ @@ -975,7 +975,7 @@ Input to the DoorLock lockDoor command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:233 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:233](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L233) ___ @@ -991,7 +991,7 @@ Body of the DoorLock lockOperationError event #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:461 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:461](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L461) ___ @@ -1007,7 +1007,7 @@ Body of the DoorLock lockOperation event #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:393 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:393](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L393) ___ @@ -1023,7 +1023,7 @@ Body of the DoorLock lockUserChange event #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:883 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:883](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L883) ___ @@ -1039,7 +1039,7 @@ Input to the DoorLock setCredential command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:763 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:763](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L763) ___ @@ -1053,7 +1053,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:785 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:785](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L785) ___ @@ -1069,7 +1069,7 @@ Input to the DoorLock setHolidaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1054 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1054](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1054) ___ @@ -1085,7 +1085,7 @@ Input to the DoorLock setUser command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:718 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:718](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L718) ___ @@ -1101,7 +1101,7 @@ Input to the DoorLock setWeekDaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:962 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:962](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L962) ___ @@ -1117,7 +1117,7 @@ Input to the DoorLock setYearDaySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1011 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1011](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1011) ___ @@ -1133,7 +1133,7 @@ Input to the DoorLock unlockDoor command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:240 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L240) ___ @@ -1149,7 +1149,7 @@ Input to the DoorLock unlockWithTimeout command #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:247 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L247) ___ @@ -1161,7 +1161,7 @@ A DoorLockCluster supports these elements if it supports feature User. #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1710 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1710](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1710) ___ @@ -1173,7 +1173,7 @@ A DoorLockCluster supports these elements if it supports feature WeekDayAccessSc #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1915 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1915](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1915) ___ @@ -1185,4 +1185,4 @@ A DoorLockCluster supports these elements if it supports feature YearDayAccessSc #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1964 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:1964](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L1964) diff --git a/docs/matter.js/modules/cluster_export.ElectricalMeasurement.md b/docs/matter.js/modules/cluster_export.ElectricalMeasurement.md index 11d55647ea..2b6b2fc8ee 100644 --- a/docs/matter.js/modules/cluster_export.ElectricalMeasurement.md +++ b/docs/matter.js/modules/cluster_export.ElectricalMeasurement.md @@ -25,7 +25,7 @@ metering cluster.. #### Defined in -packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:32 +[packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts#L32) ___ @@ -37,4 +37,4 @@ Input to the ElectricalMeasurement getMeasurementProfileCommand command #### Defined in -packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:19 +[packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts#L19) diff --git a/docs/matter.js/modules/cluster_export.EthernetNetworkDiagnostics.md b/docs/matter.js/modules/cluster_export.EthernetNetworkDiagnostics.md index f2a62d2c6b..55e6a75e02 100644 --- a/docs/matter.js/modules/cluster_export.EthernetNetworkDiagnostics.md +++ b/docs/matter.js/modules/cluster_export.EthernetNetworkDiagnostics.md @@ -38,7 +38,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:283 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L283) ## Variables @@ -50,7 +50,7 @@ These elements and properties are present in all EthernetNetworkDiagnostics clus #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:99 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L99) ___ @@ -74,7 +74,7 @@ EthernetNetworkDiagnosticsCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:252 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:252](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L252) ___ @@ -89,7 +89,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:299 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:299](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L299) ___ @@ -101,7 +101,7 @@ A EthernetNetworkDiagnosticsCluster supports these elements if it supports featu #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:183 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L183) ___ @@ -113,7 +113,7 @@ A EthernetNetworkDiagnosticsCluster supports these elements if it supports featu #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:159 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:159](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L159) ___ @@ -125,4 +125,4 @@ A EthernetNetworkDiagnosticsCluster supports these elements if it supports featu #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:216 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L216) diff --git a/docs/matter.js/modules/cluster_export.FanControl.md b/docs/matter.js/modules/cluster_export.FanControl.md index 8d88a0c248..1b29530297 100644 --- a/docs/matter.js/modules/cluster_export.FanControl.md +++ b/docs/matter.js/modules/cluster_export.FanControl.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:377 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:377](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L377) ## Variables @@ -55,7 +55,7 @@ These elements and properties are present in all FanControl clusters. #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:169 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:169](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L169) ___ @@ -76,7 +76,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:353 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:353](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L353) ___ @@ -91,7 +91,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:394 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:394](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L394) ___ @@ -103,7 +103,7 @@ A FanControlCluster supports these elements if it supports feature MultiSpeed. #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:247 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L247) ___ @@ -127,7 +127,7 @@ The value of the FanControl rockSetting attribute #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:115 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L115) ___ @@ -151,7 +151,7 @@ The value of the FanControl rockSupport attribute #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:108 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L108) ___ @@ -163,7 +163,7 @@ A FanControlCluster supports these elements if it supports feature Rocking. #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:280 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:280](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L280) ___ @@ -175,7 +175,7 @@ A FanControlCluster supports these elements if it supports feature Wind. #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:313 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:313](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L313) ___ @@ -198,7 +198,7 @@ The value of the FanControl windSetting attribute #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:129 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L129) ___ @@ -221,4 +221,4 @@ The value of the FanControl windSupport attribute #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:122 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L122) diff --git a/docs/matter.js/modules/cluster_export.FaultInjection.md b/docs/matter.js/modules/cluster_export.FaultInjection.md index a2f0386905..ff41f54a6f 100644 --- a/docs/matter.js/modules/cluster_export.FaultInjection.md +++ b/docs/matter.js/modules/cluster_export.FaultInjection.md @@ -29,7 +29,7 @@ fault in the system). #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:50 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L50) ___ @@ -41,7 +41,7 @@ Input to the FaultInjection failAtFault command #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:27 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L27) ___ @@ -53,4 +53,4 @@ Input to the FaultInjection failRandomlyAtFault command #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:38 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L38) diff --git a/docs/matter.js/modules/cluster_export.FixedLabel.md b/docs/matter.js/modules/cluster_export.FixedLabel.md index cadcb23642..2aaa7645d2 100644 --- a/docs/matter.js/modules/cluster_export.FixedLabel.md +++ b/docs/matter.js/modules/cluster_export.FixedLabel.md @@ -34,4 +34,4 @@ This cluster provides a feature for the device to tag an endpoint with zero or m #### Defined in -packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:31 +[packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts#L31) diff --git a/docs/matter.js/modules/cluster_export.FlowMeasurement.md b/docs/matter.js/modules/cluster_export.FlowMeasurement.md index 0955b0fb95..85a0e36904 100644 --- a/docs/matter.js/modules/cluster_export.FlowMeasurement.md +++ b/docs/matter.js/modules/cluster_export.FlowMeasurement.md @@ -27,4 +27,4 @@ notifications of flow measurements. #### Defined in -packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:24 +[packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts#L24) diff --git a/docs/matter.js/modules/cluster_export.GeneralCommissioning.md b/docs/matter.js/modules/cluster_export.GeneralCommissioning.md index d9fe8b13b0..3d1f08ad06 100644 --- a/docs/matter.js/modules/cluster_export.GeneralCommissioning.md +++ b/docs/matter.js/modules/cluster_export.GeneralCommissioning.md @@ -42,7 +42,7 @@ those other clusters may depend on. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:184 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L184) ___ @@ -58,7 +58,7 @@ Input to the GeneralCommissioning armFailSafe command #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:76 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L76) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:118 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L118) ___ @@ -88,7 +88,7 @@ This structure provides some constant values that may be of use to all commissio #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:24 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L24) ___ @@ -107,7 +107,7 @@ See Section 11.9.6.1, “Common fields in General Commissioning cluster response #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:167 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L167) ___ @@ -123,7 +123,7 @@ Input to the GeneralCommissioning setRegulatoryConfig command #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:140 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L140) ___ @@ -142,4 +142,4 @@ See Section 11.9.6.1, “Common fields in General Commissioning cluster response #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:154 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L154) diff --git a/docs/matter.js/modules/cluster_export.GeneralDiagnostics.md b/docs/matter.js/modules/cluster_export.GeneralDiagnostics.md index fa66de8d65..29c42d0847 100644 --- a/docs/matter.js/modules/cluster_export.GeneralDiagnostics.md +++ b/docs/matter.js/modules/cluster_export.GeneralDiagnostics.md @@ -44,7 +44,7 @@ majority of Nodes. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:428 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:428](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L428) ___ @@ -60,7 +60,7 @@ Body of the GeneralDiagnostics bootReason event #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:400 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:400](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L400) ___ @@ -76,7 +76,7 @@ Body of the GeneralDiagnostics hardwareFaultChange event #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:356 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L356) ___ @@ -92,7 +92,7 @@ Body of the GeneralDiagnostics networkFaultChange event #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:390 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:390](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L390) ___ @@ -109,7 +109,7 @@ attribute. #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:65 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L65) ___ @@ -125,7 +125,7 @@ Body of the GeneralDiagnostics radioFaultChange event #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:380 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:380](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L380) ___ @@ -141,4 +141,4 @@ Input to the GeneralDiagnostics testEventTrigger command #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:303 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L303) diff --git a/docs/matter.js/modules/cluster_export.GroupKeyManagement.md b/docs/matter.js/modules/cluster_export.GroupKeyManagement.md index cb81e16391..4929ed1e46 100644 --- a/docs/matter.js/modules/cluster_export.GroupKeyManagement.md +++ b/docs/matter.js/modules/cluster_export.GroupKeyManagement.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:479 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:479](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L479) ## Variables @@ -55,7 +55,7 @@ These elements and properties are present in all GroupKeyManagement clusters. #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:266 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:266](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L266) ___ @@ -76,7 +76,7 @@ GroupKeyManagementCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:458 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:458](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L458) ___ @@ -92,7 +92,7 @@ This field uniquely identifies the group within the scope of the given Fabric. #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:61 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L61) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:34 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L34) ___ @@ -123,7 +123,7 @@ This field shall provide the fabric-unique index for the associated group key se #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:126 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L126) ___ @@ -147,7 +147,7 @@ Each entry in GroupKeySetIDs is a GroupKeySetID field. #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:247 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L247) ___ @@ -163,7 +163,7 @@ Input to the GroupKeyManagement keySetRead command #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:216 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L216) ___ @@ -181,7 +181,7 @@ contents replaced by null. #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:225 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L225) ___ @@ -197,7 +197,7 @@ Input to the GroupKeyManagement keySetRemove command #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:232 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:232](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L232) ___ @@ -213,4 +213,4 @@ Input to the GroupKeyManagement keySetWrite command #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:209 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L209) diff --git a/docs/matter.js/modules/cluster_export.Groups.md b/docs/matter.js/modules/cluster_export.Groups.md index 736e227c91..4c32eaa907 100644 --- a/docs/matter.js/modules/cluster_export.Groups.md +++ b/docs/matter.js/modules/cluster_export.Groups.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:296 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:296](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L296) ## Variables @@ -55,7 +55,7 @@ These elements and properties are present in all Groups clusters. #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:158 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L158) ___ @@ -90,7 +90,7 @@ GroupsCluster supports optional features that you can enable with the GroupsClus #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:275 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:275](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L275) ___ @@ -112,7 +112,7 @@ The value of the Groups nameSupport attribute #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:28 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L28) ___ @@ -128,7 +128,7 @@ Input to the Groups addGroupIfIdentifying command #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:136 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L136) ___ @@ -144,7 +144,7 @@ Input to the Groups addGroup command #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:40 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L40) ___ @@ -160,7 +160,7 @@ The AddGroupResponse is sent by the Groups cluster server in response to an AddG #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:50 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L50) ___ @@ -176,7 +176,7 @@ Input to the Groups getGroupMembership command #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:78 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L78) ___ @@ -216,7 +216,7 @@ GroupList field shall contain only as many groups as will fit. #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:109 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L109) ___ @@ -232,7 +232,7 @@ Input to the Groups removeGroup command #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:119 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L119) ___ @@ -248,7 +248,7 @@ The RemoveGroupResponse command is generated by the server in response to the re #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:126 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L126) ___ @@ -264,7 +264,7 @@ Input to the Groups viewGroup command #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:60 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L60) ___ @@ -280,4 +280,4 @@ The ViewGroupResponse command is sent by the Groups cluster server in response t #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:67 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L67) diff --git a/docs/matter.js/modules/cluster_export.Identify.md b/docs/matter.js/modules/cluster_export.Identify.md index 84cd28ee35..d101b74ce5 100644 --- a/docs/matter.js/modules/cluster_export.Identify.md +++ b/docs/matter.js/modules/cluster_export.Identify.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:312 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:312](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L312) ## Variables @@ -55,7 +55,7 @@ These elements and properties are present in all Identify clusters. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:179 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L179) ___ @@ -85,7 +85,7 @@ IdentifyCluster supports optional features that you can enable with the Identify #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:290 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:290](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L290) ___ @@ -100,7 +100,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:324 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:324](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L324) ___ @@ -112,7 +112,7 @@ A IdentifyCluster supports these elements if it supports feature Query. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:251 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L251) ___ @@ -129,7 +129,7 @@ case that the device is currently identifying itself. #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:152 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L152) ___ @@ -145,7 +145,7 @@ Input to the Identify identify command #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:65 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L65) ___ @@ -161,4 +161,4 @@ Input to the Identify triggerEffect command #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:120 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L120) diff --git a/docs/matter.js/modules/cluster_export.IlluminanceMeasurement.md b/docs/matter.js/modules/cluster_export.IlluminanceMeasurement.md index a9fe014285..953c2f5408 100644 --- a/docs/matter.js/modules/cluster_export.IlluminanceMeasurement.md +++ b/docs/matter.js/modules/cluster_export.IlluminanceMeasurement.md @@ -26,4 +26,4 @@ Attributes and commands for configuring the measurement of illuminance, and repo #### Defined in -packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:23 +[packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts#L23) diff --git a/docs/matter.js/modules/cluster_export.KeypadInput.md b/docs/matter.js/modules/cluster_export.KeypadInput.md index b64328e8cb..d027a3922e 100644 --- a/docs/matter.js/modules/cluster_export.KeypadInput.md +++ b/docs/matter.js/modules/cluster_export.KeypadInput.md @@ -37,7 +37,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:259 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:259](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L259) ## Variables @@ -49,7 +49,7 @@ These elements and properties are present in all KeypadInput clusters. #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:185 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:185](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L185) ___ @@ -71,7 +71,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:238 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L238) ___ @@ -87,7 +87,7 @@ Input to the KeypadInput sendKey command #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:111 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L111) ___ @@ -103,4 +103,4 @@ This command shall be generated in response to a SendKey command. #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:145 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:145](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L145) diff --git a/docs/matter.js/modules/cluster_export.LeafWetnessMeasurement.md b/docs/matter.js/modules/cluster_export.LeafWetnessMeasurement.md index 8d9955865f..3dc1f8206e 100644 --- a/docs/matter.js/modules/cluster_export.LeafWetnessMeasurement.md +++ b/docs/matter.js/modules/cluster_export.LeafWetnessMeasurement.md @@ -26,4 +26,4 @@ limited to, leaf wetness, relative humidity, and soil moisture. #### Defined in -packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:23 +[packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts#L23) diff --git a/docs/matter.js/modules/cluster_export.LevelControl.md b/docs/matter.js/modules/cluster_export.LevelControl.md index 344f9b6859..eeee0e1804 100644 --- a/docs/matter.js/modules/cluster_export.LevelControl.md +++ b/docs/matter.js/modules/cluster_export.LevelControl.md @@ -48,7 +48,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:474 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:474](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L474) ## Variables @@ -60,7 +60,7 @@ These elements and properties are present in all LevelControl clusters. #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:193 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:193](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L193) ___ @@ -82,7 +82,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:451 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:451](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L451) ___ @@ -97,7 +97,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:488 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:488](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L488) ___ @@ -109,7 +109,7 @@ A LevelControlCluster supports these elements if it supports feature Frequency. #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:405 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:405](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L405) ___ @@ -121,7 +121,7 @@ A LevelControlCluster supports these elements if it supports feature Lighting. #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:372 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:372](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L372) ___ @@ -144,7 +144,7 @@ The value of the LevelControl options attribute #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:31 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L31) ___ @@ -160,7 +160,7 @@ Input to the LevelControl move command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:55 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L55) ___ @@ -176,7 +176,7 @@ Input to the LevelControl moveToClosestFrequency command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:159 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:159](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L159) ___ @@ -192,7 +192,7 @@ Input to the LevelControl moveToLevel command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:38 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L38) ___ @@ -208,7 +208,7 @@ Input to the LevelControl moveToLevelWithOnOff command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:112 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L112) ___ @@ -224,7 +224,7 @@ Input to the LevelControl moveWithOnOff command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:124 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L124) ___ @@ -240,7 +240,7 @@ Input to the LevelControl step command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:89 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L89) ___ @@ -256,7 +256,7 @@ Input to the LevelControl stepWithOnOff command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:136 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L136) ___ @@ -272,7 +272,7 @@ Input to the LevelControl stop command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:102 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L102) ___ @@ -288,4 +288,4 @@ Input to the LevelControl stopWithOnOff command #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:149 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L149) diff --git a/docs/matter.js/modules/cluster_export.LocalizationConfiguration.md b/docs/matter.js/modules/cluster_export.LocalizationConfiguration.md index 5c6eebcdea..425d9fc9f9 100644 --- a/docs/matter.js/modules/cluster_export.LocalizationConfiguration.md +++ b/docs/matter.js/modules/cluster_export.LocalizationConfiguration.md @@ -32,4 +32,4 @@ localization information that a Node shall utilize when conveying values to a us #### Defined in -packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:29 +[packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts#L29) diff --git a/docs/matter.js/modules/cluster_export.LowPower.md b/docs/matter.js/modules/cluster_export.LowPower.md index c7e360159a..8b7c5c8724 100644 --- a/docs/matter.js/modules/cluster_export.LowPower.md +++ b/docs/matter.js/modules/cluster_export.LowPower.md @@ -26,4 +26,4 @@ This cluster provides an interface for managing low power mode on a device. #### Defined in -packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:22 +[packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LowPowerCluster.ts#L22) diff --git a/docs/matter.js/modules/cluster_export.MediaInput.md b/docs/matter.js/modules/cluster_export.MediaInput.md index 257d091c00..18d56ad093 100644 --- a/docs/matter.js/modules/cluster_export.MediaInput.md +++ b/docs/matter.js/modules/cluster_export.MediaInput.md @@ -39,7 +39,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:222 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:222](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L222) ## Variables @@ -51,7 +51,7 @@ These elements and properties are present in all MediaInput clusters. #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:120 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L120) ___ @@ -72,7 +72,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:200 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L200) ___ @@ -87,7 +87,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:234 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L234) ___ @@ -99,7 +99,7 @@ A MediaInputCluster supports these elements if it supports feature NameUpdates. #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:178 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:178](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L178) ___ @@ -115,7 +115,7 @@ This contains information about an input. #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:49 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L49) ___ @@ -131,7 +131,7 @@ Input to the MediaInput renameInput command #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:101 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L101) ___ @@ -147,4 +147,4 @@ Input to the MediaInput selectInput command #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:86 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:86](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L86) diff --git a/docs/matter.js/modules/cluster_export.MediaPlayback.md b/docs/matter.js/modules/cluster_export.MediaPlayback.md index 891654903e..03c482c4f1 100644 --- a/docs/matter.js/modules/cluster_export.MediaPlayback.md +++ b/docs/matter.js/modules/cluster_export.MediaPlayback.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:501 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:501](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L501) ## Variables @@ -55,7 +55,7 @@ A MediaPlaybackCluster supports these elements if it supports feature AdvancedSe #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:312 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:312](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L312) ___ @@ -67,7 +67,7 @@ These elements and properties are present in all MediaPlayback clusters. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:213 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L213) ___ @@ -89,7 +89,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:478 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:478](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L478) ___ @@ -104,7 +104,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:515 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:515](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L515) ___ @@ -120,7 +120,7 @@ This structure defines a playback position within a media stream being played. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:147 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L147) ___ @@ -136,7 +136,7 @@ This command shall be generated in response to various Playback Commands. #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:88 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L88) ___ @@ -152,7 +152,7 @@ Input to the MediaPlayback seek command #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:174 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:174](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L174) ___ @@ -168,7 +168,7 @@ Input to the MediaPlayback skipBackward command #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:128 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L128) ___ @@ -184,7 +184,7 @@ Input to the MediaPlayback skipForward command #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:109 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:109](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L109) ___ @@ -196,4 +196,4 @@ A MediaPlaybackCluster supports these elements if it supports feature VariableSp #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:427 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:427](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L427) diff --git a/docs/matter.js/modules/cluster_export.ModeSelect.md b/docs/matter.js/modules/cluster_export.ModeSelect.md index c615f389fd..eee9ee5244 100644 --- a/docs/matter.js/modules/cluster_export.ModeSelect.md +++ b/docs/matter.js/modules/cluster_export.ModeSelect.md @@ -38,7 +38,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:278 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:278](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L278) ## Variables @@ -50,7 +50,7 @@ These elements and properties are present in all ModeSelect clusters. #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:120 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L120) ___ @@ -87,7 +87,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:256 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:256](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L256) ___ @@ -102,7 +102,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:290 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:290](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L290) ___ @@ -114,7 +114,7 @@ A ModeSelectCluster supports these elements if it supports feature OnOff. #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:215 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L215) ___ @@ -130,7 +130,7 @@ Input to the ModeSelect changeToMode command #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:101 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L101) ___ @@ -146,7 +146,7 @@ This is a struct representing a possible mode of the server. #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:60 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L60) ___ @@ -162,4 +162,4 @@ A Semantic Tag is meant to be interpreted by the client for the purpose the clus #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:33 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L33) diff --git a/docs/matter.js/modules/cluster_export.NetworkCommissioning.md b/docs/matter.js/modules/cluster_export.NetworkCommissioning.md index 3fa2642330..4d2595f5f9 100644 --- a/docs/matter.js/modules/cluster_export.NetworkCommissioning.md +++ b/docs/matter.js/modules/cluster_export.NetworkCommissioning.md @@ -52,7 +52,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1121 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L1121) ## Variables @@ -64,7 +64,7 @@ These elements and properties are present in all NetworkCommissioning clusters. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:593 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:593](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L593) ___ @@ -97,7 +97,7 @@ NetworkCommissioningCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1081 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1081](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L1081) ___ @@ -112,7 +112,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1141 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L1141) ___ @@ -124,7 +124,7 @@ A NetworkCommissioningCluster supports these elements if it supports feature Thr #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1029 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1029](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L1029) ___ @@ -140,7 +140,7 @@ Input to the NetworkCommissioning addOrUpdateThreadNetwork command #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:545 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:545](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L545) ___ @@ -156,7 +156,7 @@ Input to the NetworkCommissioning addOrUpdateWiFiNetwork command #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:493 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:493](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L493) ___ @@ -172,7 +172,7 @@ Input to the NetworkCommissioning connectNetwork command #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:409 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:409](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L409) ___ @@ -217,7 +217,7 @@ See Section 11.8.7.2.2, “DebugText Field” for usage. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:448 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:448](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L448) ___ @@ -258,7 +258,7 @@ See Section 11.8.7.2.2, “DebugText Field” for usage. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:390 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:390](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L390) ___ @@ -274,7 +274,7 @@ NetworkInfoStruct struct describes an existing network configuration, as provide #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:26 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L26) ___ @@ -290,7 +290,7 @@ Input to the NetworkCommissioning removeNetwork command #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:355 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:355](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L355) ___ @@ -306,7 +306,7 @@ Input to the NetworkCommissioning reorderNetwork command #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:482 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:482](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L482) ___ @@ -322,7 +322,7 @@ Input to the NetworkCommissioning scanNetworks command #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:140 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:140](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L140) ___ @@ -344,7 +344,7 @@ NetworkingStatus matching the response. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:287 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:287](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L287) ___ @@ -360,7 +360,7 @@ ThreadInterfaceScanResultStruct represents a single Thread network scan result. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:258 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:258](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L258) ___ @@ -376,7 +376,7 @@ WiFiInterfaceScanResultStruct represents a single Wi-Fi network scan result. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:231 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L231) ___ @@ -388,7 +388,7 @@ A NetworkCommissioningCluster supports these elements if it supports feature WiF #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:997 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:997](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L997) ___ @@ -401,7 +401,7 @@ ThreadNetworkInterface. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:750 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:750](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L750) ___ @@ -428,4 +428,4 @@ WiFiInterfaceScanResultStruct. #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:166 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L166) diff --git a/docs/matter.js/modules/cluster_export.OccupancySensing.md b/docs/matter.js/modules/cluster_export.OccupancySensing.md index b0ebd412de..731a267ac8 100644 --- a/docs/matter.js/modules/cluster_export.OccupancySensing.md +++ b/docs/matter.js/modules/cluster_export.OccupancySensing.md @@ -32,7 +32,7 @@ Attributes and commands for configuring occupancy sensing, and reporting occupan #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:81 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L81) ___ @@ -54,7 +54,7 @@ All other bits are reserved. #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:22 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L22) ___ @@ -76,4 +76,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:57 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L57) diff --git a/docs/matter.js/modules/cluster_export.OnOff.md b/docs/matter.js/modules/cluster_export.OnOff.md index 02ca4744e7..26b3cc7ee0 100644 --- a/docs/matter.js/modules/cluster_export.OnOff.md +++ b/docs/matter.js/modules/cluster_export.OnOff.md @@ -40,7 +40,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:305 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:305](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L305) ## Variables @@ -52,7 +52,7 @@ These elements and properties are present in all OnOff clusters. #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:130 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L130) ___ @@ -72,7 +72,7 @@ OnOffCluster supports optional features that you can enable with the OnOffCluste #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:283 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L283) ___ @@ -87,7 +87,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:317 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:317](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L317) ___ @@ -99,7 +99,7 @@ A OnOffCluster supports these elements if it supports feature LevelControlForLig #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:181 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:181](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L181) ___ @@ -122,7 +122,7 @@ The value of OnOff.onOffControl #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:77 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L77) ___ @@ -138,7 +138,7 @@ Input to the OnOff offWithEffect command #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:51 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L51) ___ @@ -154,4 +154,4 @@ Input to the OnOff onWithTimedOff command #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:84 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L84) diff --git a/docs/matter.js/modules/cluster_export.OnOffSwitchConfiguration.md b/docs/matter.js/modules/cluster_export.OnOffSwitchConfiguration.md index 8232b8d033..e94fe2609f 100644 --- a/docs/matter.js/modules/cluster_export.OnOffSwitchConfiguration.md +++ b/docs/matter.js/modules/cluster_export.OnOffSwitchConfiguration.md @@ -27,4 +27,4 @@ Attributes and commands for configuring On/Off switching devices. #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:37 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L37) diff --git a/docs/matter.js/modules/cluster_export.OperationalCredentials.md b/docs/matter.js/modules/cluster_export.OperationalCredentials.md index 962f868f50..1642d24c66 100644 --- a/docs/matter.js/modules/cluster_export.OperationalCredentials.md +++ b/docs/matter.js/modules/cluster_export.OperationalCredentials.md @@ -46,7 +46,7 @@ the associated Fabrics. #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:515 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:515](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L515) ___ @@ -62,7 +62,7 @@ Input to the OperationalCredentials addNoc command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:234 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L234) ___ @@ -78,7 +78,7 @@ Input to the OperationalCredentials addTrustedRootCertificate command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:503 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:503](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L503) ___ @@ -94,7 +94,7 @@ Input to the OperationalCredentials attestationRequest command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:122 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:122](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L122) ___ @@ -115,7 +115,7 @@ See Section F.2, “Device Attestation Response test vector” for an example co #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:136 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L136) ___ @@ -131,7 +131,7 @@ Input to the OperationalCredentials certificateChainRequest command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:176 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:176](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L176) ___ @@ -147,7 +147,7 @@ This command shall be generated in response to a CertificateChainRequest command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:185 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:185](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L185) ___ @@ -163,7 +163,7 @@ Input to the OperationalCredentials csrRequest command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:200 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L200) ___ @@ -184,7 +184,7 @@ See Section F.3, “Node Operational CSR Response test vector” for an example #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:215 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L215) ___ @@ -200,7 +200,7 @@ This structure encodes a Fabric Reference for a fabric within which a given Node #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:65 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L65) ___ @@ -219,7 +219,7 @@ TrustedRootCertificates attribute of the Node Operational Credentials cluster. #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:40 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L40) ___ @@ -245,7 +245,7 @@ It provides status information about the success or failure of those commands. #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:444 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:444](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L444) ___ @@ -261,7 +261,7 @@ Input to the OperationalCredentials removeFabric command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:496 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:496](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L496) ___ @@ -277,7 +277,7 @@ Input to the OperationalCredentials updateFabricLabel command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:486 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:486](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L486) ___ @@ -293,4 +293,4 @@ Input to the OperationalCredentials updateNoc command #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:475 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:475](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L475) diff --git a/docs/matter.js/modules/cluster_export.OtaSoftwareUpdateProvider.md b/docs/matter.js/modules/cluster_export.OtaSoftwareUpdateProvider.md index 07e8a3e3e1..7b43a87712 100644 --- a/docs/matter.js/modules/cluster_export.OtaSoftwareUpdateProvider.md +++ b/docs/matter.js/modules/cluster_export.OtaSoftwareUpdateProvider.md @@ -37,7 +37,7 @@ Provides an interface for providing OTA software updates #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:164 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:164](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L164) ___ @@ -53,7 +53,7 @@ Input to the OtaSoftwareUpdateProvider applyUpdateRequest command #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:111 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L111) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:142 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L142) ___ @@ -83,7 +83,7 @@ Input to the OtaSoftwareUpdateProvider notifyUpdateApplied command #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:152 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:152](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L152) ___ @@ -99,7 +99,7 @@ Input to the OtaSoftwareUpdateProvider queryImage command #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:54 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L54) ___ @@ -113,4 +113,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:95 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L95) diff --git a/docs/matter.js/modules/cluster_export.OtaSoftwareUpdateRequestor.md b/docs/matter.js/modules/cluster_export.OtaSoftwareUpdateRequestor.md index d20e76e469..1dc2de51b6 100644 --- a/docs/matter.js/modules/cluster_export.OtaSoftwareUpdateRequestor.md +++ b/docs/matter.js/modules/cluster_export.OtaSoftwareUpdateRequestor.md @@ -37,7 +37,7 @@ Provides an interface for downloading and applying OTA software updates #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:202 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L202) ___ @@ -53,7 +53,7 @@ Input to the OtaSoftwareUpdateRequestor announceOtaProvider command #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:120 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L120) ___ @@ -69,7 +69,7 @@ Body of the OtaSoftwareUpdateRequestor downloadError event #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:188 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:188](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L188) ___ @@ -85,7 +85,7 @@ This structure encodes a fabric-scoped location of an OTA provider on a given fa #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:37 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L37) ___ @@ -101,7 +101,7 @@ Body of the OtaSoftwareUpdateRequestor stateTransition event #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:166 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L166) ___ @@ -117,4 +117,4 @@ Body of the OtaSoftwareUpdateRequestor versionApplied event #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:178 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:178](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L178) diff --git a/docs/matter.js/modules/cluster_export.PowerSource.md b/docs/matter.js/modules/cluster_export.PowerSource.md index 8bfcef98a6..433c246b0a 100644 --- a/docs/matter.js/modules/cluster_export.PowerSource.md +++ b/docs/matter.js/modules/cluster_export.PowerSource.md @@ -51,7 +51,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1332 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1332](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1332) ## Variables @@ -63,7 +63,7 @@ These elements and properties are present in all PowerSource clusters. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:899 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:899](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L899) ___ @@ -75,7 +75,7 @@ A PowerSourceCluster supports these elements if it supports feature Battery. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1061 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1061](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1061) ___ @@ -99,7 +99,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1307 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1307](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1307) ___ @@ -114,7 +114,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1351 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1351](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1351) ___ @@ -126,7 +126,7 @@ A PowerSourceCluster supports these elements if it supports feature Rechargeable #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1225 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1225) ___ @@ -138,7 +138,7 @@ A PowerSourceCluster supports these elements if it supports feature Replaceable. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1162 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1162) ___ @@ -154,7 +154,7 @@ Body of the PowerSource batChargeFaultChange event #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:856 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:856](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L856) ___ @@ -170,7 +170,7 @@ Body of the PowerSource batFaultChange event #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:181 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:181](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L181) ___ @@ -186,7 +186,7 @@ Body of the PowerSource wiredFaultChange event #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:93 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:93](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L93) ___ @@ -198,4 +198,4 @@ A PowerSourceCluster supports these elements if it supports feature Wired. #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:968 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:968](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L968) diff --git a/docs/matter.js/modules/cluster_export.PowerSourceConfiguration.md b/docs/matter.js/modules/cluster_export.PowerSourceConfiguration.md index afdb88d5be..821cc2c463 100644 --- a/docs/matter.js/modules/cluster_export.PowerSourceConfiguration.md +++ b/docs/matter.js/modules/cluster_export.PowerSourceConfiguration.md @@ -27,4 +27,4 @@ ordering overview as well as linking to the one or more endpoints each supportin #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:24 +[packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts#L24) diff --git a/docs/matter.js/modules/cluster_export.PressureMeasurement.md b/docs/matter.js/modules/cluster_export.PressureMeasurement.md index 2af28784cd..3dc1bc624d 100644 --- a/docs/matter.js/modules/cluster_export.PressureMeasurement.md +++ b/docs/matter.js/modules/cluster_export.PressureMeasurement.md @@ -35,7 +35,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:177 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:177](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L177) ## Variables @@ -47,7 +47,7 @@ These elements and properties are present in all PressureMeasurement clusters. #### Defined in -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:34 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L34) ___ @@ -69,7 +69,7 @@ PressureMeasurementCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:155 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L155) ___ @@ -84,7 +84,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:190 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L190) ___ @@ -96,4 +96,4 @@ A PressureMeasurementCluster supports these elements if it supports feature Exte #### Defined in -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:94 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L94) diff --git a/docs/matter.js/modules/cluster_export.ProxyConfiguration.md b/docs/matter.js/modules/cluster_export.ProxyConfiguration.md index 599b783956..98bb8432c8 100644 --- a/docs/matter.js/modules/cluster_export.ProxyConfiguration.md +++ b/docs/matter.js/modules/cluster_export.ProxyConfiguration.md @@ -27,7 +27,7 @@ This cluster provides a means for a proxy-capable device to be told the set of N #### Defined in -packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:43 +[packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts#L43) ___ @@ -51,4 +51,4 @@ specifically proxy. #### Defined in -packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:31 +[packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts#L31) diff --git a/docs/matter.js/modules/cluster_export.ProxyDiscovery.md b/docs/matter.js/modules/cluster_export.ProxyDiscovery.md index ba4ab6d86a..76b6234784 100644 --- a/docs/matter.js/modules/cluster_export.ProxyDiscovery.md +++ b/docs/matter.js/modules/cluster_export.ProxyDiscovery.md @@ -28,4 +28,4 @@ Discovery” and Section 9.15.7.4, “Step 3: Proxy Response” steps of the ove #### Defined in -packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:24 +[packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts#L24) diff --git a/docs/matter.js/modules/cluster_export.PulseWidthModulation.md b/docs/matter.js/modules/cluster_export.PulseWidthModulation.md index ffa86d0f58..9887f840a1 100644 --- a/docs/matter.js/modules/cluster_export.PulseWidthModulation.md +++ b/docs/matter.js/modules/cluster_export.PulseWidthModulation.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:428 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:428](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L428) ## Variables @@ -55,7 +55,7 @@ These elements and properties are present in all PulseWidthModulation clusters. #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:147 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:147](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L147) ___ @@ -77,7 +77,7 @@ PulseWidthModulationCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:405 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:405](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L405) ___ @@ -92,7 +92,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:442 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:442](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L442) ___ @@ -104,7 +104,7 @@ A PulseWidthModulationCluster supports these elements if it supports feature Fre #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:359 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:359](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L359) ___ @@ -116,7 +116,7 @@ A PulseWidthModulationCluster supports these elements if it supports feature Lig #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:326 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:326](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L326) ___ @@ -139,7 +139,7 @@ The value of the PulseWidthModulation options attribute #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:32 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L32) ___ @@ -155,7 +155,7 @@ Input to the PulseWidthModulation move command #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:61 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L61) ___ @@ -171,7 +171,7 @@ Input to the PulseWidthModulation moveToClosestFrequency command #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:113 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L113) ___ @@ -187,7 +187,7 @@ Input to the PulseWidthModulation moveToLevel command #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:39 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L39) ___ @@ -203,7 +203,7 @@ Input to the PulseWidthModulation step command #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:90 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L90) ___ @@ -219,4 +219,4 @@ Input to the PulseWidthModulation stop command #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:103 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L103) diff --git a/docs/matter.js/modules/cluster_export.PumpConfigurationAndControl.md b/docs/matter.js/modules/cluster_export.PumpConfigurationAndControl.md index c8683e80d4..5b52f06dd0 100644 --- a/docs/matter.js/modules/cluster_export.PumpConfigurationAndControl.md +++ b/docs/matter.js/modules/cluster_export.PumpConfigurationAndControl.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:950 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:950](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L950) ## Variables @@ -55,7 +55,7 @@ A PumpConfigurationAndControlCluster supports these elements if it supports feat #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:666 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:666](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L666) ___ @@ -67,7 +67,7 @@ These elements and properties are present in all PumpConfigurationAndControl clu #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:271 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:271](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L271) ___ @@ -90,7 +90,7 @@ PumpConfigurationAndControlCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:910 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:910](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L910) ___ @@ -102,7 +102,7 @@ A PumpConfigurationAndControlCluster supports these elements if it supports feat #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:784 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:784](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L784) ___ @@ -117,7 +117,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:974 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:974](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L974) ___ @@ -129,7 +129,7 @@ A PumpConfigurationAndControlCluster supports these elements if it supports feat #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:840 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:840](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L840) ___ @@ -141,7 +141,7 @@ A PumpConfigurationAndControlCluster supports these elements if it supports feat #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:637 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:637](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L637) ___ @@ -153,7 +153,7 @@ A PumpConfigurationAndControlCluster supports these elements if it supports feat #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:813 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:813](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L813) ___ @@ -165,7 +165,7 @@ A PumpConfigurationAndControlCluster supports these elements if it supports feat #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:870 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:870](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L870) ___ @@ -193,4 +193,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:31 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L31) diff --git a/docs/matter.js/modules/cluster_export.RelativeHumidityMeasurement.md b/docs/matter.js/modules/cluster_export.RelativeHumidityMeasurement.md index 556128853e..d009983fa2 100644 --- a/docs/matter.js/modules/cluster_export.RelativeHumidityMeasurement.md +++ b/docs/matter.js/modules/cluster_export.RelativeHumidityMeasurement.md @@ -28,4 +28,4 @@ limited to, leaf wetness, relative humidity, and soil moisture. #### Defined in -packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:25 +[packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts#L25) diff --git a/docs/matter.js/modules/cluster_export.Scenes.md b/docs/matter.js/modules/cluster_export.Scenes.md index e7fc1ce0c5..d9bd1c7399 100644 --- a/docs/matter.js/modules/cluster_export.Scenes.md +++ b/docs/matter.js/modules/cluster_export.Scenes.md @@ -52,7 +52,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:557 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:557](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L557) ## Variables @@ -64,7 +64,7 @@ These elements and properties are present in all Scenes clusters. #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:338 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L338) ___ @@ -96,7 +96,7 @@ ScenesCluster supports optional features that you can enable with the ScenesClus #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:536 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:536](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L536) ___ @@ -119,7 +119,7 @@ The value of Scenes.mode #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:231 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L231) ___ @@ -141,7 +141,7 @@ The value of the Scenes nameSupport attribute #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:39 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L39) ___ @@ -157,7 +157,7 @@ Input to the Scenes addScene command #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:88 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L88) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:99 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L99) ___ @@ -187,7 +187,7 @@ This data type indicates a combination of an identifier and the value of an attr #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:51 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L51) ___ @@ -203,7 +203,7 @@ Input to the Scenes copyScene command #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:238 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:238](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L238) ___ @@ -219,7 +219,7 @@ The CopySceneResponse command allows a server to respond to a CopyScene command. #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:293 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:293](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L293) ___ @@ -237,7 +237,7 @@ field. #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:78 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L78) ___ @@ -253,7 +253,7 @@ Input to the Scenes getSceneMembership command #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:190 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L190) ___ @@ -291,7 +291,7 @@ frame to be exceeded, then the SceneList field shall contain only as many scenes #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:219 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:219](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L219) ___ @@ -307,7 +307,7 @@ Input to the Scenes recallScene command #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:179 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L179) ___ @@ -323,7 +323,7 @@ Input to the Scenes removeAllScenes command #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:148 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L148) ___ @@ -337,7 +337,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:153 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L153) ___ @@ -353,7 +353,7 @@ Input to the Scenes removeScene command #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:129 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L129) ___ @@ -367,7 +367,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:137 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:137](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L137) ___ @@ -383,7 +383,7 @@ Input to the Scenes storeScene command #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:163 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L163) ___ @@ -397,7 +397,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:168 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:168](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L168) ___ @@ -413,7 +413,7 @@ Input to the Scenes viewScene command #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:110 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L110) ___ @@ -427,4 +427,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:115 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L115) diff --git a/docs/matter.js/modules/cluster_export.SoftwareDiagnostics.md b/docs/matter.js/modules/cluster_export.SoftwareDiagnostics.md index e8df35b963..039ff1900e 100644 --- a/docs/matter.js/modules/cluster_export.SoftwareDiagnostics.md +++ b/docs/matter.js/modules/cluster_export.SoftwareDiagnostics.md @@ -37,7 +37,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:240 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L240) ## Variables @@ -49,7 +49,7 @@ These elements and properties are present in all SoftwareDiagnostics clusters. #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:112 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L112) ___ @@ -72,7 +72,7 @@ SoftwareDiagnosticsCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:218 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:218](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L218) ___ @@ -87,7 +87,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:252 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:252](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L252) ___ @@ -103,7 +103,7 @@ Body of the SoftwareDiagnostics softwareFault event #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:81 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L81) ___ @@ -117,7 +117,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:31 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L31) ___ @@ -129,4 +129,4 @@ A SoftwareDiagnosticsCluster supports these elements if it supports feature Wate #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:170 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L170) diff --git a/docs/matter.js/modules/cluster_export.SoilMoistureMeasurement.md b/docs/matter.js/modules/cluster_export.SoilMoistureMeasurement.md index c1ca2add58..f6c84dbe10 100644 --- a/docs/matter.js/modules/cluster_export.SoilMoistureMeasurement.md +++ b/docs/matter.js/modules/cluster_export.SoilMoistureMeasurement.md @@ -26,4 +26,4 @@ limited to, leaf wetness, relative humidity, and soil moisture. #### Defined in -packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:23 +[packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts#L23) diff --git a/docs/matter.js/modules/cluster_export.Switch.md b/docs/matter.js/modules/cluster_export.Switch.md index f05e8920b8..a4c46e8156 100644 --- a/docs/matter.js/modules/cluster_export.Switch.md +++ b/docs/matter.js/modules/cluster_export.Switch.md @@ -46,7 +46,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:371 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:371](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L371) ## Variables @@ -58,7 +58,7 @@ These elements and properties are present in all Switch clusters. #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:107 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L107) ___ @@ -89,7 +89,7 @@ SwitchCluster supports optional features that you can enable with the SwitchClus #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:333 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:333](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L333) ___ @@ -104,7 +104,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:399 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:399](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L399) ___ @@ -116,7 +116,7 @@ A SwitchCluster supports these elements if it supports feature LatchingSwitch. #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:227 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L227) ___ @@ -128,7 +128,7 @@ A SwitchCluster supports these elements if it supports feature MomentarySwitch. #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:244 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L244) ___ @@ -140,7 +140,7 @@ A SwitchCluster supports these elements if it supports feature MomentarySwitchLo #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:260 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:260](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L260) ___ @@ -152,7 +152,7 @@ A SwitchCluster supports these elements if it supports feature MomentarySwitchMu #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:163 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:163](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L163) ___ @@ -164,7 +164,7 @@ A SwitchCluster supports these elements if it supports feature MomentarySwitchRe #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:290 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:290](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L290) ___ @@ -180,7 +180,7 @@ Body of the Switch initialPress event #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:49 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L49) ___ @@ -196,7 +196,7 @@ Body of the Switch longPress event #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:56 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L56) ___ @@ -212,7 +212,7 @@ Body of the Switch longRelease event #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:63 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L63) ___ @@ -228,7 +228,7 @@ Body of the Switch multiPressComplete event #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:32 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L32) ___ @@ -244,7 +244,7 @@ Body of the Switch multiPressOngoing event #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:22 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L22) ___ @@ -260,7 +260,7 @@ Body of the Switch shortRelease event #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:70 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L70) ___ @@ -276,4 +276,4 @@ Body of the Switch switchLatched event #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:42 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L42) diff --git a/docs/matter.js/modules/cluster_export.TargetNavigator.md b/docs/matter.js/modules/cluster_export.TargetNavigator.md index ebacc749d3..ecc7ff5a0b 100644 --- a/docs/matter.js/modules/cluster_export.TargetNavigator.md +++ b/docs/matter.js/modules/cluster_export.TargetNavigator.md @@ -33,7 +33,7 @@ This cluster provides an interface for UX navigation within a set of targets on #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:110 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L110) ___ @@ -49,7 +49,7 @@ Input to the TargetNavigator navigateTarget command #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:45 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L45) ___ @@ -65,7 +65,7 @@ This command shall be generated in response to NavigateTarget command. #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:87 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L87) ___ @@ -81,4 +81,4 @@ This indicates an object describing the navigable target. #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:24 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L24) diff --git a/docs/matter.js/modules/cluster_export.TemperatureMeasurement.md b/docs/matter.js/modules/cluster_export.TemperatureMeasurement.md index 116d25d574..dcecaf393e 100644 --- a/docs/matter.js/modules/cluster_export.TemperatureMeasurement.md +++ b/docs/matter.js/modules/cluster_export.TemperatureMeasurement.md @@ -27,4 +27,4 @@ provision of notifications of temperature measurements. #### Defined in -packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:24 +[packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts#L24) diff --git a/docs/matter.js/modules/cluster_export.Thermostat.md b/docs/matter.js/modules/cluster_export.Thermostat.md index e5273655ae..7d455d6982 100644 --- a/docs/matter.js/modules/cluster_export.Thermostat.md +++ b/docs/matter.js/modules/cluster_export.Thermostat.md @@ -69,7 +69,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1537 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1537](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1537) ## Variables @@ -95,7 +95,7 @@ The value of the Thermostat acErrorCode attribute #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:336 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:336](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L336) ___ @@ -119,7 +119,7 @@ The value of the Thermostat alarmMask attribute #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:136 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L136) ___ @@ -131,7 +131,7 @@ A ThermostatCluster supports these elements if it supports feature AutoMode. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1274 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1274](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1274) ___ @@ -143,7 +143,7 @@ These elements and properties are present in all Thermostat clusters. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:579 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:579](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L579) ___ @@ -164,7 +164,7 @@ method. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1494 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1494](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1494) ___ @@ -179,7 +179,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1570 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1570](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1570) ___ @@ -191,7 +191,7 @@ A ThermostatCluster supports these elements if it supports features Cooling and #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1228 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1228](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1228) ___ @@ -203,7 +203,7 @@ A ThermostatCluster supports these elements if it supports feature Cooling. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1111 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1111) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:456 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:456](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L456) ___ @@ -238,7 +238,7 @@ A ThermostatCluster supports these elements if it supports features Heating and #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1251 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1251](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1251) ___ @@ -250,7 +250,7 @@ A ThermostatCluster supports these elements if it supports feature Heating. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1019 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1019](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1019) ___ @@ -267,7 +267,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:467 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:467](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L467) ___ @@ -279,7 +279,7 @@ A ThermostatCluster supports these elements if doesn't support feature LTNE. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1201 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1201](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1201) ___ @@ -301,7 +301,7 @@ The value of the Thermostat occupancy attribute #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:428 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:428](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L428) ___ @@ -313,7 +313,7 @@ A ThermostatCluster supports these elements if it supports feature Occupancy. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:999 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:999](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L999) ___ @@ -337,7 +337,7 @@ The value of the Thermostat remoteSensing attribute #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:36 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L36) ___ @@ -349,7 +349,7 @@ A ThermostatCluster supports these elements if it supports feature ScheduleConfi #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1308 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1308](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1308) ___ @@ -361,7 +361,7 @@ A ThermostatCluster supports these elements if it supports features Setback and #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1426 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1426](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1426) ___ @@ -373,7 +373,7 @@ A ThermostatCluster supports these elements if it supports feature Setback. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1365 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1365](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1365) ___ @@ -397,7 +397,7 @@ The value of the Thermostat thermostatProgrammingOperationMode attribute #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:164 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:164](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L164) ___ @@ -425,7 +425,7 @@ The value of the Thermostat thermostatRunningState attribute #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:186 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:186](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L186) ___ @@ -441,7 +441,7 @@ Input to the Thermostat getWeeklySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:505 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:505](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L505) ___ @@ -455,7 +455,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:513 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:513](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L513) ___ @@ -471,7 +471,7 @@ Input to the Thermostat setWeeklySchedule command #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:493 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:493](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L493) ___ @@ -487,7 +487,7 @@ Input to the Thermostat setpointRaiseLower command #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:418 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:418](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L418) ___ @@ -503,4 +503,4 @@ This represents a single transition in a Thermostat schedule #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:474 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:474](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L474) diff --git a/docs/matter.js/modules/cluster_export.ThermostatUserInterfaceConfiguration.md b/docs/matter.js/modules/cluster_export.ThermostatUserInterfaceConfiguration.md index e8fea849f3..24d0672fc0 100644 --- a/docs/matter.js/modules/cluster_export.ThermostatUserInterfaceConfiguration.md +++ b/docs/matter.js/modules/cluster_export.ThermostatUserInterfaceConfiguration.md @@ -33,4 +33,4 @@ thermostat controller device, that supports a keypad and LCD screen. #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:94 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L94) diff --git a/docs/matter.js/modules/cluster_export.ThreadNetworkDiagnostics.md b/docs/matter.js/modules/cluster_export.ThreadNetworkDiagnostics.md index cbbb3b0173..435a8520c0 100644 --- a/docs/matter.js/modules/cluster_export.ThreadNetworkDiagnostics.md +++ b/docs/matter.js/modules/cluster_export.ThreadNetworkDiagnostics.md @@ -46,7 +46,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1174 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1174](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L1174) ## Variables @@ -58,7 +58,7 @@ These elements and properties are present in all ThreadNetworkDiagnostics cluste #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:480 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:480](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L480) ___ @@ -82,7 +82,7 @@ ThreadNetworkDiagnosticsCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1150 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L1150) ___ @@ -97,7 +97,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1191 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1191](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L1191) ___ @@ -109,7 +109,7 @@ A ThreadNetworkDiagnosticsCluster supports these elements if it supports feature #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:714 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:714](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L714) ___ @@ -121,7 +121,7 @@ A ThreadNetworkDiagnosticsCluster supports these elements if it supports feature #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:821 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:821](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L821) ___ @@ -133,7 +133,7 @@ A ThreadNetworkDiagnosticsCluster supports these elements if it supports feature #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:744 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:744](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L744) ___ @@ -149,7 +149,7 @@ Body of the ThreadNetworkDiagnostics connectionStatus event #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:416 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:416](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L416) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:74 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L74) ___ @@ -179,7 +179,7 @@ Body of the ThreadNetworkDiagnostics networkFaultChange event #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:423 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:423](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L423) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:283 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:283](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L283) ___ @@ -212,7 +212,7 @@ This field shall specify the RLOC16 for the Node for which this route table entr #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:196 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L196) ___ @@ -226,4 +226,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:262 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:262](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L262) diff --git a/docs/matter.js/modules/cluster_export.TimeFormatLocalization.md b/docs/matter.js/modules/cluster_export.TimeFormatLocalization.md index c33ac65103..c26a62514c 100644 --- a/docs/matter.js/modules/cluster_export.TimeFormatLocalization.md +++ b/docs/matter.js/modules/cluster_export.TimeFormatLocalization.md @@ -37,7 +37,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:213 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L213) ## Variables @@ -49,7 +49,7 @@ These elements and properties are present in all TimeFormatLocalization clusters #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:115 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L115) ___ @@ -61,7 +61,7 @@ A TimeFormatLocalizationCluster supports these elements if it supports feature C #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:149 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L149) ___ @@ -87,7 +87,7 @@ TimeFormatLocalizationCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:191 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:191](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L191) ___ @@ -102,4 +102,4 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:225 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:225](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L225) diff --git a/docs/matter.js/modules/cluster_export.TimeSync.md b/docs/matter.js/modules/cluster_export.TimeSync.md index d4dcd59469..8fc9fd4fb1 100644 --- a/docs/matter.js/modules/cluster_export.TimeSync.md +++ b/docs/matter.js/modules/cluster_export.TimeSync.md @@ -44,7 +44,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:600 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:600](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L600) ## Variables @@ -56,7 +56,7 @@ These elements and properties are present in all TimeSync clusters. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:291 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L291) ___ @@ -84,7 +84,7 @@ TimeSyncCluster supports optional features that you can enable with the TimeSync #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:576 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:576](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L576) ___ @@ -99,7 +99,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:617 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:617](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L617) ___ @@ -111,7 +111,7 @@ A TimeSyncCluster supports these elements if it supports feature NtpClient. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:394 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:394](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L394) ___ @@ -123,7 +123,7 @@ A TimeSyncCluster supports these elements if it supports feature NtpServer. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:544 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:544](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L544) ___ @@ -135,7 +135,7 @@ A TimeSyncCluster supports these elements if it supports feature TimeZone. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:416 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:416](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L416) ___ @@ -153,7 +153,7 @@ assumptions. #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:231 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L231) ___ @@ -169,7 +169,7 @@ Input to the TimeSync setUtcTime command #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:165 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:165](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L165) ___ @@ -185,7 +185,7 @@ Body of the TimeSync timeZoneStatus event #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:255 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:255](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L255) ___ @@ -199,4 +199,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:200 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L200) diff --git a/docs/matter.js/modules/cluster_export.UnitLocalization.md b/docs/matter.js/modules/cluster_export.UnitLocalization.md index 69df745557..5557b4c29c 100644 --- a/docs/matter.js/modules/cluster_export.UnitLocalization.md +++ b/docs/matter.js/modules/cluster_export.UnitLocalization.md @@ -36,7 +36,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:127 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L127) ## Variables @@ -48,7 +48,7 @@ These elements and properties are present in all UnitLocalization clusters. #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:54 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L54) ___ @@ -75,7 +75,7 @@ factory method. #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:105 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L105) ___ @@ -90,7 +90,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:139 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:139](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L139) ___ @@ -102,4 +102,4 @@ A UnitLocalizationCluster supports these elements if it supports feature Tempera #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:72 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L72) diff --git a/docs/matter.js/modules/cluster_export.UserLabel.md b/docs/matter.js/modules/cluster_export.UserLabel.md index 2c9cb2d2f7..61af2c2ad8 100644 --- a/docs/matter.js/modules/cluster_export.UserLabel.md +++ b/docs/matter.js/modules/cluster_export.UserLabel.md @@ -26,4 +26,4 @@ This cluster provides a feature to tag an endpoint with zero or more labels. #### Defined in -packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:23 +[packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UserLabelCluster.ts#L23) diff --git a/docs/matter.js/modules/cluster_export.ValidProxies.md b/docs/matter.js/modules/cluster_export.ValidProxies.md index ca5cd4a5e3..026fe9db7d 100644 --- a/docs/matter.js/modules/cluster_export.ValidProxies.md +++ b/docs/matter.js/modules/cluster_export.ValidProxies.md @@ -28,7 +28,7 @@ subscriptions on its behalf as per Section 9.15.7, “Proxy Discovery & Assignme #### Defined in -packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:33 +[packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts#L33) ___ @@ -44,4 +44,4 @@ Encapsulates the Node ID of a Valid Proxy. #### Defined in -packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:23 +[packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts#L23) diff --git a/docs/matter.js/modules/cluster_export.WakeOnLan.md b/docs/matter.js/modules/cluster_export.WakeOnLan.md index a165391d6d..1141f69bbb 100644 --- a/docs/matter.js/modules/cluster_export.WakeOnLan.md +++ b/docs/matter.js/modules/cluster_export.WakeOnLan.md @@ -27,4 +27,4 @@ On Wireless LAN (WLAN) protocol (see [Wake On LAN]). #### Defined in -packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:23 +[packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts#L23) diff --git a/docs/matter.js/modules/cluster_export.WiFiNetworkDiagnostics.md b/docs/matter.js/modules/cluster_export.WiFiNetworkDiagnostics.md index 41931884ab..c071a25705 100644 --- a/docs/matter.js/modules/cluster_export.WiFiNetworkDiagnostics.md +++ b/docs/matter.js/modules/cluster_export.WiFiNetworkDiagnostics.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:449 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:449](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L449) ## Variables @@ -55,7 +55,7 @@ These elements and properties are present in all WiFiNetworkDiagnostics clusters #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:215 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L215) ___ @@ -78,7 +78,7 @@ WiFiNetworkDiagnosticsCluster.with() factory method. #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:426 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:426](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L426) ___ @@ -93,7 +93,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:463 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:463](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L463) ___ @@ -105,7 +105,7 @@ A WiFiNetworkDiagnosticsCluster supports these elements if it supports feature E #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:321 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:321](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L321) ___ @@ -117,7 +117,7 @@ A WiFiNetworkDiagnosticsCluster supports these elements if it supports feature P #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:369 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:369](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L369) ___ @@ -133,7 +133,7 @@ Body of the WiFiNetworkDiagnostics associationFailure event #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:142 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L142) ___ @@ -149,7 +149,7 @@ Body of the WiFiNetworkDiagnostics connectionStatus event #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:188 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:188](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L188) ___ @@ -165,4 +165,4 @@ Body of the WiFiNetworkDiagnostics disconnection event #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:102 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:102](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L102) diff --git a/docs/matter.js/modules/cluster_export.WindowCovering.md b/docs/matter.js/modules/cluster_export.WindowCovering.md index f09cf16de6..9541f88a5a 100644 --- a/docs/matter.js/modules/cluster_export.WindowCovering.md +++ b/docs/matter.js/modules/cluster_export.WindowCovering.md @@ -53,7 +53,7 @@ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:958 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:958](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L958) ## Variables @@ -65,7 +65,7 @@ These elements and properties are present in all WindowCovering clusters. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:365 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:365](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L365) ___ @@ -87,7 +87,7 @@ factory method. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:913 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:913](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L913) ___ @@ -102,7 +102,7 @@ features is legal per the Matter specification. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:988 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:988](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L988) ___ @@ -130,7 +130,7 @@ The value of the WindowCovering configStatus attribute #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:59 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L59) ___ @@ -142,7 +142,7 @@ A WindowCoveringCluster supports these elements if it supports features Lift and #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:869 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:869](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L869) ___ @@ -155,7 +155,7 @@ AbsolutePosition. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:562 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:562](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L562) ___ @@ -167,7 +167,7 @@ A WindowCoveringCluster supports these elements if it supports features Lift and #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:734 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:734](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L734) ___ @@ -179,7 +179,7 @@ A WindowCoveringCluster supports these elements if it supports feature Lift. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:657 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:657](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L657) ___ @@ -204,7 +204,7 @@ The value of the WindowCovering mode attribute #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:181 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:181](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L181) ___ @@ -228,7 +228,7 @@ The value of the WindowCovering operationalStatus attribute #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:106 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L106) ___ @@ -261,7 +261,7 @@ The value of the WindowCovering safetyStatus attribute #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:221 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:221](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L221) ___ @@ -273,7 +273,7 @@ A WindowCoveringCluster supports these elements if it supports features Tilt and #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:887 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:887](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L887) ___ @@ -286,7 +286,7 @@ AbsolutePosition. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:610 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:610](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L610) ___ @@ -298,7 +298,7 @@ A WindowCoveringCluster supports these elements if it supports features Tilt and #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:801 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:801](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L801) ___ @@ -310,7 +310,7 @@ A WindowCoveringCluster supports these elements if it supports feature Tilt. #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:695 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:695](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L695) ___ @@ -326,7 +326,7 @@ Input to the WindowCovering goToLiftPercentage command #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:291 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:291](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L291) ___ @@ -342,7 +342,7 @@ Input to the WindowCovering goToLiftValue command #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:311 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:311](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L311) ___ @@ -358,7 +358,7 @@ Input to the WindowCovering goToTiltPercentage command #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:301 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:301](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L301) ___ @@ -374,4 +374,4 @@ Input to the WindowCovering goToTiltValue command #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:318 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:318](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L318) diff --git a/docs/matter.js/modules/cluster_export.md b/docs/matter.js/modules/cluster_export.md index e4abfc0cd9..469010ba1b 100644 --- a/docs/matter.js/modules/cluster_export.md +++ b/docs/matter.js/modules/cluster_export.md @@ -101,11 +101,11 @@ - [FixedAttributeServer](../classes/cluster_export.FixedAttributeServer.md) - [GroupsManager](../classes/cluster_export.GroupsManager.md) - [IllegalClusterError](../classes/cluster_export.IllegalClusterError.md) -- [PresentAttributeClient](../classes/cluster_export.PresentAttributeClient.md) -- [PresentEventClient](../classes/cluster_export.PresentEventClient.md) - [ScenesManager](../classes/cluster_export.ScenesManager.md) -- [UnknownPresentAttributeClient](../classes/cluster_export.UnknownPresentAttributeClient.md) -- [UnknownPresentEventClient](../classes/cluster_export.UnknownPresentEventClient.md) +- [SupportedAttributeClient](../classes/cluster_export.SupportedAttributeClient.md) +- [SupportedEventClient](../classes/cluster_export.SupportedEventClient.md) +- [UnknownSupportedAttributeClient](../classes/cluster_export.UnknownSupportedAttributeClient.md) +- [UnknownSupportedEventClient](../classes/cluster_export.UnknownSupportedEventClient.md) ### Interfaces @@ -397,9 +397,9 @@ #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:463 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:463](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L463) -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:464 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:464](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L464) ___ @@ -409,9 +409,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:200 +[packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts#L200) -packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:201 +[packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:201](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts#L201) ___ @@ -421,9 +421,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:836 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:836](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L836) -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:837 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:837](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L837) ___ @@ -433,9 +433,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:388 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:388](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L388) -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:389 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:389](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L389) ___ @@ -451,7 +451,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:29 +[packages/matter.js/src/cluster/server/AttributeServer.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L29) ___ @@ -461,9 +461,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:156 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L156) -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:157 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L157) ___ @@ -473,9 +473,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:338 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L338) -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:339 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L339) ___ @@ -492,7 +492,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:40 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L41) ___ @@ -510,7 +510,7 @@ Initial values for the cluster attribute #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:73 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L76) ___ @@ -526,7 +526,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:108 +[packages/matter.js/src/cluster/Cluster.ts:108](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L108) ___ @@ -542,7 +542,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:77 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L80) ___ @@ -558,7 +558,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:70 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L73) ___ @@ -568,9 +568,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:213 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L213) -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:214 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L214) ___ @@ -580,9 +580,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:239 +[packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:239](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts#L239) -packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:240 +[packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts#L240) ___ @@ -592,9 +592,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:51 +[packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts#L51) -packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:52 +[packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts#L52) ___ @@ -604,9 +604,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:435 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:435](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L435) -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:436 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:436](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L436) ___ @@ -616,9 +616,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:41 +[packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts#L41) -packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:42 +[packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts#L42) ___ @@ -628,9 +628,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BindingCluster.ts:114 +[packages/matter.js/src/cluster/definitions/BindingCluster.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BindingCluster.ts#L114) -packages/matter.js/src/cluster/definitions/BindingCluster.ts:115 +[packages/matter.js/src/cluster/definitions/BindingCluster.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BindingCluster.ts#L115) ___ @@ -640,9 +640,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:57 +[packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts#L57) -packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:58 +[packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts#L58) ___ @@ -652,9 +652,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:228 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L227) -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:229 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:228](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L228) ___ @@ -664,9 +664,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:404 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:404](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L404) -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:405 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:405](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L405) ___ @@ -676,15 +676,15 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:84 +[packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts#L84) -packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:85 +[packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts#L85) ___ ### ClusterClientObj -Ƭ **ClusterClientObj**<`F`, `A`, `C`, `E`\>: { `_type`: ``"ClusterClient"`` ; `attributes`: [`AttributeClients`](cluster_export.md#attributeclients)<`F`, `A`\> ; `commands`: [`CommandServers`](export._internal_.md#commandservers)<`C`\> ; `endpointId`: `number` ; `events`: [`EventClients`](cluster_export.md#eventclients)<`E`\> ; `id`: [`ClusterId`](datatype_export.md#clusterid) ; `isUnknown`: `boolean` ; `name`: `string` ; `revision`: `number` ; `subscribeAllAttributes`: (`options`: { `dataVersionFilters?`: { `clusterId`: [`ClusterId`](datatype_export.md#clusterid) ; `dataVersion`: `number` ; `endpointId`: [`EndpointNumber`](datatype_export.md#endpointnumber) }[] ; `eventFilters?`: [`TypeFromSchema`](tlv_export.md#typefromschema)[] ; `isFabricFiltered?`: `boolean` ; `keepSubscriptions?`: `boolean` ; `maxIntervalCeilingSeconds`: `number` ; `minIntervalFloorSeconds`: `number` }) => `Promise`<`void`\> ; `supportedFeatures`: [`TypeFromPartialBitSchema`](schema_export.md#typefrompartialbitschema)<`F`\> } & [`ClientAttributeGetters`](export._internal_.md#clientattributegetters)<`A`\> & [`ClientGlobalAttributeGetters`](export._internal_.md#clientglobalattributegetters)<`F`\> & [`ClientAttributeSetters`](export._internal_.md#clientattributesetters)<`A`\> & [`ClientAttributeSubscribers`](export._internal_.md#clientattributesubscribers)<`A`\> & [`ClientAttributeListeners`](export._internal_.md#clientattributelisteners)<`A`\> & [`CommandServers`](export._internal_.md#commandservers)<`C`\> & [`ClientEventGetters`](export._internal_.md#clienteventgetters)<`E`\> & [`ClientEventSubscribers`](export._internal_.md#clienteventsubscribers)<`E`\> & [`ClientEventListeners`](export._internal_.md#clienteventlisteners)<`E`\> +Ƭ **ClusterClientObj**<`F`, `A`, `C`, `E`\>: { `_type`: ``"ClusterClient"`` ; `attributes`: [`AttributeClients`](cluster_export.md#attributeclients)<`F`, `A`\> ; `commands`: [`CommandServers`](export._internal_.md#commandservers)<`C`\> ; `endpointId`: `number` ; `events`: [`EventClients`](cluster_export.md#eventclients)<`E`\> ; `id`: [`ClusterId`](datatype_export.md#clusterid) ; `isAttributeSupported`: (`attributeId`: [`AttributeId`](datatype_export.md#attributeid)) => `boolean` ; `isAttributeSupportedByName`: (`attributeName`: `string`) => `boolean` ; `isCommandSupported`: (`commandId`: [`CommandId`](datatype_export.md#commandid)) => `boolean` ; `isCommandSupportedByName`: (`commandName`: `string`) => `boolean` ; `isEventSupported`: (`eventId`: [`EventId`](datatype_export.md#eventid)) => `boolean` ; `isEventSupportedByName`: (`eventName`: `string`) => `boolean` ; `isUnknown`: `boolean` ; `name`: `string` ; `revision`: `number` ; `subscribeAllAttributes`: (`options`: { `dataVersionFilters?`: { `clusterId`: [`ClusterId`](datatype_export.md#clusterid) ; `dataVersion`: `number` ; `endpointId`: [`EndpointNumber`](datatype_export.md#endpointnumber) }[] ; `eventFilters?`: [`TypeFromSchema`](tlv_export.md#typefromschema)[] ; `isFabricFiltered?`: `boolean` ; `keepSubscriptions?`: `boolean` ; `maxIntervalCeilingSeconds`: `number` ; `minIntervalFloorSeconds`: `number` }) => `Promise`<`void`\> ; `supportedFeatures`: [`TypeFromPartialBitSchema`](schema_export.md#typefrompartialbitschema)<`F`\> } & [`ClientAttributeGetters`](export._internal_.md#clientattributegetters)<`A`\> & [`ClientGlobalAttributeGetters`](export._internal_.md#clientglobalattributegetters)<`F`\> & [`ClientAttributeSetters`](export._internal_.md#clientattributesetters)<`A`\> & [`ClientAttributeSubscribers`](export._internal_.md#clientattributesubscribers)<`A`\> & [`ClientAttributeListeners`](export._internal_.md#clientattributelisteners)<`A`\> & [`CommandServers`](export._internal_.md#commandservers)<`C`\> & [`ClientEventGetters`](export._internal_.md#clienteventgetters)<`E`\> & [`ClientEventSubscribers`](export._internal_.md#clienteventsubscribers)<`E`\> & [`ClientEventListeners`](export._internal_.md#clienteventlisteners)<`E`\> Strongly typed interface of a cluster client @@ -699,7 +699,7 @@ Strongly typed interface of a cluster client #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:141 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L142) ___ @@ -715,7 +715,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:133 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L134) ___ @@ -734,7 +734,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:229 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:248](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L248) ___ @@ -750,13 +750,13 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:132 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L135) ___ ### ClusterServerObj -Ƭ **ClusterServerObj**<`A`, `E`\>: { `_type`: ``"ClusterServer"`` ; `attributes`: [`AttributeServers`](cluster_export.md#attributeservers)<`A`\> ; `clusterDataVersion`: `number` ; `id`: [`ClusterId`](datatype_export.md#clusterid) ; `name`: `string` } & [`ServerAttributeGetters`](export._internal_.md#serverattributegetters)<`A`\> & [`ServerAttributeSetters`](export._internal_.md#serverattributesetters)<`A`\> & [`ServerAttributeSubscribers`](export._internal_.md#serverattributesubscribers)<`A`\> & [`ServerEventTriggers`](export._internal_.md#servereventtriggers)<`E`\> +Ƭ **ClusterServerObj**<`A`, `E`\>: { `_type`: ``"ClusterServer"`` ; `attributes`: [`AttributeServers`](cluster_export.md#attributeservers)<`A`\> ; `clusterDataVersion`: `number` ; `id`: [`ClusterId`](datatype_export.md#clusterid) ; `isAttributeSupported`: (`attributeId`: [`AttributeId`](datatype_export.md#attributeid)) => `boolean` ; `isAttributeSupportedByName`: (`attributeName`: `string`) => `boolean` ; `isCommandSupported`: (`commandId`: [`CommandId`](datatype_export.md#commandid)) => `boolean` ; `isCommandSupportedByName`: (`commandName`: `string`) => `boolean` ; `isEventSupported`: (`eventId`: [`EventId`](datatype_export.md#eventid)) => `boolean` ; `isEventSupportedByName`: (`eventName`: `string`) => `boolean` ; `name`: `string` } & [`ServerAttributeGetters`](export._internal_.md#serverattributegetters)<`A`\> & [`ServerAttributeSetters`](export._internal_.md#serverattributesetters)<`A`\> & [`ServerAttributeSubscribers`](export._internal_.md#serverattributesubscribers)<`A`\> & [`ServerEventTriggers`](export._internal_.md#servereventtriggers)<`E`\> #### Type parameters @@ -767,7 +767,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:260 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L263) ___ @@ -783,7 +783,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:255 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:258](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L258) ___ @@ -803,7 +803,7 @@ Strongly typed interface of a cluster server #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:297 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:318](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L318) ___ @@ -813,9 +813,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1760 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1760](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1760) -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1761 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1761](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1761) ___ @@ -833,7 +833,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:108 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L111) ___ @@ -849,7 +849,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:147 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L150) ___ @@ -865,7 +865,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:32 +[packages/matter.js/src/cluster/Cluster.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L32) ___ @@ -875,9 +875,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:621 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:621](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L621) -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:622 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:622](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L622) ___ @@ -887,9 +887,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:105 +[packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DescriptorCluster.ts#L105) -packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:106 +[packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DescriptorCluster.ts#L106) ___ @@ -899,9 +899,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:263 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L263) -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:264 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L264) ___ @@ -911,9 +911,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2780 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2780](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2780) -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2781 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2781](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2781) ___ @@ -923,9 +923,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:181 +[packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:181](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts#L181) -packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:182 +[packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:182](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts#L182) ___ @@ -935,9 +935,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:338 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L338) -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:339 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L339) ___ @@ -953,7 +953,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:48 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L49) ___ @@ -969,7 +969,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:243 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:246](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L246) ___ @@ -985,7 +985,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:809 +[packages/matter.js/src/cluster/Cluster.ts:809](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L809) ___ @@ -1001,7 +1001,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:197 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L200) ___ @@ -1011,9 +1011,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:419 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:419](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L419) -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:420 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:420](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L420) ___ @@ -1023,9 +1023,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:69 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L69) -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:70 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L70) ___ @@ -1035,9 +1035,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:45 +[packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts#L45) -packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:46 +[packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts#L46) ___ @@ -1047,9 +1047,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:70 +[packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts#L70) -packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:71 +[packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts#L71) ___ @@ -1059,9 +1059,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:500 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:500](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L500) -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:501 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:501](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L501) ___ @@ -1071,9 +1071,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:616 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:616](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L616) -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:617 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:617](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L617) ___ @@ -1089,7 +1089,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:593 +[packages/matter.js/src/cluster/Cluster.ts:593](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L593) ___ @@ -1120,9 +1120,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:836 +[packages/matter.js/src/cluster/Cluster.ts:836](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L836) -packages/matter.js/src/cluster/Cluster.ts:856 +[packages/matter.js/src/cluster/Cluster.ts:856](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L856) ___ @@ -1132,9 +1132,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:484 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:484](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L484) -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:485 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:485](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L485) ___ @@ -1144,9 +1144,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:301 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:301](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L301) -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:302 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:302](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L302) ___ @@ -1156,9 +1156,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:337 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:337](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L337) -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:338 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L338) ___ @@ -1168,9 +1168,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:83 +[packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts#L83) -packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:84 +[packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts#L84) ___ @@ -1180,9 +1180,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:264 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L264) -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:265 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L265) ___ @@ -1192,9 +1192,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:74 +[packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts#L74) -packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:75 +[packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts#L75) ___ @@ -1204,9 +1204,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:528 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:528](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L528) -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:529 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:529](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L529) ___ @@ -1216,9 +1216,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:64 +[packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts#L64) -packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:65 +[packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts#L65) ___ @@ -1228,9 +1228,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:38 +[packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LowPowerCluster.ts#L38) -packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:39 +[packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LowPowerCluster.ts#L39) ___ @@ -1246,7 +1246,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:587 +[packages/matter.js/src/cluster/Cluster.ts:587](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L587) ___ @@ -1262,7 +1262,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:814 +[packages/matter.js/src/cluster/Cluster.ts:814](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L814) ___ @@ -1272,9 +1272,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:247 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L247) -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:248 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:248](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L248) ___ @@ -1284,9 +1284,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:555 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:555](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L555) -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:556 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:556](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L556) ___ @@ -1296,9 +1296,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:303 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L303) -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:304 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:304](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L304) ___ @@ -1308,9 +1308,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1188 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1188](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L1188) -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1189 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1189](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L1189) ___ @@ -1326,7 +1326,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:206 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L209) ___ @@ -1336,9 +1336,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:236 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L236) -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:237 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L237) ___ @@ -1348,9 +1348,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:361 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:361](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L361) -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:362 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:362](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L362) ___ @@ -1360,9 +1360,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:48 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L48) -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:49 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L49) ___ @@ -1372,9 +1372,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:895 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:895](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L895) -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:896 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:896](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L896) ___ @@ -1390,7 +1390,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:590 +[packages/matter.js/src/cluster/Cluster.ts:590](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L590) ___ @@ -1406,7 +1406,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:817 +[packages/matter.js/src/cluster/Cluster.ts:817](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L817) ___ @@ -1416,9 +1416,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:227 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L227) -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:228 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:228](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L228) ___ @@ -1428,9 +1428,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:316 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:316](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L316) -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:317 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:317](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L317) ___ @@ -1440,9 +1440,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1478 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1478](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1478) -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1479 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1479](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1479) ___ @@ -1452,9 +1452,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:48 +[packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts#L48) -packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:49 +[packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts#L49) ___ @@ -1464,9 +1464,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:216 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L216) -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:217 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L217) ___ @@ -1476,9 +1476,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:63 +[packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts#L63) -packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:64 +[packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts#L64) ___ @@ -1488,9 +1488,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:38 +[packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts#L38) -packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:39 +[packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts#L39) ___ @@ -1500,9 +1500,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:482 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:482](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L482) -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:483 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:483](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L483) ___ @@ -1512,9 +1512,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:1028 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:1028](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L1028) -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:1029 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:1029](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L1029) ___ @@ -1524,9 +1524,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:76 +[packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts#L76) -packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:77 +[packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts#L77) ___ @@ -1542,7 +1542,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:625 +[packages/matter.js/src/cluster/Cluster.ts:625](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L625) ___ @@ -1558,7 +1558,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:620 +[packages/matter.js/src/cluster/Cluster.ts:620](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L620) ___ @@ -1568,9 +1568,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:562 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:562](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L562) -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:563 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:563](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L563) ___ @@ -1604,7 +1604,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:53 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L54) ___ @@ -1614,9 +1614,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:277 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:277](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L277) -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:278 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:278](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L278) ___ @@ -1626,9 +1626,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:74 +[packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts#L74) -packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:75 +[packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts#L75) ___ @@ -1644,7 +1644,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:250 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:253](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L253) ___ @@ -1654,9 +1654,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:446 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:446](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L446) -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:447 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:447](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L447) ___ @@ -1666,9 +1666,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:149 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L149) -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:150 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L150) ___ @@ -1678,9 +1678,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:72 +[packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts#L72) -packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:73 +[packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts#L73) ___ @@ -1690,9 +1690,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1703 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1703](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1703) -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1704 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1704](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1704) ___ @@ -1702,9 +1702,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:153 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L153) -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:154 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L154) ___ @@ -1714,9 +1714,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1384 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1384](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L1384) -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1385 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1385](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L1385) ___ @@ -1726,9 +1726,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:245 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:245](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L245) -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:246 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:246](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L246) ___ @@ -1738,9 +1738,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:652 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:652](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L652) -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:653 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:653](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L653) ___ @@ -1750,9 +1750,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:154 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L154) -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:155 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L155) ___ @@ -1762,9 +1762,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:44 +[packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UserLabelCluster.ts#L44) -packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:45 +[packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UserLabelCluster.ts#L45) ___ @@ -1774,9 +1774,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:60 +[packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts#L60) -packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:61 +[packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts#L61) ___ @@ -1786,9 +1786,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:54 +[packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts#L54) -packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:55 +[packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts#L55) ___ @@ -1798,9 +1798,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:512 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:512](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L512) -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:513 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:513](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L513) ___ @@ -1810,9 +1810,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1084 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1084](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L1084) -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1085 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1085](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L1085) ## Variables @@ -1822,9 +1822,9 @@ packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1085 #### Defined in -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:463 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:463](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L463) -packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:464 +[packages/matter.js/src/cluster/definitions/AccessControlCluster.ts:464](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccessControlCluster.ts#L464) ___ @@ -1834,9 +1834,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:200 +[packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts#L200) -packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:201 +[packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts:201](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AccountLoginCluster.ts#L201) ___ @@ -1846,9 +1846,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:836 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:836](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L836) -packages/matter.js/src/cluster/definitions/ActionsCluster.ts:837 +[packages/matter.js/src/cluster/definitions/ActionsCluster.ts:837](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ActionsCluster.ts#L837) ___ @@ -1858,9 +1858,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:388 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:388](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L388) -packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:389 +[packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts:389](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AdministratorCommissioningCluster.ts#L389) ___ @@ -1874,7 +1874,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:21 +[packages/matter.js/src/cluster/ClusterHelper.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L21) ___ @@ -1884,9 +1884,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:156 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L156) -packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:157 +[packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts:157](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationBasicCluster.ts#L157) ___ @@ -1896,9 +1896,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:338 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L338) -packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:339 +[packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ApplicationLauncherCluster.ts#L339) ___ @@ -1908,9 +1908,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:213 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L213) -packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:214 +[packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/AudioOutputCluster.ts#L214) ___ @@ -1920,9 +1920,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:239 +[packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:239](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts#L239) -packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:240 +[packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts:240](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BallastConfigurationCluster.ts#L240) ___ @@ -1932,21 +1932,21 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:51 +[packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts#L51) -packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:52 +[packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BarrierControlCluster.ts#L52) ___ ### BasicInformationCluster -• **BasicInformationCluster**: [`Definition`](cluster_export.ClusterFactory.md#definition)<{ `attributes`: { `capabilityMinima`: [`FixedAttribute`](cluster_export.md#fixedattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](cluster_export.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](cluster_export.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](cluster_export.md#fixedattribute)<[`VendorId`](datatype_export.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `fabricIndex`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`FabricIndex`](datatype_export.md#fabricindex)\> }\>, `any`\> ; `reachableChanged`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `startUp`: [`Event`](cluster_export.md#event)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``40`` = 0x28; `name`: ``"BasicInformation"`` = "BasicInformation"; `revision`: ``2`` = 2 }\> +• **BasicInformationCluster**: [`Definition`](cluster_export.ClusterFactory.md#definition)<{ `attributes`: { `capabilityMinima`: [`FixedAttribute`](cluster_export.md#fixedattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `caseSessionsPerFabric`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> ; `subscriptionsPerFabric`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> ; `dataModelRevision`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersion`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `localConfigDisabled`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`boolean`, `any`\> ; `location`: [`WritableAttribute`](cluster_export.md#writableattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`WritableAttribute`](cluster_export.md#writableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BasicInformation.Color.md)\> }\>, `any`\> ; `productId`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`FixedAttribute`](cluster_export.md#fixedattribute)<[`VendorId`](datatype_export.md#vendorid), `any`\> ; `vendorName`: [`FixedAttribute`](cluster_export.md#fixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `fabricIndex`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`FabricIndex`](datatype_export.md#fabricindex)\> }\>, `any`\> ; `reachableChanged`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `startUp`: [`Event`](cluster_export.md#event)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``40`` = 0x28; `name`: ``"BasicInformation"`` = "BasicInformation"; `revision`: ``2`` = 2 }\> #### Defined in -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:435 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:435](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L435) -packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:436 +[packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts:436](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BasicInformationCluster.ts#L436) ___ @@ -1956,9 +1956,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:41 +[packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts#L41) -packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:42 +[packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BinaryInputBasicCluster.ts#L42) ___ @@ -1968,9 +1968,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BindingCluster.ts:114 +[packages/matter.js/src/cluster/definitions/BindingCluster.ts:114](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BindingCluster.ts#L114) -packages/matter.js/src/cluster/definitions/BindingCluster.ts:115 +[packages/matter.js/src/cluster/definitions/BindingCluster.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BindingCluster.ts#L115) ___ @@ -1980,21 +1980,21 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:57 +[packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts#L57) -packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:58 +[packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BooleanStateCluster.ts#L58) ___ ### BridgedDeviceBasicInformationCluster -• **BridgedDeviceBasicInformationCluster**: [`Definition`](cluster_export.ClusterFactory.md#definition)<{ `attributes`: { `hardwareVersion`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](cluster_export.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<[`VendorId`](datatype_export.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `reachableChanged`: [`Event`](cluster_export.md#event)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `startUp`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``57`` = 0x39; `name`: ``"BridgedDeviceBasicInformation"`` = "BridgedDeviceBasicInformation"; `revision`: ``2`` = 2 }\> +• **BridgedDeviceBasicInformationCluster**: [`Definition`](cluster_export.ClusterFactory.md#definition)<{ `attributes`: { `hardwareVersion`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `hardwareVersionString`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `manufacturingDate`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `nodeLabel`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`string`, `any`\> ; `partNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productAppearance`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `finish`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<[`ProductFinish`](../enums/cluster_export.BridgedDeviceBasicInformation.ProductFinish.md)\> ; `primaryColor`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<``null`` \| [`Color`](../enums/cluster_export.BridgedDeviceBasicInformation.Color.md)\> }\>, `any`\> ; `productLabel`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productName`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `productUrl`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `reachable`: [`Attribute`](cluster_export.md#attribute)<`boolean`, `any`\> ; `serialNumber`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `softwareVersion`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`number`, `any`\> ; `softwareVersionString`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `uniqueId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> ; `vendorId`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<[`VendorId`](datatype_export.md#vendorid), `any`\> ; `vendorName`: [`OptionalFixedAttribute`](cluster_export.md#optionalfixedattribute)<`string`, `any`\> } ; `events`: { `leave`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `reachableChanged`: [`Event`](cluster_export.md#event)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `reachableNewValue`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`boolean`\> }\>, `any`\> ; `shutDown`: [`OptionalEvent`](cluster_export.md#optionalevent)<`void`, `any`\> ; `startUp`: [`OptionalEvent`](cluster_export.md#optionalevent)<[`TypeFromFields`](tlv_export.md#typefromfields)<{ `softwareVersion`: [`FieldType`](../interfaces/tlv_export.FieldType.md)<`number`\> }\>, `any`\> } ; `id`: ``57`` = 0x39; `name`: ``"BridgedDeviceBasicInformation"`` = "BridgedDeviceBasicInformation"; `revision`: ``2`` = 2 }\> #### Defined in -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:228 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L227) -packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:229 +[packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts:228](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/BridgedDeviceBasicInformationCluster.ts#L228) ___ @@ -2004,9 +2004,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:404 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:404](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L404) -packages/matter.js/src/cluster/definitions/ChannelCluster.ts:405 +[packages/matter.js/src/cluster/definitions/ChannelCluster.ts:405](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ChannelCluster.ts#L405) ___ @@ -2016,9 +2016,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:84 +[packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts#L84) -packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:85 +[packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ClientMonitoringCluster.ts#L85) ___ @@ -2028,9 +2028,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1760 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1760](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1760) -packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1761 +[packages/matter.js/src/cluster/definitions/ColorControlCluster.ts:1761](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ColorControlCluster.ts#L1761) ___ @@ -2040,9 +2040,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:621 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:621](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L621) -packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:622 +[packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts:622](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ContentLauncherCluster.ts#L622) ___ @@ -2052,9 +2052,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:105 +[packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DescriptorCluster.ts#L105) -packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:106 +[packages/matter.js/src/cluster/definitions/DescriptorCluster.ts:106](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DescriptorCluster.ts#L106) ___ @@ -2064,9 +2064,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:263 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:263](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L263) -packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:264 +[packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DiagnosticLogsCluster.ts#L264) ___ @@ -2076,9 +2076,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2780 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2780](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2780) -packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2781 +[packages/matter.js/src/cluster/definitions/DoorLockCluster.ts:2781](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/DoorLockCluster.ts#L2781) ___ @@ -2088,9 +2088,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:181 +[packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:181](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts#L181) -packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:182 +[packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts:182](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ElectricalMeasurementCluster.ts#L182) ___ @@ -2100,9 +2100,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:338 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L338) -packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:339 +[packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts:339](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/EthernetNetworkDiagnosticsCluster.ts#L339) ___ @@ -2112,9 +2112,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:419 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:419](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L419) -packages/matter.js/src/cluster/definitions/FanControlCluster.ts:420 +[packages/matter.js/src/cluster/definitions/FanControlCluster.ts:420](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FanControlCluster.ts#L420) ___ @@ -2124,9 +2124,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:69 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L69) -packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:70 +[packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FaultInjectionCluster.ts#L70) ___ @@ -2136,9 +2136,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:45 +[packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts#L45) -packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:46 +[packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FixedLabelCluster.ts#L46) ___ @@ -2148,9 +2148,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:70 +[packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts#L70) -packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:71 +[packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/FlowMeasurementCluster.ts#L71) ___ @@ -2160,9 +2160,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:500 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:500](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L500) -packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:501 +[packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts:501](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralCommissioningCluster.ts#L501) ___ @@ -2172,9 +2172,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:616 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:616](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L616) -packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:617 +[packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts:617](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GeneralDiagnosticsCluster.ts#L617) ___ @@ -2184,9 +2184,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:484 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:484](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L484) -packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:485 +[packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts:485](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupKeyManagementCluster.ts#L485) ___ @@ -2196,9 +2196,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:301 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:301](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L301) -packages/matter.js/src/cluster/definitions/GroupsCluster.ts:302 +[packages/matter.js/src/cluster/definitions/GroupsCluster.ts:302](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/GroupsCluster.ts#L302) ___ @@ -2208,9 +2208,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:337 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:337](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L337) -packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:338 +[packages/matter.js/src/cluster/definitions/IdentifyCluster.ts:338](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IdentifyCluster.ts#L338) ___ @@ -2220,9 +2220,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:83 +[packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts#L83) -packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:84 +[packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/IlluminanceMeasurementCluster.ts#L84) ___ @@ -2232,9 +2232,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:264 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L264) -packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:265 +[packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts:265](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/KeypadInputCluster.ts#L265) ___ @@ -2244,9 +2244,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:74 +[packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts#L74) -packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:75 +[packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LeafWetnessMeasurementCluster.ts#L75) ___ @@ -2256,9 +2256,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:528 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:528](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L528) -packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:529 +[packages/matter.js/src/cluster/definitions/LevelControlCluster.ts:529](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LevelControlCluster.ts#L529) ___ @@ -2268,9 +2268,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:64 +[packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts#L64) -packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:65 +[packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LocalizationConfigurationCluster.ts#L65) ___ @@ -2280,9 +2280,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:38 +[packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LowPowerCluster.ts#L38) -packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:39 +[packages/matter.js/src/cluster/definitions/LowPowerCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/LowPowerCluster.ts#L39) ___ @@ -2292,7 +2292,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts:24 +[packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts#L24) ___ @@ -2302,7 +2302,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts:25 +[packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts#L25) ___ @@ -2312,9 +2312,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:247 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:247](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L247) -packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:248 +[packages/matter.js/src/cluster/definitions/MediaInputCluster.ts:248](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaInputCluster.ts#L248) ___ @@ -2324,9 +2324,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:555 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:555](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L555) -packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:556 +[packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts:556](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/MediaPlaybackCluster.ts#L556) ___ @@ -2336,9 +2336,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:303 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:303](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L303) -packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:304 +[packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts:304](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ModeSelectCluster.ts#L304) ___ @@ -2348,9 +2348,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1188 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1188](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L1188) -packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1189 +[packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts:1189](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/NetworkCommissioningCluster.ts#L1189) ___ @@ -2360,9 +2360,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:236 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:236](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L236) -packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:237 +[packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts:237](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OccupancySensingCluster.ts#L237) ___ @@ -2372,9 +2372,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:361 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:361](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L361) -packages/matter.js/src/cluster/definitions/OnOffCluster.ts:362 +[packages/matter.js/src/cluster/definitions/OnOffCluster.ts:362](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffCluster.ts#L362) ___ @@ -2384,9 +2384,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:48 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L48) -packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:49 +[packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OnOffSwitchConfigurationCluster.ts#L49) ___ @@ -2396,9 +2396,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:895 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:895](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L895) -packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:896 +[packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts:896](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OperationalCredentialsCluster.ts#L896) ___ @@ -2408,9 +2408,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:227 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L227) -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:228 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts:228](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateProviderCluster.ts#L228) ___ @@ -2420,9 +2420,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:316 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:316](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L316) -packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:317 +[packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts:317](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/OtaSoftwareUpdateRequestorCluster.ts#L317) ___ @@ -2432,9 +2432,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1478 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1478](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1478) -packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1479 +[packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts:1479](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceCluster.ts#L1479) ___ @@ -2444,9 +2444,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:48 +[packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts#L48) -packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:49 +[packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PowerSourceConfigurationCluster.ts#L49) ___ @@ -2456,9 +2456,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:216 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L216) -packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:217 +[packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PressureMeasurementCluster.ts#L217) ___ @@ -2468,9 +2468,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:63 +[packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts#L63) -packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:64 +[packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyConfigurationCluster.ts#L64) ___ @@ -2480,9 +2480,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:38 +[packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts#L38) -packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:39 +[packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ProxyDiscoveryCluster.ts#L39) ___ @@ -2492,9 +2492,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:482 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:482](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L482) -packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:483 +[packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts:483](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PulseWidthModulationCluster.ts#L483) ___ @@ -2504,9 +2504,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:1028 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:1028](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L1028) -packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:1029 +[packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts:1029](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/PumpConfigurationAndControlCluster.ts#L1029) ___ @@ -2516,9 +2516,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:76 +[packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts#L76) -packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:77 +[packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/RelativeHumidityMeasurementCluster.ts#L77) ___ @@ -2528,9 +2528,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:562 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:562](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L562) -packages/matter.js/src/cluster/definitions/ScenesCluster.ts:563 +[packages/matter.js/src/cluster/definitions/ScenesCluster.ts:563](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ScenesCluster.ts#L563) ___ @@ -2540,9 +2540,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:277 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:277](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L277) -packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:278 +[packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts:278](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoftwareDiagnosticsCluster.ts#L278) ___ @@ -2552,9 +2552,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:74 +[packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts#L74) -packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:75 +[packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SoilMoistureMeasurementCluster.ts#L75) ___ @@ -2564,9 +2564,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:446 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:446](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L446) -packages/matter.js/src/cluster/definitions/SwitchCluster.ts:447 +[packages/matter.js/src/cluster/definitions/SwitchCluster.ts:447](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/SwitchCluster.ts#L447) ___ @@ -2576,9 +2576,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:149 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:149](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L149) -packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:150 +[packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts:150](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TargetNavigatorCluster.ts#L150) ___ @@ -2588,9 +2588,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:72 +[packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts#L72) -packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:73 +[packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TemperatureMeasurementCluster.ts#L73) ___ @@ -2600,9 +2600,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1703 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1703](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1703) -packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1704 +[packages/matter.js/src/cluster/definitions/ThermostatCluster.ts:1704](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatCluster.ts#L1704) ___ @@ -2612,9 +2612,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:153 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:153](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L153) -packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:154 +[packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThermostatUserInterfaceConfigurationCluster.ts#L154) ___ @@ -2624,9 +2624,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1384 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1384](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L1384) -packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1385 +[packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts:1385](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ThreadNetworkDiagnosticsCluster.ts#L1385) ___ @@ -2636,9 +2636,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:245 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:245](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L245) -packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:246 +[packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts:246](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeFormatLocalizationCluster.ts#L246) ___ @@ -2648,9 +2648,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:652 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:652](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L652) -packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:653 +[packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts:653](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/TimeSyncCluster.ts#L653) ___ @@ -2664,7 +2664,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:39 +[packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts#L39) ___ @@ -2678,7 +2678,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:47 +[packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts#L47) ___ @@ -2688,7 +2688,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:596 +[packages/matter.js/src/cluster/Cluster.ts:596](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L596) ___ @@ -2698,9 +2698,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:154 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L154) -packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:155 +[packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UnitLocalizationCluster.ts#L155) ___ @@ -2710,9 +2710,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:44 +[packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UserLabelCluster.ts#L44) -packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:45 +[packages/matter.js/src/cluster/definitions/UserLabelCluster.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/UserLabelCluster.ts#L45) ___ @@ -2722,9 +2722,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:60 +[packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts#L60) -packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:61 +[packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/ValidProxiesCluster.ts#L61) ___ @@ -2734,9 +2734,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:54 +[packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts#L54) -packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:55 +[packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WakeOnLanCluster.ts#L55) ___ @@ -2746,9 +2746,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:512 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:512](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L512) -packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:513 +[packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts:513](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WiFiNetworkDiagnosticsCluster.ts#L513) ___ @@ -2758,9 +2758,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1084 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1084](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L1084) -packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1085 +[packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1085](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts#L1085) ## Functions @@ -2774,7 +2774,7 @@ packages/matter.js/src/cluster/definitions/WindowCoveringCluster.ts:1085 #### Defined in -packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts:182 +[packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts#L183) ___ @@ -2804,7 +2804,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:125 +[packages/matter.js/src/cluster/Cluster.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L125) ___ @@ -2818,7 +2818,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts:212 +[packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts:213](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AdministratorCommissioningServer.ts#L213) ___ @@ -2857,7 +2857,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:884 +[packages/matter.js/src/cluster/Cluster.ts:884](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L884) ___ @@ -2889,7 +2889,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClient.ts:42 +[packages/matter.js/src/cluster/client/ClusterClient.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClient.ts#L42) ___ @@ -2924,7 +2924,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:935 +[packages/matter.js/src/cluster/Cluster.ts:935](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L935) ___ @@ -2958,7 +2958,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServer.ts:49 +[packages/matter.js/src/cluster/server/ClusterServer.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServer.ts#L49) ___ @@ -2990,7 +2990,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:641 +[packages/matter.js/src/cluster/Cluster.ts:641](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L641) ___ @@ -3020,7 +3020,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:185 +[packages/matter.js/src/cluster/Cluster.ts:185](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L185) ___ @@ -3052,7 +3052,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:679 +[packages/matter.js/src/cluster/Cluster.ts:679](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L679) ___ @@ -3082,7 +3082,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:780 +[packages/matter.js/src/cluster/Cluster.ts:780](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L780) ___ @@ -3112,7 +3112,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:533 +[packages/matter.js/src/cluster/Cluster.ts:533](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L533) ___ @@ -3142,7 +3142,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:281 +[packages/matter.js/src/cluster/Cluster.ts:281](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L281) ___ @@ -3172,7 +3172,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:409 +[packages/matter.js/src/cluster/Cluster.ts:409](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L409) ___ @@ -3202,7 +3202,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:746 +[packages/matter.js/src/cluster/Cluster.ts:746](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L746) ___ @@ -3232,7 +3232,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:315 +[packages/matter.js/src/cluster/Cluster.ts:315](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L315) ___ @@ -3262,7 +3262,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:443 +[packages/matter.js/src/cluster/Cluster.ts:443](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L443) ___ @@ -3284,7 +3284,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GeneralCommissioningServer.ts:20 +[packages/matter.js/src/cluster/server/GeneralCommissioningServer.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GeneralCommissioningServer.ts#L20) ___ @@ -3310,7 +3310,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:856 +[packages/matter.js/src/cluster/Cluster.ts:856](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L856) ___ @@ -3324,7 +3324,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GroupKeyManagementServer.ts:13 +[packages/matter.js/src/cluster/server/GroupKeyManagementServer.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupKeyManagementServer.ts#L13) ___ @@ -3338,7 +3338,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GroupsServer.ts:79 +[packages/matter.js/src/cluster/server/GroupsServer.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupsServer.ts#L79) ___ @@ -3352,7 +3352,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/LevelControlServer.ts:14 +[packages/matter.js/src/cluster/server/LevelControlServer.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/LevelControlServer.ts#L14) ___ @@ -3366,7 +3366,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/OnOffServer.ts:16 +[packages/matter.js/src/cluster/server/OnOffServer.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OnOffServer.ts#L16) ___ @@ -3386,7 +3386,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:63 +[packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OperationalCredentialsServer.ts#L63) ___ @@ -3416,7 +3416,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:155 +[packages/matter.js/src/cluster/Cluster.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L155) ___ @@ -3448,7 +3448,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:660 +[packages/matter.js/src/cluster/Cluster.ts:660](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L660) ___ @@ -3478,7 +3478,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:763 +[packages/matter.js/src/cluster/Cluster.ts:763](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L763) ___ @@ -3508,7 +3508,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:503 +[packages/matter.js/src/cluster/Cluster.ts:503](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L503) ___ @@ -3538,7 +3538,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:249 +[packages/matter.js/src/cluster/Cluster.ts:249](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L249) ___ @@ -3568,7 +3568,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:377 +[packages/matter.js/src/cluster/Cluster.ts:377](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L377) ___ @@ -3582,7 +3582,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:133 +[packages/matter.js/src/cluster/server/ScenesServer.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L133) ___ @@ -3608,7 +3608,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:568 +[packages/matter.js/src/cluster/Cluster.ts:568](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L568) ___ @@ -3628,7 +3628,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:113 +[packages/matter.js/src/cluster/ClusterHelper.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L113) ___ @@ -3654,7 +3654,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:797 +[packages/matter.js/src/cluster/Cluster.ts:797](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L797) ___ @@ -3684,7 +3684,7 @@ Forces the presence of the specified optional attributes, so they can be used in #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:189 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L192) ___ @@ -3714,7 +3714,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:217 +[packages/matter.js/src/cluster/Cluster.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L217) ___ @@ -3744,7 +3744,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:345 +[packages/matter.js/src/cluster/Cluster.ts:345](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L345) ___ @@ -3774,7 +3774,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:473 +[packages/matter.js/src/cluster/Cluster.ts:473](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L473) ___ @@ -3803,7 +3803,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:263 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:282](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L282) ___ @@ -3830,7 +3830,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:380 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:401](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L401) ___ @@ -3863,7 +3863,7 @@ Factory function to create an AttributeClient for a given attribute. #### Defined in -packages/matter.js/src/cluster/client/AttributeClient.ts:21 +[packages/matter.js/src/cluster/client/AttributeClient.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/AttributeClient.ts#L21) ___ @@ -3904,7 +3904,7 @@ Factory function to create an attribute server. #### Defined in -packages/matter.js/src/cluster/server/AttributeServer.ts:34 +[packages/matter.js/src/cluster/server/AttributeServer.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/AttributeServer.ts#L34) ___ @@ -3918,7 +3918,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/GroupsServer.ts:172 +[packages/matter.js/src/cluster/server/GroupsServer.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/GroupsServer.ts#L172) ___ @@ -3938,7 +3938,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/IdentifyServer.ts:10 +[packages/matter.js/src/cluster/server/IdentifyServer.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/IdentifyServer.ts#L10) ___ @@ -3950,7 +3950,7 @@ ___ | Name | Type | | :------ | :------ | -| `commandHandler` | [`NamedHandler`](../classes/export._internal_.NamedHandler.md)<`any`\> | +| `commandHandler` | [`NamedHandler`](../classes/util_export.NamedHandler.md)<`any`\> | | `attributeInitialValues?` | [`AttributeInitialValues`](cluster_export.md#attributeinitialvalues)<[`Merge`](util_export.md#merge)<[`Merge`](util_export.md#merge)<{ `currentLevel`: [`Attribute`](cluster_export.md#attribute)<``null`` \| `number`, `any`\> ; `defaultMoveRate`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<``null`` \| `number`, `any`\> ; `maxLevel`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<`number`, `any`\> ; `minLevel`: [`OptionalAttribute`](cluster_export.md#optionalattribute)<`number`, `any`\> ; `offTransitionTime`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<``null`` \| `number`, `any`\> ; `onLevel`: [`WritableAttribute`](cluster_export.md#writableattribute)<``null`` \| `number`, `any`\> ; `onOffTransitionTime`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<`number`, `any`\> ; `onTransitionTime`: [`OptionalWritableAttribute`](cluster_export.md#optionalwritableattribute)<``null`` \| `number`, `any`\> ; `options`: [`WritableAttribute`](cluster_export.md#writableattribute)<[`TypeFromBitSchema`](schema_export.md#typefrombitschema)<{ `coupleColorTempToLevel`: [`BitFlag`](schema_export.md#bitflag-1) ; `executeIfOff`: [`BitFlag`](schema_export.md#bitflag-1) }\>, `any`\> }, [`GlobalAttributes`](cluster_export.md#globalattributes-1)<{ `frequency`: [`BitFlag`](schema_export.md#bitflag-1) ; `lighting`: [`BitFlag`](schema_export.md#bitflag-1) ; `onOff`: [`BitFlag`](schema_export.md#bitflag-1) }\>\>, [`GlobalAttributes`](cluster_export.md#globalattributes-1)<{ `frequency`: [`BitFlag`](schema_export.md#bitflag-1) ; `lighting`: [`BitFlag`](schema_export.md#bitflag-1) ; `onOff`: [`BitFlag`](schema_export.md#bitflag-1) }\>\>\> | #### Returns @@ -3959,7 +3959,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/LevelControlServer.ts:60 +[packages/matter.js/src/cluster/server/LevelControlServer.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/LevelControlServer.ts#L60) ___ @@ -3971,7 +3971,7 @@ ___ | Name | Type | | :------ | :------ | -| `commandHandler?` | [`NamedHandler`](../classes/export._internal_.NamedHandler.md)<`any`\> | +| `commandHandler?` | [`NamedHandler`](../classes/util_export.NamedHandler.md)<`any`\> | | `attributeInitialValues?` | [`AttributeInitialValues`](cluster_export.md#attributeinitialvalues)<[`Merge`](util_export.md#merge)<[`Merge`](util_export.md#merge)<{ `onOff`: [`Attribute`](cluster_export.md#attribute)<`boolean`, `any`\> }, [`GlobalAttributes`](cluster_export.md#globalattributes-1)<{ `levelControlForLighting`: [`BitFlag`](schema_export.md#bitflag-1) }\>\>, [`GlobalAttributes`](cluster_export.md#globalattributes-1)<{ `levelControlForLighting`: [`BitFlag`](schema_export.md#bitflag-1) }\>\>\> | #### Returns @@ -3980,7 +3980,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/OnOffServer.ts:98 +[packages/matter.js/src/cluster/server/OnOffServer.ts:98](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/OnOffServer.ts#L98) ___ @@ -3994,7 +3994,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ScenesServer.ts:501 +[packages/matter.js/src/cluster/server/ScenesServer.ts:501](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ScenesServer.ts#L501) ___ @@ -4027,7 +4027,7 @@ Factory function to create an EVentClient for a given event. #### Defined in -packages/matter.js/src/cluster/client/EventClient.ts:17 +[packages/matter.js/src/cluster/client/EventClient.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/EventClient.ts#L17) ___ @@ -4048,7 +4048,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:133 +[packages/matter.js/src/cluster/ClusterHelper.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L133) ___ @@ -4068,7 +4068,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:125 +[packages/matter.js/src/cluster/ClusterHelper.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L125) ___ @@ -4089,7 +4089,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:183 +[packages/matter.js/src/cluster/ClusterHelper.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L183) ___ @@ -4110,7 +4110,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:158 +[packages/matter.js/src/cluster/ClusterHelper.ts:158](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L158) ___ @@ -4130,7 +4130,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:121 +[packages/matter.js/src/cluster/ClusterHelper.ts:121](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L121) ___ @@ -4159,7 +4159,7 @@ obj is ClusterClientObj #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:248 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:267](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L267) ___ @@ -4188,7 +4188,7 @@ obj is ClusterClientObjInternal #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:254 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:273](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L273) ___ @@ -4217,7 +4217,7 @@ obj is ClusterServerObj #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:365 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:386](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L386) ___ @@ -4246,7 +4246,7 @@ obj is ClusterServerObjInternal #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:371 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:392](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L392) ___ @@ -4266,7 +4266,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:234 +[packages/matter.js/src/cluster/ClusterHelper.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L234) ___ @@ -4286,7 +4286,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:264 +[packages/matter.js/src/cluster/ClusterHelper.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L264) ___ @@ -4306,4 +4306,4 @@ ___ #### Defined in -packages/matter.js/src/cluster/ClusterHelper.ts:252 +[packages/matter.js/src/cluster/ClusterHelper.ts:252](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/ClusterHelper.ts#L252) diff --git a/docs/matter.js/modules/codec_export.Base64.md b/docs/matter.js/modules/codec_export.Base64.md index cd5b9884c8..7890a1cee3 100644 --- a/docs/matter.js/modules/codec_export.Base64.md +++ b/docs/matter.js/modules/codec_export.Base64.md @@ -33,7 +33,7 @@ decoded bytes in a ByteArray #### Defined in -packages/matter.js/src/codec/Base64Codec.ts:91 +[packages/matter.js/src/codec/Base64Codec.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/Base64Codec.ts#L91) ___ @@ -58,4 +58,4 @@ an encoded string #### Defined in -packages/matter.js/src/codec/Base64Codec.ts:52 +[packages/matter.js/src/codec/Base64Codec.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/Base64Codec.ts#L52) diff --git a/docs/matter.js/modules/codec_export.md b/docs/matter.js/modules/codec_export.md index 96e3a0a39c..d06a21fa33 100644 --- a/docs/matter.js/modules/codec_export.md +++ b/docs/matter.js/modules/codec_export.md @@ -99,7 +99,7 @@ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:55 +[packages/matter.js/src/codec/DerCodec.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L55) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:88 +[packages/matter.js/src/codec/DnsCodec.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L88) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:97 +[packages/matter.js/src/codec/DnsCodec.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L97) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:72 +[packages/matter.js/src/codec/DnsCodec.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L72) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:79 +[packages/matter.js/src/codec/DnsCodec.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L79) ___ @@ -195,7 +195,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:65 +[packages/matter.js/src/codec/DnsCodec.ts:65](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L65) ## Variables @@ -205,7 +205,7 @@ packages/matter.js/src/codec/DnsCodec.ts:65 #### Defined in -packages/matter.js/src/codec/DerCodec.ts:14 +[packages/matter.js/src/codec/DerCodec.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L14) ___ @@ -215,7 +215,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:12 +[packages/matter.js/src/codec/DerCodec.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L12) ___ @@ -225,7 +225,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:13 +[packages/matter.js/src/codec/DerCodec.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L13) ___ @@ -235,7 +235,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:207 +[packages/matter.js/src/codec/DerCodec.ts:207](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L207) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:228 +[packages/matter.js/src/codec/DerCodec.ts:228](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L228) ___ @@ -255,7 +255,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:224 +[packages/matter.js/src/codec/DerCodec.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L224) ___ @@ -268,7 +268,7 @@ when needed. #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:17 +[packages/matter.js/src/codec/DnsCodec.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L17) ___ @@ -278,7 +278,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:10 +[packages/matter.js/src/codec/DerCodec.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L10) ___ @@ -288,7 +288,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:208 +[packages/matter.js/src/codec/DerCodec.ts:208](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L208) ___ @@ -298,7 +298,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:11 +[packages/matter.js/src/codec/DerCodec.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L11) ## Functions @@ -321,7 +321,7 @@ packages/matter.js/src/codec/DerCodec.ts:11 #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:35 +[packages/matter.js/src/codec/DnsCodec.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L35) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:27 +[packages/matter.js/src/codec/DnsCodec.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L27) ___ @@ -364,7 +364,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:212 +[packages/matter.js/src/codec/DerCodec.ts:212](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L212) ___ @@ -384,7 +384,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:214 +[packages/matter.js/src/codec/DerCodec.ts:214](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L214) ___ @@ -411,7 +411,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:41 +[packages/matter.js/src/codec/DerCodec.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L41) ___ @@ -437,7 +437,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:46 +[packages/matter.js/src/codec/DerCodec.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L46) ___ @@ -463,7 +463,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:50 +[packages/matter.js/src/codec/DerCodec.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L50) ___ @@ -484,7 +484,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:40 +[packages/matter.js/src/codec/DerCodec.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L40) ___ @@ -506,7 +506,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:216 +[packages/matter.js/src/codec/DerCodec.ts:216](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L216) ___ @@ -531,7 +531,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:36 +[packages/matter.js/src/codec/DerCodec.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L36) ___ @@ -551,7 +551,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:209 +[packages/matter.js/src/codec/DerCodec.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L209) ___ @@ -571,7 +571,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:232 +[packages/matter.js/src/codec/DerCodec.ts:232](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L232) ___ @@ -591,7 +591,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:233 +[packages/matter.js/src/codec/DerCodec.ts:233](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L233) ___ @@ -614,7 +614,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:19 +[packages/matter.js/src/codec/DnsCodec.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L19) ___ @@ -648,7 +648,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:200 +[packages/matter.js/src/codec/DerCodec.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L200) ___ @@ -671,7 +671,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:51 +[packages/matter.js/src/codec/DnsCodec.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L51) ___ @@ -691,7 +691,7 @@ ___ #### Defined in -packages/matter.js/src/codec/DerCodec.ts:210 +[packages/matter.js/src/codec/DerCodec.ts:210](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DerCodec.ts#L210) ___ @@ -714,4 +714,4 @@ ___ #### Defined in -packages/matter.js/src/codec/DnsCodec.ts:43 +[packages/matter.js/src/codec/DnsCodec.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/codec/DnsCodec.ts#L43) diff --git a/docs/matter.js/modules/common_export.md b/docs/matter.js/modules/common_export.md index 1129dcfbb5..ee8c0a48d9 100644 --- a/docs/matter.js/modules/common_export.md +++ b/docs/matter.js/modules/common_export.md @@ -43,6 +43,7 @@ ### Functions +- [serverAddressToString](common_export.md#serveraddresstostring) - [tryCatch](common_export.md#trycatch) - [tryCatchAsync](common_export.md#trycatchasync) @@ -71,10 +72,11 @@ The properties are named identical as in the Matter specification. | `T?` | `number` | TCP supported | | `VP?` | `string` | VendorId + ProductId | | `addresses` | [`ServerAddress`](common_export.md#serveraddress)[] | The device's addresses IP/port pairs | +| `deviceIdentifier` | `string` | - | #### Defined in -packages/matter.js/src/common/Scanner.ts:16 +[packages/matter.js/src/common/Scanner.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L16) ___ @@ -87,7 +89,7 @@ Please decide for the best matching identifier that you have. #### Defined in -packages/matter.js/src/common/Scanner.ts:58 +[packages/matter.js/src/common/Scanner.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/Scanner.ts#L60) ___ @@ -108,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:162 +[packages/matter.js/src/common/InstanceBroadcaster.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L162) ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:133 +[packages/matter.js/src/common/InstanceBroadcaster.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L133) ___ @@ -149,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:182 +[packages/matter.js/src/common/InstanceBroadcaster.ts:182](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L182) ___ @@ -159,7 +161,7 @@ ___ #### Defined in -packages/matter.js/src/common/ServerAddress.ts:18 +[packages/matter.js/src/common/ServerAddress.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/ServerAddress.ts#L18) ___ @@ -176,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/common/ServerAddress.ts:13 +[packages/matter.js/src/common/ServerAddress.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/ServerAddress.ts#L13) ___ @@ -199,7 +201,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/common/ServerAddress.ts:7 +[packages/matter.js/src/common/ServerAddress.ts:7](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/ServerAddress.ts#L7) ## Variables @@ -234,7 +236,7 @@ packages/matter.js/src/common/ServerAddress.ts:7 #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:11 +[packages/matter.js/src/common/InstanceBroadcaster.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L11) ___ @@ -244,10 +246,30 @@ ___ #### Defined in -packages/matter.js/src/common/InstanceBroadcaster.ts:131 +[packages/matter.js/src/common/InstanceBroadcaster.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/InstanceBroadcaster.ts#L131) ## Functions +### serverAddressToString + +▸ **serverAddressToString**(`address`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `address` | [`ServerAddress`](common_export.md#serveraddress) | + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/common/ServerAddress.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/ServerAddress.ts#L20) + +___ + ### tryCatch ▸ **tryCatch**<`T`, `E`\>(`codeBlock`, `errorType`, `fallbackValueOrFunction`): `T` @@ -277,7 +299,7 @@ If the function returns undefined or the error type do not match, the error is n #### Defined in -packages/matter.js/src/common/TryCatchHandler.ts:19 +[packages/matter.js/src/common/TryCatchHandler.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/TryCatchHandler.ts#L19) ___ @@ -310,4 +332,4 @@ If the function returns undefined or the error type do not match, the error is n #### Defined in -packages/matter.js/src/common/TryCatchHandler.ts:47 +[packages/matter.js/src/common/TryCatchHandler.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/TryCatchHandler.ts#L47) diff --git a/docs/matter.js/modules/crypto_export.md b/docs/matter.js/modules/crypto_export.md index dc2e6931a3..4b2c3349ef 100644 --- a/docs/matter.js/modules/crypto_export.md +++ b/docs/matter.js/modules/crypto_export.md @@ -71,7 +71,7 @@ #### Defined in -packages/matter.js/src/crypto/Key.ts:60 +[packages/matter.js/src/crypto/Key.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L60) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:20 +[packages/matter.js/src/crypto/Crypto.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L20) ## Variables @@ -91,7 +91,7 @@ packages/matter.js/src/crypto/Crypto.ts:20 #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:19 +[packages/matter.js/src/crypto/CryptoConstants.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L19) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:20 +[packages/matter.js/src/crypto/CryptoConstants.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L20) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:21 +[packages/matter.js/src/crypto/CryptoConstants.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L21) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:18 +[packages/matter.js/src/crypto/Crypto.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L18) ___ @@ -131,7 +131,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:16 +[packages/matter.js/src/crypto/Crypto.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L16) ___ @@ -141,7 +141,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:17 +[packages/matter.js/src/crypto/Crypto.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L17) ___ @@ -151,7 +151,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:14 +[packages/matter.js/src/crypto/Crypto.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L14) ___ @@ -165,7 +165,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:10 +[packages/matter.js/src/crypto/CryptoConstants.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L10) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:11 +[packages/matter.js/src/crypto/CryptoConstants.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L11) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:15 +[packages/matter.js/src/crypto/Crypto.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L15) ___ @@ -195,7 +195,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:15 +[packages/matter.js/src/crypto/CryptoConstants.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L15) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:14 +[packages/matter.js/src/crypto/CryptoConstants.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L14) ___ @@ -219,7 +219,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:12 +[packages/matter.js/src/crypto/CryptoConstants.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L12) ___ @@ -229,7 +229,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:13 +[packages/matter.js/src/crypto/Crypto.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L13) ___ @@ -239,7 +239,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:19 +[packages/matter.js/src/crypto/Crypto.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L19) ___ @@ -253,7 +253,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:17 +[packages/matter.js/src/crypto/CryptoConstants.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L17) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/CryptoConstants.ts:18 +[packages/matter.js/src/crypto/CryptoConstants.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/CryptoConstants.ts#L18) ___ @@ -273,7 +273,7 @@ ___ #### Defined in -packages/matter.js/src/crypto/Crypto.ts:125 +[packages/matter.js/src/crypto/Crypto.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Crypto.ts#L125) ## Functions @@ -295,7 +295,7 @@ Generic key factory. #### Defined in -packages/matter.js/src/crypto/Key.ts:452 +[packages/matter.js/src/crypto/Key.ts:452](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L452) ___ @@ -318,7 +318,7 @@ Private key factory. #### Defined in -packages/matter.js/src/crypto/Key.ts:556 +[packages/matter.js/src/crypto/Key.ts:556](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L556) ___ @@ -341,7 +341,7 @@ Public key factory. #### Defined in -packages/matter.js/src/crypto/Key.ts:575 +[packages/matter.js/src/crypto/Key.ts:575](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L575) ___ @@ -364,4 +364,4 @@ Symmetric key factory. #### Defined in -packages/matter.js/src/crypto/Key.ts:586 +[packages/matter.js/src/crypto/Key.ts:586](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/crypto/Key.ts#L586) diff --git a/docs/matter.js/modules/datatype_export.FabricIndex.md b/docs/matter.js/modules/datatype_export.FabricIndex.md index 06f7702ea7..8eaf1db015 100644 --- a/docs/matter.js/modules/datatype_export.FabricIndex.md +++ b/docs/matter.js/modules/datatype_export.FabricIndex.md @@ -19,7 +19,7 @@ #### Defined in -packages/matter.js/src/datatype/FabricIndex.ts:29 +[packages/matter.js/src/datatype/FabricIndex.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricIndex.ts#L29) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -packages/matter.js/src/datatype/FabricIndex.ts:30 +[packages/matter.js/src/datatype/FabricIndex.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricIndex.ts#L30) diff --git a/docs/matter.js/modules/datatype_export.NodeId.md b/docs/matter.js/modules/datatype_export.NodeId.md index 9d27c33e73..4a2bd63a63 100644 --- a/docs/matter.js/modules/datatype_export.NodeId.md +++ b/docs/matter.js/modules/datatype_export.NodeId.md @@ -30,7 +30,7 @@ #### Defined in -packages/matter.js/src/datatype/NodeId.ts:48 +[packages/matter.js/src/datatype/NodeId.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/NodeId.ts#L48) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/NodeId.ts:39 +[packages/matter.js/src/datatype/NodeId.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/NodeId.ts#L39) ___ @@ -64,4 +64,4 @@ ___ #### Defined in -packages/matter.js/src/datatype/NodeId.ts:33 +[packages/matter.js/src/datatype/NodeId.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/NodeId.ts#L33) diff --git a/docs/matter.js/modules/datatype_export.md b/docs/matter.js/modules/datatype_export.md index 2efd9062a3..7cf2892fea 100644 --- a/docs/matter.js/modules/datatype_export.md +++ b/docs/matter.js/modules/datatype_export.md @@ -67,9 +67,9 @@ An Attribute ID is a 32 bit number and indicates an attribute defined in a clust #### Defined in -packages/matter.js/src/datatype/AttributeId.ts:19 +[packages/matter.js/src/datatype/AttributeId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/AttributeId.ts#L19) -packages/matter.js/src/datatype/AttributeId.ts:17 +[packages/matter.js/src/datatype/AttributeId.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/AttributeId.ts#L17) ___ @@ -86,9 +86,9 @@ SHALL define conformance to that specification. #### Defined in -packages/matter.js/src/datatype/ClusterId.ts:20 +[packages/matter.js/src/datatype/ClusterId.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/ClusterId.ts#L20) -packages/matter.js/src/datatype/ClusterId.ts:18 +[packages/matter.js/src/datatype/ClusterId.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/ClusterId.ts#L18) ___ @@ -104,9 +104,9 @@ A Command ID is a 32 bit number and indicates a command defined in a cluster spe #### Defined in -packages/matter.js/src/datatype/CommandId.ts:19 +[packages/matter.js/src/datatype/CommandId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/CommandId.ts#L19) -packages/matter.js/src/datatype/CommandId.ts:17 +[packages/matter.js/src/datatype/CommandId.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/CommandId.ts#L17) ___ @@ -122,9 +122,9 @@ A Device type ID is a 32-bit number that defines the type of the device. #### Defined in -packages/matter.js/src/datatype/DeviceTypeId.ts:19 +[packages/matter.js/src/datatype/DeviceTypeId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/DeviceTypeId.ts#L19) -packages/matter.js/src/datatype/DeviceTypeId.ts:17 +[packages/matter.js/src/datatype/DeviceTypeId.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/DeviceTypeId.ts#L17) ___ @@ -140,9 +140,9 @@ A Endpoint Number is a 16-bit number that that indicates an instance of a device #### Defined in -packages/matter.js/src/datatype/EndpointNumber.ts:19 +[packages/matter.js/src/datatype/EndpointNumber.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/EndpointNumber.ts#L19) -packages/matter.js/src/datatype/EndpointNumber.ts:17 +[packages/matter.js/src/datatype/EndpointNumber.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/EndpointNumber.ts#L17) ___ @@ -158,9 +158,9 @@ An EVent ID is a 32 bit number and indicates an event defined in a cluster speci #### Defined in -packages/matter.js/src/datatype/EventId.ts:19 +[packages/matter.js/src/datatype/EventId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/EventId.ts#L19) -packages/matter.js/src/datatype/EventId.ts:17 +[packages/matter.js/src/datatype/EventId.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/EventId.ts#L17) ___ @@ -177,9 +177,9 @@ a particular root CA. #### Defined in -packages/matter.js/src/datatype/FabricId.ts:21 +[packages/matter.js/src/datatype/FabricId.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricId.ts#L21) -packages/matter.js/src/datatype/FabricId.ts:19 +[packages/matter.js/src/datatype/FabricId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricId.ts#L19) ___ @@ -200,11 +200,11 @@ a fabric, such as fabric-scoped data model elements, then the fabric-index value #### Defined in -packages/matter.js/src/datatype/FabricIndex.ts:24 +[packages/matter.js/src/datatype/FabricIndex.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricIndex.ts#L24) -packages/matter.js/src/datatype/FabricIndex.ts:22 +[packages/matter.js/src/datatype/FabricIndex.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricIndex.ts#L22) -packages/matter.js/src/datatype/FabricIndex.ts:28 +[packages/matter.js/src/datatype/FabricIndex.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricIndex.ts#L28) ___ @@ -227,9 +227,9 @@ The Group ID space is allocated as described in Table 2, “Group ID Allocations #### Defined in -packages/matter.js/src/datatype/GroupId.ts:26 +[packages/matter.js/src/datatype/GroupId.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/GroupId.ts#L26) -packages/matter.js/src/datatype/GroupId.ts:24 +[packages/matter.js/src/datatype/GroupId.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/GroupId.ts#L24) ___ @@ -246,11 +246,11 @@ group of Nodes on a Fabric. #### Defined in -packages/matter.js/src/datatype/NodeId.ts:25 +[packages/matter.js/src/datatype/NodeId.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/NodeId.ts#L25) -packages/matter.js/src/datatype/NodeId.ts:23 +[packages/matter.js/src/datatype/NodeId.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/NodeId.ts#L23) -packages/matter.js/src/datatype/NodeId.ts:29 +[packages/matter.js/src/datatype/NodeId.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/NodeId.ts#L29) ___ @@ -267,7 +267,7 @@ authentication method provided by the Secure Channel architecture. #### Defined in -packages/matter.js/src/datatype/SubjectId.ts:16 +[packages/matter.js/src/datatype/SubjectId.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/SubjectId.ts#L16) ___ @@ -285,9 +285,9 @@ Connectivity Standards Alliance (see [CSA Manufacturer Code Database]). #### Defined in -packages/matter.js/src/datatype/VendorId.ts:21 +[packages/matter.js/src/datatype/VendorId.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/VendorId.ts#L21) -packages/matter.js/src/datatype/VendorId.ts:19 +[packages/matter.js/src/datatype/VendorId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/VendorId.ts#L19) ## Variables @@ -299,7 +299,7 @@ Tlv schema for an Attribute Id. #### Defined in -packages/matter.js/src/datatype/AttributeId.ts:24 +[packages/matter.js/src/datatype/AttributeId.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/AttributeId.ts#L24) ___ @@ -311,7 +311,7 @@ Tlv schema for a cluster Id. #### Defined in -packages/matter.js/src/datatype/ClusterId.ts:25 +[packages/matter.js/src/datatype/ClusterId.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/ClusterId.ts#L25) ___ @@ -323,7 +323,7 @@ Tlv schema for an Command Id. #### Defined in -packages/matter.js/src/datatype/CommandId.ts:24 +[packages/matter.js/src/datatype/CommandId.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/CommandId.ts#L24) ___ @@ -335,7 +335,7 @@ Tlv schema for a Device type ID. #### Defined in -packages/matter.js/src/datatype/DeviceTypeId.ts:24 +[packages/matter.js/src/datatype/DeviceTypeId.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/DeviceTypeId.ts#L24) ___ @@ -347,7 +347,7 @@ Tlv schema for an Endpoint number. #### Defined in -packages/matter.js/src/datatype/EndpointNumber.ts:24 +[packages/matter.js/src/datatype/EndpointNumber.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/EndpointNumber.ts#L24) ___ @@ -359,7 +359,7 @@ Tlv schema for an Event Id. #### Defined in -packages/matter.js/src/datatype/EventId.ts:24 +[packages/matter.js/src/datatype/EventId.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/EventId.ts#L24) ___ @@ -371,7 +371,7 @@ Tlv schema for a Node Identifier. #### Defined in -packages/matter.js/src/datatype/FabricId.ts:26 +[packages/matter.js/src/datatype/FabricId.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricId.ts#L26) ___ @@ -383,7 +383,7 @@ Tlv Schema for a Fabric Index. #### Defined in -packages/matter.js/src/datatype/FabricIndex.ts:34 +[packages/matter.js/src/datatype/FabricIndex.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricIndex.ts#L34) ___ @@ -395,7 +395,7 @@ Tlv Schema for a Group Id. #### Defined in -packages/matter.js/src/datatype/GroupId.ts:31 +[packages/matter.js/src/datatype/GroupId.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/GroupId.ts#L31) ___ @@ -407,7 +407,7 @@ Tlv schema for a Node Identifier. #### Defined in -packages/matter.js/src/datatype/NodeId.ts:57 +[packages/matter.js/src/datatype/NodeId.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/NodeId.ts#L57) ___ @@ -419,7 +419,7 @@ Tlv schema for a Subject Id #### Defined in -packages/matter.js/src/datatype/SubjectId.ts:19 +[packages/matter.js/src/datatype/SubjectId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/SubjectId.ts#L19) ___ @@ -431,7 +431,7 @@ Data model for a Vendor Identifier. #### Defined in -packages/matter.js/src/datatype/VendorId.ts:26 +[packages/matter.js/src/datatype/VendorId.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/VendorId.ts#L26) ## Functions @@ -451,7 +451,7 @@ packages/matter.js/src/datatype/VendorId.ts:26 #### Defined in -packages/matter.js/src/datatype/AttributeId.ts:19 +[packages/matter.js/src/datatype/AttributeId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/AttributeId.ts#L19) ___ @@ -471,7 +471,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/ClusterId.ts:20 +[packages/matter.js/src/datatype/ClusterId.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/ClusterId.ts#L20) ___ @@ -491,7 +491,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/CommandId.ts:19 +[packages/matter.js/src/datatype/CommandId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/CommandId.ts#L19) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/DeviceTypeId.ts:19 +[packages/matter.js/src/datatype/DeviceTypeId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/DeviceTypeId.ts#L19) ___ @@ -531,7 +531,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/EndpointNumber.ts:19 +[packages/matter.js/src/datatype/EndpointNumber.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/EndpointNumber.ts#L19) ___ @@ -551,7 +551,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/EventId.ts:19 +[packages/matter.js/src/datatype/EventId.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/EventId.ts#L19) ___ @@ -571,7 +571,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/FabricId.ts:21 +[packages/matter.js/src/datatype/FabricId.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricId.ts#L21) ___ @@ -591,7 +591,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/FabricIndex.ts:24 +[packages/matter.js/src/datatype/FabricIndex.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/FabricIndex.ts#L24) ___ @@ -611,7 +611,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/GroupId.ts:26 +[packages/matter.js/src/datatype/GroupId.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/GroupId.ts#L26) ___ @@ -631,7 +631,7 @@ ___ #### Defined in -packages/matter.js/src/datatype/NodeId.ts:25 +[packages/matter.js/src/datatype/NodeId.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/NodeId.ts#L25) ___ @@ -651,4 +651,4 @@ ___ #### Defined in -packages/matter.js/src/datatype/VendorId.ts:21 +[packages/matter.js/src/datatype/VendorId.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/datatype/VendorId.ts#L21) diff --git a/docs/matter.js/modules/device_export.md b/docs/matter.js/modules/device_export.md index c0670736d9..2f206e82fa 100644 --- a/docs/matter.js/modules/device_export.md +++ b/docs/matter.js/modules/device_export.md @@ -7,6 +7,7 @@ ### Enumerations - [DeviceClasses](../enums/device_export.DeviceClasses.md) +- [NodeStateInformation](../enums/device_export.NodeStateInformation.md) ### Classes @@ -20,6 +21,7 @@ - [OnOffLightDevice](../classes/device_export.OnOffLightDevice.md) - [OnOffPluginUnitDevice](../classes/device_export.OnOffPluginUnitDevice.md) - [PairedDevice](../classes/device_export.PairedDevice.md) +- [PairedNode](../classes/device_export.PairedNode.md) - [RootEndpoint](../classes/device_export.RootEndpoint.md) ### Interfaces @@ -27,6 +29,11 @@ - [DeviceTypeDefinition](../interfaces/device_export.DeviceTypeDefinition.md) - [EndpointOptions](../interfaces/device_export.EndpointOptions.md) +### Type Aliases + +- [CommissioningControllerNodeOptions](device_export.md#commissioningcontrollernodeoptions) +- [EndpointLoggingOptions](device_export.md#endpointloggingoptions) + ### Variables - [DeviceTypes](device_export.md#devicetypes) @@ -40,6 +47,60 @@ - [getDeviceTypeDefinitionByCode](device_export.md#getdevicetypedefinitionbycode) - [logEndpoint](device_export.md#logendpoint) +## Type Aliases + +### CommissioningControllerNodeOptions + +Ƭ **CommissioningControllerNodeOptions**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `attributeChangedCallback?` | (`nodeId`: [`NodeId`](datatype_export.md#nodeid), `data`: [`DecodedAttributeReportValue`](protocol_interaction_export.md#decodedattributereportvalue)<`any`\>) => `void` | Optional additional callback method which is called for each Attribute change reported by the device. Use this if subscribing to all relevant attributes is too much effort. | +| `autoSubscribe?` | `boolean` | Unless set to false all events and attributes are subscribed and value changes are reflected in the ClusterClient instances. With this reading attributes values is mostly looked up in the locally cached data. Additionally more features like reaction on shutdown event or endpoint structure changes (for bridges) are done internally automatically. | +| `eventTriggeredCallback?` | (`nodeId`: [`NodeId`](datatype_export.md#nodeid), `data`: [`DecodedEventReportValue`](protocol_interaction_export.md#decodedeventreportvalue)<`any`\>) => `void` | Optional additional callback method which is called for each Event reported by the device. Use this if subscribing to all relevant events is too much effort. | +| `stateInformationCallback?` | (`nodeId`: [`NodeId`](datatype_export.md#nodeid), `state`: [`NodeStateInformation`](../enums/device_export.NodeStateInformation.md)) => `void` | Optional callback method which is called when the state of the node changes. This can be used to detect when the node goes offline or comes back online. | +| `subscribeMaxIntervalCeilingSeconds?` | `number` | Maximum subscription interval when values are changed. This is also used as a keepalive mechanism to validate that the device is still available. Default it is set to 30s. | +| `subscribeMinIntervalFloorSeconds?` | `number` | Minimum subscription interval when values are changed. Default it is set to 0s. | + +#### Defined in + +[packages/matter.js/src/device/PairedNode.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/PairedNode.ts#L87) + +___ + +### EndpointLoggingOptions + +Ƭ **EndpointLoggingOptions**: `Object` + +Options for logging endpoint structure. The default is that anything is logged beside "Non Supported" attributes and +events on ClusterClients. The Filter methods can be used to filter out specific endpoints or clusters if wanted. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `clusterClientFilter?` | (`endpoint`: [`Endpoint`](../classes/device_export.Endpoint.md), `cluster`: [`ClusterClientObj`](cluster_export.md#clusterclientobj)<`any`, `any`, `any`, `any`\>) => `boolean` | +| `clusterServerFilter?` | (`endpoint`: [`Endpoint`](../classes/device_export.Endpoint.md), `cluster`: [`ClusterServerObj`](cluster_export.md#clusterserverobj)<`any`, `any`\>) => `boolean` | +| `endpointFilter?` | (`endpoint`: [`Endpoint`](../classes/device_export.Endpoint.md)) => `boolean` | +| `logAttributeObjectValues?` | `boolean` | +| `logAttributePrimitiveValues?` | `boolean` | +| `logChildEndpoints?` | `boolean` | +| `logClusterAttributes?` | `boolean` | +| `logClusterClients?` | `boolean` | +| `logClusterCommands?` | `boolean` | +| `logClusterEvents?` | `boolean` | +| `logClusterGlobalAttributes?` | `boolean` | +| `logClusterServers?` | `boolean` | +| `logNotSupportedClusterAttributes?` | `boolean` | +| `logNotSupportedClusterCommands?` | `boolean` | +| `logNotSupportedClusterEvents?` | `boolean` | + +#### Defined in + +[packages/matter.js/src/device/EndpointStructureLogger.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/EndpointStructureLogger.ts#L23) + ## Variables ### DeviceTypes @@ -52,7 +113,7 @@ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:113 +[packages/matter.js/src/device/DeviceTypes.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L113) ## Functions @@ -82,7 +143,7 @@ packages/matter.js/src/device/DeviceTypes.ts:113 #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:78 +[packages/matter.js/src/device/DeviceTypes.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L78) ___ @@ -102,7 +163,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:974 +[packages/matter.js/src/device/DeviceTypes.ts:974](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L974) ___ @@ -124,7 +185,7 @@ the custom ones are used if defined | Name | Type | Description | | :------ | :------ | :------ | | `handler` | [`ClusterServerHandlers`](cluster_export.md#clusterserverhandlers)<`C`\> | Internal handlers instance to wrap the external handler into | -| `commandHandler?` | [`NamedHandler`](../classes/export._internal_.NamedHandler.md)<`any`\> | Command handler instance with the registered handlers | +| `commandHandler?` | [`NamedHandler`](../classes/util_export.NamedHandler.md)<`any`\> | Command handler instance with the registered handlers | #### Returns @@ -132,7 +193,7 @@ the custom ones are used if defined #### Defined in -packages/matter.js/src/device/Device.ts:28 +[packages/matter.js/src/device/Device.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/Device.ts#L29) ___ @@ -166,7 +227,7 @@ for multiple clusters #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:36 +[packages/matter.js/src/device/OnOffDevices.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L36) ___ @@ -186,7 +247,7 @@ ___ #### Defined in -packages/matter.js/src/device/DeviceTypes.ts:983 +[packages/matter.js/src/device/DeviceTypes.ts:983](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DeviceTypes.ts#L983) ___ @@ -199,7 +260,7 @@ ___ | Name | Type | | :------ | :------ | | `endpoint` | [`Endpoint`](../classes/device_export.Endpoint.md) | -| `options` | [`EndpointLoggingOptions`](export._internal_.md#endpointloggingoptions) | +| `options` | [`EndpointLoggingOptions`](device_export.md#endpointloggingoptions) | #### Returns @@ -207,4 +268,4 @@ ___ #### Defined in -packages/matter.js/src/device/EndpointStructureLogger.ts:238 +[packages/matter.js/src/device/EndpointStructureLogger.ts:235](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/EndpointStructureLogger.ts#L235) diff --git a/docs/matter.js/modules/export._internal_.ModelTraversal.md b/docs/matter.js/modules/export._internal_.ModelTraversal.md new file mode 100644 index 0000000000..0577946845 --- /dev/null +++ b/docs/matter.js/modules/export._internal_.ModelTraversal.md @@ -0,0 +1,21 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [export](export.md) / [](export._internal_.md) / ModelTraversal + +# Namespace: ModelTraversal + +[export](export.md).[](export._internal_.md).ModelTraversal + +## Table of contents + +### Type Aliases + +- [ElementSelector](export._internal_.ModelTraversal.md#elementselector) + +## Type Aliases + +### ElementSelector + +Ƭ **ElementSelector**: `string` \| `number` \| (`model`: [`Model`](../classes/model.Model-1.md)) => `boolean` + +#### Defined in + +[packages/matter.js/src/model/logic/ModelTraversal.ts:561](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelTraversal.ts#L561) diff --git a/docs/matter.js/modules/export._internal_.md b/docs/matter.js/modules/export._internal_.md index 7436f1f1e4..f92e70e225 100644 --- a/docs/matter.js/modules/export._internal_.md +++ b/docs/matter.js/modules/export._internal_.md @@ -4,6 +4,14 @@ ## Table of contents +### References + +- [ElementSelector](export._internal_.md#elementselector) + +### Namespaces + +- [ModelTraversal](export._internal_.ModelTraversal.md) + ### Enumerations - [BitRangeType](../enums/export._internal_.BitRangeType.md) @@ -27,7 +35,7 @@ - [MatterController](../classes/export._internal_.MatterController.md) - [MatterDevice](../classes/export._internal_.MatterDevice.md) - [MdnsInstanceBroadcaster](../classes/export._internal_.MdnsInstanceBroadcaster.md) -- [NamedHandler](../classes/export._internal_.NamedHandler.md) +- [ModelTraversal](../classes/export._internal_.ModelTraversal-1.md) - [QrPairingCodeSchema](../classes/export._internal_.QrPairingCodeSchema.md) - [UdpConnection](../classes/export._internal_.UdpConnection.md) @@ -47,6 +55,8 @@ - [EventPathWithEventData](../interfaces/export._internal_.EventPathWithEventData.md) - [EventStorageData](../interfaces/export._internal_.EventStorageData.md) - [MrpParameters](../interfaces/export._internal_.MrpParameters.md) +- [RecordValidationResult](../interfaces/export._internal_.RecordValidationResult.md) +- [RecordValidator](../interfaces/export._internal_.RecordValidator.md) - [scenesTableEntry](../interfaces/export._internal_.scenesTableEntry.md) ### Type Aliases @@ -58,6 +68,8 @@ - [AttributeSetters](export._internal_.md#attributesetters) - [AttributeValidators](export._internal_.md#attributevalidators) - [BitRange](export._internal_.md#bitrange) +- [BuildArrayMinLength](export._internal_.md#buildarrayminlength) +- [ChildMapping](export._internal_.md#childmapping) - [ClientAttributeGetters](export._internal_.md#clientattributegetters) - [ClientAttributeListeners](export._internal_.md#clientattributelisteners) - [ClientAttributeSetters](export._internal_.md#clientattributesetters) @@ -67,21 +79,22 @@ - [ClientEventSubscribers](export._internal_.md#clienteventsubscribers) - [ClientGlobalAttributeGetters](export._internal_.md#clientglobalattributegetters) - [ClusterExtend](export._internal_.md#clusterextend) +- [ClusterState](export._internal_.md#clusterstate) - [CollectedCommissioningData](export._internal_.md#collectedcommissioningdata) - [CommandHandlers](export._internal_.md#commandhandlers) - [CommandServers](export._internal_.md#commandservers) - [CommissionableDeviceRecordWithExpire](export._internal_.md#commissionabledevicerecordwithexpire) +- [CommissionedNodeDetails](export._internal_.md#commissionednodedetails) - [CommissioningServerCommands](export._internal_.md#commissioningservercommands) - [CommissioningStep](export._internal_.md#commissioningstep) - [CommissioningStepResult](export._internal_.md#commissioningstepresult) - [CommissioningSuccessFailureResponse](export._internal_.md#commissioningsuccessfailureresponse) - [DimmableDeviceCommands](export._internal_.md#dimmabledevicecommands) -- [EndpointLoggingOptions](export._internal_.md#endpointloggingoptions) - [ErrorHandler](export._internal_.md#errorhandler) - [EventDataPayload](export._internal_.md#eventdatapayload) +- [ExtendPublicHandlerMethods](export._internal_.md#extendpublichandlermethods) - [GetterTypeFromSpec](export._internal_.md#gettertypefromspec) - [GetterTypeFromSpec](export._internal_.md#gettertypefromspec-1) -- [HandlerFunction](export._internal_.md#handlerfunction) - [LengthConstraints](export._internal_.md#lengthconstraints) - [LengthConstraints](export._internal_.md#lengthconstraints-1) - [MakeAttributeMandatory](export._internal_.md#makeattributemandatory) @@ -92,6 +105,7 @@ - [MaskFromBitSchema](export._internal_.md#maskfrombitschema) - [MaskOffsetFromBitSchema](export._internal_.md#maskoffsetfrombitschema) - [MatterServerRecordWithExpire](export._internal_.md#matterserverrecordwithexpire) +- [NameMapping](export._internal_.md#namemapping) - [OnOffBaseDeviceCommands](export._internal_.md#onoffbasedevicecommands) - [OptionalAttributeConf](export._internal_.md#optionalattributeconf) - [OptionalAttributeServers](export._internal_.md#optionalattributeservers) @@ -121,6 +135,12 @@ - [MakeAttributesMandatory](export._internal_.md#makeattributesmandatory-1) - [UseOptionalAttributes](export._internal_.md#useoptionalattributes-1) +## References + +### ElementSelector + +Re-exports [ElementSelector](export._internal_.ModelTraversal.md#elementselector) + ## Enumeration Members ### Enum @@ -129,7 +149,7 @@ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:16 +[packages/matter.js/src/schema/BitmapSchema.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L16) ___ @@ -139,7 +159,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:14 +[packages/matter.js/src/schema/BitmapSchema.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L14) ___ @@ -149,7 +169,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:15 +[packages/matter.js/src/schema/BitmapSchema.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L15) ## Type Aliases @@ -166,7 +186,7 @@ packages/matter.js/src/schema/BitmapSchema.ts:15 #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:18 +[packages/matter.js/src/tlv/TlvArray.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L18) ___ @@ -178,7 +198,7 @@ Type for TlvAttributeReportData where the real data are represented with the sch #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:37 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L37) ___ @@ -194,7 +214,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:88 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L91) ___ @@ -212,7 +232,7 @@ Handlers to process cluster commands #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:128 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L131) ___ @@ -228,7 +248,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:96 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L99) ___ @@ -244,7 +264,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:102 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L105) ___ @@ -270,9 +290,45 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:19 +[packages/matter.js/src/schema/BitmapSchema.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L19) + +[packages/matter.js/src/schema/BitmapSchema.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L25) + +___ + +### BuildArrayMinLength + +Ƭ **BuildArrayMinLength**<`T`, `N`, `Current`\>: `Current`[``"length"``] extends `N` ? [...Current, ...T[]] : [`BuildArrayMinLength`](export._internal_.md#buildarrayminlength)<`T`, `N`, [...Current, `T`]\> -packages/matter.js/src/schema/BitmapSchema.ts:25 +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `N` | extends `number` | +| `Current` | extends `T`[] | + +#### Defined in + +[packages/matter.js/src/util/Array.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Array.ts#L11) + +___ + +### ChildMapping + +Ƭ **ChildMapping**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `idToSlot` | { `[id: string]`: `number`; } | +| `nameToSlot` | { `[name: string]`: `number`; } | +| `slots` | [`VariantMap`](model.md#variantmap)[] | + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L198) ___ @@ -288,7 +344,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:72 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L73) ___ @@ -304,7 +360,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:103 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:104](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L104) ___ @@ -320,7 +376,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:89 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L90) ___ @@ -336,7 +392,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:94 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:95](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L95) ___ @@ -352,7 +408,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:111 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L112) ___ @@ -368,7 +424,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:127 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L128) ___ @@ -384,7 +440,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:117 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L118) ___ @@ -400,7 +456,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:81 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L82) ___ @@ -429,9 +485,27 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:922 +[packages/matter.js/src/cluster/Cluster.ts:922](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L922) -packages/matter.js/src/cluster/Cluster.ts:935 +[packages/matter.js/src/cluster/Cluster.ts:935](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L935) + +___ + +### ClusterState + +Ƭ **ClusterState**: `Object` + +This type manages state that changes when we enter a cluster. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `canonicalNames` | [`NameMapping`](export._internal_.md#namemapping) | + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:314](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L314) ___ @@ -458,7 +532,7 @@ Data that are collected initially or through the commissioning process and can b #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:98 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:100](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L100) ___ @@ -476,7 +550,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:122 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:125](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L125) ___ @@ -492,7 +566,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:109 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:110](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L110) ___ @@ -502,7 +576,23 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:49 +[packages/matter.js/src/mdns/MdnsScanner.ts:49](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L49) + +___ + +### CommissionedNodeDetails + +Ƭ **CommissionedNodeDetails**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `operationalServerAddress?` | [`ServerAddressIp`](common_export.md#serveraddressip) | + +#### Defined in + +[packages/matter.js/src/MatterController.ts:63](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterController.ts#L63) ___ @@ -520,7 +610,7 @@ Commands exposed by the CommissioningServer #### Defined in -packages/matter.js/src/CommissioningServer.ts:186 +[packages/matter.js/src/CommissioningServer.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L200) ___ @@ -542,7 +632,7 @@ All steps are for execution sorted by stepNumber and subStepNumber #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:83 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L85) ___ @@ -562,7 +652,7 @@ Breadcrump value is stored for each step for transparency #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:74 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:76](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L76) ___ @@ -570,7 +660,7 @@ ___ Ƭ **CommissioningSuccessFailureResponse**: `Object` -Types representation of a general commissioning response +Types representation of a general commissioning response. #### Type declaration @@ -581,7 +671,7 @@ Types representation of a general commissioning response #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:56 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L60) ___ @@ -604,39 +694,7 @@ ___ #### Defined in -packages/matter.js/src/device/DimmableDevices.ts:15 - -___ - -### EndpointLoggingOptions - -Ƭ **EndpointLoggingOptions**: `Object` - -Options for logging endpoint structure. The default is that anything is logged beside "Non present" attributes and -events on ClusterClients. The Filter methods can be used to filter out specific endpoints or clusters if wanted. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `clusterClientFilter?` | (`endpoint`: [`Endpoint`](../classes/device_export.Endpoint.md), `cluster`: [`ClusterClientObj`](cluster_export.md#clusterclientobj)<`any`, `any`, `any`, `any`\>) => `boolean` | -| `clusterServerFilter?` | (`endpoint`: [`Endpoint`](../classes/device_export.Endpoint.md), `cluster`: [`ClusterServerObj`](cluster_export.md#clusterserverobj)<`any`, `any`\>) => `boolean` | -| `endpointFilter?` | (`endpoint`: [`Endpoint`](../classes/device_export.Endpoint.md)) => `boolean` | -| `logAttributeObjectValues?` | `boolean` | -| `logAttributePrimitiveValues?` | `boolean` | -| `logChildEndpoints?` | `boolean` | -| `logClusterAttributes?` | `boolean` | -| `logClusterClients?` | `boolean` | -| `logClusterCommands?` | `boolean` | -| `logClusterEvents?` | `boolean` | -| `logClusterGlobalAttributes?` | `boolean` | -| `logClusterServers?` | `boolean` | -| `logNotPresentClusterAttributes?` | `boolean` | -| `logNotPresentClusterEvents?` | `boolean` | - -#### Defined in - -packages/matter.js/src/device/EndpointStructureLogger.ts:23 +[packages/matter.js/src/device/DimmableDevices.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/DimmableDevices.ts#L15) ___ @@ -667,7 +725,7 @@ ___ #### Defined in -packages/matter.js/src/common/TryCatchHandler.ts:8 +[packages/matter.js/src/common/TryCatchHandler.ts:8](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/common/TryCatchHandler.ts#L8) ___ @@ -679,23 +737,24 @@ Type for TlvEventData where the real data are represented with the schema and th #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:48 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L48) ___ -### GetterTypeFromSpec +### ExtendPublicHandlerMethods -Ƭ **GetterTypeFromSpec**<`A`\>: `A` extends [`OptionalAttribute`](cluster_export.md#optionalattribute) ? `T` \| `undefined` : [`AttributeJsType`](cluster_export.md#attributejstype)<`A`\> +Ƭ **ExtendPublicHandlerMethods**<`ParentClass`, `H`\>: `ParentClass` extends (...`args`: infer TArgs) => infer T ? (...`args`: `TArgs`) => `T` & { `_executeHandler`: (`action`: `K`, ...`args`: `Parameters`<`H`[`K`]\>) => `Promise`<`void`\> ; `addCommandHandler`: (`action`: `K`, `handler`: `H`[`K`]) => `void` ; `removeCommandHandler`: (`action`: `K`, `handler`: `H`[`K`]) => `void` } : `never` #### Type parameters | Name | Type | | :------ | :------ | -| `A` | extends [`Attribute`](cluster_export.md#attribute)<`any`, `any`\> | +| `ParentClass` | extends (...`args`: `any`[]) => `any` | +| `H` | extends `Record` | #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:69 +[packages/matter.js/src/util/NamedHandler.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L35) ___ @@ -711,36 +770,23 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:214 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L70) ___ -### HandlerFunction - -Ƭ **HandlerFunction**: (...`args`: `any`[]) => `any` - -#### Type declaration +### GetterTypeFromSpec -▸ (`...args`): `any` +Ƭ **GetterTypeFromSpec**<`A`\>: `A` extends [`OptionalAttribute`](cluster_export.md#optionalattribute) ? `T` \| `undefined` : [`AttributeJsType`](cluster_export.md#attributejstype)<`A`\> -##### Parameters +#### Type parameters | Name | Type | | :------ | :------ | -| `...args` | `any`[] | - -##### Returns - -`any` - -**`License`** - -Copyright 2022 The matter.js Authors -SPDX-License-Identifier: Apache-2.0 +| `A` | extends [`Attribute`](cluster_export.md#attribute)<`any`, `any`\> | #### Defined in -packages/matter.js/src/util/NamedHandler.ts:7 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L217) ___ @@ -758,7 +804,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:12 +[packages/matter.js/src/tlv/TlvArray.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L12) ___ @@ -776,7 +822,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvString.ts:14 +[packages/matter.js/src/tlv/TlvString.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L14) ___ @@ -792,7 +838,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:153 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:156](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L156) ___ @@ -809,9 +855,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:163 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L166) -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:167 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L170) ___ @@ -829,7 +875,7 @@ Cluster attributes accessible on the cluster server #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:51 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L54) ___ @@ -845,7 +891,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:82 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:85](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L85) ___ @@ -861,7 +907,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:27 +[packages/matter.js/src/tlv/TlvObject.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L27) ___ @@ -877,7 +923,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:53 +[packages/matter.js/src/schema/BitmapSchema.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L53) ___ @@ -893,7 +939,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:54 +[packages/matter.js/src/schema/BitmapSchema.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L54) ___ @@ -903,7 +949,19 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsScanner.ts:45 +[packages/matter.js/src/mdns/MdnsScanner.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsScanner.ts#L45) + +___ + +### NameMapping + +Ƭ **NameMapping**: `Map`<[`Model`](../classes/model.Model-1.md), `string`\> + +Map of Model -> name + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:309](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L309) ___ @@ -920,7 +978,7 @@ ___ #### Defined in -packages/matter.js/src/device/OnOffDevices.ts:24 +[packages/matter.js/src/device/OnOffDevices.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/device/OnOffDevices.ts#L24) ___ @@ -936,7 +994,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:152 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L155) ___ @@ -952,7 +1010,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:63 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:66](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L66) ___ @@ -968,7 +1026,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:85 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:88](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L88) ___ @@ -984,7 +1042,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:30 +[packages/matter.js/src/tlv/TlvObject.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L30) ___ @@ -1000,7 +1058,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:217 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:220](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L220) ___ @@ -1016,7 +1074,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:224 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:227](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L227) ___ @@ -1032,7 +1090,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:232 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:235](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L235) ___ @@ -1048,7 +1106,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:247 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:250](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L250) ___ @@ -1060,7 +1118,7 @@ Supported combined types to stringify the data for the storage that can be used #### Defined in -packages/matter.js/src/storage/StringifyTools.ts:39 +[packages/matter.js/src/storage/StringifyTools.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StringifyTools.ts#L39) ___ @@ -1072,7 +1130,7 @@ Supported base types to stringify the data for the storage that can be used as k #### Defined in -packages/matter.js/src/storage/StringifyTools.ts:21 +[packages/matter.js/src/storage/StringifyTools.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StringifyTools.ts#L21) ___ @@ -1089,7 +1147,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:34 +[packages/matter.js/src/tlv/TlvObject.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L34) ___ @@ -1106,7 +1164,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:35 +[packages/matter.js/src/tlv/TlvObject.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L35) ___ @@ -1122,7 +1180,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:33 +[packages/matter.js/src/tlv/TlvObject.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L33) ___ @@ -1138,7 +1196,7 @@ ___ #### Defined in -packages/matter.js/src/certificate/CertificateManager.ts:329 +[packages/matter.js/src/certificate/CertificateManager.ts:329](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/certificate/CertificateManager.ts#L329) ___ @@ -1155,9 +1213,9 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:177 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L180) -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:189 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L192) ___ @@ -1173,7 +1231,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/client/ClusterClientTypes.ts:86 +[packages/matter.js/src/cluster/client/ClusterClientTypes.ts:87](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/client/ClusterClientTypes.ts#L87) ## Variables @@ -1185,7 +1243,7 @@ See [MatterCoreSpecificationV1_0](../interfaces/spec_export.MatterCoreSpecificat #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:47 +[packages/matter.js/src/schema/PairingCodeSchema.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L48) ## Functions @@ -1214,7 +1272,7 @@ packages/matter.js/src/schema/PairingCodeSchema.ts:47 #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:25 +[packages/matter.js/src/schema/BitmapSchema.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L25) ___ @@ -1249,7 +1307,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/Cluster.ts:935 +[packages/matter.js/src/cluster/Cluster.ts:935](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/Cluster.ts#L935) ___ @@ -1277,7 +1335,7 @@ ___ #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:167 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L170) ___ @@ -1307,4 +1365,4 @@ Forces the presence of the specified optional attributes, so they can be used in #### Defined in -packages/matter.js/src/cluster/server/ClusterServerTypes.ts:189 +[packages/matter.js/src/cluster/server/ClusterServerTypes.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/cluster/server/ClusterServerTypes.ts#L192) diff --git a/docs/matter.js/modules/export.md b/docs/matter.js/modules/export.md index 97f3056899..65ab20746a 100644 --- a/docs/matter.js/modules/export.md +++ b/docs/matter.js/modules/export.md @@ -26,15 +26,20 @@ ### Interfaces -- [CommissioningControllerOptions](../interfaces/export.CommissioningControllerOptions.md) - [CommissioningServerOptions](../interfaces/export.CommissioningServerOptions.md) - [DevicePairingInformation](../interfaces/export.DevicePairingInformation.md) ### Type Aliases +- [CommissioningControllerOptions](export.md#commissioningcontrolleroptions) - [MatterServerOptions](export.md#matterserveroptions) +- [NodeCommissioningOptions](export.md#nodecommissioningoptions) - [NodeOptions](export.md#nodeoptions) +### Variables + +- [FORBIDDEN\_PASSCODES](export.md#forbidden_passcodes) + ## References ### MatterApplicationClusterSpecificationV1\_0 @@ -73,6 +78,18 @@ Re-exports [MatterDeviceLibrarySpecificationV1_1](../interfaces/spec_export.Matt ## Type Aliases +### CommissioningControllerOptions + +Ƭ **CommissioningControllerOptions**: [`CommissioningControllerNodeOptions`](device_export.md#commissioningcontrollernodeoptions) & { `adminFabricId?`: [`FabricId`](datatype_export.md#fabricid) ; `adminFabricIndex?`: [`FabricIndex`](datatype_export.md#fabricindex) ; `adminVendorId?`: [`VendorId`](datatype_export.md#vendorid) ; `autoConnect?`: `boolean` ; `listeningAddressIpv4?`: `string` ; `listeningAddressIpv6?`: `string` ; `localPort?`: `number` } + +Constructor options for the CommissioningController class + +#### Defined in + +[packages/matter.js/src/CommissioningController.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L36) + +___ + ### MatterServerOptions Ƭ **MatterServerOptions**: `Object` @@ -82,11 +99,24 @@ Re-exports [MatterDeviceLibrarySpecificationV1_1](../interfaces/spec_export.Matt | Name | Type | Description | | :------ | :------ | :------ | | `disableIpv4?` | `boolean` | If set to true no IPv4 socket listener is sed and only IPv6 is supported. | -| `mdnsAnnounceInterface?` | `string` | Interface to use for MDNS announcements. If not provided announcements will be sent from all network interfaces | +| `mdnsAnnounceInterface?` | `string` | Interface to use for MDNS announcements. If not provided announcements will be sent from all network interfaces TODO: Remove in later versions then 0.7 **`Deprecated`** | +| `mdnsInterface?` | `string` | Interface to use for MDNS announcements and scanning. If not provided announcements/scanning will be done on all network interfaces | + +#### Defined in + +[packages/matter.js/src/MatterServer.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L31) + +___ + +### NodeCommissioningOptions + +Ƭ **NodeCommissioningOptions**: [`CommissioningControllerNodeOptions`](device_export.md#commissioningcontrollernodeoptions) & { `commissioning?`: [`CommissioningOptions`](protocol_export.md#commissioningoptions) ; `discovery`: { `identifierData`: [`CommissionableDeviceIdentifiers`](common_export.md#commissionabledeviceidentifiers) } \| { `commissionableDevice`: [`CommissionableDevice`](common_export.md#commissionabledevice) } & { `discoveryCapabilities?`: [`TypeFromPartialBitSchema`](schema_export.md#typefrompartialbitschema) ; `knownAddress?`: [`ServerAddress`](common_export.md#serveraddress) ; `timeoutSeconds?`: `number` } ; `passcode`: `number` } + +Options needed to commission a new node #### Defined in -packages/matter.js/src/MatterServer.ts:25 +[packages/matter.js/src/CommissioningController.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningController.ts#L73) ___ @@ -98,8 +128,19 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `uniqueNodeId?` | `string` | Unique node id to use for the storage context of this node. If not provided the order of node addition is used. | +| `uniqueNodeId?` | `string` | Deprecated name for uniqueStorageKey TODO: Remove with 0.8 or such **`Deprecated`** | +| `uniqueStorageKey?` | `string` | Unique storage key for this node to use for the storage context of this node. If not provided the order of node addition is used. | + +#### Defined in + +[packages/matter.js/src/MatterServer.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/MatterServer.ts#L19) + +## Variables + +### FORBIDDEN\_PASSCODES + +• `Const` **FORBIDDEN\_PASSCODES**: `number`[] #### Defined in -packages/matter.js/src/MatterServer.ts:20 +[packages/matter.js/src/CommissioningServer.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/CommissioningServer.ts#L75) diff --git a/docs/matter.js/modules/fabric_export.md b/docs/matter.js/modules/fabric_export.md index 6a2daf4d47..bdf91f1fa6 100644 --- a/docs/matter.js/modules/fabric_export.md +++ b/docs/matter.js/modules/fabric_export.md @@ -44,4 +44,4 @@ #### Defined in -packages/matter.js/src/fabric/Fabric.ts:31 +[packages/matter.js/src/fabric/Fabric.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/fabric/Fabric.ts#L31) diff --git a/docs/matter.js/modules/log_export.consoleLogger.md b/docs/matter.js/modules/log_export.consoleLogger.md index cbecea6be6..df6e4cd6ac 100644 --- a/docs/matter.js/modules/log_export.consoleLogger.md +++ b/docs/matter.js/modules/log_export.consoleLogger.md @@ -20,4 +20,4 @@ The target for consoleLogger. #### Defined in -packages/matter.js/src/log/Logger.ts:198 +[packages/matter.js/src/log/Logger.ts:198](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L198) diff --git a/docs/matter.js/modules/log_export.md b/docs/matter.js/modules/log_export.md index d20c347979..06a3be6ba7 100644 --- a/docs/matter.js/modules/log_export.md +++ b/docs/matter.js/modules/log_export.md @@ -43,4 +43,4 @@ Log messages to the console. This is the default logging mechanism. #### Defined in -packages/matter.js/src/log/Logger.ts:171 +[packages/matter.js/src/log/Logger.ts:171](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/log/Logger.ts#L171) diff --git a/docs/matter.js/modules/mdns_export.md b/docs/matter.js/modules/mdns_export.md index 69d0f030b1..263bd68df7 100644 --- a/docs/matter.js/modules/mdns_export.md +++ b/docs/matter.js/modules/mdns_export.md @@ -43,7 +43,7 @@ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:11 +[packages/matter.js/src/mdns/MdnsConsts.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L11) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:10 +[packages/matter.js/src/mdns/MdnsConsts.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L10) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:12 +[packages/matter.js/src/mdns/MdnsConsts.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L12) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:26 +[packages/matter.js/src/mdns/MdnsServer.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L26) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:27 +[packages/matter.js/src/mdns/MdnsServer.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L27) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsServer.ts:28 +[packages/matter.js/src/mdns/MdnsServer.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsServer.ts#L28) ___ @@ -103,7 +103,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:9 +[packages/matter.js/src/mdns/MdnsConsts.ts:9](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L9) ## Functions @@ -117,7 +117,7 @@ packages/matter.js/src/mdns/MdnsConsts.ts:9 #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:23 +[packages/matter.js/src/mdns/MdnsConsts.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L23) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:24 +[packages/matter.js/src/mdns/MdnsConsts.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L24) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:15 +[packages/matter.js/src/mdns/MdnsConsts.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L15) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:18 +[packages/matter.js/src/mdns/MdnsConsts.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L18) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:14 +[packages/matter.js/src/mdns/MdnsConsts.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L14) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:21 +[packages/matter.js/src/mdns/MdnsConsts.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L21) ___ @@ -238,7 +238,7 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:19 +[packages/matter.js/src/mdns/MdnsConsts.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L19) ___ @@ -258,4 +258,4 @@ ___ #### Defined in -packages/matter.js/src/mdns/MdnsConsts.ts:17 +[packages/matter.js/src/mdns/MdnsConsts.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/mdns/MdnsConsts.ts#L17) diff --git a/docs/matter.js/modules/model.Access.md b/docs/matter.js/modules/model.Access.md new file mode 100644 index 0000000000..191f3cbdef --- /dev/null +++ b/docs/matter.js/modules/model.Access.md @@ -0,0 +1,330 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / Access + +# Namespace: Access + +[model](model.md).Access + +## Table of contents + +### Enumerations + +- [Fabric](../enums/model.Access.Fabric.md) +- [Privilege](../enums/model.Access.Privilege.md) +- [PrivilegeName](../enums/model.Access.PrivilegeName.md) +- [Rw](../enums/model.Access.Rw.md) +- [Timed](../enums/model.Access.Timed.md) + +### Type Aliases + +- [Ast](model.Access.md#ast) +- [Authorization](model.Access.md#authorization) +- [Definition](model.Access.md#definition) +- [Flag](model.Access.md#flag) +- [Flags](model.Access.md#flags) +- [TimedTag](model.Access.md#timedtag) + +### Variables + +- [A](model.Access.md#a) +- [F](model.Access.md#f) +- [M](model.Access.md#m) +- [MA](model.Access.md#ma) +- [O](model.Access.md#o) +- [OA](model.Access.md#oa) +- [OM](model.Access.md#om) +- [PrivilegePriority](model.Access.md#privilegepriority) +- [R](model.Access.md#r) +- [RW](model.Access.md#rw) +- [RWo](model.Access.md#rwo) +- [S](model.Access.md#s) +- [T](model.Access.md#t) +- [U](model.Access.md#u) +- [V](model.Access.md#v) +- [VA](model.Access.md#va) +- [VM](model.Access.md#vm) +- [VO](model.Access.md#vo) +- [W](model.Access.md#w) + +## Type Aliases + +### Ast + +Ƭ **Ast**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `fabric?` | \`${Fabric}\` | +| `readPriv?` | \`${Privilege}\` | +| `rw?` | \`${Rw}\` | +| `timed?` | `boolean` | +| `writePriv?` | \`${Privilege}\` | + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:232](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L232) + +___ + +### Authorization + +Ƭ **Authorization**: typeof [`V`](model.Access.md#v) \| typeof [`VO`](model.Access.md#vo) \| typeof [`VM`](model.Access.md#vm) \| typeof [`VA`](model.Access.md#va) \| typeof [`O`](model.Access.md#o) \| typeof [`OM`](model.Access.md#om) \| typeof [`OA`](model.Access.md#oa) \| typeof [`M`](model.Access.md#m) \| typeof [`MA`](model.Access.md#ma) \| typeof [`A`](model.Access.md#a) + +All valid privilege tags. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:375](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L375) + +___ + +### Definition + +Ƭ **Definition**: [`Ast`](model.Access.md#ast) \| ([`Flag`](model.Access.md#flag) \| [`Authorization`](model.Access.md#authorization))[] \| `string` \| `undefined` + +Defines access as defined in the Matter 1.1 specification. + +In TypeScript and JavaScript, definitions adhering to this type look +like `[ RW, VA ]` or `[ Access.Rw.W, Access.Privilege.Operate ]`. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:398](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L398) + +___ + +### Flag + +Ƭ **Flag**: [`Rw`](../enums/model.Access.Rw.md) \| [`Fabric`](../enums/model.Access.Fabric.md) \| [`Privilege`](../enums/model.Access.Privilege.md) \| [`Timed`](../enums/model.Access.Timed.md) + +All atomic access control values. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:343](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L343) + +___ + +### Flags + +Ƭ **Flags**: [`Flag`](model.Access.md#flag)[] + +A defined set of access control values. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:348](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L348) + +___ + +### TimedTag + +Ƭ **TimedTag**: typeof [`T`](model.Access.md#t) + +All valid timed tags. + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:390](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L390) + +## Variables + +### A + +• `Const` **A**: [[`Administer`](../enums/model.Access.Privilege.md#administer)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:362](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L362) + +___ + +### F + +• `Const` **F**: [`Scoped`](../enums/model.Access.Fabric.md#scoped) = `Fabric.Scoped` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:356](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L356) + +___ + +### M + +• `Const` **M**: [[`Manage`](../enums/model.Access.Privilege.md#manage)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:361](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L361) + +___ + +### MA + +• `Const` **MA**: [[`Manage`](../enums/model.Access.Privilege.md#manage), [`Administer`](../enums/model.Access.Privilege.md#administer)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:368](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L368) + +___ + +### O + +• `Const` **O**: [[`Operate`](../enums/model.Access.Privilege.md#operate)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:360](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L360) + +___ + +### OA + +• `Const` **OA**: [[`Operate`](../enums/model.Access.Privilege.md#operate), [`Administer`](../enums/model.Access.Privilege.md#administer)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:367](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L367) + +___ + +### OM + +• `Const` **OM**: [[`Operate`](../enums/model.Access.Privilege.md#operate), [`Manage`](../enums/model.Access.Privilege.md#manage)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:366](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L366) + +___ + +### PrivilegePriority + +• `Const` **PrivilegePriority**: `Object` + +Relative ordering of privilege. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `A` | `number` | +| `M` | `number` | +| `O` | `number` | +| `V` | `number` | + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:323](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L323) + +___ + +### R + +• `Const` **R**: [`Read`](../enums/model.Access.Rw.md#read) = `Rw.Read` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:350](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L350) + +___ + +### RW + +• `Const` **RW**: [`ReadWrite`](../enums/model.Access.Rw.md#readwrite) = `Rw.ReadWrite` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:352](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L352) + +___ + +### RWo + +• `Const` **RWo**: [`ReadWriteOption`](../enums/model.Access.Rw.md#readwriteoption) = `Rw.ReadWriteOption` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:353](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L353) + +___ + +### S + +• `Const` **S**: [`Sensitive`](../enums/model.Access.Fabric.md#sensitive) = `Fabric.Sensitive` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:357](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L357) + +___ + +### T + +• `Const` **T**: [`Required`](../enums/model.Access.Timed.md#required) = `Timed.Required` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:370](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L370) + +___ + +### U + +• `Const` **U**: [`Unaware`](../enums/model.Access.Fabric.md#unaware) = `Fabric.Unaware` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:355](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L355) + +___ + +### V + +• `Const` **V**: [`View`](../enums/model.Access.Privilege.md#view) = `Privilege.View` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:359](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L359) + +___ + +### VA + +• `Const` **VA**: [[`View`](../enums/model.Access.Privilege.md#view), [`Administer`](../enums/model.Access.Privilege.md#administer)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:365](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L365) + +___ + +### VM + +• `Const` **VM**: [[`View`](../enums/model.Access.Privilege.md#view), [`Manage`](../enums/model.Access.Privilege.md#manage)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:364](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L364) + +___ + +### VO + +• `Const` **VO**: [[`View`](../enums/model.Access.Privilege.md#view), [`Operate`](../enums/model.Access.Privilege.md#operate)] + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:363](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L363) + +___ + +### W + +• `Const` **W**: [`Write`](../enums/model.Access.Rw.md#write) = `Rw.Write` + +#### Defined in + +[packages/matter.js/src/model/aspects/Access.ts:351](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Access.ts#L351) diff --git a/docs/matter.js/modules/model.AttributeElement.md b/docs/matter.js/modules/model.AttributeElement.md new file mode 100644 index 0000000000..08251dd864 --- /dev/null +++ b/docs/matter.js/modules/model.AttributeElement.md @@ -0,0 +1,50 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / AttributeElement + +# Namespace: AttributeElement + +[model](model.md).AttributeElement + +## Table of contents + +### Type Aliases + +- [Properties](model.AttributeElement.md#properties) +- [Tag](model.AttributeElement.md#tag) + +### Variables + +- [Tag](model.AttributeElement.md#tag-1) + +## Type Aliases + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`AttributeElement`](model.md#attributeelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/AttributeElement.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L26) + +___ + +### Tag + +Ƭ **Tag**: [`Attribute`](../enums/model.ElementTag.md#attribute) + +#### Defined in + +[packages/matter.js/src/model/elements/AttributeElement.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L24) + +[packages/matter.js/src/model/elements/AttributeElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L25) + +## Variables + +### Tag + +• **Tag**: [`Attribute`](../enums/model.ElementTag.md#attribute) + +#### Defined in + +[packages/matter.js/src/model/elements/AttributeElement.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L24) + +[packages/matter.js/src/model/elements/AttributeElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L25) diff --git a/docs/matter.js/modules/model.BaseElement.md b/docs/matter.js/modules/model.BaseElement.md new file mode 100644 index 0000000000..b004d578e7 --- /dev/null +++ b/docs/matter.js/modules/model.BaseElement.md @@ -0,0 +1,46 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / BaseElement + +# Namespace: BaseElement + +[model](model.md).BaseElement + +## Table of contents + +### Type Aliases + +- [ElementForProperties](model.BaseElement.md#elementforproperties) +- [Properties](model.BaseElement.md#properties) + +## Type Aliases + +### ElementForProperties + +Ƭ **ElementForProperties**<`P`\>: `P` extends [`Properties`](model.BaseElement.md#properties) ? `T` : `never` + +#### Type parameters + +| Name | +| :------ | +| `P` | + +#### Defined in + +[packages/matter.js/src/model/elements/BaseElement.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/BaseElement.ts#L75) + +___ + +### Properties + +Ƭ **Properties**<`T`\>: `Omit`<`T`, ``"tag"``\> & `Partial`<`Pick`<`T`, ``"tag"``\>\> + +Element with optional type; used for factory functions and constructors. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `Object` | + +#### Defined in + +[packages/matter.js/src/model/elements/BaseElement.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/BaseElement.ts#L80) diff --git a/docs/matter.js/modules/model.ClusterElement.md b/docs/matter.js/modules/model.ClusterElement.md new file mode 100644 index 0000000000..33ceb41034 --- /dev/null +++ b/docs/matter.js/modules/model.ClusterElement.md @@ -0,0 +1,65 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / ClusterElement + +# Namespace: ClusterElement + +[model](model.md).ClusterElement + +## Table of contents + +### Enumerations + +- [Classification](../enums/model.ClusterElement.Classification.md) + +### Type Aliases + +- [Child](model.ClusterElement.md#child) +- [Properties](model.ClusterElement.md#properties) +- [Tag](model.ClusterElement.md#tag) + +### Variables + +- [Tag](model.ClusterElement.md#tag-1) + +## Type Aliases + +### Child + +Ƭ **Child**: [`DatatypeElement`](model.md#datatypeelement) \| [`AttributeElement`](model.md#attributeelement) \| [`CommandElement`](model.md#commandelement) \| [`EventElement`](model.md#eventelement) + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L43) + +___ + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`ClusterElement`](model.md#clusterelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L42) + +___ + +### Tag + +Ƭ **Tag**: [`Cluster`](../enums/model.ElementTag.md#cluster) + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L40) + +[packages/matter.js/src/model/elements/ClusterElement.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L41) + +## Variables + +### Tag + +• **Tag**: [`Cluster`](../enums/model.ElementTag.md#cluster) + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L40) + +[packages/matter.js/src/model/elements/ClusterElement.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L41) diff --git a/docs/matter.js/modules/model.ClusterModel.md b/docs/matter.js/modules/model.ClusterModel.md new file mode 100644 index 0000000000..8aa1d19da3 --- /dev/null +++ b/docs/matter.js/modules/model.ClusterModel.md @@ -0,0 +1,21 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / ClusterModel + +# Namespace: ClusterModel + +[model](model.md).ClusterModel + +## Table of contents + +### Type Aliases + +- [Child](model.ClusterModel.md#child) + +## Type Aliases + +### Child + +Ƭ **Child**: [`DatatypeModel`](../classes/model.DatatypeModel.md) \| [`AttributeModel`](../classes/model.AttributeModel.md) \| [`CommandModel`](../classes/model.CommandModel.md) \| [`EventModel`](../classes/model.EventModel.md) + +#### Defined in + +[packages/matter.js/src/model/models/ClusterModel.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/ClusterModel.ts#L73) diff --git a/docs/matter.js/modules/model.CommandElement.md b/docs/matter.js/modules/model.CommandElement.md new file mode 100644 index 0000000000..7bd7548f03 --- /dev/null +++ b/docs/matter.js/modules/model.CommandElement.md @@ -0,0 +1,54 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / CommandElement + +# Namespace: CommandElement + +[model](model.md).CommandElement + +## Table of contents + +### Enumerations + +- [Direction](../enums/model.CommandElement.Direction.md) + +### Type Aliases + +- [Properties](model.CommandElement.md#properties) +- [Tag](model.CommandElement.md#tag) + +### Variables + +- [Tag](model.CommandElement.md#tag-1) + +## Type Aliases + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`CommandElement`](model.md#commandelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/CommandElement.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L31) + +___ + +### Tag + +Ƭ **Tag**: [`Command`](../enums/model.ElementTag.md#command) + +#### Defined in + +[packages/matter.js/src/model/elements/CommandElement.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L29) + +[packages/matter.js/src/model/elements/CommandElement.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L30) + +## Variables + +### Tag + +• **Tag**: [`Command`](../enums/model.ElementTag.md#command) + +#### Defined in + +[packages/matter.js/src/model/elements/CommandElement.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L29) + +[packages/matter.js/src/model/elements/CommandElement.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L30) diff --git a/docs/matter.js/modules/model.Conformance.Ast.md b/docs/matter.js/modules/model.Conformance.Ast.md new file mode 100644 index 0000000000..74913e345e --- /dev/null +++ b/docs/matter.js/modules/model.Conformance.Ast.md @@ -0,0 +1,103 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / [Conformance](model.Conformance.md) / Ast + +# Namespace: Ast + +[model](model.md).[Conformance](model.Conformance.md).Ast + +## Table of contents + +### Type Aliases + +- [BinaryOperands](model.Conformance.Ast.md#binaryoperands) +- [Choice](model.Conformance.Ast.md#choice) +- [Group](model.Conformance.Ast.md#group) +- [Name](model.Conformance.Ast.md#name) +- [Option](model.Conformance.Ast.md#option) +- [UnaryOperand](model.Conformance.Ast.md#unaryoperand) +- [Value](model.Conformance.Ast.md#value) + +## Type Aliases + +### BinaryOperands + +Ƭ **BinaryOperands**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `lhs` | [`Ast`](model.Conformance.md#ast) | +| `rhs` | [`Ast`](model.Conformance.md#ast) | + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:131](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L131) + +___ + +### Choice + +Ƭ **Choice**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `expr` | [`Ast`](model.Conformance.md#ast) | +| `name` | [`ChoiceName`](model.Conformance.md#choicename) | +| `num` | `number` | +| `orMore?` | `boolean` | + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L136) + +___ + +### Group + +Ƭ **Group**: [`Ast`](model.Conformance.md#ast)[] + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:135](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L135) + +___ + +### Name + +Ƭ **Name**: `string` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:127](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L127) + +___ + +### Option + +Ƭ **Option**: [`Ast`](model.Conformance.md#ast) + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:129](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L129) + +___ + +### UnaryOperand + +Ƭ **UnaryOperand**: [`Ast`](model.Conformance.md#ast) + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L130) + +___ + +### Value + +Ƭ **Value**: [`FieldValue`](model.md#fieldvalue) + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L128) diff --git a/docs/matter.js/modules/model.Conformance.md b/docs/matter.js/modules/model.Conformance.md new file mode 100644 index 0000000000..05c425dd86 --- /dev/null +++ b/docs/matter.js/modules/model.Conformance.md @@ -0,0 +1,401 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / Conformance + +# Namespace: Conformance + +[model](model.md).Conformance + +## Table of contents + +### Namespaces + +- [Ast](model.Conformance.Ast.md) + +### Enumerations + +- [Flag](../enums/model.Conformance.Flag.md) +- [Operator](../enums/model.Conformance.Operator.md) +- [Special](../enums/model.Conformance.Special.md) + +### Type Aliases + +- [Ast](model.Conformance.md#ast) +- [AstParam](model.Conformance.md#astparam) +- [ChoiceName](model.Conformance.md#choicename) +- [Definition](model.Conformance.md#definition) +- [Name](model.Conformance.md#name) +- [Number](model.Conformance.md#number) +- [ReferenceResolver](model.Conformance.md#referenceresolver) + +### Variables + +- [AND](model.Conformance.md#and) +- [D](model.Conformance.md#d) +- [DOT](model.Conformance.md#dot) +- [EQ](model.Conformance.md#eq) +- [GT](model.Conformance.md#gt) +- [GTE](model.Conformance.md#gte) +- [LT](model.Conformance.md#lt) +- [LTE](model.Conformance.md#lte) +- [M](model.Conformance.md#m) +- [NE](model.Conformance.md#ne) +- [O](model.Conformance.md#o) +- [OR](model.Conformance.md#or) +- [P](model.Conformance.md#p) +- [X](model.Conformance.md#x) +- [XOR](model.Conformance.md#xor) + +### Functions + +- [isBinaryOperator](model.Conformance.md#isbinaryoperator) +- [isHigherPrecedence](model.Conformance.md#ishigherprecedence) +- [precedenceOf](model.Conformance.md#precedenceof) +- [serialize](model.Conformance.md#serialize) +- [validateReferences](model.Conformance.md#validatereferences) + +## Type Aliases + +### Ast + +Ƭ **Ast**: { `type`: [`Empty`](../enums/model.Conformance.Special.md#empty) \| [`Desc`](../enums/model.Conformance.Special.md#desc) \| [`Flag`](../enums/model.Conformance.Flag.md) } \| { `param`: [`Name`](model.Conformance.Ast.md#name) ; `type`: [`Name`](../enums/model.Conformance.Special.md#name) } \| { `param`: [`Value`](model.Conformance.Ast.md#value) ; `type`: [`Value`](../enums/model.Conformance.Special.md#value) } \| { `param`: [`Choice`](model.Conformance.Ast.md#choice) ; `type`: [`Choice`](../enums/model.Conformance.Special.md#choice) } \| { `param`: [`Group`](model.Conformance.Ast.md#group) ; `type`: [`Group`](../enums/model.Conformance.Special.md#group) } \| { `param`: [`Option`](model.Conformance.Ast.md#option) ; `type`: [`OptionalIf`](../enums/model.Conformance.Special.md#optionalif) } \| { `param`: [`BinaryOperands`](model.Conformance.Ast.md#binaryoperands) ; `type`: [`AND`](../enums/model.Conformance.Operator.md#and) \| [`OR`](../enums/model.Conformance.Operator.md#or) \| [`XOR`](../enums/model.Conformance.Operator.md#xor) \| [`EQ`](../enums/model.Conformance.Operator.md#eq) \| [`NE`](../enums/model.Conformance.Operator.md#ne) \| [`LT`](../enums/model.Conformance.Operator.md#lt) \| [`GT`](../enums/model.Conformance.Operator.md#gt) \| [`LTE`](../enums/model.Conformance.Operator.md#lte) \| [`GTE`](../enums/model.Conformance.Operator.md#gte) } \| { `param`: [`UnaryOperand`](model.Conformance.Ast.md#unaryoperand) ; `type`: [`NOT`](../enums/model.Conformance.Operator.md#not) } + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L84) + +[packages/matter.js/src/model/aspects/Conformance.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L126) + +___ + +### AstParam + +Ƭ **AstParam**: [`Name`](model.Conformance.Ast.md#name) \| [`Value`](model.Conformance.Ast.md#value) \| [`Option`](model.Conformance.Ast.md#option) \| [`UnaryOperand`](model.Conformance.Ast.md#unaryoperand) \| [`BinaryOperands`](model.Conformance.Ast.md#binaryoperands) \| [`Group`](model.Conformance.Ast.md#group) \| [`Choice`](model.Conformance.Ast.md#choice) + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L74) + +___ + +### ChoiceName + +Ƭ **ChoiceName**: ``"a"`` \| ``"b"`` \| ``"c"`` \| ``"d"`` \| ``"e"`` \| ``"f"`` \| ``"g"`` \| ``"h"`` \| ``"i"`` \| ``"j"`` \| ``"k"`` \| ``"l"`` \| ``"m"`` \| ``"n"`` \| ``"o"`` \| ``"p"`` \| ``"q"`` \| ``"r"`` \| ``"s"`` \| ``"t"`` \| ``"u"`` \| ``"v"`` \| ``"w"`` \| ``"x"`` \| ``"y"`` \| ``"z"`` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L196) + +___ + +### Definition + +Ƭ **Definition**: `string` \| `string`[] \| { `ast`: [`Ast`](model.Conformance.md#ast) } \| `undefined` + +Supported ways of expressing conformance (conceptually union should +include Flag but that is covered by string). + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L230) + +___ + +### Name + +Ƭ **Name**: `string` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:192](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L192) + +___ + +### Number + +Ƭ **Number**: `number` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:194](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L194) + +___ + +### ReferenceResolver + +Ƭ **ReferenceResolver**<`T`\>: (`name`: `string`) => `T` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +▸ (`name`): `T` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +##### Returns + +`T` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:224](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L224) + +## Variables + +### AND + +• `Const` **AND**: [`AND`](../enums/model.Conformance.Operator.md#and) = `Operator.AND` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:185](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L185) + +___ + +### D + +• `Const` **D**: [`Deprecated`](../enums/model.Conformance.Flag.md#deprecated) = `Flag.Deprecated` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:179](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L179) + +___ + +### DOT + +• `Const` **DOT**: [`DOT`](../enums/model.Conformance.Operator.md#dot) = `Operator.DOT` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:186](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L186) + +___ + +### EQ + +• `Const` **EQ**: [`EQ`](../enums/model.Conformance.Operator.md#eq) = `Operator.EQ` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:181](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L181) + +___ + +### GT + +• `Const` **GT**: [`GT`](../enums/model.Conformance.Operator.md#gt) = `Operator.GT` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:187](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L187) + +___ + +### GTE + +• `Const` **GTE**: [`GTE`](../enums/model.Conformance.Operator.md#gte) = `Operator.GTE` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:189](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L189) + +___ + +### LT + +• `Const` **LT**: [`LT`](../enums/model.Conformance.Operator.md#lt) = `Operator.LT` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:188](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L188) + +___ + +### LTE + +• `Const` **LTE**: [`LTE`](../enums/model.Conformance.Operator.md#lte) = `Operator.LTE` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L190) + +___ + +### M + +• `Const` **M**: [`Mandatory`](../enums/model.Conformance.Flag.md#mandatory) = `Flag.Mandatory` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:176](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L176) + +___ + +### NE + +• `Const` **NE**: [`NE`](../enums/model.Conformance.Operator.md#ne) = `Operator.NE` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:182](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L182) + +___ + +### O + +• `Const` **O**: [`Optional`](../enums/model.Conformance.Flag.md#optional) = `Flag.Optional` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:177](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L177) + +___ + +### OR + +• `Const` **OR**: [`OR`](../enums/model.Conformance.Operator.md#or) = `Operator.OR` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L183) + +___ + +### P + +• `Const` **P**: [`Provisional`](../enums/model.Conformance.Flag.md#provisional) = `Flag.Provisional` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:178](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L178) + +___ + +### X + +• `Const` **X**: [`Disallowed`](../enums/model.Conformance.Flag.md#disallowed) = `Flag.Disallowed` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:180](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L180) + +___ + +### XOR + +• `Const` **XOR**: [`XOR`](../enums/model.Conformance.Operator.md#xor) = `Operator.XOR` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L184) + +## Functions + +### isBinaryOperator + +▸ **isBinaryOperator**(`type`): type is Operator + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | [`Empty`](../enums/model.Conformance.Special.md#empty) \| [`Desc`](../enums/model.Conformance.Special.md#desc) \| [`Name`](../enums/model.Conformance.Special.md#name) \| [`Value`](../enums/model.Conformance.Special.md#value) \| [`Choice`](../enums/model.Conformance.Special.md#choice) \| [`Group`](../enums/model.Conformance.Special.md#group) \| [`OptionalIf`](../enums/model.Conformance.Special.md#optionalif) \| [`Flag`](../enums/model.Conformance.Flag.md) \| [`Operator`](../enums/model.Conformance.Operator.md) | + +#### Returns + +type is Operator + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:331](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L331) + +___ + +### isHigherPrecedence + +▸ **isHigherPrecedence**(`operator`, `other`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operator` | [`Empty`](../enums/model.Conformance.Special.md#empty) \| [`Desc`](../enums/model.Conformance.Special.md#desc) \| [`Name`](../enums/model.Conformance.Special.md#name) \| [`Value`](../enums/model.Conformance.Special.md#value) \| [`Choice`](../enums/model.Conformance.Special.md#choice) \| [`Group`](../enums/model.Conformance.Special.md#group) \| [`OptionalIf`](../enums/model.Conformance.Special.md#optionalif) \| [`Flag`](../enums/model.Conformance.Flag.md) \| [`Operator`](../enums/model.Conformance.Operator.md) | +| `other` | [`Empty`](../enums/model.Conformance.Special.md#empty) \| [`Desc`](../enums/model.Conformance.Special.md#desc) \| [`Name`](../enums/model.Conformance.Special.md#name) \| [`Value`](../enums/model.Conformance.Special.md#value) \| [`Choice`](../enums/model.Conformance.Special.md#choice) \| [`Group`](../enums/model.Conformance.Special.md#group) \| [`OptionalIf`](../enums/model.Conformance.Special.md#optionalif) \| [`Flag`](../enums/model.Conformance.Flag.md) \| [`Operator`](../enums/model.Conformance.Operator.md) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:340](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L340) + +___ + +### precedenceOf + +▸ **precedenceOf**(`operator`): `undefined` \| `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `operator` | [`Empty`](../enums/model.Conformance.Special.md#empty) \| [`Desc`](../enums/model.Conformance.Special.md#desc) \| [`Name`](../enums/model.Conformance.Special.md#name) \| [`Value`](../enums/model.Conformance.Special.md#value) \| [`Choice`](../enums/model.Conformance.Special.md#choice) \| [`Group`](../enums/model.Conformance.Special.md#group) \| [`OptionalIf`](../enums/model.Conformance.Special.md#optionalif) \| [`Flag`](../enums/model.Conformance.Flag.md) \| [`Operator`](../enums/model.Conformance.Operator.md) | + +#### Returns + +`undefined` \| `number` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:335](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L335) + +___ + +### serialize + +▸ **serialize**(`ast`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ast` | [`Ast`](model.Conformance.md#ast) | + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:280](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L280) + +___ + +### validateReferences + +▸ **validateReferences**(`conformance`, `ast`, `resolver`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `conformance` | [`Conformance`](../classes/model.Conformance-1.md) | +| `ast` | [`Ast`](model.Conformance.md#ast) | +| `resolver` | [`ReferenceResolver`](model.Conformance.md#referenceresolver)<`boolean`\> | + +#### Returns + +`void` + +#### Defined in + +[packages/matter.js/src/model/aspects/Conformance.ts:244](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Conformance.ts#L244) diff --git a/docs/matter.js/modules/model.Constraint.md b/docs/matter.js/modules/model.Constraint.md new file mode 100644 index 0000000000..36ea174d23 --- /dev/null +++ b/docs/matter.js/modules/model.Constraint.md @@ -0,0 +1,106 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / Constraint + +# Namespace: Constraint + +[model](model.md).Constraint + +## Table of contents + +### Type Aliases + +- [Ast](model.Constraint.md#ast) +- [Definition](model.Constraint.md#definition) +- [NumberOrIdentifier](model.Constraint.md#numberoridentifier) + +### Functions + +- [parse](model.Constraint.md#parse) +- [serialize](model.Constraint.md#serialize) + +## Type Aliases + +### Ast + +Ƭ **Ast**: `Object` + +Parsed list structure. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `desc?` | `boolean` | Indicates constraint is defined in prose and cannot be enforced automatically. | +| `entry?` | [`Ast`](model.Constraint.md#ast) | Constraint on list child element. | +| `max?` | [`FieldValue`](model.md#fieldvalue) | Upper bound on value or sequence length. | +| `min?` | [`FieldValue`](model.md#fieldvalue) | Lower bound on value or sequence length. | +| `parts?` | [`Ast`](model.Constraint.md#ast)[] | List of sub-constraints in a sequence. | +| `value?` | [`FieldValue`](model.md#fieldvalue) | Constant value. | + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:94](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L94) + +___ + +### Definition + +Ƭ **Definition**: [`Ast`](model.Constraint.md#ast) & { `definition?`: [`Definition`](model.Constraint.md#definition) } \| `string` \| `number` \| `undefined` + +These are all ways to describe a constraint. + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L130) + +___ + +### NumberOrIdentifier + +Ƭ **NumberOrIdentifier**: `number` \| `string` + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L89) + +## Functions + +### parse + +▸ **parse**(`constraint`, `definition`): [`Ast`](model.Constraint.md#ast) + +Parse constraint DSL. Extremely lenient. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `constraint` | [`Constraint`](../classes/model.Constraint-1.md) | +| `definition` | `string` | + +#### Returns + +[`Ast`](model.Constraint.md#ast) + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L229) + +___ + +### serialize + +▸ **serialize**(`ast`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ast` | [`Ast`](model.Constraint.md#ast) | + +#### Returns + +`string` + +#### Defined in + +[packages/matter.js/src/model/aspects/Constraint.ts:354](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Constraint.ts#L354) diff --git a/docs/matter.js/modules/model.DatatypeElement.md b/docs/matter.js/modules/model.DatatypeElement.md new file mode 100644 index 0000000000..0c8213bcc0 --- /dev/null +++ b/docs/matter.js/modules/model.DatatypeElement.md @@ -0,0 +1,116 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / DatatypeElement + +# Namespace: DatatypeElement + +[model](model.md).DatatypeElement + +## Table of contents + +### Type Aliases + +- [ListValues](model.DatatypeElement.md#listvalues) +- [Properties](model.DatatypeElement.md#properties) +- [Tag](model.DatatypeElement.md#tag) +- [ValueMap](model.DatatypeElement.md#valuemap) + +### Variables + +- [Tag](model.DatatypeElement.md#tag-1) + +### Functions + +- [ListValues](model.DatatypeElement.md#listvalues-1) + +## Type Aliases + +### ListValues + +Ƭ **ListValues**: [`DatatypeElement`](model.md#datatypeelement)[] + +We express enum values as IntElements as this gives us conformance +and other metadata. + +#### Defined in + +[packages/matter.js/src/model/elements/DatatypeElement.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L50) + +[packages/matter.js/src/model/elements/DatatypeElement.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L73) + +___ + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`DatatypeElement`](model.md#datatypeelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/DatatypeElement.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L41) + +___ + +### Tag + +Ƭ **Tag**: [`Datatype`](../enums/model.ElementTag.md#datatype) + +#### Defined in + +[packages/matter.js/src/model/elements/DatatypeElement.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L39) + +[packages/matter.js/src/model/elements/DatatypeElement.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L40) + +___ + +### ValueMap + +Ƭ **ValueMap**: `Object` + +Per the Matter specification, enums are named integers. The following +allows TypeScript enums to be supplied for translation into Matter +enums. To do so, we must accept both numeric and string values. For +generating the Matter enum we ignore the string keys. + +#### Index signature + +▪ [name: `string`]: `number` \| `string` + +#### Defined in + +[packages/matter.js/src/model/elements/DatatypeElement.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L81) + +## Variables + +### Tag + +• **Tag**: [`Datatype`](../enums/model.ElementTag.md#datatype) + +#### Defined in + +[packages/matter.js/src/model/elements/DatatypeElement.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L39) + +[packages/matter.js/src/model/elements/DatatypeElement.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L40) + +## Functions + +### ListValues + +▸ **ListValues**(`values`): [`ListValues`](model.DatatypeElement.md#listvalues) + +Convert a TypeScript enum to Matter enum values. + +Matter enums include conformance and other metadata. They may also have +multiple definitions of the same value selectable by conformance. So +we can't use a TypeScript enum directly. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `values` | [`ValueMap`](model.DatatypeElement.md#valuemap) | + +#### Returns + +[`ListValues`](model.DatatypeElement.md#listvalues) + +#### Defined in + +[packages/matter.js/src/model/elements/DatatypeElement.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L50) diff --git a/docs/matter.js/modules/model.DeviceTypeElement.md b/docs/matter.js/modules/model.DeviceTypeElement.md new file mode 100644 index 0000000000..a9f0650a6e --- /dev/null +++ b/docs/matter.js/modules/model.DeviceTypeElement.md @@ -0,0 +1,54 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / DeviceTypeElement + +# Namespace: DeviceTypeElement + +[model](model.md).DeviceTypeElement + +## Table of contents + +### Enumerations + +- [Classification](../enums/model.DeviceTypeElement.Classification.md) + +### Type Aliases + +- [Properties](model.DeviceTypeElement.md#properties) +- [Tag](model.DeviceTypeElement.md#tag) + +### Variables + +- [Tag](model.DeviceTypeElement.md#tag-1) + +## Type Aliases + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`DeviceTypeElement`](model.md#devicetypeelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L32) + +___ + +### Tag + +Ƭ **Tag**: [`DeviceType`](../enums/model.ElementTag.md#devicetype) + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L30) + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L31) + +## Variables + +### Tag + +• **Tag**: [`DeviceType`](../enums/model.ElementTag.md#devicetype) + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L30) + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L31) diff --git a/docs/matter.js/modules/model.EndpointElement.md b/docs/matter.js/modules/model.EndpointElement.md new file mode 100644 index 0000000000..869d7df6fe --- /dev/null +++ b/docs/matter.js/modules/model.EndpointElement.md @@ -0,0 +1,50 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / EndpointElement + +# Namespace: EndpointElement + +[model](model.md).EndpointElement + +## Table of contents + +### Type Aliases + +- [Properties](model.EndpointElement.md#properties) +- [Tag](model.EndpointElement.md#tag) + +### Variables + +- [Tag](model.EndpointElement.md#tag-1) + +## Type Aliases + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`DeviceTypeElement`](model.md#devicetypeelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/EndpointElement.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L27) + +___ + +### Tag + +Ƭ **Tag**: [`Endpoint`](../enums/model.ElementTag.md#endpoint) + +#### Defined in + +[packages/matter.js/src/model/elements/EndpointElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L25) + +[packages/matter.js/src/model/elements/EndpointElement.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L26) + +## Variables + +### Tag + +• **Tag**: [`Endpoint`](../enums/model.ElementTag.md#endpoint) + +#### Defined in + +[packages/matter.js/src/model/elements/EndpointElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L25) + +[packages/matter.js/src/model/elements/EndpointElement.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L26) diff --git a/docs/matter.js/modules/model.EventElement.md b/docs/matter.js/modules/model.EventElement.md new file mode 100644 index 0000000000..ea84cc412f --- /dev/null +++ b/docs/matter.js/modules/model.EventElement.md @@ -0,0 +1,55 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / EventElement + +# Namespace: EventElement + +[model](model.md).EventElement + +## Table of contents + +### Enumerations + +- [Priority](../enums/model.EventElement.Priority.md) +- [PriorityId](../enums/model.EventElement.PriorityId.md) + +### Type Aliases + +- [Properties](model.EventElement.md#properties) +- [Tag](model.EventElement.md#tag) + +### Variables + +- [Tag](model.EventElement.md#tag-1) + +## Type Aliases + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`EventElement`](model.md#eventelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L29) + +___ + +### Tag + +Ƭ **Tag**: [`Event`](../enums/model.ElementTag.md#event) + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L27) + +[packages/matter.js/src/model/elements/EventElement.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L28) + +## Variables + +### Tag + +• **Tag**: [`Event`](../enums/model.ElementTag.md#event) + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L27) + +[packages/matter.js/src/model/elements/EventElement.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L28) diff --git a/docs/matter.js/modules/model.FabricElement.md b/docs/matter.js/modules/model.FabricElement.md new file mode 100644 index 0000000000..2d93f7840a --- /dev/null +++ b/docs/matter.js/modules/model.FabricElement.md @@ -0,0 +1,50 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / FabricElement + +# Namespace: FabricElement + +[model](model.md).FabricElement + +## Table of contents + +### Type Aliases + +- [Properties](model.FabricElement.md#properties) +- [Tag](model.FabricElement.md#tag) + +### Variables + +- [Tag](model.FabricElement.md#tag-1) + +## Type Aliases + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`FabricElement`](model.md#fabricelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/FabricElement.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L27) + +___ + +### Tag + +Ƭ **Tag**: [`Fabric`](../enums/model.ElementTag.md#fabric) + +#### Defined in + +[packages/matter.js/src/model/elements/FabricElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L25) + +[packages/matter.js/src/model/elements/FabricElement.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L26) + +## Variables + +### Tag + +• **Tag**: [`Fabric`](../enums/model.ElementTag.md#fabric) + +#### Defined in + +[packages/matter.js/src/model/elements/FabricElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L25) + +[packages/matter.js/src/model/elements/FabricElement.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L26) diff --git a/docs/matter.js/modules/model.FeatureSet.md b/docs/matter.js/modules/model.FeatureSet.md new file mode 100644 index 0000000000..ca40518431 --- /dev/null +++ b/docs/matter.js/modules/model.FeatureSet.md @@ -0,0 +1,43 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / FeatureSet + +# Namespace: FeatureSet + +[model](model.md).FeatureSet + +## Table of contents + +### Type Aliases + +- [Definition](model.FeatureSet.md#definition) +- [Flag](model.FeatureSet.md#flag) +- [Flags](model.FeatureSet.md#flags) + +## Type Aliases + +### Definition + +Ƭ **Definition**: [`Flags`](model.FeatureSet.md#flags) \| { `[name: string]`: `boolean`; } + +#### Defined in + +[packages/matter.js/src/model/definitions/FeatureSet.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FeatureSet.ts#L47) + +___ + +### Flag + +Ƭ **Flag**: `string` + +#### Defined in + +[packages/matter.js/src/model/definitions/FeatureSet.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FeatureSet.ts#L45) + +___ + +### Flags + +Ƭ **Flags**: `Iterable`<[`Flag`](model.FeatureSet.md#flag)\> + +#### Defined in + +[packages/matter.js/src/model/definitions/FeatureSet.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FeatureSet.ts#L46) diff --git a/docs/matter.js/modules/model.FieldValue.md b/docs/matter.js/modules/model.FieldValue.md new file mode 100644 index 0000000000..992cf072ee --- /dev/null +++ b/docs/matter.js/modules/model.FieldValue.md @@ -0,0 +1,454 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / FieldValue + +# Namespace: FieldValue + +[model](model.md).FieldValue + +## Table of contents + +### Type Aliases + +- [Celsius](model.FieldValue.md#celsius) +- [Invalid](model.FieldValue.md#invalid) +- [Percent](model.FieldValue.md#percent) +- [Properties](model.FieldValue.md#properties) +- [Reference](model.FieldValue.md#reference) +- [Type](model.FieldValue.md#type) +- [celsius](model.FieldValue.md#celsius-1) +- [percent](model.FieldValue.md#percent-1) +- [properties](model.FieldValue.md#properties-1) +- [reference](model.FieldValue.md#reference-1) + +### Variables + +- [Invalid](model.FieldValue.md#invalid-1) +- [celsius](model.FieldValue.md#celsius-2) +- [percent](model.FieldValue.md#percent-2) +- [properties](model.FieldValue.md#properties-2) +- [reference](model.FieldValue.md#reference-2) + +### Functions + +- [Celsius](model.FieldValue.md#celsius-3) +- [Percent](model.FieldValue.md#percent-3) +- [Reference](model.FieldValue.md#reference-3) +- [is](model.FieldValue.md#is) +- [numericValue](model.FieldValue.md#numericvalue) +- [objectValue](model.FieldValue.md#objectvalue) +- [referenced](model.FieldValue.md#referenced) +- [serialize](model.FieldValue.md#serialize) +- [unwrap](model.FieldValue.md#unwrap) + +## Type Aliases + +### Celsius + +Ƭ **Celsius**: `Object` + +Celsius value, typically .1°C or .01°C + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `type` | [`celsius`](model.FieldValue.md#celsius-2) | +| `value` | `number` | + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L84) + +[packages/matter.js/src/model/definitions/FieldValue.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L79) + +___ + +### Invalid + +Ƭ **Invalid**: typeof [`Invalid`](model.FieldValue.md#invalid-1) + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L61) + +[packages/matter.js/src/model/definitions/FieldValue.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L62) + +___ + +### Percent + +Ƭ **Percent**: `Object` + +Percent value, units of either 1% (.01) or .01% (.0001) + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `type` | [`percent`](model.FieldValue.md#percent-2) | +| `value` | `number` | + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L96) + +[packages/matter.js/src/model/definitions/FieldValue.ts:91](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L91) + +___ + +### Properties + +Ƭ **Properties**: `Object` + +A set of struct property values keyed by name. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `properties` | { `[name: string]`: [`FieldValue`](model.md#fieldvalue); } | +| `type` | [`properties`](model.FieldValue.md#properties-2) | + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L103) + +___ + +### Reference + +Ƭ **Reference**: `Object` + +Reference to a named field + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `type` | [`reference`](model.FieldValue.md#reference-2) | + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L72) + +[packages/matter.js/src/model/definitions/FieldValue.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L67) + +___ + +### Type + +Ƭ **Type**: [`percent`](model.FieldValue.md#percent-2) \| [`celsius`](model.FieldValue.md#celsius-2) \| [`reference`](model.FieldValue.md#reference-2) \| [`properties`](model.FieldValue.md#properties-2) + +If a field value isn't a primitive type, it's an object with a type +field indicating one of these types. + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L48) + +___ + +### celsius + +Ƭ **celsius**: typeof [`celsius`](model.FieldValue.md#celsius-2) + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L35) + +[packages/matter.js/src/model/definitions/FieldValue.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L36) + +___ + +### percent + +Ƭ **percent**: typeof [`percent`](model.FieldValue.md#percent-2) + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L32) + +[packages/matter.js/src/model/definitions/FieldValue.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L33) + +___ + +### properties + +Ƭ **properties**: typeof [`properties`](model.FieldValue.md#properties-2) + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L41) + +[packages/matter.js/src/model/definitions/FieldValue.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L42) + +___ + +### reference + +Ƭ **reference**: typeof [`reference`](model.FieldValue.md#reference-2) + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L38) + +[packages/matter.js/src/model/definitions/FieldValue.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L39) + +## Variables + +### Invalid + +• `Const` **Invalid**: unique `symbol` + +Flag for an invalid value. Not part of the FieldValue union but +returned when casting to a field value if the cast is impossible + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L61) + +[packages/matter.js/src/model/definitions/FieldValue.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L62) + +___ + +### celsius + +• `Const` **celsius**: ``"celsius"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L35) + +[packages/matter.js/src/model/definitions/FieldValue.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L36) + +___ + +### percent + +• `Const` **percent**: ``"percent"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L32) + +[packages/matter.js/src/model/definitions/FieldValue.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L33) + +___ + +### properties + +• `Const` **properties**: ``"properties"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L41) + +[packages/matter.js/src/model/definitions/FieldValue.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L42) + +___ + +### reference + +• `Const` **reference**: ``"reference"`` + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L38) + +[packages/matter.js/src/model/definitions/FieldValue.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L39) + +## Functions + +### Celsius + +▸ **Celsius**(`value`): [`Celsius`](model.FieldValue.md#celsius) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | + +#### Returns + +[`Celsius`](model.FieldValue.md#celsius) + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:84](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L84) + +___ + +### Percent + +▸ **Percent**(`value`): [`Percent`](model.FieldValue.md#percent) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | + +#### Returns + +[`Percent`](model.FieldValue.md#percent) + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:96](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L96) + +___ + +### Reference + +▸ **Reference**(`name`): [`Reference`](model.FieldValue.md#reference) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `name` | `string` | + +#### Returns + +[`Reference`](model.FieldValue.md#reference) + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L72) + +___ + +### is + +▸ **is**(`value`, `type`): `undefined` \| ``null`` \| `boolean` \| ``""`` \| ``0`` \| `0n` + +Test for one of the special placeholder types. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `undefined` \| [`FieldValue`](model.md#fieldvalue) | +| `type` | [`Type`](model.FieldValue.md#type) | + +#### Returns + +`undefined` \| ``null`` \| `boolean` \| ``""`` \| ``0`` \| `0n` + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L53) + +___ + +### numericValue + +▸ **numericValue**(`value`, `typeName?`): `undefined` \| `number` + +Given a type name as a hint, do our best to convert a field value to a +number. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `undefined` \| [`FieldValue`](model.md#fieldvalue) | +| `typeName?` | `string` | + +#### Returns + +`undefined` \| `number` + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:134](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L134) + +___ + +### objectValue + +▸ **objectValue**(`value`): `undefined` \| { `[name: string]`: [`FieldValue`](model.md#fieldvalue); } + +Extract object properties from the value. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `undefined` \| [`FieldValue`](model.md#fieldvalue) | + +#### Returns + +`undefined` \| { `[name: string]`: [`FieldValue`](model.md#fieldvalue); } + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L172) + +___ + +### referenced + +▸ **referenced**(`value`): `undefined` \| `string` + +Get the referenced name if the FieldValue is a reference. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `undefined` \| [`FieldValue`](model.md#fieldvalue) | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:210](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L210) + +___ + +### serialize + +▸ **serialize**(`value`): `undefined` \| `string` + +Convert the field value to a "defacto-standard" form. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | [`FieldValue`](model.md#fieldvalue) | + +#### Returns + +`undefined` \| `string` + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L111) + +___ + +### unwrap + +▸ **unwrap**(`value`, `typeName?`): `undefined` \| ``null`` \| `string` \| `number` \| `bigint` \| `boolean` \| `Date` \| [] \| { `[name: string]`: [`FieldValue`](model.md#fieldvalue); } + +Unwrap wrapped values, leave others as-is. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `undefined` \| [`FieldValue`](model.md#fieldvalue) | +| `typeName?` | `string` | + +#### Returns + +`undefined` \| ``null`` \| `string` \| `number` \| `bigint` \| `boolean` \| `Date` \| [] \| { `[name: string]`: [`FieldValue`](model.md#fieldvalue); } + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:181](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L181) diff --git a/docs/matter.js/modules/model.MatterElement.md b/docs/matter.js/modules/model.MatterElement.md new file mode 100644 index 0000000000..70976b3932 --- /dev/null +++ b/docs/matter.js/modules/model.MatterElement.md @@ -0,0 +1,61 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / MatterElement + +# Namespace: MatterElement + +[model](model.md).MatterElement + +## Table of contents + +### Type Aliases + +- [Child](model.MatterElement.md#child) +- [Properties](model.MatterElement.md#properties) +- [Tag](model.MatterElement.md#tag) + +### Variables + +- [Tag](model.MatterElement.md#tag-1) + +## Type Aliases + +### Child + +Ƭ **Child**: [`ClusterElement`](model.md#clusterelement) \| [`DeviceTypeElement`](model.md#devicetypeelement) \| [`FabricElement`](model.md#fabricelement) \| [`NodeElement`](model.md#nodeelement) \| [`DatatypeElement`](model.md#datatypeelement) \| [`AttributeElement`](model.md#attributeelement) + +#### Defined in + +[packages/matter.js/src/model/elements/MatterElement.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L33) + +___ + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`MatterElement`](model.md#matterelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/MatterElement.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L32) + +___ + +### Tag + +Ƭ **Tag**: [`Matter`](../enums/model.ElementTag.md#matter) + +#### Defined in + +[packages/matter.js/src/model/elements/MatterElement.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L30) + +[packages/matter.js/src/model/elements/MatterElement.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L31) + +## Variables + +### Tag + +• **Tag**: [`Matter`](../enums/model.ElementTag.md#matter) + +#### Defined in + +[packages/matter.js/src/model/elements/MatterElement.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L30) + +[packages/matter.js/src/model/elements/MatterElement.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L31) diff --git a/docs/matter.js/modules/model.MatterModel.md b/docs/matter.js/modules/model.MatterModel.md new file mode 100644 index 0000000000..04dc714196 --- /dev/null +++ b/docs/matter.js/modules/model.MatterModel.md @@ -0,0 +1,21 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / MatterModel + +# Namespace: MatterModel + +[model](model.md).MatterModel + +## Table of contents + +### Type Aliases + +- [Child](model.MatterModel.md#child) + +## Type Aliases + +### Child + +Ƭ **Child**: [`ClusterModel`](../classes/model.ClusterModel-1.md) \| [`DeviceTypeModel`](../classes/model.DeviceTypeModel.md) \| [`DatatypeModel`](../classes/model.DatatypeModel.md) \| [`AttributeModel`](../classes/model.AttributeModel.md) \| [`FabricModel`](../classes/model.FabricModel.md) + +#### Defined in + +[packages/matter.js/src/model/models/MatterModel.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/MatterModel.ts#L78) diff --git a/docs/matter.js/modules/model.MergeModels.md b/docs/matter.js/modules/model.MergeModels.md new file mode 100644 index 0000000000..cc86df5cc2 --- /dev/null +++ b/docs/matter.js/modules/model.MergeModels.md @@ -0,0 +1,46 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / MergeModels + +# Namespace: MergeModels + +[model](model.md).MergeModels + +## Table of contents + +### Type Aliases + +- [Priorities](model.MergeModels.md#priorities) + +### Variables + +- [DefaultPriorities](model.MergeModels.md#defaultpriorities) + +## Type Aliases + +### Priorities + +Ƭ **Priorities**: `Object` + +Priorities define rules that control how values are merged. + +#### Index signature + +▪ [typeName: `string`]: { `[fieldName: string]`: `string`[]; } + +#### Defined in + +[packages/matter.js/src/model/logic/MergeModels.ts:286](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/MergeModels.ts#L286) + +## Variables + +### DefaultPriorities + +• `Const` **DefaultPriorities**: [`Priorities`](model.MergeModels.md#priorities) + +A default set of priorities for the variants included with matter.js. +We currently have "chip" as preferred over "spec" by default, but then +have overridden to reverse this for a lot of fields. Should probably +revisit the default at some point. + +#### Defined in + +[packages/matter.js/src/model/logic/MergeModels.ts:304](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/MergeModels.ts#L304) diff --git a/docs/matter.js/modules/model.Metatype.md b/docs/matter.js/modules/model.Metatype.md new file mode 100644 index 0000000000..bd182457a4 --- /dev/null +++ b/docs/matter.js/modules/model.Metatype.md @@ -0,0 +1,98 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / Metatype + +# Namespace: Metatype + +[model](model.md).Metatype + +## Table of contents + +### Type Aliases + +- [NativeType](model.Metatype.md#nativetype) + +### Functions + +- [cast](model.Metatype.md#cast) +- [hasChildren](model.Metatype.md#haschildren) +- [native](model.Metatype.md#native) + +## Type Aliases + +### NativeType + +Ƭ **NativeType**: typeof `Boolean` \| typeof `BigInt` \| typeof `Number` \| typeof [`ByteArray`](util_export.md#bytearray-1) \| typeof `Array` \| typeof `Object` \| typeof `String` \| typeof `Date` + +These are the native types used by this module. + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:235](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L235) + +## Functions + +### cast + +▸ **cast**(`type`, `value`): [`FieldValue`](model.md#fieldvalue) \| [`Invalid`](model.FieldValue.md#invalid-1) \| `undefined` + +Cast a value to a specific type. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `type` | [`Metatype`](../enums/model.Metatype-1.md) | casts to a native equivalent of this type | +| `value` | [`FieldValue`](model.md#fieldvalue) | value to cast | + +#### Returns + +[`FieldValue`](model.md#fieldvalue) \| [`Invalid`](model.FieldValue.md#invalid-1) \| `undefined` + +the cast value or FieldValue.Invalid if cast is not possible + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L83) + +___ + +### hasChildren + +▸ **hasChildren**(`type`): `boolean` + +Does the specific type have children? + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) | + +#### Returns + +`boolean` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:31](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L31) + +___ + +### native + +▸ **native**(`type`): `undefined` \| `ObjectConstructor` \| `StringConstructor` \| `BooleanConstructor` \| `NumberConstructor` \| `DateConstructor` \| `ArrayConstructor` \| `Uint8ArrayConstructor` \| `BigIntConstructor` + +Determine the JS type for a metatype. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `undefined` \| [`Metatype`](../enums/model.Metatype-1.md) | + +#### Returns + +`undefined` \| `ObjectConstructor` \| `StringConstructor` \| `BooleanConstructor` \| `NumberConstructor` \| `DateConstructor` \| `ArrayConstructor` \| `Uint8ArrayConstructor` \| `BigIntConstructor` + +#### Defined in + +[packages/matter.js/src/model/definitions/Metatype.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Metatype.ts#L46) diff --git a/docs/matter.js/modules/model.Model.md b/docs/matter.js/modules/model.Model.md new file mode 100644 index 0000000000..355b0fcd86 --- /dev/null +++ b/docs/matter.js/modules/model.Model.md @@ -0,0 +1,79 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / Model + +# Namespace: Model + +[model](model.md).Model + +## Table of contents + +### Classes + +- [CrossReference](../classes/model.Model.CrossReference.md) + +### Type Aliases + +- [Constructor](model.Model.md#constructor) +- [LookupPredicate](model.Model.md#lookuppredicate) +- [PropertyValidation](model.Model.md#propertyvalidation) + +## Type Aliases + +### Constructor + +Ƭ **Constructor**<`T`\>: (...`args`: `any`) => `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](../classes/model.Model-1.md) | + +#### Type declaration + +• (`...args`) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | `any` | + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:394](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L394) + +___ + +### LookupPredicate + +Ƭ **LookupPredicate**<`T`\>: [`Constructor`](model.Model.md#constructor)<`T`\> \| { `test`: (`model`: [`Model`](../classes/model.Model-1.md)) => `boolean` ; `type`: [`Constructor`](model.Model.md#constructor)<`T`\> } + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Model`](../classes/model.Model-1.md) | + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:396](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L396) + +___ + +### PropertyValidation + +Ƭ **PropertyValidation**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `nullable?` | `boolean` | +| `required?` | `boolean` | +| `type` | `string` \| (...`args`: `any`[]) => `any` \| { `[key: string \| number]`: `any`; } \| `undefined` | +| `values?` | { `[name: string]`: `any`; } | + +#### Defined in + +[packages/matter.js/src/model/models/Model.ts:400](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/models/Model.ts#L400) diff --git a/docs/matter.js/modules/model.NodeElement.md b/docs/matter.js/modules/model.NodeElement.md new file mode 100644 index 0000000000..6d569e7a30 --- /dev/null +++ b/docs/matter.js/modules/model.NodeElement.md @@ -0,0 +1,50 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / NodeElement + +# Namespace: NodeElement + +[model](model.md).NodeElement + +## Table of contents + +### Type Aliases + +- [Properties](model.NodeElement.md#properties) +- [Tag](model.NodeElement.md#tag) + +### Variables + +- [Tag](model.NodeElement.md#tag-1) + +## Type Aliases + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`NodeElement`](model.md#nodeelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/NodeElement.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L27) + +___ + +### Tag + +Ƭ **Tag**: [`Node`](../enums/model.ElementTag.md#node) + +#### Defined in + +[packages/matter.js/src/model/elements/NodeElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L25) + +[packages/matter.js/src/model/elements/NodeElement.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L26) + +## Variables + +### Tag + +• **Tag**: [`Node`](../enums/model.ElementTag.md#node) + +#### Defined in + +[packages/matter.js/src/model/elements/NodeElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L25) + +[packages/matter.js/src/model/elements/NodeElement.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L26) diff --git a/docs/matter.js/modules/model.Quality.md b/docs/matter.js/modules/model.Quality.md new file mode 100644 index 0000000000..bb631c8bd2 --- /dev/null +++ b/docs/matter.js/modules/model.Quality.md @@ -0,0 +1,142 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / Quality + +# Namespace: Quality + +[model](model.md).Quality + +## Table of contents + +### Enumerations + +- [Field](../enums/model.Quality.Field.md) +- [Flag](../enums/model.Quality.Flag.md) + +### Type Aliases + +- [AllProperties](model.Quality.md#allproperties) +- [Ast](model.Quality.md#ast) +- [Attribute](model.Quality.md#attribute) +- [AttributeData](model.Quality.md#attributedata) +- [DataField](model.Quality.md#datafield) +- [Definition](model.Quality.md#definition) +- [DeviceType](model.Quality.md#devicetype) +- [FlagName](model.Quality.md#flagname) + +### Variables + +- [FlagNames](model.Quality.md#flagnames) + +## Type Aliases + +### AllProperties + +Ƭ **AllProperties**: [`Attribute`](model.Quality.md#attribute) & { `singleton?`: `boolean` } + +Quality properties that apply to device types. + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L190) + +___ + +### Ast + +Ƭ **Ast**: [`DeviceType`](model.Quality.md#devicetype) + +Values for all qualities designated as "other qualities" in the Matter +specification. + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:211](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L211) + +___ + +### Attribute + +Ƭ **Attribute**: [`AttributeData`](model.Quality.md#attributedata) & { `reportable?`: `boolean` ; `scene?`: `boolean` } + +Quality values that apply to attributes. + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:175](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L175) + +___ + +### AttributeData + +Ƭ **AttributeData**: [`DataField`](model.Quality.md#datafield) & { `changesOmitted?`: `boolean` ; `fixed?`: `boolean` ; `nonvolatile?`: `boolean` } + +Quality values that apply to attribute data. + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L154) + +___ + +### DataField + +Ƭ **DataField**: `Object` + +Quality values that apply to data fields. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `nullable?` | `boolean` | Designates a data field as nullable? Scope: data field | + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L142) + +___ + +### Definition + +Ƭ **Definition**: [`Ast`](model.Quality.md#ast) \| \`${Flag}\`[] \| `string` \| `undefined` + +Various ways to define quality. + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:101](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L101) + +___ + +### DeviceType + +Ƭ **DeviceType**: [`AllProperties`](model.Quality.md#allproperties) & { `disallowed?`: [`AllProperties`](model.Quality.md#allproperties) } + +Quality values that apply to device types. + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L200) + +___ + +### FlagName + +Ƭ **FlagName**: \`${Field}\` + +Valid "other quality" flags. + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:132](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L132) + +## Variables + +### FlagNames + +• `Const` **FlagNames**: [`FlagName`](model.Quality.md#flagname)[] + +Runtime version of QualityFlag. + +#### Defined in + +[packages/matter.js/src/model/aspects/Quality.ts:137](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/aspects/Quality.ts#L137) diff --git a/docs/matter.js/modules/model.RequirementElement.md b/docs/matter.js/modules/model.RequirementElement.md new file mode 100644 index 0000000000..c0fa8fd42f --- /dev/null +++ b/docs/matter.js/modules/model.RequirementElement.md @@ -0,0 +1,54 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / RequirementElement + +# Namespace: RequirementElement + +[model](model.md).RequirementElement + +## Table of contents + +### Enumerations + +- [ElementType](../enums/model.RequirementElement.ElementType.md) + +### Type Aliases + +- [Properties](model.RequirementElement.md#properties) +- [Tag](model.RequirementElement.md#tag) + +### Variables + +- [Tag](model.RequirementElement.md#tag-1) + +## Type Aliases + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`RequirementElement`](model.md#requirementelement)\> + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L40) + +___ + +### Tag + +Ƭ **Tag**: [`Requirement`](../enums/model.ElementTag.md#requirement) + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L38) + +[packages/matter.js/src/model/elements/RequirementElement.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L39) + +## Variables + +### Tag + +• **Tag**: [`Requirement`](../enums/model.ElementTag.md#requirement) + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L38) + +[packages/matter.js/src/model/elements/RequirementElement.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L39) diff --git a/docs/matter.js/modules/model.Specification.md b/docs/matter.js/modules/model.Specification.md new file mode 100644 index 0000000000..6a0dcd808e --- /dev/null +++ b/docs/matter.js/modules/model.Specification.md @@ -0,0 +1,34 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / Specification + +# Namespace: Specification + +[model](model.md).Specification + +## Table of contents + +### Enumerations + +- [Names](../enums/model.Specification.Names.md) + +### Type Aliases + +- [CrossReference](model.Specification.md#crossreference) + +## Type Aliases + +### CrossReference + +Ƭ **CrossReference**: `Object` + +Information on the source of an element. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `document` | \`${Specification}\` | The defining document for the element. | +| `section` | `string` | The section of the defining document that most specifically addresses the element. | + +#### Defined in + +[packages/matter.js/src/model/definitions/Specification.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/Specification.ts#L29) diff --git a/docs/matter.js/modules/model.ValidateModel.md b/docs/matter.js/modules/model.ValidateModel.md new file mode 100644 index 0000000000..ba9166cd9c --- /dev/null +++ b/docs/matter.js/modules/model.ValidateModel.md @@ -0,0 +1,11 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / ValidateModel + +# Namespace: ValidateModel + +[model](model.md).ValidateModel + +## Table of contents + +### Classes + +- [Result](../classes/model.ValidateModel.Result.md) diff --git a/docs/matter.js/modules/model.ValueElement.md b/docs/matter.js/modules/model.ValueElement.md new file mode 100644 index 0000000000..77e4f6e4c2 --- /dev/null +++ b/docs/matter.js/modules/model.ValueElement.md @@ -0,0 +1,71 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / [model](model.md) / ValueElement + +# Namespace: ValueElement + +[model](model.md).ValueElement + +## Table of contents + +### Enumerations + +- [Metatype](../enums/model.ValueElement.Metatype.md) + +### Type Aliases + +- [BitmapSize](model.ValueElement.md#bitmapsize) +- [Datatypes](model.ValueElement.md#datatypes) +- [Properties](model.ValueElement.md#properties) +- [Size](model.ValueElement.md#size) + +## Type Aliases + +### BitmapSize + +Ƭ **BitmapSize**: ``1`` \| ``2`` \| ``4`` \| ``8`` + +Legal bitmap sizes. The Matter specification defines enums as +extensions of int8 or in16 so the size information is not used for +actual enums, just for bitmaps, which are used (somewhat inconsistently) +as base types. + +#### Defined in + +[packages/matter.js/src/model/elements/ValueElement.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L105) + +___ + +### Datatypes + +Ƭ **Datatypes**: `Object` + +A pool of datatype definitions indexed by name. + +#### Index signature + +▪ [name: `string`]: [`ValueElement`](model.md#valueelement) + +#### Defined in + +[packages/matter.js/src/model/elements/ValueElement.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L92) + +___ + +### Properties + +Ƭ **Properties**: [`Properties`](model.BaseElement.md#properties)<[`ValueElement`](model.md#valueelement) & { `tag`: \`${ElementTag}\` }\> + +#### Defined in + +[packages/matter.js/src/model/elements/ValueElement.ts:79](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L79) + +___ + +### Size + +Ƭ **Size**: ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` + +Valid sizes for ints. + +#### Defined in + +[packages/matter.js/src/model/elements/ValueElement.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L97) diff --git a/docs/matter.js/modules/model.md b/docs/matter.js/modules/model.md new file mode 100644 index 0000000000..4def054b5e --- /dev/null +++ b/docs/matter.js/modules/model.md @@ -0,0 +1,1414 @@ +[@project-chip/matter.js](../README.md) / [Modules](../modules.md) / model + +# Module: model + +## Table of contents + +### Namespaces + +- [Access](model.Access.md) +- [AttributeElement](model.AttributeElement.md) +- [BaseElement](model.BaseElement.md) +- [ClusterElement](model.ClusterElement.md) +- [ClusterModel](model.ClusterModel.md) +- [CommandElement](model.CommandElement.md) +- [Conformance](model.Conformance.md) +- [Constraint](model.Constraint.md) +- [DatatypeElement](model.DatatypeElement.md) +- [DeviceTypeElement](model.DeviceTypeElement.md) +- [EndpointElement](model.EndpointElement.md) +- [EventElement](model.EventElement.md) +- [FabricElement](model.FabricElement.md) +- [FeatureSet](model.FeatureSet.md) +- [FieldValue](model.FieldValue.md) +- [MatterElement](model.MatterElement.md) +- [MatterModel](model.MatterModel.md) +- [MergeModels](model.MergeModels.md) +- [Metatype](model.Metatype.md) +- [Model](model.Model.md) +- [NodeElement](model.NodeElement.md) +- [Quality](model.Quality.md) +- [RequirementElement](model.RequirementElement.md) +- [Specification](model.Specification.md) +- [ValidateModel](model.ValidateModel.md) +- [ValueElement](model.ValueElement.md) + +### Enumerations + +- [ElementTag](../enums/model.ElementTag.md) +- [Metatype](../enums/model.Metatype-1.md) +- [Specification](../enums/model.Specification-1.md) +- [StatusCode](../enums/model.StatusCode.md) + +### Classes + +- [Access](../classes/model.Access-1.md) +- [Aspect](../classes/model.Aspect.md) +- [AttributeModel](../classes/model.AttributeModel.md) +- [ClusterModel](../classes/model.ClusterModel-1.md) +- [CommandModel](../classes/model.CommandModel.md) +- [Conformance](../classes/model.Conformance-1.md) +- [Constraint](../classes/model.Constraint-1.md) +- [DatatypeModel](../classes/model.DatatypeModel.md) +- [DeviceTypeModel](../classes/model.DeviceTypeModel.md) +- [EndpointModel](../classes/model.EndpointModel.md) +- [EventModel](../classes/model.EventModel.md) +- [FabricModel](../classes/model.FabricModel.md) +- [FeatureSet](../classes/model.FeatureSet-1.md) +- [MatterModel](../classes/model.MatterModel-1.md) +- [Model](../classes/model.Model-1.md) +- [ModelVariantTraversal](../classes/model.ModelVariantTraversal.md) +- [NodeModel](../classes/model.NodeModel.md) +- [Quality](../classes/model.Quality-1.md) +- [RequirementModel](../classes/model.RequirementModel.md) +- [ValueModel](../classes/model.ValueModel.md) + +### Interfaces + +- [VariantDetail](../interfaces/model.VariantDetail.md) + +### Type Aliases + +- [AnyElement](model.md#anyelement) +- [AnyValueElement](model.md#anyvalueelement) +- [AttributeElement](model.md#attributeelement) +- [BaseElement](model.md#baseelement) +- [ClusterElement](model.md#clusterelement) +- [ClusterVariance](model.md#clustervariance) +- [CommandElement](model.md#commandelement) +- [DatatypeElement](model.md#datatypeelement) +- [DefinitionError](model.md#definitionerror) +- [DeviceTypeElement](model.md#devicetypeelement) +- [EndpointElement](model.md#endpointelement) +- [EventElement](model.md#eventelement) +- [FabricElement](model.md#fabricelement) +- [FeatureBitmap](model.md#featurebitmap) +- [FeatureFlags](model.md#featureflags) +- [FeatureNames](model.md#featurenames) +- [FieldValue](model.md#fieldvalue) +- [IllegalFeatureCombinations](model.md#illegalfeaturecombinations) +- [InferredComponent](model.md#inferredcomponent) +- [InferredComponents](model.md#inferredcomponents) +- [ManufacturerExtensibleIdentifier](model.md#manufacturerextensibleidentifier) +- [MatterElement](model.md#matterelement) +- [Mei](model.md#mei) +- [NamedComponent](model.md#namedcomponent) +- [NamedComponents](model.md#namedcomponents) +- [NodeElement](model.md#nodeelement) +- [RequirementElement](model.md#requirementelement) +- [TraverseMap](model.md#traversemap) +- [ValueElement](model.md#valueelement) +- [VarianceCondition](model.md#variancecondition) +- [VariantMap](model.md#variantmap) + +### Variables + +- [Critical](model.md#critical) +- [Debug](model.md#debug) +- [ENUM8](model.md#enum8) +- [Globals](model.md#globals) +- [Info](model.md#info) +- [Matter](model.md#matter) +- [OCTSTR](model.md#octstr) +- [STRUCT](model.md#struct) +- [UINT16](model.md#uint16) +- [UINT32](model.md#uint32) +- [UINT64](model.md#uint64) +- [UINT8](model.md#uint8) + +### Functions + +- [AttributeElement](model.md#attributeelement-1) +- [BaseElement](model.md#baseelement-1) +- [ClusterElement](model.md#clusterelement-1) +- [ClusterVariance](model.md#clustervariance-1) +- [CommandElement](model.md#commandelement-1) +- [DatatypeElement](model.md#datatypeelement-1) +- [DefaultValue](model.md#defaultvalue) +- [DeviceTypeElement](model.md#devicetypeelement-1) +- [EndpointElement](model.md#endpointelement-1) +- [EventElement](model.md#eventelement-1) +- [FabricElement](model.md#fabricelement-1) +- [FeatureBitmap](model.md#featurebitmap-1) +- [IllegalFeatureCombinations](model.md#illegalfeaturecombinations-1) +- [InferredComponents](model.md#inferredcomponents-1) +- [MatterElement](model.md#matterelement-1) +- [MergeModels](model.md#mergemodels) +- [NamedComponents](model.md#namedcomponents-1) +- [NodeElement](model.md#nodeelement-1) +- [RecordValidator](model.md#recordvalidator) +- [RequirementElement](model.md#requirementelement-1) +- [ValidateModel](model.md#validatemodel) +- [ValueElement](model.md#valueelement-1) +- [conditionToBitmaps](model.md#conditiontobitmaps) +- [translateBitmap](model.md#translatebitmap) + +## Type Aliases + +### AnyElement + +Ƭ **AnyElement**: [`AnyValueElement`](model.md#anyvalueelement) \| [`ClusterElement`](model.md#clusterelement) \| [`DeviceTypeElement`](model.md#devicetypeelement) \| [`RequirementElement`](model.md#requirementelement) \| [`EndpointElement`](model.md#endpointelement) \| [`FabricElement`](model.md#fabricelement) \| [`NodeElement`](model.md#nodeelement) \| [`MatterElement`](model.md#matterelement) + +Any Matter element. + +#### Defined in + +[packages/matter.js/src/model/elements/AnyElement.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AnyElement.ts#L19) + +___ + +### AnyValueElement + +Ƭ **AnyValueElement**: [`AttributeElement`](model.md#attributeelement) \| [`CommandElement`](model.md#commandelement) \| [`EventElement`](model.md#eventelement) \| [`DatatypeElement`](model.md#datatypeelement) + +All Matter data elements. + +#### Defined in + +[packages/matter.js/src/model/elements/AnyValueElement.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AnyValueElement.ts#L15) + +___ + +### AttributeElement + +Ƭ **AttributeElement**: [`ValueElement`](model.md#valueelement) & { `id`: [`Mei`](model.md#mei) ; `tag`: \`${Tag}\` } + +A cluster property description. + +#### Defined in + +[packages/matter.js/src/model/elements/AttributeElement.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L19) + +[packages/matter.js/src/model/elements/AttributeElement.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L14) + +[packages/matter.js/src/model/elements/AttributeElement.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L23) + +___ + +### BaseElement + +Ƭ **BaseElement**: `Object` + +Per the Matter specification, an element is a data construct that supports +an instance of data. So, a class. + +Elements as defined by this package are a static data structure. Each +element has a corresponding "Model" that is a proper class with runtime +functionality related to the element. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `children?` | [`AnyElement`](model.md#anyelement)[] | Child elements. | +| `description?` | `string` | A short summary of the element. | +| `details?` | `string` | A paragraph summary of the element. | +| `global?` | `boolean` | Is this a global element? Global elements are defined in Globals.ts and are available in-scope for every cluster. | +| `id?` | `number` | The ID of the element per Matter specification, either global or context-specific. A "machine appropriate" semantic differentiator. | +| `name` | `string` | The key used for storing this element. A "human appropriate" semantic differentiator. | +| `type?` | `string` | If an element derives from another element, the name of the parent element goes here. | +| `xref?` | [`CrossReference`](model.Specification.md#crossreference) | Reference to Matter specification document. | + +#### Defined in + +[packages/matter.js/src/model/elements/BaseElement.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/BaseElement.ts#L64) + +[packages/matter.js/src/model/elements/BaseElement.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/BaseElement.ts#L18) + +[packages/matter.js/src/model/elements/BaseElement.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/BaseElement.ts#L74) + +___ + +### ClusterElement + +Ƭ **ClusterElement**: [`BaseElement`](model.md#baseelement) & { `children?`: [`Child`](model.ClusterElement.md#child)[] ; `classification?`: \`${Classification}\` ; `id?`: [`Mei`](model.md#mei) ; `singleton?`: `boolean` ; `tag`: \`${Tag}\` } + +A cluster describes a set of related functionality. + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L35) + +[packages/matter.js/src/model/elements/ClusterElement.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L17) + +[packages/matter.js/src/model/elements/ClusterElement.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L39) + +___ + +### ClusterVariance + +Ƭ **ClusterVariance**: `Object` + +Defines different variants of clusters. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `base` | [`InferredComponent`](model.md#inferredcomponent) | The base component. | +| `components` | [`NamedComponents`](model.md#namedcomponents) | Optional components. | +| `illegal` | [`IllegalFeatureCombinations`](model.md#illegalfeaturecombinations) | Illegal feature combinations as bit flags. | +| `requiresFeatures` | `boolean` | If this is false, the cluster cannot be used without features. | + +#### Defined in + +[packages/matter.js/src/model/logic/ClusterVariance.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ClusterVariance.ts#L41) + +[packages/matter.js/src/model/logic/ClusterVariance.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ClusterVariance.ts#L15) + +___ + +### CommandElement + +Ƭ **CommandElement**: [`ValueElement`](model.md#valueelement) & { `direction?`: \`${Direction}\` ; `id`: [`Mei`](model.md#mei) ; `response?`: `string` ; `tag`: \`${Tag}\` } + +A command describes a remote procedure call. + +#### Defined in + +[packages/matter.js/src/model/elements/CommandElement.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L24) + +[packages/matter.js/src/model/elements/CommandElement.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L14) + +[packages/matter.js/src/model/elements/CommandElement.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L28) + +___ + +### DatatypeElement + +Ƭ **DatatypeElement**: [`ValueElement`](model.md#valueelement) & { `children?`: [`DatatypeElement`](model.md#datatypeelement)[] ; `id?`: [`Mei`](model.md#mei) ; `metatype?`: \`${Metatype}\` ; `tag`: \`${Tag}\` } + +A datatype element defines a standalone datatype. + +#### Defined in + +[packages/matter.js/src/model/elements/DatatypeElement.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L34) + +[packages/matter.js/src/model/elements/DatatypeElement.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L14) + +[packages/matter.js/src/model/elements/DatatypeElement.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L38) + +___ + +### DefinitionError + +Ƭ **DefinitionError**: `Object` + +Describes an error in model construction. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `message` | `string` | +| `source` | `string` | +| `xref?` | `string` | + +#### Defined in + +[packages/matter.js/src/model/definitions/DefinitionError.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/DefinitionError.ts#L10) + +___ + +### DeviceTypeElement + +Ƭ **DeviceTypeElement**: [`BaseElement`](model.md#baseelement) & { `category?`: `string` ; `children?`: ([`RequirementElement`](model.md#requirementelement) \| [`DatatypeElement`](model.md#datatypeelement))[] ; `classification`: \`${Classification}\` ; `id?`: [`Mei`](model.md#mei) ; `tag`: \`${Tag}\` } + +Details on a specific device as defined in the Matter specification. + +TODO - extract/merge DeviceTypes.ts? + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L25) + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L17) + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L29) + +___ + +### EndpointElement + +Ƭ **EndpointElement**: [`BaseElement`](model.md#baseelement) & { `children`: [`DeviceTypeElement`](model.md#devicetypeelement)[] ; `id`: `number` ; `tag`: \`${Tag}\` } + +Runtime representation of an endpoint. + +#### Defined in + +[packages/matter.js/src/model/elements/EndpointElement.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L20) + +[packages/matter.js/src/model/elements/EndpointElement.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L14) + +[packages/matter.js/src/model/elements/EndpointElement.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L24) + +___ + +### EventElement + +Ƭ **EventElement**: [`ValueElement`](model.md#valueelement) & { `id`: [`Mei`](model.md#mei) ; `priority?`: \`${Priority}\` ; `tag`: \`${Tag}\` } + +An event is triggered by endpoints. + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L22) + +[packages/matter.js/src/model/elements/EventElement.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L14) + +[packages/matter.js/src/model/elements/EventElement.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L26) + +___ + +### FabricElement + +Ƭ **FabricElement**: [`BaseElement`](model.md#baseelement) & { `children`: [`NodeElement`](model.md#nodeelement)[] ; `id`: `number` ; `tag`: \`${Tag}\` } + +Runtime representation of a fabric. + +#### Defined in + +[packages/matter.js/src/model/elements/FabricElement.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L20) + +[packages/matter.js/src/model/elements/FabricElement.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L14) + +[packages/matter.js/src/model/elements/FabricElement.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L24) + +___ + +### FeatureBitmap + +Ƭ **FeatureBitmap**: `Object` + +#### Index signature + +▪ [name: `string`]: `boolean` + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts#L14) + +[packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts#L11) + +___ + +### FeatureFlags + +Ƭ **FeatureFlags**: `string`[] + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts#L10) + +___ + +### FeatureNames + +Ƭ **FeatureNames**: `Object` + +#### Index signature + +▪ [key: `string`]: `string` + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts#L12) + +___ + +### FieldValue + +Ƭ **FieldValue**: ``null`` \| `string` \| `number` \| `bigint` \| `boolean` \| `Date` \| [] \| [`Properties`](model.FieldValue.md#properties) \| [`Reference`](model.FieldValue.md#reference) \| [`Percent`](model.FieldValue.md#percent) \| [`Celsius`](model.FieldValue.md#celsius) + +A FieldValue represents a concrete value for a datatype. Most values are +primitives but some values we encode with specialized typed objects so we +can capture the original semantic meaning. + +#### Defined in + +[packages/matter.js/src/model/definitions/FieldValue.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L15) + +[packages/matter.js/src/model/definitions/FieldValue.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/FieldValue.ts#L28) + +___ + +### IllegalFeatureCombinations + +Ƭ **IllegalFeatureCombinations**: [`FeatureBitmap`](model.md#featurebitmap)[] + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/IllegalFeatureCombinations.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/IllegalFeatureCombinations.ts#L33) + +[packages/matter.js/src/model/logic/cluster-variance/IllegalFeatureCombinations.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/IllegalFeatureCombinations.ts#L13) + +___ + +### InferredComponent + +Ƭ **InferredComponent**: `Object` + +Lists mandatory and optional elements for a specific context. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `condition?` | [`VarianceCondition`](model.md#variancecondition) | +| `mandatory` | [`ValueModel`](../classes/model.ValueModel.md)[] | +| `optional` | [`ValueModel`](../classes/model.ValueModel.md)[] | + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/InferredComponents.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/InferredComponents.ts#L15) + +___ + +### InferredComponents + +Ƭ **InferredComponents**: [`InferredComponent`](model.md#inferredcomponent)[] + +A list of component definitions. + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/InferredComponents.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/InferredComponents.ts#L29) + +[packages/matter.js/src/model/logic/cluster-variance/InferredComponents.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/InferredComponents.ts#L24) + +___ + +### ManufacturerExtensibleIdentifier + +Ƭ **ManufacturerExtensibleIdentifier**: `number` + +Base type for semantic identifiers per Matter specification. Formally a +32-bit unsigned integer with assigned bit functions: + + Bits 0-15 are the identifier's scope: + 0x0000: Standard (global) or scoped (within cluster) ID + 0x0001 - 0xfff0: Manufacturer code as defined by CSA group + 0xfff1 - 0xfff4: Test manufacturer codes + Bits 16-31 are the actual identifier + +For this and following types, the specification defines restrictions that +we do not express statically with TypeScript. + +#### Defined in + +[packages/matter.js/src/model/definitions/identifiers.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/identifiers.ts#L20) + +___ + +### MatterElement + +Ƭ **MatterElement**: [`BaseElement`](model.md#baseelement) & { `children`: [`Child`](model.MatterElement.md#child)[] ; `tag`: \`${Matter}\` ; `version?`: `string` } + +The root model element. + +#### Defined in + +[packages/matter.js/src/model/elements/MatterElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L25) + +[packages/matter.js/src/model/elements/MatterElement.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L19) + +[packages/matter.js/src/model/elements/MatterElement.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L29) + +___ + +### Mei + +Ƭ **Mei**: [`ManufacturerExtensibleIdentifier`](model.md#manufacturerextensibleidentifier) + +#### Defined in + +[packages/matter.js/src/model/definitions/identifiers.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/definitions/identifiers.ts#L21) + +___ + +### NamedComponent + +Ƭ **NamedComponent**: [`InferredComponent`](model.md#inferredcomponent) & { `documentation`: `string` ; `name`: `string` } + +An inferred with generated name and documentation. + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/NamedComponents.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/NamedComponents.ts#L14) + +___ + +### NamedComponents + +Ƭ **NamedComponents**: [`NamedComponent`](model.md#namedcomponent)[] + +A set of components keyed by generated names. + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/NamedComponents.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/NamedComponents.ts#L27) + +[packages/matter.js/src/model/logic/cluster-variance/NamedComponents.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/NamedComponents.ts#L22) + +___ + +### NodeElement + +Ƭ **NodeElement**: [`BaseElement`](model.md#baseelement) & { `children?`: [`EndpointElement`](model.md#endpointelement)[] ; `id`: `number` ; `tag`: \`${Tag}\` } + +Runtime representation of a node. + +#### Defined in + +[packages/matter.js/src/model/elements/NodeElement.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L20) + +[packages/matter.js/src/model/elements/NodeElement.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L14) + +[packages/matter.js/src/model/elements/NodeElement.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L24) + +___ + +### RequirementElement + +Ƭ **RequirementElement**: [`BaseElement`](model.md#baseelement) & { `access?`: [`Definition`](model.Access.md#definition) ; `children?`: ([`RequirementElement`](model.md#requirementelement) \| [`DatatypeElement`](model.md#datatypeelement))[] ; `conformance?`: [`Definition`](model.Conformance.md#definition) ; `constraint?`: [`Definition`](model.Constraint.md#definition) ; `element`: \`${ElementType}\` ; `quality?`: [`Definition`](model.Quality.md#definition) ; `tag`: \`${Tag}\` } + +Describes a cluster or cluster element requirement for a device. + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L30) + +[packages/matter.js/src/model/elements/RequirementElement.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L14) + +[packages/matter.js/src/model/elements/RequirementElement.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L37) + +___ + +### TraverseMap + +Ƭ **TraverseMap**: `Object` + +Input to traverse(). + +#### Index signature + +▪ [sourceName: `string`]: [`Model`](../classes/model.Model-1.md) \| [`AnyElement`](model.md#anyelement) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L26) + +___ + +### ValueElement + +Ƭ **ValueElement**: [`BaseElement`](model.md#baseelement) & { `access?`: [`Definition`](model.Access.md#definition) ; `byteSize?`: [`Size`](model.ValueElement.md#size) ; `children?`: [`AnyValueElement`](model.md#anyvalueelement)[] ; `conformance?`: [`Definition`](model.Conformance.md#definition) ; `constraint?`: [`Definition`](model.Constraint.md#definition) ; `default?`: [`FieldValue`](model.md#fieldvalue) ; `quality?`: [`Definition`](model.Quality.md#definition) ; `type?`: `string` } + +A base element for all elements that represent data values. + +#### Defined in + +[packages/matter.js/src/model/elements/ValueElement.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L62) + +[packages/matter.js/src/model/elements/ValueElement.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L15) + +[packages/matter.js/src/model/elements/ValueElement.ts:78](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L78) + +___ + +### VarianceCondition + +Ƭ **VarianceCondition**: `Object` + +The condition for supported patterns of complex variance on Cluster +Attributes, Commands and Events. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allOf?` | `string`[] | +| `anyOf?` | `string`[] | +| `not?` | `string` | + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/VarianceCondition.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/VarianceCondition.ts#L14) + +___ + +### VariantMap + +Ƭ **VariantMap**: `Object` + +This is a map of equivalent models keyed by "source name". The source +name is a string that identifies the source of the variant, such as "chip", +"spec" or "local". + +#### Index signature + +▪ [sourceName: `string`]: [`Model`](../classes/model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ModelVariantTraversal.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ModelVariantTraversal.ts#L21) + +## Variables + +### Critical + +• `Const` **Critical**: [`Critical`](../enums/model.EventElement.Priority.md#critical) = `EventElement.Priority.Critical` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L52) + +___ + +### Debug + +• `Const` **Debug**: [`Debug`](../enums/model.EventElement.Priority.md#debug) = `EventElement.Priority.Debug` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:50](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L50) + +___ + +### ENUM8 + +• `Const` **ENUM8**: ``"enum8"`` + +#### Defined in + +[packages/matter.js/src/model/elements/Globals.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/Globals.ts#L17) + +___ + +### Globals + +• `Const` **Globals**: `Object` + +These are all of the global elements defined in the Matter Specification. +This includes types from the "data types" section and other elements from +the "global elements" section. + +According to the specification, any type that is used by more than one +cluster should be defined here. Various cluster-specific elements reference +these types or derive new types. + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `AcceptedCommandListList` | [`AttributeElement`](model.md#attributeelement) | - | +| `AttributeList` | [`AttributeElement`](model.md#attributeelement) | - | +| `ClusterRevision` | [`AttributeElement`](model.md#attributeelement) | - | +| `EventList` | [`AttributeElement`](model.md#attributeelement) | - | +| `FabricIndex` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `FeatureMap` | [`AttributeElement`](model.md#attributeelement) | - | +| `GeneratedCommandList` | [`AttributeElement`](model.md#attributeelement) | - | +| `SubjectId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `actionId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `any` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `attributeId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `bool` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `clusterId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `commandId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `dataVer` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `date` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `deviceTypeId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `double` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `endpointNo` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `entryIdx` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `enum16` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `enum8` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `epochS` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `epochUs` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `eui64` | [`DatatypeElement`](model.md#datatypeelement) | **`Deprecated`** by Matter specification | +| `eventId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `eventNo` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `fabricId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `fabricIdx` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `fieldId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `groupId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `hwadr` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `int16` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `int24` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `int32` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `int40` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `int48` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `int56` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `int64` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `int8` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `ipadr` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `ipv4adr` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `ipv6adr` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `ipv6pre` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `list` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `map16` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `map32` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `map64` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `map8` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `nodeId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `octstr` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `percent` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `percent100ths` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `posixMs` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `priority` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `single` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `status` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `string` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `struct` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `systimeMs` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `systimeUs` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `tod` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `transactionId` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `uint16` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `uint24` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `uint32` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `uint40` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `uint48` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `uint56` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `uint64` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `uint8` | [`DatatypeElement`](model.md#datatypeelement) | - | +| `utc` | [`DatatypeElement`](model.md#datatypeelement) | **`Deprecated`** by Matter specification | +| `vendorId` | [`DatatypeElement`](model.md#datatypeelement) | - | + +#### Defined in + +[packages/matter.js/src/model/elements/Globals.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/Globals.ts#L72) + +___ + +### Info + +• `Const` **Info**: [`Info`](../enums/model.EventElement.Priority.md#info) = `EventElement.Priority.Info` + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L51) + +___ + +### Matter + +• `Const` **Matter**: [`MatterElement`](model.md#matterelement) + +Canonical instance of the Matter Object Model. + +#### Defined in + +[packages/matter.js/src/model/standard/Matter.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/standard/Matter.ts#L12) + +___ + +### OCTSTR + +• `Const` **OCTSTR**: ``"octstr"`` + +#### Defined in + +[packages/matter.js/src/model/elements/Globals.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/Globals.ts#L15) + +___ + +### STRUCT + +• `Const` **STRUCT**: ``"struct"`` + +#### Defined in + +[packages/matter.js/src/model/elements/Globals.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/Globals.ts#L16) + +___ + +### UINT16 + +• `Const` **UINT16**: ``"uint16"`` + +#### Defined in + +[packages/matter.js/src/model/elements/Globals.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/Globals.ts#L19) + +___ + +### UINT32 + +• `Const` **UINT32**: ``"uint32"`` + +#### Defined in + +[packages/matter.js/src/model/elements/Globals.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/Globals.ts#L20) + +___ + +### UINT64 + +• `Const` **UINT64**: ``"uint64"`` + +#### Defined in + +[packages/matter.js/src/model/elements/Globals.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/Globals.ts#L21) + +___ + +### UINT8 + +• `Const` **UINT8**: ``"uint8"`` + +#### Defined in + +[packages/matter.js/src/model/elements/Globals.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/Globals.ts#L18) + +## Functions + +### AttributeElement + +▸ **AttributeElement**(`definition`): [`AttributeElement`](model.md#attributeelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.AttributeElement.md#properties) | + +#### Returns + +[`AttributeElement`](model.md#attributeelement) + +#### Defined in + +[packages/matter.js/src/model/elements/AttributeElement.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/AttributeElement.ts#L19) + +___ + +### BaseElement + +▸ **BaseElement**(`tag`, `definition`): [`BaseElement`](model.md#baseelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tag` | [`ElementTag`](../enums/model.ElementTag.md) | +| `definition` | [`BaseElement`](model.md#baseelement) | + +#### Returns + +[`BaseElement`](model.md#baseelement) + +#### Defined in + +[packages/matter.js/src/model/elements/BaseElement.ts:64](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/BaseElement.ts#L64) + +___ + +### ClusterElement + +▸ **ClusterElement**(`definition`): [`ClusterElement`](model.md#clusterelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.ClusterElement.md#properties) | + +#### Returns + +[`ClusterElement`](model.md#clusterelement) + +#### Defined in + +[packages/matter.js/src/model/elements/ClusterElement.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ClusterElement.ts#L35) + +___ + +### ClusterVariance + +▸ **ClusterVariance**(`cluster`): [`ClusterVariance`](model.md#clustervariance) + +Analyzes a cluster to determine components, component names and feature +flag -> component mapping. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cluster` | [`ClusterModel`](../classes/model.ClusterModel-1.md) | + +#### Returns + +[`ClusterVariance`](model.md#clustervariance) + +#### Defined in + +[packages/matter.js/src/model/logic/ClusterVariance.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ClusterVariance.ts#L41) + +___ + +### CommandElement + +▸ **CommandElement**(`definition`): [`CommandElement`](model.md#commandelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.CommandElement.md#properties) | + +#### Returns + +[`CommandElement`](model.md#commandelement) + +#### Defined in + +[packages/matter.js/src/model/elements/CommandElement.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/CommandElement.ts#L24) + +___ + +### DatatypeElement + +▸ **DatatypeElement**(`definition`): [`DatatypeElement`](model.md#datatypeelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.DatatypeElement.md#properties) | + +#### Returns + +[`DatatypeElement`](model.md#datatypeelement) + +#### Defined in + +[packages/matter.js/src/model/elements/DatatypeElement.ts:34](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DatatypeElement.ts#L34) + +___ + +### DefaultValue + +▸ **DefaultValue**(`model`): `any` + +Obtain a native JS default value for a ValueModel. + +This code assumes defaults have been previously validated (e.g. by model +validator). It throws errors for a few structural issues but generally +returns undefined if the model's default value cannot be converted to the +correct type. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | [`ValueModel`](../classes/model.ValueModel.md) | + +#### Returns + +`any` + +#### Defined in + +[packages/matter.js/src/model/logic/DefaultValue.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/DefaultValue.ts#L21) + +___ + +### DeviceTypeElement + +▸ **DeviceTypeElement**(`definition`): [`DeviceTypeElement`](model.md#devicetypeelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.DeviceTypeElement.md#properties) | + +#### Returns + +[`DeviceTypeElement`](model.md#devicetypeelement) + +#### Defined in + +[packages/matter.js/src/model/elements/DeviceTypeElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/DeviceTypeElement.ts#L25) + +___ + +### EndpointElement + +▸ **EndpointElement**(`definition`): [`EndpointElement`](model.md#endpointelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.EndpointElement.md#properties) | + +#### Returns + +[`EndpointElement`](model.md#endpointelement) + +#### Defined in + +[packages/matter.js/src/model/elements/EndpointElement.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EndpointElement.ts#L20) + +___ + +### EventElement + +▸ **EventElement**(`definition`): [`EventElement`](model.md#eventelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.EventElement.md#properties) | + +#### Returns + +[`EventElement`](model.md#eventelement) + +#### Defined in + +[packages/matter.js/src/model/elements/EventElement.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/EventElement.ts#L22) + +___ + +### FabricElement + +▸ **FabricElement**(`definition`): [`BaseElement`](model.md#baseelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.FabricElement.md#properties) | + +#### Returns + +[`BaseElement`](model.md#baseelement) + +#### Defined in + +[packages/matter.js/src/model/elements/FabricElement.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/FabricElement.ts#L20) + +___ + +### FeatureBitmap + +▸ **FeatureBitmap**(`bitmap?`): [`FeatureBitmap`](model.md#featurebitmap) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bitmap` | [`FeatureBitmap`](model.md#featurebitmap) \| [`FeatureFlags`](model.md#featureflags) | + +#### Returns + +[`FeatureBitmap`](model.md#featurebitmap) + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts#L14) + +___ + +### IllegalFeatureCombinations + +▸ **IllegalFeatureCombinations**(`cluster`): `Object` + +Analyzes feature conformance to ascertain feature combinations that are +unsupported. Uses rules to match the conformance AST. + +Rule matching is not exhaustive but supports a significant subset of the +conformance dialect that is inclusive of all feature conformances used by +the 1.1 specifications. + +Throws an error if conformance does not adhere to supported rules. This +indicates the ruleset needs augmentation. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cluster` | [`ClusterModel`](../classes/model.ClusterModel-1.md) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `illegal` | [`IllegalFeatureCombinations`](model.md#illegalfeaturecombinations) | +| `requiresFeatures` | `boolean` | + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/IllegalFeatureCombinations.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/IllegalFeatureCombinations.ts#L33) + +___ + +### InferredComponents + +▸ **InferredComponents**(`cluster`): [`InferredComponents`](model.md#inferredcomponents) + +Details components generated by analyzing variance of cluster elements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cluster` | [`ClusterModel`](../classes/model.ClusterModel-1.md) | + +#### Returns + +[`InferredComponents`](model.md#inferredcomponents) + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/InferredComponents.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/InferredComponents.ts#L29) + +___ + +### MatterElement + +▸ **MatterElement**(`definition`): [`MatterElement`](model.md#matterelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.MatterElement.md#properties) | + +#### Returns + +[`MatterElement`](model.md#matterelement) + +#### Defined in + +[packages/matter.js/src/model/elements/MatterElement.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/MatterElement.ts#L25) + +___ + +### MergeModels + +▸ **MergeModels**(`variants`, `priorities?`): [`Model`](../classes/model.Model-1.md) + +Merge multiple variants of an element into a single element. + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `variants` | [`TraverseMap`](model.md#traversemap) | `undefined` | +| `priorities` | [`Priorities`](model.MergeModels.md#priorities) | `MergeModels.DefaultPriorities` | + +#### Returns + +[`Model`](../classes/model.Model-1.md) + +#### Defined in + +[packages/matter.js/src/model/logic/MergeModels.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/MergeModels.ts#L17) + +___ + +### NamedComponents + +▸ **NamedComponents**(`cluster`, `inferredComponents`): `Object` + +Compute name and documentation a set of inferred components. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cluster` | [`ClusterModel`](../classes/model.ClusterModel-1.md) | +| `inferredComponents` | [`InferredComponents`](model.md#inferredcomponents) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `base` | [`InferredComponent`](model.md#inferredcomponent) | +| `components` | [`NamedComponents`](model.md#namedcomponents) | + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/NamedComponents.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/NamedComponents.ts#L27) + +___ + +### NodeElement + +▸ **NodeElement**(`definition`): [`NodeElement`](model.md#nodeelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.NodeElement.md#properties) | + +#### Returns + +[`NodeElement`](model.md#nodeelement) + +#### Defined in + +[packages/matter.js/src/model/elements/NodeElement.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/NodeElement.ts#L20) + +___ + +### RecordValidator + +▸ **RecordValidator**(`fields`, `featureMap`, `features`): [`RecordValidator`](../interfaces/export._internal_.RecordValidator.md) + +Creates a utility object that can validate records based on a model. + +TODO - doesn't currently recurse into children + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fields` | [`ValueModel`](../classes/model.ValueModel.md)[] | defines the record to test | +| `featureMap` | [`ValueModel`](../classes/model.ValueModel.md) | - | +| `features` | [`FeatureSet`](../classes/model.FeatureSet-1.md) | active features | + +#### Returns + +[`RecordValidator`](../interfaces/export._internal_.RecordValidator.md) + +a Validator + +#### Defined in + +[packages/matter.js/src/model/logic/RecordValidator.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/RecordValidator.ts#L23) + +___ + +### RequirementElement + +▸ **RequirementElement**(`definition`): [`RequirementElement`](model.md#requirementelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `definition` | [`Properties`](model.RequirementElement.md#properties) | + +#### Returns + +[`RequirementElement`](model.md#requirementelement) + +#### Defined in + +[packages/matter.js/src/model/elements/RequirementElement.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/RequirementElement.ts#L30) + +___ + +### ValidateModel + +▸ **ValidateModel**(`model`): [`Result`](../classes/model.ValidateModel.Result.md) + +Ensures that a model's definition is correct. Places errors into the error +array of invalid models. + +Makes a few minor modifications to the model as a side effect: + +- Default values are cast to the correct type if possible +- Cross-references are deleted if they're redundant with the parent + +Note that we run validation against model classes rather than element +datatypes. The classes implement type resolution, error handling and other +logic we rely on for validation. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `model` | [`Model`](../classes/model.Model-1.md) | + +#### Returns + +[`Result`](../classes/model.ValidateModel.Result.md) + +#### Defined in + +[packages/matter.js/src/model/logic/ValidateModel.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/ValidateModel.ts#L27) + +___ + +### ValueElement + +▸ **ValueElement**(`tag`, `definition`): [`ValueElement`](model.md#valueelement) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `tag` | [`ElementTag`](../enums/model.ElementTag.md) | +| `definition` | [`ValueElement`](model.md#valueelement) | + +#### Returns + +[`ValueElement`](model.md#valueelement) + +#### Defined in + +[packages/matter.js/src/model/elements/ValueElement.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/elements/ValueElement.ts#L62) + +___ + +### conditionToBitmaps + +▸ **conditionToBitmaps**(`condition`, `cluster`): [`FeatureBitmap`](model.md#featurebitmap)[] + +Convert a VarianceCondition to an array of FeatureBitmaps. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `condition` | [`VarianceCondition`](model.md#variancecondition) | +| `cluster` | [`ClusterModel`](../classes/model.ClusterModel-1.md) | + +#### Returns + +[`FeatureBitmap`](model.md#featurebitmap)[] + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/VarianceCondition.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/VarianceCondition.ts#L23) + +___ + +### translateBitmap + +▸ **translateBitmap**(`bitmap`, `cluster`): `Object` + +Map the names in a feature bitmap to different names. Used to convert from +a feature code bitmap to a feature name bitmap. + +E.g. { F: true } -> { foo: true } + +If a name isn't present leaves the feature code intact. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bitmap` | [`FeatureBitmap`](model.md#featurebitmap) | +| `cluster` | [`ClusterModel`](../classes/model.ClusterModel-1.md) | + +#### Returns + +`Object` + +#### Defined in + +[packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/model/logic/cluster-variance/FeatureBitmap.ts#L29) diff --git a/docs/matter.js/modules/net_export.md b/docs/matter.js/modules/net_export.md index 1e45c31d15..f7ca1122ff 100644 --- a/docs/matter.js/modules/net_export.md +++ b/docs/matter.js/modules/net_export.md @@ -58,7 +58,7 @@ #### Defined in -packages/matter.js/src/net/fake/SimulatedNetwork.ts:12 +[packages/matter.js/src/net/fake/SimulatedNetwork.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/SimulatedNetwork.ts#L12) ## Variables @@ -68,7 +68,7 @@ packages/matter.js/src/net/fake/SimulatedNetwork.ts:12 #### Defined in -packages/matter.js/src/net/fake/SimulatedNetwork.ts:16 +[packages/matter.js/src/net/fake/SimulatedNetwork.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/fake/SimulatedNetwork.ts#L16) ## Functions @@ -88,4 +88,4 @@ obj is NetInterface #### Defined in -packages/matter.js/src/net/NetInterface.ts:19 +[packages/matter.js/src/net/NetInterface.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/net/NetInterface.ts#L19) diff --git a/docs/matter.js/modules/protocol_export.md b/docs/matter.js/modules/protocol_export.md index ba40deb46d..9b9e123939 100644 --- a/docs/matter.js/modules/protocol_export.md +++ b/docs/matter.js/modules/protocol_export.md @@ -9,6 +9,8 @@ - [ChannelManager](../classes/protocol_export.ChannelManager.md) - [CommissioningError](../classes/protocol_export.CommissioningError.md) - [ControllerCommissioner](../classes/protocol_export.ControllerCommissioner.md) +- [ControllerDiscovery](../classes/protocol_export.ControllerDiscovery.md) +- [DiscoveryError](../classes/protocol_export.DiscoveryError.md) - [ExchangeCounter](../classes/protocol_export.ExchangeCounter.md) - [ExchangeManager](../classes/protocol_export.ExchangeManager.md) - [ExchangeProvider](../classes/protocol_export.ExchangeProvider.md) @@ -38,21 +40,21 @@ User specific options for the Commissioning process #### Type declaration -| Name | Type | -| :------ | :------ | -| `adminVendorId?` | `number` | -| `regulatoryCountryCode` | `string` | -| `regulatoryLocation` | [`RegulatoryLocationType`](../enums/cluster_export.GeneralCommissioning.RegulatoryLocationType.md) | -| `threadNetwork?` | { `networkName`: `string` ; `operationalDataset`: `string` } | -| `threadNetwork.networkName` | `string` | -| `threadNetwork.operationalDataset` | `string` | -| `wifiNetwork?` | { `wifiCredentials`: `string` ; `wifiSsid`: `string` } | -| `wifiNetwork.wifiCredentials` | `string` | -| `wifiNetwork.wifiSsid` | `string` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `nodeId?` | [`NodeId`](datatype_export.md#nodeid) | - | +| `regulatoryCountryCode` | `string` | Country Code where the device is used. | +| `regulatoryLocation` | [`RegulatoryLocationType`](../enums/cluster_export.GeneralCommissioning.RegulatoryLocationType.md) | Regulatory Location (Indoor/Outdoor) where the device is used. | +| `threadNetwork?` | { `networkName`: `string` ; `operationalDataset`: `string` } | Thread network credentials to commission the device to. | +| `threadNetwork.networkName` | `string` | - | +| `threadNetwork.operationalDataset` | `string` | - | +| `wifiNetwork?` | { `wifiCredentials`: `string` ; `wifiSsid`: `string` } | Wifi network credentials to commission the device to. | +| `wifiNetwork.wifiCredentials` | `string` | - | +| `wifiNetwork.wifiSsid` | `string` | - | #### Defined in -packages/matter.js/src/protocol/ControllerCommissioner.ts:39 +[packages/matter.js/src/protocol/ControllerCommissioner.ts:38](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/ControllerCommissioner.ts#L38) ___ @@ -70,4 +72,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/MessageExchange.ts:36 +[packages/matter.js/src/protocol/MessageExchange.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/MessageExchange.ts#L36) diff --git a/docs/matter.js/modules/protocol_interaction_export.md b/docs/matter.js/modules/protocol_interaction_export.md index 6801b99585..968c2a5375 100644 --- a/docs/matter.js/modules/protocol_interaction_export.md +++ b/docs/matter.js/modules/protocol_interaction_export.md @@ -118,7 +118,7 @@ Type for TlvAttributeReport where the real data are represented with the schema #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:32 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L32) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:61 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L68) ___ @@ -140,7 +140,7 @@ Type for TlvDataReport where the real data are represented with the schema and t #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:54 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L54) ___ @@ -171,7 +171,7 @@ Represents a fully qualified and decoded attribute value from a received DataRep #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:24 +[packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts#L24) ___ @@ -189,7 +189,7 @@ Represents a decoded attribute value from a received DataReport where data versi #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:37 +[packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts#L37) ___ @@ -217,7 +217,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:22 +[packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventDataDecoder.ts#L22) ___ @@ -245,7 +245,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:32 +[packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventDataDecoder.ts#L32) ___ @@ -257,7 +257,7 @@ Type for TlvEventReport where the real data are represented with the schema and #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:43 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L43) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:123 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:123](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L123) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:64 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L71) ___ @@ -295,7 +295,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:65 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L72) ___ @@ -305,7 +305,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:60 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L67) ___ @@ -315,7 +315,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:62 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:69](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L69) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:63 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:70](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L70) ___ @@ -335,7 +335,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:66 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L73) ___ @@ -345,7 +345,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:67 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L74) ___ @@ -355,7 +355,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:68 +[packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionMessenger.ts#L75) ## Variables @@ -365,7 +365,7 @@ packages/matter.js/src/protocol/interaction/InteractionMessenger.ts:68 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:62 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:62](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L62) ___ @@ -375,7 +375,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:61 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L61) ___ @@ -389,7 +389,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:126 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:126](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L126) ___ @@ -403,7 +403,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:56 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:56](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L56) ___ @@ -417,7 +417,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:141 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:141](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L141) ___ @@ -427,7 +427,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:133 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:133](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L133) ___ @@ -441,7 +441,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:119 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L119) ___ @@ -455,7 +455,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:97 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L97) ___ @@ -469,7 +469,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:170 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:170](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L170) ___ @@ -483,7 +483,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:162 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:162](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L162) ___ @@ -497,7 +497,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:177 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:177](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L177) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:209 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L209) ___ @@ -523,7 +523,7 @@ Special version of the DataReport Message with pre-encoded report entries used b #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:219 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:219](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L219) ___ @@ -537,7 +537,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:105 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:105](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L105) ___ @@ -551,7 +551,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:77 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L77) ___ @@ -565,7 +565,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:90 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:90](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L90) ___ @@ -579,7 +579,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:67 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L67) ___ @@ -593,7 +593,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:155 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:155](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L155) ___ @@ -607,7 +607,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:148 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L148) ___ @@ -621,7 +621,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:249 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:249](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L249) ___ @@ -635,7 +635,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:257 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:257](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L257) ___ @@ -649,7 +649,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:184 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L184) ___ @@ -663,7 +663,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:199 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:199](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L199) ___ @@ -677,7 +677,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:112 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:112](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L112) ___ @@ -691,7 +691,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:193 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:193](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L193) ___ @@ -705,7 +705,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:229 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:229](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L229) ___ @@ -719,7 +719,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:242 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:242](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L242) ___ @@ -733,7 +733,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:264 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:264](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L264) ___ @@ -747,7 +747,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:270 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:270](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L270) ___ @@ -761,7 +761,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:279 +[packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:279](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionProtocol.ts#L279) ## Functions @@ -781,7 +781,7 @@ packages/matter.js/src/protocol/interaction/InteractionProtocol.ts:279 #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:111 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L111) ___ @@ -803,7 +803,7 @@ Return if an AttributeReportPayload can be chunked or not. #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:103 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:103](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L103) ___ @@ -825,7 +825,7 @@ Chunk an AttributeReportPayload into multiple AttributeReportPayloads. #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:117 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L117) ___ @@ -845,7 +845,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:119 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:119](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L119) ___ @@ -865,7 +865,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:107 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:107](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L107) ___ @@ -887,7 +887,7 @@ Sort and use Tag compression to compress a list of AttributeReportPayloads. #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:183 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L183) ___ @@ -917,7 +917,7 @@ Decodes the data for one attribute via a schema including array un-chunking. #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:184 +[packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts#L184) ___ @@ -939,7 +939,7 @@ Decodes the data for one unknown attribute via the AnySchema including array un- #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:209 +[packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts#L209) ___ @@ -959,7 +959,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:120 +[packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventDataDecoder.ts#L120) ___ @@ -981,7 +981,7 @@ Encodes an AttributeReportPayload into a TlvStream (used for TlvAny type). #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:60 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:60](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L60) ___ @@ -1003,7 +1003,7 @@ Encodes an EventReportPayload into a TlvStream (used for TlvAny type). #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:71 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L71) ___ @@ -1023,7 +1023,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:115 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:115](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L115) ___ @@ -1045,7 +1045,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/InteractionServer.ts:99 +[packages/matter.js/src/protocol/interaction/InteractionServer.ts:99](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/InteractionServer.ts#L99) ___ @@ -1068,7 +1068,7 @@ DataReport. #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:116 +[packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts#L116) ___ @@ -1088,7 +1088,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:71 +[packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventDataDecoder.ts#L71) ___ @@ -1111,7 +1111,7 @@ a received DataReport. #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:45 +[packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts#L45) ___ @@ -1131,7 +1131,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:43 +[packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventDataDecoder.ts#L43) ___ @@ -1155,7 +1155,7 @@ a received DataReport. #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:58 +[packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:58](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts#L58) ___ @@ -1175,7 +1175,7 @@ ___ #### Defined in -packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:52 +[packages/matter.js/src/protocol/interaction/EventDataDecoder.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/EventDataDecoder.ts#L52) ___ @@ -1199,7 +1199,7 @@ ground for tag compression. #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:160 +[packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataEncoder.ts#L160) ___ @@ -1221,4 +1221,4 @@ Structure the data of a received DataReport into an endpointId/clusterId/attribu #### Defined in -packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:230 +[packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts:230](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/interaction/AttributeDataDecoder.ts#L230) diff --git a/docs/matter.js/modules/protocol_securechannel_export.md b/docs/matter.js/modules/protocol_securechannel_export.md index d993e3e3de..ac56738501 100644 --- a/docs/matter.js/modules/protocol_securechannel_export.md +++ b/docs/matter.js/modules/protocol_securechannel_export.md @@ -16,6 +16,7 @@ - [SecureChannelMessenger](../classes/protocol_securechannel_export.SecureChannelMessenger.md) - [SecureChannelProtocol](../classes/protocol_securechannel_export.SecureChannelProtocol.md) - [SecureChannelStatusMessageSchema](../classes/protocol_securechannel_export.SecureChannelStatusMessageSchema.md) +- [StatusReportOnlySecureChannelProtocol](../classes/protocol_securechannel_export.StatusReportOnlySecureChannelProtocol.md) ### Type Aliases @@ -42,7 +43,7 @@ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts:13 +[packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts#L13) ## Variables @@ -57,7 +58,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:7 +[packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts:7](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelMessages.ts#L7) ___ @@ -67,4 +68,4 @@ ___ #### Defined in -packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts:37 +[packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/protocol/securechannel/SecureChannelStatusMessageSchema.ts#L37) diff --git a/docs/matter.js/modules/schema_export.md b/docs/matter.js/modules/schema_export.md index 19af50e0e8..6bd208057b 100644 --- a/docs/matter.js/modules/schema_export.md +++ b/docs/matter.js/modules/schema_export.md @@ -58,9 +58,9 @@ Defines the bit position and bit length of a numeric value. #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:36 +[packages/matter.js/src/schema/BitmapSchema.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L36) -packages/matter.js/src/schema/BitmapSchema.ts:37 +[packages/matter.js/src/schema/BitmapSchema.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L37) ___ @@ -78,9 +78,9 @@ Defines the bit position and bit length of an enum flag. #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:40 +[packages/matter.js/src/schema/BitmapSchema.ts:40](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L40) -packages/matter.js/src/schema/BitmapSchema.ts:41 +[packages/matter.js/src/schema/BitmapSchema.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L41) ___ @@ -92,9 +92,9 @@ Defines the bit position of a boolean flag. #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:32 +[packages/matter.js/src/schema/BitmapSchema.ts:32](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L32) -packages/matter.js/src/schema/BitmapSchema.ts:33 +[packages/matter.js/src/schema/BitmapSchema.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L33) ___ @@ -113,9 +113,9 @@ Create a type with specified bit flags set #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:202 +[packages/matter.js/src/schema/BitmapSchema.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L202) -packages/matter.js/src/schema/BitmapSchema.ts:196 +[packages/matter.js/src/schema/BitmapSchema.ts:196](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L196) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:44 +[packages/matter.js/src/schema/BitmapSchema.ts:44](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L44) ___ @@ -147,7 +147,7 @@ Create a partial bitmap from a flag sequence #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:191 +[packages/matter.js/src/schema/BitmapSchema.ts:191](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L191) ___ @@ -163,11 +163,11 @@ ___ | `passcode` | `number` | | `productId?` | `number` | | `shortDiscriminator?` | `number` | -| `vendorId?` | `number` | +| `vendorId?` | [`VendorId`](datatype_export.md#vendorid) | #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:73 +[packages/matter.js/src/schema/PairingCodeSchema.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L74) ___ @@ -177,7 +177,7 @@ ___ #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:56 +[packages/matter.js/src/schema/PairingCodeSchema.ts:57](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L57) ___ @@ -193,7 +193,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:45 +[packages/matter.js/src/schema/BitmapSchema.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L45) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:51 +[packages/matter.js/src/schema/BitmapSchema.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L51) ___ @@ -225,7 +225,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:48 +[packages/matter.js/src/schema/BitmapSchema.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L48) ## Variables @@ -235,7 +235,7 @@ packages/matter.js/src/schema/BitmapSchema.ts:48 #### Defined in -packages/matter.js/src/schema/Base38Schema.ts:97 +[packages/matter.js/src/schema/Base38Schema.ts:97](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/Base38Schema.ts#L97) ___ @@ -255,7 +255,7 @@ See [MatterCoreSpecificationV1_0](../interfaces/spec_export.MatterCoreSpecificat #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:34 +[packages/matter.js/src/schema/PairingCodeSchema.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L35) ___ @@ -265,7 +265,7 @@ ___ #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:44 +[packages/matter.js/src/schema/PairingCodeSchema.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L45) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:119 +[packages/matter.js/src/schema/PairingCodeSchema.ts:120](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L120) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -packages/matter.js/src/schema/QrCodeSchema.ts:213 +[packages/matter.js/src/schema/QrCodeSchema.ts:217](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/QrCodeSchema.ts#L217) ___ @@ -295,7 +295,7 @@ ___ #### Defined in -packages/matter.js/src/schema/PairingCodeSchema.ts:71 +[packages/matter.js/src/schema/PairingCodeSchema.ts:72](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/PairingCodeSchema.ts#L72) ## Functions @@ -316,7 +316,7 @@ packages/matter.js/src/schema/PairingCodeSchema.ts:71 #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:37 +[packages/matter.js/src/schema/BitmapSchema.ts:37](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L37) ___ @@ -343,7 +343,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:41 +[packages/matter.js/src/schema/BitmapSchema.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L41) ___ @@ -363,7 +363,7 @@ ___ #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:33 +[packages/matter.js/src/schema/BitmapSchema.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L33) ___ @@ -393,7 +393,7 @@ Create a bitmap schema with a named subset of flags set #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:202 +[packages/matter.js/src/schema/BitmapSchema.ts:202](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L202) ___ @@ -421,7 +421,7 @@ Declares a bitmap schema by indicating the bit position and their names. #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:231 +[packages/matter.js/src/schema/BitmapSchema.ts:231](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L231) ___ @@ -451,7 +451,7 @@ Create a full bitmap schema from a partial bitmap schema #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:215 +[packages/matter.js/src/schema/BitmapSchema.ts:215](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L215) ___ @@ -479,4 +479,4 @@ Declares a bitmap schema backed by a ByteArray by indicating the bit position an #### Defined in -packages/matter.js/src/schema/BitmapSchema.ts:234 +[packages/matter.js/src/schema/BitmapSchema.ts:234](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/schema/BitmapSchema.ts#L234) diff --git a/docs/matter.js/modules/session_export.md b/docs/matter.js/modules/session_export.md index f9eca9142c..57e42a28e3 100644 --- a/docs/matter.js/modules/session_export.md +++ b/docs/matter.js/modules/session_export.md @@ -70,7 +70,7 @@ #### Defined in -packages/matter.js/src/session/Session.ts:12 +[packages/matter.js/src/session/Session.ts:12](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L12) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:11 +[packages/matter.js/src/session/Session.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L11) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:21 +[packages/matter.js/src/session/pase/PaseMessenger.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L21) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -packages/matter.js/src/session/Session.ts:13 +[packages/matter.js/src/session/Session.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L13) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:22 +[packages/matter.js/src/session/case/CaseMessages.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L22) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:26 +[packages/matter.js/src/session/case/CaseMessages.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L26) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:23 +[packages/matter.js/src/session/case/CaseMessages.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L23) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:27 +[packages/matter.js/src/session/case/CaseMessages.ts:27](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L27) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:24 +[packages/matter.js/src/session/case/CaseMessages.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L24) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:25 +[packages/matter.js/src/session/case/CaseMessages.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L25) ___ @@ -172,7 +172,7 @@ Maximum sleep interval of node when in active mode. #### Defined in -packages/matter.js/src/session/Session.ts:16 +[packages/matter.js/src/session/Session.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L16) ___ @@ -184,7 +184,7 @@ Minimum amount the node SHOULD stay awake after network activity. #### Defined in -packages/matter.js/src/session/Session.ts:22 +[packages/matter.js/src/session/Session.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L22) ___ @@ -196,7 +196,7 @@ Maximum sleep interval of node when in idle mode. #### Defined in -packages/matter.js/src/session/Session.ts:19 +[packages/matter.js/src/session/Session.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/Session.ts#L19) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessenger.ts:22 +[packages/matter.js/src/session/pase/PaseMessenger.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessenger.ts#L22) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:28 +[packages/matter.js/src/session/case/CaseMessages.ts:28](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L28) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:29 +[packages/matter.js/src/session/case/CaseMessages.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L29) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:41 +[packages/matter.js/src/session/case/CaseMessages.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L41) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:52 +[packages/matter.js/src/session/case/CaseMessages.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L52) ___ @@ -268,7 +268,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:61 +[packages/matter.js/src/session/case/CaseMessages.ts:61](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L61) ___ @@ -282,7 +282,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:68 +[packages/matter.js/src/session/case/CaseMessages.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L68) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:81 +[packages/matter.js/src/session/case/CaseMessages.ts:81](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L81) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:89 +[packages/matter.js/src/session/case/CaseMessages.ts:89](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L89) ___ @@ -324,7 +324,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessages.ts:48 +[packages/matter.js/src/session/pase/PaseMessages.ts:48](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessages.ts#L48) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessages.ts:53 +[packages/matter.js/src/session/pase/PaseMessages.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessages.ts#L53) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessages.ts:59 +[packages/matter.js/src/session/pase/PaseMessages.ts:59](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessages.ts#L59) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessages.ts:24 +[packages/matter.js/src/session/pase/PaseMessages.ts:24](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessages.ts#L24) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -packages/matter.js/src/session/pase/PaseMessages.ts:33 +[packages/matter.js/src/session/pase/PaseMessages.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/pase/PaseMessages.ts#L33) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -packages/matter.js/src/session/case/CaseMessages.ts:73 +[packages/matter.js/src/session/case/CaseMessages.ts:73](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/case/CaseMessages.ts#L73) ___ @@ -404,7 +404,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:21 +[packages/matter.js/src/session/SessionManager.ts:21](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L21) ___ @@ -414,7 +414,7 @@ ___ #### Defined in -packages/matter.js/src/session/SessionManager.ts:23 +[packages/matter.js/src/session/SessionManager.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SessionManager.ts#L23) ## Functions @@ -441,4 +441,4 @@ asserts session is SecureSession #### Defined in -packages/matter.js/src/session/SecureSession.ts:241 +[packages/matter.js/src/session/SecureSession.ts:324](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/session/SecureSession.ts#L324) diff --git a/docs/matter.js/modules/storage_export.md b/docs/matter.js/modules/storage_export.md index 7d253bc84c..bccef82f11 100644 --- a/docs/matter.js/modules/storage_export.md +++ b/docs/matter.js/modules/storage_export.md @@ -29,7 +29,7 @@ #### Defined in -packages/matter.js/src/storage/StringifyTools.ts:47 +[packages/matter.js/src/storage/StringifyTools.ts:47](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StringifyTools.ts#L47) ## Functions @@ -49,7 +49,7 @@ packages/matter.js/src/storage/StringifyTools.ts:47 #### Defined in -packages/matter.js/src/storage/StringifyTools.ts:82 +[packages/matter.js/src/storage/StringifyTools.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StringifyTools.ts#L82) ___ @@ -70,4 +70,4 @@ ___ #### Defined in -packages/matter.js/src/storage/StringifyTools.ts:55 +[packages/matter.js/src/storage/StringifyTools.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/storage/StringifyTools.ts#L55) diff --git a/docs/matter.js/modules/time_export.md b/docs/matter.js/modules/time_export.md index 8af40f6d2f..8877d9d4e7 100644 --- a/docs/matter.js/modules/time_export.md +++ b/docs/matter.js/modules/time_export.md @@ -32,4 +32,4 @@ #### Defined in -packages/matter.js/src/time/Time.ts:9 +[packages/matter.js/src/time/Time.ts:9](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/time/Time.ts#L9) diff --git a/docs/matter.js/modules/tlv_export.md b/docs/matter.js/modules/tlv_export.md index b3a0fff3b2..22f12a3e6c 100644 --- a/docs/matter.js/modules/tlv_export.md +++ b/docs/matter.js/modules/tlv_export.md @@ -100,7 +100,7 @@ #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:22 +[packages/matter.js/src/tlv/TlvArray.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L22) ___ @@ -123,7 +123,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:83 +[packages/matter.js/src/tlv/TlvNumber.ts:83](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L83) ___ @@ -147,7 +147,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:54 +[packages/matter.js/src/tlv/TlvSchema.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L54) ___ @@ -161,7 +161,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:25 +[packages/matter.js/src/tlv/TlvObject.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L25) ___ @@ -171,7 +171,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:52 +[packages/matter.js/src/tlv/TlvSchema.ts:52](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L52) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:111 +[packages/matter.js/src/tlv/TlvCodec.ts:111](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L111) ___ @@ -218,7 +218,7 @@ Converts [TlvType](../enums/tlv_export.TlvType.md) to the js primitive type. #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:67 +[packages/matter.js/src/tlv/TlvCodec.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L67) ___ @@ -230,7 +230,7 @@ Type and length or value, when applicable. #### Defined in -packages/matter.js/src/tlv/TlvCodec.ts:53 +[packages/matter.js/src/tlv/TlvCodec.ts:53](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvCodec.ts#L53) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:36 +[packages/matter.js/src/tlv/TlvObject.ts:36](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L36) ___ @@ -264,7 +264,7 @@ Type defined by the TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvSchema.ts:92 +[packages/matter.js/src/tlv/TlvSchema.ts:92](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvSchema.ts#L92) ## Variables @@ -274,7 +274,7 @@ packages/matter.js/src/tlv/TlvSchema.ts:92 #### Defined in -packages/matter.js/src/tlv/TlvAny.ts:200 +[packages/matter.js/src/tlv/TlvAny.ts:200](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvAny.ts#L200) ___ @@ -286,7 +286,7 @@ Boolean TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvBoolean.ts:33 +[packages/matter.js/src/tlv/TlvBoolean.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvBoolean.ts#L33) ___ @@ -298,7 +298,7 @@ ByteString TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvString.ts:68 +[packages/matter.js/src/tlv/TlvString.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L68) ___ @@ -308,7 +308,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:117 +[packages/matter.js/src/tlv/TlvNumber.ts:117](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L117) ___ @@ -318,7 +318,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:188 +[packages/matter.js/src/tlv/TlvNumber.ts:188](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L188) ___ @@ -328,7 +328,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:187 +[packages/matter.js/src/tlv/TlvNumber.ts:187](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L187) ___ @@ -340,7 +340,7 @@ Unsigned integer TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:116 +[packages/matter.js/src/tlv/TlvNumber.ts:116](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L116) ___ @@ -350,7 +350,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvString.ts:82 +[packages/matter.js/src/tlv/TlvString.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L82) ___ @@ -360,7 +360,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:124 +[packages/matter.js/src/tlv/TlvNumber.ts:124](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L124) ___ @@ -370,7 +370,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:130 +[packages/matter.js/src/tlv/TlvNumber.ts:130](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L130) ___ @@ -380,7 +380,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:136 +[packages/matter.js/src/tlv/TlvNumber.ts:136](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L136) ___ @@ -390,7 +390,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:118 +[packages/matter.js/src/tlv/TlvNumber.ts:118](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L118) ___ @@ -400,7 +400,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:113 +[packages/matter.js/src/tlv/TlvNumber.ts:113](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L113) ___ @@ -412,7 +412,7 @@ Void TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvNoArguments.ts:26 +[packages/matter.js/src/tlv/TlvNoArguments.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNoArguments.ts#L26) ___ @@ -422,7 +422,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:183 +[packages/matter.js/src/tlv/TlvNumber.ts:183](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L183) ___ @@ -432,7 +432,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:184 +[packages/matter.js/src/tlv/TlvNumber.ts:184](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L184) ___ @@ -442,7 +442,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:189 +[packages/matter.js/src/tlv/TlvNumber.ts:189](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L189) ___ @@ -454,7 +454,7 @@ String TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvString.ts:71 +[packages/matter.js/src/tlv/TlvString.ts:71](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L71) ___ @@ -466,7 +466,7 @@ String TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvString.ts:80 +[packages/matter.js/src/tlv/TlvString.ts:80](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L80) ___ @@ -478,7 +478,7 @@ String TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvString.ts:74 +[packages/matter.js/src/tlv/TlvString.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L74) ___ @@ -490,7 +490,7 @@ String TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvString.ts:77 +[packages/matter.js/src/tlv/TlvString.ts:77](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvString.ts#L77) ___ @@ -500,7 +500,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:191 +[packages/matter.js/src/tlv/TlvNumber.ts:191](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L191) ___ @@ -510,7 +510,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:190 +[packages/matter.js/src/tlv/TlvNumber.ts:190](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L190) ___ @@ -520,7 +520,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:148 +[packages/matter.js/src/tlv/TlvNumber.ts:148](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L148) ___ @@ -530,7 +530,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:154 +[packages/matter.js/src/tlv/TlvNumber.ts:154](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L154) ___ @@ -540,7 +540,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:160 +[packages/matter.js/src/tlv/TlvNumber.ts:160](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L160) ___ @@ -550,7 +550,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:166 +[packages/matter.js/src/tlv/TlvNumber.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L166) ___ @@ -560,7 +560,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:142 +[packages/matter.js/src/tlv/TlvNumber.ts:142](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L142) ___ @@ -572,7 +572,7 @@ Void TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvVoid.ts:33 +[packages/matter.js/src/tlv/TlvVoid.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvVoid.ts#L33) ## Functions @@ -601,7 +601,7 @@ Array TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvArray.ts:128 +[packages/matter.js/src/tlv/TlvArray.ts:128](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvArray.ts#L128) ___ @@ -628,7 +628,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:173 +[packages/matter.js/src/tlv/TlvNumber.ts:173](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L173) ___ @@ -648,7 +648,7 @@ ___ #### Defined in -packages/matter.js/src/tlv/TlvNumber.ts:172 +[packages/matter.js/src/tlv/TlvNumber.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNumber.ts#L172) ___ @@ -680,7 +680,7 @@ to the value being empty. #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:174 +[packages/matter.js/src/tlv/TlvObject.ts:174](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L174) ___ @@ -708,7 +708,7 @@ List TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:167 +[packages/matter.js/src/tlv/TlvObject.ts:167](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L167) ___ @@ -736,7 +736,7 @@ Nullable TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvNullable.ts:54 +[packages/matter.js/src/tlv/TlvNullable.ts:54](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvNullable.ts#L54) ___ @@ -764,7 +764,7 @@ Object TLV schema. #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:164 +[packages/matter.js/src/tlv/TlvObject.ts:164](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L164) ___ @@ -793,4 +793,4 @@ Object TLV optional field. #### Defined in -packages/matter.js/src/tlv/TlvObject.ts:178 +[packages/matter.js/src/tlv/TlvObject.ts:178](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/tlv/TlvObject.ts#L178) diff --git a/docs/matter.js/modules/util_export.md b/docs/matter.js/modules/util_export.md index 1d3ab99ff0..2a3e41bc7b 100644 --- a/docs/matter.js/modules/util_export.md +++ b/docs/matter.js/modules/util_export.md @@ -18,6 +18,7 @@ - [DataReader](../classes/util_export.DataReader.md) - [DataWriter](../classes/util_export.DataWriter.md) - [EndOfStreamError](../classes/util_export.EndOfStreamError.md) +- [NamedHandler](../classes/util_export.NamedHandler.md) - [NoResponseTimeoutError](../classes/util_export.NoResponseTimeoutError.md) - [Queue](../classes/util_export.Queue.md) @@ -27,10 +28,13 @@ ### Type Aliases +- [ArrayMinLength](util_export.md#arrayminlength) +- [AtLeastOne](util_export.md#atleastone) - [Brand](util_export.md#brand) - [Branded](util_export.md#branded) - [ByteArray](util_export.md#bytearray) - [ClassExtends](util_export.md#classextends) +- [HandlerFunction](util_export.md#handlerfunction) - [MakeMandatory](util_export.md#makemandatory) - [Merge](util_export.md#merge) - [MergeAll](util_export.md#mergeall) @@ -61,10 +65,12 @@ - [Merge](util_export.md#merge-1) - [MergeAll](util_export.md#mergeall-1) - [Pluck](util_export.md#pluck-1) +- [anyPromise](util_export.md#anypromise) - [camelize](util_export.md#camelize) - [capitalize](util_export.md#capitalize) - [createPromise](util_export.md#createpromise) - [describeList](util_export.md#describelist) +- [extendPublicHandlerMethods](util_export.md#extendpublichandlermethods) - [iPv4ToNumber](util_export.md#ipv4tonumber) - [iPv6ToArray](util_export.md#ipv6toarray) - [isDeepEqual](util_export.md#isdeepequal) @@ -82,6 +88,46 @@ ## Type Aliases +### ArrayMinLength + +Ƭ **ArrayMinLength**<`T`, `N`\>: [`BuildArrayMinLength`](export._internal_.md#buildarrayminlength)<`T`, `N`, []\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `N` | extends `number` | + +#### Defined in + +[packages/matter.js/src/util/Array.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Array.ts#L15) + +___ + +### AtLeastOne + +Ƭ **AtLeastOne**<`T`\>: [`ArrayMinLength`](util_export.md#arrayminlength)<`T`, ``1``\> + +Array types + +**`License`** + +Copyright 2022 The node-matter Authors +SPDX-License-Identifier: Apache-2.0 + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[packages/matter.js/src/util/Array.ts:9](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Array.ts#L9) + +___ + ### Brand Ƭ **Brand**<`B`\>: `Object` @@ -100,7 +146,7 @@ #### Defined in -packages/matter.js/src/util/Type.ts:67 +[packages/matter.js/src/util/Type.ts:67](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L67) ___ @@ -117,7 +163,7 @@ ___ #### Defined in -packages/matter.js/src/util/Type.ts:68 +[packages/matter.js/src/util/Type.ts:68](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L68) ___ @@ -129,9 +175,9 @@ Array of bytes, alias of Uint8Array. #### Defined in -packages/matter.js/src/util/ByteArray.ts:74 +[packages/matter.js/src/util/ByteArray.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/ByteArray.ts#L74) -packages/matter.js/src/util/ByteArray.ts:75 +[packages/matter.js/src/util/ByteArray.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/ByteArray.ts#L75) ___ @@ -163,7 +209,36 @@ Type that represents a class constructor of a defined type or extend of it #### Defined in -packages/matter.js/src/util/Type.ts:19 +[packages/matter.js/src/util/Type.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L19) + +___ + +### HandlerFunction + +Ƭ **HandlerFunction**: (...`args`: `any`[]) => `any` + +#### Type declaration + +▸ (`...args`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | `any`[] | + +##### Returns + +`any` + +**`License`** + +Copyright 2022 The matter.js Authors +SPDX-License-Identifier: Apache-2.0 + +#### Defined in + +[packages/matter.js/src/util/NamedHandler.ts:7](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L7) ___ @@ -179,7 +254,7 @@ ___ #### Defined in -packages/matter.js/src/util/Type.ts:55 +[packages/matter.js/src/util/Type.ts:55](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L55) ___ @@ -198,9 +273,9 @@ Merges two types into one. #### Defined in -packages/matter.js/src/util/Type.ts:14 +[packages/matter.js/src/util/Type.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L14) -packages/matter.js/src/util/Type.ts:10 +[packages/matter.js/src/util/Type.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L10) ___ @@ -218,9 +293,9 @@ Merge an array of objects into one. Currently assumes unique elements #### Defined in -packages/matter.js/src/util/Type.ts:30 +[packages/matter.js/src/util/Type.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L30) -packages/matter.js/src/util/Type.ts:22 +[packages/matter.js/src/util/Type.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L22) ___ @@ -239,9 +314,9 @@ Pluck an item from an array of objects if present #### Defined in -packages/matter.js/src/util/Type.ts:43 +[packages/matter.js/src/util/Type.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L43) -packages/matter.js/src/util/Type.ts:35 +[packages/matter.js/src/util/Type.ts:35](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L35) ___ @@ -260,7 +335,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/util/Type.ts:7 +[packages/matter.js/src/util/Type.ts:7](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L7) ## Variables @@ -270,9 +345,9 @@ packages/matter.js/src/util/Type.ts:7 #### Defined in -packages/matter.js/src/util/ByteArray.ts:74 +[packages/matter.js/src/util/ByteArray.ts:74](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/ByteArray.ts#L74) -packages/matter.js/src/util/ByteArray.ts:75 +[packages/matter.js/src/util/ByteArray.ts:75](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/ByteArray.ts#L75) ___ @@ -282,7 +357,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:23 +[packages/matter.js/src/util/Number.ts:23](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L23) ___ @@ -292,7 +367,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:22 +[packages/matter.js/src/util/Number.ts:22](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L22) ___ @@ -302,7 +377,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:18 +[packages/matter.js/src/util/Number.ts:18](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L18) ___ @@ -312,7 +387,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:14 +[packages/matter.js/src/util/Number.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L14) ___ @@ -322,7 +397,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:19 +[packages/matter.js/src/util/Number.ts:19](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L19) ___ @@ -332,7 +407,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:15 +[packages/matter.js/src/util/Number.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L15) ___ @@ -342,7 +417,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:20 +[packages/matter.js/src/util/Number.ts:20](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L20) ___ @@ -352,7 +427,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:16 +[packages/matter.js/src/util/Number.ts:16](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L16) ___ @@ -362,7 +437,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:17 +[packages/matter.js/src/util/Number.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L17) ___ @@ -372,7 +447,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:13 +[packages/matter.js/src/util/Number.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L13) ___ @@ -382,7 +457,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:8 +[packages/matter.js/src/util/Number.ts:8](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L8) ___ @@ -392,7 +467,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:9 +[packages/matter.js/src/util/Number.ts:9](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L9) ___ @@ -402,7 +477,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:10 +[packages/matter.js/src/util/Number.ts:10](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L10) ___ @@ -412,7 +487,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:11 +[packages/matter.js/src/util/Number.ts:11](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L11) ___ @@ -427,7 +502,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/util/Number.ts:7 +[packages/matter.js/src/util/Number.ts:7](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L7) ## Functions @@ -455,7 +530,7 @@ packages/matter.js/src/util/Number.ts:7 #### Defined in -packages/matter.js/src/util/Type.ts:14 +[packages/matter.js/src/util/Type.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L14) ___ @@ -481,7 +556,7 @@ ___ #### Defined in -packages/matter.js/src/util/Type.ts:30 +[packages/matter.js/src/util/Type.ts:30](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L30) ___ @@ -509,7 +584,36 @@ ___ #### Defined in -packages/matter.js/src/util/Type.ts:43 +[packages/matter.js/src/util/Type.ts:43](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L43) + +___ + +### anyPromise + +▸ **anyPromise**<`T`\>(`promises`): `Promise`<`T`\> + +Use all promises or promise returning methods and return the first resolved promise or reject when all promises +rejected + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `promises` | (`Promise`<`T`\> \| () => `Promise`<`T`\>)[] | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +[packages/matter.js/src/util/Promises.ts:42](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Promises.ts#L42) ___ @@ -533,7 +637,7 @@ Converts identifiers of the form "foo-bar", "foo_bar", "foo bar", "foo*bar", #### Defined in -packages/matter.js/src/util/String.ts:15 +[packages/matter.js/src/util/String.ts:15](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/String.ts#L15) ___ @@ -564,7 +668,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/util/String.ts:7 +[packages/matter.js/src/util/String.ts:7](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/String.ts#L7) ___ @@ -592,7 +696,7 @@ Obtain a promise with functions to resolve and reject. #### Defined in -packages/matter.js/src/util/Promises.ts:14 +[packages/matter.js/src/util/Promises.ts:14](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Promises.ts#L14) ___ @@ -615,7 +719,34 @@ Create a human readable version of a list of items. #### Defined in -packages/matter.js/src/util/String.ts:209 +[packages/matter.js/src/util/String.ts:209](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/String.ts#L209) + +___ + +### extendPublicHandlerMethods + +▸ **extendPublicHandlerMethods**<`ParentClass`, `H`\>(`parentClass`): [`ExtendPublicHandlerMethods`](export._internal_.md#extendpublichandlermethods)<`ParentClass`, `H`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `ParentClass` | extends (...`args`: `any`[]) => `any` | +| `H` | extends `Record` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `parentClass` | `ParentClass` | + +#### Returns + +[`ExtendPublicHandlerMethods`](export._internal_.md#extendpublichandlermethods)<`ParentClass`, `H`\> + +#### Defined in + +[packages/matter.js/src/util/NamedHandler.ts:46](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/NamedHandler.ts#L46) ___ @@ -635,7 +766,7 @@ ___ #### Defined in -packages/matter.js/src/util/Ip.ts:17 +[packages/matter.js/src/util/Ip.ts:17](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Ip.ts#L17) ___ @@ -655,7 +786,7 @@ ___ #### Defined in -packages/matter.js/src/util/Ip.ts:26 +[packages/matter.js/src/util/Ip.ts:26](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Ip.ts#L26) ___ @@ -681,7 +812,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/util/DeepEqual.ts:7 +[packages/matter.js/src/util/DeepEqual.ts:7](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/DeepEqual.ts#L7) ___ @@ -701,7 +832,7 @@ ___ #### Defined in -packages/matter.js/src/util/Ip.ts:9 +[packages/matter.js/src/util/Ip.ts:9](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Ip.ts#L9) ___ @@ -721,7 +852,7 @@ ___ #### Defined in -packages/matter.js/src/util/Ip.ts:13 +[packages/matter.js/src/util/Ip.ts:13](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Ip.ts#L13) ___ @@ -743,7 +874,7 @@ Same as "a == undefined" but keeps the kids happy #### Defined in -packages/matter.js/src/util/Type.ts:51 +[packages/matter.js/src/util/Type.ts:51](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Type.ts#L51) ___ @@ -770,7 +901,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:39 +[packages/matter.js/src/util/Number.ts:39](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L39) ___ @@ -797,7 +928,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:33 +[packages/matter.js/src/util/Number.ts:33](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L33) ___ @@ -819,7 +950,7 @@ ___ #### Defined in -packages/matter.js/src/util/Ip.ts:41 +[packages/matter.js/src/util/Ip.ts:41](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Ip.ts#L41) ___ @@ -841,7 +972,7 @@ Like JSON.stringify but targets well-formed JS and is slightly more readable. #### Defined in -packages/matter.js/src/util/String.ts:82 +[packages/matter.js/src/util/String.ts:82](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/String.ts#L82) ___ @@ -878,7 +1009,7 @@ SPDX-License-Identifier: Apache-2.0 #### Defined in -packages/matter.js/src/util/Singleton.ts:7 +[packages/matter.js/src/util/Singleton.ts:7](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Singleton.ts#L7) ___ @@ -898,7 +1029,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:29 +[packages/matter.js/src/util/Number.ts:29](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L29) ___ @@ -918,7 +1049,7 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:45 +[packages/matter.js/src/util/Number.ts:45](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L45) ___ @@ -938,4 +1069,4 @@ ___ #### Defined in -packages/matter.js/src/util/Number.ts:25 +[packages/matter.js/src/util/Number.ts:25](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/Number.ts#L25) diff --git a/docs/matter.js/modules/util_export.serialize.md b/docs/matter.js/modules/util_export.serialize.md index 186e367d5d..c641acc5fe 100644 --- a/docs/matter.js/modules/util_export.serialize.md +++ b/docs/matter.js/modules/util_export.serialize.md @@ -25,7 +25,7 @@ Custom serialization function key. #### Defined in -packages/matter.js/src/util/String.ts:166 +[packages/matter.js/src/util/String.ts:166](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/String.ts#L166) ## Functions @@ -48,7 +48,7 @@ representation. #### Defined in -packages/matter.js/src/util/String.ts:172 +[packages/matter.js/src/util/String.ts:172](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/String.ts#L172) ___ @@ -70,4 +70,4 @@ Test whether a value serializes as a structure or a primitive. #### Defined in -packages/matter.js/src/util/String.ts:187 +[packages/matter.js/src/util/String.ts:187](https://github.com/project-chip/matter.js/blob/be83914/packages/matter.js/src/util/String.ts#L187) diff --git a/lerna.json b/lerna.json index 7cd65dd7ee..c179cc0930 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "command": { "run": { "stream": true diff --git a/models/package.json b/models/package.json index 1288771f44..f91c57e893 100644 --- a/models/package.json +++ b/models/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter.js-intermediate-models", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "Matter.js intermediate models", "private": true, "type": "module", @@ -22,7 +22,7 @@ }, "homepage": "https://github.com/project-chip/matter.js#readme", "devDependencies": { - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter.js": "0.7.0", + "@project-chip/matter.js-tools": "0.7.0" } } diff --git a/package-lock.json b/package-lock.json index 7d03a48490..8a9184b206 100644 --- a/package-lock.json +++ b/package-lock.json @@ -34,24 +34,24 @@ }, "chip-testing": { "name": "@project-chip/matter.js-chip-testing", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "dependencies": { - "@project-chip/matter-node.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter-node.js": "0.7.0", + "@project-chip/matter.js": "0.7.0", + "@project-chip/matter.js-tools": "0.7.0" } }, "codegen": { "name": "@project-chip/matter.js-codegen", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "dependencies": { - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js-intermediate-models": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter.js": "0.7.0", + "@project-chip/matter.js-intermediate-models": "0.7.0" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "@types/jsdom": "^21.1.4", "jsdom": "^22.1.0", "typescript": "^5.2.2", @@ -60,11 +60,11 @@ }, "models": { "name": "@project-chip/matter.js-intermediate-models", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "devDependencies": { - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter.js": "0.7.0", + "@project-chip/matter.js-tools": "0.7.0" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -13749,13 +13749,13 @@ }, "packages/matter-node-ble.js": { "name": "@project-chip/matter-node-ble.js", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "dependencies": { - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter.js": "0.7.0" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "ts-node": "^10.9.1", "typescript": "^5.2.2" }, @@ -13769,11 +13769,11 @@ }, "packages/matter-node-shell.js": { "name": "@project-chip/matter-node-shell.js", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "dependencies": { - "@project-chip/matter-node-ble.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter-node.js": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter-node-ble.js": "0.7.0", + "@project-chip/matter-node.js": "0.7.0", "child_process": "^1.0.2", "readline": "^1.3.0", "yargs": "^17.7.2" @@ -13782,7 +13782,7 @@ "shell": "dist/cjs/app.js" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "typescript": "^5.2.2" }, "engines": { @@ -13792,14 +13792,14 @@ }, "packages/matter-node.js": { "name": "@project-chip/matter-node.js", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "dependencies": { - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js": "0.7.0", "node-localstorage": "^3.0.5" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "@types/bn.js": "^5.1.3", "@types/bytebuffer": "^5.0.46", "@types/node-localstorage": "^1.3.2", @@ -13814,12 +13814,12 @@ }, "packages/matter-node.js-examples": { "name": "@project-chip/matter-node.js-examples", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "dependencies": { - "@project-chip/matter-node-ble.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter-node.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter-node-ble.js": "0.7.0", + "@project-chip/matter-node.js": "0.7.0", + "@project-chip/matter.js-tools": "0.7.0" }, "bin": { "matter-bridge": "dist/esm/examples/BridgedDevicesNode.js", @@ -13873,14 +13873,14 @@ }, "packages/matter.js": { "name": "@project-chip/matter.js", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "dependencies": { "bn.js": "^5.2.1", "elliptic": "^6.5.4" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "@types/bn.js": "^5.1.3", "@types/chai": "^4.3.9", "@types/elliptic": "^6.4.16", @@ -13892,7 +13892,7 @@ }, "packages/matter.js-tools": { "name": "@project-chip/matter.js-tools", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "license": "Apache-2.0", "dependencies": { "@npmcli/map-workspaces": "^3.0.4", diff --git a/packages/matter-node-ble.js/package.json b/packages/matter-node-ble.js/package.json index 0dc8675cc6..ef6028960d 100644 --- a/packages/matter-node-ble.js/package.json +++ b/packages/matter-node-ble.js/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter-node-ble.js", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "Matter BLE support for node.js", "keywords": [ "iot", @@ -29,12 +29,12 @@ "build-doc": "typedoc --excludeExternals --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-markdown --tsconfig src/tsconfig.json" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "ts-node": "^10.9.1", "typescript": "^5.2.2" }, "dependencies": { - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter.js": "0.7.0" }, "optionalDependencies": { "@abandonware/bleno": "^0.6.1", diff --git a/packages/matter-node-shell.js/package.json b/packages/matter-node-shell.js/package.json index 1d4749230b..ef62b9f28a 100644 --- a/packages/matter-node-shell.js/package.json +++ b/packages/matter-node-shell.js/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter-node-shell.js", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "Shell app for Matter controller", "keywords": [ "iot", @@ -32,12 +32,12 @@ "shell": "./dist/cjs/app.js" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "typescript": "^5.2.2" }, "dependencies": { - "@project-chip/matter-node-ble.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter-node.js": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter-node-ble.js": "0.7.0", + "@project-chip/matter-node.js": "0.7.0", "child_process": "^1.0.2", "readline": "^1.3.0", "yargs": "^17.7.2" diff --git a/packages/matter-node.js-examples/package.json b/packages/matter-node.js-examples/package.json index a0ab238d7a..bc47a89709 100644 --- a/packages/matter-node.js-examples/package.json +++ b/packages/matter-node.js-examples/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter-node.js-examples", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "CLI/Reference implementation scripts for Matter protocol for node.js", "keywords": [ "iot", @@ -47,9 +47,9 @@ "typescript": "^5.2.2" }, "dependencies": { - "@project-chip/matter-node-ble.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter-node.js": "0.6.1-alpha.0-20231111-0f49576", - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576" + "@project-chip/matter-node-ble.js": "0.7.0", + "@project-chip/matter-node.js": "0.7.0", + "@project-chip/matter.js-tools": "0.7.0" }, "engines": { "_comment": "For Crypto.hkdf support", diff --git a/packages/matter-node.js/package.json b/packages/matter-node.js/package.json index 5991ba80d1..e4672d78d7 100644 --- a/packages/matter-node.js/package.json +++ b/packages/matter-node.js/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter-node.js", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "Matter protocol for node.js", "keywords": [ "iot", @@ -31,7 +31,7 @@ "test": "matter-test" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "@types/bn.js": "^5.1.3", "@types/bytebuffer": "^5.0.46", "@types/node-localstorage": "^1.3.2", @@ -40,7 +40,7 @@ "typescript": "^5.2.2" }, "dependencies": { - "@project-chip/matter.js": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js": "0.7.0", "node-localstorage": "^3.0.5" }, "engines": { diff --git a/packages/matter.js-tools/package.json b/packages/matter.js-tools/package.json index cb26ac18b2..186d773d4c 100644 --- a/packages/matter.js-tools/package.json +++ b/packages/matter.js-tools/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter.js-tools", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "Matter.js tooling", "type": "module", "scripts": { diff --git a/packages/matter.js/package.json b/packages/matter.js/package.json index 4f0820147a..bdc7dd68e2 100644 --- a/packages/matter.js/package.json +++ b/packages/matter.js/package.json @@ -1,6 +1,6 @@ { "name": "@project-chip/matter.js", - "version": "0.6.1-alpha.0-20231111-0f49576", + "version": "0.7.0", "description": "Matter protocol in pure js", "keywords": [ "iot", @@ -36,7 +36,7 @@ "elliptic": "^6.5.4" }, "devDependencies": { - "@project-chip/matter.js-tools": "0.6.1-alpha.0-20231111-0f49576", + "@project-chip/matter.js-tools": "0.7.0", "@types/bn.js": "^5.1.3", "@types/chai": "^4.3.9", "@types/elliptic": "^6.4.16",