Class Endpoint

Hierarchy (View Summary)

ZigbeeEntity
- Endpoint

Properties

`Readonly`clusters

clusters: Clusters

`Optional`deviceID

deviceID?: number

deviceIeeeAddress

deviceIeeeAddress: string

deviceNetworkAddress

deviceNetworkAddress: number

`Readonly`ID

ID: number

inputClusters

inputClusters: number[]

outputClusters

outputClusters: number[]

`Optional`profileID

profileID?: number

Accessors

binds

get binds(): Bind[]
Returns Bind[]
- Defined in src/controller/model/endpoint.ts:122

configuredReportings

get configuredReportings(): ConfiguredReporting[]
Returns ConfiguredReporting[]
- Defined in src/controller/model/endpoint.ts:139

Methods

addBinding

addBinding(clusterKey: string | number, target: number | Endpoint | Group): void
Parameters
- clusterKey: string | number
- target: number | Endpoint | Group
Returns void
- Defined in src/controller/model/endpoint.ts:666

addToGroup

addToGroup(group: Group): Promise<void>
Parameters
- group: Group
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:1097

bind

bind(
clusterKey: string | number,
target: number | Endpoint | Group,
): Promise<void>
Parameters
- clusterKey: string | number
- target: number | Endpoint | Group
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:693

clearBindings

clearBindings(): void
Returns void
- Defined in src/controller/model/endpoint.ts:389

command

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

commandResponse

commandResponse<
    Cl extends string
    | number,
    Co extends string | number,
    Custom extends TCustomCluster | undefined = undefined,
>(
    clusterKey: Cl,
    commandKey: Co,
    payload: ClusterOrRawPayload<Cl, Co, Custom>,
    options?: Options,
    transactionSequenceNumber?: number,
): Promise<void>
Type Parameters
- Cl extends string | number
- Co extends string | number
- Custom extends TCustomCluster | undefined = undefined
Parameters
- clusterKey: Cl
- commandKey: Co
- payload: ClusterOrRawPayload<Cl, Co, Custom>
- Optionaloptions: Options
- OptionaltransactionSequenceNumber: number
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:947

configureReporting

configureReporting<
    Cl extends string
    | number,
    Custom extends TCustomCluster | undefined = undefined,
>(
    clusterKey: Cl,
    items: ConfigureReportingItem<Cl, Custom>[],
    options?: Options,
): Promise<void>
Type Parameters
- Cl extends string | number
- Custom extends TCustomCluster | undefined = undefined
Parameters
- clusterKey: Cl
- items: ConfigureReportingItem<Cl, Custom>[]
- Optionaloptions: Options
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:811

defaultResponse

defaultResponse(
    commandID: number,
    status: number,
    clusterID: number,
    transactionSequenceNumber: number,
    options?: Options,
): Promise<void>
Parameters
- commandID: number
- status: number
- clusterID: number
- transactionSequenceNumber: number
- Optionaloptions: Options
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:799

getBindIndex

getBindIndex(clusterId: number, target: Endpoint | Group): number
Parameters
- clusterId: number
- target: Endpoint | Group
Returns number
- Defined in src/controller/model/endpoint.ts:662

getClusterAttributeValue

getClusterAttributeValue(
clusterKey: string | number,
attributeKey: string | number,
): string | number | undefined
Parameters
- clusterKey: string | number
- attributeKey: string | number
Returns string | number | undefined
- Defined in src/controller/model/endpoint.ts:325

getDevice

getDevice(): Device
Get device of this endpoint

Returns Device
- Defined in src/controller/model/endpoint.ts:192

getInputClusters

getInputClusters(): Cluster[]
Returns Cluster[]
- Defined in src/controller/model/endpoint.ts:226

getOutputClusters

getOutputClusters(): Cluster[]
Returns Cluster[]
- Defined in src/controller/model/endpoint.ts:233

hasBind

hasBind(clusterId: number, target: Endpoint | Group): boolean
Parameters
- clusterId: number
- target: Endpoint | Group
Returns boolean
- Defined in src/controller/model/endpoint.ts:658

hasPendingRequests

hasPendingRequests(): boolean
Returns boolean
- Defined in src/controller/model/endpoint.ts:395

