Class OnOffBaseDevice

Abstract Base class for OnOff devices

Hierarchy (view full)

Device<this> & {
    _executeHandler<K>(action: K, ...args: Parameters<OnOffBaseDeviceCommands[K]>): Promise<void>;
    addCommandHandler<K>(action: K, handler: OnOffBaseDeviceCommands[K]): void;
    removeCommandHandler<K>(action: K, handler: OnOffBaseDeviceCommands[K]): void;
}
- OnOffBaseDevice
  - OnOffPluginUnitDevice
  - OnOffLightDevice

Constructors

constructor

new OnOffBaseDevice(definition, attributeInitialValues?, options?, isLighting?): OnOffBaseDevice
Protected
Creates a new OnOffBaseDevice
Parameters
- definition: DeviceTypeDefinition
  Device type definition of the device to create
- OptionalattributeInitialValues: {
  [key: ClusterId]: AttributeInitialValues<any>;
  }
  Optional object with initial attribute values for automatically added clusters
  - [key: ClusterId]: AttributeInitialValues<any>
- options: EndpointOptions = {}
  Optional endpoint options
- isLighting: boolean = false
  Define if Lighting feature is set
Returns OnOffBaseDevice
Overrides extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).constructor
- Defined in packages/matter.js/src/device/OnOffDevices.ts:56

Properties

`Protected`commandHandler

commandHandler: NamedHandler<any> = ...

`Protected`deviceTypes

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

One or multiple DeviceTypeDefinitions of the endpoint

`Protected`isLighting

isLighting: boolean = false

Define if Lighting feature is set

name

name: string = ""

number

number: undefined | EndpointNumber

uniqueStorageKey

uniqueStorageKey: undefined | string

Accessors

deviceType

get deviceType(): DeviceTypeId
Returns DeviceTypeId
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).deviceType
- Defined in packages/matter.js/src/device/Endpoint.ts:85

Methods

`Protected`_executeHandler

_executeHandler(command, ...args): Promise<any>
Protected
Execute a command handler. Should only be used internally, but cannot be declared as protected officially because needed public for derived classes.
Parameters
- command: never
  Command name to execute the handler for
- Rest...args: any[]
  Arguments to be passed to the handler
Returns Promise<any>
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device)._executeHandler
- Defined in packages/matter.js/src/device/Device.ts:209
_executeHandler<K>(action, ...args): Promise<void>
Type Parameters
- K extends keyof OnOffBaseDeviceCommands
Parameters
- action: K
- Rest...args: Parameters<OnOffBaseDeviceCommands[K]>
Returns Promise<void>
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device)._executeHandler
- Defined in packages/general/dist/esm/util/NamedHandler.d.ts:17

addChildEndpoint

addChildEndpoint(endpoint): void
Parameters
- endpoint: EndpointInterface
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).addChildEndpoint
- Defined in packages/matter.js/src/device/Endpoint.ts:251

addClusterClient

addClusterClient(cluster): void
Parameters
- cluster: ClusterClientObj
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).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 extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).addClusterServer
- Defined in packages/matter.js/src/device/Endpoint.ts:155

addCommandHandler

addCommandHandler(command, handler): void
Method to add command handlers to the device. The base class do not expose any commands!
Parameters
- command: never
  Command name to add a handler for
- handler: HandlerFunction
  Handler function to be executed when the command is received
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).addCommandHandler
- Defined in packages/matter.js/src/device/Device.ts:186
addCommandHandler<K>(action, handler): void
Type Parameters
- K extends keyof OnOffBaseDeviceCommands
Parameters
- action: K
- handler: OnOffBaseDeviceCommands[K]
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).addCommandHandler
- Defined in packages/general/dist/esm/util/NamedHandler.d.ts:15

`Protected`addDeviceClusters

addDeviceClusters(attributeInitialValues?, excludeList?): void
Protected
Adds mandatory clusters to the device
Parameters
- OptionalattributeInitialValues: {
  [key: ClusterId]: AttributeInitialValues<any>;
  }
  Optional object with initial attribute values for automatically added clusters
  - [key: ClusterId]: AttributeInitialValues<any>
- excludeList: ClusterId[] = []
  List of clusters to exclude from being added
Returns void
- Defined in packages/matter.js/src/device/OnOffDevices.ts:73

addFixedLabel

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

addOnOffListener

addOnOffListener(listener): void
Adds a listener for the OnOff attribute This is an example of a convenient device class API to control the device without need to access clusters
Parameters
- listener: ((newValue: boolean, oldValue: boolean) => void)
  Listener function to be called when the attribute changes
  - - (newValue, oldValue): void
    - Parameters
      newValue: boolean
      oldValue: boolean
      Returns void
Returns void
- Defined in packages/matter.js/src/device/OnOffDevices.ts:129

addUserLabel

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

close

close(): void
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).close
- Defined in packages/matter.js/src/device/Endpoint.ts:102

`Protected`createOptionalClusterClient

createOptionalClusterClient<const T>(_cluster): ClusterClientObj<T>
Type Parameters
- const T extends ClusterType
Parameters
- _cluster: T
Returns ClusterClientObj<T>
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).createOptionalClusterClient
- Defined in packages/matter.js/src/device/Device.ts:218

`Protected`createOptionalClusterServer

createOptionalClusterServer<const T>(_cluster): ClusterServerObj<T>
Type Parameters
- const T extends ClusterType
Parameters
- _cluster: T
Returns ClusterServerObj<T>
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).createOptionalClusterServer
- Defined in packages/matter.js/src/device/Device.ts:213

determineUniqueID

determineUniqueID(): undefined | string
Returns undefined | string
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).determineUniqueID
- Defined in packages/matter.js/src/device/Endpoint.ts:285

