fix(docs): Standardize all internal links
This commit is contained in:
Nick Winans
Pete Johanson
parent
689ba2d171
commit
d964faaa89
|
|
@ -84,5 +84,5 @@ ZMK support bluetooth “profiles” which allows connection to multiple devices
|
|||
The bluetooth MAC address and negotiated keys during pairing are stored in the permanent storage on your chip and can be reused even after reflashing the firmware. If for some reason you want to delete the stored information, you can bind the `BT_CLR` behavior described above to a key and use it to clear the _current_ profile.
|
||||
|
||||
:::note
|
||||
If you clear bond of a paired profile, make sure you do the same thing on the peer device as well (typically achieved by _removing_ or _forgetting_ the bluetooth connection). Otherwise the peer will try to connect to your keyboard whenever it discovers it. But while the MAC address of both devices could remain the same, the security key no longer match: the peer device still possess the old key negotiated in the previous pairing procedure, but our keyboard firmware has deleted that key. So the connection will fail. If you [enabled USB logging](../development/usb-logging), you might see a lot of failed connection attempts due to the reason of “Security failed”.
|
||||
If you clear bond of a paired profile, make sure you do the same thing on the peer device as well (typically achieved by _removing_ or _forgetting_ the bluetooth connection). Otherwise the peer will try to connect to your keyboard whenever it discovers it. But while the MAC address of both devices could remain the same, the security key no longer match: the peer device still possess the old key negotiated in the previous pairing procedure, but our keyboard firmware has deleted that key. So the connection will fail. If you [enabled USB logging](../development/usb-logging.md), you might see a lot of failed connection attempts due to the reason of “Security failed”.
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ When the hold-tap key is released and the hold behavior has not been triggered,
|
|||
|
||||
### Basic usage
|
||||
|
||||
For basic usage, please see [mod-tap](./mod-tap.md) and [layer-tap](./layers.md) pages.
|
||||
For basic usage, please see [mod-tap](mod-tap.md) and [layer-tap](layers.md) pages.
|
||||
|
||||
### Advanced Configuration
|
||||
|
||||
|
|
|
|||
|
|
@ -10,14 +10,14 @@ a certain key.
|
|||
|
||||
The categories of supported codes are:
|
||||
|
||||
- [Keyboard & Keypad](../codes/keyboard-keypad)
|
||||
- [Editing](../codes/editing)
|
||||
- [Media](../codes/media)
|
||||
- [Applications](../codes/applications)
|
||||
- [Input Assist](../codes/input-assist)
|
||||
- [Power](../codes/power)
|
||||
- [Keyboard & Keypad](../codes/keyboard-keypad.mdx)
|
||||
- [Editing](../codes/editing.mdx)
|
||||
- [Media](../codes/media.mdx)
|
||||
- [Applications](../codes/applications.mdx)
|
||||
- [Input Assist](../codes/input-assist.mdx)
|
||||
- [Power](../codes/power.mdx)
|
||||
|
||||
Please visit the [codes](../codes) section for a comprehensive list.
|
||||
Please visit the [codes](../codes/index.mdx) section for a comprehensive list.
|
||||
|
||||
For advanced users, user-defined HID usages are also supported but must be encoded, please see [`dt-bindings/zmk/keys.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/keys.h) for further insight.
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ Doing so makes a set of defines such as `A`, `N1`, etc. available for use with t
|
|||
### Improperly defined keymap - `dtlib.DTError: <board>.dts.pre.tmp:<line number>`
|
||||
|
||||
When compiling firmware from a keymap, it may be common to encounter an error in the form of a`dtlib.DTError: <board>.dts.pre.tmp:<line number>`.
|
||||
For instructions to resolve such an error, click [here](../troubleshooting###Improperly-defined-keymap)
|
||||
For instructions to resolve such an error, click [here](../troubleshooting.md###Improperly-defined-keymap)
|
||||
|
||||
## Key Press
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ Example:
|
|||
|
||||
## Layer-tap
|
||||
|
||||
The "layer-tap" behavior enables a layer when a key is held, and output another key when the key is only tapped for a short time. For more information on the inner workings of layer-tap, see [hold-tap](./hold-tap.md).
|
||||
The "layer-tap" behavior enables a layer when a key is held, and output another key when the key is only tapped for a short time. For more information on the inner workings of layer-tap, see [hold-tap](hold-tap.md).
|
||||
|
||||
### Behavior Binding
|
||||
|
||||
|
|
|
|||
|
|
@ -46,4 +46,4 @@ You can configure a different tapping term in your keymap:
|
|||
|
||||
### Additional information
|
||||
|
||||
The mod-tap is a [hold-tap](./hold-tap.md) under the hood with the "balanced" flavor and tapping-term-ms 200.
|
||||
The mod-tap is a [hold-tap](hold-tap.md) under the hood with the "balanced" flavor and tapping-term-ms 200.
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import Table from "@site/src/components/codes/Table";
|
|||
|
||||
### Modifiers
|
||||
|
||||
The [Modifiers](./modifiers) page includes further information.
|
||||
The [Modifiers](modifiers.mdx) page includes further information.
|
||||
|
||||
<Table group="keyboard-modifiers" />
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ sidebar_label: Customizing ZMK
|
|||
---
|
||||
|
||||
After verifying you can successfully flash the default firmware, you will probably want to begin customizing your keymap and other keyboard options.
|
||||
[In the initial setup tutorial](user-setup), you created a Github repository called `zmk-config`. This repository is a discrete filesystem which works
|
||||
[In the initial setup tutorial](user-setup.md), you created a Github repository called `zmk-config`. This repository is a discrete filesystem which works
|
||||
with the main `zmk` firmware repository to build your desired firmware. The main advantage of a discrete configuration folder is ensuring that the
|
||||
working components of ZMK are kept separate from your personal keyboard settings, reducing the amount of file manipulation in the configuration process.
|
||||
This makes flashing ZMK to your keyboard much easier, especially because you don't need to keep an up-to-date copy of zmk on your computer at all times.
|
||||
|
|
@ -26,7 +26,7 @@ various config settings that can be commented/uncommented to modify how your fir
|
|||
## Keymap
|
||||
|
||||
Once you have the basic user config completed, you can find the keymap file in `config/<shield>.keymap` and customize from there.
|
||||
Refer to the [Keymap](/docs/features/keymaps) documentation to learn more.
|
||||
Refer to the [Keymap](features/keymaps.md) documentation to learn more.
|
||||
|
||||
## Publishing
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ If you need to, a review of [Learn The Basics Of Git In Under 10 Minutes](https:
|
|||
|
||||
## Building from a local `zmk` fork using `zmk-config`
|
||||
|
||||
[As outlined here](development/build-flash), firmware comes in the form of .uf2 files, which can be built locally using the command `west build`. Normally,
|
||||
[As outlined here](development/build-flash.md), firmware comes in the form of .uf2 files, which can be built locally using the command `west build`. Normally,
|
||||
`west build` will default to using the in-tree .keymap and .conf files found in your local copy of the `zmk` repository. However, you can append the command, `-DZMK_CONFIG="C:/the/absolute/path/config"` to `west build` in order to use the contents of your `zmk-config` folder instead of the
|
||||
default keyboard settings.
|
||||
**Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.**
|
||||
|
|
@ -55,4 +55,4 @@ west build -b nice_nano -- -DSHIELD=kyria_left -DZMK_CONFIG="C:/Users/myUser/Doc
|
|||
For normal keyboards, follow the same flashing instructions as before to flash your updated firmware.
|
||||
|
||||
For split keyboards, only the central (left) side will need to be reflashed if you are just updating your keymap.
|
||||
More troubleshooting information for split keyboards can be found [here](troubleshooting#split-keyboard-halves-unable-to-pair).
|
||||
More troubleshooting information for split keyboards can be found [here](troubleshooting.md#split-keyboard-halves-unable-to-pair).
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ The foundational elements needed to get a specific keyboard working with ZMK can
|
|||
- A keymap, which binds each key position to a behavior, e.g. key press, mod-tap, momentary layer, in a set of layers.
|
||||
|
||||
These three core architectural elements are defined per-keyboard, and _where_ they are defined depends on the specifics of how that
|
||||
keyboard works. For an overview on the general concepts of boards and shields, please see the [FAQs on boards and shields](/docs/faq#why-boards-and-shields--why-not-just-keyboard).
|
||||
keyboard works. For an overview on the general concepts of boards and shields, please see the [FAQs on boards and shields](../faq.md#why-boards-and-shields--why-not-just-keyboard).
|
||||
|
||||
## Self-Contained Keyboard
|
||||
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ This produces `left` and `right` subfolders under the `build` directory and two
|
|||
|
||||
### Building from `zmk-config` Folder
|
||||
|
||||
Instead of building .uf2 files using the default keymap and config files, you can build directly from your [`zmk-config` folder](../user-setup#github-repo) by adding
|
||||
Instead of building .uf2 files using the default keymap and config files, you can build directly from your [`zmk-config` folder](../user-setup.md#github-repo) by adding
|
||||
`-DZMK_CONFIG="C:/the/absolute/path/config"` to your `west build` command. **Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.**
|
||||
|
||||
For instance, building kyria firmware from a user `myUser`'s `zmk-config` folder on Windows 10 may look something like this:
|
||||
|
|
@ -107,7 +107,7 @@ volume automatically -- we need to delete the default volume before binding it t
|
|||
1. Remove all the containers that are not running via the command `docker container prune`. We need to remove the ZMK container before we can delete the default `zmk-config` volume referenced by it. If you do not want to delete all the containers that are not running, you can find the id of the ZMK container and use `docker rm` to delete that one only.
|
||||
1. Remove the default volume via the command `docker volume rm zmk-config`.
|
||||
|
||||
Then you can bind the `zmk-config` volume to the correct path pointing to your local [zmk-config](./customization.md) folder:
|
||||
Then you can bind the `zmk-config` volume to the correct path pointing to your local [zmk-config](customization.md) folder:
|
||||
|
||||
```
|
||||
docker volume create --driver local -o o=bind -o type=none -o \
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ terminal to the ZMK repository and run the following command:
|
|||
west config build.cmake-args -- -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
|
||||
```
|
||||
|
||||
Every [build](build-flash#building) will now update the database. You will
|
||||
Every [build](build-flash.md#building) will now update the database. You will
|
||||
need to build once to create the database before code completion will work.
|
||||
We'll tell Visual Studio Code where to find the database in the next step.
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ ZMK support for split keyboards requires a few more files than single boards to
|
|||
:::note
|
||||
This guide describes how to add shield to the ZMK main repository. If you are building firmware for your
|
||||
own prototype or handwired keyboard, it is recommended to use your own user config repository. Follow the
|
||||
[user setup guide](./user-setup.md) to create your user config repository first. When following the rest
|
||||
[user setup guide](user-setup.md) to create your user config repository first. When following the rest
|
||||
of this guide, replace the `app/` directory in the ZMK main repository with the `config/` directory in your
|
||||
user config repository. For example, `app/boards/shields/<keyboard_name>` should now be
|
||||
`config/boards/shields/<keyboard_name>`.
|
||||
|
|
@ -449,7 +449,7 @@ Add the following line to your keymap file to add default encoder behavior bindi
|
|||
sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>;
|
||||
```
|
||||
|
||||
Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](/docs/features/encoders) and [Keymap](/docs/features/keymaps) feature documentation for more details.
|
||||
Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](../features/encoders.md) and [Keymap](../features/keymaps.md) feature documentation for more details.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
|
@ -477,11 +477,11 @@ west flash
|
|||
```
|
||||
|
||||
Please have a look at documentation specific to
|
||||
[building and flashing](build-flash) for additional information.
|
||||
[building and flashing](build-flash.md) for additional information.
|
||||
|
||||
:::note
|
||||
Further testing your keyboard shield without altering the root keymap file can be done with the use of `-DZMK_CONFIG` in your `west build` command,
|
||||
shown [here](build-flash#building-from-zmk-config-folder)
|
||||
shown [here](build-flash.md#building-from-zmk-config-folder)
|
||||
:::
|
||||
|
||||
## Updating `build.yml`
|
||||
|
|
|
|||
|
|
@ -456,7 +456,7 @@ This step pulls down quite a bit of tooling. Go grab a cup of coffee, it can tak
|
|||
:::info
|
||||
If you're using Docker, you're done with setup! You must restart the container at this point. The easiest way to do so is to close the VS Code window, verify that the container has stopped in Docker Dashboard, and reopen the container with VS Code.
|
||||
|
||||
Once your container is restarted, proceed to [Building and Flashing](./development/build-flash.md).
|
||||
Once your container is restarted, proceed to [Building and Flashing](development/build-flash.md).
|
||||
:::
|
||||
|
||||
#### Export Zephyr™ Core
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Tests
|
|||
sidebar_label: Tests
|
||||
---
|
||||
|
||||
Running tests requires [native posix support](posix-board). Any folder under `/app/tests`
|
||||
Running tests requires [native posix support](posix-board.md). Any folder under `/app/tests`
|
||||
containing `native_posix.keymap` will be selected when running `west test`.
|
||||
|
||||
Run a single test with `west test <testname>`, like `west test tests/toggle-layer/normal`.
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ The `CONFIG_ZMK_USB_LOGGING` KConfig value needs to be set, either by copy and p
|
|||
`west build -t menuconfig` and manually enabling the setting in that UI at `ZMK -> Advanced -> USB Logging`.
|
||||
|
||||
:::note
|
||||
If you are debugging your own keyboard in your [user config repository](./user-setup.md), use
|
||||
If you are debugging your own keyboard in your [user config repository](user-setup.md), use
|
||||
`config/boards/shields/<your_keyboard>/<your_keyboard>.conf` instead of `app/prj.conf`. In Github
|
||||
Actions, you can search the `Kconfig file` build log to verify the options above have been enabled
|
||||
for you successfully.
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Rotation is handled separately as a type of sensor. The behavior for this is set
|
|||
sensor-bindings = <BINDING CW_KEY CCW_KEY>;
|
||||
```
|
||||
|
||||
- `BINDING`, for now, has only one behavior available; `&inc_dec_kp` for key presses (see [Key Press](/docs/behaviors/key-press) for details on available keycodes).
|
||||
- `BINDING`, for now, has only one behavior available; `&inc_dec_kp` for key presses (see [Key Press](../behaviors/key-press.md) for details on available keycodes).
|
||||
- `CW_KEY` is the keycode activated by a clockwise turn.
|
||||
- `CCW_KEY` is the keycode activated by a counter-clockwise turn.
|
||||
|
||||
|
|
@ -45,4 +45,4 @@ Here, the left encoder is configured to control volume up and down while the rig
|
|||
|
||||
## Adding Encoder Support
|
||||
|
||||
See the [New Keyboard Shield](/docs/development/new-shield#encoders) documentation for how to add or modify additional encoders to your shield.
|
||||
See the [New Keyboard Shield](../development/new-shield.md#encoders) documentation for how to add or modify additional encoders to your shield.
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ For example, the simplest behavior in ZMK is the "key press" behavior, which res
|
|||
(a certain spot on the keyboard), and when that position is pressed, send a keycode to the host, and
|
||||
when the key position is released, updates the host to notify of the keycode being released.
|
||||
|
||||
For the full set of possible behaviors, start at the [Key Press](/docs/behaviors/key-press) behavior.
|
||||
For the full set of possible behaviors, start at the [Key Press](../behaviors/key-press.md) behavior.
|
||||
|
||||
## Layers
|
||||
|
||||
|
|
@ -131,7 +131,7 @@ Each layer should have:
|
|||
1. A `bindings` property this will be a list of behaviour bindings, one for each key position for the keyboard.
|
||||
1. (Optional) A `sensor-bindings` property that will be a list of behavior bindings for each sensor on the keyboard. (Currently, only encoders are supported as sensor hardware, but in the future devices like trackpoints would be supported the same way)
|
||||
|
||||
For the full set of possible behaviors, start at the [Key Press](/docs/behaviors/key-press) behavior.
|
||||
For the full set of possible behaviors, start at the [Key Press](../behaviors/key-press.md) behavior.
|
||||
|
||||
### Complete Example
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ have had their hardware details codified in boards/shields for ZMK.
|
|||
:::
|
||||
|
||||
With the solid technical foundation of Zephyr™ RTOS, ZMK can support a wide diversity of hardware targets.
|
||||
That being said, there are currently only a few specific [boards](/docs/faq#what-is-a-board)/[shields](/docs/faq#what-is-a-shield) that have been written and tested by the ZMK contributors.
|
||||
That being said, there are currently only a few specific [boards](faq.md#what-is-a-board)/[shields](faq.md#what-is-a-shield) that have been written and tested by the ZMK contributors.
|
||||
|
||||
## Boards
|
||||
|
||||
|
|
@ -53,4 +53,4 @@ Until detailed documentation is available, feel free to ask questions about how
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to add support for a new keyboard shield, head over to the [New Keyboard Shield](development/new-shield) documentation.
|
||||
If you'd like to add support for a new keyboard shield, head over to the [New Keyboard Shield](development/new-shield.md) documentation.
|
||||
|
|
|
|||
|
|
@ -14,32 +14,32 @@ ZMK is currently missing some features found in other popular firmware. This tab
|
|||
| Legend: | ✅ Supported | 🚧 Under Development | 💡 Planned |
|
||||
| :------ | :----------- | :------------------- | :--------- |
|
||||
|
||||
| **Feature** | ZMK | BlueMicro | QMK |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: |
|
||||
| Low Latency BLE Support | ✅ | ✅ | |
|
||||
| Multi-Device BLE Support | ✅ | | |
|
||||
| [USB Connectivity](behaviors/outputs) | ✅ | ✅ | ✅ |
|
||||
| User Configuration Repositories | ✅ | | |
|
||||
| Split Keyboard Support | ✅ | ✅ | ✅ |
|
||||
| [Keymaps and Layers](behaviors/layers) | ✅ | ✅ | ✅ |
|
||||
| [Hold-Tap](behaviors/hold-tap) (which includes [Mod-Tap](behaviors/mod-tap) and [Layer-Tap](behaviors/layers/#layer-tap)) | ✅ | ✅ | ✅ |
|
||||
| [Keyboard Codes](codes/#keyboard) | ✅ | ✅ | ✅ |
|
||||
| [Media](codes/#media-controls) & [Consumer](codes/#consumer-controls) Codes | ✅ | ✅ | ✅ |
|
||||
| [Encoders](features/encoders)[^1] | ✅ | ✅ | ✅ |
|
||||
| [Display Support](features/displays)[^2] | 🚧 | 🚧 | ✅ |
|
||||
| [RGB Underglow](features/underglow) | ✅ | ✅ | ✅ |
|
||||
| One Shot Keys | ✅ | ✅ | ✅ |
|
||||
| [Combo Keys](features/combos) | ✅ | | ✅ |
|
||||
| Macros | 🚧 | ✅ | ✅ |
|
||||
| Mouse Keys | 💡 | ✅ | ✅ |
|
||||
| Low Active Power Usage | ✅ | | |
|
||||
| Low Power Sleep States | ✅ | ✅ | |
|
||||
| [Low Power Mode (VCC Shutoff)](behaviors/power) | ✅ | ✅ | |
|
||||
| Battery Reporting | ✅ | ✅ | |
|
||||
| Shell over BLE | 💡 | | |
|
||||
| Realtime Keymap Updating | 💡 | | ✅ |
|
||||
| AVR/8 Bit | | | ✅ |
|
||||
| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | |
|
||||
| **Feature** | ZMK | BlueMicro | QMK |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------- | :-: | :-------: | :-: |
|
||||
| Low Latency BLE Support | ✅ | ✅ | |
|
||||
| Multi-Device BLE Support | ✅ | | |
|
||||
| [USB Connectivity](behaviors/outputs.md) | ✅ | ✅ | ✅ |
|
||||
| User Configuration Repositories | ✅ | | |
|
||||
| Split Keyboard Support | ✅ | ✅ | ✅ |
|
||||
| [Keymaps and Layers](behaviors/layers.md) | ✅ | ✅ | ✅ |
|
||||
| [Hold-Tap](behaviors/hold-tap.md) (which includes [Mod-Tap](behaviors/mod-tap.md) and [Layer-Tap](behaviors/layers.md/#layer-tap)) | ✅ | ✅ | ✅ |
|
||||
| [Keyboard Codes](codes/index.mdx#keyboard) | ✅ | ✅ | ✅ |
|
||||
| [Media](codes/index.mdx#media-controls) & [Consumer](codes/index.mdx#consumer-controls) Codes | ✅ | ✅ | ✅ |
|
||||
| [Encoders](features/encoders.md)[^1] | ✅ | ✅ | ✅ |
|
||||
| [Display Support](features/displays.md)[^2] | 🚧 | 🚧 | ✅ |
|
||||
| [RGB Underglow](features/underglow.md) | ✅ | ✅ | ✅ |
|
||||
| One Shot Keys | ✅ | ✅ | ✅ |
|
||||
| [Combo Keys](features/combos.md) | ✅ | | ✅ |
|
||||
| Macros | 🚧 | ✅ | ✅ |
|
||||
| Mouse Keys | 💡 | ✅ | ✅ |
|
||||
| Low Active Power Usage | ✅ | | |
|
||||
| Low Power Sleep States | ✅ | ✅ | |
|
||||
| [Low Power Mode (VCC Shutoff)](behaviors/power.md) | ✅ | ✅ | |
|
||||
| Battery Reporting | ✅ | ✅ | |
|
||||
| Shell over BLE | 💡 | | |
|
||||
| Realtime Keymap Updating | 💡 | | ✅ |
|
||||
| AVR/8 Bit | | | ✅ |
|
||||
| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | |
|
||||
|
||||
[^2]: Encoders are not currently supported on peripheral side splits.
|
||||
[^1]: OLEDs are currently proof of concept in ZMK.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Variations of the warnings shown below occur when flashing the `<firmware>.uf2`
|
|||
### CMake Error
|
||||
|
||||
An error along the lines of `CMake Error at (zmk directory)/zephyr/cmake/generic_toolchain.cmake:64 (include): include could not find load file:` during firmware compilation indicates that the Zephyr Environment Variables are not properly defined.
|
||||
For more information, click [here](../docs/development/setup#environment-variables).
|
||||
For more information, click [here](../docs/development/setup.md#environment-variables).
|
||||
|
||||
### dtlib.DTError
|
||||
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ Pick an MCU board:
|
|||
:::note
|
||||
If you are building firmware for a new keyboard shield that is not included in the built-in
|
||||
list of shields, you can choose any shield from the list that is similar to yours to generate the repository,
|
||||
and edit / add necessary files according to the [guide for adding new keyboard shield](./development/new-shield).
|
||||
and edit / add necessary files according to the [guide for adding new keyboard shield](development/new-shield.md).
|
||||
:::
|
||||
|
||||
When prompted, enter the number for the corresponding keyboard shield you would like to target:
|
||||
|
|
@ -195,7 +195,7 @@ storage device. Once the flash is complete, the controller should automatically
|
|||
|
||||
ZMK will automatically advertise itself as connectable if it is not currently connected to a device. You should be able to see your keyboard from the bluetooth scanning view of your laptop or phone / tablet. It is reported by some users that the connections with Android / iOS devices are generally smoother than with laptops, so if you have trouble connecting, you could try to connect from your phone or tablet first to eliminate any potential hardware issues.
|
||||
|
||||
ZMK support multiple BLE “profiles”, which allows you to connect to and switch among multiple devices. Please refer to the [Bluetooth behavior](behaviors/bluetooth) section for detailed explanations of how to use them.
|
||||
ZMK support multiple BLE “profiles”, which allows you to connect to and switch among multiple devices. Please refer to the [Bluetooth behavior](behaviors/bluetooth.md) section for detailed explanations of how to use them.
|
||||
|
||||
### Connecting Split Keyboard Halves
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue