Cleanurge

A scalable waste management system powered by IoT.

There are 3 repositories for the entire cleanurge system in total

1. cleanurge-mcu: Containing the source code for the microcontroller
2. cleanurge-backend: Containing the source code for the Express backend
3. cleanurge-app: Containing the source code for the Android App

cleanurge-mcu

This is the repository for the microcontroller part of project- Cleanurge

Contents

1. Description
2. Project structure
3. Project roadmap
4. Getting started
5. TODO
6. Built with
7. Contributing
8. Authors
9. License
10. Acknowledgments

Description

What's the problem?

Today, waste is a significant global issue. Increasing volumes of waste are being generated as the global population and living standards rise. The environmental impact is significant, with massive volumes of waste generated annually with only basic or little treatment to minimise its impact. People are increasingly concerned about the production of waste and its effect, and are seeking ways to deal with the problem.

How can this project help?

Our project serves to prevent overaccumulation of waste at public bins by maintaining a log of their waste accumulation levels. The authorities will have the feature to get live status of the various public bins and appoint garbagemen to clear off any bins on overaccumulation. Moreover, the local residents will be able to report if there is an urgent attention needed in case of an overflow outside the garbage bins or excess accumulation of wastes nearby.

The idea

The idea is to have wireless beacons configured at various public bins to detect and measure the level of waste accumulation at the bins. When the level at any of the bins cross a threshold, a request is triggered to a web server that is then used to send notifications to the authorities in an app as well as web based software. The mobile application also supports the feature for individuals living in the locality to report of any waste accumulation directly to the authorities.

Project structure

This repository hosts only the hardware side code

/
  ├── .github/            github related files like PR templates, contribution guidelines
  ├── PIO-Arduino         This is the "project folder", Open this from PlatformIO (Home) > Open Project
  ├── .gitignore          stores files and directories to be ignored in commits
  ├── LICENSE             the open source license
  ├── code_of_conduct.md  code of conduct for open source contribution
  ├── contributing.md     contribution guidelines
  └── readme.md           details and instructions about the project go here

Project roadmap

The project currently does the following things.

• Global Objects and Variables
• Timing Logic
• Few functions

See below for our future steps.

• Platform IO based firmware for the microcontroller unit
• A sensor to measure the level of waste in the garbage bins which will be accurate as well as economic
• The units are to be solar powered to reduce the maintenance and energy cost.
• Some cheap arrangement to set the location of the beacon (without involving GPS)
• An arrangement to supply internet connection to the beacons in a cheap and practical way
• The data channel should have some sort of security

Getting started

Everyone is welcomed to contribute to our project. Mentioning in bold, you do not need to know the tech stack and tools beforehand to be a part of our project. This is a learn-and-build projects where the contributors build alongside learning the various concepts and technologies involved. Below are a few prerequisites and installation guides:

Prerequisites

Resources needed

• An IDE that supports Platform IO (VS Code recommended)
• (Optional) It is possible to simulate the hardware in "Proteus" (No official guide provided by us)
• Have a look at the cleanurge-backend routes documentation from Cleaurge Backend Docs

Knowledge needed

The best way to learn the following is to google each and everything!

• Very basic understanding of git and github:

  • What are repositories (local - remote - upstream), issues, pull requests
  • How to clone a repository, how to fork a repository, how to set upstreams
  • Adding, committing, pulling, pushing changes to remote repositories

• For IoT

  • Embedded C/C++ language
  • Tune in to the IoT and electronics channel in our discord server and learn more - DSCK Discord

Installing and Working on the source code

A step by step series of instructions that tell you how to get the project running locally is given below. Google every issue you face following the below instructions or just ask us in our Discord / WhatsApp group.

• Fork and clone the repository followed by opening the project in your text editor (with a terminal)
• If you are working with VS code, just go to Extensions -> Install Platform IO
• Press the button in the status bar and Open the project folder which starts with PIO...
• Main code lies in the src/ foler inside each PIO project
• include/ includes .h header files
• lib/ contains the libraries exclusively added from outside
• platformio.ini contains the library dependencies, board properties and all, head on to their website for exact details on that ini files.

TODO

• Make an working prototype on Arduino
  
• Make the design more economic
  
• Improve/Add the logic
  
• Optimise for time and space usage
  

Built with

• Platform IO
• Arduino Framework

Contributing

Please read contributing.md for details on our code of conduct, and the process for submitting pull requests to us. Your PRs will only be reviewed on Sundays only.

Authors

License

This project is licensed under the GNU Public License - see the LICENSE file for details.

Acknowledgments

contributors-img