Class Device

meta

applicationVersion

• get applicationVersion(): number | undefined

  Returns number | undefined

• set applicationVersion(version: number): void

  Parameters

  • version: number

  Returns void

checkinInterval

• get checkinInterval(): number | undefined

  Returns number | undefined

• set checkinInterval(checkinInterval: number | undefined): void

  Parameters

  • checkinInterval: number | undefined

  Returns void

customClusters

• get customClusters(): CustomClusters

  Returns CustomClusters

customReadResponse

• get customReadResponse(): CustomReadResponse | undefined

  Returns CustomReadResponse | undefined

• set customReadResponse(customReadResponse: CustomReadResponse | undefined): void

  If the set function returns true, the default read response behavior is skipped

  Parameters

  • customReadResponse: CustomReadResponse | undefined

  Returns void

dateCode

• get dateCode(): string | undefined

  Returns string | undefined

• set dateCode(code: string): void

  Parameters

  • code: string

  Returns void

endpoints

• get endpoints(): Endpoint[]

  Returns Endpoint[]

genBasic

• get genBasic(): TPartialClusterAttributes<"genBasic">

  Returns TPartialClusterAttributes<"genBasic">

gpSecurityKey

• get gpSecurityKey(): number[] | undefined

  Returns number[] | undefined

hardwareVersion

• get hardwareVersion(): number | undefined

  Returns number | undefined

• set hardwareVersion(version: number): void

  Parameters

  • version: number

  Returns void

ieeeAddr

• get ieeeAddr(): string

  Returns string

• set ieeeAddr(ieeeAddr: string): void

  Parameters

  • ieeeAddr: string

  Returns void

interviewState

• get interviewState(): InterviewState

  Returns InterviewState

isDeleted

• get isDeleted(): boolean

  Returns boolean

lastSeen

• get lastSeen(): number | undefined

  Returns number | undefined

linkquality

• get linkquality(): number | undefined

  Returns number | undefined

• set linkquality(linkquality: number): void

  Parameters

  • linkquality: number

  Returns void

manufacturerID

• get manufacturerID(): number | undefined

  Returns number | undefined

manufacturerName

• get manufacturerName(): string | undefined

  Returns string | undefined

• set manufacturerName(name: string | undefined): void

  Parameters

  • name: string | undefined

  Returns void

modelID

• get modelID(): string | undefined

  Returns string | undefined

• set modelID(id: string): void

  Parameters

  • id: string

  Returns void

networkAddress

• get networkAddress(): number

  Returns number

• set networkAddress(networkAddress: number): void

  Parameters

  • networkAddress: number

  Returns void

otaInProgress

• get otaInProgress(): boolean

  Returns boolean

pendingRequestTimeout

• get pendingRequestTimeout(): number

  Returns number

• set pendingRequestTimeout(pendingRequestTimeout: number): void

  Parameters

  • pendingRequestTimeout: number

  Returns void

powerSource

• get powerSource(): string | undefined

  Returns string | undefined

• set powerSource(source: string | number): void

  Parameters

  • source: string | number

  Returns void

scheduledOta

• get scheduledOta(): OtaSource | undefined

  Returns OtaSource | undefined

skipDefaultResponse

• get skipDefaultResponse(): boolean

  Returns boolean

• set skipDefaultResponse(skipDefaultResponse: boolean): void

  Parameters

  • skipDefaultResponse: boolean

  Returns void

softwareBuildID

• get softwareBuildID(): string | undefined

  Returns string | undefined

• set softwareBuildID(id: string): void

  Parameters

  • id: string

  Returns void

stackVersion

• get stackVersion(): number | undefined

  Returns number | undefined

• set stackVersion(version: number): void

  Parameters

  • version: number

  Returns void

type

• get type(): DeviceType

  Returns DeviceType

• set type(type: DeviceType): void

  Parameters

  • type: DeviceType

  Returns void

zclVersion

• get zclVersion(): number | undefined

  Returns number | undefined

• set zclVersion(version: number): void

  Parameters

  • version: number

  Returns void

addCustomCluster

• addCustomCluster(name: string, cluster: Cluster): void

  Parameters

  • name: string
  • cluster: Cluster

  Returns void

bindingTable

• bindingTable(): Promise<BindingTableEntry[]>

  Returns Promise<BindingTableEntry[]>

changeIeeeAddress

• changeIeeeAddress(ieeeAddr: string): void

  Parameters

  • ieeeAddr: string

  Returns void

checkOta

