Merge pull request HaoboGu#161 from HaoboGu/feat/add_clear_storage_option

feat(storage): add `clear_storage` option

Author: HaoboGu

docs/src/faq.md

@@ -38,6 +38,18 @@ By default, Rust compiler generates `elf` file in target folder. There're a litt
 
   This script requires you have `python` command available in your commandline. Some platforms have `python3` command only, you can change `python` in `Makefile.toml` to `python3` in this case.
 
+### I changed keymap in `keyboard.toml`, but the keyboard is not updated
+
+RMK assumes that users change the keymap using [vial](https://vial.rocks). So reflashing the firmware won't change the keymap by default. For testing senario, RMK provides a config `clear_storage` under `[storage]` section, you can enable it to clear the storage when the keyboard boots.
+
+```toml
+[storage]
+# Set `clear_storage` to true to clear all the stored info when the keyboard boots
+clear_storage = true
+```
+
+Note that the storage will be clear EVERYTIME you reboot the keyboard.
+
 ### I can see a `RMK Start` log, but nothing else
 
 First you need to check the RCC config of your board, make sure that the USB's clock is enabled and set to 48MHZ. For example, if you're using stm32f1, you can set the RCC as the following:

docs/src/storage.md

@@ -21,6 +21,10 @@ enabled = true
 start_addr = 0x00000000
 # How many sectors are used for storage, the default value is 2
 num_sectors = 2
+# Clear storage at keyboard boot. 
+# Set it to true will reset the storage(including keymap, BLE bond info, etc.) at each reboot.
+# This option is useful when testing the firmware.
+clear_storage = false
 ```
 
 You can also edit `storage_config` field in `RmkConfig` if you're using Rust API:
@@ -31,6 +35,7 @@ You can also edit `storage_config` field in `RmkConfig` if you're using Rust API
 let storage_config = StorageConfig {
     start_addr: 0x70000,
     num_sectors: 2,
+    ..Default::default()
 };
 let keyboard_config = RmkConfig {
     usb_config: keyboard_usb_config,

examples/use_config/nrf52840_ble/keyboard.toml

@@ -19,7 +19,7 @@ cols = 3
 layers = 2
 keymap = [
     [
-        ["A", "B", "C"],
+        ["A", "A", "A"],
         ["Kc1", "Kc2", "Kc3"],
         ["LCtrl", "MO(1)", "LShift"],
         ["OSL(1)", "LT(2, Kc9)", "LM(1, LShift | LGui)"]
@@ -45,6 +45,7 @@ capslock.low_active = false
 [storage]
 # Storage feature is enabled by default
 # enabled = false
+clear_storage = true
 
 [ble]
 enabled = true

examples/use_rust/nrf52832_ble/src/main.rs

@@ -47,6 +47,7 @@ async fn main(spawner: Spawner) {
     let storage_config = StorageConfig {
         start_addr: 0x70000,
         num_sectors: 2,
+        ..Default::default()
     };
     let keyboard_config = RmkConfig {
         usb_config: keyboard_usb_config,

examples/use_rust/nrf52840_ble/src/main.rs

@@ -96,6 +96,7 @@ async fn main(spawner: Spawner) {
     let storage_config = StorageConfig {
         start_addr: 0,
         num_sectors: 6,
+        ..Default::default()
     };
     let keyboard_config = RmkConfig {
         usb_config: keyboard_usb_config,

examples/use_rust/nrf52840_ble_split/src/central.rs

@@ -98,6 +98,7 @@ async fn main(spawner: Spawner) {
     let storage_config = StorageConfig {
         start_addr: 0,
         num_sectors: 6,
+        ..Default::default()
     };
     let keyboard_config = RmkConfig {
         usb_config: keyboard_usb_config,

rmk-macro/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `clear_storage` option
+
 ## [0.3.4] - 2024-11-27
 
 ### Changed

rmk-macro/src/config/mod.rs

@@ -77,6 +77,8 @@ pub struct StorageConfig {
     pub num_sectors: Option<u8>,
     #[serde(default = "default_true")]
     pub enabled: bool,
+    // Clear on the storage at reboot, set this to true if you want to reset the keymap
+    pub clear_storage: Option<bool>,
 }
 
 #[derive(Clone, Default, Debug, Deserialize)]

rmk-macro/src/default_config/esp32.rs

@@ -17,6 +17,7 @@ pub(crate) fn default_esp32(chip: ChipModel) -> KeyboardConfig {
             start_addr: Some(0),
             num_sectors: Some(32),
             enabled: true,
+            ..Default::default()
         },
         ..Default::default()
     }

rmk-macro/src/default_config/nrf52810.rs

@@ -17,6 +17,7 @@ pub(crate) fn default_nrf52810(chip: ChipModel) -> KeyboardConfig {
             start_addr: Some(0x28000),
             num_sectors: Some(8),
             enabled: true,
+            ..Default::default()
         },
         ..Default::default()
     }