Skip to content

Commit

Permalink
doc: fix typo, use latest rmk version
Browse files Browse the repository at this point in the history
Signed-off-by: Haobo Gu <[email protected]>
  • Loading branch information
HaoboGu committed Nov 18, 2024
1 parent 5da97f3 commit 2d8a2d7
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/po/zh_CN.po
Original file line number Diff line number Diff line change
Expand Up @@ -1635,7 +1635,7 @@ msgstr ""
#: src\wireless.md:5
msgid ""
"```toml\n"
"rmk = { version = \"0.3.1\", features = [\n"
"rmk = { version = \"0.4\", features = [\n"
" \"nrf52840_ble\", # Enable BLE feature for nRF52840\n"
"] }\n"
"```"
Expand Down
2 changes: 1 addition & 1 deletion docs/src/low_power.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
RMK supports low-power mode by using utilizing embassy's low-power feature and `Wait` trait in `embedded-hal-async`. To enable low-power mode, add `async_matrix` feature to your `Cargo.toml`:

```diff
rmk = { version = "0.3.1", features = [
rmk = { version = "0.4", features = [
"nrf52840_ble",
+ "async_matrix",
] }
Expand Down
4 changes: 2 additions & 2 deletions docs/src/wireless.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
RMK has built-in wireless(BLE) support for nRF52 series and ESP32. To use the wireless feature, you need to enable ble feature gate in your `Cargo.toml`:

```toml
rmk = { version = "0.3.1", features = [
rmk = { version = "0.4", features = [
"nrf52840_ble", # Enable BLE feature for nRF52840
] }
```
Expand Down Expand Up @@ -47,7 +47,7 @@ RMK supports at most 8 wireless profiles, profile 0 is activated by default. Via
- `User10`: clear current profile bond info
- `User11`: switch default output between USB/BLE

Vial also provides a way to customize the displayed keycode, see `customKeycodes` in [this example](https://github.com/HaoboGu/rmk/blob/main/examples/use_rust/nrf52840_ble/vial.json). If `customKeycodes` are configured, the `User0` ~ `User11` will be displayed as `BT0`, ..., `Switch\nOutput`.
Vial also provides a way to customize the displayed keycode, see `customKeycodes` in [this example](https://github.com/HaoboGu/rmk/blob/main/examples/use_rust/nrf52840_ble/vial.json). If `customKeycodes` are configured, the `User0` ~ `User11` will be displayed as `BT0`, ..., `Switch Output`.


If you've connected a host for a profile, other devices would not be able to connect to this profile before doing manually clearing.

0 comments on commit 2d8a2d7

Please sign in to comment.