switch to event based expander interface (WIP)

main/drivers/CMakeLists.txt

@@ -4,15 +4,14 @@ set(SOURCES
     "TM1640/TM1640.cpp"
     "SparkFunBQ27441/SparkFunBQ27441.cpp"
     "esp_lcd_ili9488/esp_lcd_ili9488.c"
-    "bottom_half.cpp"
+    # "bottom_half.cpp"
     "char_lcd.cpp"
     "game_info.cpp"
     "game_timer.cpp"
-    "hwdata.cpp"
     "i2c_lcd_pcf8574.c"
     "i2c.cpp"
+    "inputs.cpp"
     "leds.cpp"
-    "nvs.cpp"
     "perh.cpp"
     "power.cpp"
     "sd.cpp"

main/drivers/SparkFunBQ27441/SparkFunBQ27441.cpp

@@ -729,9 +729,7 @@ uint16_t BQ27441::i2cWriteBytes(uint8_t subAddress, uint8_t * src, uint8_t count
 		w_buff[i+1] = src[i];
 	}
 
-	xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
 	esp_err_t ret = i2c_master_write_to_device(BQ72441_I2C_NUM, _deviceAddress, src, count+1, timeout);
-	xSemaphoreGive(main_i2c_mutex);
 	
 	return ret == ESP_OK;
 }

main/drivers/all.cpp

