Configuration manager access

[pnpebeling]

Hello,

I am converting the ZWave portion my home automation .NET project from openZWave to ZWaveJS via ZWaveJS.NET. I am using the current version of ZWaveJS.NET in "Self Hosted" mode. The conversion has gone quite smoothly. I have a need to access the manufacturer information and since there are no public methods within ZWaveJS.NET to access the ZWaveJS configuration manager I am attempting to add some.

I have include the JWaveJS.NET source code as a project within my solution and am in the process of adding extension methods to provide configuration manager access. My extension methods follow the established pattern for sending requests to the server code. I have successfully added an extension method to retrieve a node's neighbor nodes.

My attempts to access the server configuration manager have not been successful. My extension method and the server response are shown below. From reviewing the server documentation I believe I have formatted the command correctly, however I get Unknown Command responses.

Any insight into this issue is appreciated.

paul ebeling

public static Task<CMDResult> CfgMgrTest(this Controller controller, ZWaveNode Node) {
  Guid ID = Guid.NewGuid();

  TaskCompletionSource<CMDResult> Result = new TaskCompletionSource<CMDResult>();
  Driver.Callbacks.Add(ID, (JO) => {
    CMDResult Res = new CMDResult(JO);
    if (Res.Success) {
      Res.SetPayload(JO.Value<JObject>("result"));
    }
    Result.SetResult(Res);
  });

  Dictionary<string, object> Request = new Dictionary<string, object>();
  Request.Add("messageId", ID);
  Request.Add("command", "config_manager.lookup_manufacturer");

  Request.Add("manufacturer_id", Node.manufacturerId);

  string RequestPL = Newtonsoft.Json.JsonConvert.SerializeObject(Request);
  Driver.Client.SendAsync(RequestPL);

  return Result.Task;
}

{
"type": "result",
"success": false,
"messageId": "5edbfc06-73ae-464c-b9f6-bfe6ebac08b5",
"errorCode": "unknown_command",
"args": {
"command": "config_manager.lookup_manufacturer"
}
}

[marcus-j-davies]

Hi @pnpebeling

You likely havant compiled the middleware image (PSI file) to the latest version - therefore, it's not pulling down the server version that included this functionality (config manager)

See https://github.com/zwave-js/ZWaveJS.NET/tree/main/PSI for the PSI source

The 'current' version of the PSI is based on schema 17 - quite old now, its currently on schema version 40
The V4 branch https://github.com/zwave-js/ZWaveJS.NET/tree/4.0.0 is based on 35

(I think config_manager was added in schema v38)

The are a 2 parts to this project...

• The .Net DLL
• The PSI file

The PSI file contains an embedded version of the Zwave JS Driver, and the web socket server - its the web socket server, that will handle this functionality - and I doubt schema version 17 - contained this functionality.

The PSI file is compiled to an exe - and hosts an embedded runtime of the Driver and Server - the DLL fires it up, and connects to it via web socket

See : https://github.com/zwave-js/zwave-js-server

Try using the V4 branch (be aware of a lot of breaking changes) + the need to now compile your own PSI
form here - bump the dependency on the PSI project to the latest server version (35-> 40), and you should be able to move forward.

[marcus-j-davies]

1. Pull down V4
2. Edit the dependencies on the PSI project to pull down the latest Driver and Server
3. Build it
   - cd to ./PSI
   - run npm install && npm run build
   - rename ./dist/server.exe to ./dist/server.psi, and distribute the image with the library.
4. Patch your application. (to handle the breaking change in V4)

You could just try bumping the server and driver on the current version you have downloaded (and build as normal)

[marcus-j-davies]

UPDATE

---

V4 now has the Config Manager

Driver.ConfigManager.LookupDevice(int ManufacturerID, int ProductTypeID, int ProductId)
Driver.ConfigManager.LookupManufacturer(int ManufacturerID)

Again - you need to compile your own PSI, to take advantage

[pnpebeling]

Thanks for the prompt reply. I've downloaded V4 and compiled the PSI. I'm working through the breaking changes now ... though they are not as bad as I feared. thx again.

[pnpebeling]

After updating my application to use the V4 branch, I can no longer connect to the server. I receive the following error message in the StartupErrorEvent event callback.
"Could not connect to the server, Connection will continue to try: Unable to connect to the remote server".

