Skip to content

Update docs to refer to ESP-IDF 5.1.2 #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damz merged 2 commits into from
Jun 2, 2025
Merged

Update docs to refer to ESP-IDF 5.1.2 #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
470e552
Update docs to refer to ESP-IDF 5.1.2
andypiper Jun 2, 2025
17e7776
Update README.md
andypiper Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ Ribbit Network is a large network of open-source, low-cost, Greenhouse Gas (CO2

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.](https://github.com/Ribbit-Network/ribbit-network-frog-hardware)

## Gettting Started / Dependancies
To get started, you'll need to install a few dependancies first.
## Getting Started / Dependencies

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

### ESP IDF

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

```shell
mkdir -p ~/esp
Expand Down Expand Up @@ -54,13 +54,13 @@ $ 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.
Connect the esp32 board to your computer using the USB-C 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](https://github.com/Ribbit-Network/ribbit-network-frog-software/assets/2559382/046c0e77-cf4e-4546-bbd3-f41e9f136bc7)

The device should now appear on your machine as a serial port like "/dev/ttyACM0".
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.

Expand All @@ -69,30 +69,37 @@ $ 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.](https://discord.gg/vq8PkDb2TC). You can also [start a discussion](https://github.com/Ribbit-Network/ribbit-network-frog-sensor/discussions) right here in Github.

# View the Data!

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

[See more about the cloud database here.](https://github.com/Ribbit-Network/ribbit-network-dashboard)

## Questions?

[Check out the Frequently Asked Questions section.](https://github.com/Ribbit-Network/ribbit-network-faq) 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.](https://ribbitnetwork.notion.site/Core-Team-Role-Postings-105df298e0634f179f8f063c01708069).

## Contributing

See the [Issues](https://github.com/keenanjohnson/ghg-gas-cloud/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](https://github.com/Ribbit-Network/ribbit-network-frog-sensor/projects) helps detail the major efforts going on right now.

We have a [contributing guide](https://github.com/Ribbit-Network/ribbit-network-frog-sensor/blob/main/CONTRIBUTING.md) that details the process for making a contribution.

[If you are not sure where to start or just want to chat join our developer slack here.](https://join.slack.com/t/ribbitnetworkgroup/shared_invite/zt-2vxvbo7ld-S36SgfDiev~ZQ2zvp03FOg). You can also [start a discussion](https://github.com/Ribbit-Network/ribbit-network-frog-software/discussions) right here in Github.

## Background Information
[See the Wiki for background research.](https://github.com/Ribbit-Network/ribbit-network-frog-sensor/blob/main/wiki/Background-Research.md) This project is inspired by some awesome research by incedible scientists in academia.

[See the Wiki for background research.](https://ribbitnetwork.notion.site/Learnings-Low-cost-sensors-for-the-measurement-of-atmospheric-composition-e3d41736c49e41ad81dcdf7e16a6573b) This project is inspired by some awesome research by incredible 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](https://givebutter.com/ribbitnetwork). The money is used to pay for software fees, purchase R&D hardware and generally support the mission of Ribbit Network.
Expand Down