Class BuffaloZdo

Hierarchy (View Summary)

Buffalo
- BuffaloZdo

Index

Constructors

Methods

getBuffer getByte getPosition getWritten isMore isMoreBy readActiveEndpointsResponse readBindingTableResponse readBindResponse readBuffer readChallengeResponse readClearAllBindingsResponse readDecommissionResponse readDoubleLE readEndDeviceAnnounce readFloatLE readGetAuthenticationLevelResponse readGetConfigurationResponse readGlobalTLV readIeeeAddr readIEEEAddressResponse readInt16 readInt24 readInt32 readInt40 readInt48 readInt56 readInt64 readInt8 readLeaveResponse readListUInt16 readListUInt24 readListUInt32 readListUInt8 readLQITableResponse readMatchDescriptorsResponse readNetworkAddressResponse readNodeDescriptorResponse readNwkBeaconSurveyResponse readNwkEnhancedUpdateResponse readNwkIEEEJoiningListResponse readNwkUnsolicitedEnhancedUpdateResponse readNwkUpdateResponse readParentAnnounceResponse readPermitJoiningResponse readPowerDescriptorResponse readRetrieveAuthenticationTokenResponse readRoutingTableResponse readSetConfigurationResponse readSimpleDescriptorResponse readStartKeyNegotiationResponse readStartKeyUpdateResponse readSystemServerDiscoveryResponse readTLVs readUInt16 readUInt24 readUInt32 readUInt40 readUInt48 readUInt56 readUInt64 readUInt8 readUnbindResponse readUtf8String setByte setPosition writeBuffer writeDoubleLE writeFloatLE writeGlobalTLV writeGlobalTLVs writeIeeeAddr writeInt16 writeInt24 writeInt32 writeInt40 writeInt48 writeInt56 writeInt64 writeInt8 writeListUInt16 writeListUInt24 writeListUInt32 writeListUInt8 writeUInt16 writeUInt24 writeUInt32 writeUInt40 writeUInt48 writeUInt56 writeUInt64 writeUInt8 writeUtf8String buildRequest checkStatus readResponse

Constructors

constructor

new BuffaloZdo(buffer: Buffer, position?: number): BuffaloZdo
Parameters
- buffer: Buffer
- position: number = 0
Returns BuffaloZdo
Inherited from Buffalo.constructor
- Defined in src/buffalo/buffalo.ts:9

Methods

getBuffer

getBuffer(): Buffer
Returns Buffer
Inherited from Buffalo.getBuffer
- Defined in src/buffalo/buffalo.ts:18

getByte

getByte(position: number): number
Get the byte at given position without affecting the internal position tracker. TODO: move to base Buffalo class
Parameters
- position: number
Returns number
- Defined in src/zspec/zdo/buffaloZdo.ts:102

getPosition

getPosition(): number
Returns number
Inherited from Buffalo.getPosition
- Defined in src/buffalo/buffalo.ts:14

getWritten

getWritten(): Buffer
Returns Buffer
Inherited from Buffalo.getWritten
- Defined in src/buffalo/buffalo.ts:22

isMore

isMore(): boolean
Returns boolean
Inherited from Buffalo.isMore
- Defined in src/buffalo/buffalo.ts:26

isMoreBy

isMoreBy(count: number): boolean
Check if internal buffer has enough bytes to satisfy: (current position + given count). TODO: move to base Buffalo class
Parameters
- count: number
Returns boolean
True if has given more bytes
- Defined in src/zspec/zdo/buffaloZdo.ts:112

readActiveEndpointsResponse

readActiveEndpointsResponse(): [Status, undefined | ActiveEndpointsResponse]
Returns [Status, undefined | ActiveEndpointsResponse]
See
ClusterId.ACTIVE_ENDPOINTS_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1759

readBindingTableResponse

readBindingTableResponse(): [Status, undefined | BindingTableResponse]
Returns [Status, undefined | BindingTableResponse]
See
ClusterId.BINDING_TABLE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1981

readBindResponse

readBindResponse(): [Status, undefined | void]
Returns [Status, undefined | void]
No response payload, throws if not success

See
ClusterId.BIND_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1859

