Skip to content

Latest commit

 

History

History
202 lines (137 loc) · 11.7 KB

README.md

File metadata and controls

202 lines (137 loc) · 11.7 KB
Raw

PlatformIO ViewCount Liberapay Status Telegram Group

CanAirIO firmware

CanAirIO Community

A citizen science project that employs both mobile and fixed sensors to measure air quality (PM 2.5 or CO2) and environmental variables. This is achieved using low-cost sensors and smartphones. The project is built around an ESP32 module board integrated with the CanAirIO Android client app.

Don't forget to star ⭐ this repository

Features

  • Super easy web installer, via Chrome or Edge
  • Mobile station (via Bluetooth LE for tag GPS variables)
  • Fixed station, (using only your WiFi)
  • Fast WiFi credentials provisioning via Bluetooth or via
  • CLI tool alternative for configuration and provisioning
  • Based on CanAirIO Sensors Library to support more sensors in the future
  • Automatic firmware OTA updates (with stable/testing channels)
  • Share mobile tracks via mobile.canair.io or CanAirIO app
  • Home Assistant integration, discovery and multisensor support
  • Share your fixed station quickly via Anaire Cloud
  • PAX Counter feature (default wifi sniffer sensor to count people)
  • Multiple boards and sensors supported with only one firmware

Boards supported

The last release of CanAirIO Device supports the next boards:

Firmware Name Boards supported Display Guide and schematics
TTGO_TDISPLAY TTGO T-Display eTFT CanAirIO Bike, CanAirIO Plantower
TTGO_T7 TTGO T7, D1Mini, ** OLED 64x48 CanAirIO v2.1, CanAirIO IKEA
M5STICKCPLUS M5StickC Plus eTFT CanAirIO M5StickC Plus
M5ATOM M5Atom Lite OLED I2C M5Atom Lite sample
ESP32DevKit ESP32DevKit, NodeMCU V3, ** OLED 128x64 HacksterIO
TTGO_TQ TTGO TQ Builtin OLED TTGO_TQ board
WEMOSOLED WemosOLED and similar boards OLED 128x64 ESP32 OLED board
HELTEC ESP32 Heltec board OLED 128x64
ESP32C3 M5STAMPC3** OLED BLE not supported
ESP32C3OIPLUS TTGO-T-OI-Plus OLED BLE not supported
ESP32C3LOLIN LOLIN Mini C3 OLED BLE not supported
ESP32C3SEEDX Seeed_xiao_esp32c3 OLED BLE not supported
TTGO T7S3 LilyGO ESP32S3 T7S3 OLED Config via CLI. BLE notifications
ESP32S3 ESP32S3 CAM Freenove OLED Config via CLI. BLE notifications
ESP32S3 Makerfabs S3 Parallel TFT In development

** is possible that the current firmware supports more boards and sensors. Also you can choose the sensor brand or type on the CanAirIO Android app or on the firmware CLI.

Installation alternatives

We have different alternatives to load the current firmware. By complexity order, they are:

Via CanAirIO Web Installer (RECOMMENDED)

If you already have a ESP32 board, you can test our CanAirIO firmware on one click, with our web installer:

canairio web installer on m5stickcplus
Full video - Web installer

Via CanAirIO loader

You will able to install the last version of CanAirIO firmware using a simple Arduino sketch that it will doing all for you, you only need to use the official Arduino IDE or Arduino Droid app for Android for load this simple sketch. Please follow the instructions here or follow the next YouTube video guide for Android OTG installation alternative.

Via binaries

You can download the last firmware version in releases section. For example, download the last production release from assets section, like this:

releases assets

please uncompress the zip file and connect your CanAirIO device to your USB and execute the next command to upload the firmware to your board, for example for an ESP32DevKit board you should run the next commands:

Linux and MacOSx

unzip canairio_rev414_20190829.zip
cd canairio_installer
esptool --port /dev/ttyUSB0 -b 1500000 write_flash 0x0 canairio_ESP32DEVKIT_rev932_merged.bin

(You should install esptool in your system.)

Windows

Please read the Espressif Uploader section in the main documentation to have details of how load the firmware via the official Espressif Download Tool in Windows.

Via PlatformIO (Compiling on Linux, Mac or Windows)

Please install first PlatformIO open source ecosystem for IoT development compatible with Arduino IDE and its command line tools (Windows, MacOs and Linux). Also, you may need to install git in your system.

For the default board TTGO_TDISPLAY (CanAirIO Bike), clone and upload firmware via USB cable:

git clone https://github.com/kike-canaries/canairio_firmware
cd canairio_firmware
pio run --target upload

For a specific firmware for example for a TTGO-T7 board, only change the last line for:

pio run -e TTGO_T7 --target upload

Via Docker

First build the Docker image using the following command line:

docker build -t canairio_pio:master .

This build a basic compiler image with all PlatformIO stuff. For build the project you only needs now run:

./docker_build run

OTA WAN updates

CanAirIO offers two channels for remote OTA (Over-The-Air) updates for your device: the production channel and the development channel. This means you won't need to reinstall the firmware manually for any updates; it's all automatic. You only need to have Wi-Fi enabled on your device to receive these firmware updates.

If you're interested in the latest testing updates, please go to the releases section and choose and download the development firmware (a zip file with dev in its name), then upload it to your board to receive these kind of updates.

Supporting the project

If you want to contribute to the code or documentation, consider posting a bug report, feature request or a pull request.

When creating a pull request, we recommend that you do the following:

  • Clone the repository
  • Create a new branch for your fix or feature. For example, git checkout -b fix/my-fix or git checkout -b feat/my-feature.
  • Run to any clang formatter if it is a code, for example using the vscode formatter. We are using Google style. More info here
  • Document the PR description or code will be great
  • Target your pull request to be merged with devel branch

Also you can consider make a donation, be a patron or buy a device:

NOTE:
Supporting our Citizen Science Initiative many people be able to fight for air quality rights in many countries with this kind of problems. More info in CanAir.IO

CanAirIO device HOWTO guide

We have some build guides with different alternatives, please visit our CanAirIO documentation.

CanAirIO CO2 and Mini

Building Guide

Soldering Guide (some improvements)

Box STL files

** W A R N N I N G **

The last versions for all box versions, are in the official repository because it is more easy for handling the versions than Thingiverse.

TODO

  • Enable/Disable APIs from App
  • Locatitation settings via Bluetooth
  • Sensors manager is now a library (CanAirIO Sensorlib)
  • Auto detection of PM sensors (see sensorlib doc)
  • CO2 sensors in chart
  • OTA updates (LAN and WAN) (dev/prod, see releases for details)
  • Multiple variables in chart (C02,PM2.5,Hum,Temp,etc)
  • Map of each recorded track in details
  • InfluxDB schema (by geohashes)
  • New pax counter variable (People around the device)
  • WiFi SSIDs scanner for have a choose list of it in the app
  • Pax counter disable/enable
  • Home Assistant integration (with zero-config)
  • Anaire cloud integration (Automatic time series of your station)
  • Fahrenheit and Kelvin units supported
  • Geiger sensor supported
  • Sensor community alternativa for fixed stations
  • Anonymous authentication