From 6e26600666af4f8f144e754cee43260d44cb8c77 Mon Sep 17 00:00:00 2001 From: Al Calzone Date: Fri, 12 Apr 2024 12:50:02 +0000 Subject: [PATCH] docs: update typed documentation and API report --- docs/api/node.md | 2 +- packages/cc/api.md | 40 ++++---- packages/config/api.md | 2 + packages/core/api.md | 16 ++-- packages/nvmedit/api.md | 2 +- packages/serial/api.md | 200 +++++++++++++++++++-------------------- packages/zwave-js/api.md | 21 ++++ 7 files changed, 154 insertions(+), 129 deletions(-) diff --git a/docs/api/node.md b/docs/api/node.md index 04b8837e41e0..bd8e98b54689 100644 --- a/docs/api/node.md +++ b/docs/api/node.md @@ -946,7 +946,7 @@ If the `Z-Wave+` Command Class is supported, this returns the `Z-Wave+` node typ ```ts enum ZWavePlusNodeType { - Node = 0, + Node = 0, // ZWave+ Node IPGateway = 2, } ``` diff --git a/packages/cc/api.md b/packages/cc/api.md index 7df7f078144d..e16a819f20bc 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 } @@ -17676,25 +17676,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 +20525,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..20419d155acc 100644 --- a/packages/config/api.md +++ b/packages/config/api.md @@ -847,6 +847,8 @@ export class NotificationParameterWithDuration { export class NotificationParameterWithEnum { constructor(definition: JSONObject); // (undocumented) + readonly default?: number; + // (undocumented) readonly values: ReadonlyMap; } diff --git a/packages/core/api.md b/packages/core/api.md index 31004dd608ef..7e51dbf471e9 100644 --- a/packages/core/api.md +++ b/packages/core/api.md @@ -484,7 +484,7 @@ export enum ConfigValueFormat { // (undocumented) Enumerated = 2, // (undocumented) - SignedInteger = 0, + SignedInteger = 0,// UnsignedInt, Radio Buttons // (undocumented) UnsignedInteger = 1 } @@ -504,15 +504,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 } @@ -1464,7 +1464,7 @@ export type LogValueArgs = T & { // @public (undocumented) export enum LongRangeChannel { // (undocumented) - A = 1, + A = 1,// Reserved // (undocumented) B = 2, // (undocumented) @@ -3488,6 +3488,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..a437df9aa15b 100644 --- a/packages/serial/api.md +++ b/packages/serial/api.md @@ -109,9 +109,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 +121,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 +321,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 +331,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 +351,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) diff --git a/packages/zwave-js/api.md b/packages/zwave-js/api.md index 95641e46a315..a466a994bbad 100644 --- a/packages/zwave-js/api.md +++ b/packages/zwave-js/api.md @@ -350,12 +350,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; @@ -552,6 +555,7 @@ export class Endpoint implements IZWaveEndpoint { 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_2): boolean; } export { EntryControlDataTypes } @@ -1255,6 +1259,8 @@ export class ZWaveController extends TypedEventEmitter get isUsingHomeIdFromOtherNetwork(): MaybeNotKnown; // (undocumented) get manufacturerId(): MaybeNotKnown; + get maxPayloadSize(): MaybeNotKnown; + get maxPayloadSizeLR(): MaybeNotKnown; get nodeIdType(): NodeIDType; get nodes(): ReadonlyThrowingMap; // (undocumented) @@ -1783,6 +1789,21 @@ export interface ZWaveOptions extends ZWaveHostOptions { export * from "@zwave-js/cc"; +// Warnings were encountered during analysis: +// +// src/lib/controller/Controller.ts:788: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:2893: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) ```