diff --git a/README.md b/README.md index 997946b..d5b0fb9 100644 --- a/README.md +++ b/README.md @@ -185,6 +185,31 @@ is beyond the range of the timer to correct, you will hear 5 short beeps repeated. +## Calibration And Tuning + +The timer should pretty much be ready to run "out of the box". But, +here are a few ideas on how it can be tuned or adjusted: + +* VERY IMPORTANT: Do **NOT** run the timer with `DEBUG = True`. This + option is for the sofware developer only and introduces extra + output that *makes the timer less accurate*. So, unless you are + hacking on the hardware or software, leave this set to `False`. + +* The `CALIBRATION_OFFSET` variable is designed to help compensate for + the amount of time the master timing loop needs to run on your + particular platform. The default value should be about right for a + Raspberry Pi Zero. If you use a different platform or overclock + your Pi, you may wish to adjust this to calibrate the timer. This + is best done by running the timer in realtime mode (no temperature + compensation), adjusting this variable and seeing how the timer + speed compares to a known good reference timer. + +* You can adjust the individual compensation entries for film or paper + to your liking. The values there are pretty good first + approximations based a fair bit of research, but you can "tweak" + them to suit your style of photography and film development. + + ## Help & Support There isn't any. You can send mail to `devtimer@tundraware.com` and I'll diff --git a/devtimer.py b/devtimer.py index 0caf1ce..a940aaa 100755 --- a/devtimer.py +++ b/devtimer.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # devtimer.py - Temperature Controlled Photographic Darkroom Timer # Targeted for RaspberryPi -# Copyright (c) 2018-2020 TundraWare Inc. +# Copyright (c) 2018-2021 TundraWare Inc. # Permission Hereby Granted For Unrestricted Personal Or Commercial Use # Code Repo Here: https://gitbucket.tundraware.com/tundra/devtimer @@ -24,7 +24,7 @@ # Constants ##### -DEBUG = True # Debugging switch +DEBUG = False # Debugging switch # GPIO Ports And Other Hardware Constants