Class Endpoint

The primary interface for Matter.js endpoint implementations.

TODO - this is a transitional interface that allows us to have multiple implementations of the legacy endpoint API

Hierarchy (view full)

Endpoint

Implements

EndpointInterface

Constructors

constructor

new Endpoint(deviceTypes, options?): Endpoint
Create a new Endpoint instance.
Parameters
- deviceTypes: [DeviceTypeDefinition, ...DeviceTypeDefinition[]]
  One or multiple DeviceTypeDefinitions of the endpoint
- options: EndpointOptions = {}
  Options for the endpoint
Returns Endpoint
- Defined in packages/matter.js/src/device/Endpoint.ts:57

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
Implementation of EndpointInterface.deviceType
- Defined in packages/matter.js/src/device/Endpoint.ts:85

Methods

addChildEndpoint

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

addClusterClient

addClusterClient(cluster): void
Parameters
- cluster: ClusterClientObj
Returns void
Implementation of EndpointInterface.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
Implementation of EndpointInterface.addClusterServer
- Defined in packages/matter.js/src/device/Endpoint.ts:155

addFixedLabel

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

addUserLabel

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

close

close(): void
Returns void
Implementation of EndpointInterface.close
- Defined in packages/matter.js/src/device/Endpoint.ts:102

determineUniqueID

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

getClusterClient

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

getClusterClientById

getClusterClientById(clusterId): undefined | ClusterClientObj
Parameters
- clusterId: ClusterId
Returns undefined | ClusterClientObj
- 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>
Implementation of EndpointInterface.getClusterServer
- Defined in packages/matter.js/src/device/Endpoint.ts:190

getClusterServerById

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

getDeviceTypes

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

getNumber

getNumber(): EndpointNumber
Returns EndpointNumber
Implementation of EndpointInterface.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
- 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
Implementation of EndpointInterface.hasClusterServer
- Defined in packages/matter.js/src/device/Endpoint.ts:211

`Protected`removeChildEndpoint

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

removeFromStructure

removeFromStructure(): void
Returns void
Implementation of EndpointInterface.removeFromStructure
- Defined in packages/matter.js/src/device/Endpoint.ts:94

setDeviceTypes

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

setStructureChangedCallback

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

updatePartsList

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

verifyRequiredClusters

verifyRequiredClusters(): void
Returns void
Implementation of EndpointInterface.verifyRequiredClusters
- Defined in packages/matter.js/src/device/Endpoint.ts:307

Class Endpoint

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Endpoint

Properties

ProtecteddeviceTypes

name

number

uniqueStorageKey

Accessors

deviceType

Returns DeviceTypeId

Methods

addChildEndpoint

Parameters

Returns void

addClusterClient

Parameters

Returns void

addClusterServer

Type Parameters

Parameters

Returns void

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

Returns void

removeFromStructure

`Protected`deviceTypes

`Protected`removeChildEndpoint