aboutsummaryrefslogtreecommitdiff
path: root/puzzle/smoketest
diff options
context:
space:
mode:
Diffstat (limited to 'puzzle/smoketest')
-rw-r--r--puzzle/smoketest/index.dox15
-rw-r--r--puzzle/smoketest/main.cpp2
2 files changed, 12 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.
*/
+
diff --git a/puzzle/smoketest/main.cpp b/puzzle/smoketest/main.cpp
index 6b4d7d0..3169ed5 100644
--- a/puzzle/smoketest/main.cpp
+++ b/puzzle/smoketest/main.cpp
@@ -2,7 +2,9 @@
#include "lib/pbdrv/pb-types.h"
#include "lib/pbdrv/pb-mod.h"
+//! LED pin (on-board LED on Arduino Uno board) \ingroup puz_smoketest
#define EXTERNAL_LED_PIN 13
+//! External button pin (button shorts this pin to ground) \ingroup puz_smoketest
#define BUTTON_PIN 10
pb_global_state_t state = PB_GS_NOINIT;