From 77aba570a3a94cdcf78e82dc0ebbff0c3dde41d1 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Sun, 23 Jun 2024 14:16:41 +0200
Subject: clean up documentation for puzzle modules

---
 puzzle/vault/CMakeLists.txt | 12 ++----------
 puzzle/vault/index.dox      |  5 +++++
 puzzle/vault/makefile       | 12 ------------
 puzzle/vault/mod.c          |  4 ++--
 4 files changed, 9 insertions(+), 24 deletions(-)

(limited to 'puzzle/vault')

diff --git a/puzzle/vault/CMakeLists.txt b/puzzle/vault/CMakeLists.txt
index b0f05f2..bc13c8c 100644
--- a/puzzle/vault/CMakeLists.txt
+++ b/puzzle/vault/CMakeLists.txt
@@ -7,26 +7,18 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
 # enable debug features
 set(CMAKE_BUILD_TYPE Debug)
 add_compile_definitions(DEBUG)
-# add_compile_options(-O0) # no optimizations
 
 # arduino
 set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/lib/Arduino-CMake-Toolchain/Arduino-toolchain.cmake)
-# set(ARDUINO_BOARD "Arduino Uno [avr.uno]")
 set(ARDUINO_BOARD "Arduino Mega or Mega 2560 [avr.mega]")
 
 # freertos
 add_library(freertos_config INTERFACE)
 target_include_directories(freertos_config SYSTEM INTERFACE .)
-# set(FREERTOS_PORT GCC_ATMEGA) # Arduino Uno
-set(FREERTOS_PORT GCC_ATMEGA) # Arduino Uno
+set(FREERTOS_PORT GCC_ATMEGA)
 set(FREERTOS_HEAP 4)
 
-# used for testing
-# set(ARDUINO_BOARD "Raspberry Pi Pico W [rp2040.rpipicow]")
-# add_compile_definitions(USE_TINYUSB)
-# include_directories(/home/loek/.arduino15/packages/rp2040/hardware/rp2040/3.9.2/libraries/Adafruit_TinyUSB_Arduino/src/arduino)
-
-project(pb_mod_dummy C CXX)
+project(pb_mod_vault C CXX)
 
 add_subdirectory(lib/pbdrv)
 add_subdirectory(lib/FreeRTOS-Kernel)
diff --git a/puzzle/vault/index.dox b/puzzle/vault/index.dox
index b14e616..15eae1f 100644
--- a/puzzle/vault/index.dox
+++ b/puzzle/vault/index.dox
@@ -3,4 +3,9 @@
 \ingroup puz
 \defgroup puz_vault Vault
 \brief Vault puzzle module
+
+\par Setup
+- Use the Arduino IDE library manager to install the "TM1637" library (by
+	Avishay Orpaz) and its dependencies
+
 */
diff --git a/puzzle/vault/makefile b/puzzle/vault/makefile
index 509d8e3..26e9157 100644
--- a/puzzle/vault/makefile
+++ b/puzzle/vault/makefile
@@ -6,15 +6,3 @@ export SERIAL_PORT ?= /dev/ttyACM0
 flash: upload-main;
 upload-main: $(TARGET)
 
-test: test_a test_b;
-
-test_a:
-	$(MAKE) -C . clean
-	$(MAKE) -E CMFLAGS+=-D\ CMAKE_CXX_FLAGS=-DTEST_A -C .
-	$(MAKE) -E SERIAL_PORT=/dev/ttyACM0 -C . flash
-
-test_b:
-	$(MAKE) -C . clean
-	$(MAKE) -E CMFLAGS+=-D\ CMAKE_CXX_FLAGS=-DTEST_B -C .
-	$(MAKE) -E SERIAL_PORT=/dev/ttyACM1 -C . flash
-
diff --git a/puzzle/vault/mod.c b/puzzle/vault/mod.c
index 058a585..bae8a3d 100644
--- a/puzzle/vault/mod.c
+++ b/puzzle/vault/mod.c
@@ -1,6 +1,6 @@
 #include "pb.h"
 #include "pb-mod.h"
 
-const char * PB_MOD_NAME = "dummy";
-const i2c_addr_t PB_MOD_ADDR = PB_ADDR_MOD_DUMMY;
+const char * PB_MOD_NAME = "vault";
+const i2c_addr_t PB_MOD_ADDR = PB_ADDR_MOD_VAULT;
 
-- 
cgit v1.2.3