sameer/python-openzwave-sniffer

A simple OpenZWave Network Sniffer written in Python 3 that logs to an output file in CSV format

OpenZWave Sensor Sniffer in Python 3

This program initializes the ZWave Network, logging any and all value refreshes received to the file output.csv -- this includes sensor readings and other updates.

Set-up

Ubuntu (also Windows Subsystem for Linux with Ubuntu)

Note: if you do not already have Windows Subsystem for Linux, follow the installation guide provided by Microsoft

• ./setup_ubuntu.sh
• ./allow_port_access_forever_ubuntu.sh

OS X

• ./setup_os_x.sh

Running

• ./run.sh <optional port name, defaults to /dev/ttyACM0 for Linux>

Stopping

• Just do ctrl+C once, it will stop itself.

FAQ

What should the port name be?

Let # as used below be the port number of the ZWave Stick.

Windows Subsystem for Linux with Ubuntu

It should be COM# in Windows and /dev/ttyS# in Ubuntu. You can try figure out what # is by opening Device Manager and looking at the USB devices list, then trying each with ./run.sh /dev/ttyS# until it works. If you get an error message that permission is denied, run ./allow_port_access_once.sh /dev/tty/S#.

OS X

It should be /dev/ttyUSB#, you can also try each one until you get it right.

Any other Linux system

It should be /dev/ttyACM#, you may need permission to read/write to the port. In that case, run ./allow_port_access_once.sh /dev/ttyACM# or use the indefinite version.

---

Is it relatively safe to delete all the files that seem to be generated (i.e. pyozw.sqlite) when I run the sniffer?

Yes, just make sure you stop the sniffer first. Use clean.sh

---

Error in manager callback: KeyError: 'valueid'

If you're seeing this, there was an error in configuring the network properly. It's best to re-download/re-clone this repo and run it from there, or alternatively delete all the new files.

---

Stuck in state "Topology loaded"

This has happened to me several times -- usually, the issue is that you're running the network for the first time and the stick is waiting for something (not sure what). The solution tends to be to press the button on each of the sensors once.

python-openzwave-sniffer's Issues

Getting Z-wave stick to work with WSL on Ubuntu?

Hi,
Thanks for this library and instructions.

I am trying to get it to work on Windows 10 with WSL on Ubuntu. I noticed that your README has instructions for WSL. Have you got it working there before? I have the Aeotec Z-wave Stick and have it plugged into COM4 on the machine as shown by Device Manager.

I have configured /dev/ttyS4 as covered in the following article: https://www.scivision.dev/usb-tty-windows-subsystem-for-linux/

chmod 666 /dev/ttyS4
stty -F /dev/ttyS4 115200

When I try to run the sniffer, I just get the following:

$ ./run.sh /dev/ttyS4
2019-07-04 17:43:26,235 INFO openzwave/main.py[13328] -- Launching with ZWave Stick at /dev/ttyS4
2019-07-04 17:43:26,259 INFO openzwave/main.py[13328] -- Starting network...
2019-07-04 17:43:26,260 INFO openzwave [13328] -- Start Openzwave network.
2019-07-04 17:43:26,511 INFO openzwave/main.py[13328] -- Stopped

Any ideas?