Class ComposedDevice

A ComposedDevice is a special endpoint that allows to combine multiple sub devices and expose this as one device (e.g. a fan and a light).

Hierarchy (view full)

Endpoint
- ComposedDevice

Constructors

constructor

new ComposedDevice(definition, devices?, options?): ComposedDevice
Creates a new ComposedDevice.
Parameters
- definition: DeviceTypeDefinition
  DeviceTypeDefinitions of the composed device
- devices: Device[] = []
  Array with devices that should be combined into one device that are directly added.
- options: EndpointOptions = {}
  Optional Endpoint options
Returns ComposedDevice
Overrides Endpoint.constructor
- Defined in packages/matter.js/src/device/ComposedDevice.ts:24

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

addDevice

addDevice(device): void
Add a sub-device to the composed device.
Parameters
- device: Device
  Device instance to add
Returns void
- Defined in packages/matter.js/src/device/ComposedDevice.ts:33

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

getDevices

getDevices(): Endpoint[]
Get all sub-devices of the composed device.

Returns Endpoint[]
Array with all sub-devices
- Defined in packages/matter.js/src/device/ComposedDevice.ts:42

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

setBridgedDeviceReachability

setBridgedDeviceReachability(reachable): void
Set the reachability of the Composed device exposed via the bridge.
Parameters
- reachable: boolean
  true if reachable, false otherwise
Returns void
- Defined in packages/matter.js/src/device/ComposedDevice.ts:61

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
Verify that the required clusters exists on the device.

Returns void
Overrides Endpoint.verifyRequiredClusters
- Defined in packages/matter.js/src/device/ComposedDevice.ts:49

Class ComposedDevice

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ComposedDevice

Properties

ProtecteddeviceTypes

name

number

uniqueStorageKey

Accessors

deviceType

Returns DeviceTypeId

Methods

addChildEndpoint

Parameters

Returns void

addClusterClient

Parameters

Returns void

addClusterServer

Type Parameters

Parameters

Returns void

addDevice

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

getDevices

Returns Endpoint[]

getDeviceTypes

Returns [DeviceTypeDefinition, ...DeviceTypeDefinition[]]

getNumber

Returns EndpointNumber

hasClusterClient

Type Parameters

Parameters

Returns boolean

hasClusterServer

Type Parameters

Parameters

Returns boolean

`Protected`deviceTypes

`Protected`removeChildEndpoint