Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ckuethe/esp8266-watermeter
ESP8266 and MicroPython web server to monitor a hall effect water sensor
https://github.com/ckuethe/esp8266-watermeter
esp8266 hall-effect-sensor iot-device iot-sensors micropython micropython-esp8266 water-resources
Last synced: 2 days ago
JSON representation
ESP8266 and MicroPython web server to monitor a hall effect water sensor
- Host: GitHub
- URL: https://github.com/ckuethe/esp8266-watermeter
- Owner: ckuethe
- License: mit
- Created: 2018-11-21T08:13:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-06T23:40:26.000Z (about 4 years ago)
- Last Synced: 2024-12-09T12:14:43.898Z (29 days ago)
- Topics: esp8266, hall-effect-sensor, iot-device, iot-sensors, micropython, micropython-esp8266, water-resources
- Language: Python
- Size: 1.2 MB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESP8266 Water Meter
This is a simple ESP8266 powered water flow sensor. A typical use case might
be to measure the amount of water that has passed through a reverse osmosis
water filter to know when the filter media should be changed.
## Hardware
Pretty simple, really. Take one NodeMCU, connect the 3.3V regulated output
pin to Vcc (red wire) on a hall effect sensor. Ground pin to GND (black wire).
GPIO4 (it happens to be D2 on my board) to OUT (yellow wire) on the sensor.
Finally, add an I2C memory (persisting state to on-board flash is a great way
to wreck your device... says the voice of bitter experience).
That's it.
The circuit toggles one of the on-board LEDs whenever a pulse arrives from
the sensor but that's purely eye-candy.
If you want to get fancy, you can add an I2C display.
## Firmware
The watermeter is based on micropython with a customized set of frozen
modules. This is necessary due to the limited amount of memory available
for runtime compilation of modules on the file system, the fact that not
all the modules are available to be installed with upip, and an upper bound
on flash image size prevents me from just shipping all of `micropython-lib`
as frozen modules. As recommended by the documentation, the water meter
application is in a single module which can be imported and then invoked by
`main()`.
After startup, the water meter will emit a UDP broadcast packet to port 1900
every 30 seconds announcing its presence. The UDP packet is sourced from the
same IP and port where the TCP listener is running. The same information is
logged on the serial console.
```
Log:
INFO:None:advertised 192.168.1.42:2782 to 192.168.1.255
Network Advertisement:
08:57:55.771389 IP 192.168.1.42.2782 > 192.168.1.255.1900: UDP, length 46
0x0000: 4500 004a 0018 0000 ff11 3711 c0a8 012a E..J......7....*
0x0010: c0a8 01ff 0ade 076c 0036 6178 7761 7465 .......l.6axwate
0x0020: 726d 6574 6572 2072 756e 6e69 6e67 206f rmeter.running.o
0x0030: 6e20 6874 7470 3a2f 2f31 3932 2e31 3638 n.http://192.168
0x0040: 2e31 2e34 323a 3237 3832 .1.42:2782
```
#### Installation
1. Flash micropython to the target board
1. I have provided a binary of my micropython build [here](esp8266-firmware-git.bin)
1. You can build your own by adding and removing the listed modules
1. Copy in watermeter.py, eg. `ampy -p /dev/ttyUSB0 watermeter.py`
1. Some boards don't have enough memory to compile, so I've included precompiled bytecode [here](watermeter.mpy)
1. Connect to the ESP8266 over its serial console
1. `import watermeter`
1. `watermeter.initconfig('your-wifi-ssid-here', 'your-wifi-password-here', False)` # or just `watermeter.netconfig()`
1. `watermeter.install_and_reboot()` # renames watermeter.py to main.py so that the bootloader will run it at startup
#### Removed Modules
- apa102
- dht
- ds18x20
- neopixel
- onewire
- port_diag
- upip
- upip_utarfile
#### Added Modules
- logging / ulogging
- picoweb
- pkg_resources
- uasyncio
- ssd1306
## JSON API
```
/
```
List all the API endpoints
#### Current Usage
```
/usage
```
This endpoint returns a timestamped report of current usage, eg. `{"timestamp": "2018-11-21 08:14:22.002", "volume": 1.6704, "pulses": 1305, "k": 1.28, "unit": "litre"}`
#### Calibration
```
/calibrate?mls=&pulses=
/calibrate?k=
```
This endpoint sets the calibration value for the sensor. Different turbines,
impellers, and pipe will have varying volumes per pulse.
#### Unit selection
```
/metric
```
```
/imperial
```
Switch the reporting unit between metric (litres) and imperial (gallons).
#### Sync to permanent storage
```
/sync
```
Forces an immediate save to flash.
#### Deactivate auto-start
```
/uninstall
```
renames `main.py` to `watermeter.py` so that it will not restart at boot.