feat: ping node (#1255)

Fixes #1253
zwave-js · May 21, 2021 · 2fc61ef · 2fc61ef
1 parent 79e283a
commit 2fc61ef
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 2 deletions.
diff --git a/docs/guide/mqtt.md b/docs/guide/mqtt.md
@@ -64,6 +64,7 @@ This are the available apis:
 - `removeAllAssociations(nodeId)`: Remove all associations of a specific node
 - `removeNodeFromAllAssociations(nodeId)`: Remove a node from all associations
 - `refreshValues(nodeId)`: Refresh all node values
+- `pingNode(nodeId)`: Ping a node
 - `pollValue(valueId)`: Polls a value from the node
 - `startInclusion()`: Starts the inclusion
 - `startExclusion()`: Starts the exclusion

diff --git a/lib/ZwaveClient.js b/lib/ZwaveClient.js
@@ -82,7 +82,8 @@ const allowedApis = [
   'writeMulticast',
   'driverFunction',
   'checkForConfigUpdates',
-  'installConfigUpdate'
+  'installConfigUpdate',
+  'pingNode'
 ]
 
 const ZWAVEJS_LOG_FILE = utils.joinPath(storeDir, `zwavejs_${process.pid}.log`)
@@ -1070,6 +1071,22 @@ class ZwaveClient extends EventEmitter {
     throw Error('Driver is closed')
   }
 
+  /**
+   * Ping a node
+   *
+   * @param {number} nodeId
+   * @returns {Promise<boolean>}
+   */
+  async pingNode (nodeId) {
+    if (this.driver && !this.closed) {
+      const zwaveNode = this.getNode(nodeId)
+
+      return zwaveNode.ping()
+    }
+
+    throw Error('Driver is closed')
+  }
+
   /**
    * Refresh all node values of a specific CC
    *

diff --git a/src/components/ControlPanel.vue b/src/components/ControlPanel.vue
@@ -3,7 +3,7 @@
     <v-card>
       <v-card-text>
         <v-container fluid>
-          <v-row justify="start">
+          <v-row style="max-width:800px" justify="start">
             <v-col cols="12" sm="4" md="3" style="text-align:center">
               <v-btn
                 depressed

diff --git a/src/components/nodes-table/NodeDetails.vue b/src/components/nodes-table/NodeDetails.vue
@@ -10,6 +10,14 @@
 
     <v-row>
       <v-col cols="8" style="max-width:300px">
+        <v-btn
+          dark
+          color="primary"
+          @click.stop="apiRequest('pingNode', [node.id])"
+          depressed
+        >
+          Ping
+        </v-btn>
         <v-btn dark color="green" depressed @click="advancedShowDialog = true">
           Advanced
         </v-btn>

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -382,6 +382,7 @@ export interface ZwaveClient extends EventEmitter {
   getNodes(): Z2MNode[]
   getInfo(): Map<string, any>
   refreshValues(nodeId: number): Promise<void>
+  pingNode(nodeId: number): Promise<boolean>
   setPollInterval(valueId: Z2MValueId, interval: number): void
   checkForConfigUpdates(): Promise<string | undefined>
   installConfigUpdate(): Promise<boolean>