Feat/new hold

.github/workflows/build.yml

@@ -21,7 +21,7 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build_examples:
+  build-examples:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -35,6 +35,8 @@ jobs:
           - stm32f1
           - stm32f4
           - stm32h7
+          - esp32c3_ble
+          - esp32c6_ble
         example_type:
           - use_rust
           - use_config
@@ -47,13 +49,33 @@ jobs:
       - name: Install cargo-make and flip-link
         run: cargo binstall cargo-make flip-link
       - name: Install target
-        run: rustup target add thumbv6m-none-eabi thumbv7em-none-eabihf thumbv7m-none-eabi
+        run: rustup target add thumbv6m-none-eabi thumbv7em-none-eabihf thumbv7m-none-eabi riscv32imac-unknown-none-elf riscv32imc-unknown-none-elf
       - name: Build example
         working-directory: ./examples/${{ matrix.example_type }}/${{ matrix.example }}
         run: cargo build --release
       - name: Build example uf2
+        if: ${{ matrix.example != 'esp32c3_ble' && matrix.example != 'esp32c6_ble' }}
         working-directory: ./examples/${{ matrix.example_type }}/${{ matrix.example }}
         run: cargo make uf2 --release
+  build-esp32s3:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        chip:
+          - esp32s3
+        example_type:
+          - use_rust
+          - use_config
+    steps:
+      - uses: cargo-bins/cargo-binstall@main
+      - uses: actions/checkout@v3
+      - name: Install ldproxy and espup
+        run: cargo binstall ldproxy espup -y
+      - name: Install esp toolchain
+        run: espup install
+      - name: Build
+        working-directory: ./examples/${{ matrix.example_type }}/${{ matrix.chip }}_ble
+        run: . /home/runner/export-esp.sh && cargo +esp build --release 
   binary-size:
     # Copied from sequential-storage: https://github.com/tweedegolf/sequential-storage/blob/master/.github/workflows/ci.yaml
     runs-on: ubuntu-latest

.github/workflows/unit_test.yml

@@ -35,4 +35,4 @@ jobs:
       - run: rustup update ${{ matrix.toolchain }} && rustup default ${{ matrix.toolchain }}
       - name: Run tests
         working-directory: ./rmk
-        run: cargo test --tests --no-default-features --verbose
+        run: cargo test --tests --no-default-features features="log, std" --verbose

.vscode/settings.json

