docs: update typed documentation and API report

zwave-js · Jun 24, 2024 · 70af318 · 70af318
1 parent 59bda8c
commit 70af318
Show file tree

Hide file tree

Showing 6 changed files with 205 additions and 125 deletions.
diff --git a/docs/api/CCs/Notification.md b/docs/api/CCs/Notification.md
@@ -114,6 +114,27 @@ async getSupportedEvents(
 - **min. value:** 0
 - **max. value:** 255
 
+### `doorTiltState`
+
+```ts
+{
+	commandClass: CommandClasses.Notification,
+	endpoint: number,
+	property: "Access Control",
+	propertyKey: "Door tilt state",
+}
+```
+
+- **label:** Door tilt state
+- **min. CC version:** 1
+- **readable:** true
+- **writeable:** false
+- **stateful:** true
+- **secret:** false
+- **value type:** `"number"`
+- **min. value:** 0
+- **max. value:** 255
+
 ### `notificationVariable(notificationName: string, variableName: string)`
 
 ```ts

diff --git a/docs/api/driver.md b/docs/api/driver.md
@@ -898,6 +898,14 @@ interface ZWaveOptions extends ZWaveHostOptions {
 		 * Default: `true`, except when the ZWAVEJS_DISABLE_UNRESPONSIVE_CONTROLLER_RECOVERY env variable is set.
 		 */
 		unresponsiveControllerRecovery?: boolean;
+
+		/**
+		 * Controllers of the 700 series and newer have a hardware watchdog that can be enabled to automatically
+		 * reset the chip in case it becomes unresponsive. This option controls whether the watchdog should be enabled.
+		 *
+		 * Default: `true`, except when the ZWAVEJS_DISABLE_WATCHDOG env variable is set.
+		 */
+		watchdog?: boolean;
 	};
 	preferences: {
 		/**

diff --git a/packages/cc/api.md b/packages/cc/api.md
@@ -13357,6 +13357,43 @@ export const NotificationCCValues: Readonly<{
             readonly supportsEndpoints: false;
         };
     };
+    doorTiltState: {
+        readonly id: {
+            commandClass: CommandClasses.Notification;
+            property: "Access Control";
+            propertyKey: "Door tilt state";
+        };
+        readonly endpoint: (endpoint?: number | undefined) => {
+            readonly commandClass: CommandClasses.Notification;
+            readonly endpoint: number;
+            readonly property: "Access Control";
+            readonly propertyKey: "Door tilt state";
+        };
+        readonly is: (valueId: ValueID_2) => boolean;
+        readonly meta: {
+            readonly label: "Door tilt state";
+            readonly states: {
+                readonly 0: "Window/door is not tilted";
+                readonly 1: "Window/door is tilted";
+            };
+            readonly ccSpecific: {
+                readonly notificationType: 6;
+            };
+            readonly writeable: false;
+            readonly min: 0;
+            readonly max: 255;
+            readonly type: "number";
+            readonly readable: true;
+        };
+        readonly options: {
+            readonly stateful: true;
+            readonly secret: false;
+            readonly internal: false;
+            readonly minVersion: 1;
+            readonly supportsEndpoints: true;
+            readonly autoCreate: false;
+        };
+    };
     doorStateSimple: {
         readonly id: {
             commandClass: CommandClasses.Notification;

diff --git a/packages/core/api.md b/packages/core/api.md
@@ -3302,6 +3302,13 @@ export interface ValueUpdatedArgs extends ValueID {
     source?: "driver" | "node";
 }
 
+// Warning: (ae-missing-release-tag) "wasControllerReset" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function wasControllerReset(e: unknown): e is ZWaveError & {
+    code: ZWaveErrorCodes.Controller_Reset;
+};
+
 // 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)
@@ -3414,7 +3421,7 @@ export enum ZWaveErrorCodes {
     // (undocumented)
     CC_NoAPI = 304,
     // (undocumented)
-    CC_NoNodeID = 301,
+    CC_NoNodeID = 301,// FIXME: This is not used
     // (undocumented)
     CC_NotImplemented = 303,
     // (undocumented)
@@ -3433,24 +3440,25 @@ export enum ZWaveErrorCodes {
     ConfigurationCC_NoResetToDefaultOnLegacyDevices = 1002,
     // (undocumented)
     Controller_CallbackNOK = 204,
-    Controller_CommandError = 215,
-    Controller_EndpointNotFound = 211,
+    Controller_CommandError = 216,
+    Controller_EndpointNotFound = 212,
     // (undocumented)
-    Controller_ExclusionFailed = 207,
+    Controller_ExclusionFailed = 208,
     // (undocumented)
-    Controller_InclusionFailed = 206,
-    Controller_InterviewRestarted = 209,
+    Controller_InclusionFailed = 207,
+    Controller_InterviewRestarted = 210,
     // (undocumented)
     Controller_Jammed = 205,
     // (undocumented)
     Controller_MessageDropped = 202,
-    Controller_MessageExpired = 214,
-    Controller_MessageTooLarge = 216,
-    Controller_NodeInsecureCommunication = 213,
-    Controller_NodeNotFound = 210,
-    Controller_NodeRemoved = 212,
+    Controller_MessageExpired = 215,
+    Controller_MessageTooLarge = 217,
+    Controller_NodeInsecureCommunication = 214,
+    Controller_NodeNotFound = 211,
+    Controller_NodeRemoved = 213,
     Controller_NodeTimeout = 201,
-    Controller_NotSupported = 208,
+    Controller_NotSupported = 209,
+    Controller_Reset = 206,
     // (undocumented)
     Controller_ResponseNOK = 203,
     Controller_Timeout = 200,