readBuffer

readBuffer(length: number): Buffer
Parameters
- length: number
Returns Buffer
Inherited from Buffalo.readBuffer
- Defined in src/buffalo/buffalo.ts:258

readChallengeResponse

readChallengeResponse(): [Status, undefined | TLVs]
Returns [Status, undefined | TLVs]
See
ClusterId.CHALLENGE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2327

readClearAllBindingsResponse

readClearAllBindingsResponse(): [Status, undefined | void]
Returns [Status, undefined | void]
No response payload, throws if not success

See
ClusterId.CLEAR_ALL_BINDINGS_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1881

readDecommissionResponse

readDecommissionResponse(): [Status, undefined | void]
Returns [Status, undefined | void]
No response payload, throws if not success

See
ClusterId.DECOMMISSION_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2317

readDoubleLE

readDoubleLE(): number
Returns number
Inherited from Buffalo.readDoubleLE
- Defined in src/buffalo/buffalo.ts:231

readEndDeviceAnnounce

readEndDeviceAnnounce(): [Status, undefined | EndDeviceAnnounce]
Returns [Status, undefined | EndDeviceAnnounce]
See
ClusterId.END_DEVICE_ANNOUNCE
- Defined in src/zspec/zdo/buffaloZdo.ts:1803

readFloatLE

readFloatLE(): number
Returns number
Inherited from Buffalo.readFloatLE
- Defined in src/buffalo/buffalo.ts:220

readGetAuthenticationLevelResponse

readGetAuthenticationLevelResponse(): [Status, undefined | TLVs]
Returns [Status, undefined | TLVs]
See
ClusterId.GET_AUTHENTICATION_LEVEL_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2239

readGetConfigurationResponse

readGetConfigurationResponse(): [Status, undefined | TLVs]
Returns [Status, undefined | TLVs]
See
ClusterId.GET_CONFIGURATION_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2285

readGlobalTLV

readGlobalTLV(
    tagId: number,
    length: number,
):
    | undefined
    | ManufacturerSpecificGlobalTLV
    | SupportedKeyNegotiationMethodsGlobalTLV
    | PanIdConflictReportGlobalTLV
    | NextPanIdChangeGlobalTLV
    | NextChannelChangeGlobalTLV
    | SymmetricPassphraseGlobalTLV
    | RouterInformationGlobalTLV
    | FragmentationParametersGlobalTLV
    | JoinerEncapsulationGlobalTLV
    | BeaconAppendixEncapsulationGlobalTLV
    | ConfigurationParametersGlobalTLV
    | DeviceCapabilityExtensionGlobalTLV
    | LocalTLVType
Parameters
- tagId: number
- length: number
Returns
    | undefined
    | ManufacturerSpecificGlobalTLV
    | SupportedKeyNegotiationMethodsGlobalTLV
    | PanIdConflictReportGlobalTLV
    | NextPanIdChangeGlobalTLV
    | NextChannelChangeGlobalTLV
    | SymmetricPassphraseGlobalTLV
    | RouterInformationGlobalTLV
    | FragmentationParametersGlobalTLV
    | JoinerEncapsulationGlobalTLV
    | BeaconAppendixEncapsulationGlobalTLV
    | ConfigurationParametersGlobalTLV
    | DeviceCapabilityExtensionGlobalTLV
    | LocalTLVType
- Defined in src/zspec/zdo/buffaloZdo.ts:419

readIeeeAddr

readIeeeAddr(): `0x${string}`
Returns `0x${string}`
Inherited from Buffalo.readIeeeAddr
- Defined in src/buffalo/buffalo.ts:242

readIEEEAddressResponse

readIEEEAddressResponse(): [Status, undefined | IEEEAddressResponse]
Returns [Status, undefined | IEEEAddressResponse]
See
ClusterId.IEEE_ADDRESS_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1622

readInt16

readInt16(): number
Returns number
Inherited from Buffalo.readInt16
- Defined in src/buffalo/buffalo.ts:136

readInt24

readInt24(): number
Returns number
Inherited from Buffalo.readInt24
- Defined in src/buffalo/buffalo.ts:147

readInt32

readInt32(): number
Returns number
Inherited from Buffalo.readInt32
- Defined in src/buffalo/buffalo.ts:158

readInt40

readInt40(): number
Returns number
Inherited from Buffalo.readInt40
- Defined in src/buffalo/buffalo.ts:169

readInt48

readInt48(): number
Returns number
Inherited from Buffalo.readInt48
- Defined in src/buffalo/buffalo.ts:180

readInt56

readInt56(): bigint
Returns bigint
Inherited from Buffalo.readInt56
- Defined in src/buffalo/buffalo.ts:193

readInt64

readInt64(): bigint
Returns bigint
Inherited from Buffalo.readInt64
- Defined in src/buffalo/buffalo.ts:209

readInt8

readInt8(): number
Returns number
Inherited from Buffalo.readInt8
- Defined in src/buffalo/buffalo.ts:125

readLeaveResponse

readLeaveResponse(): [Status, undefined | void]
Returns [Status, undefined | void]
No response payload, throws if not success

See
ClusterId.LEAVE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2030

readListUInt16

readListUInt16(length: number): number[]
Parameters
- length: number
Returns number[]
Inherited from Buffalo.readListUInt16
- Defined in src/buffalo/buffalo.ts:284

readListUInt24

readListUInt24(length: number): number[]
Parameters
- length: number
Returns number[]
Inherited from Buffalo.readListUInt24
- Defined in src/buffalo/buffalo.ts:299

readListUInt32

readListUInt32(length: number): number[]
Parameters
- length: number
Returns number[]
Inherited from Buffalo.readListUInt32
- Defined in src/buffalo/buffalo.ts:314

readListUInt8

readListUInt8(length: number): number[]
Parameters
- length: number
Returns number[]
Inherited from Buffalo.readListUInt8
- Defined in src/buffalo/buffalo.ts:270

readLQITableResponse

readLQITableResponse(): [Status, undefined | LQITableResponse]
Returns [Status, undefined | LQITableResponse]
See
ClusterId.LQI_TABLE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1891

readMatchDescriptorsResponse

readMatchDescriptorsResponse(): [Status, undefined | MatchDescriptorsResponse]
Returns [Status, undefined | MatchDescriptorsResponse]
See
ClusterId.MATCH_DESCRIPTORS_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1781

readNetworkAddressResponse

readNetworkAddressResponse(): [Status, undefined | NetworkAddressResponse]
Returns [Status, undefined | NetworkAddressResponse]
See
ClusterId.NETWORK_ADDRESS_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1589

readNodeDescriptorResponse

readNodeDescriptorResponse(): [Status, undefined | NodeDescriptorResponse]
Returns [Status, undefined | NodeDescriptorResponse]
See
ClusterId.NODE_DESCRIPTOR_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1654

readNwkBeaconSurveyResponse

readNwkBeaconSurveyResponse(): [Status, undefined | TLVs]
Returns [Status, undefined | TLVs]
See
ClusterId.NWK_BEACON_SURVEY_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2172

readNwkEnhancedUpdateResponse

readNwkEnhancedUpdateResponse(): [Status, undefined | NwkEnhancedUpdateResponse]
Returns [Status, undefined | NwkEnhancedUpdateResponse]
See
ClusterId.NWK_ENHANCED_UPDATE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2078

readNwkIEEEJoiningListResponse

readNwkIEEEJoiningListResponse(): [
    Status,
    undefined
    | NwkIEEEJoiningListResponse,
]
Returns [Status, undefined | NwkIEEEJoiningListResponse]
See
ClusterId.NWK_IEEE_JOINING_LIST_REPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2105

readNwkUnsolicitedEnhancedUpdateResponse

readNwkUnsolicitedEnhancedUpdateResponse(): [
    Status,
    undefined
    | NwkUnsolicitedEnhancedUpdateResponse,
]
Returns [Status, undefined | NwkUnsolicitedEnhancedUpdateResponse]
See
ClusterId.NWK_UNSOLICITED_ENHANCED_UPDATE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2145

readNwkUpdateResponse

