Running Zigbee2mqtt on Windows #

Since Node.js is fully cross-platform it is possible to run Zigbee2mqtt on Windows.

Before you start make sure you have already flashed your Zigbee adapter with the appropriate firmware.

1. Determine which COM port is assigned to your device #

  1. Connect your sniffer device
  2. Open up Start menu and start typing Device Manager
  3. Expand Ports (COM & LPT)
  4. Look for a node similar to USB Serial Device (COM4)
  5. Take note of the port number, it will be needed during configuration

Device Manager

2. Installing #

  1. Download and install Node.js 10 LTS from their website
  2. Open up a Command prompt or Powershell from the Start menu (Powershell has prettier colors)
  3. Verify Node.js was successfully installed 
     node --version
  4. Choose a suitable directory for Zigbee2mqtt and copy all the files from the Zigbee2mqtt repository
    • if you prefer to use git (which you should), just clone the whole repository 
        git clone git@github.com:Koenkk/zigbee2mqtt.git
    • otherwise use the green Clone or download button to download the zip archive, then extract it
  5. Change to the newly created directory and install dependencies with Node.js’ own package manager npm 
     npm ci

3. Configuring #

  1. Open data\configuration.yaml in a text editor
  2. Change the serial port configuration to match your setup 
     serial:
     port: \\.\COM4
  3. Make sure other settings are correct as well
  4. Save and exit

Congratulations, you’re now ready to start your Zigbee2mqtt installation

4. Starting Zigbee2mqtt #

Just change to the root directory of your installation and run the application:

npm start

A successful setup produces an output similar to this:

> zigbee2mqtt@1.6.0 start C:\Users\me\Documents\GitHub\zigbee2mqtt
> node index.js

  zigbee2mqtt:info 2019-10-18 10:56:22 PM Logging to directory: 'D:\Documents\GitHub\zigbee2mqtt\data\log\2019-10-18.22-56-22'
  zigbee2mqtt:info 2019-10-18 10:56:22 PM Starting zigbee2mqtt version 1.6.0 (commit #e26ad2a)
  zigbee2mqtt:info 2019-10-18 10:56:22 PM Starting zigbee-shepherd
  zigbee2mqtt:info 2019-10-18 10:56:24 PM zigbee-shepherd started
  zigbee2mqtt:info 2019-10-18 10:56:24 PM Coordinator firmware version: '20190608'

The Coordinator firmware version: '20190608' entry means that Zigbee2mqtt has successfully communicated with the USB sniffer.

Zigbee2mqtt can be stopped anytime by pressing CTRL + C and then confirming with Y (on English locales at least).