commit a489182bafc30ce62d1fbbad86dafbc4e52b7c56
parent c9661b2095c126785674de0ca5a40c295be73ed5
Author: Martin Kloeckner <mjkloeckner@gmail.com>
Date: Fri, 4 Apr 2025 21:00:23 -0300
updated `README.md`
Diffstat:
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -2,13 +2,32 @@
The idea is to have a device that turns on and off one of it's outputs at a
certain time of the day, and also having the possibility to override the timer
-and toggle the output remotely.
+and toggle the output remotely
To keep the clock synchronized the device uses the Network Time Protocol (NTP)
+## Timer Defined State and User Override State
+
+### Base Timer Function
+
+If the timer is set (`timer_enabled == 1`) then after a defined amount of
+time, the current time gets compared with the timer-set values, if the current
+time fits inside the interval defined by the timer then the output pin
+(`MAIN_OUTPUT_PIN`) gets pulled up and keeps in that state until the current
+time no longer belongs to the interval or if the user manually changes the
+output state, in which case the timer deactivates
+
+### User Override
+
+If the user overrides the state of the output then the timer is deactivated
+(`timer_enabled` is set to `0`)
+
## Dependencies
-* [PlatformIO Core](https://docs.platformio.org/en/latest/core/index.html)
+The project is developed using [PlatformIO
+Core](https://docs.platformio.org/en/latest/core/index.html) which does the
+compiling, uploading to the board and dependency management, but the same code
+can compiled (with some light changes) using the Arduino IDE.
## Building and Uploading to the Board
