CanAirIO Air quality Reporter

CanAirIO is a citizen science initiative for air quality tracking, visualization and dissemination by using PM2.5 particulate material sensors paired with your smartphone via bluetooth.

This code is for CanAir.IO Android app that using a DIY device that handle a pollution sensor (Honeywell, Sensirion, Plantower, Panasonic) or others air quality sensors.

Installation

You can install it from the release section downloading the last signed apk or installing from GooglePlay

CanAirIO Device

For test and use the CanAirIO app, is recommended have a CanAirIO device, you can have one with any ESP32 board without any sensor or any wire solder if you want, because CanAirIO has out of the box PAX Counter detector feature, for counts the people around you. For that you only need load our firmware via a easy web tool:

Usage

For now you need any Android device with Bluetooth 4 or above. You can download the CanAirIO app from GooglePlay, keep in mind that it is in continuos development then please any feedback, report errors, or any thing please let us know it via our contact form or on our Telegram chat

You have two configuration options or modes of your CanAirIO device from the app:

Mobile Station Mode

This mode allows you to record tracks on your device or publish it to the cloud (share), please follow the next steps:

• [X] Turn on your Bluetooth
• [X] Allow location and storage permissions
• [X] Scan your device and paring it (connect)
• [X] Record a mobile track on your device
• [X] Share

Tips

• If you aren't recording, you able to exit of your app and the Bluetooth will be over, you don't need unpair the device.
• If you are recording a track, you can put the app in background and using other apps. But not forget stop the recording because it can drain your battery
• In some Android versions, your need the background permission too.

(Connection to CanAirIO device, record a air quality track and share)

Mobile Map

We are developing a new mobile map, you can see the current tracks that the people share here:

Fixed Station Mode

Also, you can connect your CanAirIO device to the WiFi and leave this like a fixed station. In this mode you only need the Android app only for setup the initial settings, after that the device could be publish data without the phone using the WiFi. For this please download the CanAirIO app and setup the WiFi:

WiFi Setup

• Open the app and enter on settings section
• Choose the Wifi Name and set the Password (if it has)
• Save the credentials with the switch.
• Wait for connected status in the summary switch

Publication

After WiFi is ready, please follow the next steps for publish your fixed station:

• save Geohash location (turn on the switch for save, it will go to off after some seconds)
• enable the publication switch
• wait for some minutes, the device should be show data icon some times
• your station should be in our Global Map with the special ID showed in the last item of settings

CanAirIO fixed station (fast setup guide)

CanAirIO Documentation

We have a documentation portal with full information about the device and the app usage.

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.
• Build and test your apk, and 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:

• Via Ethereum:
• 0x1779cD3b85b6D8Cf1A5886B2CF5C53a0E072C108
• Be a patron: Github Sponsors, LiberaPay
• Buy a device: CanAirIO Bike in Tindie
• Inviting us a coffee: buymeacoffee, Sponsors

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

For our supporters, patrons or donors, we will send the files for our coming version:

CanAirIO CO2 and CanAirIO Mini box

TODO

• [X] BLE scanning and connecting
• [X] Receive data via BLE notification
• [X] Basic chart for PM 2.5 data
• [X] BLE persist connection on background service
• [X] List recorded tracks fragment
• [X] Firebase connection for publish reports
• [X] Open Street map fragment
• [x] Export data to json on external storage (SD)
• [x] Osmdroid routes (for line or dinamic points)
• [ ] Add other air quality APIs to map (AQICN ie)
• [ ] Flutter migration for have to iOS app
• [ ] Osmdroid clusters (for static points)

Building from source code

Dependencies

• Android SDK
• CMake
• Android Studio (optional)

Requirements

Please first clone the project with all submodules:

git clone --recursive https://github.com/kike-canaries/canairio_android.git

Firebase

This application uses a Firebase Database instance to store mobile air quality reports,

For local development, you will need to create a database in the Firebase Console using hpsaturn.pollutionreporter as the application identifier and retrieve a google-services.json file. See instructions here.

After that copy this file into the project:

cd canairio_android && cp ~/google-services.json app/

Aqicn API key (optional)

Please put your Aqicn API key in app/src/main/res/values/api_aqicn.xml or create a fake file like with:

<resources>
    <string name="api_aqicn_key">7cbbbb864b9c0755b8xxxxyyy</string>
</resources>

Compiling

./gradlew assembleDebug

App apk installation

./gradlew installDebug

Credits