@@ -4,7 +4,6 @@ void init_drivers() {
     init_i2c();
     // init char_lcd so we can use it to report other initialization errors.
     init_lcd();
-    init_nvs();
     init_star_code_system();
     // init the bottom half so that we can get user input.
     init_bottom_half();

main/drivers/all.h

@@ -6,7 +6,6 @@
 #include "game_timer.h"
 #include "i2c.h"
 #include "leds.h"
-#include "nvs.h"
 #include "power.h"
 #include "sd.h"
 #include "speaker.h"

main/drivers/bottom_half.cpp

@@ -76,7 +76,6 @@ void init_bottom_half() {
 
 static uint8_t receive_delta(void) {
     uint8_t reg = 1;
-    xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
     esp_err_t result = i2c_master_write_read_device(BOTTOM_I2C_NUM, BOTTOM_I2C_ADDR, &reg, 1, buf, 1, (100 / portTICK_PERIOD_MS));
     ESP_ERROR_CHECK_WITHOUT_ABORT(result);
     if (result != ESP_OK) {
@@ -86,11 +85,10 @@ static uint8_t receive_delta(void) {
 }
 
 static void receive_keypad(void) {
+    // TODO: use mutex
     // TODO: change the bottom half polling scheme from a state-based protocol to an event based protocol
     uint8_t reg = 2;
-    xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
     esp_err_t result = i2c_master_write_read_device(BOTTOM_I2C_NUM, BOTTOM_I2C_ADDR, &reg, 1, buf, 2, (100 / portTICK_PERIOD_MS));
-    xSemaphoreGive(main_i2c_mutex);
     ESP_ERROR_CHECK_WITHOUT_ABORT(result);
     if (result != ESP_OK) {
         return;
@@ -119,9 +117,7 @@ static void receive_keypad(void) {
 
 static void receive_button_switch(void) {
     uint8_t reg = 3;
-    xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
     esp_err_t result = i2c_master_write_read_device(BOTTOM_I2C_NUM, BOTTOM_I2C_ADDR, &reg, 1, buf, 2, (100 / portTICK_PERIOD_MS));
-    xSemaphoreGive(main_i2c_mutex);
     ESP_ERROR_CHECK_WITHOUT_ABORT(result);
     if (result != ESP_OK) {
         return;
@@ -192,9 +188,7 @@ static void receive_button_switch(void) {
 static void receive_touch(void) {
     uint8_t reg = 4;
     buf[0] = 0;
-    xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
     ESP_ERROR_CHECK_WITHOUT_ABORT(i2c_master_write_read_device(BOTTOM_I2C_NUM, BOTTOM_I2C_ADDR, &reg, 1, buf, 1, (100 / portTICK_PERIOD_MS)));
-    xSemaphoreGive(main_i2c_mutex);
     bool new_touch_state = buf[0] != 0;
 
     bool just_pressed = new_touch_state & !touch_state;

main/drivers/char_lcd.cpp

@@ -9,11 +9,6 @@
 #include "game_info.h"
 
 i2c_lcd_pcf8574_handle_t lcd;
-SemaphoreHandle_t lcd_mutex;
-
-static volatile bool cursor_visible = false;
-static volatile uint8_t cursor_resting_row = 0;
-static volatile uint8_t cursor_resting_col = 0;
 
 static volatile bool header_enabled = false;
 
@@ -22,7 +17,6 @@ static const char* EMPTY_ROW = "                    ";
 
 static char buf[65];
 
-// TODO: move this to power.cpp
 static void monitor_battery_task(void* _arg) {
     (void) _arg;
 
@@ -35,35 +29,53 @@ static void monitor_battery_task(void* _arg) {
 static bool replay_handler(const char* event, char* arg) {
     if (strcmp(event, "LCD_CLEAR") == 0) {
         lcd_clear();
+        return true;
     }
-    else if (strcmp(event, "LCD_SET_DISPLAY") == 0) {
+    if (strcmp(event, "LCD_CURSOR") == 0) {
+        char* col_str = strtok(arg, ",");
+        char* row_str = strtok(NULL, ",");
+        uint32_t col = atoi(col_str);
+        uint32_t row = atoi(row_str);
+        lcd_set_cursor_pos(col, row);
+        return true;
+    }
+    if (strcmp(event, "LCD_SET_DISPLAY") == 0) {
         lcd_set_display(strcmp(arg, "true") == 0);
+        return true;
     }
-    else if (strcmp(event, "LCD_CURSOR_VIS") == 0) {
+    if (strcmp(event, "LCD_CURSOR_VIS") == 0) {
         lcd_set_cursor_vis(strcmp(arg, "true") == 0);
+        return true;
     }
-    else if (strcmp(event, "LCD_CURSOR_BLINK") == 0) {
+    if (strcmp(event, "LCD_CURSOR_BLINK") == 0) {
         lcd_set_cursor_blink(strcmp(arg, "true") == 0);
+        return true;
     }
-    else if (strcmp(event, "LCD_SCROLL_DISPLAY_LEFT") == 0) {
+    if (strcmp(event, "LCD_SCROLL_DISPLAY_LEFT") == 0) {
         lcd_scroll_display_left();
+        return true;
     }
-    else if (strcmp(event, "LCD_SCROLL_DISPLAY_RIGHT") == 0) {
+    if (strcmp(event, "LCD_SCROLL_DISPLAY_RIGHT") == 0) {
         lcd_scroll_display_right();
+        return true;
     }
-    else if (strcmp(event, "LCD_LEFT_TO_RIGHT") == 0) {
+    if (strcmp(event, "LCD_LEFT_TO_RIGHT") == 0) {
         lcd_left_to_right();
+        return true;
     }
-    else if (strcmp(event, "LCD_RIGHT_TO_LEFT") == 0) {
+    if (strcmp(event, "LCD_RIGHT_TO_LEFT") == 0) {
         lcd_right_to_left();
+        return true;
     }
-    else if (strcmp(event, "LCD_AUTOSCROLL") == 0) {
+    if (strcmp(event, "LCD_AUTOSCROLL") == 0) {
         lcd_set_autoscroll(strcmp(arg, "true") == 0);
+        return true;
     }
-    else if (strcmp(event, "LCD_BACKLIGHT") == 0) {
+    if (strcmp(event, "LCD_BACKLIGHT") == 0) {
         lcd_set_backlight(strcmp(arg, "true") == 0);
+        return true;
     }
-    else if (strcmp(event, "LCD_CREATE_CHAR") == 0) {
+    if (strcmp(event, "LCD_CREATE_CHAR") == 0) {
         char* location_str = strtok(arg, ",");
         uint8_t location = atoi(location_str);
 
@@ -74,34 +86,24 @@ static bool replay_handler(const char* event, char* arg) {
         }
 
         lcd_create_char(location, charmap);
-    }
-    else if (strcmp(event, "LCD_PRINT") == 0) {
-        char* str = strtok(arg, ",");
-        uint8_t row = atoi(str);
-        str = strtok(NULL, ",");
-        uint8_t col = atoi(str);
-        // get remaining part of string.
-        str = strtok(NULL, "");
-
-        // TODO: handle \r and \n
-        lcd_print(row, col, str);
-    } else {
-        return false;
-    }
-
         return true;
+    }
+    if (strcmp(event, "LCD_PRINT") == 0) {
+        // TODO: handle \r and \n
+        lcd_print(&lcd, arg);
+        return true;
+    }
+
+    return false;
 }
 
 void init_lcd() {
     ESP_LOGI(TAG, "Initializing LCD...");
 
-    lcd_mutex = xSemaphoreCreateMutex();
-    assert(lcd_mutex != NULL);
-
     lcd_init(&lcd, LCD_ADDR, CHAR_LCD_I2C_NUM);
     lcd_begin(&lcd, LCD_COLS, LCD_ROWS);
 
-    lcd_set_backlight_to(&lcd, 1);
+    lcd_set_backlight(&lcd, 255);
 
     register_replay_fn(replay_handler);
 
@@ -110,124 +112,115 @@ void init_lcd() {
     ESP_LOGI(TAG, "LCD initialized!");
 }
 
-void lcd_clear(bool no_lock) {
+void lcd_clear() {
     if (!header_enabled) {
-        if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
         lcd_clear(&lcd);
-        if (!no_lock) xSemaphoreGive(lcd_mutex);
 
         if (is_state_tracking()) {
             event_occured("LCD_CLEAR", NULL);
         }
     } else {
-        if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
+        lcd_print(0, 1, EMPTY_ROW);
-        lcd_print(1, 0, EMPTY_ROW, true);
+        lcd_print(0, 2, EMPTY_ROW);
-        lcd_print(2, 0, EMPTY_ROW, true);
+        lcd_print(0, 3, EMPTY_ROW);
-        lcd_print(3, 0, EMPTY_ROW, true);
-        if (!no_lock) xSemaphoreGive(lcd_mutex);
     }
 }
 
-void lcd_set_display(bool display,  bool no_lock) {
+// TODO: rm
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
+void lcd_cursor_home() {
+    lcd_set_cursor_pos(0, 0);
+}
+
+// TODO: with print requiring you to set a pos every time, this function is not helpful
+void lcd_set_cursor_pos(uint8_t col, uint8_t row) {
+    lcd_set_cursor(&lcd, col, row);
+
+    if (is_state_tracking()) {
+        sprintf(buf, "%d,%d", col, row);
+        event_occured("LCD_CURSOR", buf);
+    }
+}
+
+void lcd_set_display(bool display) {
     if (display) {
         lcd_display(&lcd);
     } else {
         lcd_no_display(&lcd);
     }
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
         event_occured("LCD_SET_DISPLAY", display ? "true" : "false");
     }
 }
 
-void lcd_set_cursor_vis(bool cursor, bool no_lock) {
+void lcd_set_cursor_vis(bool cursor) {
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
     if (cursor) {
         lcd_cursor(&lcd);
     } else {
         lcd_no_cursor(&lcd);
     }
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
-
-    cursor_visible = cursor;
 
     if (is_state_tracking()) {
         event_occured("LCD_CURSOR_VIS", cursor ? "true" : "false");
     }
 }
 
-void lcd_set_cursor_blink(bool blink, bool no_lock) {
+void lcd_set_cursor_blink(bool blink) {
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
     if (blink) {
         lcd_blink(&lcd);
     } else {
         lcd_no_blink(&lcd);
     }
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
         event_occured("LCD_CURSOR_BLINK", blink ? "true" : "false");
     }
 }
 
-void lcd_scroll_display_left(bool no_lock) {
+void lcd_scroll_display_left() {
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
     lcd_scroll_display_left(&lcd);
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
         event_occured("LCD_SCROLL_DISPLAY_LEFT", NULL);
     }
 }
-void lcd_scroll_display_right(bool no_lock) {
+void lcd_scroll_display_right() {
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
     lcd_scroll_display_right(&lcd);
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
         event_occured("LCD_SCROLL_DISPLAY_RIGHT", NULL);
     }
 }
 
-void lcd_left_to_right(bool no_lock) {
+void lcd_left_to_right() {
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
     lcd_left_to_right(&lcd);
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
         event_occured("LCD_LEFT_TO_RIGHT", NULL);
     }
 }
-void lcd_right_to_left(bool no_lock) {
+void lcd_right_to_left() {
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
     lcd_right_to_left(&lcd);
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
         event_occured("LCD_RIGHT_TO_LEFT", NULL);
     }
 }
 
-void lcd_set_autoscroll(bool autoscroll, bool no_lock) {
+void lcd_set_autoscroll(bool autoscroll) {
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
     if (autoscroll) {
         lcd_autoscroll(&lcd);
     } else {
         lcd_no_autoscroll(&lcd);
     }
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
         event_occured("LCD_AUTOSCROLL", autoscroll ? "true" : "false");
     }
 }
 
-void lcd_set_backlight(bool backlight, bool no_lock) {
+void lcd_set_backlight(bool backlight) {
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
+    lcd_set_backlight(&lcd, backlight);
-    lcd_set_backlight_to(&lcd, backlight);
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
         sprintf(buf, "%d", backlight);
@@ -235,15 +228,11 @@ void lcd_set_backlight(bool backlight, bool no_lock) {
     }
 }
 
-void lcd_create_char(uint8_t location, const uint8_t charmap[], bool no_lock) {
+void lcd_create_char(uint8_t location, const uint8_t charmap[]) {
-    if (location == 8) location = 0;
-
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
     lcd_create_char(&lcd, location, charmap);
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
 
     if (is_state_tracking()) {
-        snprintf(buf, sizeof(buf),
+        snprintf(buf, 65,
             "%d,%d,%d,%d,%d,%d,%d,%d,%d", location, 
             charmap[0], charmap[1], charmap[2], charmap[3], charmap[4], charmap[5], charmap[6], charmap[7]
         );
@@ -251,21 +240,14 @@ void lcd_create_char(uint8_t location, const uint8_t charmap[], bool no_lock) {
     }
 }
 
-void lcd_print(uint8_t row, uint8_t col, const char* str, bool no_lock) {
+// TODO: switch to row, col
-    if (!no_lock) xSemaphoreTake(lcd_mutex, portMAX_DELAY);
+void lcd_print(uint8_t col, uint8_t row, const char* str) {
-    lcd_set_cursor(&lcd, col, row);
+    lcd_set_cursor_pos(col, row);
     lcd_print(&lcd, str);
 
-    if (cursor_visible) {
-        lcd_set_cursor(&lcd, cursor_resting_col, cursor_resting_row);
-    }
-    
-    if (!no_lock) xSemaphoreGive(lcd_mutex);
-
     if (is_state_tracking()) {
-        // TODO: handle \r and \n and others
+        // TODO: handle \r and \n
-        snprintf(buf, sizeof(buf), "%d,%d,%s", row, col, str);
+        event_occured("LCD_PRINT", str);
-        event_occured("LCD_PRINT", buf);
     }
 }
 
@@ -302,37 +284,13 @@ void lcd_do_splash() {
     };
 
     // TODO: make the lcd_lib somehow support the custom character 0 which would otherwise be a null terminator
-    xSemaphoreTake(lcd_mutex, portMAX_DELAY);
+    lcd_create_char(1, custom_char[0]);
-    lcd_create_char(1, custom_char[0], true);
+    lcd_create_char(2, custom_char[1]);
-    lcd_create_char(2, custom_char[1], true);
+    lcd_create_char(3, custom_char[2]);
-    lcd_create_char(3, custom_char[2], true);
+    lcd_create_char(4, custom_char[3]);
-    lcd_create_char(4, custom_char[3], true);
+    lcd_create_char(5, custom_char[4]);
-    lcd_create_char(5, custom_char[4], true);
+    lcd_create_char(6, custom_char[5]);
-    lcd_create_char(6, custom_char[5], true);
 
-    lcd_print(1, 6, "\x01\x02Marino", true);
+    lcd_print(6, 1, "\x01\x02Marino");
-    lcd_print(2, 5, "\x03\x04\x05\x06""DEV", true);
+    lcd_print(5, 2, "\x03\x04\x05\x06""DEV");
-    xSemaphoreGive(lcd_mutex);
-}
-
-bool lcd_lock(uint32_t ticks_to_wait) {
-    return xSemaphoreTake(lcd_mutex, ticks_to_wait);
-}
-
-void lcd_unlock() {
-    xSemaphoreGive(lcd_mutex);
-}
-
-void lcd_set_cursor_resting_position(uint8_t row, uint8_t col) {
-    cursor_resting_row = row;
-    cursor_resting_col = col;
-}
-
-void lcd_get_cursor_resting_position(uint8_t* row, uint8_t* col) {
-    if (row) *row = cursor_resting_row;
-    if (col) *col = cursor_resting_col;
-}
-
-bool lcd_is_cursor_visible() {
-    return cursor_visible;
 }

main/drivers/char_lcd.h

@@ -6,53 +6,54 @@
 #define CHAR_LCD_I2C_NUM I2C_NUM_0
 
 #define LCD_ADDR 0x27
-#define LCD_ROWS 4
 #define LCD_COLS 20
+#define LCD_ROWS 4
 
-/// @brief Initializes the 2004 Character LCD
+/// Initializes the 2004 Character LCD
 void init_lcd();
 
-/// @brief Clear the LCD
+/// Clear the LCD
-void lcd_clear(bool no_lock = false);
+void lcd_clear();
 
-/// @brief Move cursor to home position
+/// Move cursor to home position
-void lcd_cursor_home(bool no_lock = false);
+void lcd_cursor_home();
 
-/// @brief Turn the display on/off
+/// Set cursor position
-void lcd_set_display(bool display, bool no_lock = false);
+void lcd_set_cursor_pos(uint8_t col, uint8_t row);
 
-/// @brief Turn the cursor's visibility on/off
+/// Turn the display on/off
-void lcd_set_cursor_vis(bool cursor, bool no_lock = false);
+void lcd_set_display(bool display);
 
-/// @brief Turn blinking cursor on/off
+/// Turn the cursor's visibility on/off
-void lcd_set_cursor_blink(bool blink, bool no_lock = false);
+void lcd_set_cursor_vis(bool cursor);
 
-/// @brief Scroll the display left
+/// Turn blinking cursor on/off
-void lcd_scroll_display_left(bool no_lock = false);
+void lcd_set_cursor_blink(bool blink);
-/// @brief Scroll the display right
-void lcd_scroll_display_right(bool no_lock = false);
 
-/// @brief Set the text to flows automatically left to right
+/// Scroll the display left
-void lcd_left_to_right(bool no_lock = false);
+void lcd_scroll_display_left();
-/// @brief Set the text to flows automatically right to left
+/// Scroll the display right
-void lcd_right_to_left(bool no_lock = false);
+void lcd_scroll_display_right();
 
-/// @brief Turn on/off autoscroll
+/// Set the text to flows automatically left to right
-void lcd_set_autoscroll(bool autoscroll, bool no_lock = false);
+void lcd_left_to_right();
+/// Set the text to flows automatically right to left
+void lcd_right_to_left();
 
-/// @brief Set backlight brightness
+// Turn on/off autoscroll
-void lcd_set_backlight(bool backlight, bool no_lock = false);
+void lcd_set_autoscroll(bool autoscroll);
 
-/// @brief Create a custom character. You get 8 custom characters.
+// Set backlight brightness
-/// You can print custom characters by using escape characters in strings:
+void lcd_set_backlight(bool backlight);
-/// use '\x01' - '\x07' for custom characters 1-7. Use '\x08' for custom char 0.
+
-void lcd_create_char(uint8_t location, const uint8_t charmap[], bool no_lock = false);
+// Create a custom character
+void lcd_create_char(uint8_t location, const uint8_t charmap[]);
 
 /// @brief Print a string to the LCD at a given pos. 
-/// @param row the row the print the string at.
 /// @param col the column to print the string at.
+/// @param row the row the print the string at.
 /// @param str the string to print.
-void lcd_print(uint8_t row, uint8_t col, const char* str, bool no_lock = false);
+void lcd_print(uint8_t col, uint8_t row, const char* str);
 
 /// @brief Enables or disables the header on the LCD.
 /// @param enable `true` to enable the header, `false` to disable.
@@ -68,29 +69,4 @@ void lcd_print_header();
 /// @brief Prints the splash screen for the BLK_BOX.
 void lcd_do_splash();
 
-/// @brief Locks the LCD to allow chaining multiple commands without interuptions.
-///
-/// Commands you call while you lock the LCD, you must call with the `no_lock` flag set to true.
-///
-/// Do not hold this lock for an extended period of time.
-/// @return `true` iff the lock was aquired.
-bool lcd_lock(uint32_t ticks_to_wait);
-
-/// @brief Unlocks the LCD to give away the mutex access to it.
-void lcd_unlock();
-
-/// @brief Set the resting position for the cursor
-/// @param row the row where the cursor should rest
-/// @param col the column where the cursor should rest
-void lcd_set_cursor_resting_position(uint8_t row, uint8_t col);
-
-/// @brief Get the current resting position of the cursor
-/// @param row pointer to store the resting row
-/// @param col pointer to store the resting column
-void lcd_get_cursor_resting_position(uint8_t* row, uint8_t* col);
-
-/// @brief Check if the cursor is currently visible
-/// @return true if cursor is visible, false otherwise
-bool lcd_is_cursor_visible();
-
 #endif /* CHAR_LCD_H */

main/drivers/game_info.cpp

@@ -17,5 +17,5 @@ void lcd_print_header_step() {
     if (!lcd_header_enabled()) return;
     if (lcd_starcode_displaying_result()) return;
 
-    lcd_print(0, 10, game_state);
+    lcd_print(10, 0, game_state);
 }

main/drivers/hwdata.cpp

@@ -1,494 +0,0 @@
-#include "hwdata.h"
-#include "esp_err.h"
-#include "esp_log.h"
-#include "bottom_half.h"
-#include "char_lcd.h"
-#include "../helper.h"
-#include "nvs.h"
-
-static const char* TAG = "hwdata";
-
-HWData::HWData() 
-    : compat_mode(true) 
-{}
-
-HWData::HWData(HWData1 data, bool compat_mode)
-    : compat_mode(compat_mode),
-      inner(data) 
-{}
-
-esp_err_t HWData::save(nvs_handle_t handle, bool force) {
-    if (compat_mode && !force) {
-        ESP_LOGW(TAG, "Not saving due to being in compatability mode.");
-        return ESP_OK;
-    }
-    return inner.save(handle);
-}
-
-HWData HWData::load(nvs_handle_t handle) {
-    esp_err_t err;
-
-    uint16_t stored_version = 0;
-    err = nvs_get_u16(handle, "version", &stored_version);
-    if (err == ESP_ERR_NVS_NOT_FOUND) {
-        ESP_LOGE(TAG, "No NVS data found! using defaults");
-        return HWData();
-    } else if (err != ESP_OK) {
-        ESP_ERROR_CHECK_WITHOUT_ABORT(err);
-        ESP_LOGE(TAG, "Other esp error! using defaults");
-        return HWData();
-    }
-
-    HWData1 data;
-    switch (stored_version) {
-        case 0:
-            ESP_LOGE(TAG, "HWData version was 0! using defaults");
-            return HWData();
-        case 1:
-            data.load(handle);
-            return HWData(data, false);
-        default:
-            ESP_LOGW(TAG, "Max currently supported version is %d, but saved version is %d. Loading version %d anyway!", CURRENT_HWDATA_VERSION, stored_version, CURRENT_HWDATA_VERSION);
-            data.load(handle);
-            return HWData(data, true);
-    }
-}
-
-HWData1::HWData1() {}
-
-esp_err_t HWData1::save(nvs_handle_t handle) const {
-    ESP_ERROR_CHECK(nvs_set_u16(handle, "version", 1));
-
-    // Serial number
-    ESP_ERROR_CHECK(nvs_set_str(handle, "serial_num", serial_num.c_str()));
-
-    // Revisions
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "rev_ctrl_maj", rev_ctrl_maj));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "rev_ctrl_min", rev_ctrl_min));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "rev_exp_maj", rev_exp_maj));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "rev_exp_min", rev_exp_min));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "rev_ft_maj", rev_ft_maj));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "rev_ft_min", rev_ft_min));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "rev_fb_maj", rev_fb_maj));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "rev_fb_min", rev_fb_min));
-
-    // Enums
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "sseg_color_t", static_cast<uint8_t>(sseg_color_t)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "sseg_color_b", static_cast<uint8_t>(sseg_color_b)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "lcd_color", static_cast<uint8_t>(lcd_color)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "button_type", static_cast<uint8_t>(button_type)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "tft_type", static_cast<uint8_t>(tft_type)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "bat_type", static_cast<uint8_t>(bat_type)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "shape1", static_cast<uint8_t>(shape1)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "shape2", static_cast<uint8_t>(shape2)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "shape3", static_cast<uint8_t>(shape3)));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "shape4", static_cast<uint8_t>(shape4)));
-
-    // Other fields
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "switch_pos", switch_pos));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "has_speaker", has_speaker));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "has_mic", has_mic));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "has_ir", has_ir));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "has_rfid", has_rfid));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "has_fp", has_fp));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "has_fp_hall", has_fp_hall));
-    ESP_ERROR_CHECK(nvs_set_u8(handle, "has_close_hall", has_close_hall));
-
-    // Battery capacity
-    ESP_ERROR_CHECK(nvs_set_u16(handle, "bat_cap", bat_cap));
-
-    return nvs_commit(handle);
-}
-
-void HWData1::load(nvs_handle_t handle) {
-    char buf[128];
-    size_t required_size = sizeof(buf);
-    esp_err_t err = nvs_get_str(handle, "serial_num", buf, &required_size);
-    serial_num = (err == ESP_OK) ? std::string(buf) : "";
-
-    nvs_get_u8(handle, "rev_ctrl_maj", &rev_ctrl_maj);
-    nvs_get_u8(handle, "rev_ctrl_min", &rev_ctrl_min);
-    nvs_get_u8(handle, "rev_exp_maj", &rev_exp_maj);
-    nvs_get_u8(handle, "rev_exp_min", &rev_exp_min);
-    nvs_get_u8(handle, "rev_ft_maj", &rev_ft_maj);
-    nvs_get_u8(handle, "rev_ft_min", &rev_ft_min);
-    nvs_get_u8(handle, "rev_fb_maj", &rev_fb_maj);
-    nvs_get_u8(handle, "rev_fb_min", &rev_fb_min);
-
-    uint8_t tmp;
-    if (nvs_get_u8(handle, "sseg_color_t", &tmp) == ESP_OK) sseg_color_t = static_cast<SSegColor>(tmp);
-    if (nvs_get_u8(handle, "sseg_color_b", &tmp) == ESP_OK) sseg_color_b = static_cast<SSegColor>(tmp);
-    if (nvs_get_u8(handle, "lcd_color", &tmp) == ESP_OK) lcd_color = static_cast<LCDColor>(tmp);
-    if (nvs_get_u8(handle, "button_type", &tmp) == ESP_OK) button_type = static_cast<ButtonType>(tmp);
-    if (nvs_get_u8(handle, "tft_type", &tmp) == ESP_OK) tft_type = static_cast<TFTType>(tmp);
-    if (nvs_get_u8(handle, "bat_type", &tmp) == ESP_OK) bat_type = static_cast<BatType>(tmp);
-    nvs_get_u16(handle, "bat_cap", &bat_cap);
-
-    if (nvs_get_u8(handle, "shape1", &tmp) == ESP_OK) shape1 = static_cast<ShapeType>(tmp);
-    if (nvs_get_u8(handle, "shape2", &tmp) == ESP_OK) shape2 = static_cast<ShapeType>(tmp);
-    if (nvs_get_u8(handle, "shape3", &tmp) == ESP_OK) shape3 = static_cast<ShapeType>(tmp);
-    if (nvs_get_u8(handle, "shape4", &tmp) == ESP_OK) shape4 = static_cast<ShapeType>(tmp);
-
-    nvs_get_u8(handle, "switch_pos", &switch_pos);
-    nvs_get_u8(handle, "has_speaker", &tmp); has_speaker = tmp;
-    nvs_get_u8(handle, "has_mic", &tmp); has_mic = tmp;
-    nvs_get_u8(handle, "has_ir", &tmp); has_ir = tmp;
-    nvs_get_u8(handle, "has_rfid", &tmp); has_rfid = tmp;
-    nvs_get_u8(handle, "has_fp", &tmp); has_fp = tmp;
-    nvs_get_u8(handle, "has_fp_hall", &tmp); has_fp_hall = tmp;
-    nvs_get_u8(handle, "has_close_hall", &tmp); has_close_hall = tmp;
-}
-
-static void handle_uint8(KeypadKey key, uint8_t& val) {
-    char key_c = char_of_keypad_key(key);
-    bool is_digit = std::isdigit(static_cast<unsigned char>(key_c));
-    uint8_t digit = is_digit ? static_cast<uint8_t>(key_c - '0') : 0;
-
-    if (key == KeypadKey::star) {
-        val = 0;
-    } else if (is_digit) {
-        uint16_t new_digit = ((uint16_t) val) * 10 + (uint16_t) digit;
-        if (new_digit < 255) val = new_digit;
-    }
-}
-static void handle_uint16(KeypadKey key, uint16_t& val) {
-    char key_c = char_of_keypad_key(key);
-    bool is_digit = std::isdigit(static_cast<unsigned char>(key_c));
-    uint8_t digit = is_digit ? static_cast<uint8_t>(key_c - '0') : 0;
-
-    if (key == KeypadKey::star) {
-        val = 0;
-    } else if (is_digit) {
-        uint32_t new_digit = ((uint32_t) val) * 10 + (uint32_t) digit;
-        if (new_digit < 65535) val = new_digit;
-    }
-}
-
-static void handle_enum(ButtonKey key, uint8_t& val, uint8_t n_items) {
-    if (key == ButtonKey::b1) {
-        // dec
-        val = (val + n_items - 1) % n_items;
-    } else if (key == ButtonKey::b2) {
-        // inc
-        val = (val + 1) % n_items;
-    }
-}
-
-void hardware_config() {
-    clean_bomb();
-    uint8_t current_item = 0;
-    const uint8_t n_items = 28;
-
-    HWData1& hwdata = get_hw_data().inner;
-
-    ButtonKey btn;
-    KeypadKey key;
-    bool dirty = true;
-    while (true) {
-        if (dirty) {
-            // display
-            char name[21];
-            char value[21];
-
-            switch (current_item) {
-                case 0: // serial_num
-                    snprintf(name, sizeof(name), "%-20s", "serial_num");
-                    snprintf(value, sizeof(value), "%s", hwdata.serial_num.c_str());
-                    break;
-
-                case 1: // rev_ctrl_maj
-                    snprintf(name, sizeof(name), "%-20s", "rev_ctrl_maj");
-                    snprintf(value, sizeof(value), "%d", hwdata.rev_ctrl_maj);
-                    break;
-
-                case 2: // rev_ctrl_min
-                    snprintf(name, sizeof(name), "%-20s", "rev_ctrl_min");
-                    snprintf(value, sizeof(value), "%d", hwdata.rev_ctrl_min);
-                    break;
-
-                case 3: // rev_exp_maj
-                    snprintf(name, sizeof(name), "%-20s", "rev_exp_maj");
-                    snprintf(value, sizeof(value), "%d", hwdata.rev_exp_maj);
-                    break;
-
-                case 4: // rev_exp_min
-                    snprintf(name, sizeof(name), "%-20s", "rev_exp_min");
-                    snprintf(value, sizeof(value), "%d", hwdata.rev_exp_min);
-                    break;
-
-                case 5: // rev_ft_maj
-                    snprintf(name, sizeof(name), "%-20s", "rev_ft_maj");
-                    snprintf(value, sizeof(value), "%d", hwdata.rev_ft_maj);
-                    break;
-
-                case 6: // rev_ft_min
-                    snprintf(name, sizeof(name), "%-20s", "rev_ft_min");
-                    snprintf(value, sizeof(value), "%d", hwdata.rev_ft_min);
-                    break;
-
-                case 7: // rev_fb_maj
-                    snprintf(name, sizeof(name), "%-20s", "rev_fb_maj");
-                    snprintf(value, sizeof(value), "%d", hwdata.rev_fb_maj);
-                    break;
-
-                case 8: // rev_fb_min
-                    snprintf(name, sizeof(name), "%-20s", "rev_fb_min");
-                    snprintf(value, sizeof(value), "%d", hwdata.rev_fb_min);
-                    break;
-
-                case 9: // sseg_color_t
-                    snprintf(name, sizeof(name), "%-20s", "sseg_color_t");
-                    snprintf(value, sizeof(value), "%s", SSEG_COLOR_NAMES[static_cast<uint8_t>(hwdata.sseg_color_t)]);
-                    break;
-
-                case 10: // sseg_color_b
-                    snprintf(name, sizeof(name), "%-20s", "sseg_color_b");
-                    snprintf(value, sizeof(value), "%s", SSEG_COLOR_NAMES[static_cast<uint8_t>(hwdata.sseg_color_b)]);
-                    break;
-
-                case 11: // lcd_color
-                    snprintf(name, sizeof(name), "%-20s", "lcd_color");
-                    snprintf(value, sizeof(value), "%s", LCD_COLOR_NAMES[static_cast<uint8_t>(hwdata.lcd_color)]);
-                    break;
-
-                case 12: // switch_pos
-                    snprintf(name, sizeof(name), "%-20s", "switch_pos");
-                    snprintf(value, sizeof(value), "%d", hwdata.switch_pos);
-                    break;
-
-                case 13: // button_type
-                    snprintf(name, sizeof(name), "%-20s", "button_type");
-                    snprintf(value, sizeof(value), "%s", BUTTON_TYPE_NAMES[static_cast<uint8_t>(hwdata.button_type)]);
-                    break;
-
-                case 14: // tft_type
-                    snprintf(name, sizeof(name), "%-20s", "tft_type");
-                    snprintf(value, sizeof(value), "%s", TFT_TYPE_NAMES[static_cast<uint8_t>(hwdata.tft_type)]);
-                    break;
-
-                case 15: // bat_type
-                    snprintf(name, sizeof(name), "%-20s", "bat_type");
-                    snprintf(value, sizeof(value), "%s", BAT_TYPE_NAMES[static_cast<uint8_t>(hwdata.bat_type)]);
-                    break;
-
-                case 16: // bat_cap
-                    snprintf(name, sizeof(name), "%-20s", "bat_cap");
-                    snprintf(value, sizeof(value), "%d", hwdata.bat_cap);
-                    break;
-
-                case 17: // shape1
-                    snprintf(name, sizeof(name), "%-20s", "shape1");
-                    snprintf(value, sizeof(value), "%s", SHAPE_TYPE_NAMES[static_cast<uint8_t>(hwdata.shape1)]);
-                    break;
-
-                case 18: // shape2
-                    snprintf(name, sizeof(name), "%-20s", "shape2");
-                    snprintf(value, sizeof(value), "%s", SHAPE_TYPE_NAMES[static_cast<uint8_t>(hwdata.shape2)]);
-                    break;
-
-                case 19: // shape3
-                    snprintf(name, sizeof(name), "%-20s", "shape3");
-                    snprintf(value, sizeof(value), "%s", SHAPE_TYPE_NAMES[static_cast<uint8_t>(hwdata.shape3)]);
-                    break;
-
-                case 20: // shape4
-                    snprintf(name, sizeof(name), "%-20s", "shape4");
-                    snprintf(value, sizeof(value), "%s", SHAPE_TYPE_NAMES[static_cast<uint8_t>(hwdata.shape4)]);
-                    break;
-
-                case 21: // has_speaker
-                    snprintf(name, sizeof(name), "%-20s", "has_speaker");
-                    snprintf(value, sizeof(value), "%s", hwdata.has_speaker ? "true" : "false");
-                    break;
-
-                case 22: // has_mic
-                    snprintf(name, sizeof(name), "%-20s", "has_mic");
-                    snprintf(value, sizeof(value), "%s", hwdata.has_mic ? "true" : "false");
-                    break;
-
-                case 23: // has_ir
-                    snprintf(name, sizeof(name), "%-20s", "has_ir");
-                    snprintf(value, sizeof(value), "%s", hwdata.has_ir ? "true" : "false");
-                    break;
-
-                case 24: // has_rfid
-                    snprintf(name, sizeof(name), "%-20s", "has_rfid");
-                    snprintf(value, sizeof(value), "%s", hwdata.has_rfid ? "true" : "false");
-                    break;
-
-                case 25: // has_fp
-                    snprintf(name, sizeof(name), "%-20s", "has_fp");
-                    snprintf(value, sizeof(value), "%s", hwdata.has_fp ? "true" : "false");
-                    break;
-
-                case 26: // has_fp_hall
-                    snprintf(name, sizeof(name), "%-20s", "has_fp_hall");
-                    snprintf(value, sizeof(value), "%s", hwdata.has_fp_hall ? "true" : "false");
-                    break;
-
-                case 27: // has_close_hall
-                    snprintf(name, sizeof(name), "%-20s", "has_close_hall");
-                    snprintf(value, sizeof(value), "%s", hwdata.has_close_hall ? "true" : "false");
-                    break;
-
-                default:
-                    break;
-            }
-
-            lcd_print(1, 0, name);
-            lcd_print(2, 0, value);
-
-            dirty = false;
-        }
-
-        if (get_button_pressed(&btn)) {
-            dirty = true;
-            switch (btn) {
-                case ButtonKey::b3: // dec
-                    current_item = (current_item + n_items - 1) % n_items;
-                    break;
-                case ButtonKey::b4: // inc
-                    current_item = (current_item + 1) % n_items;
-                    break;
-                default:
-                    switch (current_item) {   
-                        case 9: // sseg_color_t
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.sseg_color_t), SSEG_COLOR_COUNT);
-                            break;
-
-                        case 10: // sseg_color_b
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.sseg_color_b), SSEG_COLOR_COUNT);
-                            break;
-
-                        case 11: // lcd_color
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.lcd_color), LCD_COLOR_COUNT);
-                            break;
-
-                        case 13: // button_type
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.button_type), BUTTON_TYPE_COUNT);
-                            break;
-
-                        case 14: // tft_type
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.tft_type), TFT_TYPE_COUNT);
-                            break;
-
-                        case 15: // bat_type
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.bat_type), BAT_TYPE_COUNT);
-                            break;
-                
-                        case 17: // shape1
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.shape1), SHAPE_TYPE_COUNT);
-                            break;                
-                        case 18: // shape2
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.shape2), SHAPE_TYPE_COUNT);
-                            break;
-                        case 19: // shape3
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.shape3), SHAPE_TYPE_COUNT);
-                            break;
-                        case 20: // shape4                
-                            handle_enum(btn, reinterpret_cast<uint8_t&>(hwdata.shape4), SHAPE_TYPE_COUNT);
-                            break;
-                
-                        case 21: // has_speaker
-                            hwdata.has_speaker = btn == ButtonKey::button_green;
-                            break;
-                
-                        case 22: // has_mic
-                            hwdata.has_mic = btn == ButtonKey::button_green;
-                            break;
-                        
-                        case 23: // has_ir
-                            hwdata.has_ir = btn == ButtonKey::button_green;
-                            break;
-                        
-                        case 24: // has_rfid
-                            hwdata.has_rfid = btn == ButtonKey::button_green;
-                            break;
-                        
-                        case 25: // has_fp
-                            hwdata.has_fp = btn == ButtonKey::button_green;
-                            break;
-                        
-                        case 26: // has_fp_hall                        
-                            hwdata.has_fp_hall = btn == ButtonKey::button_green;
-                            break;
-                        
-                        case 27: // has_close_hall
-                            hwdata.has_close_hall = btn == ButtonKey::button_green;
-                            break;
-
-                        default:
-                            break;
-                    }
-                    break;
-            }
-        }
-        if (get_keypad_pressed(&key)) {
-            dirty = true;
-            if (key == KeypadKey::pound) {
-                // TODO: ask the user to save
-                return; // done
-            }
-
-            char key_c = char_of_keypad_key(key);
-            bool is_digit = std::isdigit(static_cast<unsigned char>(key_c));
-            uint8_t digit = is_digit ? static_cast<uint8_t>(key_c - '0') : 0;
-
-            // update the current value
-            switch (current_item) {
-                case 0: // serial_num
-                    if (key == KeypadKey::star) {
-                        hwdata.serial_num.clear();
-                    } else {
-                        hwdata.serial_num.push_back(char_of_keypad_key(key));
-                    }
-                    break;
-                
-                case 1: // rev_ctrl_maj
-                    handle_uint8(key, hwdata.rev_ctrl_maj);
-                    break;
-                
-                case 2: // rev_ctrl_min
-                    handle_uint8(key, hwdata.rev_ctrl_min);
-                    break;
-                
-                case 3: // rev_exp_maj
-                    handle_uint8(key, hwdata.rev_exp_maj);
-                    break;
-                
-                case 4: // rev_exp_min
-                    handle_uint8(key, hwdata.rev_exp_min);
-                    break;
-                
-                case 5: // rev_ft_maj
-                    handle_uint8(key, hwdata.rev_ft_maj);
-                    break;
-                
-                case 6: // rev_ft_min
-                    handle_uint8(key, hwdata.rev_ft_min);
-                    break;
-                
-                case 7: // rev_fb_maj
-                    handle_uint8(key, hwdata.rev_fb_maj);
-                    break;
-                
-                case 8: // rev_fb_min
-                    handle_uint8(key, hwdata.rev_fb_min);
-                    break;
-                
-                case 12: // switch_pos
-                    if (digit == 2 || digit == 3) hwdata.switch_pos = digit;
-                    break;
-                
-                case 16: // bat_cap
-                    handle_uint16(key, hwdata.bat_cap);
-                    break;
-                                   
-                default:
-                    break;
-            }
-        }
-
-        vTaskDelay(pdMS_TO_TICKS(10));
-    }
-}

