Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
CS Fancy Clock
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TheJoeCoder
CS Fancy Clock
Commits
61ff895e
Verified
Commit
61ff895e
authored
9 months ago
by
TheJoeCoder
Browse files
Options
Downloads
Patches
Plain Diff
Add architecture to the README
parent
eaaf548f
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+20
-0
20 additions, 0 deletions
README.md
with
20 additions
and
0 deletions
README.md
+
20
−
0
View file @
61ff895e
...
...
@@ -33,3 +33,23 @@ xhost +
# Run the clock
sudo
./.venv/bin/python3 main.py
```
## Architecture
The main system running the software is a Raspberry Pi Zero 2 W. The display is a 240x240 pixel SPI display.
In terms of software stack:
-
The clock's software is written in Python, using the Pygame library for rendering the display.
-
The software is multithreaded:
-
One thread for the display, which renders the display (with pygame).
-
One thread for the LEDs, controlling the patterns (with either neopixel or dummy led libraries).
-
One thread for the web server, which serves the configuration page and API endpoints.
-
The main thread controls the other threads and handles changes to the configuration.
-
Wayland is used as the display server, as it is faster than X11 and works well with the SPI display.
-
For operating system we use Raspberry Pi OS Lite, with Wayland and the necessary dependencies installed.
It's designed to be:
-
Modular, with different modules - both widgets for the display and patterns for the LEDs that
can be added or removed. The clock can be configured to display different modules in different orders,
and the modules can be easily created or modified.
-
Easily extensible, with a simple API for creating new modules. The clock is also designed to be
easily configurable, with a simple configuration file that can be edited to change the appearance of the clock.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment