From 0860e6d023645d61ac1a79ec6bb3071e57f26496 Mon Sep 17 00:00:00 2001 From: Tanner Collin Date: Tue, 14 Oct 2025 15:55:48 -0600 Subject: [PATCH] Add theory to README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 5e8f1b8..e61ebfd 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,34 @@ Controls the welcome room Vestaboard directly, bypassing their cloud. ![a split flap display with the words "PROTOFLAP BY PROTOSPACE"](media/signpic.jpg) +## Theory + +Polls URL (https://api.my.protospace.ca/stats/) continuously and looks for +changes to the `vestaboard` key. When updated, it replaces any special +characters and then displays the message on the sign via serial. + +If you want to use this, just call `send_sign(text)` in protoflap.py directly. + +The split flap controller is connected to serial at `/dev/ttyAMA0`, 38400 baud. + +### See Also + +@Benno1308's reverse engineering: + +https://github.com/EngineOwningSoftware/Vestaboard-Reverse-Engineering + +https://www.reddit.com/r/Vestaboard/comments/tjm93n/local_device_api/ ## Setup +Download the Vestaboard root private key. It should be the same for all +Vestaboards: + +``` +$ curl https://files.catbox.moe/kvibj6 > ~/.ssh/vestaboard +$ chmod 600 ~/.ssh/vestaboard +``` + SSH into the Vestaboard using the root key, ie: ```