Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joshua-8 committed Dec 12, 2022
1 parent 80c8fc7 commit e64cbe0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 3 additions & 1 deletion src/src.ino
Original file line number Diff line number Diff line change
@@ -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 <Arduino.h>

Expand Down

0 comments on commit e64cbe0

Please sign in to comment.