feat: link reliability checks (#3814)

Co-authored-by: Dominic Griesel <dominic.griesel@nabucasa.com>

api/lib/SocketEvents.ts

@@ -21,6 +21,7 @@ export enum socketEvents {
 	inclusionAborted = 'INCLUSION_ABORTED',
 	znifferFrame = 'ZNIFFER_FRAME',
 	znifferState = 'ZNIFFER_STATE',
+	linkReliability = 'LINK_RELIABILITY',
 }
 
 // events from client ---> server

api/lib/ZwaveClient.ts

@@ -102,6 +102,7 @@ import {
 	InclusionUserCallbacks,
 	InclusionState,
 	ProvisioningEntryStatus,
+	LinkReliabilityCheckResult,
 } from 'zwave-js'
 import { getEnumMemberName, parseQRCodeString } from 'zwave-js/Utils'
 import { logsDir, nvmBackupsDir, storeDir } from '../config/app'
@@ -229,6 +230,8 @@ export const allowedApis = validateMethods([
 	'checkLifelineHealth',
 	'abortHealthCheck',
 	'checkRouteHealth',
+	'checkLinkReliability',
+	'abortLinkReliabilityCheck',
 	'syncNodeDateAndTime',
 	'manuallyIdleNotificationValue',
 	'getSchedules',
@@ -3682,6 +3685,32 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
 		throw new DriverNotReadyError()
 	}
 
+	async checkLinkReliability(
+		nodeId: number,
+		options: any,
+	): Promise<LinkReliabilityCheckResult> {
+		if (this.driverReady) {
+			const result = await this.getNode(nodeId).checkLinkReliability({
+				...options,
+				onProgress: (progress) =>
+					this._onLinkReliabilityCheckProgress({ nodeId }, progress),
+			})
+
+			return result
+		}
+
+		throw new DriverNotReadyError()
+	}
+
+	abortLinkReliabilityCheck(nodeId: number): void {
+		if (this.driverReady) {
+			this.getNode(nodeId).abortLinkReliabilityCheck()
+			return
+		}
+
+		throw new DriverNotReadyError()
+	}
+
 	/**
 	 * Check node routes health
 	 */
@@ -4781,6 +4810,18 @@ class ZwaveClient extends TypedEventEmitter<ZwaveClientEventCallbacks> {
 		})
 	}
 
+	private _onLinkReliabilityCheckProgress(
+		request: { nodeId: number },
+		...args: any[]
+	) {
+		// const message = `Link statistics ${request.nodeId}: ${args.join(', ')}`
+		// this._updateControllerStatus(message)
+		this.sendToSocket(socketEvents.linkReliability, {
+			request,
+			args,
+		})
+	}
+
 	private _onRebuildRoutesDone(result) {
 		const message = `Rebuild Routes process COMPLETED. Healed ${result.size} nodes`
 		this._updateControllerStatus(message)

src/components/custom/NodePanel.vue

@@ -293,6 +293,16 @@
 						<v-icon>monitor_heart</v-icon>
 					</v-btn>
 				</v-col>
+				<v-col class="pa-1">
+					<v-btn
+						color="purple"
+						small
+						rounded
+						@click="dialogLinkReliability = true"
+						>Link Statistics
+						<v-icon>leak_add</v-icon>
+					</v-btn>
+				</v-col>
 				<v-col v-if="!isLongRange" class="pa-1">
 					<v-btn
 						color="error"
@@ -341,6 +351,15 @@
 			:socket="socket"
 			:node="node"
 		/>
+
+		<dialog-link-reliability
+			v-if="node && !node.isControllerNode"
+			v-model="dialogLinkReliability"
+			@close="dialogLinkReliability = false"
+			:socket="socket"
+			:node="node"
+		/>
+
 		<v-dialog
 			fullscreen
 			persistent
@@ -398,6 +417,8 @@ export default {
 		BgRssiChart: () => import('@/components/custom/BgRssiChart.vue'),
 		DialogHealthCheck: () =>
 			import('@/components/dialogs/DialogHealthCheck.vue'),
+		DialogLinkReliability: () =>
+			import('@/components/dialogs/DialogLinkReliability.vue'),
 		draggable,
 	},
 	props: {
@@ -416,6 +437,7 @@ export default {
 	data: () => ({
 		showFullscreen: false,
 		dialogHealth: false,
+		dialogLinkReliability: false,
 		discoverLoading: false,
 		routesChanged: false,
 		returnRoutes: [],