README.md

Saaf water Hardware

Saaf water hardware collects data, displays water quality and estimates or sends data to IBM Watson IoT Platform via MQTT Protocol. To do so it comprises of 5 units namely:

• Power Unit
  • 5V 3A DC Power Adapter or equivalent Solar Panel with the appropriate battery and it's charge & protection circuit
• Microcontroller Unit (MCU)
  • ESP32 Dev Module
  • ADS1115 External ADC
• Sensing Unit
  • TDS Senor
  • Turbidity Sensor
  • pH Sensor
  • Electrical Conductivity Sensor
  • Waterproof Temperature Sensor DS18B20
• Visual Indicator
  • Adafruit Neopixel 16 LED Ring
• Telemetry
  • SIM800l Module
  • OR WiFi 2.4 GHz if ESP32 Dev Board

Getting started with Saaf water Hardware

There are 3 hardware codes:

1. Hardware Node: This is the Arduino code for the cellular device
2. Testing Hardware Node: This is the Arduino code for WiFi enabled device and testing
3. Simulator: This file can be imported in the IBM Watson IoT Platform to use the simulator

Procedure

Note: Setup your hardware and configure IBM IoT Platform (Click here for guide)

1. Install Arduino IDE
2. Configure ESP32 prerequisites in Arduino IDE
3. Copy all libraries from the library folder to your local Arduino IDE's library folder
4. Select hardware code and change the configuration information according to your setup
5. Upload!

How to Contribute

Thank you for your interest in contributing to Saaf water! Before you begin writing code, it is important that you share your intention to contribute with the team, based on the type of contribution:

1. You want to propose a new feature and implement it.
   • Post about your intended feature in an issue, and we shall discuss the design and implementation. Once we agree that the plan looks good, go ahead and implement it.
2. You want to implement a feature or bug-fix for an outstanding issue.
   • Search for your issue in the Saaf water Hardware issue list.
   • Pick an issue and comment that you'd like to work on the feature or bug-fix.
   • If you need more context on a particular issue, please ask and we shall provide.

Once you implement and test your feature or bug-fix, please submit a Pull Request to https://github.com/saaf-water/Saaf-water-Hardware.

The project reviewers at this time are :

• Hrishikesh Bhandari (Maintainer)
• Satyam Prakash

License

Saaf water Dashboard is licensed under the Apache Software License, Version 2. Contributions are subject to the Apache Software License, Version 2.