summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoel Spadin <joelspadin@gmail.com>2020-10-27 13:49:28 -0500
committerJoel Spadin <joelspadin@gmail.com>2020-10-28 18:15:05 -0500
commit2fe1fbb526d9190e478999f36adbcfcf4a8847b2 (patch)
tree1d6dbc3ed34a14f427e39d580e27c5064ca1bfb2 /docs
parent600bba25f049b1fa161b2372b2a47762164c7fcd (diff)
feat(endpoints): rename behavior to outputs
"Outputs" is probably easier for most people to understand than "endpoints".
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/behavior/endpoints.md59
-rw-r--r--docs/docs/behavior/outputs.md59
-rw-r--r--docs/sidebars.js2
3 files changed, 60 insertions, 60 deletions
diff --git a/docs/docs/behavior/endpoints.md b/docs/docs/behavior/endpoints.md
deleted file mode 100644
index caedf3a..0000000
--- a/docs/docs/behavior/endpoints.md
+++ /dev/null
@@ -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
- ```
diff --git a/docs/docs/behavior/outputs.md b/docs/docs/behavior/outputs.md
new file mode 100644
index 0000000..50afac9
--- /dev/null
+++ b/docs/docs/behavior/outputs.md
@@ -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
+ ```
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 334a35d..c8dc79f 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -22,7 +22,7 @@ module.exports = {
"behavior/mod-tap",
"behavior/reset",
"behavior/bluetooth",
- "behavior/endpoints",
+ "behavior/outputs",
"behavior/lighting",
"behavior/power",
],