From 07287402e1600ac7596eb99787327107f8f644ab Mon Sep 17 00:00:00 2001 From: Z-Wave JS Bot <76957017+zwave-js-bot@users.noreply.github.com> Date: Mon, 13 May 2024 11:54:17 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20update=20typed=20documentation=20and=20?= =?UTF-8?q?API=20report=20=F0=9F=A4=96=20(#6720)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Al Calzone --- packages/cc/api.md | 41 +-- packages/config/api.md | 32 ++- packages/core/api.md | 126 ++++++++- packages/nvmedit/api.md | 2 +- packages/serial/api.md | 574 ++++++++++++++++++++++++++++++++------- packages/zwave-js/api.md | 429 ++++++++++++++++++++++++++--- 6 files changed, 1023 insertions(+), 181 deletions(-) diff --git a/packages/cc/api.md b/packages/cc/api.md index 7df7f078144d..1dc26b21187f 100644 --- a/packages/cc/api.md +++ b/packages/cc/api.md @@ -7926,9 +7926,9 @@ export enum HumidityControlSetpointType { // (undocumented) "De-humidifier" = 2, // (undocumented) - "N/A" = 0, + "N/A" = 0,// CC v1 // (undocumented) - "Auto" = 3, + "Auto" = 3,// CC v1 // (undocumented) "Humidifier" = 1 } @@ -10195,21 +10195,21 @@ export function isTransportServiceEncapsulation(command: CommandClass): command // @public (undocumented) export enum KEXFailType { // (undocumented) - BootstrappingCanceled = 6, + BootstrappingCanceled = 6,// KEX_KEY // (undocumented) - Decrypt = 5, + Decrypt = 5,// KEX_SCHEME // (undocumented) - DifferentKey = 10, + DifferentKey = 10,// KEX_CURVES // (undocumented) KeyNotGranted = 8, // (undocumented) - NoKeyMatch = 1, + NoKeyMatch = 1,// CANCEL // (undocumented) - NoSupportedCurve = 3, + NoSupportedCurve = 3,// AUTH // (undocumented) - NoSupportedScheme = 2, + NoSupportedScheme = 2,// GET // (undocumented) - NoVerify = 9, + NoVerify = 9,// VERIFY // (undocumented) WrongSecurityLevel = 7 } @@ -15453,6 +15453,7 @@ export class Security2CCMessageEncapsulation extends Security2CC { extensions: Security2Extension[]; // (undocumented) getMulticastGroupId(): number | undefined; + getSenderEI(): Buffer | undefined; // (undocumented) hasMOSExtension(): boolean; // (undocumented) @@ -17676,25 +17677,25 @@ export enum ThermostatSetpointType { // (undocumented) "Auto Changeover" = 10, // (undocumented) - "Away Cooling" = 14, + "Away Cooling" = 14,// CC v1 // (undocumented) - "Away Heating" = 13, + "Away Heating" = 13,// CC v1 // (undocumented) - "Dry Air" = 8, + "Dry Air" = 8,// CC v1 // (undocumented) - "Energy Save Cooling" = 12, + "Energy Save Cooling" = 12,// CC v1 // (undocumented) - "Energy Save Heating" = 11, + "Energy Save Heating" = 11,// CC v1 // (undocumented) - "Full Power" = 15, + "Full Power" = 15,// CC v1 // (undocumented) - "Moist Air" = 9, + "Moist Air" = 9,// CC v2 // (undocumented) - "N/A" = 0, + "N/A" = 0,// CC v2 // (undocumented) - "Cooling" = 2, + "Cooling" = 2,// CC v2 // (undocumented) - "Furnace" = 7, + "Furnace" = 7,// CC v3 // (undocumented) "Heating" = 1 } @@ -20525,7 +20526,7 @@ export enum ZWavePlusCommand { // @public (undocumented) export enum ZWavePlusNodeType { // (undocumented) - IPGateway = 2, + IPGateway = 2,// ZWave+ Node // (undocumented) Node = 0 } diff --git a/packages/config/api.md b/packages/config/api.md index 19da0602a40e..53ee2e488c24 100644 --- a/packages/config/api.md +++ b/packages/config/api.md @@ -36,6 +36,18 @@ export interface BasicDeviceClass { // @public (undocumented) export type BasicDeviceClassMap = ReadonlyMap; +// Warning: (ae-forgotten-export) The symbol "basicReportMappings" needs to be exported by the entry point index.d.ts +// Warning: (ae-missing-release-tag) "BasicReportMapping" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export type BasicReportMapping = typeof basicReportMappings[number]; + +// Warning: (ae-forgotten-export) The symbol "basicSetMappings" needs to be exported by the entry point index.d.ts +// Warning: (ae-missing-release-tag) "BasicSetMapping" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export type BasicSetMapping = typeof basicSetMappings[number]; + // Warning: (ae-missing-release-tag) "CompatAddCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -142,16 +154,12 @@ export class ConditionalCompatConfig implements ConditionalItem { // (undocumented) readonly disableAutoRefresh?: boolean; // (undocumented) - readonly disableBasicMapping?: boolean; - // (undocumented) readonly disableCallbackFunctionTypeCheck?: number[]; // (undocumented) readonly disableStrictEntryControlDataValidation?: boolean; // (undocumented) readonly disableStrictMeasurementValidation?: boolean; // (undocumented) - readonly enableBasicSetMapping?: boolean; - // (undocumented) evaluateCondition(deviceId?: DeviceID): CompatConfig | undefined; // (undocumented) readonly forceNotificationIdleReset?: boolean; @@ -160,6 +168,10 @@ export class ConditionalCompatConfig implements ConditionalItem { // (undocumented) readonly manualValueRefreshDelayMs?: number; // (undocumented) + readonly mapBasicReport?: BasicReportMapping; + // (undocumented) + readonly mapBasicSet?: BasicSetMapping; + // (undocumented) readonly mapRootReportsToEndpoint?: number; // (undocumented) readonly overrideFloatEncoding?: { @@ -189,8 +201,6 @@ export class ConditionalCompatConfig implements ConditionalItem { // (undocumented) readonly skipConfigurationNameQuery?: boolean; // (undocumented) - readonly treatBasicSetAsEvent?: boolean; - // (undocumented) readonly treatDestinationEndpointAsSource?: boolean; // (undocumented) readonly treatMultilevelSwitchSetAsEvent?: boolean; @@ -663,8 +673,6 @@ export interface FulltextDeviceConfigIndexEntry { export class GenericDeviceClass { constructor(key: number, definition: JSONObject); // (undocumented) - readonly controlledCCs: readonly CommandClasses[]; - // (undocumented) readonly key: number; // (undocumented) readonly label: string; @@ -674,8 +682,6 @@ export class GenericDeviceClass { readonly requiresSecurity?: boolean; // (undocumented) readonly specific: ReadonlyMap; - // (undocumented) - readonly supportedCCs: readonly CommandClasses[]; } // Warning: (ae-missing-release-tag) "GenericDeviceClassMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -847,6 +853,8 @@ export class NotificationParameterWithDuration { export class NotificationParameterWithEnum { constructor(definition: JSONObject); // (undocumented) + readonly default?: number; + // (undocumented) readonly values: ReadonlyMap; } @@ -971,8 +979,6 @@ export type SensorTypeMap = ReadonlyMap; export class SpecificDeviceClass { constructor(key: number, definition: JSONObject, generic: GenericDeviceClass); // (undocumented) - readonly controlledCCs: readonly CommandClasses[]; - // (undocumented) readonly key: number; // (undocumented) readonly label: string; @@ -981,8 +987,6 @@ export class SpecificDeviceClass { // (undocumented) readonly requiresSecurity?: boolean; // (undocumented) - readonly supportedCCs: readonly CommandClasses[]; - // (undocumented) readonly zwavePlusDeviceType?: string; } diff --git a/packages/core/api.md b/packages/core/api.md index 31004dd608ef..d324a24d3abf 100644 --- a/packages/core/api.md +++ b/packages/core/api.md @@ -78,6 +78,20 @@ export function authHomeIdFromDSK(dsk: Buffer): Buffer; // @public export function averageRSSI(acc: number | undefined, rssi: RSSI, weight: number): number; +// Warning: (ae-missing-release-tag) "BeamingInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum BeamingInfo { + // (undocumented) + Fragmented = 4, + // (undocumented) + LongContinuous = 2, + // (undocumented) + None = 0, + // (undocumented) + ShortContinuous = 1 +} + // Warning: (ae-missing-release-tag) "BroadcastCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -484,7 +498,7 @@ export enum ConfigValueFormat { // (undocumented) Enumerated = 2, // (undocumented) - SignedInteger = 0, + SignedInteger = 0,// UnsignedInt, Radio Buttons // (undocumented) UnsignedInteger = 1 } @@ -504,15 +518,15 @@ export const CONTROLLER_LABEL = "CNTRLR"; // @public (undocumented) export enum ControllerCapabilityFlags { // (undocumented) - NoNodesIncluded = 32, + NoNodesIncluded = 32,// Controller is a secondary // (undocumented) - OnOtherNetwork = 2, + OnOtherNetwork = 2,// Controller is using a home ID from another network // (undocumented) - Secondary = 1, + Secondary = 1,// There's a SUC id server (SIS) on the network // (undocumented) - SISPresent = 4, + SISPresent = 4,// Before the SIS was added, the controller was the primary // (undocumented) - SUC = 16, + SUC = 16,// Controller is a static update controller (SUC) // (undocumented) WasRealPrimary = 8 } @@ -1006,6 +1020,14 @@ export function getBitMaskWidth(mask: number): number; // @public (undocumented) export function getCCName(cc: number): string; +// Warning: (ae-missing-release-tag) "getChipTypeAndVersion" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export function getChipTypeAndVersion(zWaveChipType: string): MaybeNotKnown<{ + type: number; + version: number; +}>; + // Warning: (ae-missing-release-tag) "getDefaultDSTInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public @@ -1073,6 +1095,11 @@ export function getNodeTag(nodeId: number): string; // @public export function getNumericEnumValues>(enumeration: T): readonly number[]; +// Warning: (ae-missing-release-tag) "getZWaveChipType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export function getZWaveChipType(type: number, version: number): string | UnknownZWaveChipType; + // Warning: (ae-missing-release-tag) "GraphNode" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -1465,10 +1492,10 @@ export type LogValueArgs = T & { export enum LongRangeChannel { // (undocumented) A = 1, + Auto = 255, // (undocumented) B = 2, - // (undocumented) - Unknown = 0 + Unsupported = 0 } // Warning: (ae-missing-release-tag) "managementCCs" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -1600,6 +1627,22 @@ export type MPANTableEntry = { currentMPAN: Buffer; }; +// Warning: (ae-missing-release-tag) "MPDUHeaderType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum MPDUHeaderType { + // (undocumented) + Acknowledgement = 3, + // (undocumented) + Explorer = 5, + // (undocumented) + Multicast = 2, + // (undocumented) + Routed = 8, + // (undocumented) + Singlecast = 1 +} + // Warning: (ae-missing-release-tag) "MulticastCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -2724,6 +2767,16 @@ export const UNKNOWN_STATE: null; // @public (undocumented) export type UNKNOWN_STATE = typeof UNKNOWN_STATE; +// Warning: (ae-missing-release-tag) "UnknownZWaveChipType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface UnknownZWaveChipType { + // (undocumented) + type: number; + // (undocumented) + version: number; +} + // Warning: (ae-missing-release-tag) "unsilence" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public @@ -3231,6 +3284,61 @@ export interface ValueUpdatedArgs extends ValueID { source?: "driver" | "node"; } +// Warning: (ae-missing-release-tag) "ZnifferProtocolDataRate" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum ZnifferProtocolDataRate { + // (undocumented) + LongRange_100k = 3, + // (undocumented) + ZWave_100k = 2, + // (undocumented) + ZWave_40k = 1, + // (undocumented) + ZWave_9k6 = 0 +} + +// Warning: (ae-missing-release-tag) "znifferProtocolDataRateToString" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export function znifferProtocolDataRateToString(rate: ZnifferProtocolDataRate): string; + +// Warning: (ae-missing-release-tag) "ZnifferRegion" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum ZnifferRegion { + // (undocumented) + "Australia/New Zealand" = 2, + // (undocumented) + "Default (EU)" = 255, + // (undocumented) + "Hong Kong" = 3, + // (undocumented) + "USA (Long Range)" = 9, + // (undocumented) + "USA (Long Range, backup)" = 10, + // (undocumented) + "USA (Long Range, end device)" = 48, + // (undocumented) + "China" = 8, + // (undocumented) + "Europe" = 0, + // (undocumented) + "India" = 5, + // (undocumented) + "Israel" = 6, + // (undocumented) + "Japan" = 32, + // (undocumented) + "Korea" = 33, + // (undocumented) + "Russia" = 7, + // (undocumented) + "Unknown" = 254, + // (undocumented) + "USA" = 1 +} + // Warning: (ae-missing-release-tag) "ZWaveApiVersion" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -3488,6 +3596,8 @@ export interface ZWaveLogInfo extends // Warnings were encountered during analysis: // +// src/security/Manager2.ts:116:79 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag +// src/security/Manager2.ts:116:98 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag // src/security/QR.ts:99:3 - (ae-unresolved-link) The @link reference could not be resolved: The package "@zwave-js/core" does not have an export "requestedSecurityClasses" // (No @packageDocumentation comment for this package) diff --git a/packages/nvmedit/api.md b/packages/nvmedit/api.md index 171e9a30565c..59c33dca5028 100644 --- a/packages/nvmedit/api.md +++ b/packages/nvmedit/api.md @@ -430,7 +430,7 @@ export enum PageStatus { // @public (undocumented) export enum PageWriteSize { // (undocumented) - WRITE_SIZE_16 = 1, + WRITE_SIZE_16 = 1,// Only single writes are allowed // (undocumented) WRITE_SIZE_32 = 0 } diff --git a/packages/serial/api.md b/packages/serial/api.md index 95b85aa120de..cc6cd3d16587 100644 --- a/packages/serial/api.md +++ b/packages/serial/api.md @@ -15,12 +15,15 @@ import type { JSONObject } from '@zwave-js/shared/safe'; import type { LogContext } from '@zwave-js/core/safe'; import { MessageOrCCLogEntry } from '@zwave-js/core'; import { MessagePriority } from '@zwave-js/core'; -import * as net from 'node:net'; +import type * as net from 'node:net'; import { PassThrough } from 'node:stream'; +import { RSSI } from '@zwave-js/core'; import { SerialPort } from 'serialport'; import { Transform } from 'node:stream'; import { TransformCallback } from 'node:stream'; import type { TypedClassDecorator } from '@zwave-js/shared/safe'; +import { UnknownZWaveChipType } from '@zwave-js/core'; +import { ZnifferProtocolDataRate } from '@zwave-js/core'; import type { ZWaveApplicationHost } from '@zwave-js/host'; import type { ZWaveHost } from '@zwave-js/host'; import { ZWaveLogContainer } from '@zwave-js/core'; @@ -92,6 +95,11 @@ export class BootloaderScreenParser extends Transform { // @public (undocumented) export type DeserializingMessageConstructor = new (host: ZWaveHost, options: MessageDeserializationOptions) => T; +// Warning: (ae-missing-release-tag) "DeserializingZnifferMessageConstructor" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type DeserializingZnifferMessageConstructor = new (options: ZnifferMessageDeserializationOptions) => T; + // Warning: (ae-missing-release-tag) "expectedCallback" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public @@ -109,9 +117,9 @@ export enum FunctionType { // (undocumented) AddNodeToNetwork = 74, // (undocumented) - ApplicationCommand = 4, + ApplicationCommand = 4,// Set up the controller NIF prior to starting or joining a Z-Wave network // (undocumented) - ApplicationUpdateRequest = 73, + ApplicationUpdateRequest = 73,// A message from another node // (undocumented) AssignPriorityReturnRoute = 79, // (undocumented) @@ -121,199 +129,199 @@ export enum FunctionType { // (undocumented) AssignSUCReturnRoute = 81, // (undocumented) - BridgeApplicationCommand = 168, + BridgeApplicationCommand = 168,// Used to request the Z-Wave Protocol version data (700 series) // (undocumented) - DeleteReturnRoute = 71, + DeleteReturnRoute = 71,// Sent by the controller after the serial API has been started (again) // (undocumented) - DeleteSUCReturnRoute = 85, + DeleteSUCReturnRoute = 85,// Configure the Serial API // (undocumented) - EnterBootloader = 39, + EnterBootloader = 39,// Power the RF section of the stick down/up // (undocumented) - ExtExtWriteLongByte = 45, + ExtExtWriteLongByte = 45,// Set the CPU into sleep mode // (undocumented) - ExtNVMReadLongBuffer = 42, + ExtNVMReadLongBuffer = 42,// Send Node Information Frame of the stick // (undocumented) - ExtNVMReadLongByte = 44, + ExtNVMReadLongByte = 44,// Send data // (undocumented) - ExtNVMWriteLongBuffer = 43, + ExtNVMWriteLongBuffer = 43,// Send data using multicast // (undocumented) FirmwareUpdateNVM = 120, // (undocumented) - FUNC_ID_APPLICATION_SLAVE_COMMAND_HANDLER = 161, + FUNC_ID_APPLICATION_SLAVE_COMMAND_HANDLER = 161,// Abort sending data // (undocumented) - FUNC_ID_PROMISCUOUS_APPLICATION_COMMAND_HANDLER = 209, + FUNC_ID_PROMISCUOUS_APPLICATION_COMMAND_HANDLER = 209,// Set RF Power level // (undocumented) - FUNC_ID_SERIAL_API_SLAVE_NODE_INFO = 160, + FUNC_ID_SERIAL_API_SLAVE_NODE_INFO = 160,// ?? // (undocumented) - FUNC_ID_ZW_CONTROLLER_CHANGE = 77, + FUNC_ID_ZW_CONTROLLER_CHANGE = 77,// Returns random data of variable length // (undocumented) - FUNC_ID_ZW_CREATE_NEW_PRIMARY = 76, + FUNC_ID_ZW_CREATE_NEW_PRIMARY = 76,// Get Home ID and Controller Node ID // (undocumented) - FUNC_ID_ZW_ENABLE_SUC = 82, + FUNC_ID_ZW_ENABLE_SUC = 82,// get a byte of memory // (undocumented) - FUNC_ID_ZW_EXPLORE_REQUEST_INCLUSION = 94, + FUNC_ID_ZW_EXPLORE_REQUEST_INCLUSION = 94,// write a byte of memory // (undocumented) FUNC_ID_ZW_GET_RANDOM = 28, // (undocumented) FUNC_ID_ZW_GET_VIRTUAL_NODES = 165, // (undocumented) - FUNC_ID_ZW_IS_VIRTUAL_NODE = 166, + FUNC_ID_ZW_IS_VIRTUAL_NODE = 166,// Leave Serial API and enter bootloader (700+ series only). Enter Auto-Programming mode (500 series only). // (undocumented) - FUNC_ID_ZW_NEW_CONTROLLER = 67, + FUNC_ID_ZW_NEW_CONTROLLER = 67,// ZW_NVRGetValue(offset, length) => NVRdata[], see INS13954-13 // (undocumented) - FUNC_ID_ZW_R_F_POWER_LEVEL_SET = 23, + FUNC_ID_ZW_R_F_POWER_LEVEL_SET = 23,// Returns information about the external NVM // (undocumented) - FUNC_ID_ZW_REPLICATION_COMMAND_COMPLETE = 68, + FUNC_ID_ZW_REPLICATION_COMMAND_COMPLETE = 68,// Reads a buffer from the external NVM // (undocumented) - FUNC_ID_ZW_REPLICATION_SEND_DATA = 69, + FUNC_ID_ZW_REPLICATION_SEND_DATA = 69,// Writes a buffer to the external NVM // (undocumented) - FUNC_ID_ZW_REQUEST_NETWORK_UPDATE = 83, + FUNC_ID_ZW_REQUEST_NETWORK_UPDATE = 83,// Reads a byte from the external NVM // (undocumented) - FUNC_ID_ZW_REQUEST_NODE_NEIGHBOR_UPDATE_OPTIONS = 90, + FUNC_ID_ZW_REQUEST_NODE_NEIGHBOR_UPDATE_OPTIONS = 90,// Writes a byte to the external NVM // (undocumented) - FUNC_ID_ZW_SEND_NODE_INFORMATION = 18, + FUNC_ID_ZW_SEND_NODE_INFORMATION = 18,// 700-series command to read and write from/to the external NVM // (undocumented) - FUNC_ID_ZW_SEND_SLAVE_DATA = 163, + FUNC_ID_ZW_SEND_SLAVE_DATA = 163,// ?? // (undocumented) - FUNC_ID_ZW_SEND_SLAVE_NODE_INFO = 162, + FUNC_ID_ZW_SEND_SLAVE_NODE_INFO = 162,// ?? // (undocumented) - FUNC_ID_ZW_SET_LEARN_MODE = 80, + FUNC_ID_ZW_SET_LEARN_MODE = 80,// ?? // (undocumented) - FUNC_ID_ZW_SET_LEARN_NODE_STATE = 64, + FUNC_ID_ZW_SET_LEARN_NODE_STATE = 64,// ?? // (undocumented) - FUNC_ID_ZW_SET_PROMISCUOUS_MODE = 208, + FUNC_ID_ZW_SET_PROMISCUOUS_MODE = 208,// ?? // (undocumented) - FUNC_ID_ZW_SET_SLAVE_LEARN_MODE = 164, + FUNC_ID_ZW_SET_SLAVE_LEARN_MODE = 164,// ?? // (undocumented) - GetBackgroundRSSI = 59, + GetBackgroundRSSI = 59,// ?? // (undocumented) GetControllerCapabilities = 5, // (undocumented) GetControllerId = 32, // (undocumented) - GetControllerVersion = 21, + GetControllerVersion = 21,// request the most recent background RSSI levels detected // (undocumented) GetLongRangeChannel = 219, // (undocumented) - GetLongRangeNodes = 218, + GetLongRangeNodes = 218,// Not implemented // (undocumented) - GetNodeProtocolInfo = 65, + GetNodeProtocolInfo = 65,// Get protocol info (baud rate, listening, etc.) for a given node // (undocumented) - GetNVMId = 41, + GetNVMId = 41,// Reset controller and node info to default (original) values // (undocumented) - GetPriorityRoute = 146, + GetPriorityRoute = 146,// Not implemented // (undocumented) - GetProtocolVersion = 9, + GetProtocolVersion = 9,// Replication send data complete // (undocumented) - GetRoutingInfo = 128, + GetRoutingInfo = 128,// Replication send data // (undocumented) - GetSerialApiCapabilities = 7, + GetSerialApiCapabilities = 7,// Assign a return route from the source node to the destination node // (undocumented) - GetSerialApiInitData = 2, + GetSerialApiInitData = 2,// Delete all return routes from the specified node // (undocumented) - GetSUCNodeId = 86, + GetSUCNodeId = 86,// Ask the specified node to update its neighbors (then read them from the controller) // (undocumented) - HardReset = 66, + HardReset = 66,// Get a list of supported (and controller) command classes // (undocumented) - IsFailedNode = 98, + IsFailedNode = 98,// Control the addnode (or addcontroller) process...start, stop, etc. // (undocumented) - NVMOperations = 46, + NVMOperations = 46,// Control the removenode (or removecontroller) process...start, stop, etc. // (undocumented) - RemoveFailedNode = 97, + RemoveFailedNode = 97,// Control the createnewprimary process...start, stop, etc. // (undocumented) - RemoveNodeFromNetwork = 75, + RemoveNodeFromNetwork = 75,// Control the transferprimary process...start, stop, etc. // (undocumented) - ReplaceFailedNode = 99, + ReplaceFailedNode = 99,// Assign a priority route between two nodes // (undocumented) - RequestNodeInfo = 96, + RequestNodeInfo = 96,// Put a controller into learn mode for replication/ receipt of configuration info // (undocumented) - RequestNodeNeighborUpdate = 72, + RequestNodeNeighborUpdate = 72,// Assign a return route to the SUC // (undocumented) - SendData = 19, + SendData = 19,// Make a controller a Static Update Controller // (undocumented) - SendDataAbort = 22, + SendDataAbort = 22,// Network update for a SUC(?) // (undocumented) - SendDataBridge = 169, + SendDataBridge = 169,// Configure a static/bridge controller to be a SUC/SIS node (or not) // (undocumented) - SendDataMulticast = 20, + SendDataMulticast = 20,// Remove return routes to the SUC // (undocumented) - SendDataMulticastBridge = 171, + SendDataMulticastBridge = 171,// Try to retrieve a Static Update Controller node id (zero if no SUC present) // (undocumented) SerialAPISetup = 11, // (undocumented) - SerialAPIStarted = 10, + SerialAPIStarted = 10,// Assign a priority route from a node to the SUC // (undocumented) SetApplicationNodeInformation = 3, // (undocumented) - SetLongRangeChannel = 220, + SetLongRangeChannel = 220,// Allow options for request node neighbor update // (undocumented) - SetLongRangeShadowNodeIDs = 221, + SetLongRangeShadowNodeIDs = 221,// supports NWI // (undocumented) - SetPriorityRoute = 147, + SetPriorityRoute = 147,// Get info (supported command classes) for the specified node // (undocumented) - SetRFReceiveMode = 16, + SetRFReceiveMode = 16,// Mark a specified node id as failed // (undocumented) - SetSerialApiTimeouts = 6, + SetSerialApiTimeouts = 6,// Check to see if a specified node has failed // (undocumented) - SetSUCNodeId = 84, + SetSUCNodeId = 84,// Replace a failed node with a new one that takes the same node ID // (undocumented) - Shutdown = 217, + Shutdown = 217,// ?? // (undocumented) - SoftReset = 8, + SoftReset = 8,// ?? // (undocumented) - UNKNOWN_FUNC_ClearNetworkStats = 57, + UNKNOWN_FUNC_ClearNetworkStats = 57,// ?? // (undocumented) - UNKNOWN_FUNC_CLOCK_COMPARE = 50, + UNKNOWN_FUNC_CLOCK_COMPARE = 50,// ?? // (undocumented) - UNKNOWN_FUNC_CLOCK_GET = 49, + UNKNOWN_FUNC_CLOCK_GET = 49,// ?? // (undocumented) - UNKNOWN_FUNC_CLOCK_SET = 48, + UNKNOWN_FUNC_CLOCK_SET = 48,// ?? // (undocumented) - UNKNOWN_FUNC_GET_LIBRARY_TYPE = 189, + UNKNOWN_FUNC_GET_LIBRARY_TYPE = 189,// Access the NVM section for 500 series OTW firmware updates // (undocumented) - UNKNOWN_FUNC_GET_PROTOCOL_STATUS = 191, + UNKNOWN_FUNC_GET_PROTOCOL_STATUS = 191,// Get a specified node's neighbor information from the controller // (undocumented) - UNKNOWN_FUNC_GetNetworkStats = 58, + UNKNOWN_FUNC_GetNetworkStats = 58,// ?? // (undocumented) - UNKNOWN_FUNC_GetTXCounter = 129, + UNKNOWN_FUNC_GetTXCounter = 129,// ?? // (undocumented) - UNKNOWN_FUNC_LOCK_ROUTE_RESPONSE = 144, + UNKNOWN_FUNC_LOCK_ROUTE_RESPONSE = 144,// ?? // (undocumented) - UNKNOWN_FUNC_MEMORY_GET_BUFFER = 35, + UNKNOWN_FUNC_MEMORY_GET_BUFFER = 35,// ?? // (undocumented) - UNKNOWN_FUNC_MEMORY_GET_BYTE = 33, + UNKNOWN_FUNC_MEMORY_GET_BYTE = 33,// ?? // (undocumented) - UNKNOWN_FUNC_MEMORY_PUT_BUFFER = 36, + UNKNOWN_FUNC_MEMORY_PUT_BUFFER = 36,// ?? // (undocumented) - UNKNOWN_FUNC_MEMORY_PUT_BYTE = 34, + UNKNOWN_FUNC_MEMORY_PUT_BYTE = 34,// Get the route that is used as the first routing attempty when transmitting to a node // (undocumented) - UNKNOWN_FUNC_REDISCOVERY_NEEDED = 89, + UNKNOWN_FUNC_REDISCOVERY_NEEDED = 89,// Set the route that shall be used as the first routing attempty when transmitting to a node // (undocumented) - UNKNOWN_FUNC_RemoveNodeIdFromNetwork = 63, + UNKNOWN_FUNC_RemoveNodeIdFromNetwork = 63,// ?? // (undocumented) - UNKNOWN_FUNC_ResetTXCounter = 130, + UNKNOWN_FUNC_ResetTXCounter = 130,// ?? // (undocumented) - UNKNOWN_FUNC_RF_POWERLEVEL_GET = 186, + UNKNOWN_FUNC_RF_POWERLEVEL_GET = 186,// Set application virtual slave node information // (undocumented) - UNKNOWN_FUNC_RTC_TIMER_CALL = 54, + UNKNOWN_FUNC_RTC_TIMER_CALL = 54,// Slave command handler // (undocumented) - UNKNOWN_FUNC_RTC_TIMER_CREATE = 51, + UNKNOWN_FUNC_RTC_TIMER_CREATE = 51,// Send a slave node information message // (undocumented) - UNKNOWN_FUNC_RTC_TIMER_DELETE = 53, + UNKNOWN_FUNC_RTC_TIMER_DELETE = 53,// Send data from slave // (undocumented) - UNKNOWN_FUNC_RTC_TIMER_READ = 52, + UNKNOWN_FUNC_RTC_TIMER_READ = 52,// Enter slave learn mode // (undocumented) - UNKNOWN_FUNC_SEND_DATA_META = 24, + UNKNOWN_FUNC_SEND_DATA_META = 24,// Return all virtual nodes // (undocumented) - UNKNOWN_FUNC_SEND_DATA_ROUTE_DEMO = 145, + UNKNOWN_FUNC_SEND_DATA_ROUTE_DEMO = 145,// Virtual node test // (undocumented) - UNKNOWN_FUNC_SEND_SUC_ID = 87, + UNKNOWN_FUNC_SEND_SUC_ID = 87,// A message from another node using the Bridge API // (undocumented) - UNKNOWN_FUNC_SEND_TEST_FRAME = 190, + UNKNOWN_FUNC_SEND_TEST_FRAME = 190,// Send data (Bridge API) // (undocumented) - UNKNOWN_FUNC_SERIAL_API_TEST = 149, + UNKNOWN_FUNC_SERIAL_API_TEST = 149,// Send data using multicast (Bridge API) // (undocumented) - UNKNOWN_FUNC_SET_SLEEP_MODE = 17, + UNKNOWN_FUNC_SET_SLEEP_MODE = 17,// ?? // (undocumented) UNKNOWN_FUNC_StoreHomeId = 132, // (undocumented) @@ -321,9 +329,9 @@ export enum FunctionType { // (undocumented) UNKNOWN_FUNC_TIMER_CALL = 115, // (undocumented) - UNKNOWN_FUNC_TIMER_CANCEL = 114, + UNKNOWN_FUNC_TIMER_CANCEL = 114,// ?? // (undocumented) - UNKNOWN_FUNC_TIMER_RESTART = 113, + UNKNOWN_FUNC_TIMER_RESTART = 113,// Get RF Power level // (undocumented) UNKNOWN_FUNC_TIMER_START = 112, // (undocumented) @@ -331,19 +339,19 @@ export enum FunctionType { // (undocumented) UNKNOWN_FUNC_UNKNOWN_0x66 = 102, // (undocumented) - UNKNOWN_FUNC_UNKNOWN_0x67 = 103, + UNKNOWN_FUNC_UNKNOWN_0x67 = 103,// Set controller into promiscuous mode to listen to all messages // (undocumented) UNKNOWN_FUNC_UNKNOWN_0x98 = 152, // (undocumented) - UNKNOWN_FUNC_UNKNOWN_0xB4 = 180, + UNKNOWN_FUNC_UNKNOWN_0xB4 = 180,// ?? // (undocumented) - UNKNOWN_FUNC_UNKNOWN_0xB9 = 185, + UNKNOWN_FUNC_UNKNOWN_0xB9 = 185,// ?? // (undocumented) - UNKNOWN_FUNC_UNKNOWN_0xD2 = 210, + UNKNOWN_FUNC_UNKNOWN_0xD2 = 210,// ?? // (undocumented) - UNKNOWN_FUNC_UNKNOWN_0xD3 = 211, + UNKNOWN_FUNC_UNKNOWN_0xD3 = 211,// Instruct the Z-Wave API to shut down in order to safely remove the power // (undocumented) - UNKNOWN_FUNC_UNKNOWN_0xD4 = 212, + UNKNOWN_FUNC_UNKNOWN_0xD4 = 212,// Used after GetSerialApiInitData to get the nodes with IDs > 0xFF // (undocumented) UNKNOWN_FUNC_UNKNOWN_0xEF = 239, // (undocumented) @@ -351,7 +359,7 @@ export enum FunctionType { // (undocumented) UNKNOWN_FUNC_WATCH_DOG_ENABLE = 182, // (undocumented) - UNKNOWN_FUNC_WATCH_DOG_KICK = 184, + UNKNOWN_FUNC_WATCH_DOG_KICK = 184,// ?? // (undocumented) UNKNOWN_FUNC_ZMEBootloaderFlash = 244, // (undocumented) @@ -676,6 +684,370 @@ export enum XModemMessageHeaders { SOF = 1 } +// Warning: (ae-missing-release-tag) "ZnifferDataMessage" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferDataMessage extends ZnifferMessage implements ZnifferFrameInfo { + constructor(options: ZnifferMessageOptions); + // (undocumented) + readonly channel: number; + // (undocumented) + readonly checksumOK: boolean; + // (undocumented) + readonly frameType: ZnifferFrameType; + // (undocumented) + readonly protocolDataRate: ZnifferProtocolDataRate; + // (undocumented) + readonly region: number; + // (undocumented) + readonly rssiRaw: number; +} + +// Warning: (ae-missing-release-tag) "ZnifferFrameInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferFrameInfo { + // (undocumented) + readonly channel: number; + // (undocumented) + readonly frameType: ZnifferFrameType; + // (undocumented) + readonly protocolDataRate: ZnifferProtocolDataRate; + // (undocumented) + readonly region: number; + // (undocumented) + rssi?: RSSI; + // (undocumented) + readonly rssiRaw: number; +} + +// Warning: (ae-missing-release-tag) "ZnifferFrameType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum ZnifferFrameType { + // (undocumented) + BeamFrame = 2, + // (undocumented) + BeamStart = 4, + // (undocumented) + BeamStop = 5, + // (undocumented) + Command = 0, + // (undocumented) + Data = 1 +} + +// Warning: (ae-missing-release-tag) "ZnifferFunctionType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum ZnifferFunctionType { + // (undocumented) + GetFrequencies = 3, + // (undocumented) + GetFrequencyInfo = 19, + // (undocumented) + GetVersion = 1, + // (undocumented) + SetBaudRate = 14, + // (undocumented) + SetFrequency = 2, + // (undocumented) + Start = 4, + // (undocumented) + Stop = 5 +} + +// Warning: (ae-missing-release-tag) "ZnifferGetFrequenciesRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferGetFrequenciesRequest extends ZnifferMessage { + constructor(); +} + +// Warning: (ae-missing-release-tag) "ZnifferGetFrequenciesResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferGetFrequenciesResponse extends ZnifferMessage { + constructor(options: ZnifferMessageOptions); + // (undocumented) + readonly currentFrequency: number; + // (undocumented) + readonly supportedFrequencies: readonly number[]; +} + +// Warning: (ae-missing-release-tag) "ZnifferGetFrequencyInfoRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferGetFrequencyInfoRequest extends ZnifferMessage { + constructor(options: ZnifferGetFrequencyInfoRequestOptions); + // (undocumented) + frequency: number; + // (undocumented) + serialize(): Buffer; +} + +// Warning: (ae-missing-release-tag) "ZnifferGetFrequencyInfoRequestOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferGetFrequencyInfoRequestOptions { + // (undocumented) + frequency: number; +} + +// Warning: (ae-missing-release-tag) "ZnifferGetFrequencyInfoResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferGetFrequencyInfoResponse extends ZnifferMessage { + constructor(options: ZnifferMessageOptions); + // (undocumented) + readonly frequency: number; + // (undocumented) + readonly frequencyName: string; + // (undocumented) + readonly numChannels: number; +} + +// Warning: (ae-missing-release-tag) "ZnifferGetVersionRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferGetVersionRequest extends ZnifferMessage { + constructor(); +} + +// Warning: (ae-missing-release-tag) "ZnifferGetVersionResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferGetVersionResponse extends ZnifferMessage { + constructor(options: ZnifferMessageOptions); + // (undocumented) + readonly chipType: string | UnknownZWaveChipType; + // (undocumented) + readonly majorVersion: number; + // (undocumented) + readonly minorVersion: number; +} + +// Warning: (ae-missing-release-tag) "ZnifferMessage" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export class ZnifferMessage { + constructor(options: ZnifferMessageOptions); + static from(options: ZnifferMessageDeserializationOptions): ZnifferMessage; + // (undocumented) + functionType?: ZnifferFunctionType; + static getConstructor(data: Buffer): ZnifferMessageConstructor; + // (undocumented) + payload: Buffer; + serialize(): Buffer; + // (undocumented) + type: ZnifferMessageType; +} + +// Warning: (ae-missing-release-tag) "ZnifferMessageBaseOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferMessageBaseOptions { +} + +// Warning: (ae-missing-release-tag) "ZnifferMessageConstructor" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type ZnifferMessageConstructor = new (options: ZnifferMessageOptions) => T; + +// Warning: (ae-missing-release-tag) "ZnifferMessageCreationOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferMessageCreationOptions extends ZnifferMessageBaseOptions { + // (undocumented) + functionType?: ZnifferFunctionType; + // (undocumented) + messageType: ZnifferMessageType; + // (undocumented) + payload?: Buffer; +} + +// Warning: (ae-missing-release-tag) "ZnifferMessageDeserializationOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferMessageDeserializationOptions { + // (undocumented) + data: Buffer; +} + +// Warning: (ae-missing-release-tag) "ZnifferMessageHeaders" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum ZnifferMessageHeaders { + // (undocumented) + SOCF = 35,// commmand frame + // (undocumented) + SODF = 33 +} + +// Warning: (ae-missing-release-tag) "ZnifferMessageOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type ZnifferMessageOptions = ZnifferMessageCreationOptions | ZnifferMessageDeserializationOptions; + +// Warning: (ae-missing-release-tag) "ZnifferMessageType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum ZnifferMessageType { + // (undocumented) + Command = 35, + // (undocumented) + Data = 33 +} + +// Warning: (ae-missing-release-tag) "ZnifferSerialPort" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export class ZnifferSerialPort extends ZnifferSerialPortBase { + constructor(port: string, loggers: ZWaveLogContainer, Binding?: typeof SerialPort); + // (undocumented) + get isOpen(): boolean; +} + +// Warning: (ae-missing-release-tag) "ZnifferSerialPortBase" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// Warning: (ae-missing-release-tag) "ZnifferSerialPortBase" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferSerialPortBase { + // (undocumented) + addListener(event: TEvent, callback: ZnifferSerialPortEventCallbacks[TEvent]): this; + // (undocumented) + emit(event: TEvent, ...args: Parameters): boolean; + // (undocumented) + off(event: TEvent, callback: ZnifferSerialPortEventCallbacks[TEvent]): this; + // (undocumented) + on(event: TEvent, callback: ZnifferSerialPortEventCallbacks[TEvent]): this; + // (undocumented) + once(event: TEvent, callback: ZnifferSerialPortEventCallbacks[TEvent]): this; + // (undocumented) + removeAllListeners(event?: ZnifferSerialPortEvents): this; + // (undocumented) + removeListener(event: TEvent, callback: ZnifferSerialPortEventCallbacks[TEvent]): this; +} + +// @public (undocumented) +export class ZnifferSerialPortBase extends PassThrough { + // (undocumented) + [Symbol.asyncIterator]: () => AsyncIterableIterator; + constructor(implementation: ZWaveSerialPortImplementation, loggers: ZWaveLogContainer); + // (undocumented) + close(): Promise; + // (undocumented) + get isOpen(): boolean; + // (undocumented) + protected logger: SerialLogger; + // (undocumented) + open(): Promise; + // (undocumented) + protected serial: ReturnType; + // (undocumented) + writeAsync(data: Buffer): Promise; +} + +// Warning: (ae-missing-release-tag) "ZnifferSerialPortEventCallbacks" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferSerialPortEventCallbacks { + // (undocumented) + data: (data: Buffer) => void; + // (undocumented) + discardedData: (data: Buffer) => void; + // (undocumented) + error: (e: Error) => void; +} + +// Warning: (ae-missing-release-tag) "ZnifferSerialPortEvents" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type ZnifferSerialPortEvents = Extract; + +// Warning: (ae-missing-release-tag) "ZnifferSetBaudRateRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferSetBaudRateRequest extends ZnifferMessage { + constructor(options: ZnifferSetBaudRateRequestOptions); + // (undocumented) + baudrate: 0; + // (undocumented) + serialize(): Buffer; +} + +// Warning: (ae-missing-release-tag) "ZnifferSetBaudRateRequestOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferSetBaudRateRequestOptions { + // (undocumented) + baudrate: 0; +} + +// Warning: (ae-missing-release-tag) "ZnifferSetBaudRateResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferSetBaudRateResponse extends ZnifferMessage { +} + +// Warning: (ae-missing-release-tag) "ZnifferSetFrequencyRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferSetFrequencyRequest extends ZnifferMessage { + constructor(options: ZnifferSetFrequencyRequestOptions); + // (undocumented) + frequency: number; + // (undocumented) + serialize(): Buffer; +} + +// Warning: (ae-missing-release-tag) "ZnifferSetFrequencyRequestOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferSetFrequencyRequestOptions { + // (undocumented) + frequency: number; +} + +// Warning: (ae-missing-release-tag) "ZnifferSetFrequencyResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferSetFrequencyResponse extends ZnifferMessage { +} + +// Warning: (ae-missing-release-tag) "ZnifferSocket" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export class ZnifferSocket extends ZnifferSerialPortBase { + constructor(socketOptions: ZWaveSocketOptions, loggers: ZWaveLogContainer); +} + +// Warning: (ae-missing-release-tag) "ZnifferStartRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferStartRequest extends ZnifferMessage { + constructor(); +} + +// Warning: (ae-missing-release-tag) "ZnifferStartResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferStartResponse extends ZnifferMessage { +} + +// Warning: (ae-missing-release-tag) "ZnifferStopRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferStopRequest extends ZnifferMessage { + constructor(); +} + +// Warning: (ae-missing-release-tag) "ZnifferStopResponse" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZnifferStopResponse extends ZnifferMessage { +} + // Warning: (ae-missing-release-tag) "ZWaveSerialChunk" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) diff --git a/packages/zwave-js/api.md b/packages/zwave-js/api.md index 95641e46a315..157b173deee3 100644 --- a/packages/zwave-js/api.md +++ b/packages/zwave-js/api.md @@ -11,14 +11,16 @@ import { APIMethodsOf } from '@zwave-js/cc'; import { AssociationAddress } from '@zwave-js/cc'; import { AssociationGroup } from '@zwave-js/cc'; import type { BasicDeviceClass } from '@zwave-js/config'; +import { BeamingInfo } from '@zwave-js/core/safe'; +import { BeamingInfo as BeamingInfo_2 } from '@zwave-js/core'; import { BootloaderChunk } from '@zwave-js/serial'; import { buffer2hex } from '@zwave-js/shared/safe'; import { CCAPIs } from '@zwave-js/cc'; import { CCConstructor } from '@zwave-js/cc'; import { CCNameOrId } from '@zwave-js/cc'; import { CommandClass } from '@zwave-js/cc'; -import { CommandClasses } from '@zwave-js/core/safe'; -import { CommandClasses as CommandClasses_2 } from '@zwave-js/core'; +import { CommandClasses } from '@zwave-js/core'; +import { CommandClasses as CommandClasses_2 } from '@zwave-js/core/safe'; import { CommandClassInfo } from '@zwave-js/core'; import { Comparable } from 'alcalzone-shared/comparable'; import { CompareResult } from 'alcalzone-shared/comparable'; @@ -74,6 +76,7 @@ import type { JSONObject } from '@zwave-js/shared'; import { KEXFailType } from '@zwave-js/cc'; import { LogConfig } from '@zwave-js/core'; import { LogContext } from '@zwave-js/core'; +import { LongRangeChannel } from '@zwave-js/core'; import { MaybeNotKnown } from '@zwave-js/core'; import { MaybeUnknown } from '@zwave-js/core'; import { Message } from '@zwave-js/serial'; @@ -87,6 +90,8 @@ import { MessageType } from '@zwave-js/serial'; import type { MetadataUpdatedArgs } from '@zwave-js/core/safe'; import { MockControllerBehavior } from '@zwave-js/testing'; import { MockNodeBehavior } from '@zwave-js/testing'; +import { MPDUHeaderType } from '@zwave-js/core/safe'; +import { MPDUHeaderType as MPDUHeaderType_2 } from '@zwave-js/core'; import { MulticastCC } from '@zwave-js/core'; import { MulticastDestination } from '@zwave-js/core/safe'; import { MultilevelSwitchCommand } from '@zwave-js/cc/safe'; @@ -151,6 +156,7 @@ import { TranslatedValueID as TranslatedValueID_2 } from '@zwave-js/core'; import { TransmitOptions } from '@zwave-js/core'; import { TXReport } from '@zwave-js/core/safe'; import { TypedEventEmitter } from '@zwave-js/shared'; +import { UnknownZWaveChipType } from '@zwave-js/core'; import * as util from 'node:util'; import type { ValueAddedArgs } from '@zwave-js/core/safe'; import { ValueDB } from '@zwave-js/core'; @@ -167,6 +173,10 @@ import type { ValueRemovedArgs } from '@zwave-js/core/safe'; import { ValueType } from '@zwave-js/core/safe'; import type { ValueUpdatedArgs } from '@zwave-js/core/safe'; import type { Weekday } from '@zwave-js/cc/safe'; +import { ZnifferDataMessage } from '@zwave-js/serial'; +import { ZnifferFrameInfo } from '@zwave-js/serial'; +import { ZnifferProtocolDataRate } from '@zwave-js/core'; +import { ZnifferRegion } from '@zwave-js/core'; import { ZWaveApiVersion } from '@zwave-js/core/safe'; import type { ZWaveApplicationHost } from '@zwave-js/host'; import { ZWaveDataRate } from '@zwave-js/core'; @@ -181,6 +191,40 @@ import { ZWavePlusRoleType } from '@zwave-js/cc'; import type { ZWaveSerialPortBase } from '@zwave-js/serial'; import { ZWaveSerialPortImplementation } from '@zwave-js/serial'; +// Warning: (ae-missing-release-tag) "BeamFrame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type BeamFrame = { + channel: number; +} & ({ + protocol: Protocols.ZWave; + type: ZWaveFrameType.BeamStart; + protocolDataRate: ZnifferProtocolDataRate; + rssiRaw: number; + rssi?: RSSI_2; + region: ZnifferRegion; + homeIdHash?: number; + destinationNodeId: number; +} | { + protocol: Protocols.ZWaveLongRange; + type: LongRangeFrameType.BeamStart; + protocolDataRate: ZnifferProtocolDataRate; + rssiRaw: number; + rssi?: RSSI_2; + region: ZnifferRegion; + txPower: number; + homeIdHash: number; + destinationNodeId: number; +} | { + protocol: Protocols.ZWave; + type: ZWaveFrameType.BeamStop; +} | { + protocol: Protocols.ZWaveLongRange; + type: LongRangeFrameType.BeamStop; +}); + +export { BeamingInfo } + export { buffer2hex } // Warning: (ae-forgotten-export) The symbol "ControllerEventCallbacks" needs to be exported by the entry point index.d.ts @@ -265,6 +309,18 @@ export { ControllerStatus } export { ControllerValueLogContext } +// Warning: (ae-missing-release-tag) "CorruptedFrame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type CorruptedFrame = { + channel: number; + region: number; + rssiRaw: number; + rssi?: RSSI_2; + protocolDataRate: ZnifferProtocolDataRate; + payload: Buffer; +}; + // Warning: (ae-missing-release-tag) "createDefaultBehaviors" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public @@ -307,9 +363,9 @@ export class DeviceClass { readonly basic: BasicDeviceClass; // (undocumented) readonly generic: GenericDeviceClass; - // (undocumented) + // @deprecated (undocumented) get mandatoryControlledCCs(): readonly CommandClasses[]; - // (undocumented) + // @deprecated (undocumented) get mandatorySupportedCCs(): readonly CommandClasses[]; // (undocumented) readonly specific: SpecificDeviceClass; @@ -350,12 +406,15 @@ export class Driver extends TypedEventEmitter implements Z local?: boolean; remote?: boolean; }): Promise; + // (undocumented) + exceedsMaxPayloadLength(msg: SendDataMessage): boolean; getConservativeWaitTimeAfterFirmwareUpdate(advertisedWaitTime: number | undefined): number; // (undocumented) getDeviceConfig(nodeId: number): DeviceConfig | undefined; // (undocumented) getHighestSecurityClass(nodeId: number): MaybeNotKnown; getLogConfig(): LogConfig; + getMaxPayloadLength(msg: SendDataMessage): number; readonly getNextCallbackId: () => number; getNextSupervisionSessionId(nodeId: number): number; readonly getNextTransportServiceSessionId: () => number; @@ -365,7 +424,7 @@ export class Driver extends TypedEventEmitter implements Z // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - getSafeCCVersion(cc: CommandClasses_2, nodeId: number, endpointIndex?: number): number; + getSafeCCVersion(cc: CommandClasses, nodeId: number, endpointIndex?: number): number; // Warning: (ae-forgotten-export) The symbol "SendDataMulticastRequest" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "SendDataMulticastBridgeRequest" needs to be exported by the entry point index.d.ts getSendDataMulticastConstructor(): typeof SendDataMulticastRequest | typeof SendDataMulticastBridgeRequest; @@ -373,7 +432,7 @@ export class Driver extends TypedEventEmitter implements Z // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - getSupportedCCVersion(cc: CommandClasses_2, nodeId: number, endpointIndex?: number): number; + getSupportedCCVersion(cc: CommandClasses, nodeId: number, endpointIndex?: number): number; getUserAgentStringWithComponents(components?: Record): string; getValueDB(nodeId: number): ValueDB; hardReset(): Promise; @@ -386,7 +445,7 @@ export class Driver extends TypedEventEmitter implements Z // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - isCCSecure(ccId: CommandClasses_2, nodeId: number, endpointIndex?: number): boolean; + isCCSecure(ccId: CommandClasses, nodeId: number, endpointIndex?: number): boolean; isControllerNode(nodeId: number): boolean; // (undocumented) isInBootloader(): boolean; @@ -516,42 +575,41 @@ export class Endpoint implements IZWaveEndpoint { constructor( nodeId: number, driver: Driver, - index: number, deviceClass?: DeviceClass, supportedCCs?: CommandClasses_2[]); + index: number, deviceClass?: DeviceClass, supportedCCs?: CommandClasses[]); // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen - addCC(cc: CommandClasses_2, info: Partial): void; - protected addMandatoryCC(cc: CommandClasses_2, info: Partial): void; - protected applyDeviceClass(deviceClass?: DeviceClass): void; - buildCCInterviewGraph(skipCCs: CommandClasses_2[]): GraphNode[]; + addCC(cc: CommandClasses, info: Partial): void; + buildCCInterviewGraph(skipCCs: CommandClasses[]): GraphNode[]; get commandClasses(): CCAPIs; - controlsCC(cc: CommandClasses_2): boolean; - createCCInstance(cc: CommandClasses_2 | CCConstructor): T | undefined; - createCCInstanceUnsafe(cc: CommandClasses_2 | CCConstructor): T | undefined; + controlsCC(cc: CommandClasses): boolean; + createCCInstance(cc: CommandClasses | CCConstructor): T | undefined; + createCCInstanceUnsafe(cc: CommandClasses | CCConstructor): T | undefined; // (undocumented) get deviceClass(): MaybeNotKnown; protected set deviceClass(deviceClass: MaybeNotKnown); protected readonly driver: Driver; get endpointLabel(): string | undefined; // (undocumented) - getCCs(): Iterable<[ccId: CommandClasses_2, info: CommandClassInfo]>; - getCCVersion(cc: CommandClasses_2): number; + getCCs(): Iterable<[ccId: CommandClasses, info: CommandClassInfo]>; + getCCVersion(cc: CommandClasses): number; getNodeUnsafe(): ZWaveNode | undefined; getSupportedCCInstances(): readonly CommandClass[]; hideBasicCCInFavorOfActuatorCCs(): void; readonly index: number; get installerIcon(): MaybeNotKnown; - invokeCCAPI any> = CommandClasses_2 extends CC ? any : Omit extends CC ? any : APIMethodsOf>(cc: CC, method: TMethod, ...args: Parameters): ReturnType; - isCCSecure(cc: CommandClasses_2): boolean; + invokeCCAPI any> = CommandClasses extends CC ? any : Omit extends CC ? any : APIMethodsOf>(cc: CC, method: TMethod, ...args: Parameters): ReturnType; + isCCSecure(cc: CommandClasses): boolean; maybeAddBasicCCAsFallback(): void; maySupportBasicCC(): boolean; readonly nodeId: number; removeBasicCCSupportIfForbidden(): void; - removeCC(cc: CommandClasses_2): void; + removeCC(cc: CommandClasses): void; protected reset(): void; - supportsCC(cc: CommandClasses_2): boolean; + supportsCC(cc: CommandClasses): boolean; supportsCCAPI(cc: CCNameOrId): boolean; get userIcon(): MaybeNotKnown; // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "IZWaveEndpoint" readonly virtual = false; + wasCCRemovedViaConfig(cc: CommandClasses): boolean; } export { EntryControlDataTypes } @@ -574,6 +632,18 @@ export enum ExclusionStrategy { Unprovision = 2 } +// Warning: (ae-missing-release-tag) "ExplorerFrameCommand" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum ExplorerFrameCommand { + // (undocumented) + InclusionRequest = 1, + // (undocumented) + Normal = 0, + // (undocumented) + SearchResult = 2 +} + export { extractFirmware } export { FileSystem } @@ -641,15 +711,20 @@ export function formatRouteHealthCheckSummary(sourceNodeId: number, targetNodeId // @public export interface FoundNode { // (undocumented) - controlledCCs?: CommandClasses[]; + controlledCCs?: CommandClasses_2[]; // (undocumented) deviceClass?: DeviceClass; // (undocumented) id: number; // (undocumented) - supportedCCs?: CommandClasses[]; + supportedCCs?: CommandClasses_2[]; } +// Warning: (ae-missing-release-tag) "Frame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type Frame = ZWaveFrame | LongRangeFrame | BeamFrame; + export { FunctionType } export { getEnumMemberName } @@ -795,6 +870,78 @@ export interface LifelineRoutes { nlwr?: RouteStatistics; } +// Warning: (ae-missing-release-tag) "LongRangeFrame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type LongRangeFrame = { + protocol: Protocols.ZWaveLongRange; + channel: number; + region: ZnifferRegion; + protocolDataRate: ZnifferProtocolDataRate; + rssiRaw: number; + rssi?: RSSI_2; + noiseFloor: RSSI_2; + txPower: number; + sequenceNumber: number; + homeId: number; + sourceNodeId: number; + destinationNodeId: number; +} & ({ + type: LongRangeFrameType.Singlecast; + ackRequested: boolean; + payload: Buffer | CommandClass; +} | { + type: LongRangeFrameType.Ack; + incomingRSSI: RSSI_2; + payload: Buffer; +}); + +// Warning: (ae-missing-release-tag) "LongRangeFrameType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public +export enum LongRangeFrameType { + // (undocumented) + Ack = 1, + // (undocumented) + BeamStart = 2, + // (undocumented) + BeamStop = 3, + // (undocumented) + Singlecast = 0 +} + +// Warning: (ae-missing-release-tag) "LongRangeMPDU" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class LongRangeMPDU implements MPDU { + // Warning: (ae-forgotten-export) The symbol "MPDUOptions" needs to be exported by the entry point index.d.ts + constructor(options: MPDUOptions); + // (undocumented) + readonly ackRequested: boolean; + // (undocumented) + readonly destinationNodeId: number; + // (undocumented) + readonly frameInfo: ZnifferFrameInfo; + // (undocumented) + static from(msg: ZnifferDataMessage): LongRangeMPDU; + // (undocumented) + readonly headerType: MPDUHeaderType_2; + // (undocumented) + readonly homeId: number; + // (undocumented) + readonly noiseFloor: RSSI_2; + // (undocumented) + payload: Buffer; + // (undocumented) + readonly sequenceNumber: number; + // (undocumented) + readonly sourceNodeId: number; + // (undocumented) + toLogEntry(): MessageOrCCLogEntry; + // (undocumented) + readonly txPower: number; +} + export { Message } export { MessageOptions } @@ -803,6 +950,28 @@ export { MessagePriority } export { MessageType } +// Warning: (ae-missing-release-tag) "MPDU" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface MPDU { + // (undocumented) + ackRequested: boolean; + // (undocumented) + frameInfo: ZnifferFrameInfo; + // (undocumented) + headerType: MPDUHeaderType_2; + // (undocumented) + homeId: number; + // (undocumented) + payload: Buffer; + // (undocumented) + sequenceNumber: number; + // (undocumented) + sourceNodeId: number; +} + +export { MPDUHeaderType } + export { MultilevelSwitchCommand } export { NODE_ID_BROADCAST } @@ -842,6 +1011,11 @@ export { NodeType } export { num2hex } +// Warning: (ae-missing-release-tag) "parseMPDU" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export function parseMPDU(frame: ZnifferDataMessage): ZWaveMPDU | LongRangeMPDU; + export { parseQRCodeString } // Warning: (ae-missing-release-tag) "PartialZWaveOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -975,7 +1149,7 @@ export { RouteProtocolDataRate } // // @public (undocumented) export interface RouteStatistics { - protocolDataRate: ProtocolDataRate_2; + protocolDataRate?: ProtocolDataRate_2; repeaterRSSI?: RSSI_2[]; repeaters: number[]; routeFailedBetween?: [number, number]; @@ -1086,15 +1260,15 @@ export class VirtualEndpoint implements IVirtualEndpoint { index: number); get commandClasses(): CCAPIs; protected readonly driver: Driver; - getCCVersion(cc: CommandClasses): number; + getCCVersion(cc: CommandClasses_2): number; readonly index: number; - invokeCCAPI any> = CommandClasses extends CC ? any : Omit extends CC ? any : APIMethodsOf>(cc: CC, method: TMethod, ...args: Parameters): ReturnType; + invokeCCAPI any> = CommandClasses_2 extends CC ? any : Omit extends CC ? any : APIMethodsOf>(cc: CC, method: TMethod, ...args: Parameters): ReturnType; // (undocumented) get node(): VirtualNode; // (undocumented) get nodeId(): number | MulticastDestination; - supportsCC(cc: CommandClasses): boolean; - supportsCCAPI(cc: CommandClasses): boolean; + supportsCC(cc: CommandClasses_2): boolean; + supportsCCAPI(cc: CommandClasses_2): boolean; // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "IZWaveEndpoint" readonly virtual = true; } @@ -1131,6 +1305,36 @@ export interface VirtualValueID extends TranslatedValueID_2 { metadata: ValueMetadata_2; } +// Warning: (ae-forgotten-export) The symbol "ZnifferEventCallbacks" needs to be exported by the entry point index.d.ts +// Warning: (ae-missing-release-tag) "Zniffer" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class Zniffer extends TypedEventEmitter { + constructor(port: string | ZWaveSerialPortImplementation, options?: ZnifferOptions); + get currentFrequency(): number | undefined; + // (undocumented) + init(): Promise; + saveCaptureToFile(filePath: string): Promise; + // (undocumented) + setFrequency(frequency: number): Promise; + start(): Promise; + // (undocumented) + stop(): Promise; + get supportedFrequencies(): ReadonlyMap; +} + +// Warning: (ae-missing-release-tag) "ZnifferOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export interface ZnifferOptions { + convertRSSI?: boolean; + // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "ZnifferRegion" + defaultFrequency?: number; + logConfig?: Partial; + securityKeys?: ZWaveOptions["securityKeys"]; + securityKeysLongRange?: ZWaveOptions["securityKeysLongRange"]; +} + export { ZWaveApiVersion } // Warning: (ae-forgotten-export) The symbol "ControllerStatisticsHost" needs to be exported by the entry point index.d.ts @@ -1213,6 +1417,11 @@ export class ZWaveController extends TypedEventEmitter // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "assignCustomSUCReturnRoutes" getCustomSUCReturnRoutesCached(nodeId: number): Route[]; getKnownLifelineRoutes(): ReadonlyMap; + getLongRangeChannel(): Promise<{ + channel: LongRangeChannel; + supportsAutoChannelSelection: boolean; + }>; + getMaxLongRangePowerlevel(): Promise; getMulticastGroup(nodeIDs: number[]): VirtualNode; getNodeByDSK(dsk: Buffer | string): ZWaveNode | undefined; getNodeNeighbors(nodeId: number, onlyRepeaters?: boolean): Promise; @@ -1253,8 +1462,14 @@ export class ZWaveController extends TypedEventEmitter get isSUC(): MaybeNotKnown; // (undocumented) get isUsingHomeIdFromOtherNetwork(): MaybeNotKnown; + // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "setLongRangeChannel" + get longRangeChannel(): MaybeNotKnown; // (undocumented) get manufacturerId(): MaybeNotKnown; + // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "setMaxLongRangePowerlevel" + get maxLongRangePowerlevel(): MaybeNotKnown; + get maxPayloadSize(): MaybeNotKnown; + get maxPayloadSizeLR(): MaybeNotKnown; get nodeIdType(): NodeIDType; get nodes(): ReadonlyThrowingMap; // (undocumented) @@ -1294,6 +1509,8 @@ export class ZWaveController extends TypedEventEmitter sdkVersionGte(version: SDKVersion): MaybeNotKnown; sdkVersionLt(version: SDKVersion): MaybeNotKnown; sdkVersionLte(version: SDKVersion): MaybeNotKnown; + setLongRangeChannel(channel: LongRangeChannel.A | LongRangeChannel.B | LongRangeChannel.Auto): Promise; + setMaxLongRangePowerlevel(limit: number): Promise; setPowerlevel(powerlevel: number, measured0dBm: number): Promise; // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen @@ -1312,6 +1529,7 @@ export class ZWaveController extends TypedEventEmitter get supportedSerialAPISetupCommands(): readonly SerialAPISetupCommand[] | undefined; supportsFeature(feature: ZWaveFeature): MaybeNotKnown; get supportsLongRange(): MaybeNotKnown; + get supportsLongRangeAutoChannelSelection(): MaybeNotKnown; // (undocumented) get supportsTimers(): MaybeNotKnown; toggleRF(enabled: boolean): Promise; @@ -1325,8 +1543,6 @@ export class ZWaveController extends TypedEventEmitter get wasRealPrimary(): MaybeNotKnown; // (undocumented) get zwaveApiVersion(): MaybeNotKnown; - // Warning: (ae-forgotten-export) The symbol "UnknownZWaveChipType" needs to be exported by the entry point index.d.ts - // // (undocumented) get zwaveChipType(): MaybeNotKnown; } @@ -1343,6 +1559,91 @@ export enum ZWaveFeature { SmartStart = 0 } +// Warning: (ae-missing-release-tag) "ZWaveFrame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type ZWaveFrame = { + protocol: Protocols.ZWave; + channel: number; + region: number; + rssiRaw: number; + rssi?: RSSI_2; + protocolDataRate: ZnifferProtocolDataRate; + speedModified: boolean; + sequenceNumber: number; + homeId: number; + sourceNodeId: number; +} & (({ + type: ZWaveFrameType.Singlecast; + destinationNodeId: number; + ackRequested: boolean; + payload: Buffer | CommandClass; +} & AllOrNone<{ + direction: "outbound" | "inbound"; + hop: number; + repeaters: number[]; + repeaterRSSI?: RSSI_2[]; +} & ({ + routedAck: false; + routedError: false; + failedHop?: undefined; +} | { + routedAck: true; + routedError: false; + failedHop?: undefined; +} | { + routedAck: false; + routedError: true; + failedHop: number; +})>) | { + type: ZWaveFrameType.Multicast; + destinationNodeIds: number[]; + payload: Buffer | CommandClass; +} | { + type: ZWaveFrameType.AckDirect; + destinationNodeId: number; +} | (({ + type: ZWaveFrameType.ExplorerNormal; + payload: Buffer | CommandClass; +} | { + type: ZWaveFrameType.ExplorerSearchResult; + searchingNodeId: number; + frameHandle: number; + resultTTL: number; + resultRepeaters: readonly number[]; +} | { + type: ZWaveFrameType.ExplorerInclusionRequest; + networkHomeId: number; +}) & { + destinationNodeId: number; + ackRequested: boolean; + direction: "outbound" | "inbound"; + repeaters: number[]; + ttl: number; +})); + +// Warning: (ae-missing-release-tag) "ZWaveFrameType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export enum ZWaveFrameType { + // (undocumented) + AckDirect = 2, + // (undocumented) + BeamStart = 6, + // (undocumented) + BeamStop = 7, + // (undocumented) + ExplorerInclusionRequest = 5, + // (undocumented) + ExplorerNormal = 3, + // (undocumented) + ExplorerSearchResult = 4, + // (undocumented) + Multicast = 1, + // (undocumented) + Singlecast = 0 +} + // Warning: (ae-missing-release-tag) "ZWaveInterviewFailedCallback" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -1350,6 +1651,41 @@ export type ZWaveInterviewFailedCallback = (node: ZWaveNode, args: NodeInterview export { ZWaveLibraryTypes } +// Warning: (ae-missing-release-tag) "ZWaveMPDU" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export class ZWaveMPDU implements MPDU { + constructor(options: MPDUOptions); + // (undocumented) + readonly ackRequested: boolean; + // (undocumented) + readonly beamingInfo: BeamingInfo_2; + // (undocumented) + protected readonly destinationBuffer: Buffer; + // (undocumented) + readonly frameInfo: ZnifferFrameInfo; + // (undocumented) + static from(msg: ZnifferDataMessage): ZWaveMPDU; + // (undocumented) + readonly headerType: MPDUHeaderType_2; + // (undocumented) + readonly homeId: number; + // (undocumented) + readonly lowPower: boolean; + // (undocumented) + payload: Buffer; + // (undocumented) + readonly routed: boolean; + // (undocumented) + readonly sequenceNumber: number; + // (undocumented) + readonly sourceNodeId: number; + // (undocumented) + readonly speedModified: boolean; + // (undocumented) + toLogEntry(): MessageOrCCLogEntry; +} + // Warning: (ae-forgotten-export) The symbol "StatisticsEventCallbacksWithSelf" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "NodeStatisticsHost" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "ZWaveNode" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -1361,7 +1697,7 @@ export interface ZWaveNode extends TypedEventEmitter; // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "checkLifelineHealth" // Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "checkRouteHealth" @@ -1414,7 +1750,7 @@ export class ZWaveNode extends Endpoint implements SecurityClassOwner, IZWaveNod get individualEndpointCount(): MaybeNotKnown; interview(): Promise; get interviewAttempts(): number; - interviewCC(cc: CommandClasses_2): Promise; + interviewCC(cc: CommandClasses): Promise; protected interviewCCs(): Promise; protected interviewNodeInfo(): Promise; get interviewStage(): InterviewStage; @@ -1454,7 +1790,7 @@ export class ZWaveNode extends Endpoint implements SecurityClassOwner, IZWaveNod get protocolVersion(): MaybeNotKnown; protected queryProtocolInfo(): Promise; get ready(): boolean; - refreshCCValues(cc: CommandClasses_2): Promise; + refreshCCValues(cc: CommandClasses): Promise; refreshInfo(options?: RefreshInfoOptions): Promise; refreshValues(): Promise; // (undocumented) @@ -1663,7 +1999,7 @@ export interface ZWaveNotificationCallbackArgs_PowerlevelCC { // @public export type ZWaveNotificationCallbackParams_EntryControlCC = [ endpoint: Endpoint, -ccId: (typeof CommandClasses)["Entry Control"], +ccId: (typeof CommandClasses_2)["Entry Control"], args: ZWaveNotificationCallbackArgs_EntryControlCC ]; @@ -1672,7 +2008,7 @@ args: ZWaveNotificationCallbackArgs_EntryControlCC // @public export type ZWaveNotificationCallbackParams_MultilevelSwitchCC = [ endpoint: Endpoint, -ccId: (typeof CommandClasses)["Multilevel Switch"], +ccId: (typeof CommandClasses_2)["Multilevel Switch"], args: ZWaveNotificationCallbackArgs_MultilevelSwitchCC ]; @@ -1681,7 +2017,7 @@ args: ZWaveNotificationCallbackArgs_MultilevelSwitchCC // @public export type ZWaveNotificationCallbackParams_NotificationCC = [ endpoint: Endpoint, -ccId: CommandClasses.Notification, +ccId: CommandClasses_2.Notification, args: ZWaveNotificationCallbackArgs_NotificationCC ]; @@ -1690,7 +2026,7 @@ args: ZWaveNotificationCallbackArgs_NotificationCC // @public export type ZWaveNotificationCallbackParams_PowerlevelCC = [ endpoint: Endpoint, -ccId: CommandClasses.Powerlevel, +ccId: CommandClasses_2.Powerlevel, args: ZWaveNotificationCallbackArgs_PowerlevelCC ]; @@ -1736,6 +2072,8 @@ export interface ZWaveOptions extends ZWaveHostOptions { powerlevel: number; measured0dBm: number; }; + maxLongRangePowerlevel?: number; + longRangeChannel?: LongRangeChannel.A | LongRangeChannel.B | LongRangeChannel.Auto; }; securityKeys?: { S2_AccessControl?: Buffer; @@ -1783,6 +2121,23 @@ export interface ZWaveOptions extends ZWaveHostOptions { export * from "@zwave-js/cc"; +// Warnings were encountered during analysis: +// +// src/lib/controller/Controller.ts:812:2 - (ae-missing-getter) The property "provisioningList" has a setter but no getter. +// src/lib/driver/Driver.ts:690:24 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag +// src/lib/driver/Driver.ts:4070:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/lib/driver/Driver.ts:5130:2 - (ae-unresolved-link) The @link reference could not be resolved: The package "zwave-js" does not have an export "drainSerialAPIQueue" +// src/lib/driver/Driver.ts:5533:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/lib/driver/Driver.ts:5534:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/lib/driver/Driver.ts:5576:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/lib/driver/Driver.ts:5577:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/lib/driver/Driver.ts:5713:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/lib/node/Node.ts:913:2 - (ae-missing-getter) The property "associations" has a setter but no getter. +// src/lib/node/Node.ts:1004:2 - (ae-missing-getter) The property "deviceConfigHash" has a setter but no getter. +// src/lib/node/Node.ts:2892:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/lib/zniffer/Zniffer.ts:562:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen +// src/lib/zniffer/Zniffer.ts:563:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen + // (No @packageDocumentation comment for this package) ```