readNwkUpdateResponse(): [Status, undefined | NwkUpdateResponse]
Returns [Status, undefined | NwkUpdateResponse]
See
ClusterId.NWK_UPDATE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2051

readParentAnnounceResponse

readParentAnnounceResponse(): [Status, undefined | ParentAnnounceResponse]
Returns [Status, undefined | ParentAnnounceResponse]
See
ClusterId.PARENT_ANNOUNCE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1834

readPermitJoiningResponse

readPermitJoiningResponse(): [Status, undefined | void]
Returns [Status, undefined | void]
No response payload, throws if not success

See
ClusterId.PERMIT_JOINING_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2041

readPowerDescriptorResponse

readPowerDescriptorResponse(): [Status, undefined | PowerDescriptorResponse]
Returns [Status, undefined | PowerDescriptorResponse]
See
ClusterId.POWER_DESCRIPTOR_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1698

readRetrieveAuthenticationTokenResponse

readRetrieveAuthenticationTokenResponse(): [Status, undefined | TLVs]
Returns [Status, undefined | TLVs]
See
ClusterId.RETRIEVE_AUTHENTICATION_TOKEN_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2220

readRoutingTableResponse

readRoutingTableResponse(): [Status, undefined | RoutingTableResponse]
Returns [Status, undefined | RoutingTableResponse]
See
ClusterId.ROUTING_TABLE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1940

readSetConfigurationResponse

readSetConfigurationResponse(): [Status, undefined | TLVs]
Returns [Status, undefined | TLVs]
See
ClusterId.SET_CONFIGURATION_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2262

readSimpleDescriptorResponse

readSimpleDescriptorResponse(): [Status, undefined | SimpleDescriptorResponse]
Returns [Status, undefined | SimpleDescriptorResponse]
See
ClusterId.SIMPLE_DESCRIPTOR_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1723

readStartKeyNegotiationResponse

readStartKeyNegotiationResponse(): [Status, undefined | TLVs]
Returns [Status, undefined | TLVs]
See
ClusterId.START_KEY_NEGOTIATION_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2197

readStartKeyUpdateResponse

readStartKeyUpdateResponse(): [Status, undefined | void]
Returns [Status, undefined | void]
No response payload, throws if not success

See
ClusterId.START_KEY_UPDATE_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:2306

readSystemServerDiscoveryResponse

readSystemServerDiscoveryResponse(): [
    Status,
    undefined
    | SystemServerDiscoveryResponse,
]
Returns [Status, undefined | SystemServerDiscoveryResponse]
See
ClusterId.SYSTEM_SERVER_DISCOVERY_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1815

readTLVs

readTLVs(
localTLVReaders?: Map<number, LocalTLVReader>,
encapsulated?: boolean,
): TLV[]
ANNEX I ZIGBEE TLV DEFINITIONS AND FORMAT

Unknown tags => TLV ignored Duplicate tags => reject message except for MANUFACTURER_SPECIFIC_GLOBAL_TLV Malformed TLVs => reject message
Parameters
- OptionallocalTLVReaders: Map<number, LocalTLVReader>
  Mapping of tagID to local TLV reader function
- encapsulated: boolean = false
  Default false. If true, this is reading inside an encapsuled TLV (excludes further encapsulation)
Returns TLV[]
- Defined in src/zspec/zdo/buffaloZdo.ts:688

readUInt16

readUInt16(): number
Returns number
Inherited from Buffalo.readUInt16
- Defined in src/buffalo/buffalo.ts:46

readUInt24

readUInt24(): number
Returns number
Inherited from Buffalo.readUInt24
- Defined in src/buffalo/buffalo.ts:57

readUInt32

readUInt32(): number
Returns number
Inherited from Buffalo.readUInt32
- Defined in src/buffalo/buffalo.ts:68

readUInt40

readUInt40(): number
Returns number
Inherited from Buffalo.readUInt40
- Defined in src/buffalo/buffalo.ts:79

readUInt48

readUInt48(): number
Returns number
Inherited from Buffalo.readUInt48
- Defined in src/buffalo/buffalo.ts:90

readUInt56

readUInt56(): bigint
Returns bigint
Inherited from Buffalo.readUInt56
- Defined in src/buffalo/buffalo.ts:102

