zwave-js 9.2.1 → 9.3.0

package/build/lib/node/Node.js

@@ -1,13 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZWaveNode = void 0;
 const core_1 = require("@zwave-js/core");
+const serial_1 = require("@zwave-js/serial");
 const shared_1 = require("@zwave-js/shared");
 const math_1 = require("alcalzone-shared/math");
 const strings_1 = require("alcalzone-shared/strings");
@@ -42,7 +66,6 @@ const _Types_1 = require("../commandclass/_Types");
 const _Types_2 = require("../controller/_Types");
 const NetworkCache_1 = require("../driver/NetworkCache");
 const StateMachineShared_1 = require("../driver/StateMachineShared");
-const Constants_1 = require("../message/Constants");
 const ApplicationUpdateRequest_1 = require("../serialapi/application/ApplicationUpdateRequest");
 const GetNodeProtocolInfoMessages_1 = require("../serialapi/network-mgmt/GetNodeProtocolInfoMessages");
 const RequestNodeInfoMessages_1 = require("../serialapi/network-mgmt/RequestNodeInfoMessages");
@@ -52,6 +75,7 @@ const HealthCheck_1 = require("./HealthCheck");
 const NodeReadyMachine_1 = require("./NodeReadyMachine");
 const NodeStatistics_1 = require("./NodeStatistics");
 const NodeStatusMachine_1 = require("./NodeStatusMachine");
+const nodeUtils = __importStar(require("./utils"));
 const _Types_3 = require("./_Types");
 /**
  * A ZWaveNode represents a node in a Z-Wave network. It is also an instance
@@ -165,35 +189,12 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
             this.cancelScheduledPoll(valueId);
         }
     }
-    /**
-     * Enhances a value id so it can be consumed better by applications
-     */
-    translateValueID(valueId) {
-        // Try to retrieve the speaking CC name
-        const commandClassName = (0, core_1.getCCName)(valueId.commandClass);
-        const ret = {
-            commandClassName,
-            ...valueId,
-        };
-        const ccInstance = this.createCCInstanceInternal(valueId.commandClass);
-        if (!ccInstance) {
-            throw new core_1.ZWaveError(`Cannot translate a value ID for the non-implemented CC ${(0, core_1.getCCName)(valueId.commandClass)}`, core_1.ZWaveErrorCodes.CC_NotImplemented);
-        }
-        // Retrieve the speaking property name
-        ret.propertyName = ccInstance.translateProperty(valueId.property, valueId.propertyKey);
-        // Try to retrieve the speaking property key
-        if (valueId.propertyKey != undefined) {
-            const propertyKey = ccInstance.translatePropertyKey(valueId.property, valueId.propertyKey);
-            ret.propertyKeyName = propertyKey;
-        }
-        return ret;
-    }
     /**
      * Enhances the raw event args of the ValueDB so it can be consumed better by applications
      */
     translateValueEvent(eventName, arg) {
         // Try to retrieve the speaking CC name
-        const outArg = this.translateValueID(arg);
+        const outArg = nodeUtils.translateValueID(this.driver, this, arg);
         // @ts-expect-error This can happen for value updated events
         if ("source" in outArg)
             delete outArg.source;
@@ -202,7 +203,7 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
             outArg.metadata =
                 this.getValueMetadata(arg);
         }
-        const ccInstance = this.createCCInstanceInternal(arg.commandClass);
+        const ccInstance = CommandClass_1.CommandClass.createInstanceUnchecked(this.driver, this, arg.commandClass);
         const isInternalValue = ccInstance === null || ccInstance === void 0 ? void 0 : ccInstance.isInternalValue(arg.property);
         // Check whether this value change may be logged
         const isSecretValue = !!(ccInstance === null || ccInstance === void 0 ? void 0 : ccInstance.isSecretValue(arg.property));
@@ -233,7 +234,7 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
             // Only application CCs need to be filtered
             core_1.applicationCCs.includes(arg.commandClass) &&
             // and only if the endpoints are not unnecessary and the root values mirror them
