re-add README

This commit is contained in:
King Kévin 2019-09-30 13:39:58 +02:00
parent 8946ed7f5c
commit dfc006eb45
1 changed files with 35 additions and 0 deletions

35
README.md Normal file
View File

@ -0,0 +1,35 @@
these Linux programs read out the measurements from the WEB/WITRN/GZUt/QWay U2/U2p USB power meter.
go to [wiki](https://wiki.cuvoodoo.info/doku.php?id=web-u2) for more information about the device and protocols.
USB
===
`u2_usb` reads the measurements using the USB HID interface.
to compile the source code you require: gcc, make, hidapi library (libhidapi-dev).
then just run `make` and it will output the `u2_usb` binary.
run `u2_usb` to get the output in CSV format.
run `u2_usb -d` to get the raw and decoded output (useful for reversing and debugging).
Bluetooth
=========
to compile the source code you require: gcc, make, dbus library (libdbus-1-dev).
then just run `make` and it will output the `u2_bt` binary.
ensure the BlueZ Bluetooth stack is running:
```
sudo systemctl start bluetooth
```
don't forget to grant the permissions to access bluetooth devices:
```
sudo adduser $USER bluetooth
```
run `u2_bt` to get the output in CSV format.
run `u2_bt -d` to get the raw and decoded output (useful for reversing and debugging).
I did not implement the possibility to specify the Bluetooth adapter and device.
the program uses the first Bluetooth adapter it finds, and first device with the name starting with Qway_U2.