Class PairedDevice

Temporary used device class for paired devices until we added a layer to choose the right specialized device class based on the device classes and features of the paired device

Hierarchy (view full)

Endpoint
- PairedDevice

Constructors

constructor

new PairedDevice(definition, clusters?, endpointId): PairedDevice
Create a new PairedDevice instance. All data are automatically parsed from the paired device!
Parameters
- definition: [DeviceTypeDefinition, ...DeviceTypeDefinition[]]
  DeviceTypeDefinitions of the paired device as reported by the device
- clusters: (ClusterClientObj | ClusterServerObj)[] = []
  Clusters of the paired device as reported by the device
- endpointId: EndpointNumber
  Endpoint ID of the paired device as reported by the device
Returns PairedDevice
Overrides Endpoint.constructor
- Defined in packages/matter.js/src/device/Device.ts:66

Properties

`Protected`deviceTypes

deviceTypes: [DeviceTypeDefinition, ...DeviceTypeDefinition[]]

One or multiple DeviceTypeDefinitions of the endpoint

name

name: string = ""

number

number: undefined | EndpointNumber

uniqueStorageKey

uniqueStorageKey: undefined | string

Accessors

deviceType

get deviceType(): DeviceTypeId
Returns DeviceTypeId
Inherited from Endpoint.deviceType
- Defined in packages/matter.js/src/device/Endpoint.ts:85

Methods

addChildEndpoint

addChildEndpoint(endpoint): void
Parameters
- endpoint: EndpointInterface
Returns void
Inherited from Endpoint.addChildEndpoint
- Defined in packages/matter.js/src/device/Endpoint.ts:251

addClusterClient

addClusterClient<const T>(cluster): void
Add cluster clients (used internally only!)
Type Parameters
- const T extends ClusterType
Parameters
- cluster: ClusterClientObj<T>
Returns void
Deprecated
PairedDevice does not support adding additional clusters
Overrides Endpoint.addClusterClient
- Defined in packages/matter.js/src/device/Device.ts:98

addClusterServer

addClusterServer<const T>(cluster): void
Add cluster servers (used internally only!)
Type Parameters
- const T extends ClusterType
Parameters
- cluster: ClusterServerObj<T>
Returns void
Deprecated
PairedDevice does not support adding additional clusters
Overrides Endpoint.addClusterServer
- Defined in packages/matter.js/src/device/Device.ts:87

addFixedLabel

addFixedLabel(label, value): void
Parameters
- label: string
- value: string
Returns void
Inherited from Endpoint.addFixedLabel
- Defined in packages/matter.js/src/device/Endpoint.ts:115

addUserLabel

addUserLabel(label, value): void
Parameters
- label: string
- value: string
Returns void
Inherited from Endpoint.addUserLabel
- Defined in packages/matter.js/src/device/Endpoint.ts:135

close

close(): void
Returns void
Inherited from Endpoint.close
- Defined in packages/matter.js/src/device/Endpoint.ts:102

determineUniqueID

determineUniqueID(): undefined | string
Returns undefined | string
Inherited from Endpoint.determineUniqueID
- Defined in packages/matter.js/src/device/Endpoint.ts:285

getAllClusterClients

getAllClusterClients(): ClusterClientObj[]
Returns ClusterClientObj[]
Inherited from Endpoint.getAllClusterClients
- Defined in packages/matter.js/src/device/Endpoint.ts:345

getAllClusterServers

getAllClusterServers(): ClusterServerObj[]
Returns ClusterServerObj[]
Inherited from Endpoint.getAllClusterServers
- Defined in packages/matter.js/src/device/Endpoint.ts:341

getChildEndpoint

getChildEndpoint(id): undefined | Endpoint
Parameters
- id: EndpointNumber
Returns undefined | Endpoint
Inherited from Endpoint.getChildEndpoint
- Defined in packages/matter.js/src/device/Endpoint.ts:267

getChildEndpoints

getChildEndpoints(): Endpoint[]
Returns Endpoint[]
Inherited from Endpoint.getChildEndpoints
- Defined in packages/matter.js/src/device/Endpoint.ts:271

getClusterClient

getClusterClient<const T>(cluster): undefined | ClusterClientObj<T>
Type Parameters
- const T extends ClusterType
Parameters
- cluster: T
Returns undefined | ClusterClientObj<T>
Inherited from Endpoint.getClusterClient
- Defined in packages/matter.js/src/device/Endpoint.ts:199

getClusterClientById

getClusterClientById(clusterId): undefined | ClusterClientObj
Parameters
- clusterId: ClusterId
Returns undefined | ClusterClientObj
Inherited from Endpoint.getClusterClientById
- Defined in packages/matter.js/src/device/Endpoint.ts:207

getClusterServer

