Waterwise

Overview

A micro service to interface with the bewaterwise.com watering index RSS feed

This project depends on echttp and houseportal. It accepts all standard options of echttp and the houseportal client runtime. See these two projects for more information.

This project is also a good example of a minimal micro-service based on echttp and houseportal.

Interface

The waterwise service accepts the /waterwise/status HTTP URL and returns the watering index information in JSON format, for example:

{
  "host": "andresy",
  "timestamp": 1602561976,
  "waterindex": {
    "status": {
      "origin": "http://www.bewaterwise.com/RSS/rsswi.xml",
      "state": "a",
      "index": 91,
      "received": 1602561782,
      "calculated": 1603263600
    }
  }
}

The timestamp field represents the time of the request, the host field represents the name of the server hosting this micro-service.

The origin field represent the URL used to obtain the index. The state field is either 'u' (not yet initialized), 'f' (failed to access the bewaterwise.com web site), 'e' (malformed JSON data received) or 'a' (active). Except when active, an error field provides a description of the error.

The index field is a percentage (which can be above 100), the received field indicate when this index was obtained, and the calculated field indicates when the bewaterwise.com site calculated the index. (This service use the weekly index.)

Debian Packaging

The provided Makefile supports building private Debian packages. These are not official packages:

• They do not follow all Debian policies.

• They are not built using Debian standard conventions and tools.

• The packaging is not separate from the upstream sources, and there is no source package.

To build a Debian package, use the debian-package target:

make debian-package

Docker

The project supports a Docker container build, which was tested on an ARM board running Debian. To make it work, all the house containers should be run in host network mode (--network host option). This is because of the way houseportal manages access to each service: using dynamically assigned ports does not mesh well with Docker's port mapping.