kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: fix typos in various places

Browse source
This commit is contained in:
Horu 2024-05-14 03:47:33 +07:00 • committed by GitHub
parent 4dfc45d4ab
commit 7d1f84e3eb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
app/Kconfig
View file

@ -157,7 +157,7 @@ config ZMK_BLE_EXPERIMENTAL_CONN
bool "Experimental BLE connection changes" bool "Experimental BLE connection changes"
help help
Enables a combination of settings that are planned to be default in future versions of ZMK Enables a combination of settings that are planned to be default in future versions of ZMK
to improve connection stability. This includes changes to timing on BLE pairing initation, to improve connection stability. This includes changes to timing on BLE pairing initiation,
restores use of the updated/new LLCP implementation, and disables 2M PHY support. restores use of the updated/new LLCP implementation, and disables 2M PHY support.
config ZMK_BLE_EXPERIMENTAL_SEC config ZMK_BLE_EXPERIMENTAL_SEC
@ -257,7 +257,7 @@ menu "Display/LED Options"
rsource "src/display/Kconfig" rsource "src/display/Kconfig"
menuconfig ZMK_RGB_UNDERGLOW menuconfig ZMK_RGB_UNDERGLOW
bool "RGB Adressable LED Underglow" bool "RGB Addressable LED Underglow"
select LED_STRIP select LED_STRIP
select ZMK_LOW_PRIORITY_WORK_QUEUE select ZMK_LOW_PRIORITY_WORK_QUEUE

2
app/boards/arm/corneish_zen/corneish_zen_v1_left.dts
View file