From the log file, it appears that the server is connecting to the ZWave Stick (AEOTEC Gen5), however there appears to be a problem in the subsequent GetControllerVersion requests. The last few lines from the log file are as follows.

2025-01-27T16:53:48.630Z DRIVER » [REQ] [GetControllerVersion]
2025-01-27T16:53:48.631Z CNTRLR Failed to execute controller command after 2/3 attempts. Scheduling next try i
n 1100 ms.
2025-01-27T16:53:49.735Z DRIVER » [REQ] [GetControllerVersion]
2025-01-27T16:53:49.738Z CNTRLR Serial API did not respond, trying again in 15 seconds...
2025-01-27T16:53:49.738Z DRIVER all queues idle
2025-01-27T16:54:04.744Z DRIVER one or more queues busy
2025-01-27T16:54:04.748Z DRIVER » [REQ] [GetControllerVersion]
2025-01-27T16:54:04.749Z CNTRLR Failed to execute controller command after 1/3 attempts. Scheduling next try i
n 100 ms.
2025-01-27T16:54:04.854Z DRIVER » [REQ] [GetControllerVersion]
2025-01-27T16:54:04.855Z CNTRLR Failed to execute controller command after 2/3 attempts. Scheduling next try i
n 1100 ms.
2025-01-27T16:54:05.967Z DRIVER » [REQ] [GetControllerVersion]
2025-01-27T16:54:05.969Z CNTRLR Serial API did not respond, giving up
2025-01-27T16:54:05.971Z DRIVER Failed to initialize the driver: ZWaveError: The Serial API did not respond af
ter soft-reset (ZW0100)
at Driver3.softResetInternal (C:\snapshot\build\server.js)
at processTicksAndRejections (node:internal/process/task_queues:95:5)
at Driver3.initializeControllerAndNodes (C:\snapshot\build\server.js)
at Immediate. (C:\snapshot\build\server.js)
2025-01-27T16:54:05.971Z DRIVER destroying driver instance...
2025-01-27T16:54:05.972Z DRIVER driver instance destroyed

In addition, when I run the application, an instance of server.500001.psi is created alongside of the existing server.psi file.

Note that I am using the NodeJS version that shipped with my Visual Studio 2022 environment, node -v reports version v20.13.1
I am building out of the 4.0.0 PSI folder so I believe I'm pulling in the proper server versions. package.json contains the following.

{
"version": "4.0.0",
"name": "server",
"bin": "./server.js",
"dependencies": {
"@zwave-js/server": "1.40.2",
"zwave-js": "14.3.7"
},
"devDependencies": {
"@yao-pkg/pkg": "^6.2.0",
"esbuild": "^0.24.2",
"eslint": "^8.57.0",
"prettier": "^3.4.2"
},
"scripts": {
"build": "npm run do_esbuild && npm run do_pkgbuild",
"do_esbuild": "node esb.js",
"do_pkgbuild": "pkg ./build/package.json --compress gzip -t host --targets node18 --output ./build/dist/server",
"test": "export WS_PORT=7070 SERIAL_PORT=/dev/tty.usbmodem214301 CONFIG=$(<./test_config.json) && ./build/dist/server",
"lint": "eslint --ext .js .",
"lint:fix": "eslint --fix --ext .js . && prettier -w ."
}
}

The PSI build process reports several warnings in the npm install phase

npm WARN deprecated inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
npm WARN deprecated @humanwhocodes/config-array@0.13.0: Use @eslint/config-array instead
npm WARN deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported
npm WARN deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported
npm WARN deprecated @humanwhocodes/object-schema@2.0.3: Use @eslint/object-schema instead
npm WARN deprecated eslint@8.57.1: This version is no longer supported. Please see https://eslint.org/version-support for other options.

added 344 packages, and audited 345 packages in 26s

as well as the build phase

