feat: add dump node action (#3768)

zwave-js · Jun 13, 2024 · f07a854 · f07a854
1 parent c12448c
commit f07a854
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 2 deletions.
diff --git a/api/lib/ZwaveClient.ts b/api/lib/ZwaveClient.ts
@@ -203,6 +203,7 @@ export const allowedApis = validateMethods([
 	'updateFirmware',
 	'firmwareUpdateOTW',
 	'abortFirmwareUpdate',
+	'dumpNode',
 	'getAvailableFirmwareUpdates',
 	'firmwareUpdateOTA',
 	'sendCommand',
@@ -3898,6 +3899,20 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
 		}
 	}
 
+	dumpNode(nodeId: number) {
+		if (this.driverReady) {
+			const zwaveNode = this.getNode(nodeId)
+
+			if (!zwaveNode) {
+				throw Error(`Node ${nodeId} not found`)
+			}
+
+			return zwaveNode.createDump()
+		}
+
+		throw new DriverNotReadyError()
+	}
+
 	beginRebuildingRoutes(options?: RebuildRoutesOptions): boolean {
 		if (this.driverReady) {
 			return this._driver.controller.beginRebuildingRoutes(options)

diff --git a/docs/guide/mqtt.md b/docs/guide/mqtt.md
@@ -1913,6 +1913,29 @@ Payload:
 
 </details>
 
+#### `dumpNode`
+
+```ts
+dumpNode(nodeId: number): import("/home/daniel/GitProjects/zwave-js-ui/node_modules/zwave-js/build/lib/node/Dump").NodeDump;
+```
+
+<details>
+<summary>Mqtt usage</summary>
+
+Topic: `zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/dumpNode/set`
+
+Payload:
+
+```json
+{
+	"args": [
+		nodeId
+	]
+}
+```
+
+</details>
+
 #### `beginRebuildingRoutes`
 
 ```ts

diff --git a/package.json b/package.json
@@ -28,7 +28,7 @@
     "dev": "vite",
     "dev-https": "SERVER_SSL='true' npm run dev",
     "dev:server": "nodemon",
-    "server": "ts-node -r esbuild-register api/bin/www.ts",
+    "server": "node -r ./esbuild-register.js api/bin/www.ts",
     "fake-stick": "npx mock-server -- -c server_config.js",
     "start": "node --preserve-symlinks server/bin/www.js",
     "bundle": "node esbuild.js",

diff --git a/src/components/nodes-table/ExpandedNode.vue b/src/components/nodes-table/ExpandedNode.vue
@@ -518,7 +518,10 @@ export default {
 			return [
 				{
 					text: 'Export json',
-					options: [{ name: 'Export', action: 'exportNode' }],
+					options: [
+						{ name: 'Export', action: 'exportNode' },
+						{ name: 'Dump', action: 'dumpNode' },
+					],
 					icon: 'get_app',
 					desc: 'Export this node in a json file',
 				},

diff --git a/src/mixins/InstancesMixin.js b/src/mixins/InstancesMixin.js
@@ -577,6 +577,14 @@ export default {
 								this.app.handleFwUpdateResponse(response)
 								break
 
+							case 'dumpNode':
+								this.app.exportConfiguration(
+									response.result,
+									'node_' + response.result.id + '_dump',
+									'json',
+								)
+								break
+
 							default:
 								this.showSnackbar(
 									`API ${response.api} ended successfully`,