main/drivers/hwdata.h

@@ -1,199 +0,0 @@
-#ifndef HWDATA_H
-#define HWDATA_H
-
-#include <string>
-#include <cstdint>
-#include <cstring>
-#include "esp_err.h"
-#include "nvs_flash.h"
-
-#define CURRENT_HWDATA_VERSION 1
-#define CURRENT_HWDATA_STRUCT HWData1
-
-#define SSEG_COLOR_COUNT 10
-static constexpr const char* SSEG_COLOR_NAMES[SSEG_COLOR_COUNT] = {
-    "UNKNOWN",
-    "NONE",
-    "OTHER",
-    "RED",
-    "ORANGE",
-    "YELLOW",
-    "GREEN",
-    "BLUE",
-    "PURPLE",
-    "WHITE"
-};
-enum class SSegColor : uint8_t {
-    UNKNOWN = 0,
-    NONE = 1,
-    OTHER = 2,
-    RED = 3,
-    ORANGE = 4,
-    YELLOW = 5,
-    GREEN = 6,
-    BLUE = 7,
-    PURPLE = 8,
-    WHITE = 9,
-};
-
-#define LCD_COLOR_COUNT 8
-static constexpr const char* LCD_COLOR_NAMES[LCD_COLOR_COUNT] = {
-    "UNKNOWN",
-    "NONE",
-    "OTHER",
-    "BLACK_GREEN",
-    "WHITE_BLUE",
-    "BLACK_SKY",
-    "BLACK_WHITE",
-    "WHITE_BLACK"
-};
-enum class LCDColor : uint8_t {
-    UNKNOWN = 0,
-    NONE = 1,
-    OTHER = 2,
-    BLACK_GREEN = 3,
-    WHITE_BLUE = 4,
-    BLACK_SKY = 5,
-    BLACK_WHITE = 6,
-    WHITE_BLACK = 7,
-};
-
-#define BUTTON_TYPE_COUNT 6
-static constexpr const char* BUTTON_TYPE_NAMES[BUTTON_TYPE_COUNT] = {
-    "UNKNOWN",
-    "NONE",
-    "OTHER",
-    "WHITE",
-    "BROWN",
-    "RED"
-};
-enum class ButtonType : uint8_t {
-    UNKNOWN = 0,
-    NONE = 1,
-    OTHER = 2,
-    WHITE = 3,
-    BROWN = 4,
-    RED = 5,
-};
-
-#define TFT_TYPE_COUNT 5
-static constexpr const char* TFT_TYPE_NAMES[TFT_TYPE_COUNT] = {
-    "UNKNOWN",
-    "NONE",
-    "OTHER",
-    "EAST_RISING",
-    "SHENZHEN"
-};
-enum class TFTType : uint8_t {
-    UNKNOWN = 0,
-    NONE = 1,
-    OTHER = 2,
-    EAST_RISING = 3,
-    SHENZHEN = 4,
-};
-
-#define BAT_TYPE_COUNT 5
-static constexpr const char* BAT_TYPE_NAMES[BAT_TYPE_COUNT] = {
-    "UNKNOWN",
-    "NONE",
-    "OTHER",
-    "BAT_18650",
-    "LIPO"
-};
-enum class BatType : uint8_t {
-    UNKNOWN = 0,
-    NONE = 1,
-    OTHER = 2,
-    BAT_18650 = 3,
-    LIPO = 4,
-};
-
-#define SHAPE_TYPE_COUNT 11
-static constexpr const char* SHAPE_TYPE_NAMES[SHAPE_TYPE_COUNT] = {
-    "UNKNOWN",
-    "OTHER",
-    "CIRCLE",
-    "SQUARE",
-    "TRIANGLE",
-    "X",
-    "STAR",
-    "SPADE",
-    "DIAMOND",
-    "CLUB",
-    "HEART"
-};
-enum class ShapeType : uint8_t {
-    UNKNOWN = 0,
-    OTHER = 1,
-    CIRCLE = 2,
-    SQUARE = 3,
-    TRIANGLE = 4,
-    X = 5,
-    STAR = 6,
-    SPADE = 7,
-    DIAMOND = 8,
-    CLUB = 9,
-    HEART = 10,
-};
-
-
-
-/// @brief Version 1 of HWData, kept constant for migrations
-struct HWData1 {
-    std::string serial_num;
-    uint8_t rev_ctrl_maj;
-    uint8_t rev_ctrl_min;
-    uint8_t rev_exp_maj;
-    uint8_t rev_exp_min;
-    uint8_t rev_ft_maj;
-    uint8_t rev_ft_min;
-    uint8_t rev_fb_maj;
-    uint8_t rev_fb_min;
-
-    SSegColor sseg_color_t;
-    SSegColor sseg_color_b;
-    LCDColor lcd_color;
-    uint8_t switch_pos;
-    ButtonType button_type;
-    TFTType tft_type;
-    BatType bat_type;
-    uint16_t bat_cap;
-
-    ShapeType shape1;
-    ShapeType shape2;
-    ShapeType shape3;
-    ShapeType shape4;
-
-    bool has_speaker;
-    bool has_mic;
-    bool has_ir;
-    bool has_rfid;
-    bool has_fp;
-    bool has_fp_hall;
-    bool has_close_hall;
-
-    HWData1();
-
-    esp_err_t save(nvs_handle_t handle) const;
-    void load(nvs_handle_t handle);
-
-    // Add migration method as necessary
-};
-
-/// @brief The current version of HWData, to be stored
-struct HWData {
-    /// @brief `true` if there is some issue in loading, and we are doing a "best effort" to be compatible
-    /// We should make no writes to NVS if this is `true`.
-    volatile bool compat_mode;
-    HWData1 inner;
-
-    HWData();
-    HWData(HWData1 data, bool compat_mode);
-
-    esp_err_t save(nvs_handle_t handle, bool force = false);
-    static HWData load(nvs_handle_t handle);
-};
-
-void hardware_config();
-
-#endif /* HWDATA_H */

