Add Makefile, rename files and add troubleshooting in documentation

This commit is contained in:
Marek Hobler 2022-02-11 19:34:13 +01:00
parent fa1a05d88c
commit 7b21d0753e
4 changed files with 23 additions and 16 deletions

4
Makefile Normal file
View File

@ -0,0 +1,4 @@
# Makefile
main:
gcc everblu_meters.c -o everblu_meters -lwiringPi -lpthread -Wall

View File

@ -1,10 +1,14 @@
# everblu-meters
Fetch water usage data from Cyble EverBlu meters using RADIAN protocol.
Fetch water/gas usage data from Cyble EverBlu meters using RADIAN protocol on 433Mhz.
Meters supported:
- Itron EverBlu Cyble Enhanced
## Hardware
![Raspberry Pi Zero with CC1101](board.jpg)
Currently the project runs on Raspberry Pi with an RF transreciver (CC1101).
The project runs on Raspberry Pi with an RF transreciver (CC1101).
### Connections (rpi to CC1101):
- pin 1 (3V3) to pin 2 (VCC)
@ -20,28 +24,29 @@ Currently the project runs on Raspberry Pi with an RF transreciver (CC1101).
## Configuration
1. Enable SPI in raspi-config.
2. Install WiringPi from https://github.com/WiringPi/WiringPi/
3. Set meter serial number and production date in `cc1101.c`, it can be found on the meter label itself:
3. Install mosquitto-dev: `apt install mosquitto-dev`
4. Set meter serial number and production date in `cc1101.c`, it can be found on the meter label itself:
![Cyble Meter Label](meter_label.png)
5. Compile the code with `make`
6. Run `everblu_meters`, after ~2s your meter data should be on the screen.
## Compiling
```
gcc radian_trx.c -o radian_trx -lwiringPi -lpthread -Wall
```
## Troubleshooting
### Frequency adjustment
Your transreciver module may be not calibrated correctly, please modify frequency a bit lower or higher and try again
### Business hours
Your meter may be configured in such a way that is listens for request only during hours when data collectors work - to conserve energy. If you are unable to communicate with the meter, please try again during business hours (8-16).
### Serial number starting with 0
Please ignore the trailing 0, provide serial in configuration whthout it.
## Origin and license
This code is fetched from http://www.lamaisonsimon.fr/wiki/doku.php?id=maison2:compteur_d_eau:compteur_d_eau
This code is based on code from http://www.lamaisonsimon.fr/wiki/doku.php?id=maison2:compteur_d_eau:compteur_d_eau
The license is unknown, citing one of the authors (fred):
@ -50,5 +55,3 @@ The license is unknown, citing one of the authors (fred):
> this code was made by "looking" at the radian protocol which is said to be open source earlier in the page, I don't know if that helps?

View File

@ -2,7 +2,7 @@
/* it is exposed just to demonstrate CC1101 capability to reader water meter indexes */
/* there is no Warranty on radian_trx SW */
#include "radian_trx.h"
#include "everblu_meters.h"
void IO_init(void)
{