@@ -1,4 +1,8 @@
 {
+    "[rust]": {
+        "editor.formatOnSave": true,
+        "editor.formatOnSaveMode": "file",
+    },
     "cortex-debug.variableUseNaturalFormat": false,
     "rust-analyzer.check.allTargets": false,
     "rust-analyzer.check.noDefaultFeatures": true,
@@ -7,57 +11,48 @@
     // Uncomment the target of your chip.
     //"rust-analyzer.cargo.target": "thumbv6m-none-eabi",
     //"rust-analyzer.cargo.target": "thumbv7m-none-eabi",
-    "rust-analyzer.cargo.target": "thumbv7em-none-eabi",
-    //"rust-analyzer.cargo.target": "thumbv7em-none-eabihf",
+    // "rust-analyzer.cargo.target": "thumbv7em-none-eabi",
+    // "rust-analyzer.cargo.target": "thumbv7em-none-eabihf",
     //"rust-analyzer.cargo.target": "thumbv8m.main-none-eabihf",
-    //"rust-analyzer.cargo.target": "riscv32imafc-unknown-none-elf",
-    //"rust-analyzer.cargo.target": "riscv32imc-esp-espidf",
-    //"rust-analyzer.cargo.target": "riscv32imac-esp-espidf",
-    //"rust-analyzer.cargo.target": "xtensa-esp32s3-espidf",
-    //"rust-analyzer.cargo.target": "riscv32imafc-unknown-none-elf",
-    "rust-analyzer.cargo.features": [
-        // Comment out these features when working on the examples. Most example crates do not have any cargo features.
-        // "stm32f446re",
-        // "time-driver-any",
-        // "unstable-pac",
-        // "exti",
-        // "rt",
-    ],
+    // "rust-analyzer.cargo.target": "riscv32imc-unknown-none-elf", // for esp32c3
+    // "rust-analyzer.cargo.target": "riscv32imac-unknown-none-elf", // for esp32c6
     "rust-analyzer.linkedProjects": [
         "rmk-macro/Cargo.toml",
         "rmk/Cargo.toml",
         // To work on the examples, comment the line above and all of the cargo.features lines,
         // then uncomment ONE line below to select the chip you want to work on.
         // This makes rust-analyzer work on the example crate and all its dependencies.
+        // "examples/use_config/esp32c3_ble/Cargo.toml",
+        // "examples/use_config/esp32c6_ble/Cargo.toml",
+        // "examples/use_config/esp32s3_ble/Cargo.toml",
+        // "examples/use_config/nef52832_ble/Cargo.toml",
+        // "examples/use_config/nrf52840_ble/Cargo.toml",
+        // "examples/use_config/nrf52840_ble_split/Cargo.toml",
+        // "examples/use_config/nrf52840_ble_split_direct_pin/Cargo.toml",
+        // "examples/use_config/rp2040/Cargo.toml"
+        // "examples/use_config/rp2040_direct_pin/Cargo.toml"
+        // "examples/use_config/rp2040_split/Cargo.toml"
+        // "examples/use_config/rp2040_split_pio/Cargo.toml"
+        // "examples/use_config/stm32f1/Cargo.toml",
+        // "examples/use_config/stm32f4/Cargo.toml",
+        // "examples/use_config/stm32h7/Cargo.toml",
         // "examples/use_rust/ch32v307/Cargo.toml",
         // "examples/use_rust/esp32c3_ble/Cargo.toml",
         // "examples/use_rust/esp32c6_ble/Cargo.toml",
         // "examples/use_rust/esp32s3_ble/Cargo.toml",
         // "examples/use_rust/hpm5300/Cargo.toml",
         // "examples/use_rust/nef52832_ble/Cargo.toml",
+        // "examples/use_rust/nrf52840/Cargo.toml",
         // "examples/use_rust/nrf52840_ble/Cargo.toml",
         // "examples/use_rust/nrf52840_ble_split/Cargo.toml",
         // "examples/use_rust/py32f07x/Cargo.toml",
         // "examples/use_rust/rp2040/Cargo.toml"
         // "examples/use_rust/rp2040_direct_pin/Cargo.toml"
         // "examples/use_rust/rp2040_split/Cargo.toml"
+        // "examples/use_rust/rp2040_split_pio/Cargo.toml"
         // "examples/use_rust/rp2350/Cargo.toml"
         // "examples/use_rust/stm32f1/Cargo.toml",
         // "examples/use_rust/stm32f4/Cargo.toml",
         // "examples/use_rust/stm32h7/Cargo.toml",
-        // "examples/use_config/esp32c3_ble/Cargo.toml",
-        // "examples/use_config/esp32c6_ble/Cargo.toml",
-        // "examples/use_config/esp32s3_ble/Cargo.toml",
-        // "examples/use_config/nef52832_ble/Cargo.toml",
-        // "examples/use_config/nrf52840_ble/Cargo.toml",
-        // "examples/use_config/nrf52840_ble_split/Cargo.toml",
-        // "examples/use_config/nrf52840_ble_split_direct_pin/Cargo.toml",
-        // "examples/use_config/nrf52840_usb/Cargo.toml",
-        // "examples/use_config/rp2040/Cargo.toml"
-        // "examples/use_config/rp2040_direct_pin/Cargo.toml"
-        // "examples/use_config/rp2040_split/Cargo.toml"
-        // "examples/use_config/stm32f1/Cargo.toml",
-        // "examples/use_config/stm32f4/Cargo.toml",
-        // "examples/use_config/stm32h7/Cargo.toml",
     ],
 }

docs/src/SUMMARY.md

@@ -16,7 +16,17 @@
 
 # Features
 - [Keyboard Configuration](keyboard_configuration.md)
-- [Keymap](keymap.md)
+    - [Keyboard and matrix](configuration/keyboard_matrix.md)
+    - [Layout](configuration/layout.md)
+    - [Split keyboard](configuration/split.md)
+    - [Storage](configuration/storage.md)
+    - [Behavior](configuration/behavior.md)
+    - [Input device](configuration/input_device.md)
+    - [Wireless/Bluetooth](configuration/wireless.md)
+    - [Light](configuration/light.md)
+    - [Appendix](configuration/appendix.md)
+- [Keymap](keymap/keymap.md)
+    - [Special keys](keymap/special_keys.md)
 - [Vial support](vial_support.md)
 - [Wireless](wireless.md)
 - [Low-power](low_power.md)

docs/src/binary_size_optimization.md

@@ -31,8 +31,8 @@ By default, RMK uses `panic-probe` to print error messages if panic occurs. But
 ```diff
 # In your binary's Cargo.toml
 
-- panic-probe = { version = "0.3", features = ["print-defmt"] }
-+ panic-halt = "0.2"
+- panic-probe = { version = "1.0", features = ["print-defmt"] }
++ panic-halt = "1.0"
 ```
 
 The in `main.rs`, use `panic-halt` instead:
@@ -51,7 +51,7 @@ You can also remove the entire defmt-rtt logger to save flash.
 
 ```diff
 # In your binary's Cargo.toml 
-- defmt-rtt = "0.4"
+- defmt-rtt = "1.0"
 ```
 
 In this case, you have to implement an empty defmt logger.