README.md

Water Monitoring System - IoT Project

You can view the demo here.

Water Monitoring System is an IOT based Liquid Level Monitoring system that has mechanisms to keep the user alerted in case of liquid overflow or when tank depletes. The water tanks can be fixed with ultrasonic sensors that is placed over the container. Ultrasonic sensor is used to measure, compare container depth and liquid level.

The status of the system could be monitored by an LCD screen or a web page that provides a brilliant graphical representation. Colours are used to depict various scenarios with respect to the amount of liquid in the tanks or containers and the buzzer buzzes when the limit exceeds the permissible quantity of fill.

Goals of this project :

• To reduce the wastage of water across the city
• To provide better water supply to the people

  ____                   __        __    _            
 / ___|  __ ___   _____  \ \      / /_ _| |_ ___ _ __ 
 \___ \ / _` \ \ / / _ \  \ \ /\ / / _` | __/ _ \ '__|
  ___) | (_| |\ V /  __/   \ V  V / (_| | ||  __/ |   
 |____/ \__,_| \_/ \___|    \_/\_/ \__,_|\__\___|_|   
  ____                    _     _  __                 
 / ___|  __ ___   _____  | |   (_)/ _| ___            
 \___ \ / _` \ \ / / _ \ | |   | | |_ / _ \           
  ___) | (_| |\ V /  __/ | |___| |  _|  __/           
 |____/ \__,_| \_/ \___| |_____|_|_|  \___|           
                                                      

Click here to download the report.

The IoT(Hardware) components required are:

• AVR family microcontroller
• LCD screen
• Wifi modem
• A buzzer
• 12V transformer

Getting Started

1. Fork this repository.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/Water-Monitoring-System

3. Navigate to the project directory.

cd Water-Monitoring-System

4. Create a new branch.

git checkout -b <your_branch_name>

5. Make changes in source code.

6. Commit your changes.

  git add .
  git commit -m "<your_commit_message>"

7. Push your local branch to the remote repository.

git push -u origin <your_branch_name>

8. Create a PR!

9. Congratulations! Sit and relax, you've made your contribution to Water Monitoring System project.

Issues

TITLE	LEVEL
UI Enhancements	EASY
Project Documentation	VERY EASY
Setting up Cloud APIs to send/receive data	MEDIUM
Admin Dashboard	HARD
Notify stakeholders	ADVANCED

NOTE: Feel free to open issues. Make sure you follow the Issue Template provided.

Contribution Guidelines

• Write clear meaningful git commit messages (Do read this).

• Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)

• When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)

• When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

• Please follow the PR Template to create the PR.

• Always create PR to develop branch.

• Please read our Code of Conduct.

• Refer this for more.

Maintainer

Vinit Shahdeo

Need help? Feel free to contact me @ vinitshahdeo@gmail.com

---

/**
 *
 * {thisRepo.url} = https://github.com/vinitshahdeo/Water-Monitoring-System/
 *
 */
if (thisRepo.isAwesome()) {
    thisRepo.fork(); // waiting for your awesome contributions :)
    thisRepo.star(); // thanks in advance :p
    thisRepo.watch((bug) => {
      if(!doesIssueExists(bug)) {
        createNewIssue(bug); // wow, that's a nice catch
      }
      else {
        checkIssueTracker(bug); // comment there
      }
    });
    thisRepo.share(); // sharing is caring :D
}

---