zigbee-herdsman › "controller/model/endpoint" › Endpoint
-
Entity
↳ Endpoint
- addToGroup
- bind
- command
- configureReporting
- defaultResponse
- getClusterAttributeValue
- getDevice
- read
- readResponse
- removeFromAllGroups
- removeFromGroup
- saveClusterAttributeList
- supportsInputCluster
- supportsOutputCluster
- toDatabaseRecord
- unbind
- write
- create
- fromDatabaseRecord
- injectAdapter
- injectDatabase
• ID: number
Defined in controller/model/endpoint.ts:46
• clusters: Clusters
Defined in controller/model/endpoint.ts:47
• deviceID? : number
Defined in controller/model/endpoint.ts:42
• deviceNetworkAddress: number
Defined in controller/model/endpoint.ts:49
• inputClusters: number[]
Defined in controller/model/endpoint.ts:43
• outputClusters: number[]
Defined in controller/model/endpoint.ts:44
• profileID? : number
Defined in controller/model/endpoint.ts:45
• get binds(): Bind[]
Defined in controller/model/endpoint.ts:53
Returns: Bind[]
▸ addToGroup(group
: Group): Promise‹void›
Defined in controller/model/endpoint.ts:352
Parameters:
Name | Type |
---|---|
group |
Group |
Returns: Promise‹void›
▸ bind(clusterKey
: number | string, target
: Endpoint | Group): Promise‹void›
Defined in controller/model/endpoint.ts:229
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
target |
Endpoint | Group |
Returns: Promise‹void›
▸ command(clusterKey
: number | string, commandKey
: number | string, payload
: KeyValue, options?
: Options): Promise‹void | KeyValue›
Defined in controller/model/endpoint.ts:318
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
commandKey |
number | string |
payload |
KeyValue |
options? |
Options |
Returns: Promise‹void | KeyValue›
▸ configureReporting(clusterKey
: number | string, items
: ConfigureReportingItem[], options?
: Options): Promise‹void›
Defined in controller/model/endpoint.ts:282
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
items |
ConfigureReportingItem[] |
options? |
Options |
Returns: Promise‹void›
▸ defaultResponse(commandID
: number, status
: number, clusterID
: number, transactionSequenceNumber
: number, options?
: Options): Promise‹void›
Defined in controller/model/endpoint.ts:270
Parameters:
Name | Type |
---|---|
commandID |
number |
status |
number |
clusterID |
number |
transactionSequenceNumber |
number |
options? |
Options |
Returns: Promise‹void›
▸ getClusterAttributeValue(clusterKey
: number | string, attributeKey
: number | string): number | string
Defined in controller/model/endpoint.ts:153
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
attributeKey |
number | string |
Returns: number | string
▸ getDevice(): Device
Defined in controller/model/endpoint.ts:87
Get device of this endpoint
Returns: Device
▸ read(clusterKey
: number | string, attributes
: string[] | number[], options?
: Options): Promise‹KeyValue›
Defined in controller/model/endpoint.ts:191
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
attributes |
string[] | number[] |
options? |
Options |
Returns: Promise‹KeyValue›
▸ readResponse(clusterKey
: number | string, transactionSequenceNumber
: number, attributes
: KeyValue, options?
: Options): Promise‹void›
Defined in controller/model/endpoint.ts:211
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
transactionSequenceNumber |
number |
attributes |
KeyValue |
options? |
Options |
Returns: Promise‹void›
▸ removeFromAllGroups(): Promise‹void›
Defined in controller/model/endpoint.ts:369
Returns: Promise‹void›
▸ removeFromGroup(group
: Group | number): Promise‹void›
Defined in controller/model/endpoint.ts:362
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›
▸ saveClusterAttributeList(clusterKey
: number | string, list
: KeyValue): void
Defined in controller/model/endpoint.ts:144
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
list |
KeyValue |
Returns: void
▸ supportsInputCluster(clusterKey
: number | string): boolean
Defined in controller/model/endpoint.ts:95
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
Returns: boolean
▸ supportsOutputCluster(clusterKey
: number | string): boolean
Defined in controller/model/endpoint.ts:100
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
Returns: boolean
▸ toDatabaseRecord(): KeyValue
Defined in controller/model/endpoint.ts:126
Returns: KeyValue
▸ unbind(clusterKey
: number | string, target
: Endpoint | Group): Promise‹void›
Defined in controller/model/endpoint.ts:253
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
target |
Endpoint | Group |
Returns: Promise‹void›
▸ write(clusterKey
: number | string, attributes
: KeyValue, options?
: Options): Promise‹void›
Defined in controller/model/endpoint.ts:167
Parameters:
Name | Type |
---|---|
clusterKey |
number | string |
attributes |
KeyValue |
options? |
Options |
Returns: Promise‹void›
▸ create(ID
: number, profileID
: number, deviceID
: number, inputClusters
: number[], outputClusters
: number[], deviceNetworkAddress
: number, deviceIeeeAddress
: string): Endpoint
Defined in controller/model/endpoint.ts:134
Parameters:
Name | Type |
---|---|
ID |
number |
profileID |
number |
deviceID |
number |
inputClusters |
number[] |
outputClusters |
number[] |
deviceNetworkAddress |
number |
deviceIeeeAddress |
string |
Returns: Endpoint
▸ fromDatabaseRecord(record
: KeyValue, deviceNetworkAddress
: number, deviceIeeeAddress
: string): Endpoint
Defined in controller/model/endpoint.ts:109
Parameters:
Name | Type |
---|---|
record |
KeyValue |
deviceNetworkAddress |
number |
deviceIeeeAddress |
string |
Returns: Endpoint
▸ injectAdapter(adapter
: Adapter): void
Inherited from void
Defined in controller/model/entity.ts:12
Parameters:
Name | Type |
---|---|
adapter |
Adapter |
Returns: void
▸ injectDatabase(database
: Database): void
Inherited from void
Defined in controller/model/entity.ts:8
Parameters:
Name | Type |
---|---|
database |
Database |
Returns: void