_src_controller_model_endpoint_.endpoint.md

zigbee-herdsman

Globals / "src/controller/model/endpoint" / Endpoint

Class: Endpoint

Hierarchy

• Entity

  ↳ Endpoint

Index

Properties

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

Accessors

• binds

Methods

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

Properties

ID

• Readonly ID: number

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

---

clusters

• Readonly clusters: Clusters

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

---

deviceID

• Optional deviceID: number

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

---

deviceNetworkAddress

• deviceNetworkAddress: number

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

---

inputClusters

• inputClusters: number[]

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

---

outputClusters

• outputClusters: number[]

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

---

profileID

• Optional profileID: number

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

Accessors

binds

• get binds(): Bind[]

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

Returns: Bind[]

Methods

addBinding

▸ addBinding(clusterKey: number | string, target: Endpoint | Group | number): void

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

Parameters:

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

Returns: void

---

addToGroup

▸ addToGroup(group: Group): Promise<void>

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

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:367

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:513

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:547

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:458

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:431

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:205

Parameters:

Name	Type
clusterKey	number | string
attributeKey	number | string

Returns: number | string

---

getDevice

▸ getDevice(): Device

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

Get device of this endpoint

Returns: Device

---

getInputClusters

▸ getInputClusters(): Cluster[]

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

Returns: Cluster[]

---

getOutputClusters

▸ getOutputClusters(): Cluster[]

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

Returns: Cluster[]

---

read

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

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

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:308

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:633

Returns: Promise<void>

---

removeFromAllGroupsDatabase

▸ removeFromAllGroupsDatabase(): void

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

Returns: void

---

removeFromGroup

▸ removeFromGroup(group: Group | number): Promise<void>

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

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>

---

save

▸ save(): void

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

Returns: void

---

saveClusterAttributeKeyValue

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

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

Parameters:

Name	Type
clusterKey	number | string
list	KeyValue

Returns: void

---

supportsInputCluster

▸ supportsInputCluster(clusterKey: number | string): boolean

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

Parameters:

Name	Type
clusterKey	number | string

Returns: boolean

---

supportsOutputCluster

▸ supportsOutputCluster(clusterKey: number | string): boolean

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

Parameters:

Name	Type
clusterKey	number | string

Returns: boolean

---

toDatabaseRecord

▸ toDatabaseRecord(): KeyValue

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

Returns: KeyValue

---

unbind

▸ unbind(clusterKey: number | string, target: Endpoint | Group | number): Promise<void>

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

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:578

Parameters:

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

Returns: object

Name	Type
cancel	() => void
promise	Promise<{ header: KeyValue ; payload: KeyValue }>

---

write

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

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

Parameters:

Name	Type
clusterKey	number | string
attributes	KeyValue
options?	Options

Returns: Promise<void>

---

create

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

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

Parameters:

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

Returns: Endpoint

---

fromDatabaseRecord

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

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

Parameters:

Name	Type
record	KeyValue
deviceNetworkAddress	number
deviceIeeeAddress	string

Returns: Endpoint

---

injectAdapter

▸ StaticinjectAdapter(adapter: Adapter): void

Inherited from Group.injectAdapter

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

Parameters:

Name	Type
adapter	Adapter

Returns: void

---

injectDatabase

▸ StaticinjectDatabase(database: Database): void

Inherited from Group.injectDatabase

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

Parameters:

Name	Type
database	Database

Returns: void