Class RootEndpoint

Root endpoint of a device. This is used internally and not needed to be instanced by the user.

Hierarchy (view full)

Endpoint
- RootEndpoint

Constructors

constructor

new RootEndpoint(): RootEndpoint
Create a new RootEndpoint instance. This is automatically instanced by the CommissioningServer class.

Returns RootEndpoint
Overrides Endpoint.constructor
- Defined in packages/matter.js/src/device/Device.ts:113

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(cluster): void
Parameters
- cluster: ClusterClientObj
Returns void
Inherited from Endpoint.addClusterClient
- Defined in packages/matter.js/src/device/Endpoint.ts:182

addClusterServer

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

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

addRootClusterClient

addRootClusterClient(cluster): void
Add a cluster client to the root endpoint. This is mainly used internally and not needed to be called by the user.
Parameters
- cluster: ClusterClientObj
  ClusterClient object to add
Returns void
- Defined in packages/matter.js/src/device/Device.ts:131

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

getRootClusterClient

getRootClusterClient<const T>(cluster): undefined | ClusterClientObj<T>
Get a cluster client from the root endpoint. This is mainly used internally and not needed to be called by the user.
Type Parameters
- const T extends ClusterType
Parameters
- cluster: T
  ClusterClient to get or undefined if not existing
Returns undefined | ClusterClientObj<T>
- Defined in packages/matter.js/src/device/Device.ts:140

getRootClusterServer

getRootClusterServer<const T>(cluster): undefined | ClusterServerObj<T>
Get a cluster server from the root endpoint. This is mainly used internally and not needed to be called by the user.
Type Parameters
- const T extends ClusterType
Parameters
- cluster: T
  ClusterServer to get or undefined if not existing
Returns undefined | ClusterServerObj<T>
- Defined in packages/matter.js/src/device/Device.ts:122

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