@ -88,7 +88,7 @@
fuelgauge: bq274xx@55 { fuelgauge: bq274xx@55 {
compatible = "ti,bq274xx"; compatible = "ti,bq274xx";
reg = <0x55>; reg = <0x55>;
design-voltage = <3700>; //Battery Design Volatge in mV design-voltage = <3700>; //Battery Design Voltage in mV
design-capacity = <180>; //Battery Design Capacity in mAh design-capacity = <180>; //Battery Design Capacity in mAh
taper-current = <2>; //Battery Taper current in mAh taper-current = <2>; //Battery Taper current in mAh
terminate-voltage = <2750>; //Battery Terminate Voltage in mV terminate-voltage = <2750>; //Battery Terminate Voltage in mV

2
app/boards/arm/corneish_zen/corneish_zen_v1_right.dts
View file

@ -96,7 +96,7 @@
fuelgauge: bq274xx@55 { fuelgauge: bq274xx@55 {
compatible = "ti,bq274xx"; compatible = "ti,bq274xx";
reg = <0x55>; reg = <0x55>;
design-voltage = <3700>; //Battery Design Volatge in mV design-voltage = <3700>; //Battery Design Voltage in mV
design-capacity = <180>; //Battery Design Capacity in mAh design-capacity = <180>; //Battery Design Capacity in mAh
taper-current = <2>; //Battery Taper current in mAh 2.1 taper-current = <2>; //Battery Taper current in mAh 2.1
terminate-voltage = <2750>; //Battery Terminate Voltage in mV terminate-voltage = <2750>; //Battery Terminate Voltage in mV

2
app/boards/interconnects/seeed_xiao/seeed_xiao.zmk.yml
View file

@ -5,7 +5,7 @@ type: interconnect
url: https://wiki.seeedstudio.com/Seeeduino-XIAO/ url: https://wiki.seeedstudio.com/Seeeduino-XIAO/
manufacturer: Seeed manufacturer: Seeed
description: | description: |
The Seeed(uino) XIAO is a popular smaller format micro-controller, that has gained popularity as an alterative The Seeed(uino) XIAO is a popular smaller format micro-controller, that has gained popularity as an alternative
to the SparkFun Pro Micro. Since its creation, several pin compatible controllers, such to the SparkFun Pro Micro. Since its creation, several pin compatible controllers, such
as the Seeeduino XIAO BLE, Adafruit QT Py and Adafruit QT Py RP2040, have become available. as the Seeeduino XIAO BLE, Adafruit QT Py and Adafruit QT Py RP2040, have become available.
node_labels: node_labels:

2
app/dts/common/arduino_uno_pro_micro_map.dtsi
View file

@ -4,7 +4,7 @@
* SPDX-License-Identifier: MIT * SPDX-License-Identifier: MIT
*/ */
/* This provies a mapping from Arduino Uno to Arduino Pro Micro pins for development */ /* This provides a mapping from Arduino Uno to Arduino Pro Micro pins for development */
/ { / {
pro_micro_d: connector_d { pro_micro_d: connector_d {

6
app/include/zmk/display.h
View file

@ -23,12 +23,12 @@ int zmk_display_init(void);
* *
* @param listener THe ZMK Event manager listener name. * @param listener THe ZMK Event manager listener name.
* @param state_type The struct/enum type used to store/transfer state. * @param state_type The struct/enum type used to store/transfer state.
* @param cb The callback to invoke in the dispaly queue context to update the UI. Should be `void * @param cb The callback to invoke in the display queue context to update the UI. Should be `void
* func(state_type)` signature. * func(state_type)` signature.
* @param state_func The callback function to invoke to fetch the updated state from ZMK core. * @param state_func The callback function to invoke to fetch the updated state from ZMK core.
* Should be `state type func(const zmk_event_t *eh)` signature. * Should be `state type func(const zmk_event_t *eh)` signature.
* @retval listner##_init Generates a function `listener##_init` that should be called by the widget * @retval listener##_init Generates a function `listener##_init` that should be called by the
* once ready to be updated. * widget once ready to be updated.
**/ **/
#define ZMK_DISPLAY_WIDGET_LISTENER(listener, state_type, cb, state_func) \ #define ZMK_DISPLAY_WIDGET_LISTENER(listener, state_type, cb, state_func) \
K_MUTEX_DEFINE(listener##_mutex); \ K_MUTEX_DEFINE(listener##_mutex); \

2
app/src/behaviors/behavior_hold_tap.c
View file

@ -181,7 +181,7 @@ static void release_captured_events() {
// //
// Events for different mod-tap instances are separated by a NULL pointer. // Events for different mod-tap instances are separated by a NULL pointer.
// //
// The first event popped will never be catched by the next active hold-tap // The first event popped will never be caught by the next active hold-tap
// because to start capturing a mod-tap-key-down event must first completely // because to start capturing a mod-tap-key-down event must first completely
// go through the events queue. // go through the events queue.
// //

2
app/src/combo.c
View file

@ -162,7 +162,7 @@ static int setup_candidates_for_first_keypress(int32_t position, int64_t timesta
static int filter_candidates(int32_t position) { static int filter_candidates(int32_t position) {
// this code iterates over candidates and the lookup together to filter in O(n) // this code iterates over candidates and the lookup together to filter in O(n)
// assuming they are both sorted on key_position_len, virtal_key_position // assuming they are both sorted on key_position_len, virtual_key_position
int matches = 0, lookup_idx = 0, candidate_idx = 0; int matches = 0, lookup_idx = 0, candidate_idx = 0;
while (lookup_idx < CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY && while (lookup_idx < CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY &&
candidate_idx < CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY) { candidate_idx < CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY) {

2
app/src/split/Kconfig
View file

@ -24,7 +24,7 @@ config ZMK_SPLIT_PERIPHERAL_HID_INDICATORS
bool "Peripheral HID Indicators" bool "Peripheral HID Indicators"
depends on ZMK_HID_INDICATORS depends on ZMK_HID_INDICATORS
help help
Enable propogating the HID (LED) Indicator state to the split peripheral(s). Enable propagating the HID (LED) Indicator state to the split peripheral(s).
#ZMK_SPLIT #ZMK_SPLIT
endif endif

2
app/src/split/bluetooth/central.c
View file

@ -585,7 +585,7 @@ static bool split_central_eir_found(const bt_addr_le_t *addr) {
return false; return false;
} }
LOG_DBG("Initiating new connnection"); LOG_DBG("Initiating new connection");
struct bt_le_conn_param *param = struct bt_le_conn_param *param =
BT_LE_CONN_PARAM(CONFIG_ZMK_SPLIT_BLE_PREF_INT, CONFIG_ZMK_SPLIT_BLE_PREF_INT, BT_LE_CONN_PARAM(CONFIG_ZMK_SPLIT_BLE_PREF_INT, CONFIG_ZMK_SPLIT_BLE_PREF_INT,
CONFIG_ZMK_SPLIT_BLE_PREF_LATENCY, CONFIG_ZMK_SPLIT_BLE_PREF_TIMEOUT); CONFIG_ZMK_SPLIT_BLE_PREF_LATENCY, CONFIG_ZMK_SPLIT_BLE_PREF_TIMEOUT);

2
app/tests/mod-morph/2b-masked-morph-implicit-overwrite/native_posix_64.keymap
View file

@ -7,7 +7,7 @@
mod_morph: mod_morph { mod_morph: mod_morph {
compatible = "zmk,behavior-mod-morph"; compatible = "zmk,behavior-mod-morph";
#binding-cells = <0>; #binding-cells = <0>;
bindings = <&kp A>, <&kp LS(B)>; // implict mod overwrite bindings = <&kp A>, <&kp LS(B)>; // implicit mod overwrite
mods = <(MOD_LSFT|MOD_RSFT)>; mods = <(MOD_LSFT|MOD_RSFT)>;
}; };
}; };

2
docs/blog/2024-01-05-zmk-tools.md
View file

@ -145,7 +145,7 @@ I should note that, as a native English speaker and typer, I don't use any of th
## Keyboard Latency Testing ## Keyboard Latency Testing
The last project I want to mention is a tool for testing keyboard latency. It requires only a Rasbperry Pi, an optocoupler IC, a resistor, and some wire. If you've ever wondered how ZMK's latency compares to other keyboards, you can [check the results here](https://github.com/joelspadin/keyboard-latency-tester/blob/main/results/chart.ipynb)! The last project I want to mention is a tool for testing keyboard latency. It requires only a Raspberry Pi, an optocoupler IC, a resistor, and some wire. If you've ever wondered how ZMK's latency compares to other keyboards, you can [check the results here](https://github.com/joelspadin/keyboard-latency-tester/blob/main/results/chart.ipynb)!
I don't have a very large collection of keyboards though, so the data is pretty limited so far. If you want to try it on your own keyboard, see the instructions on the [keyboard latency tester README](https://github.com/joelspadin/keyboard-latency-tester), and please send me a PR with your results! I don't have a very large collection of keyboards though, so the data is pretty limited so far. If you want to try it on your own keyboard, see the instructions on the [keyboard latency tester README](https://github.com/joelspadin/keyboard-latency-tester), and please send me a PR with your results!

2
docs/docs/config/battery.md
View file

@ -18,7 +18,7 @@ Definition file: [zmk/app/Kconfig](https://github.com/zmkfirmware/zmk/blob/main/
:::note[Default setting] :::note[Default setting]
While `CONFIG_ZMK_BATTERY_REPORTING` is disabled by default it is implied by `CONFIG_ZMK_BLE`, thus any board with BLE enabled will have this automatically enabled unless explicitly overriden. While `CONFIG_ZMK_BATTERY_REPORTING` is disabled by default it is implied by `CONFIG_ZMK_BLE`, thus any board with BLE enabled will have this automatically enabled unless explicitly overridden.
::: :::

4
docs/docs/config/bluetooth.md
View file

@ -10,8 +10,8 @@ See [Configuration Overview](index.md) for instructions on how to change these s
## Kconfig ## Kconfig
| Option | Type | Description | Default | | Option | Type | Description | Default |
| -------------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | -------------------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| `CONFIG_ZMK_BLE_EXPERIMENTAL_CONN` | bool | Enables a combination of settings that are planned to be default in future versions of ZMK to improve connection stability. This includes changes to timing on BLE pairing initation, restores use of the updated/new LLCP implementation, and disables 2M PHY support. | n | | `CONFIG_ZMK_BLE_EXPERIMENTAL_CONN` | bool | Enables a combination of settings that are planned to be default in future versions of ZMK to improve connection stability. This includes changes to timing on BLE pairing initiation, restores use of the updated/new LLCP implementation, and disables 2M PHY support. | n |
| `CONFIG_ZMK_BLE_EXPERIMENTAL_SEC` | bool | Enables a combination of settings that are planned to be officially supported in the future. This includes enabling BT Secure Connection passkey entry, and allows overwrite of keys from previously paired hosts. | n | | `CONFIG_ZMK_BLE_EXPERIMENTAL_SEC` | bool | Enables a combination of settings that are planned to be officially supported in the future. This includes enabling BT Secure Connection passkey entry, and allows overwrite of keys from previously paired hosts. | n |
| `CONFIG_ZMK_BLE_EXPERIMENTAL_FEATURES` | bool | Aggregate config that enables both `CONFIG_ZMK_BLE_EXPERIMENTAL_CONN` and `CONFIG_ZMK_BLE_EXPERIMENTAL_SEC`. | n | | `CONFIG_ZMK_BLE_EXPERIMENTAL_FEATURES` | bool | Aggregate config that enables both `CONFIG_ZMK_BLE_EXPERIMENTAL_CONN` and `CONFIG_ZMK_BLE_EXPERIMENTAL_SEC`. | n |
| `CONFIG_ZMK_BLE_PASSKEY_ENTRY` | bool | Enable passkey entry during pairing for enhanced security. (Note: After enabling this, you will need to re-pair all previously paired hosts.) | n | | `CONFIG_ZMK_BLE_PASSKEY_ENTRY` | bool | Enable passkey entry during pairing for enhanced security. (Note: After enabling this, you will need to re-pair all previously paired hosts.) | n |

2
docs/docs/config/system.md
View file

@ -31,7 +31,7 @@ Making changes to any of the settings in this section modifies the HID report de
| Config | Type | Description | Default | | Config | Type | Description | Default |
| ------------------------------------- | ---- | -------------------------------------------------------------- | ------- | | ------------------------------------- | ---- | -------------------------------------------------------------- | ------- |
| `CONFIG_ZMK_HID_INDICATORS` | bool | Enable reciept of HID/LED indicator state from connected hosts | n | | `CONFIG_ZMK_HID_INDICATORS` | bool | Enable receipt of HID/LED indicator state from connected hosts | n |
| `CONFIG_ZMK_HID_CONSUMER_REPORT_SIZE` | int | Number of consumer keys simultaneously reportable | 6 | | `CONFIG_ZMK_HID_CONSUMER_REPORT_SIZE` | int | Number of consumer keys simultaneously reportable | 6 |
Exactly zero or one of the following options may be set to `y`. The first is used if none are set. Exactly zero or one of the following options may be set to `y`. The first is used if none are set.

2
docs/src/templates/setup.ps1.mustache
View file

@ -308,6 +308,6 @@ if ($github_repo -ne "") {
if ($github_repo -imatch "https") { if ($github_repo -imatch "https") {
$actions = "$($github_repo.substring(0, $github_repo.length - 4))/actions" $actions = "$($github_repo.substring(0, $github_repo.length - 4))/actions"
Write-Host "Your firmware should be availalbe from GitHub Actions shortly: $actions" Write-Host "Your firmware should be available from GitHub Actions shortly: $actions"
} }
} }

2
docs/src/templates/setup.sh.mustache
View file

@ -297,7 +297,7 @@ if [ -n "$github_repo" ]; then
exit 1 exit 1
fi fi
# TODO: Support determing the actions URL when non-https:// repo URL is used. # TODO: Support determining the actions URL when non-https:// repo URL is used.
if [ "${github_repo}" != "${github_repo#https://}" ]; then if [ "${github_repo}" != "${github_repo#https://}" ]; then
echo "Your firmware should be available from GitHub Actions shortly: ${github_repo%.git}/actions" echo "Your firmware should be available from GitHub Actions shortly: ${github_repo%.git}/actions"
fi fi