getAllClusterClients

getAllClusterClients(): ClusterClientObj[]
Returns ClusterClientObj[]
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).getAllClusterClients
- Defined in packages/matter.js/src/device/Endpoint.ts:345

getAllClusterServers

getAllClusterServers(): ClusterServerObj[]
Returns ClusterServerObj[]
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).getAllClusterServers
- Defined in packages/matter.js/src/device/Endpoint.ts:341

getChildEndpoint

getChildEndpoint(id): undefined | Endpoint
Parameters
- id: EndpointNumber
Returns undefined | Endpoint
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).getChildEndpoint
- Defined in packages/matter.js/src/device/Endpoint.ts:267

getChildEndpoints

getChildEndpoints(): Endpoint[]
Returns Endpoint[]
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).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 extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).getClusterClient
- Defined in packages/matter.js/src/device/Device.ts:237

getClusterClientById

getClusterClientById(clusterId): undefined | ClusterClientObj
Parameters
- clusterId: ClusterId
Returns undefined | ClusterClientObj
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).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 extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).getClusterServer
- Defined in packages/matter.js/src/device/Device.ts:223

getClusterServerById

getClusterServerById(clusterId): undefined | ClusterServerObj
Parameters
- clusterId: ClusterId
Returns undefined | ClusterServerObj
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).getClusterServerById
- Defined in packages/matter.js/src/device/Endpoint.ts:203

getDeviceTypes

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

getNumber

getNumber(): EndpointNumber
Returns EndpointNumber
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).getNumber
- Defined in packages/matter.js/src/device/Endpoint.ts:108

getOnOff

getOnOff(): boolean
Returns boolean
- Defined in packages/matter.js/src/device/OnOffDevices.ts:109

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 extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).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 extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).hasClusterServer
- Defined in packages/matter.js/src/device/Endpoint.ts:211

`Protected`removeChildEndpoint

removeChildEndpoint(endpoint): void
Parameters
- endpoint: Endpoint
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).removeChildEndpoint
- Defined in packages/matter.js/src/device/Endpoint.ts:275

removeCommandHandler

removeCommandHandler(command, handler): void
Method to remove command handlers from the device. The base class do not expose any commands!
Parameters
- command: never
  Command name to remove the handler from
- handler: HandlerFunction
  Handler function to be removed
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).removeCommandHandler
- Defined in packages/matter.js/src/device/Device.ts:197
removeCommandHandler<K>(action, handler): void
Type Parameters
- K extends keyof OnOffBaseDeviceCommands
Parameters
- action: K
- handler: OnOffBaseDeviceCommands[K]
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).removeCommandHandler
- Defined in packages/general/dist/esm/util/NamedHandler.d.ts:16

removeFromStructure

removeFromStructure(): void
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).removeFromStructure
- Defined in packages/matter.js/src/device/Endpoint.ts:94

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
- reachable: boolean
  true if reachable, false otherwise
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).setBridgedDeviceReachability
- Defined in packages/matter.js/src/device/Device.ts:256

setDeviceTypes

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

setOnOff

setOnOff(onOff): void
Turns the device on or off This is an example f a convenient device class API to control the device without need to access clusters
Parameters
- onOff: boolean
  true to turn on, false to turn off
Returns void
- Defined in packages/matter.js/src/device/OnOffDevices.ts:105

setStructureChangedCallback

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

toggle

toggle(): void
Toggles the device on or off This is an example f a convenient device class API to control the device without need to access clusters

Returns void
- Defined in packages/matter.js/src/device/OnOffDevices.ts:117

updatePartsList

updatePartsList(): EndpointNumber[]
Returns EndpointNumber[]
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).updatePartsList
- Defined in packages/matter.js/src/device/Endpoint.ts:349

verifyRequiredClusters

verifyRequiredClusters(): void
Returns void
Inherited from extendPublicHandlerMethods<typeof Device, OnOffBaseDeviceCommands>(Device).verifyRequiredClusters
- Defined in packages/matter.js/src/device/Endpoint.ts:307

Class OnOffBaseDevice

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

[key: ClusterId]: AttributeInitialValues<any>

Returns OnOffBaseDevice

Properties

ProtectedcommandHandler

ProtecteddeviceTypes

ProtectedisLighting

name

number

uniqueStorageKey

Accessors

deviceType

Returns DeviceTypeId

Methods

Protected_executeHandler

Parameters

Returns Promise<any>

Type Parameters

Parameters

Returns Promise<void>

addChildEndpoint

Parameters

Returns void

addClusterClient

Parameters

Returns void

addClusterServer

Type Parameters

Parameters

Returns void

addCommandHandler

Parameters

Returns void

Type Parameters

Parameters

Returns void

ProtectedaddDeviceClusters

Parameters

[key: ClusterId]: AttributeInitialValues<any>

Returns void

addFixedLabel

Parameters

Returns void

addOnOffListener

Parameters

Parameters

Returns void

Returns void

addUserLabel

Parameters

Returns void

close

Returns void

ProtectedcreateOptionalClusterClient

Type Parameters

Parameters

Returns ClusterClientObj<T>

ProtectedcreateOptionalClusterServer

Type Parameters

Parameters

Returns ClusterServerObj<T>

determineUniqueID

Returns undefined | string

getAllClusterClients

Returns ClusterClientObj[]

getAllClusterServers

Returns ClusterServerObj[]

getChildEndpoint

Parameters

Returns undefined | Endpoint

getChildEndpoints

`Protected`commandHandler

`Protected`deviceTypes

`Protected`isLighting

`Protected`_executeHandler

`Protected`addDeviceClusters

`Protected`createOptionalClusterClient

`Protected`createOptionalClusterServer

`Protected`removeChildEndpoint