/watermeter

Reads analog water meters and provides a web service that returns the read value as decimal.

Primary LanguagePHPGNU Affero General Public License v3.0AGPL-3.0

Read a water meter and returns value

Reads analog water meters and provides a web service that returns the read value as decimal. The needles of the analog gauges currently have to be red.

Turns Watermeter into 820.5745 so it can become Grafana Screenshot.

CI Docker Hub Pulls

Getting Started

This is only a quick introduction to setting up and configuring watermeter. A more extensive documentation can be found in the howto.

Installation

Using Docker Compose (recommended)

version: "3.5"
services:
  watermeter:
    image: nohn/watermeter:latest
    container_name: watermeter
    volumes:
      - ./watermeter/config:/usr/src/watermeter/src/config
    restart: always
    ports:
      - "3000:3000"

Configuration

You can access the configuration tool http://watermeter:3000/configure.php. The interface should be self explanatory. Source Image can be either in local filesystem or any HTTP(S) resource.

Configuration GUI Screenshot

After configuration is done, you can access the current value at

http://watermeter:3000/

or

http://watermeter:3000/?json

or see debug information at

http://watermeter:3000/?debug

How to contribute

You can contribute to this project by:

  • Opening an Issue if you found a bug or wish to propose a new feature
  • Placing a Pull Request with bugfixes, new features etc.

You like this?

Consider a gift.

License

analogmeterreader is released under the GNU Affero General Public License.