Initial pass on the design documentation.

The design doc and software design doc.
The UML images are generated with plantUML from the *.puml files.
This commit is contained in:
2025-07-18 12:14:01 -04:00
parent 1181759ace
commit 1c593aff9b
6 changed files with 367 additions and 0 deletions

BIN
docs/uml/switcher.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

35
docs/uml/switcher.puml Normal file
View File

@ -0,0 +1,35 @@
@startuml
interface App
[Switcher] --> [AppID]
[Switcher] --> [App] : use
package "Menu" {
[App] <-- [Menu]
}
package "Badge" {
[App] <-- [Badge]
}
package "Snake" {
[App] <-- [Game]
}
package "NFC" {
[App] <-- [NFC]
}
package "Channel" {
[ButtonReceiver] <-u- [Menu] : use
[ButtonReceiver] <-u- [Badge] : use
[ButtonReceiver] <-u- [Game] : use
[ButtonReceiver] <-u- [NFC] : use
[FrameSender] <-u- [Menu] : use
[FrameSender] <-u- [Badge] : use
[FrameSender] <-u- [Game] : use
[FrameSender] <-u- [NFC] : use
}
@enduml

BIN
docs/uml/tasks.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

13
docs/uml/tasks.puml Normal file
View File

@ -0,0 +1,13 @@
@startuml
skinparam componentStyle rectangle
[Tasks] --> [Switcher]
[Tasks] --> [Display]
package "Button Listeners" {
[Tasks] --> [A Button Listener]
[Tasks] --> [B Button Listener]
[Tasks] --> [Start Button Listener]
}
@enduml