_controller_model_endpoint_.endpoint.md

zigbee-herdsman › "controller/model/endpoint" › Endpoint

Class: Endpoint

Hierarchy

• Entity

  ↳ Endpoint

Index

Properties

• ID
• clusters
• deviceID
• deviceNetworkAddress
• inputClusters
• outputClusters
• profileID

Accessors

• binds

Methods

• addToGroup
• bind
• command
• commandResponse
• configureReporting
• defaultResponse
• getClusterAttributeValue
• getDevice
• read
• readResponse
• removeFromAllGroups
• removeFromGroup
• saveClusterAttributeKeyValue
• supportsInputCluster
• supportsOutputCluster
• toDatabaseRecord
• unbind
• waitForCommand
• write
• create
• fromDatabaseRecord
• injectAdapter
• injectDatabase

Properties

ID

• ID: number

Defined in src/controller/model/endpoint.ts:53

---

clusters

• clusters: Clusters

Defined in src/controller/model/endpoint.ts:54

---

Optional deviceID

• deviceID? : number

Defined in src/controller/model/endpoint.ts:49

---

deviceNetworkAddress

• deviceNetworkAddress: number

Defined in src/controller/model/endpoint.ts:56

---

inputClusters

• inputClusters: number[]

Defined in src/controller/model/endpoint.ts:50

---

outputClusters

• outputClusters: number[]

Defined in src/controller/model/endpoint.ts:51

---

Optional profileID

• profileID? : number

Defined in src/controller/model/endpoint.ts:52

Accessors

binds

• get binds(): Bind[]

Defined in src/controller/model/endpoint.ts:60

Returns: Bind[]

Methods

addToGroup

▸ addToGroup(group: Group): Promise‹void›

Defined in src/controller/model/endpoint.ts:503

Parameters:

Name	Type
group	Group

Returns: Promise‹void›

---

bind

▸ bind(clusterKey: number | string, target: Endpoint | Group | number): Promise‹void›

Defined in src/controller/model/endpoint.ts:279

Parameters:

Name	Type
clusterKey	number | string
target	Endpoint | Group | number

Returns: Promise‹void›

---

command

▸ command(clusterKey: number | string, commandKey: number | string, payload: KeyValue, options?: Options): Promise‹void | KeyValue›

Defined in src/controller/model/endpoint.ts:415

Parameters:

Name	Type
clusterKey	number | string
commandKey	number | string
payload	KeyValue
options?	Options

Returns: Promise‹void | KeyValue›

---

commandResponse

▸ commandResponse(clusterKey: number | string, commandKey: number | string, payload: KeyValue, options?: Options, transactionSequenceNumber?: number): Promise‹void | KeyValue›

Defined in src/controller/model/endpoint.ts:447

Parameters:

Name	Type
clusterKey	number | string
commandKey	number | string
payload	KeyValue
options?	Options
transactionSequenceNumber?	number

Returns: Promise‹void | KeyValue›

---

configureReporting

▸ configureReporting(clusterKey: number | string, items: ConfigureReportingItem[], options?: Options): Promise‹void›

Defined in src/controller/model/endpoint.ts:368

Parameters:

Name	Type
clusterKey	number | string
items	ConfigureReportingItem[]
options?	Options

Returns: Promise‹void›

---

defaultResponse

▸ defaultResponse(commandID: number, status: number, clusterID: number, transactionSequenceNumber: number, options?: Options): Promise‹void›

Defined in src/controller/model/endpoint.ts:345

Parameters:

Name	Type
commandID	number
status	number
clusterID	number
transactionSequenceNumber	number
options?	Options

Returns: Promise‹void›

---

getClusterAttributeValue

▸ getClusterAttributeValue(clusterKey: number | string, attributeKey: number | string): number | string

Defined in src/controller/model/endpoint.ts:161

Parameters:

Name	Type
clusterKey	number | string
attributeKey	number | string

Returns: number | string

---

getDevice

▸ getDevice(): Device

Defined in src/controller/model/endpoint.ts:95

Get device of this endpoint

Returns: Device

---

read

▸ read(clusterKey: number | string, attributes: string[] | number[], options?: Options): Promise‹KeyValue›

Defined in src/controller/model/endpoint.ts:211

Parameters:

Name	Type
clusterKey	number | string
attributes	string[] | number[]
options?	Options

Returns: Promise‹KeyValue›

---

readResponse

▸ readResponse(clusterKey: number | string, transactionSequenceNumber: number, attributes: KeyValue, options?: Options): Promise‹void›

Defined in src/controller/model/endpoint.ts:242

Parameters:

Name	Type
clusterKey	number | string
transactionSequenceNumber	number
attributes	KeyValue
options?	Options

Returns: Promise‹void›

---

removeFromAllGroups

▸ removeFromAllGroups(): Promise‹void›

Defined in src/controller/model/endpoint.ts:520

Returns: Promise‹void›

---

removeFromGroup

▸ removeFromGroup(group: Group | number): Promise‹void›

Defined in src/controller/model/endpoint.ts:513

Remove endpoint from a group, accepts both a Group and number as parameter. The number parameter type should only be used when removing from a group which is not known to zigbee-herdsman.

Parameters:

Name	Type
group	Group | number

Returns: Promise‹void›

---

saveClusterAttributeKeyValue

▸ saveClusterAttributeKeyValue(clusterKey: number | string, list: KeyValue): void

Defined in src/controller/model/endpoint.ts:152

Parameters:

Name	Type
clusterKey	number | string
list	KeyValue

Returns: void

---

supportsInputCluster

▸ supportsInputCluster(clusterKey: number | string): boolean

Defined in src/controller/model/endpoint.ts:103

Parameters:

Name	Type
clusterKey	number | string

Returns: boolean

---

supportsOutputCluster

▸ supportsOutputCluster(clusterKey: number | string): boolean

Defined in src/controller/model/endpoint.ts:108

Parameters:

Name	Type
clusterKey	number | string

Returns: boolean

---

toDatabaseRecord

▸ toDatabaseRecord(): KeyValue

Defined in src/controller/model/endpoint.ts:134

Returns: KeyValue

---

unbind

▸ unbind(clusterKey: number | string, target: Endpoint | Group | number): Promise‹void›

Defined in src/controller/model/endpoint.ts:316

Parameters:

Name	Type
clusterKey	number | string
target	Endpoint | Group | number

Returns: Promise‹void›

---

waitForCommand

▸ waitForCommand(clusterKey: number | string, commandKey: number | string, transactionSequenceNumber: number, timeout: number): object

Defined in src/controller/model/endpoint.ts:474

Parameters:

Name	Type
clusterKey	number | string
commandKey	number | string
transactionSequenceNumber	number
timeout	number

Returns: object

• cancel(): function

  • (): void

• promise: Promise‹object›

---

write

▸ write(clusterKey: number | string, attributes: KeyValue, options?: Options): Promise‹void›

Defined in src/controller/model/endpoint.ts:175

Parameters:

Name	Type
clusterKey	number | string
attributes	KeyValue
options?	Options

Returns: Promise‹void›

---

Static create

▸ create(ID: number, profileID: number, deviceID: number, inputClusters: number[], outputClusters: number[], deviceNetworkAddress: number, deviceIeeeAddress: string): Endpoint

Defined in src/controller/model/endpoint.ts:142

Parameters:

Name	Type
ID	number
profileID	number
deviceID	number
inputClusters	number[]
outputClusters	number[]
deviceNetworkAddress	number
deviceIeeeAddress	string

Returns: Endpoint

---

Static fromDatabaseRecord

▸ fromDatabaseRecord(record: KeyValue, deviceNetworkAddress: number, deviceIeeeAddress: string): Endpoint

Defined in src/controller/model/endpoint.ts:117

Parameters:

Name	Type
record	KeyValue
deviceNetworkAddress	number
deviceIeeeAddress	string

Returns: Endpoint

---

Static injectAdapter

▸ injectAdapter(adapter: Adapter): void

Inherited from Group.injectAdapter

Defined in src/controller/model/entity.ts:12

Parameters:

Name	Type
adapter	Adapter

Returns: void

---

Static injectDatabase

▸ injectDatabase(database: Database): void

Inherited from Group.injectDatabase

Defined in src/controller/model/entity.ts:8

Parameters:

Name	Type
database	Database

Returns: void