Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

feat(endpoints): rename behavior to outputs

Browse Source 
"Outputs" is probably easier for most people to understand than "endpoints".
This commit is contained in:
Joel Spadin
2020-10-27 13:49:28 -05:00
parent 600bba25f0
commit 2fe1fbb526
11 changed files with 96 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/docs/behavior/endpoints.md
View File

@@ -1,59 +0,0 @@
---
title: Endpoint Behavior
sidebar_label: Endpoints
---
## Summary
The endpoint behavior allows selecting whether keyboard input is sent to the
USB or bluetooth connection when both are connected. This allows connecting a
keyboard to USB for power but sending input to a different device over bluetooth.
By default, keyboard input is sent to USB when both endpoints are connected.
Once you select a different endpoint, it will be remembered until you change it again.
## Endpoints Command Defines
Endpoints command defines are provided through the [`dt-bindings/zmk/endpoints.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/endpoints.h)
header, which is added at the top of the keymap file:
```
#include <dt-bindings/zmk/endpoints.h>
```
This allows you to reference the actions defined in this header:
| Define | Action | Alias |
| --------------------- | ---------------------------------------------------- | --------- |
| `ENDPOINT_USB_CMD` | Send keyboard input to USB | `END_USB` |
| `ENDPOINT_BLE_CMD` | Send keyboard input to the current bluetooth profile | `END_BLE` |
| `ENDPOINT_TOGGLE_CMD` | Toggle between USB and BLE | `END_TOG` |
## Endpoints Behavior
The endpoints behavior changes the preferred endpoint on press.
### Behavior Binding
- Reference: `&end`
- Parameter #1: Command, e.g. `END_BLE`
### Example:
1. Behavior binding to prefer sending keyboard input to USB
```
&end END_USB
```
1. Behavior binding to prefer sending keyboard input to the current bluetooth profile
```
&end END_BLE
```
1. Behavior binding to toggle between preferring USB and BLE
```
&end END_TOG
```

59
docs/docs/behavior/outputs.md Normal file
View File

@@ -0,0 +1,59 @@
---
title: Output Selection Behavior
sidebar_label: Output Selection
---
## Summary
The output behavior allows selecting whether keyboard output is sent to the
USB or bluetooth connection when both are connected. This allows connecting a
keyboard to USB for power but outputting to a different device over bluetooth.
By default, output is sent to USB when both USB and BLE are connected.
Once you select a different output, it will be remembered until you change it again.
## Output Command Defines
Output command defines are provided through the [`dt-bindings/zmk/outputs.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/outputs.h)
header, which is added at the top of the keymap file:
```
#include <dt-bindings/zmk/outputs.h>
```
This allows you to reference the actions defined in this header:
| Define | Action | Alias |
| ------------------- | ----------------------------------------------- | --------- |
| `OUTPUT_USB_CMD` | Prefer sending to USB | `OUT_USB` |
| `OUTPUT_BLE_CMD` | Prefer sending to the current bluetooth profile | `OUT_BLE` |
| `OUTPUT_TOGGLE_CMD` | Toggle between USB and BLE | `OUT_TOG` |
## Output Selection Behavior
The output selection behavior changes the preferred output on press.
### Behavior Binding
- Reference: `&out`
- Parameter #1: Command, e.g. `OUT_BLE`
### Example:
1. Behavior binding to prefer sending keyboard output to USB
```
&out OUT_USB
```
1. Behavior binding to prefer sending keyboard output to the current bluetooth profile
```
&out OUT_BLE
```
1. Behavior binding to toggle between preferring USB and BLE
```
&out OUT_TOG
```

2
docs/sidebars.js
View File

@@ -22,7 +22,7 @@ module.exports = {
"behavior/mod-tap",
"behavior/reset",
"behavior/bluetooth",
"behavior/endpoints",
"behavior/outputs",
"behavior/lighting",
"behavior/power",
],