read

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

readReportingConfig

readReportingConfig<
    Cl extends string
    | number,
    Custom extends TCustomCluster | undefined = undefined,
>(
    clusterKey: Cl,
    items: ReadReportConfigItem<Cl, Custom>[],
    options?: Options,
): Promise<
    {
        attrId: number;
        dataType?: number;
        direction: number;
        maxRepIntval?: number;
        minRepIntval?: number;
        repChange?: unknown;
        status: number;
        timeout?: number;
    }[],
>
Type Parameters
- Cl extends string | number
- Custom extends TCustomCluster | undefined = undefined
Parameters
- clusterKey: Cl
- items: ReadReportConfigItem<Cl, Custom>[]
- Optionaloptions: Options
Returns Promise<
    {
        attrId: number;
        dataType?: number;
        direction: number;
        maxRepIntval?: number;
        minRepIntval?: number;
        repChange?: unknown;
        status: number;
        timeout?: number;
    }[],
>
- Defined in src/controller/model/endpoint.ts:883

readResponse

readResponse<
    Cl extends string
    | number,
    Custom extends TCustomCluster | undefined = undefined,
>(
    clusterKey: Cl,
    transactionSequenceNumber: number,
    attributes: PartialClusterOrRawWriteAttributes<Cl, Custom>,
    options?: Options,
): Promise<void>
Type Parameters
- Cl extends string | number
- Custom extends TCustomCluster | undefined = undefined
Parameters
- clusterKey: Cl
- transactionSequenceNumber: number
- attributes: PartialClusterOrRawWriteAttributes<Cl, Custom>
- Optionaloptions: Options
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:607

removeFromAllGroups

removeFromAllGroups(): Promise<void>
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:1135

removeFromAllGroupsDatabase

removeFromAllGroupsDatabase(): void
Returns void
- Defined in src/controller/model/endpoint.ts:1140

removeFromGroup

removeFromGroup(group: number | Group): Promise<void>
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
- group: number | Group
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:1119

report

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

save

save(): void
Returns void
- Defined in src/controller/model/endpoint.ts:735

saveBindings

saveBindings(binds: BindInternal[]): void
Parameters
- binds: BindInternal[]
Returns void
- Defined in src/controller/model/endpoint.ts:383

saveClusterAttributeKeyValue

saveClusterAttributeKeyValue(clusterKey: string | number, list: KeyValue): void
Parameters
- clusterKey: string | number
- list: KeyValue
Returns void
- Defined in src/controller/model/endpoint.ts:313

saveClusterAttributeReportConfig

saveClusterAttributeReportConfig(
    clusterId: number,
    manufacturerCode: ManufacturerCode | undefined,
    reportConfigs: {
        attrId: number;
        dataType?: number;
        direction: number;
        maxRepIntval?: number;
        minRepIntval?: number;
        repChange?: unknown;
        status: number;
        timeout?: number;
    }[],
): void
Parameters
- clusterId: number
- manufacturerCode: ManufacturerCode | undefined
- reportConfigs: {
      attrId: number;
      dataType?: number;
      direction: number;
      maxRepIntval?: number;
      minRepIntval?: number;
      repChange?: unknown;
      status: number;
      timeout?: number;
  }[]
  - attrId: number
    Type: DATA16
  - OptionaldataType?: number
    Type: DATA8 conditions=[{fieldEquals field=status value=0}{fieldEquals field=direction value=0}]
  - direction: number
    Type: DATA8
  - OptionalmaxRepIntval?: number
    Type: DATA16 conditions=[{fieldEquals field=status value=0}{fieldEquals field=direction value=0}]
  - OptionalminRepIntval?: number
    Type: DATA16 conditions=[{fieldEquals field=status value=0}{fieldEquals field=direction value=0}]
  - OptionalrepChange?: unknown
    Type: USE_DATA_TYPE conditions=[{fieldEquals field=status value=0}{fieldEquals field=direction value=0}{dataTypeValueTypeEquals value=ANALOG}]
  - status: number
    Type: ENUM8
  - Optionaltimeout?: number
    Type: DATA16 conditions=[{fieldEquals field=status value=0}{fieldEquals field=direction value=1}]
