Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 3.39 KB

README.md

File metadata and controls

68 lines (49 loc) · 3.39 KB
Raw

High Level Overview

  • The raspberry pi runs a docker container inside of Balena OS + Balena Cloud. This makes it easy to deploy software remotely to the PI and will be useful once there is a large fleet of sensors for managing software updates.
  • Inside of the Docker container is a simple Python script that periodically reads data from the sensor and publishes the data to Influx DB.

Main Software Folders / Docker Images

  • co2 - This folder contains the main python script responsible for connecting to the CO2 sensor and publishing the data to the InfluxDB database.
  • gps - This folder contains the dockerfile that configures gpsd to connect to a gps device for recieving the device location.
  • wifi-connect - This is a git submodule to the wifi connect repo. This allows easy reconfiguration of the sensor's wifi connection.

Local Development

The co2 and gpsd folders are Python projects with identical setup. To work on them locally (including helping your IDE understand the dependencies):

  1. Install the Poetry package manager as described here, then in either gpsd or co2:
  2. poetry install to create a virtualenv with all production and development dependencies
  3. poetry run ./check.sh to execute all the linters and tests

Some further notes:

  • You can run poetry run <whatever> to execute commands in the virtualenv, or poetry shell to enter a shell with the virtualenv activated.
  • If your IDE needs help finding the location of the virtualenv, poetry env info will tell you what you need.
  • You can add / remove dependencies with poetry add and poetry remove. Similarly, poetry update can be used to bump the version of dependencies.

Deployment

If you are trying to build a device to contribute data only, we recommend joining our balena open-fleet! If you join the fleet, you'll download an image preconfigured with everything and your device will follow the software updates with the rest of the fleet as we build out the network.

However, if you are building your own sensor for development or your own purpose, you can deploy this code to your bown balena fleet.

The software is deployed via the Balena CLI with the following command:

balena push <balena-fleet-name>

Database Configuration

If you are pusing your own image, note that you will need to setup an instance of InfluxDB for the device to plublish to.

The script is looking for a file called influx_config.ini in the software/co2 directory.

It has the following format:

[influx2]
url=https://us-west-2-1.aws.cloud2.influxdata.com
[email protected]
token=#FIXME
timeout=6000
verify_ssl=True

You'll need to create an InfluxDB accesss token and add it to that file before pushing the balena fleet.

Dashboard Information

See the dashboard repo for more information on the public facing data dashboard.

Main Readme

Head back to the main readme for more info!