From e64cbe03a8936fe4297d638ca7f843a55bcd6a1a Mon Sep 17 00:00:00 2001 From: joshua-8 Date: Mon, 12 Dec 2022 01:47:45 -0500 Subject: [PATCH] documentation --- README.md | 2 ++ src/src.ino | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b576353..f904fae 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ This repository powers an arduino project consisting of a spinning display of LE # Sample Operation After pressing the on button, the motor speed is set and the device spins up. Once the rotation speed threshold is reached, the LEDs begin to display an image representation of the current time. +A quick summary of how an image is actually displayed is that each time the beam break sensor detects a rotation, if the clock is in the running state, then the beam break ISR starts or adjusts the rate of a timer interrupt, and the timer interrupt updates the LEDs for each column of the image as the clock spins around. + ![Propellor_diagrams drawio (13)](https://user-images.githubusercontent.com/47846691/206894760-a541a390-96aa-418b-9b59-aca229215c41.png) # Finite State Machine (FSM) diff --git a/src/src.ino b/src/src.ino index e2fc08d..eab1e80 100644 --- a/src/src.ino +++ b/src/src.ino @@ -1,5 +1,7 @@ /** - * This file contains Arduino's setup() and loop() functions and the state machine. More generalized + * This file contains Arduino's setup() and loop() functions and the state machine. More generalized functions involving registers and other things are kept in other files. + * @note A quick summary of how an image is actually displayed is that each time the beam break sensor detects a rotation, if the clock is in the running state, then + * the beam break ISR starts or adjusts the rate of a timer interrupt, and the timer interrupt updates the LEDs for each column of the image as the clock spins around. */ #include