Returns void
- Defined in src/controller/model/endpoint.ts:340

sendPendingRequests

sendPendingRequests(fastPolling: boolean): Promise<void>
Parameters
- fastPolling: boolean
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:399

supportsInputCluster

supportsInputCluster(clusterKey: string | number): boolean
Parameters
- clusterKey: string | number
Returns boolean
- Defined in src/controller/model/endpoint.ts:209

supportsOutputCluster

supportsOutputCluster(clusterKey: string | number): boolean
Parameters
- clusterKey: string | number
Returns boolean
- Defined in src/controller/model/endpoint.ts:218

toDatabaseRecord

toDatabaseRecord(): KeyValue
Returns KeyValue
- Defined in src/controller/model/endpoint.ts:287

unbind

unbind(
clusterKey: string | number,
target: number | Endpoint | Group,
): Promise<void>
Parameters
- clusterKey: string | number
- target: number | Endpoint | Group
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:739

updateSimpleDescriptor

updateSimpleDescriptor(): Promise<void>
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:641

waitForCommand

waitForCommand(
    clusterKey: string | number,
    commandKey: string | number,
    transactionSequenceNumber: number | undefined,
    timeout: number,
): {
    cancel: () => void;
    promise: Promise<{ header: ZclHeader; payload: KeyValue }>;
}
Parameters
- clusterKey: string | number
- commandKey: string | number
- transactionSequenceNumber: number | undefined
- timeout: number
Returns {
cancel: () => void;
promise: Promise<{ header: ZclHeader; payload: KeyValue }>;
}
- Defined in src/controller/model/endpoint.ts:998

write

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

writeResponse

writeResponse<
    Cl extends string
    | number,
    Custom extends TCustomCluster | undefined = undefined,
>(
    clusterKey: Cl,
    transactionSequenceNumber: number,
    attributes: Partial<
        Record<
            ClusterOrRawAttributeKeys<Cl, Custom>[number],
            { attrId?: number; status: number },
        >,
    > & Record<number, { attrId?: number; status: number }>,
    options?: Options,
): Promise<void>
Type Parameters
- Cl extends string | number
- Custom extends TCustomCluster | undefined = undefined
Parameters
- clusterKey: Cl
- transactionSequenceNumber: number
- attributes: Partial<
      Record<
          ClusterOrRawAttributeKeys<Cl, Custom>[number],
          { attrId?: number; status: number },
      >,
  > & Record<number, { attrId?: number; status: number }>
- Optionaloptions: Options
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:526

writeStructured

writeStructured<Cl extends string | number>(
    clusterKey: Cl,
    payload: {
        attrId: number;
        dataType: number;
        elementData: unknown;
        selector: StructuredSelector;
    }[],
    options?: Options,
): Promise<void>
Type Parameters
- Cl extends string | number
Parameters
- clusterKey: Cl
- payload: {
      attrId: number;
      dataType: number;
      elementData: unknown;
      selector: StructuredSelector;
  }[]
  - attrId: number
    Type: DATA16
  - dataType: number
    Type: DATA8
  - elementData: unknown
    Type: USE_DATA_TYPE
  - selector: StructuredSelector
    Type: STRUCTURED_SELECTOR
- Optionaloptions: Options
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:926

zclCommand

zclCommand<
    Cl extends string
    | number,
    Co extends string | number,
    Custom extends TCustomCluster | undefined = undefined,
>(
    clusterKey: Cluster | Cl,
    commandKey: Command | Co,
    payload: ClusterOrRawPayload<Cl, Co, Custom> | FoundationOrRawPayload<Co>,
    options?: Options,
    logPayload?: KeyValue,
    checkStatus?: boolean,
    frameType?: FrameType,
): Promise<ZclFrame | undefined>
Type Parameters
- Cl extends string | number
- Co extends string | number
- Custom extends TCustomCluster | undefined = undefined
Parameters
- clusterKey: Cluster | Cl
- commandKey: Command | Co
- payload: ClusterOrRawPayload<Cl, Co, Custom> | FoundationOrRawPayload<Co>
- Optionaloptions: Options
- OptionallogPayload: KeyValue
- checkStatus: boolean = false
- frameType: FrameType = Zcl.FrameType.GLOBAL
Returns Promise<ZclFrame | undefined>
- Defined in src/controller/model/endpoint.ts:1148

