diff --git a/docs/guide/mqtt.md b/docs/guide/mqtt.md index 6d058e66d3c..31c97764553 100644 --- a/docs/guide/mqtt.md +++ b/docs/guide/mqtt.md @@ -567,6 +567,33 @@ Payload: +#### `setNodeDefaultSetValueOptions` + +```ts +setNodeDefaultSetValueOptions( + nodeId: number, + props: Pick +): void; +``` + +
+Mqtt usage + +Topic: `zwave/_CLIENTS/ZWAVE_GATEWAY-/api/setNodeDefaultSetValueOptions/set` + +Payload: + +```json +{ + "args": [ + nodeId, + props + ] +} +``` + +
+ #### `_createScene` ```ts @@ -1027,7 +1054,7 @@ Payload: async getAvailableFirmwareUpdates( nodeId: number, options?: GetFirmwareUpdatesOptions -): Promise; +): Promise<{ version: string; changelog: string; channel: "stable" | "beta"; files: FirmwareUpdateFileInfo[]; downgrade: boolean; normalizedVersion: string; device: { manufacturerId: number; productType: number; productId: number; firmwareVersion: string; rfRegion?: RFRegion; }; }[]>; ```
@@ -1065,7 +1092,7 @@ Payload: { "args": [ nodeId, - updates + updateInfo ] } ``` @@ -1405,7 +1432,8 @@ Payload: async assignCustomReturnRoutes( nodeId: number, destinationNodeId: number, - routes: Route[] + routes: Route[], + priorityRoute?: Route ): Promise; ``` @@ -1423,7 +1451,8 @@ Payload: "args": [ nodeId, destinationNodeId, - routes + routes, + priorityRoute ] } ``` @@ -1458,7 +1487,11 @@ Payload: #### `assignCustomSUCReturnRoutes` ```ts -async assignCustomSUCReturnRoutes(nodeId: number, routes: Route[]): Promise; +async assignCustomSUCReturnRoutes( + nodeId: number, + routes: Route[], + priorityRoute?: Route +): Promise; ``` Assigns up to 4 return routes to a node to the controller. @@ -1474,7 +1507,8 @@ Payload: { "args": [ nodeId, - routes + routes, + priorityRoute ] } ``` @@ -1698,6 +1732,31 @@ Payload:
+#### `abortHealthCheck` + +```ts +abortHealthCheck(nodeId: number): void; +``` + +Aborts an ongoing health check if one is currently in progress. + +
+Mqtt usage + +Topic: `zwave/_CLIENTS/ZWAVE_GATEWAY-/api/abortHealthCheck/set` + +Payload: + +```json +{ + "args": [ + nodeId + ] +} +``` + +
+ #### `isFailedNode` ```ts