• checkOta(
      source: OtaSource,
      current:
          | {
              fieldControl: number;
              fileVersion: number;
              hardwareVersion?: number;
              imageType: number;
              manufacturerCode: number;
          }
          | undefined,
      extraMetas: OtaExtraMetas,
      endpoint?: Endpoint | undefined,
  ): Promise<OtaUpdateAvailableResult>

  If current is undefined, will automatically notify and reply to query with NO_IMAGE_AVAILABLE (stops device from doing further requests).

  Parameters

  • source: OtaSource
  • current:
        | {
            fieldControl: number;
            fileVersion: number;
            hardwareVersion?: number;
            imageType: number;
            manufacturerCode: number;
        }
        | undefined
    • {
          fieldControl: number;
          fileVersion: number;
          hardwareVersion?: number;
          imageType: number;
          manufacturerCode: number;
      }

      • fieldControl: number

        type=BITMAP8

      • fileVersion: number

        type=UINT32

      • OptionalhardwareVersion?: number

        type=UINT16 | conditions=[{bitMaskSet param=fieldControl mask=1}]

      • imageType: number

        type=UINT16 | max=65471

      • manufacturerCode: number

        type=UINT16

    • undefined
  • extraMetas: OtaExtraMetas
  • endpoint: Endpoint | undefined = ...

  Returns Promise<OtaUpdateAvailableResult>

clearAllBindings

• clearAllBindings(eui64List: `0x${string}`[]): Promise<void>

  Clear all the bindings of a device. Support of this command is optional (only mandatory if device has a binding table).

  Parameters

  • eui64List: `0x${string}`[]

    list of bind entries to match and clear. Send ["0xffffffffffffffff"] to clear all.

  Returns Promise<void>

createEndpoint

• createEndpoint(id: number): Endpoint

  Parameters

  • id: number

  Returns Endpoint

findMatchingOtaImage

• findMatchingOtaImage(
      source: OtaSource,
      current: {
          fieldControl: number;
          fileVersion: number;
          hardwareVersion?: number;
          imageType: number;
          manufacturerCode: number;
      },
      extraMetas: OtaExtraMetas,
  ): Promise<ZigbeeOtaImageMeta | undefined>

  Parameters

  • source: OtaSource
  • current: {
        fieldControl: number;
        fileVersion: number;
        hardwareVersion?: number;
        imageType: number;
        manufacturerCode: number;
    }

    • fieldControl: number

      type=BITMAP8

    • fileVersion: number

      type=UINT32

    • OptionalhardwareVersion?: number

      type=UINT16 | conditions=[{bitMaskSet param=fieldControl mask=1}]

    • imageType: number

      type=UINT16 | max=65471

    • manufacturerCode: number

      type=UINT16

  • extraMetas: OtaExtraMetas

  Returns Promise<ZigbeeOtaImageMeta | undefined>

getEndpoint

• getEndpoint(id: number): Endpoint | undefined

  Parameters

  • id: number

  Returns Endpoint | undefined

getEndpointByDeviceType

• getEndpointByDeviceType(deviceType: string): Endpoint | undefined

  Parameters

  • deviceType: string

  Returns Endpoint | undefined

implicitCheckin

• implicitCheckin(): void

  Returns void

interview

• interview(ignoreCache?: boolean): Promise<void>

  Parameters

  • ignoreCache: boolean = false

  Returns Promise<void>

lqi

• lqi(): Promise<LQITableEntry[]>

  Returns Promise<LQITableEntry[]>

onZclData

• onZclData(
      dataPayload: ZclPayload,
      frame: ZclFrame,
      endpoint: Endpoint,
      defaultResponse: Status | undefined,
  ): Promise<void>

  Parameters

  • dataPayload: ZclPayload
  • frame: ZclFrame
  • endpoint: Endpoint
  • defaultResponse: Status | undefined

  Returns Promise<void>

ping

• ping(disableRecovery?: boolean): Promise<void>

  Parameters

  • disableRecovery: boolean = true

  Returns Promise<void>

removeFromDatabase

• removeFromDatabase(): void

  Returns void

removeFromNetwork

• removeFromNetwork(): Promise<void>

  Returns Promise<void>

requestNetworkAddress

• requestNetworkAddress(): Promise<void>

  Request device to advertise its network address. Note: This does not actually update the device property (if needed), as this is already done with zdoResponse event in Controller.

  Returns Promise<void>

resetTransient

• resetTransient(cache: boolean): void

  Reset transient data about the device.

  Parameters

  • cache: boolean

    If true, reset some previously cached data. Should be set to true when device potentially changed its internal data to prevent mismatching state/config.

  Returns void

routingTable

• routingTable(): Promise<RoutingTableEntry[]>

  Returns Promise<RoutingTableEntry[]>

save

• save(writeDatabase?: boolean): void

  Parameters

  • writeDatabase: boolean = true

  Returns void

scheduleOta

• scheduleOta(source: OtaSource): void

  Parameters

  • source: OtaSource

  Returns void

undelete

• undelete(): void

  Returns void

unscheduleOta

• unscheduleOta(): void

  Returns void

updateActiveEndpoints

• updateActiveEndpoints(): Promise<void>

  Returns Promise<void>

updateGenBasic