readUInt64

readUInt64(): bigint
Returns bigint
Inherited from Buffalo.readUInt64
- Defined in src/buffalo/buffalo.ts:114

readUInt8

readUInt8(): number
Returns number
Inherited from Buffalo.readUInt8
- Defined in src/buffalo/buffalo.ts:35

readUnbindResponse

readUnbindResponse(): [Status, undefined | void]
Returns [Status, undefined | void]
No response payload, throws if not success

See
ClusterId.UNBIND_RESPONSE
- Defined in src/zspec/zdo/buffaloZdo.ts:1870

readUtf8String

readUtf8String(length: number): string
Parameters
- length: number
Returns string
Inherited from Buffalo.readUtf8String
- Defined in src/buffalo/buffalo.ts:327

setByte

setByte(position: number, value: number): void
Set the byte at given position without affecting the internal position tracker. TODO: move to base Buffalo class
Parameters
- position: number
- value: number
Returns void
- Defined in src/zspec/zdo/buffaloZdo.ts:92

setPosition

setPosition(position: number): void
Set the position of the internal position tracker. TODO: move to base Buffalo class
Parameters
- position: number
Returns void
- Defined in src/zspec/zdo/buffaloZdo.ts:82

writeBuffer

writeBuffer(values: number[] | Buffer, length: number): void
Parameters
- values: number[] | Buffer
- length: number
Returns void
Inherited from Buffalo.writeBuffer
- Defined in src/buffalo/buffalo.ts:246

writeDoubleLE

