summaryrefslogtreecommitdiff
path: root/app/boards/arm/bdn9/README.md
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-12-30 15:44:03 -0500
committerPete Johanson <peter@peterjohanson.com>2020-12-31 14:46:15 -0500
commit39490552f2a84282143e0ec039fdaf4b2f309539 (patch)
treef60cd83ada9111ed110e15537434f74bcf0dee4a /app/boards/arm/bdn9/README.md
parent5072590af523cf25941e05945d490d350f148797 (diff)
feat(boards): Add BDN9 Rev2 board.
* Onboard stm32f072. * 3 possible encoder positions. * Underglow/per-key not yet support.
Diffstat (limited to 'app/boards/arm/bdn9/README.md')
-rw-r--r--app/boards/arm/bdn9/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/app/boards/arm/bdn9/README.md b/app/boards/arm/bdn9/README.md
new file mode 100644
index 0000000..7b4ef44
--- /dev/null
+++ b/app/boards/arm/bdn9/README.md
@@ -0,0 +1,37 @@
+# Building ZMK for the BDN9
+
+Some general notes/commands for building standard BDN9 layouts from the assembly documentation.
+
+## Standard Build
+
+```
+west build -p -d build/bdn9 --board bdn9_rev2
+```
+
+## Encoder Notes
+
+If you built your BDN9 with encoders, you'll need to change the following in your local BDN9 config or add them to the end of the file.
+
+```
+CONFIG_EC11=y
+CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y
+```
+
+Then, you'll want to uncomment the necessary encoder lines in your `bdn9_rev2.keymap`:
+
+```
+&sensors {
+ status = "okay";
+ sensors = <&left_encoder &mid_encoder &right_encoder>;
+};
+
+&left_encoder { status = "okay"; };
+&mid_encoder { status = "okay"; };
+&right_encoder { status = "okay"; };
+```
+
+And then add the correct `sensor-bindings` array to each keymap layer, e.g.:
+
+```
+sensor-bindings = <&inc_dec_kp PG_UP PG_DN &inc_dec_kp M_VOLU M_VOLD &inc_dec_kp C_PREV C_NEXT>;
+```