Class ZigbeeEntity`Abstract`

Hierarchy (View Summary)

Entity
- ZigbeeEntity
  - Endpoint
  - Group

Index

Constructors

Methods

command read write injectAdapter injectDatabase

Constructors

constructor

new ZigbeeEntity(options?: EventEmitterOptions): ZigbeeEntity
Parameters
- Optionaloptions: EventEmitterOptions
Returns ZigbeeEntity
Inherited from Entity.constructor
- Defined in node_modules/.pnpm/@types+node@24.5.2/node_modules/@types/node/events.d.ts:134

Methods

`Abstract`command

command<
    Cl extends string
    | number,
    Co extends string | number,
    Custom extends undefined | TCustomCluster = undefined,
>(
    clusterKey: Cl,
    commandKey: Co,
    payload: ClusterOrRawPayload<Cl, Co, Custom>,
    options?: KeyValue,
): Promise<undefined | KeyValue>
Type Parameters
- Cl extends string | number
- Co extends string | number
- Custom extends undefined | TCustomCluster = undefined
Parameters
- clusterKey: Cl
- commandKey: Co
- payload: ClusterOrRawPayload<Cl, Co, Custom>
- Optionaloptions: KeyValue
Returns Promise<undefined | KeyValue>
- Defined in src/controller/model/zigbeeEntity.ts:24

`Abstract`read

read<
    Cl extends string
    | number,
    Custom extends undefined | TCustomCluster = undefined,
>(
    clusterKey: Cl,
    attributes: ClusterOrRawAttributeKeys<Cl, Custom>,
    options?: KeyValue,
): Promise<undefined | ClusterOrRawAttributes<Cl, Custom>>
Type Parameters
- Cl extends string | number
- Custom extends undefined | TCustomCluster = undefined
Parameters
- clusterKey: Cl
- attributes: ClusterOrRawAttributeKeys<Cl, Custom>
- Optionaloptions: KeyValue
Returns Promise<undefined | ClusterOrRawAttributes<Cl, Custom>>
- Defined in src/controller/model/zigbeeEntity.ts:12

`Abstract`write

write<
    Cl extends string
    | number,
    Custom extends undefined | TCustomCluster = undefined,
>(
    clusterKey: Cl,
    attributes: PartialClusterOrRawWriteAttributes<Cl, Custom>,
    options?: KeyValue,
): Promise<void>
Type Parameters
- Cl extends string | number
- Custom extends undefined | TCustomCluster = undefined
Parameters
- clusterKey: Cl
- attributes: PartialClusterOrRawWriteAttributes<Cl, Custom>
- Optionaloptions: KeyValue
Returns Promise<void>
- Defined in src/controller/model/zigbeeEntity.ts:18

`Static`injectAdapter

injectAdapter(adapter: Adapter): void
Parameters
- adapter: Adapter
Returns void
Inherited from Entity.injectAdapter
- Defined in src/controller/model/entity.ts:18

`Static`injectDatabase

injectDatabase(database: Database): void
Parameters
- database: Database
Returns void
Inherited from Entity.injectDatabase
- Defined in src/controller/model/entity.ts:14