main/drivers/i2c_lcd_pcf8574.c

@@ -233,7 +233,7 @@ void lcd_no_autoscroll(i2c_lcd_pcf8574_handle_t* lcd) {
 
 // Setting the backlight: It can only be turn on or off.
 // Current backlight value is saved in the i2c_lcd_pcf8574_handle_t struct for further data transfers
-void lcd_set_backlight_to(i2c_lcd_pcf8574_handle_t* lcd, uint8_t brightness) {
+void lcd_set_backlight(i2c_lcd_pcf8574_handle_t* lcd, uint8_t brightness) {
     // Place the backlight value in the lcd struct
     lcd->backlight = brightness;
     // Send no data
@@ -258,13 +258,8 @@ void lcd_write(i2c_lcd_pcf8574_handle_t* lcd, uint8_t value) {
 // Print characters to the LCD: cursor set or clear instruction must preceded this instruction, or it will write on the current text.
 void lcd_print(i2c_lcd_pcf8574_handle_t* lcd, const char* str) {
     while (*str) {
-        if (*str == '\x08') {
-            lcd_write(lcd, '\x00');
-            str++;
-        } else {
         lcd_write(lcd, *str++);
     }
-    }
 }  // lcd_print()
 
 // Additional function to print numbers as formatted string
@@ -301,17 +296,18 @@ void lcd_print_number(i2c_lcd_pcf8574_handle_t* lcd, uint8_t col, uint8_t row, u
 
 // Private functions: derived from the esp32 i2c_master driver
 
+
 static void lcd_send(i2c_lcd_pcf8574_handle_t* lcd, uint8_t value, bool is_data) {
+    xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
     i2c_cmd_handle_t cmd = i2c_cmd_link_create();
     i2c_master_start(cmd);
     i2c_master_write_byte(cmd, (lcd->i2c_addr << 1) | I2C_MASTER_WRITE, true);
-    xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
     lcd_write_nibble(lcd, (value >> 4 & 0x0F), is_data, cmd);
     lcd_write_nibble(lcd, (value & 0x0F), is_data, cmd);
     i2c_master_stop(cmd);
     esp_err_t ret = i2c_master_cmd_begin(lcd->i2c_port, cmd, I2C_MASTER_TIMEOUT_MS / portTICK_PERIOD_MS);
-    xSemaphoreGive(main_i2c_mutex);
     i2c_cmd_link_delete(cmd);
+    xSemaphoreGive(main_i2c_mutex);
     
     if (ret != ESP_OK) {
         ESP_LOGE(TAG, "Failed to send data to LCD: %s", esp_err_to_name(ret));
@@ -350,15 +346,15 @@ static void lcd_write_i2c(i2c_lcd_pcf8574_handle_t* lcd, uint8_t data, bool is_d
         data |= lcd->backlight_mask;
     }
 
+    xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
     i2c_cmd_handle_t cmd = i2c_cmd_link_create();
     i2c_master_start(cmd);
     i2c_master_write_byte(cmd, (lcd->i2c_addr << 1) | I2C_MASTER_WRITE, true);
     i2c_master_write_byte(cmd, data, true);
     i2c_master_stop(cmd);
-    xSemaphoreTake(main_i2c_mutex, portMAX_DELAY);
     esp_err_t ret = i2c_master_cmd_begin(lcd->i2c_port, cmd, I2C_MASTER_TIMEOUT_MS / portTICK_PERIOD_MS);
-    xSemaphoreGive(main_i2c_mutex);
     i2c_cmd_link_delete(cmd);
+    xSemaphoreGive(main_i2c_mutex);
 
     if (ret != ESP_OK) {
         ESP_LOGE(TAG, "Failed to write to LCD: %s", esp_err_to_name(ret));

main/drivers/i2c_lcd_pcf8574.h

@@ -91,7 +91,7 @@ void lcd_autoscroll(i2c_lcd_pcf8574_handle_t* lcd);
 void lcd_no_autoscroll(i2c_lcd_pcf8574_handle_t* lcd);
 
 // Set backlight brightness
-void lcd_set_backlight_to(i2c_lcd_pcf8574_handle_t* lcd, uint8_t brightness);
+void lcd_set_backlight(i2c_lcd_pcf8574_handle_t* lcd, uint8_t brightness);
 
 // Create a custom character
 void lcd_create_char(i2c_lcd_pcf8574_handle_t* lcd, uint8_t location, const uint8_t charmap[]);

main/drivers/inputs.cpp

@@ -0,0 +1,486 @@
+#include "blk_box_drivers/inputs.hpp"
+
+#include "bottom_half.h"
+#include "pins.h"
+#include "driver/i2c.h"
+#include "driver/gpio.h"
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "esp_log.h"
+#include "esp_err.h"
+
+static const char *TAG = "INPUTS";
+
+static TaskHandle_t expander_task_handle = NULL;
+
+static i2c_master_dev_handle_t expander_i2c_dev_handle;
+
+const static uint8_t REG_WHOAMI = 0x01;
+const static uint8_t REG_SW_VERSION = 0x02;
+const static uint8_t REG_EVENT_QUEUE_POP = 0x10;
+const static uint8_t REG_EVENT_QUEUE_LEN = 0x11;
+const static uint8_t REG_STATE_BUTTONS = 0x20;
+const static uint8_t REG_STATE_SWITCHES = 0x21;
+const static uint8_t REG_STATE_KEYPAD = 0x22;
+const static uint8_t REG_STATE_TOUCH = 0x23;
+const static uint8_t REG_STATE_RFID = 0x24;
+const static uint8_t REG_STATE_HALL = 0x25;
+const static uint8_t REG_STATE_CLOSE = 0x26;
+const static uint8_t REG_RESET = 0x30;
+const static uint8_t REG_HALL_SENSITIVITY = 0x31;
+const static uint8_t REG_CLOSE_SENSITIVITY = 0x32;
+const static uint8_t REG_SWITCH_TOUCH_EVENT = 0x33;
+
+/// The global data for the expander peripheral.
+class ExpanderPeripheral {
+    // TODO: change these to private
+    // or even make this class hidden
+    public: 
+    SemaphoreHandle_t state_mutex;
+    InputsState state;
+
+    // channels
+    QueueHandle_t button_press_events;
+    QueueHandle_t button_release_events;
+    QueueHandle_t switch_flip_events;
+    QueueHandle_t switch_touch_events;
+    QueueHandle_t touch_events;
+    QueueHandle_t keypad_press_events;
+    QueueHandle_t keypad_release_events;
+};
+
+ExpanderPeripheral expander_peripheral_singleton;
+
+// forward declarations
+static void get_events();
+static void handle_event(uint8_t event);
+static void handle_button_switch_event(uint8_t event);
+static void handle_keypad_event(uint8_t event);
+static void handle_touch_event(uint8_t event);
+static void handle_rfid_event(uint8_t event);
+static void handle_close_hal_event(uint8_t event);
+static void expander_task(void *arg);
+
+// ISR handler
+static void IRAM_ATTR expander_isr_handler(void *arg) {
+    BaseType_t xHigherPriorityTaskWoken = pdFALSE;
+
+    if (expander_task_handle != NULL) {
+        vTaskNotifyGiveFromISR(expander_task_handle, &xHigherPriorityTaskWoken);
+    }
+
+    if (xHigherPriorityTaskWoken == pdTRUE) {
+        portYIELD_FROM_ISR();
+    }
+}
+
+void init_expander() {
+    ESP_LOGI(TAG, "Initializing expander...");
+
+    i2c_device_config_t dev_config = {
+        .dev_addr_length = I2C_ADDR_BIT_LEN_7,
+        .device_address = EXPANDER_I2C_ADDR,
+        .scl_speed_hz = EXPANDER_I2C_SPEED,
+        .scl_wait_us = 0, // default
+        .flags = {
+            .disable_ack_check = 0,
+        }
+    };
+
+    // setup interrupt on BOTTOM_PIN_INTERUPT
+    gpio_config_t io_conf = {
+        .pin_bit_mask = (1ULL << BOTTOM_PIN_INTERUPT),
+        .mode = GPIO_MODE_INPUT,
+        .pull_up_en = GPIO_PULLUP_ENABLE,
+        .pull_down_en = GPIO_PULLDOWN_DISABLE,
+        .intr_type = GPIO_INTR_NEGEDGE
+    };
+
+    ESP_ERROR_CHECK(gpio_config(&io_conf));
+
+    // Install ISR service (only call once in your program)
+    ESP_ERROR_CHECK(gpio_install_isr_service(0));
+
+    // Attach the ISR to the expander pin
+    ESP_ERROR_CHECK(gpio_isr_handler_add(BOTTOM_PIN_INTERUPT, expander_isr_handler, NULL));
+
+    // verify the expander connection status by reading the WHOAMI register
+    uint8_t read_buf[2] = {0};
+
+    i2c_master_write_read_device(I2C_NUM_0, BOTTOM_I2C_ADDR, &REG_WHOAMI, 1, read_buf, 1, 1000);
+
+    if (read_buf[0] != EXPANDER_WHOAMI_VALUE) {
+        ESP_LOGE(TAG, "WHOAMI mismatch, expected 0x%02X, got 0x%02X", EXPANDER_WHOAMI_VALUE, read_buf[0]);
+        return;
+    }
+
+    ESP_LOGD(TAG, "Expander WHOAMI check passed");
+
+    ESP_ERROR_CHECK(i2c_master_transmit_receive(expander_i2c_dev_handle, &REG_SW_VERSION, 1, read_buf, 2, EXPANDER_TIMEOUT_MS));
+
+    // init the peripheral struct
+    expander_peripheral_singleton.state_mutex = xSemaphoreCreateMutex();
+    expander_peripheral_singleton.button_press_events= xQueueCreate(EXPANDER_EVENT_QUEUE_SIZE, sizeof(Button));
+    expander_peripheral_singleton.button_release_events= xQueueCreate(EXPANDER_EVENT_QUEUE_SIZE, sizeof(Button));
+    expander_peripheral_singleton.switch_flip_events= xQueueCreate(EXPANDER_EVENT_QUEUE_SIZE, sizeof(SwitchFlip));
+    expander_peripheral_singleton.switch_touch_events= xQueueCreate(EXPANDER_EVENT_QUEUE_SIZE, sizeof(SwitchTouch));
+    expander_peripheral_singleton.touch_events= xQueueCreate(EXPANDER_EVENT_QUEUE_SIZE, sizeof(TouchedReleased));
+    expander_peripheral_singleton.keypad_press_events= xQueueCreate(EXPANDER_KEYPAD_QUEUE_SIZE, sizeof(KeypadKey));
+    expander_peripheral_singleton.keypad_release_events= xQueueCreate(EXPANDER_KEYPAD_QUEUE_SIZE, sizeof(KeypadKey));
+
+    ESP_LOGI(TAG, "Expander initialized! SW version: v%d.%d", read_buf[0], read_buf[1]);
+
+    // Create the expander background worker task
+    BaseType_t task_created = xTaskCreate(
+        expander_task,
+        "expander_task",
+        4096,
+        NULL,
+        tskIDLE_PRIORITY + 1,
+        &expander_task_handle
+    );
+
+    if (task_created != pdPASS) {
+        ESP_LOGE(TAG, "Failed to create expander task");
+    }
+}
+
+static void expander_task(void *arg) {
+    (void)arg;
+
+    while (true) {
+        get_events();
+
+        // Wait for interrupt notification (signal is sent when INT falls)
+        ulTaskNotifyTake(pdTRUE, portMAX_DELAY);
+    }
+}
+
+static void get_events() {
+    uint8_t recv;
+    while (gpio_get_level(PIN_EXPANDER_INT) == 0) {
+        ESP_ERROR_CHECK(i2c_master_transmit_receive(expander_i2c_dev_handle, &REG_EVENT_QUEUE_POP, 1, &recv, 1, EXPANDER_TIMEOUT_MS));
+        handle_event(recv);
+    }
+}
+
+static void handle_event(uint8_t event) {
+    const uint8_t BUTTON_SWITCH = 0b000;
+    const uint8_t KEYPAD = 0b001;
+    const uint8_t TOUCH = 0b010;
+    const uint8_t RFID = 0b011;
+
+    ESP_LOGD(TAG, "Expander event: 0b%08b (0x%02X)", event, event);
+
+    if (event == 0) {
+        ESP_LOGE(TAG, "We read from event queue while it was empty!");
+        return;
+    }
+
+    uint8_t type_bits = event >> 5;
+
+    switch (type_bits) {
+        case BUTTON_SWITCH:
+            handle_button_switch_event(event);
+            break;
+        case KEYPAD:
+            handle_keypad_event(event);
+            break;
+        case TOUCH:
+            handle_touch_event(event);
+            break;
+        case RFID:
+            handle_rfid_event(event);
+            break;
+        default:
+            handle_close_hal_event(event);
+            break;
+    }
+}
+
+static void handle_button_switch_event(uint8_t event) {
+    const uint8_t PRESSED_NOT_RELEASED_BIT = 0b10000;
+    const uint8_t SWITCH_NOT_BUTTON_BIT = 0b01000;
+    const uint8_t SWITCH_UP_NOT_DOWN_BIT = 0b00100;
+    const uint8_t NUMBER_MASK = 0b00011;
+
+    bool pressed = (event & PRESSED_NOT_RELEASED_BIT) != 0;
+    uint8_t number = event & NUMBER_MASK;
+
+    if ((event & SWITCH_NOT_BUTTON_BIT) != 0) {
+        // For now, we support two position switches by only looking at the switch up events
+        bool switch_up = (event & SWITCH_UP_NOT_DOWN_BIT) != 0;
+        if (!switch_up) {
+            return;
+        }
+
+        Switch sw = static_cast<Switch>(number);
+        SwitchFlip sw_flip = SwitchFlip(sw, pressed);
+        xQueueSendToBack(expander_peripheral_singleton.switch_flip_events, &sw_flip, 0);
+        xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+        if (pressed) {
+            // set
+            expander_peripheral_singleton.state.switch_state |= 1 << number;
+        } else {
+            // clear
+            expander_peripheral_singleton.state.switch_state &= ~(1 << number);
+        }
+        xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+    } else {
+        // button
+        Button button = static_cast<Button>(number);
+        if (pressed) {
+            xQueueSendToBack(expander_peripheral_singleton.button_press_events, &button, 0);
+            xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+            expander_peripheral_singleton.state.button_state |= 1 << number;
+            xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+        } else {
+            xQueueSendToBack(expander_peripheral_singleton.button_release_events, &button, 0);
+            xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+            expander_peripheral_singleton.state.button_state &= ~(1 << number);
+            xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+        }
+    }
+}
+
+static void handle_keypad_event(uint8_t event) {
+    const uint8_t PRESSED_NOT_RELEASED_BIT = 0b10000;
+    const uint8_t KEY_MASK = 0b1111;
+
+    bool pressed = (event & PRESSED_NOT_RELEASED_BIT) != 0;
+    uint8_t number = event & KEY_MASK;
+    KeypadKey key = static_cast<KeypadKey>(number);
+
+    // starcode system gets first dibs
+    // TODO: do starcode inbetweener
+    // if starcode_handle_keypad(key, pressed).await {
+    //     return;
+    // }
+
+    if (pressed) {
+        xQueueSendToBack(expander_peripheral_singleton.keypad_press_events, &key, 0);
+        xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+        expander_peripheral_singleton.state.keypad_state |= 1 << number;
+        xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+    } else {
+        xQueueSendToBack(expander_peripheral_singleton.keypad_release_events, &key, 0);
+        xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+        expander_peripheral_singleton.state.keypad_state &= ~(1 << number);
+        xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+    }
+}
+
+static void handle_touch_event(uint8_t event) {
+    const uint8_t TOUCHED_NOT_UNTOUCHED_BIT = 0b10000;
+    const uint8_t SENSOR_MASK = 0b0111;
+    const uint8_t FINGERPRINT_BIT = 0b0100;
+
+    bool touched = (event & TOUCHED_NOT_UNTOUCHED_BIT) != 0;
+    uint8_t sensor = event & SENSOR_MASK;
+
+    if ((sensor & FINGERPRINT_BIT) != 0) {
+        TouchedReleased touch_state = static_cast<TouchedReleased>(touched);
+        xQueueSendToBack(expander_peripheral_singleton.touch_events, &touch_state, 0);
+    } else {
+        Switch sw = static_cast<Switch>(sensor);
+        SwitchTouch sw_touch = SwitchTouch(sw, touched);
+        xQueueSendToBack(expander_peripheral_singleton.switch_touch_events, &sw_touch, 0);
+    }
+
+    xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+    if (touched) {
+        expander_peripheral_singleton.state.touch_state |= 1 << sensor;
+    } else {
+        expander_peripheral_singleton.state.touch_state &= ~(1 << sensor);
+    }
+    xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+}
+
+static void handle_rfid_event(uint8_t event) {
+    // TODO: impl
+    (void)event;
+}
+
+static void handle_close_hal_event(uint8_t event) {
+    // TODO: impl
+    (void)event;
+}
+
+// InputsController implementations
+
+/// Clears all events waiting in the queues.
+void InputsController::clear_all_events() {
+    xQueueReset(expander_peripheral_singleton.button_press_events);
+    xQueueReset(expander_peripheral_singleton.button_release_events);
+    xQueueReset(expander_peripheral_singleton.switch_flip_events);
+    xQueueReset(expander_peripheral_singleton.switch_touch_events);
+    xQueueReset(expander_peripheral_singleton.touch_events);
+    xQueueReset(expander_peripheral_singleton.keypad_press_events);
+    xQueueReset(expander_peripheral_singleton.keypad_release_events);
+}
+
+InputsState InputsController::get_input_state() {
+    xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+    InputsState state_copy = expander_peripheral_singleton.state;
+    xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+    return state_copy;
+}
+
+/// Returns `true` iff there is a button press event waiting.
+bool InputsController::has_button_press() {
+    return uxQueueMessagesWaiting(expander_peripheral_singleton.button_press_events) > 0;
+}
+
+/// Gets the next button press event (if any).
+std::optional<Button> InputsController::get_button_press() {
+    Button b;
+    if (xQueueReceive(expander_peripheral_singleton.button_press_events, &b, 0) == pdTRUE) {
+        return b;
+    }
+    return std::nullopt;
+}
+
+/// Gets the next button press event, waiting if neccesary.
+Button InputsController::wait_button_press() {
+    Button b;
+    xQueueReceive(expander_peripheral_singleton.button_press_events, &b, portMAX_DELAY);
+    return b;
+}
+
+/// Gets the current state of the buttons.
+uint8_t InputsController::button_state() {
+    xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+    uint8_t value = expander_peripheral_singleton.state.button_state;
+    xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+    return value;
+}
+
+/// Returns `true` iff there is a button release event waiting.
+bool InputsController::has_button_release() {
+    return uxQueueMessagesWaiting(expander_peripheral_singleton.button_release_events) > 0;
+}
+
+/// Gets the next button release event (if any).
+std::optional<Button> InputsController::get_button_release() {
+    Button b;
+    if (xQueueReceive(expander_peripheral_singleton.button_release_events, &b, 0) == pdTRUE) {
+        return b;
+    }
+    return std::nullopt;
+}
+
+/// Gets the next button release event, waiting if neccesary.
+Button InputsController::wait_button_release() {
+    Button b;
+    xQueueReceive(expander_peripheral_singleton.button_release_events, &b, portMAX_DELAY);
+    return b;
+}
+
+/// Returns `true` iff there is a switch flip event waiting.
+bool InputsController::has_switch_flip() {
+    return uxQueueMessagesWaiting(expander_peripheral_singleton.switch_flip_events) > 0;
+}
+
+/// Gets the next switch flip event (if any).
+std::optional<SwitchFlip> InputsController::get_switch_flip() {
+    SwitchFlip s;
+    if (xQueueReceive(expander_peripheral_singleton.switch_flip_events, &s, 0) == pdTRUE) {
+        return s;
+    }
+    return std::nullopt;
+}
+
+/// Gets the next switch flip event, waiting if neccesary.
+SwitchFlip InputsController::wait_switch_flip() {
+    SwitchFlip s;
+    xQueueReceive(expander_peripheral_singleton.switch_flip_events, &s, portMAX_DELAY);
+    return s;
+}
+
+/// Gets the current state of the switches.
+uint8_t InputsController::switch_state() {
+    xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+    uint8_t value = expander_peripheral_singleton.state.switch_state;
+    xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+    return value;
+}
+
+/// Returns `true` iff there is a switch touch event waiting.
+bool InputsController::has_switch_touch() {
+    return uxQueueMessagesWaiting(expander_peripheral_singleton.switch_touch_events) > 0;
+}
+
+/// Gets the next switch touch event (if any).
+std::optional<SwitchTouch> InputsController::get_switch_touch() {
+    SwitchTouch s;
+    if (xQueueReceive(expander_peripheral_singleton.switch_touch_events, &s, 0) == pdTRUE) {
+        return s;
+    }
+    return std::nullopt;
+}
+
+/// Gets the next switch touch event, waiting if neccesary.
+SwitchTouch InputsController::wait_switch_touch() {
+    SwitchTouch s;
+    xQueueReceive(expander_peripheral_singleton.switch_touch_events, &s, portMAX_DELAY);
+    return s;
+}
+
+/// Gets the current state of the touch sensors.
+uint8_t InputsController::switch_touch_state() {
+    xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+    uint8_t value = expander_peripheral_singleton.state.touch_state;
+    xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+    return value;
+}
+
+/// Returns `true` iff there is a keypad press event waiting.
+bool InputsController::has_keypad_press() {
+    return uxQueueMessagesWaiting(expander_peripheral_singleton.keypad_press_events) > 0;
+}
+
+/// Gets the next keypad press event (if any).
+std::optional<KeypadKey> InputsController::get_keypad_press() {
+    KeypadKey k;
+    if (xQueueReceive(expander_peripheral_singleton.keypad_press_events, &k, 0) == pdTRUE) {
+        return k;
+    }
+    return std::nullopt;
+}
+
+/// Gets the next keypad press event, waiting if neccesary.
+KeypadKey InputsController::wait_keypad_press() {
+    KeypadKey k;
+    xQueueReceive(expander_peripheral_singleton.keypad_press_events, &k, portMAX_DELAY);
+    return k;
+}
+
+/// Returns `true` iff there is a keypad release event waiting.
+bool InputsController::has_keypad_release() {
+    return uxQueueMessagesWaiting(expander_peripheral_singleton.keypad_release_events) > 0;
+}
+
+/// Gets the next keypad release event (if any).
+std::optional<KeypadKey> InputsController::get_keypad_release() {
+    KeypadKey k;
+    if (xQueueReceive(expander_peripheral_singleton.keypad_release_events, &k, 0) == pdTRUE) {
+        return k;
+    }
+    return std::nullopt;
+}
+
+/// Gets the next keypad release event, waiting if neccesary.
+KeypadKey InputsController::wait_keypad_release() {
+    KeypadKey k;
+    xQueueReceive(expander_peripheral_singleton.keypad_release_events, &k, portMAX_DELAY);
+    return k;
+}
+
+/// Gets the current state of the keypad.
+uint16_t InputsController::keypad_state() {
+    xSemaphoreTake(expander_peripheral_singleton.state_mutex, portMAX_DELAY);
+    uint16_t value = expander_peripheral_singleton.state.keypad_state;
+    xSemaphoreGive(expander_peripheral_singleton.state_mutex);
+    return value;
+}
+

main/drivers/nvs.cpp

@@ -1,63 +0,0 @@
-#include "nvs.h"
-#include "esp_log.h"
-#include "bottom_half.h"
-#include "char_lcd.h"
-
-static const char* TAG = "nvs";
-
-static const char* HWDATA_NAMESPACE = "hwdata";
-static HWData hw_data;
-
-bool init_nvs() {
-    ESP_LOGI(TAG, "Initializing NVS...");
-    esp_err_t ret = nvs_flash_init();
-    if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) {
-        // NVS partition was truncated, erase and retry
-        ESP_LOGE(TAG, "Failed to init nvs flash: %s.", esp_err_to_name(ret));
-        lcd_print(1, 0, "NVS: ");
-        lcd_print(1, 4, esp_err_to_name(ret));
-        lcd_print(2, 0, "Press Yellow to skip");
-        lcd_print(3, 0, "Press Red to erase");
-
-        ButtonKey button;
-        while (!( get_button_pressed(&button) && (button == ButtonKey::button_red || button == ButtonKey::button_yellow) )) vTaskDelay(pdMS_TO_TICKS(10));
-
-        lcd_clear();
-        
-        if (button == ButtonKey::button_yellow) {
-            return false;
-        }
-        if (button == ButtonKey::button_red) {
-            ESP_ERROR_CHECK(nvs_flash_erase());
-            ret = nvs_flash_init();
-        }
-    }
-    ESP_ERROR_CHECK(ret);
-
-    nvs_handle_t hw_handle;
-    ret = nvs_open(HWDATA_NAMESPACE, NVS_READONLY, &hw_handle);
-    if (ret == ESP_ERR_NVS_NOT_FOUND) {
-        ESP_LOGW(TAG, "Partition \"%s\" has not been initialized. Loading defaults.", HWDATA_NAMESPACE);
-        hw_data = HWData();
-    } else {
-        ESP_ERROR_CHECK(ret);
-        hw_data = HWData::load(hw_handle);
-        nvs_close(hw_handle);
-    }
-
-    ESP_LOGI(TAG, "NVS initialized!");
-
-    return true;
-}
-
-HWData& get_hw_data() {
-    return hw_data;
-}
-
-void save_hw_data(bool force) {
-    nvs_handle_t hw_handle;
-    ESP_ERROR_CHECK(nvs_open(HWDATA_NAMESPACE, NVS_READWRITE, &hw_handle));
-    hw_data.save(hw_handle);
-    nvs_close(hw_handle);
-}
-

main/drivers/nvs.h

@@ -1,13 +0,0 @@
-#ifndef NVS_H
-#define NVS_H
-
-#include "nvs_flash.h"
-#include "hwdata.h"
-
-/// @brief Initializes the NVS.
-bool init_nvs();
-
-/// Gets the HWData stored in NVS.
-HWData& get_hw_data();
-
-#endif /* NVS_H */

main/drivers/power.cpp

@@ -12,9 +12,9 @@ void bat_monitor_task(void* arg) {
         sprintf(str_buf, "%d.%03dV", voltage / 1000, voltage % 1000);
 
         lcd_clear();
-        lcd_print(0, 1, str_buf);
+        lcd_print(1, 0, str_buf);
 
-        int16_t current = lipo.current();
+        int16_t current = lipo.current(current_measure::AVG);
         sprintf(str_buf, "%dmA", current);
 
         lcd_print(1, 1, str_buf);
@@ -23,12 +23,12 @@ void bat_monitor_task(void* arg) {
         int16_t total_cap = lipo.capacity(capacity_measure::FULL);
         sprintf(str_buf, "%dmAh", total_cap);
 
-        lcd_print(2, 1, str_buf);
+        lcd_print(1, 2, str_buf);
 
         int16_t soc = lipo.soc(soc_measure::FILTERED);
         sprintf(str_buf, "%d%%", soc);
 
-        lcd_print(3, 1, str_buf);
+        lcd_print(1, 3, str_buf);
 
 
         vTaskDelay(pdMS_TO_TICKS(250));
@@ -60,7 +60,7 @@ void lcd_print_header_bat() {
     if (lcd_starcode_displaying_result()) return;
     
     uint8_t soc = lipo.soc();
-    int16_t current = lipo.current();
+    uint8_t current = lipo.current();
     char buf[6];
     if (soc < 5 && current <= 0) {
         snprintf(buf, sizeof(buf), " LOW");
@@ -74,27 +74,5 @@ void lcd_print_header_bat() {
         }
     }
 
-    lcd_print(0, 16, buf);
+    lcd_print(16, 0, buf);
 }
-
-// memory version
-// void lcd_print_header_bat() {
-//     if (!lcd_header_enabled()) return;
-//     if (lcd_starcode_displaying_result()) return;
-
-//     // Show memory usage percentage instead of battery percentage
-//     char buf[6];
-//     size_t free_heap = heap_caps_get_free_size(MALLOC_CAP_DEFAULT);
-//     size_t total_heap = heap_caps_get_total_size(MALLOC_CAP_DEFAULT);
-//     uint8_t mem_percent = 0;
-//     if (total_heap > 0) {
-//         mem_percent = (uint8_t)(100 - ((free_heap * 100) / total_heap));
-//     }
-//     if (mem_percent >= 100) {
-//         snprintf(buf, sizeof(buf), " 100");
-//     } else {
-//         snprintf(buf, sizeof(buf), " %2d%%", mem_percent);
-//     }
-
-//     lcd_print(0, 16, buf);
-// }

main/drivers/sd.cpp

@@ -51,10 +51,10 @@ bool init_sd() {
         ESP_LOGE(TAG, "Failed to mount sd card: %s.", esp_err_to_name(ret));
 
         lcd_print(0, 0, "SD: ");
-        lcd_print(0, 4, esp_err_to_name(ret));
+        lcd_print(4, 0, esp_err_to_name(ret));
-        lcd_print(1, 0, "Press Green to retry");
+        lcd_print(0, 1, "Press Green to retry");
-        lcd_print(2, 0, "Press Yellow to skip");
+        lcd_print(0, 2, "Press Yellow to skip");
-        lcd_print(3, 0, "Press Red to format");
+        lcd_print(0, 3, "Press Red to format");
 
         ButtonKey button;
         while (!( get_button_pressed(&button) && (button == ButtonKey::button_green || button == ButtonKey::button_red || button == ButtonKey::button_yellow) )) vTaskDelay(pdMS_TO_TICKS(10));

main/drivers/starcode.cpp

@@ -7,7 +7,6 @@
 #include "drivers/bottom_half.h"
 #include "char_lcd.h"
 #include "esp_timer.h"
-#include "freertos/task.h"
 
 static const char* TAG = "star_code";
 
@@ -15,7 +14,7 @@ volatile bool handling_new_starcodes = false;
 static volatile bool system_initialized = false;
 
 // TODO: use the semaphore, convert to RWLock?
-static volatile SemaphoreHandle_t star_codes_mutex;
+static volatile SemaphoreHandle_t star_codes_sem;
 static std::vector<StarCodeEntry> star_codes;
 
 static const char EMPTY_STAR_CODE_HEADER[] = "          ";
@@ -30,19 +29,10 @@ static uint16_t starcode_waiting_on_release;
 static char current[STARCODE_MAX_LEN + 1];
 static size_t current_idx;
 
-// Task handle for the starcode callback task
+static void starcode_trigger_cb(void* arg) {
-static TaskHandle_t starcode_callback_task_handle = nullptr;
-
-static void starcode_callback_task(void* arg) {
     (void) arg;
 
-    while (true) {
-        // Wait for notification from starcode_trigger_cb
-        uint32_t notification_value;
-        if (xTaskNotifyWait(0, ULONG_MAX, &notification_value, portMAX_DELAY) == pdTRUE) {
-            // Process the starcode callback
     delaying_for_starcode = false;
-            lcd_print_header();
 
     if (current_starcode != nullptr) {
         if (current_starcode->triggered_sem != nullptr)
@@ -52,18 +42,10 @@ static void starcode_callback_task(void* arg) {
         
         current_starcode = nullptr;
     }
-        }
-    }
-}
 
-static void starcode_trigger_cb(void* arg) {
+    // TODO: rename star code everywhere to starcode
-    (void) arg;
+    lcd_print_header();
-
-    if (starcode_callback_task_handle != nullptr) {
-        xTaskNotify(starcode_callback_task_handle, 1, eSetBits);
-    }
 }
-// TODO: rename star code everywhere to starcode
 
 
 void star_code_handle_keypad(uint16_t* just_pressed, uint16_t* just_released) {
@@ -109,9 +91,8 @@ void star_code_handle_keypad(uint16_t* just_pressed, uint16_t* just_released) {
 }
 
 void init_star_code_system() {
-    star_codes_mutex = xSemaphoreCreateMutex();
+    star_codes_sem = xSemaphoreCreateBinary();
-
+    xSemaphoreGive(star_codes_sem);
-    xTaskCreate(starcode_callback_task, "starcode_cb", 4096, NULL, 3, &starcode_callback_task_handle);
 
     const esp_timer_create_args_t timer_args = {
         .callback = &starcode_trigger_cb,

main/drivers/wires.cpp

@@ -2,9 +2,6 @@
 
 extern uint32_t current_step;
 
-/// The mutex for accessing `I2C_NUM_1` (wires I2C bus).
-SemaphoreHandle_t wires_i2c_mutex;
-
 uint32_t total_strikes;
 uint32_t step_strikes[N_STEPS] = {0};
 uint32_t step_finish_times[N_STEPS] = {0};
@@ -44,10 +41,6 @@ void init_wires(void) {
     ESP_ERROR_CHECK(i2c_param_config(WIRES_I2C_NUM, &wires_conf));
     ESP_ERROR_CHECK(i2c_driver_install(WIRES_I2C_NUM, wires_conf.mode, 0, 0, 0));
 
-    // Create mutex for wires I2C bus
-    wires_i2c_mutex = xSemaphoreCreateMutex();
-    assert(wires_i2c_mutex != NULL);
-
     gpio_config_t int_pin_conf = {};
     // delta_pin_conf.intr_type = GPIO_INTR_LOW_LEVEL;
     int_pin_conf.mode = GPIO_MODE_INPUT;
@@ -92,41 +85,33 @@ void clear_wires_pressed_released_cut(void) {
 
 void strike(const char* reason) {
     ESP_LOGW("strike!", "%s", reason);
-    lcd_print(3, 0, reason);
+    lcd_print(0, 3, reason);
     time_penalty(STRIKE_TIME_PENALTY);
     if (current_step > 0 && current_step <= N_STEPS) {
         total_strikes += 1;
         step_strikes[current_step - 1] += 1;
     }
     uint8_t reg = 6;
-    xSemaphoreTake(wires_i2c_mutex, portMAX_DELAY);
     ESP_ERROR_CHECK_WITHOUT_ABORT(i2c_master_write_to_device(WIRES_I2C_NUM, WIRES_I2C_ADDR, &reg, 1, (100 / portTICK_PERIOD_MS)));
-    xSemaphoreGive(wires_i2c_mutex);
 }
 
 void set_leds(uint8_t led_states) {
     buf[0] = 5; // register 5
     buf[1] = led_states;
-    xSemaphoreTake(wires_i2c_mutex, portMAX_DELAY);
     ESP_ERROR_CHECK_WITHOUT_ABORT(i2c_master_write_to_device(WIRES_I2C_NUM, WIRES_I2C_ADDR, buf, 2, (100 / portTICK_PERIOD_MS)));
-    xSemaphoreGive(wires_i2c_mutex);
 }
 
 static uint8_t receive_delta(void) {
     uint8_t reg = 1;
     buf[0] = 0;
-    xSemaphoreTake(wires_i2c_mutex, portMAX_DELAY);
     ESP_ERROR_CHECK_WITHOUT_ABORT(i2c_master_write_read_device(WIRES_I2C_NUM, WIRES_I2C_ADDR, &reg, 1, buf, 1, (100 / portTICK_PERIOD_MS)));
-    xSemaphoreGive(wires_i2c_mutex);
     return buf[0];
 }
 
 static void receive_wires(void) {
     uint8_t reg = 2;
     buf[0] = 0;
-    xSemaphoreTake(wires_i2c_mutex, portMAX_DELAY);
     ESP_ERROR_CHECK_WITHOUT_ABORT(i2c_master_write_read_device(WIRES_I2C_NUM, WIRES_I2C_ADDR, &reg, 1, buf, 1, (100 / portTICK_PERIOD_MS)));
-    xSemaphoreGive(wires_i2c_mutex);
     uint8_t new_wires = buf[0];
 
     uint8_t just_cut = ~new_wires & wires_state;
@@ -138,9 +123,7 @@ static void receive_wires(void) {
 static void receive_button(void) {
     uint8_t reg = 3;
     buf[0] = 0;
-    xSemaphoreTake(wires_i2c_mutex, portMAX_DELAY);
     ESP_ERROR_CHECK_WITHOUT_ABORT(i2c_master_write_read_device(WIRES_I2C_NUM, WIRES_I2C_ADDR, &reg, 1, buf, 1, (100 / portTICK_PERIOD_MS)));
-    xSemaphoreGive(wires_i2c_mutex);
     bool new_button = buf[0] != 0;
 
     bool just_pressed = new_button & !button_state;

main/drivers/wires.h

@@ -5,8 +5,6 @@
 #include <driver/i2c.h>
 #include <driver/gpio.h>
 #include <esp_log.h>
-#include "freertos/FreeRTOS.h"
-#include "freertos/semphr.h"
 #include "drivers/char_lcd.h"
 #include "drivers/game_timer.h"
 #include "main.h"
@@ -18,9 +16,6 @@
 #define WIRES_I2C_NUM I2C_NUM_1
 #define WIRES_I2C_ADDR 125
 
-/// The mutex for accessing `I2C_NUM_1` (wires I2C bus).
-extern SemaphoreHandle_t wires_i2c_mutex;
-
 #define DELTA_BIT_WIRES 0
 #define DELTA_BIT_BUTTON 1
 

main/steps/setup_wires.cpp

@@ -11,7 +11,7 @@ void print_wires(WireColor* wires, int editing_idx) {
     lcd_print(1, 1, string_buf);
 
     cut_to_string(cut, string_buf);
-    lcd_print(2, 1, string_buf);
+    lcd_print(1, 2, string_buf);
 
     wires_state = get_wires();
     for (int i = 0; i < NUM_WIRES; i++) {
@@ -21,10 +21,9 @@ void print_wires(WireColor* wires, int editing_idx) {
             string_buf[i] = '!';
         }
     }
-    lcd_print(3, 1, string_buf);
+    lcd_print(1, 3, string_buf);
 
-    lcd_set_cursor_vis(true);
+    lcd_set_cursor_pos(editing_idx+1, 1);
-    lcd_set_cursor_resting_position(1, editing_idx+1);
 }
 
 void setup_wires(void) {

main/steps/step0.cpp

@@ -64,17 +64,10 @@ void step0() {
             .callback = nullptr,
             .triggered_sem = continue_sem,
         },
-        {
-            .code = "59860",
-            .display_text = "Hardware Config",
-            .delay_us = 2'000'000,
-            .callback = hardware_config,
-            .triggered_sem = nullptr,
-        },
         {
             .code = "59861",
             .display_text = "Setup Wires",
-            .delay_us = 2'000'000,
+            .delay_us = 10'000'000,
             .callback = setup_wires,
             .triggered_sem = nullptr,
         },
@@ -221,8 +214,7 @@ static void _update_display(uint8_t* digits, uint8_t cursor_pos) {
     lcd_print(1, 1, str_buf);
     cursor_pos = MAX(0, MIN(4, cursor_pos));
     int mapped_cursor_pos = CURSOR_POS_MAP[cursor_pos];
-
+    lcd_set_cursor_pos(mapped_cursor_pos, 1);
-    lcd_set_cursor_resting_position(1, mapped_cursor_pos);
 }
 
 static void set_game_time() {
@@ -343,32 +335,32 @@ static void debug_switches() {
     while (1) {
         if (get_button_pressed(&button)) {
             sprintf(buf, "Button Pressed: %d ", button);
-            lcd_print(3, 0, buf);
+            lcd_print(0, 3, buf);
             ESP_LOGI(TAG, "%s", buf);
         }
         if (get_button_released(&button)) {
             sprintf(buf, "Button Released: %d", button);
-            lcd_print(3, 0, buf);
+            lcd_print(0, 3, buf);
             ESP_LOGI(TAG, "%s", buf);
         }
         if (get_switch_flipped_down(&switch_)) {
             sprintf(buf, "Switch Down: %d    ", switch_);
-            lcd_print(3, 0, buf);
+            lcd_print(0, 3, buf);
             ESP_LOGI(TAG, "%s", buf);
         }
         if (get_switch_flipped_up(&switch_)) {
             sprintf(buf, "Switch Up: %d      ", switch_);
-            lcd_print(3, 0, buf);
+            lcd_print(0, 3, buf);
             ESP_LOGI(TAG, "%s", buf);
         }
         if (get_switch_touch_pressed(&switch_)) {
             sprintf(buf, "Switch Touch: %d   ", switch_);
-            lcd_print(3, 0, buf);
+            lcd_print(0, 3, buf);
             ESP_LOGI(TAG, "%s", buf);
         }
         if (get_switch_touch_released(&switch_)) {
             sprintf(buf, "Switch Un-touch: %d", switch_);
-            lcd_print(3, 0, buf);
+            lcd_print(0, 3, buf);
             ESP_LOGI(TAG, "%s", buf);
         }
 
@@ -377,7 +369,7 @@ static void debug_switches() {
             switch_touch_state = new_switch_touch_state;
             print_4bin_rev(bin_buf, switch_touch_state);
             sprintf(buf, "t: %s", bin_buf);
-            lcd_print(0, 1, buf);
+            lcd_print(1, 0, buf);
             ESP_LOGI(TAG, "%s", buf);
         }
 
@@ -395,7 +387,7 @@ static void debug_switches() {
             button_state = new_button_state;
             print_4bin_rev(bin_buf, button_state);
             sprintf(buf, "b: %s", bin_buf);
-            lcd_print(2, 1, buf);
+            lcd_print(1, 2, buf);
             ESP_LOGI(TAG, "%s", buf);
         }
         

main/steps/step1.cpp

@@ -199,7 +199,7 @@ static int generate_part(void) {
 static void update_lcd_count(int times) {
     char buf[16] = {0};
     sprintf(buf, "%d/15", times);
-    lcd_print(1, 14, buf);
+    lcd_print(14, 1, buf);
 }
 
 static bool play_part(uint32_t time) {

main/steps/step5.cpp

@@ -729,7 +729,7 @@ void step5(void) {
                 }
 
                 // display expression
-                lcd_print(2, 1, display_expression.c_str());
+                lcd_print(1, 2, display_expression.c_str());
 
                 // set LEDs
                 const uint32_t COLORS[] = {
@@ -790,8 +790,8 @@ void step5(void) {
 
                         lcd_clear();
                         lcd_print(1, 1, "What");
-                        lcd_print(2, 1, display_expression.c_str());
+                        lcd_print(1, 2, display_expression.c_str());
-                        lcd_print(3, 1, entered_string.c_str());
+                        lcd_print(1, 3, entered_string.c_str());
                     }
                     if (get_module_time() <= 0) {
                         strike("Ran out of time!");
@@ -849,7 +849,7 @@ void step5(void) {
 
                     // ESP_LOGI(TAG, "color string: %s", color_string.c_str());
 
-                    lcd_print(2, 1, color_string.c_str());
+                    lcd_print(1, 2, color_string.c_str());
 
                     std::string entered_string;
 
@@ -880,8 +880,8 @@ void step5(void) {
 
                             lcd_clear();
                             lcd_print(1, 1, "Plink");
-                            lcd_print(2, 1, color_string.c_str());
+                            lcd_print(1, 2, color_string.c_str());
-                            lcd_print(3, 1, entered_string.c_str());
+                            lcd_print(1, 3, entered_string.c_str());
                         }
                         if (get_module_time() <= 0) {
                             strike("Ran out of time!");