search

Ribbit-Network / ribbit-network-frog-software

The software for the Ribbit Network Frog Sensor
https://www.ribbitnetwork.org/
MIT License
9 stars 8 forks source link
firmware micropython python

readme

Ribbit Frog Software

Chat

Ribbit Network is a large network of open-source, low-cost, Greenhouse Gas (CO2 and hopefully other gasses in the future) Detection Sensors. These sensor units will be sold by the Ribbit Network and will upload their data to the cloud, creating the world's most complete Greenhouse Gas dataset.

This respository contains the software for the Frog Sensor.

Current Software

The current Ribbit Network Frog software is being developed for the Frog Sensor Version 4.

Gettting Started / Dependancies

To get started, you'll need to install a few dependancies first.

ESP IDF

We currently build and test with ESP-IDF v4.4.1.

mkdir -p ~/esp
cd ~/esp
git clone --recursive https://github.com/espressif/esp-idf.git
cd esp-idf
git checkout v5.1.2
git submodule update --init --recursive
./install.sh all

Building the Software

Fetch the submodules:

$ git submodule update --jobs 32 --init --recursive

Set up ESP-IDF:

$ source ~/esp/esp-idf/export.sh

Run tests:

$ make test

Build the firmware:

$ make build

Flash the ESP32

Connect the esp32 board to your computer using the USBC connection port on the esp32 and a cable that will connect to your computer.

Press and hold the "boot" button then press the "reset" button and release both at the same time (shown below). This puts the esp32 into a flashing mode.

image

The device should now appear on your machine as a serial port like "/dev/ttyACM0".

Now the command below can be run to flash the software to the device.

$ make DEVICE=/dev/ttyACM0 flash

Need Help?

If you are not sure where to start or just want to chat join our developer discord here.. You can also start a discussion right here in Github.

View the Data!

The first prototype sensors are up and running! Here is some real data from our sensor network! (Note this dashboard is still experimental and may be down occasionally).

See more about the cloud database here.

Questions?

Check out the Frequently Asked Questions section. If you don't see your question, let us know either in a Github Discussion or via Discord.

Get Involved

Are you interested in getting more involved or leading an effort in the Ribbit Network project? We are recruiting for additional members to join the Core Team. See the Open Roles and descriptions here..

Contributing

See the Issues section of this project for the work that I've currently scoped out to be done. Reach out to me if you are interested in helping out! The projects section helps detail the major efforts going on right now.

We have a contributing guide that details the process for making a contribution.

If you are not sure where to start or just want to chat join our developer discord here.. You can also start a discussion right here in Github.

Background Information

See the Wiki for background research. This project is inspired by some awesome research by incedible scientists in academia.

Ribbit Network

Ribbit Network is a non-profit (501c3) creating the world's largest Greenhouse Gas Emissions dataset that will empower anyone to join in the work on climate and provide informed data for climate action. We're an all volunteer team building everything we do in the open-source community.

If you would like to consider sponsoring Ribbit Nework you can do via this link. The money is used to pay for software fees, purchase R&D hardware and generally support the mission of Ribbit Network.

Ribbit Network Code of Conduct

By participating in this project, you agree to follow the Ribbit Network Code of Conduct and Anti-Harassement Policy. Violations can be reported anonymously by filling out this form .