-            this.shouldHideRootApplicationCCValues()) {
+            nodeUtils.shouldHideRootApplicationCCValues(this.driver, this)) {
             // Iterate through all possible non-root endpoints of this node and
             // check if there is a value ID that mirrors root endpoint functionality
             for (const endpoint of this.getEndpointIndizes()) {
@@ -400,6 +401,9 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
         var _a;
         return (_a = this.securityClasses.get(securityClass)) !== null && _a !== void 0 ? _a : core_1.unknownBoolean;
     }
+    setSecurityClass(securityClass, granted) {
+        this.securityClasses.set(securityClass, granted);
+    }
     /** Returns the highest security class this node was granted or `undefined` if that information isn't known yet */
     getHighestSecurityClass() {
         if (this.securityClasses.size === 0)
@@ -582,77 +586,7 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
     }
     /** Returns a list of all value names that are defined on all endpoints of this node */
     getDefinedValueIDs() {
-        let ret = [];
-        const allowControlled = [
-            core_1.CommandClasses["Scene Activation"],
-        ];
-        for (const endpoint of this.getAllEndpoints()) {
-            for (const [cc, info] of endpoint.implementedCommandClasses) {
-                // Only expose value IDs for CCs that are supported
-                // with some exceptions that are controlled
-                if (info.isSupported ||
-                    (info.isControlled && allowControlled.includes(cc))) {
-                    const ccInstance = endpoint.createCCInstanceUnsafe(cc);
-                    if (ccInstance) {
-                        ret.push(...ccInstance.getDefinedValueIDs());
-                    }
-                }
-            }
-        }
-        // Application command classes of the Root Device capabilities that are also advertised by at
-        // least one End Point SHOULD be filtered out by controlling nodes before presenting the functionalities
-        // via service discovery mechanisms like mDNS or to users in a GUI.
-        // We do this when there are endpoints that were explicitly preserved
-        if (this.shouldHideRootApplicationCCValues()) {
-            ret = this.filterRootApplicationCCValueIDs(ret);
-        }
-        // Translate the remaining value IDs before exposing them to applications
-        return ret.map((id) => this.translateValueID(id));
-    }
-    /** Determines whether the root application CC values should be hidden in favor of endpoint values */
-    shouldHideRootApplicationCCValues() {
-        var _a, _b, _c, _d;
-        // This is not the case when the root values should explicitly be preserved
-        if ((_b = (_a = this._deviceConfig) === null || _a === void 0 ? void 0 : _a.compat) === null || _b === void 0 ? void 0 : _b.preserveRootApplicationCCValueIDs)
-            return false;
-        // This is not the case when there are no endpoints
-        const endpointIndizes = this.getEndpointIndizes();
-        if (endpointIndizes.length === 0)
-            return false;
-        // This is not the case when only individual endpoints should be preserved in addition to the root
-        const preserveEndpoints = (_d = (_c = this._deviceConfig) === null || _c === void 0 ? void 0 : _c.compat) === null || _d === void 0 ? void 0 : _d.preserveEndpoints;
-        if (preserveEndpoints != undefined &&
-            preserveEndpoints !== "*" &&
-            preserveEndpoints.length !== endpointIndizes.length) {
-            return false;
-        }
-        // Otherwise they should be hidden
-        return true;
-    }
-    shouldHideRootValueID(valueId, allValueIds) {
-        // Non-root endpoint values don't need to be filtered
-        if (!!valueId.endpoint)
-            return false;
-        // Non-application CCs don't need to be filtered
-        if (!core_1.applicationCCs.includes(valueId.commandClass))
-            return false;
-        // Filter out root values if an identical value ID exists for another endpoint
-        const valueExistsOnAnotherEndpoint = allValueIds.some((other) => 
-        // same CC
-        other.commandClass === valueId.commandClass &&
-            // non-root endpoint
-            !!other.endpoint &&
-            // same property and key
-            other.property === valueId.property &&
-            other.propertyKey === valueId.propertyKey);
-        return valueExistsOnAnotherEndpoint;
-    }
-    /**
-     * Removes all Value IDs from an array that belong to a root endpoint and have a corresponding
-     * Value ID on a non-root endpoint
-     */
-    filterRootApplicationCCValueIDs(allValueIds) {
-        return allValueIds.filter((vid) => !this.shouldHideRootValueID(vid, allValueIds));
+        return nodeUtils.getDefinedValueIDs(this.driver, this);
     }
     /**
      * Updates a value for a given property of a given CommandClass on the node.
@@ -722,7 +656,7 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
             // We do not want to delay more important communication by polling, so give it
             // the lowest priority and don't retry unless overwritten by the options
             maxSendAttempts: 1,
-            priority: Constants_1.MessagePriority.Poll,
+            priority: serial_1.MessagePriority.Poll,
             ...sendCommandOptions,
         });
         // Check if the pollValue method is implemented
@@ -752,7 +686,7 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
             // We do not want to delay more important communication by polling, so give it
             // the lowest priority and don't retry unless overwritten by the options
             maxSendAttempts: 1,
-            priority: Constants_1.MessagePriority.Poll,
+            priority: serial_1.MessagePriority.Poll,
         });
         // Check if the pollValue method is implemented
         if (!api.pollValue)
@@ -795,28 +729,16 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
         return true;
     }
     get endpointCountIsDynamic() {
-        return this.getValue({
-            commandClass: core_1.CommandClasses["Multi Channel"],
-            property: "countIsDynamic",
-        });
+        return nodeUtils.endpointCountIsDynamic(this.driver, this);
     }
     get endpointsHaveIdenticalCapabilities() {
-        return this.getValue({
-            commandClass: core_1.CommandClasses["Multi Channel"],
-            property: "identicalCapabilities",
-        });
+        return nodeUtils.endpointsHaveIdenticalCapabilities(this.driver, this);
     }
     get individualEndpointCount() {
-        return this.getValue({
-            commandClass: core_1.CommandClasses["Multi Channel"],
-            property: "individualCount",
-        });
+        return nodeUtils.getIndividualEndpointCount(this.driver, this);
     }
     get aggregatedEndpointCount() {
-        return this.getValue({
-            commandClass: core_1.CommandClasses["Multi Channel"],
-            property: "aggregatedCount",
-        });
+        return nodeUtils.getAggregatedEndpointCount(this.driver, this);
     }
     /** Returns the device class of an endpoint. Falls back to the node's device class if the information is not known. */
     getEndpointDeviceClass(index) {
@@ -845,30 +767,17 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
      * Some devices are known to contradict themselves.
      */
     getEndpointCount() {
-        return ((this.individualEndpointCount || 0) +
-            (this.aggregatedEndpointCount || 0));
+        return nodeUtils.getEndpointCount(this.driver, this);
     }
     /**
      * Returns indizes of all endpoints on the node.
      */
     getEndpointIndizes() {
-        let ret = this.getValue((0, MultiChannelCC_1.getEndpointIndizesValueId)());
-        if (!ret) {
-            // Endpoint indizes not stored, assume sequential endpoints
-            ret = [];
-            for (let i = 1; i <= this.getEndpointCount(); i++) {
-                ret.push(i);
-            }
-        }
-        return ret;
+        return nodeUtils.getEndpointIndizes(this.driver, this);
     }
     /** Whether the Multi Channel CC has been interviewed and all endpoint information is known */
     get isMultiChannelInterviewComplete() {
-        return !!this.getValue({
-            commandClass: core_1.CommandClasses["Multi Channel"],
-            endpoint: 0,
-            property: "interviewComplete",
-        });
+        return nodeUtils.isMultiChannelInterviewComplete(this.driver, this);
     }
     getEndpoint(index) {
         if (index < 0)
@@ -900,17 +809,7 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
     }
     /** Returns a list of all endpoints of this node, including the root endpoint (index 0) */
     getAllEndpoints() {
-        const ret = [this];
-        // Check if the Multi Channel CC interview for this node is completed,
-        // because we don't have all the endpoint information before that
-        if (this.isMultiChannelInterviewComplete) {
-            for (const i of this.getEndpointIndizes()) {
-                const endpoint = this.getEndpoint(i);
-                if (endpoint)
-                    ret.push(endpoint);
-            }
-        }
-        return ret;
+        return nodeUtils.getAllEndpoints(this.driver, this);
     }
     /**
      * This tells us which interview stage was last completed
@@ -1090,7 +989,8 @@ let ZWaveNode = class ZWaveNode extends Endpoint_1.Endpoint {
         this.nodeType = resp.nodeType;
         this.supportsSecurity = resp.supportsSecurity;
         this.supportsBeaming = resp.supportsBeaming;
-        this.applyDeviceClass(resp.deviceClass);
+        const deviceClass = new DeviceClass_1.DeviceClass(this.driver.configManager, resp.basicDeviceClass, resp.genericDeviceClass, resp.specificDeviceClass);
+        this.applyDeviceClass(deviceClass);
         const logMessage = `received response for protocol info:
 basic device class:    ${this.deviceClass.basic.label}
 generic device class:  ${this.deviceClass.generic.label}
@@ -1240,7 +1140,7 @@ protocol version:      ${this.protocolVersion}`;
             if (instance.interviewComplete)
                 return "continue";
             try {
-                await instance.interview();
+                await instance.interview(this.driver);
             }
             catch (e) {
                 if ((0, core_1.isTransmissionError)(e)) {
@@ -1543,7 +1443,7 @@ protocol version:      ${this.protocolVersion}`;
             const instance = endpoint.createCCInstanceUnsafe(cc);
             if (instance) {
                 try {
-                    await instance.interview();
+                    await instance.interview(this.driver);
                 }
                 catch (e) {
                     this.driver.controllerLog.logNode(this.id, `failed to interview CC ${(0, core_1.getCCName)(cc)}, endpoint ${endpoint.index}: ${(0, shared_1.getErrorMessage)(e)}`, "error");
@@ -1560,7 +1460,7 @@ protocol version:      ${this.protocolVersion}`;
             const instance = endpoint.createCCInstanceUnsafe(cc);
             if (instance) {
                 try {
-                    await instance.refreshValues();
+                    await instance.refreshValues(this.driver);
                 }
                 catch (e) {
                     this.driver.controllerLog.logNode(this.id, `failed to refresh values for ${(0, core_1.getCCName)(cc)}, endpoint ${endpoint.index}: ${(0, shared_1.getErrorMessage)(e)}`, "error");
@@ -1581,7 +1481,7 @@ protocol version:      ${this.protocolVersion}`;
                     continue;
                 }
                 try {
-                    await cc.refreshValues();
+                    await cc.refreshValues(this.driver);
                 }
                 catch (e) {
                     this.driver.controllerLog.logNode(this.id, `failed to refresh values for ${(0, core_1.getCCName)(cc.ccId)}, endpoint ${endpoint.index}: ${(0, shared_1.getErrorMessage)(e)}`, "error");
@@ -1746,6 +1646,9 @@ protocol version:      ${this.protocolVersion}`;
         else if (command instanceof PowerlevelCC_1.PowerlevelCCTestNodeReport) {
             return this.handlePowerlevelTestNodeReport(command);
         }
+        else if (command instanceof ZWavePlusCC_1.ZWavePlusCCGet) {
+            return this.handleZWavePlusGet(command);
+        }
         // Ignore all commands that don't need to be handled
         switch (true) {
             // Reports are either a response to a Get command or
@@ -2238,6 +2141,17 @@ protocol version:      ${this.protocolVersion}`;
             this.emit("notification", this, core_1.CommandClasses["Multilevel Switch"], { eventType: _Types_1.MultilevelSwitchCommand.StopLevelChange });
         }
     }
+    async handleZWavePlusGet(_command) {
+        // treat this as a sign that the node is awake
+        this.markAsAwake();
+        await this.commandClasses["Z-Wave Plus Info"].sendReport({
+            zwavePlusVersion: 2,
+            roleType: _Types_1.ZWavePlusRoleType.CentralStaticController,
+            nodeType: _Types_1.ZWavePlusNodeType.Node,
+            installerIcon: 0x0500,
+            userIcon: 0x0500, // Generic Gateway
+        });
+    }
     /** Schedules a notification value to be reset */
     scheduleNotificationIdleReset(valueId, handler) {
         this.clearNotificationIdleReset(valueId);
@@ -2440,8 +2354,8 @@ protocol version:      ${this.protocolVersion}`;
         if (command.weekday !== weekday ||
             command.hour !== hours ||
             command.minute !== minutes) {
-            const endpoint = command.getEndpoint();
-            if (!endpoint || !endpoint.commandClasses.Clock.isSupported()) {
+            const endpoint = command.getEndpoint(this.driver);
+            if (!endpoint /*|| !endpoint.commandClasses.Clock.isSupported()*/) {
                 // Make sure the endpoint supports the CC (GH#1704)
                 return;
             }