Skip to content

A LoRaWAN-based air quality sensor for citizen science projects

License

Notifications You must be signed in to change notification settings

MakeMonmouth/lorair

Repository files navigation

LoRAIR - A LoRaWAN Air Quality Monitor for Citizen Science projects

We've stolen a lot of the ideas behind the incredible sensor.community design, but we're using LoRaWAN instead of WiFi and sending the data to Grafana.

Contributing to the project

We'd love as many people to get involved with the project as possible, whether it's code, design, or documentation. Here's how to get started!

Forks, Pulls, and Issues

We understand that many people find the workflow around git complex, so we try to keep it as simple as possible.

We recommend that you use a bit of software known as an "IDE" (don't worry about what it stands for, it's what it does that is the important bit!) that includes git support, such as VSCode. VSCode has a plugin for PlatformIO (more on what that does later) and something called git which is what we use to control how people contribute.

Thankfully, the folks over in the VSCode team have put together a great tutorial on how to get started with clones, forks, and pull requests and you'll want to make yourself familiar with that before you get involved.

If you have any questions, feel free to pop down to a Make Monmouth meeting and one of our team will be happy to help!

Documentation

Documentation is vitally important to any project, especially one that is going to be used by people who may not be experienced in technical areas. We need our documentation to be clear, concise, and easy to follow, and we hope you'll help us achieve that!

Our documentation is written in Markdown and contained within the docs folder.

We use Markdown for our documentation because we can easily export it to all kinds of different formats depending on who needs to read it.

If you've not written documents in Markdown before, then there is an excellent getting started guide you can follow!

Development Environment

We use Python Poetry for dependency management, PlatformIO for the sensor code, and mkdocs for the documentation.

About

A LoRaWAN-based air quality sensor for citizen science projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published