getClusterServer<const T>(cluster): undefined | ClusterServerObj<T>
Type Parameters
- const T extends ClusterType
Parameters
- cluster: T
Returns undefined | ClusterServerObj<T>
Inherited from Endpoint.getClusterServer
- Defined in packages/matter.js/src/device/Endpoint.ts:190

getClusterServerById

getClusterServerById(clusterId): undefined | ClusterServerObj
Parameters
- clusterId: ClusterId
Returns undefined | ClusterServerObj
Inherited from Endpoint.getClusterServerById
- Defined in packages/matter.js/src/device/Endpoint.ts:203

getDeviceTypes

getDeviceTypes(): [DeviceTypeDefinition, ...DeviceTypeDefinition[]]
Returns [DeviceTypeDefinition, ...DeviceTypeDefinition[]]
Inherited from Endpoint.getDeviceTypes
- Defined in packages/matter.js/src/device/Endpoint.ts:231

getNumber

getNumber(): EndpointNumber
Returns EndpointNumber
Inherited from Endpoint.getNumber
- Defined in packages/matter.js/src/device/Endpoint.ts:108

hasClusterClient

hasClusterClient<F, SF, A, C, E>(cluster): boolean
Type Parameters
- F extends BitSchema
- SF extends TypeFromPartialBitSchema<F>
- A extends Attributes
- C extends Commands
- E extends Events
Parameters
- cluster: Cluster<F, SF, A, C, E>
Returns boolean
Inherited from Endpoint.hasClusterClient
- Defined in packages/matter.js/src/device/Endpoint.ts:221

hasClusterServer

hasClusterServer<F, SF, A, C, E>(cluster): boolean
Type Parameters
- F extends BitSchema
- SF extends TypeFromPartialBitSchema<F>
- A extends Attributes
- C extends Commands
- E extends Events
Parameters
- cluster: Cluster<F, SF, A, C, E>
Returns boolean
Inherited from Endpoint.hasClusterServer
- Defined in packages/matter.js/src/device/Endpoint.ts:211

`Protected`removeChildEndpoint

removeChildEndpoint(endpoint): void
Parameters
- endpoint: Endpoint
Returns void
Inherited from Endpoint.removeChildEndpoint
- Defined in packages/matter.js/src/device/Endpoint.ts:275

removeFromStructure

removeFromStructure(): void
Returns void
Inherited from Endpoint.removeFromStructure
- Defined in packages/matter.js/src/device/Endpoint.ts:94

setDeviceTypes

setDeviceTypes(deviceTypes): void
Parameters
- deviceTypes: [DeviceTypeDefinition, ...DeviceTypeDefinition[]]
Returns void
Inherited from Endpoint.setDeviceTypes
- Defined in packages/matter.js/src/device/Endpoint.ts:235

setStructureChangedCallback

setStructureChangedCallback(callback): void
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from Endpoint.setStructureChangedCallback
- Defined in packages/matter.js/src/device/Endpoint.ts:89

updatePartsList

updatePartsList(): EndpointNumber[]
Returns EndpointNumber[]
Inherited from Endpoint.updatePartsList
- Defined in packages/matter.js/src/device/Endpoint.ts:349

verifyRequiredClusters

verifyRequiredClusters(): void
Returns void
Inherited from Endpoint.verifyRequiredClusters
- Defined in packages/matter.js/src/device/Endpoint.ts:307

Class PairedDevice

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PairedDevice

Properties

ProtecteddeviceTypes

name

number

uniqueStorageKey

Accessors

deviceType

Returns DeviceTypeId

Methods

addChildEndpoint

Parameters

Returns void

addClusterClient

Type Parameters

Parameters

Returns void

Deprecated

addClusterServer

Type Parameters

Parameters

Returns void

Deprecated

addFixedLabel

Parameters

Returns void

addUserLabel

Parameters

Returns void

close

Returns void

determineUniqueID

Returns undefined | string

getAllClusterClients

Returns ClusterClientObj[]

getAllClusterServers

Returns ClusterServerObj[]

getChildEndpoint

Parameters

Returns undefined | Endpoint

getChildEndpoints

Returns Endpoint[]

getClusterClient

Type Parameters

Parameters

Returns undefined | ClusterClientObj<T>

getClusterClientById

Parameters

Returns undefined | ClusterClientObj

getClusterServer

Type Parameters

Parameters

Returns undefined | ClusterServerObj<T>

getClusterServerById

Parameters

Returns undefined | ClusterServerObj

getDeviceTypes

Returns [DeviceTypeDefinition, ...DeviceTypeDefinition[]]

getNumber

Returns EndpointNumber

hasClusterClient

Type Parameters

Parameters

Returns boolean

hasClusterServer

Type Parameters

Parameters

Returns boolean

ProtectedremoveChildEndpoint

Parameters

`Protected`deviceTypes

`Protected`removeChildEndpoint