aboutsummaryrefslogtreecommitdiff
path: root/puzzle/vault
diff options
context:
space:
mode:
Diffstat (limited to 'puzzle/vault')
-rw-r--r--puzzle/vault/CMakeLists.txt49
-rw-r--r--puzzle/vault/FreeRTOSConfig.h52
-rw-r--r--puzzle/vault/arduino-vaultpuzzle/arduino-vaultpuzzle.ino150
-rw-r--r--puzzle/vault/console-vaultpuzzle/vault.cpp130
-rw-r--r--puzzle/vault/index.dox6
l---------puzzle/vault/lib1
-rw-r--r--puzzle/vault/main.cpp165
-rw-r--r--puzzle/vault/makefile20
-rw-r--r--puzzle/vault/mod.c6
9 files changed, 299 insertions, 280 deletions
diff --git a/puzzle/vault/CMakeLists.txt b/puzzle/vault/CMakeLists.txt
new file mode 100644
index 0000000..b0f05f2
--- /dev/null
+++ b/puzzle/vault/CMakeLists.txt
@@ -0,0 +1,49 @@
+cmake_minimum_required(VERSION 3.29)
+
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_CXX_STANDARD 17)
+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_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)
+
+add_subdirectory(lib/pbdrv)
+add_subdirectory(lib/FreeRTOS-Kernel)
+
+add_executable(main
+ main.cpp
+ mod.c
+ )
+
+target_link_libraries(main PUBLIC
+ pbdrv-mod
+ )
+target_link_arduino_libraries(main PUBLIC
+ core
+ Wire
+ TM1637
+ )
+
+target_enable_arduino_upload(main)
+
diff --git a/puzzle/vault/FreeRTOSConfig.h b/puzzle/vault/FreeRTOSConfig.h
new file mode 100644
index 0000000..c0acc49
--- /dev/null
+++ b/puzzle/vault/FreeRTOSConfig.h
@@ -0,0 +1,52 @@
+#pragma once
+
+#define configUSE_PREEMPTION 1
+#define configUSE_IDLE_HOOK 0
+#define configUSE_TICK_HOOK 0
+#define configMAX_PRIORITIES 32
+#define configMINIMAL_STACK_SIZE ((configSTACK_DEPTH_TYPE) 192)
+#define configUSE_16_BIT_TICKS 1
+#define configIDLE_SHOULD_YIELD 1
+#define configUSE_MUTEXES 1
+#define configUSE_RECURSIVE_MUTEXES 1
+#define configUSE_APPLICATION_TASK_TAG 0
+#define configUSE_COUNTING_SEMAPHORES 1
+#define configQUEUE_REGISTRY_SIZE 8
+#define configUSE_QUEUE_SETS 0
+#define configUSE_TIME_SLICING 1
+#define configSTACK_DEPTH_TYPE uint16_t
+#define configSUPPORT_STATIC_ALLOCATION 0
+#define configSUPPORT_DYNAMIC_ALLOCATION 1
+// #define configTOTAL_HEAP_SIZE (1024)
+#define configTOTAL_HEAP_SIZE (5 * 1024)
+#define configCHECK_FOR_STACK_OVERFLOW 0
+#define configUSE_MALLOC_FAILED_HOOK 0
+#define configUSE_DAEMON_TASK_STARTUP_HOOK 0
+#define configGENERATE_RUN_TIME_STATS 0
+#define configUSE_TRACE_FACILITY 0
+#define configUSE_STATS_FORMATTING_FUNCTIONS 0
+#define configUSE_TIMERS 1
+#define configTIMER_TASK_PRIORITY (configMAX_PRIORITIES - 1)
+#define configTIMER_QUEUE_LENGTH 10
+#define configTIMER_TASK_STACK_DEPTH 92
+
+#include <assert.h>
+#define configASSERT(x) assert(x)
+
+#define INCLUDE_vTaskPrioritySet 1
+#define INCLUDE_uxTaskPriorityGet 1
+#define INCLUDE_vTaskDelete 1
+#define INCLUDE_vTaskSuspend 1
+#define INCLUDE_vTaskDelayUntil 1
+#define INCLUDE_vTaskDelay 1
+#define INCLUDE_xTaskGetSchedulerState 1
+#define INCLUDE_xTaskGetCurrentTaskHandle 1
+#define INCLUDE_uxTaskGetStackHighWaterMark 1
+#define INCLUDE_xTaskGetIdleTaskHandle 1
+#define INCLUDE_eTaskGetState 1
+#define INCLUDE_xTimerPendFunctionCall 1
+#define INCLUDE_xTaskAbortDelay 1
+#define INCLUDE_xTaskGetHandle 1
+#define INCLUDE_xTaskResumeFromISR 1
+#define INCLUDE_xQueueGetMutexHolder 1
+
diff --git a/puzzle/vault/arduino-vaultpuzzle/arduino-vaultpuzzle.ino b/puzzle/vault/arduino-vaultpuzzle/arduino-vaultpuzzle.ino
deleted file mode 100644
index 4dd8ac8..0000000
--- a/puzzle/vault/arduino-vaultpuzzle/arduino-vaultpuzzle.ino
+++ /dev/null
@@ -1,150 +0,0 @@
-#include <Wire.h>
-#include <TM1637Display.h>
-
-// Definitions for GPIO numbers, change these according to your hardware setup
-#define TOTAL_LEVELS 5
-#define TAG "VaultPuzzle"
-
-// Key Matrix Pin Configuration
-#define ROWS 4
-#define COLS 3
-
-// Module connection pins (Digital Pins for TM1637)
-#define CLK 2
-#define DIO 3
-
-// Pin to indicate puzzle solved state
-#define SOLVED_PIN 53
-
-// Initialize the TM1637 display
-TM1637Display display(CLK, DIO);
-
-//TODO Update these pin numbers based on your Arduino setup
-const int ROW_PINS[ROWS] = {7, 6, 5, 4};
-const int COL_PINS[COLS] = {10, 9, 8};
-
-typedef enum {
- STATE_UNINITIALIZED = 0x00,
- STATE_RESET = 0x01,
- STATE_PLAYING = 0x02,
- STATE_SOLVED = 0x03,
- STATE_ERROR = 0x04
-} PuzzleState;
-
-const char* validButtons[TOTAL_LEVELS] = {"A2", "B1", "D3", "C2", "C1"};
-PuzzleState puzzleState = STATE_UNINITIALIZED;
-int currentLevel = 0;
-
-// Function prototypes
-void display_code(int level);
-void initialize_system();
-void check_button_press();
-void update_state_after_button_press(bool validPress);
-void play_error_sound();
-void blink_display();
-
-void setup() {
- Serial.begin(115200); // Initialize default Serial for debug messages
- pinMode(SOLVED_PIN, OUTPUT); // Initialize the solved indicator pin
- digitalWrite(SOLVED_PIN, LOW); // Start with the solved pin LOW
-
- display.setBrightness(0x0f); // Set the brightness of the TM1637 display
- initialize_system();
- Serial.println("GPIO and display initialized.");
-
- // Test to light up all segments
- uint8_t allOn[] = {0xFF, 0xFF, 0xFF, 0xFF}; // All segments on
- display.setSegments(allOn);
- delay(2000); // Keep it on for 2 seconds before proceeding
-
- // Initialize the game
- if (true) { // Simulating isVaultClosed
- puzzleState = STATE_RESET;
- currentLevel = 0;
- display_code(currentLevel);
- } else {
- Serial.println("Vault door is open. Please close the door to start the puzzle.");
- }
-}
-
-void initialize_system() {
- // Configure the rows as input with pull-up
- for (int i = 0; i < ROWS; i++) {
- pinMode(ROW_PINS[i], INPUT_PULLUP);
- }
-
- // Configure the columns as output
- for (int i = 0; i < COLS; i++) {
- pinMode(COL_PINS[i], OUTPUT);
- digitalWrite(COL_PINS[i], HIGH);
- }
-}
-
-void loop() {
- while (puzzleState != STATE_SOLVED) {
- check_button_press();
- delay(100); // Non-blocking delay
- }
- // When puzzle is solved, you might want to display a final message and set the solved pin high
- if (puzzleState == STATE_SOLVED) {
- digitalWrite(SOLVED_PIN, HIGH); // Set the solved pin high
- display.showNumberDec(currentLevel, true); // Show final level or a special message
- Serial.println("Final display shown. Puzzle complete.");
- while (1) { delay(1000); } // Hold on the final display
- }
-}
-
-void display_code(int level) {
- Serial.print("Displaying code for level "); Serial.println(level);
- // Display the level on the TM1637 4-digit 7-segment display
- display.showNumberDec(level, true); // True to show leading zeros
- Serial.print("Code for level "); Serial.print(level); Serial.println(" displayed successfully.");
-}
-
-void check_button_press() {
- char keyPress[3] = {0};
- for (int col = 0; col < COLS; col++) {
- digitalWrite(COL_PINS[col], LOW); // Activate column
- for (int row = 0; row < ROWS; row++) {
- if (digitalRead(ROW_PINS[row]) == LOW) { // Detect if any row is activated
- delay(50); // Debounce delay
- if (digitalRead(ROW_PINS[row]) == LOW) { // Confirm the button is still pressed
- keyPress[0] = 'A' + row;
- keyPress[1] = '1' + col;
- keyPress[2] = '\0';
- Serial.print("Keypress detected: "); Serial.println(keyPress);
- if (strcmp(keyPress, validButtons[currentLevel]) == 0) {
- currentLevel++;
- if (currentLevel >= TOTAL_LEVELS) {
- puzzleState = STATE_SOLVED;
- Serial.println("Puzzle solved!");
- display.showNumberDec(currentLevel + 1, true); // Display the final level
- digitalWrite(SOLVED_PIN, HIGH); // Set the solved pin high
- } else {
- puzzleState = STATE_PLAYING;
- display_code(currentLevel);
- }
- } else {
- play_error_sound();
- blink_display();
- puzzleState = STATE_ERROR;
- currentLevel = 0;
- display_code(currentLevel);
- }
- while (digitalRead(ROW_PINS[row]) == LOW) {} // Wait for release
- }
- }
- }
- digitalWrite(COL_PINS[col], HIGH); // Deactivate column
- }
-}
-
-void play_error_sound() {
- // Simulate error sound - connect a buzzer to play actual sound
- Serial.println("Playing error sound.");
-}
-
-void blink_display() {
- // Simulate blinking the display - use LEDs or other methods to show visual feedback
- Serial.println("7-segment display is blinking to indicate an error.");
-}
diff --git a/puzzle/vault/console-vaultpuzzle/vault.cpp b/puzzle/vault/console-vaultpuzzle/vault.cpp
deleted file mode 100644
index 3566b3e..0000000
--- a/puzzle/vault/console-vaultpuzzle/vault.cpp
+++ /dev/null
@@ -1,130 +0,0 @@
-#include <iostream>
-#include <string>
-#include <array>
-
-// Definitions for puzzle requirements
-constexpr int TOTAL_LEVELS = 5;
-
-// Enumeration for the states of the puzzle
-enum PuzzleState {
- STATE_UNINITIALIZED,
- STATE_RESET,
- STATE_PLAYING,
- STATE_SOLVED,
- STATE_ERROR
-};
-
-// This array maps each level to the correct button press
-const std::array<std::string, TOTAL_LEVELS> validButtons = {"A3", "F1", "U4", "C2", "L1"};
-
-PuzzleState puzzleState = STATE_UNINITIALIZED;
-int currentLevel = 0;
-
-// Function prototypes
-void displayCode(int level);
-void sendI2CUpdate(PuzzleState state);
-
-// Simulate sending an I2C update
-void sendI2CUpdate(PuzzleState state) {
- std::cout << "Sending state " << state << " to main controller via I2C.\n";
-}
-
-// Simulate checking if the vault door is closed
-bool isVaultClosed() {
- return true; // Return true if the door sensor indicates closed
-}
-
-// Function to display a code on the 7-segment display
-void displayCode(int level) {
- std::cout << "Displaying code for level " << level << " on the 7-segment display.\n";
-}
-
-// Function to initialize the puzzle
-void initializePuzzle() {
- if (isVaultClosed()) {
- puzzleState = STATE_RESET;
- currentLevel = 1; // Start at level 1
- std::cout << "Puzzle initialized. Starting at level " << currentLevel << ".\n";
- displayCode(currentLevel); // Show the first code
- } else {
- std::cout << "Vault door is open. Please close the door to start the puzzle.\n";
- }
-}
-
-// Function to lock the vault
-void lockVault() {
- std::cout << "Vault locked.\n";
-}
-
-// Function to unlock the vault
-void unlockVault() {
- std::cout << "Vault unlocked!\n";
-}
-
-// Function to simulate the buzzer sound
-void playErrorSound() {
- std::cout << "Playing error sound.\n";
-}
-
-// Function to simulate blinking the 7-segment display
-void blinkDisplay() {
- std::cout << "7-segment display is blinking to indicate an error.\n";
-}
-
-// Validate the button press for the current level
-bool isValidButtonPress(const std::string& button, int level) {
- return button == validButtons[level - 1];
-}
-
-// Function to update the state of the puzzle based on the current level
-void updateStateAfterButtonPress(bool validPress) {
- if (validPress) {
- if (currentLevel >= TOTAL_LEVELS) {
- puzzleState = STATE_SOLVED;
- unlockVault();
- } else {
- puzzleState = STATE_PLAYING;
- displayCode(currentLevel);
- }
- } else {
- puzzleState = STATE_ERROR;
- playErrorSound();
- blinkDisplay();
- lockVault();
- currentLevel = 1; // Reset to level 1
- displayCode(currentLevel);
- }
- sendI2CUpdate(puzzleState); // Notify main controller of the state change
-}
-
-int main() {
- initializePuzzle();
-
- std::string buttonInput;
-
- while (puzzleState != STATE_SOLVED) {
- std::cout << "Enter the button pressed for level " << currentLevel << " (format Xn, e.g., A3): ";
- std::getline(std::cin, buttonInput);
-
- if (!buttonInput.empty() && isValidButtonPress(buttonInput, currentLevel)) {
- currentLevel++;
- if (currentLevel > TOTAL_LEVELS) {
- puzzleState = STATE_SOLVED;
- unlockVault();
- std::cout << "The puzzle is solved and the vault is open!\n";
- } else {
- displayCode(currentLevel);
- }
- } else {
- playErrorSound();
- blinkDisplay();
- lockVault();
- puzzleState = STATE_RESET;
- currentLevel = 1;
- displayCode(currentLevel);
- }
- sendI2CUpdate(puzzleState);
- }
-
- return 0;
-}
diff --git a/puzzle/vault/index.dox b/puzzle/vault/index.dox
new file mode 100644
index 0000000..b14e616
--- /dev/null
+++ b/puzzle/vault/index.dox
@@ -0,0 +1,6 @@
+// vim:ft=doxygen
+/**
+\ingroup puz
+\defgroup puz_vault Vault
+\brief Vault puzzle module
+*/
diff --git a/puzzle/vault/lib b/puzzle/vault/lib
new file mode 120000
index 0000000..58677dd
--- /dev/null
+++ b/puzzle/vault/lib
@@ -0,0 +1 @@
+../../lib \ No newline at end of file
diff --git a/puzzle/vault/main.cpp b/puzzle/vault/main.cpp
new file mode 100644
index 0000000..76e5f65
--- /dev/null
+++ b/puzzle/vault/main.cpp
@@ -0,0 +1,165 @@
+#include <Arduino.h>
+#include <Wire.h>
+#include <TM1637Display.h>
+
+#define TOTAL_LEVELS 5
+#define ROWS 4
+#define COLS 3
+#define CLK 2
+#define DIO 3
+#define SOLVED_PIN 53
+#define I2C_MODULE_ADDRESS 0x08 // Address of the puzzle module
+#define HANDSHAKE_RECEIVED {0x70, 0x75, 0x7a, 0x62, 0x75, 0x73} // Magic command for the handshake
+#define HANDSHAKE_SEND {0x67, 0x61, 0x6d, 0x69, 0x6e, 0x67} // Magic command for the handshake
+#define REQUEST_STATE_CMD 0x53 // 'S' to request the game state
+
+const int ROW_PINS[ROWS] = {7, 6, 5, 4};
+const int COL_PINS[COLS] = {10, 9, 8};
+const char* validButtons[TOTAL_LEVELS] = {"A2", "B1", "D3", "C2", "C3"};
+const char bombCode[] = "1234";
+
+TM1637Display display(CLK, DIO);
+
+typedef enum {
+ STATE_UNINITIALIZED = 0x00,
+ STATE_RESET = 0x01,
+ STATE_PLAYING = 0x02,
+ STATE_SOLVED = 0x03,
+ STATE_ERROR = 0x04
+} PuzzleState;
+
+PuzzleState puzzleState = STATE_UNINITIALIZED;
+int currentLevel = 0;
+
+void requestEvent() {
+ if (puzzleState == STATE_PLAYING) {
+ uint8_t responseData[] = HANDSHAKE_SEND;
+ Wire.write(responseData, sizeof(responseData));
+ Serial.println("Handshake response sent.");
+ }
+}
+
+void blink_display(char num) {
+ while(puzzleState == STATE_UNINITIALIZED || puzzleState == STATE_ERROR) {
+ display.showNumberDecEx(0, 0b11111111, true); // Display "0000" with all digits on
+ delay(500);
+ display.clear();
+ delay(500);
+ }
+}
+
+void display_final_code(const char* code) {
+ uint8_t segs[4] = {0, 0, 0, 0};
+ int numDigits = strlen(code);
+ numDigits = numDigits > 4 ? 4 : numDigits;
+
+ for (int i = 0; i < numDigits; i++) {
+ segs[i] = display.encodeDigit(code[i] - '0');
+ }
+
+ display.setSegments(segs, numDigits, 0);
+}
+
+void check_button_press() {
+ for (int col = 0; col < COLS; col++) {
+ digitalWrite(COL_PINS[col], LOW);
+ for (int row = 0; row < ROWS; row++) {
+ if (digitalRead(ROW_PINS[row]) == LOW) {
+ delay(50);
+ if (digitalRead(ROW_PINS[row]) == LOW) {
+ char keyPress[3] = {'A' + row, '1' + col, '\0'};
+ Serial.print("Keypress detected: ");
+ Serial.println(keyPress);
+ if (strcmp(keyPress, validButtons[currentLevel]) == 0) {
+ currentLevel++;
+ if (currentLevel >= TOTAL_LEVELS) {
+ puzzleState = STATE_SOLVED;
+ Serial.println("Puzzle solved!");
+ display.showNumberDec(currentLevel + 1, true);
+ digitalWrite(SOLVED_PIN, HIGH);
+ } else {
+ puzzleState = STATE_PLAYING;
+ }
+ } else {
+ currentLevel = 0;
+ }
+ while (digitalRead(ROW_PINS[row]) == LOW) {} // Ensure button release
+ }
+ }
+ }
+ digitalWrite(COL_PINS[col], HIGH);
+ }
+}
+
+void initialize_system() {
+ for (int i = 0; i < ROWS; i++) {
+ pinMode(ROW_PINS[i], INPUT_PULLUP);
+ }
+ for (int i = 0; i < COLS; i++) {
+ pinMode(COL_PINS[i], OUTPUT);
+ digitalWrite(COL_PINS[i], HIGH);
+ }
+ Serial.println("GPIO and display initialized.");
+}
+
+void receiveEvent(int howMany) {
+ if (howMany == 6) {
+ uint8_t expectedBytes[] = HANDSHAKE_RECEIVED;
+ uint8_t receivedBytes[6];
+ bool match = true;
+
+ for (int i = 0; i < 6; i++) {
+ receivedBytes[i] = Wire.read();
+ if (receivedBytes[i] != expectedBytes[i]) {
+ match = false;
+ break;
+ }
+ }
+
+ if (match) {
+ Serial.println("Correct handshake data received.");
+ puzzleState = STATE_PLAYING;
+ initialize_system();
+ } else {
+ Serial.println("Incorrect handshake data received.");
+ puzzleState = STATE_ERROR;
+ }
+ } else {
+ Serial.print("Received wrong number of bytes: ");
+ Serial.println(howMany);
+ puzzleState = STATE_ERROR;
+ }
+}
+
+
+void setup() {
+ Serial.begin(115200);
+ pinMode(SOLVED_PIN, OUTPUT);
+ digitalWrite(SOLVED_PIN, LOW);
+ display.setBrightness(0x0f);
+
+ Wire.begin(I2C_MODULE_ADDRESS);
+ Wire.onRequest(requestEvent);
+ Wire.onReceive(receiveEvent);
+
+ // Initialize display with blinking zeros to indicate no connection or initialization state
+ blink_display('0');
+}
+
+void loop() {
+ switch(puzzleState) {
+ case STATE_PLAYING:
+ check_button_press();
+ delay(100);
+ break;
+ case STATE_SOLVED:
+ display_final_code(bombCode);
+ digitalWrite(SOLVED_PIN, HIGH);
+ Serial.println("Final display shown. Puzzle complete.");
+ break;
+ case STATE_ERROR:
+ case STATE_UNINITIALIZED:
+ blink_display('0');
+ break;
+ }
+} \ No newline at end of file
diff --git a/puzzle/vault/makefile b/puzzle/vault/makefile
new file mode 100644
index 0000000..509d8e3
--- /dev/null
+++ b/puzzle/vault/makefile
@@ -0,0 +1,20 @@
+TARGET = $(BUILD_DIR)/main.elf
+
+include ../../lazy.mk
+
+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
new file mode 100644
index 0000000..058a585
--- /dev/null
+++ b/puzzle/vault/mod.c
@@ -0,0 +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;
+