aboutsummaryrefslogtreecommitdiff
path: root/puzzle/smoketest/index.dox
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-06-26 14:44:04 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-06-26 14:44:04 +0200
commitcdd1034144da2f606d8f2a57061f694cdaa96cc1 (patch)
treea28a208f6a359a199b239ceb441b477db66dddb4 /puzzle/smoketest/index.dox
parentc1473020106d36b20cde090ac417c253b0059336 (diff)
more important documentation
Diffstat (limited to 'puzzle/smoketest/index.dox')
-rw-r--r--puzzle/smoketest/index.dox15
1 files changed, 10 insertions, 5 deletions
diff --git a/puzzle/smoketest/index.dox b/puzzle/smoketest/index.dox
index 15eae1f..78ff702 100644
--- a/puzzle/smoketest/index.dox
+++ b/puzzle/smoketest/index.dox
@@ -1,11 +1,16 @@
// vim:ft=doxygen
/**
\ingroup puz
-\defgroup puz_vault Vault
-\brief Vault puzzle module
+\defgroup puz_smoketest Smoketest
+\brief Smoketest puzzle module
-\par Setup
-- Use the Arduino IDE library manager to install the "TM1637" library (by
- Avishay Orpaz) and its dependencies
+This puzzle module was used as a substitute for the \ref puz_neo
+"NeoTrellis puzzle module" during the 23-24 assessment due to the I2C issues
+encountered with the Adafruit NeoTrellis modules.
+
+This puzzle module turns on an on-board LED when it is in the \ref
+PB_GS_PLAYING "playing" state, and sets itself to the \ref PB_GS_SOLVED
+"solved" state when an external button is pressed.
*/
+