zclCommandBroadcast

zclCommandBroadcast<
    Cl extends string
    | number,
    Co extends string | number,
    Custom extends TCustomCluster | undefined = undefined,
>(
    endpoint: number,
    destination: BroadcastAddress,
    clusterKey: Cl,
    commandKey: Co,
    payload: ClusterOrRawPayload<Cl, Co, Custom> | FoundationOrRawPayload<Co>,
    options?: Options,
): Promise<void>
Type Parameters
- Cl extends string | number
- Co extends string | number
- Custom extends TCustomCluster | undefined = undefined
Parameters
- endpoint: number
- destination: BroadcastAddress
- clusterKey: Cl
- commandKey: Co
- payload: ClusterOrRawPayload<Cl, Co, Custom> | FoundationOrRawPayload<Co>
- Optionaloptions: Options
Returns Promise<void>
- Defined in src/controller/model/endpoint.ts:1205

`Static`create

create(
    id: number,
    profileID: number | undefined,
    deviceID: number | undefined,
    inputClusters: number[],
    outputClusters: number[],
    deviceNetworkAddress: number,
    deviceIeeeAddress: string,
): Endpoint
Parameters
- id: number
- profileID: number | undefined
- deviceID: number | undefined
- inputClusters: number[]
- outputClusters: number[]
- deviceNetworkAddress: number
- deviceIeeeAddress: string
Returns Endpoint
- Defined in src/controller/model/endpoint.ts:301

`Static`fromDatabaseRecord

fromDatabaseRecord(
    record: KeyValue,
    deviceNetworkAddress: number,
    deviceIeeeAddress: string,
): Endpoint
Parameters
- record: KeyValue
- deviceNetworkAddress: number
- deviceIeeeAddress: string
Returns Endpoint
- Defined in src/controller/model/endpoint.ts:245

`Static`injectAdapter

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

`Static`injectDatabase

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

Class Endpoint

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Readonlyclusters

OptionaldeviceID

deviceIeeeAddress

deviceNetworkAddress

ReadonlyID

inputClusters

meta

outputClusters

OptionalprofileID

Accessors

binds

Returns Bind[]

configuredReportings

Returns ConfiguredReporting[]

Methods

addBinding

Parameters

Returns void

addToGroup

Parameters

Returns Promise<void>

bind

Parameters

Returns Promise<void>

clearBindings

Returns void

command

Type Parameters

Parameters

Returns Promise<KeyValue | undefined>

commandResponse

Type Parameters

Parameters

Returns Promise<void>

configureReporting

Type Parameters

Parameters

Returns Promise<void>

defaultResponse

Parameters

Returns Promise<void>

getBindIndex

Parameters

Returns number

getClusterAttributeValue

Parameters

Returns string | number | undefined

getDevice

Returns Device

getInputClusters

Returns Cluster[]

getOutputClusters

Returns Cluster[]

hasBind

Parameters

Returns boolean

hasPendingRequests

Returns boolean

read

Type Parameters

Parameters

Returns Promise<ClusterOrRawAttributes<Cl, Custom>>

readReportingConfig

Type Parameters

Parameters

Returns Promise< { attrId: number; dataType?: number; direction: number; maxRepIntval?: number; minRepIntval?: number; repChange?: unknown; status: number; timeout?: number; }[],>

readResponse

Type Parameters

Parameters

Returns Promise<void>

removeFromAllGroups

Returns Promise<void>

removeFromAllGroupsDatabase

`Readonly`clusters

`Optional`deviceID

`Readonly`ID

`Optional`profileID

Returns Promise<
{
attrId: number;
dataType?: number;
direction: number;
maxRepIntval?: number;
minRepIntval?: number;
repChange?: unknown;
status: number;
timeout?: number;
}[],
>

`Optional`dataType?: number

`Optional`maxRepIntval?: number

`Optional`minRepIntval?: number

`Optional`repChange?: unknown

`Optional`timeout?: number

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