brewblox-ispindel 0.2.0

No project description provided

# BrewBlox iSpindel service

This a BrewBlox service to support [iSpindel](https://github.com/universam1/iSpindel/)
an electronic hydrometer.


This project is under active development.


## How does it work ?

The iSpindel is configured to send metrics using the generic HTTP POST protocol.

When the iSpindel wake up (like every minute) it submits a POST request containing the metrics to the iSpindel BrewBlox service.

The service then publish metrics to the event-bus, the BrewBlox history service is in charge to persist the metrics into the InfluxDB database.

## Configuration

### Deploy the iSpindel service on the BrewBlox stack


You need to add the service to your existing BrewBlox docker compose file.

```yaml
ispindel:
image: bdelbosc/brewblox-ispindel:rpi-latest
depends_on:
- history
labels:
- "traefik.port=5000"
- "traefik.frontend.rule=PathPrefix: /ispindel"
```

The `brewblox-ispindel` docker images are available on docker hub.

Note that the image tag to use is:
- `rpi-latest` for the `arm` architecture (when deploying on a RaspberryPi)
- `latest` for the `amd` architecture

### Configure the iSpindel

The `brewblox-ispindel` endpoint needs to be accessible in `HTTP`,
you need to find the `IP` address and `PORT` where the service:
[http://IP:PORT/ispindel/_service/status](http://IP:PORT/ispindel/_service/status)
reply with a:
```json
{"status": "ok"}
```
Then:
- Switch the iSpindel on
- Press the reset button 3-4 times which sets up an access point
- Connect to the Wifi network "iSpindel"
- Open a browser on [http://192.168.4.1](http://192.168.4.1)
- From the "Configuration" menu, configure the Wifi access, then
- Service Type: `HTTP`
- Token:
- Server Address: `<IP>`
- Server Port: `<PORT>`
- Server URL: `/ispindel/ispindel`


Double check that your are using an HTTP service type (and not a TCP).

### Add Graph to your dashboard

From your dashboard `ACTIONS > New Widget` then select and create a `Graph` widget.

Once the iSpindel is configured to send data to BrewBlox, you should see its metrics when configuring the widget:



## Development

### Run tests

```bash
# install pip3 if not already done
sudo pip3 install pipenv

# init the env
pipenv lock
pipenv sync -d

# Run the tests
pipenv run pytest
```

### Build a docker image

1. Install the [brewblox-tools](https://github.com/BrewBlox/brewblox-tools)

2. Go into the brewblox-ispindel directory and build the `rpi-latest` image
```bash
bbt-localbuild -r bdelbosc/brewblox-ispindel --tags latest -a arm
```

Use `-a amd` to build the `latest` image for amd architecture.

### Simulate iSpindel request

From the BrewBlox host:

```bash
curl -XPOST http://localhost:9000/ispindel/ispindel
-d'{"name":"iSpindel000","ID":4974097,"angle":83.49442,"temperature":21.4375,"temp_units":"C","battery":4.035453,"gravity":30.29128,"interval":60,"RSSI":-76}'
```

### Check iSpindel service logs

Each time the service receive a request there is a log showing the temperature and gravity.
To run from the directory containing the `docker-compose.yml` file.

```bash
docker-compose logs ispindel
...
ispindel_1 | 2019/04/12 14:18:34 INFO __main__ iSpindel iSpindel000, temp: 21.75, gravity: 22.63023
ispindel_1 | 2019/04/12 14:19:05 INFO __main__ iSpindel iSpindel000, temp: 21.6875, gravity: 22.69526
```

### View iSpindel metrics persisted in the influxdb database

To run from the directory containing the `docker-compose.yml` file.

```sql
docker-compose exec influx influx
> USE brewblox
> SHOW SERIES
key
---
iSpindel000 -- This is the name given to the iSpindel
sparkey
spock

> SELECT * FROM "iSpindel000"
name: iSpindel000
time angle battery gravity rssi temperature
---- ----- ------- ------- ---- -----------
1546121491626257000 83.49442 4.035453 30.29128 -76 21.4375
1546121530861939000 84.41665 4.035453 30.75696 -75 19.125

> -- Latest metrics
> PRECISION rfc3339
> SELECT * FROM "iSpindel000" WHERE time > now() -5m ORDER BY time DESC LIMIT 10
time Combined Influx points angle battery gravity rssi temperature
---- ----------------------- ----- ------- ------- ---- -----------
2019-04-12T14:15:29.715678Z 1 71.6947 4.233577 22.67045 -68 21.9375
2019-04-12T14:14:58.997279Z 1 71.58447 4.233577 22.51496 -67 21.9375

```

### [azure-pipelines.yml](./azure-pipelines.yml)

[Azure](https://dev.azure.com) can automatically test and deploy all commits you push to GitHub. If you haven't enabled travis for your repository: don't worry, it won't do anything.

To deploy your software, you will also need [PyPi](https://pypi.org/) and [Docker Hub](https://hub.docker.com/) accounts.

## TODO

- Give a docker-compose configuration to expose the service in http (default is now https which is not supported by iSpindel)
- Support an HTTP token that can be set in the docker-compose file.

## Limitations

- There is no security on the iSpindel endpoint