Getting Started - zwave-js/node-red-contrib-zwave-js GitHub Wiki

So! you have taken the bait. Lets turn you into a pro with node-red-contrib-zwave-js

Before you begin

This IS NOT a node that will work with HA's Z-Wave infrastructure - its a node that manages all aspects of Z-Wave directly in Node RED, with its own UI using the same backend library (zwave-js) that HA also uses, so if your planning to use this to control HA's Z-Wave network, then this node isn't for you.

Please ensure your system meets or exceeds these requirements:

  • Node.js Version >= v12.22.2
  • Node-RED Version >= 2.0.0

node-red-contrib-zwave-js employs the nodejs serialport package, and during the installation,
it will attempt to pulldown a pre-build of that package for your host (it uses native NodeJS Modules).

If a pre-build is not available, it will attempt to compile one for you, therefore, you may need to ensure
your system has the following (if a pre-build is not available)

of course, if you know a pre-build is available, the requirements below do not apply.

Host specific requirements:

  • *nix
    • Python v3.6, v3.7, v3.8, or v3.9
    • A proper C/C++ compiler toolchain/environment, like GCC
    • If your host is openSUSE, you may also need to do:
      • zypper install nodejs-devel
      • zypper install -t pattern devel_C_C++
  • OSX
    • Python v3.6, v3.7, v3.8, or v3.9
    • XCode Command Line Tools
  • Windows
    • Python v3.6, v3.7, v3.8, or v3.9
    • Visual C++ Build Environment/tools (Visual Studio Community will do the trick)
    • Set NPM Visual Studio version npm config set msvs_version 20##

Lastly, If your running Node RED under a standard user, say pi on a Raspberry Pi, you may need to add the pi user to the correct group, in order to access the serial ports.

sudo usermod -a -G dialout pi

Installing

Installing the node, is no different to installing other Node-RED modules - just use the palette manager.
The install process might take a minute or 2, as it will build some native Node.js Modules (the serialports package).

If you prefer to use the command line, see below.

Installing from command line

Navigate to the .node-red directory and run the normal npm routines.

  • cd /home/pi/.node-red
  • npm install node-red-contrib-zwave-js@latest
  • Restart Node-RED

Now what?

Either follow the wiki down or click Here to obtain an example flow.