Skip to content

mackmoe/arduino-projects

Repository files navigation

Arduino Projects

Tweaked some scripts from other peoples projects that didn't exactly fit my needs but stil... Giving credit where credit is due;

Example

To see this code in action, head over to my self hosted Water Usage Monitor App.

Table of Contents

Introduction

I created this project because I wanted a water flow sensor to help determine when and how much water is being used on this (100GPD) RO filter I got from amazon. It also assists with knowing around when to replace the filters for the system. Both wired and wireless should work but let me explain:

Features

Key features of the project:

  • Both scripts display water useage measurement in gallons, pretty accurately too! 😎
  • The wireless version of the code has a simple dashboard displaying water usage (see the example).
  • The wired version has a python script that prints output from the console but, this script still needs work in order to achieve similar functionality to the wireless version.

Installation

Instructions on how to set up and run the project locally are as follows: Copy the 'arduino_secrets.h' file to the same directory as the script. Then use it store the sensitive data when compiling and uploading the code to your arduino in the Arduino IDE.

  1. Clone (or download) the repository:
    git clone https://github.com/mackmoe/arduino-projects.git
  2. Open your Arduino IDE, any recent release should work.
  3. Connect your Arduino to your computer and once the IDE recognizes it, make sure to update the IDE with all the dependencies for your board. *You may also need some adittional packages for the script later but they should be downloaded automatically for you.
  4. Open the repository folder (after it's been extracted) and navigate to the folder that has the code for your specific Arduino (wired or wireless).
  5. Place a copy of the 'arduino_secrets.h' file in the folder and update the variables.
  6. Verify and upload in the Arduino IDE

Contributing

Instructions on how to contribute to the project:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/feature-name).
  3. Make your changes and commit them (git commit -m 'Add feature').
  4. Push to the branch (git push origin feature/feature-name).
  5. Open a pull request.

License

This project is licensed under the MIT License.

About

my arduino nfo scripts for various projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published