writeDoubleLE(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeDoubleLE
- Defined in src/buffalo/buffalo.ts:226

writeFloatLE

writeFloatLE(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeFloatLE
- Defined in src/buffalo/buffalo.ts:215

writeGlobalTLV

writeGlobalTLV(tlv: TLV): void
Parameters
- tlv: TLV
Returns void
- Defined in src/zspec/zdo/buffaloZdo.ts:360

writeGlobalTLVs

writeGlobalTLVs(tlvs: TLV[]): void
Parameters
- tlvs: TLV[]
Returns void
- Defined in src/zspec/zdo/buffaloZdo.ts:464

writeIeeeAddr

writeIeeeAddr(value: string): void
Parameters
- value: string
Returns void
Inherited from Buffalo.writeIeeeAddr
- Defined in src/buffalo/buffalo.ts:237

writeInt16

writeInt16(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeInt16
- Defined in src/buffalo/buffalo.ts:131

writeInt24

writeInt24(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeInt24
- Defined in src/buffalo/buffalo.ts:142

writeInt32

writeInt32(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeInt32
- Defined in src/buffalo/buffalo.ts:153

writeInt40

writeInt40(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeInt40
- Defined in src/buffalo/buffalo.ts:164

writeInt48

writeInt48(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeInt48
- Defined in src/buffalo/buffalo.ts:175

writeInt56

writeInt56(value: bigint): void
Parameters
- value: bigint
Returns void
Inherited from Buffalo.writeInt56
- Defined in src/buffalo/buffalo.ts:186

writeInt64

writeInt64(value: bigint): void
Parameters
- value: bigint
Returns void
Inherited from Buffalo.writeInt64
- Defined in src/buffalo/buffalo.ts:204

writeInt8

writeInt8(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeInt8
- Defined in src/buffalo/buffalo.ts:120

writeListUInt16

writeListUInt16(values: number[]): void
Parameters
- values: number[]
Returns void
Inherited from Buffalo.writeListUInt16
- Defined in src/buffalo/buffalo.ts:278

writeListUInt24

writeListUInt24(values: number[]): void
Parameters
- values: number[]
Returns void
Inherited from Buffalo.writeListUInt24
- Defined in src/buffalo/buffalo.ts:293

writeListUInt32

writeListUInt32(values: number[]): void
Parameters
- values: number[]
Returns void
Inherited from Buffalo.writeListUInt32
- Defined in src/buffalo/buffalo.ts:308

writeListUInt8

writeListUInt8(values: number[]): void
Parameters
- values: number[]
Returns void
Inherited from Buffalo.writeListUInt8
- Defined in src/buffalo/buffalo.ts:264

writeUInt16

writeUInt16(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeUInt16
- Defined in src/buffalo/buffalo.ts:41

writeUInt24

writeUInt24(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeUInt24
- Defined in src/buffalo/buffalo.ts:52

writeUInt32

writeUInt32(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeUInt32
- Defined in src/buffalo/buffalo.ts:63

writeUInt40

writeUInt40(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeUInt40
- Defined in src/buffalo/buffalo.ts:74

writeUInt48

writeUInt48(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeUInt48
- Defined in src/buffalo/buffalo.ts:85

writeUInt56

writeUInt56(value: bigint): void
Parameters
- value: bigint
Returns void
Inherited from Buffalo.writeUInt56
- Defined in src/buffalo/buffalo.ts:96

writeUInt64

writeUInt64(value: bigint): void
Parameters
- value: bigint
Returns void
Inherited from Buffalo.writeUInt64
- Defined in src/buffalo/buffalo.ts:109

writeUInt8

writeUInt8(value: number): void
Parameters
- value: number
Returns void
Inherited from Buffalo.writeUInt8
- Defined in src/buffalo/buffalo.ts:30

writeUtf8String

writeUtf8String(value: string): void
Parameters
- value: string
Returns void
Inherited from Buffalo.writeUtf8String
- Defined in src/buffalo/buffalo.ts:322

`Static`buildRequest

buildRequest<K extends keyof RequestMap>(
    hasZdoMessageOverhead: boolean,
    clusterId: K,
    ...args: RequestMap[K],
): Buffer
Type Parameters
- K extends keyof RequestMap
Parameters
- hasZdoMessageOverhead: boolean
- clusterId: K
- ...args: RequestMap[K]
Returns Buffer
- Defined in src/zspec/zdo/buffaloZdo.ts:755

`Static`checkStatus

checkStatus<K extends keyof ValidResponseMap>(
result: GenericZdoResponse,
): result is ValidResponseMap[K]
Type Parameters
- K extends keyof ValidResponseMap
Parameters
- result: GenericZdoResponse
Returns result is ValidResponseMap[K]
- Defined in src/zspec/zdo/buffaloZdo.ts:1475

`Static`readResponse

readResponse<K extends number>(
    hasZdoMessageOverhead: boolean,
    clusterId: K extends number ? number : K,
    buffer: Buffer,
): ResponseMap[K]
Type Parameters
- K extends number
Parameters
- hasZdoMessageOverhead: boolean
- clusterId: K extends number ? number : K
- buffer: Buffer
Returns ResponseMap[K]
- Defined in src/zspec/zdo/buffaloZdo.ts:1479

Class BuffaloZdo

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BuffaloZdo

Methods

getBuffer

Returns Buffer

getByte

Parameters

Returns number

getPosition

Returns number

getWritten

Returns Buffer

isMore

Returns boolean

isMoreBy

Parameters

Returns boolean

readActiveEndpointsResponse

Returns [Status, undefined | ActiveEndpointsResponse]

See

readBindingTableResponse

Returns [Status, undefined | BindingTableResponse]

See

readBindResponse

Returns [Status, undefined | void]

See

readBuffer

Parameters

Returns Buffer

readChallengeResponse

Returns [Status, undefined | TLVs]

See

readClearAllBindingsResponse

Returns [Status, undefined | void]

See

readDecommissionResponse

Returns [Status, undefined | void]

See

readDoubleLE

Returns number

readEndDeviceAnnounce

Returns [Status, undefined | EndDeviceAnnounce]

See

readFloatLE

Returns number

readGetAuthenticationLevelResponse

Returns [Status, undefined | TLVs]

See

readGetConfigurationResponse

Returns [Status, undefined | TLVs]

See

readGlobalTLV

Parameters

readIeeeAddr

Returns `0x${string}`

readIEEEAddressResponse

Returns [Status, undefined | IEEEAddressResponse]

See

readInt16

Returns number

readInt24

Returns number

readInt32

Returns number

readInt40

Returns number

readInt48

Returns number

readInt56

Returns bigint

readInt64

Returns bigint

readInt8