Warning Cannot resolve '"url".replace("", "")'
C:\pae\ZWave\ZWaveJS.NET-4.0.0\ZWaveJS.NET-4.0.0\PSI\build\server.js
Dynamic require may fail at run time, because the requested file
is unknown at compilation time and not included into executable.
Use a string literal as an argument for 'require', or leave it
as is and specify the resolved file name in 'scripts' option.
Warning Cannot resolve '"url".replace("", "")'
C:\pae\ZWave\ZWaveJS.NET-4.0.0\ZWaveJS.NET-4.0.0\PSI\build\server.js
Dynamic require may fail at run time, because the requested file
is unknown at compilation time and not included into executable.
Use a string literal as an argument for 'require', or leave it
as is and specify the resolved file name in 'scripts' option.
Warning Cannot resolve 'adapters[adapter]'
C:\pae\ZWave\ZWaveJS.NET-4.0.0\ZWaveJS.NET-4.0.0\PSI\build\server.js
Dynamic require may fail at run time, because the requested file
is unknown at compilation time and not included into executable.
Use a string literal as an argument for 'require', or leave it
as is and specify the resolved file name in 'scripts' option.
1 file(s) copied.

Any additional guidance is appreciated. thx

-p

[marcus-j-davies]

OK @pnpebeling

Pull down the V4 PR again.

Soft Reset is now in..

ZWaveOptions.features.softReset

Set it to false (pull the stick and back in again to give it a fresh start)

[pnpebeling]

Ok, that seems to have fixed things, however ... the StartUpError event fires several times during server startup. If I ignore these events the server eventually becomes ready (DriverReady event). Timing of these events is shown below (my log entries).

12:04:33.258, [ E], AfwZWaveJSN._OnStartupError(): Could not connect to the server, Connection will continue to try: Unable to connect to the remote server
12:04:44.668, [ E], AfwZWaveJSN._OnStartupError(): Could not connect to the server, Connection will continue to try: Unable to connect to the remote server
12:04:56.079, [ F], AfwZWaveJSN._OnStartupError(): Could not connect to the server, Connection will continue to try: Unable to connect to the remote server
12:05:07.519, [10], AfwZWaveJSN._OnStartupError(): Could not connect to the server, Connection will continue to try: Unable to connect to the remote server
Starting server on localhost:50001
ZwaveJS server listening on localhost:50001

Thanks for your help ... this gets me going on V4.

What is the recommended way of determining fatal startup errors?
Is there any API I can call to check startup progress? (That is the time between Driver.Start and the DriverReady event.)

thanks again

[marcus-j-davies]

Ok - my web socket to the server is a little..... impatient?
I think I just need to improve the way I am waiting for the socket to become ready.

You can override this noise with ServerErrorThrottleTime in the c'tor
Default it's 10s - set it to ~50000 (50s) - that way, it will only complain once - its something I want to improve soon.

What is the recommended way of determining fatal startup errors?

There are 3 events

Driver.StartUpError          // I think you are already subscribed to it?
Driver.ConnectionLost        // occurs if connection is lost after up and running
Driver.UnexpectedHostExit    // I think this is obsolete 

In essence, its an area I want to improve - and will be my aim before V4 is released (hopefully soon)

[marcus-j-davies]

Thanks for your help ... this gets me going on V4.

You should now have access to Driver.ConfigManager

[marcus-j-davies]

@pnpebeling

Just some bonus content:

Now that you have v4.
One thing that comes with it, is a Method Factory.

This allows adding new methods during runtime without modifying the library/source
Providing the PSI (ZWaveJS Server version) that you have/built has it implemented.

SomeClass.cs

public class SomeClass
{
   public SomeClass() { }

   [Newtonsoft.Json.JsonProperty]
   public int somePropertyFromTheResult { get; set; }

   [Newtonsoft.Json.JsonProperty]
   public int someOtherPropertyFromTheResult { get; set; }
}

var MyMethod = MethodFactory.CreateCLASS(_Driver, "node.unimplmented_method_example", typeof(SomeClass), "result.some.result.path");

Dictionary<string, object> Parameters = new Dictionary<string, object>();
Parameters.Add("nodeId",46);
Parameters.Add("someOtherRequiredProperty",46);

MyMethod.Invoke(Parameters).ContinueWith((R) =>
{
   if (R.Result.Success)
   {
       SomeClass MyClass = R.Result.ResultPayload as SomeClass;
   }
});

In a nutshell, it takes

• The Driver instance
• The server command name
• The Class that the result should be transposed against
• The Path where that result is found on the incoming result message