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

  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

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

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: ClusterDefinition): void

  Parameters

  • name: string
  • cluster: ClusterDefinition

  Returns void

bindingTable

• bindingTable(): Promise<BindingTableEntry[]>

  Returns Promise<BindingTableEntry[]>

changeIeeeAddress

• changeIeeeAddress(ieeeAddr: string): void

  Parameters

  • ieeeAddr: string

  Returns void

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

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,
  ): Promise<void>

  Parameters

  • dataPayload: ZclPayload
  • frame: ZclFrame
  • endpoint: Endpoint

  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>

routingTable

• routingTable(): Promise<RoutingTableEntry[]>

  Returns Promise<RoutingTableEntry[]>

save

• save(writeDatabase?: boolean): void

  Parameters

  • writeDatabase: boolean = true

  Returns void

undelete

• undelete(): 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>

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