search

COAST-Lab / Open-Water-Level

An open-source, low-cost, DIY ultrasonic water level sensor
MIT License
9 stars 4 forks source link

Updated code and instructions to simplify user experience #46

Closed gracelower closed 1 month ago

gracelower commented 1 month ago

Commits in this pull request include ...

  1. Making changes in sample code to simplify number of steps in instructions, such as:
    • setting PUBLISHING = 0 instead of having sample code = 1 and having users manually change to 0 (to ensure cellular connection / publishing is off & to eliminate a step)
    • adding // function prototype
      int secondsUntilNextEvent();` to sample code instead of having users manually paste this (to ensure these lines are in the right place within code & to eliminate a step)
  2. Making changes in Getting-Started instructions to reflect these changes to the sample code
  3. Renaming photos and updating embedded pathways; also deleting unnecessary photos that are no longer relevant
SUPScientist commented 1 month ago

This looks great to me but noting that I haven't tested the new firmware. @gracelower, can you confirm that you tested this exact firmware (not copying and pasting across files but rather state whether this exact firmware was compiled and flashed with expected results)? Knowing that this is the case will offer some peace of mind.

gracelower commented 1 month ago

My apologies, I definitely could have made that more clear! Yes, this exact code (not copied) was compiled, flashed, and tested with the water level sensor, producing the expected results (pictured).

Screenshot 2024-07-25 at 8 29 13 AM

Note: I didn't change the time between readings from 3600 secs to 30 secs for this test run to ensure code works as it's provided in the repo.

SUPScientist commented 1 month ago

Perfect, thank you, and no apology needed! I just wanted to be extra explicit so that I knew where to pick this up when you leave \. Thanks for confirming.