• updateGenBasic(data: TPartialClusterAttributes<"genBasic">): void

  Parameters

  • data: TPartialClusterAttributes<"genBasic">

  Returns void

updateLastSeen

• updateLastSeen(): void

  Returns void

updateNodeDescriptor

• updateNodeDescriptor(): Promise<void>

  Returns Promise<void>

updateOta

• updateOta(
      source: Readonly<OtaSource> | undefined,
      requestPayload:
          | {
              fieldControl: number;
              fileVersion: number;
              hardwareVersion?: number;
              imageType: number;
              manufacturerCode: number;
          }
          | undefined,
      requestTsn: number | undefined,
      extraMetas: Readonly<OtaExtraMetas>,
      onProgress: (progress: number, remaining: number) => void,
      dataSettings: OtaDataSettings,
      endpoint?: Endpoint | undefined,
  ): Promise<
      [
          from: {
              fieldControl: number;
              fileVersion: number;
              hardwareVersion?: number;
              imageType: number;
              manufacturerCode: number;
          },
          to: {
              fieldControl: number;
              fileVersion: number;
              hardwareVersion?: number;
              imageType: number;
              manufacturerCode: number;
          },
      ],
  >

  Parameters

  • source: Readonly<OtaSource> | undefined
  • requestPayload:
        | {
            fieldControl: number;
            fileVersion: number;
            hardwareVersion?: number;
            imageType: number;
            manufacturerCode: number;
        }
        | undefined
    • {
          fieldControl: number;
          fileVersion: number;
          hardwareVersion?: number;
          imageType: number;
          manufacturerCode: number;
      }

      • fieldControl: number

        type=BITMAP8

      • fileVersion: number

        type=UINT32

      • OptionalhardwareVersion?: number

        type=UINT16 | conditions=[{bitMaskSet param=fieldControl mask=1}]

      • imageType: number

        type=UINT16 | max=65471

      • manufacturerCode: number

        type=UINT16

    • undefined
  • requestTsn: number | undefined
  • extraMetas: Readonly<OtaExtraMetas>
  • onProgress: (progress: number, remaining: number) => void
  • dataSettings: OtaDataSettings
  • endpoint: Endpoint | undefined = ...

  Returns Promise<
      [
          from: {
              fieldControl: number;
              fileVersion: number;
              hardwareVersion?: number;
              imageType: number;
              manufacturerCode: number;
          },
          to: {
              fieldControl: number;
              fileVersion: number;
              hardwareVersion?: number;
              imageType: number;
              manufacturerCode: number;
          },
      ],
  >

Staticall

• all(): Device[]

  Returns Device[]

  Deprecated

  use allIterator()

StaticallIterator

• allIterator(predicate?: (value: Device) => boolean): Generator<Device>

  Parameters

  • Optionalpredicate: (value: Device) => boolean

  Returns Generator<Device>

StaticbyIeeeAddr

• byIeeeAddr(ieeeAddr: string, includeDeleted?: boolean): Device | undefined

  Parameters

  • ieeeAddr: string
  • includeDeleted: boolean = false

  Returns Device | undefined

StaticbyNetworkAddress

• byNetworkAddress(
      networkAddress: number,
      includeDeleted?: boolean,
  ): Device | undefined

  Parameters

  • networkAddress: number
  • includeDeleted: boolean = false

  Returns Device | undefined

StaticbyType

• byType(type: DeviceType): Device[]

  Parameters

  • type: DeviceType

  Returns Device[]

Staticcreate

• create(
      type: DeviceType,
      ieeeAddr: string,
      networkAddress: number,
      manufacturerID: number | undefined,
      manufacturerName: string | undefined,
      powerSource: string | undefined,
      modelID: string | undefined,
      interviewState: InterviewState,
      gpSecurityKey: number[] | undefined,
  ): Device

  Parameters

  • type: DeviceType
  • ieeeAddr: string
  • networkAddress: number
  • manufacturerID: number | undefined
  • manufacturerName: string | undefined
  • powerSource: string | undefined
  • modelID: string | undefined
  • interviewState: InterviewState
  • gpSecurityKey: number[] | undefined

  Returns Device

Staticfind

• find(
      ieeeOrNwkAddress: string | number,
      includeDeleted?: boolean,
  ): Device | undefined

  Parameters

  • ieeeOrNwkAddress: string | number
  • includeDeleted: boolean = false

  Returns Device | undefined

StaticisDeletedByIeeeAddr

• isDeletedByIeeeAddr(ieeeAddr: string): boolean

  Check if a device is explicitly deleted

  Parameters

  • ieeeAddr: string

  Returns boolean

StaticisDeletedByNetworkAddress

• isDeletedByNetworkAddress(networkAddress: number): boolean

  Check if a device is explicitly deleted

  Parameters

  • networkAddress: number

  Returns boolean

StaticresetCache

• resetCache(): void

  Reset runtime lookups.

  Returns void