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

feat(docs): Generate new shield interconnect docs.

Browse Source 
* Add to metadata schema for interconnects.
* New conventional location for pinout diagrams/pics.
* New component to generate the tabs for the new shield
  doc section on interconnects.
* Add XIAO and arduino uno pinout diagram.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Peter Johanson
2022-12-23 05:02:18 +00:00
committed by Pete Johanson
parent d993b03433
commit c23443a086
15 changed files with 149 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
app/boards/interconnects/arduino_uno/arduino_uno.zmk.yml
View File

@@ -13,3 +13,13 @@ description: |
Note: ZMK doesn't support boards with AVR 8-bit processors, such as the ATmega32U4, because Zephyr™ only
supports 32-bit and 64-bit platforms. As a result, boards like the original Arduino Uno Rev3 itself are
*not* supported by ZMK.
node_labels:
gpio: arduino_header
i2c: arduino_i2c
spi: arduino_spi
uart: arduino_serial
adc: arduino_adc
design_guideline: |
The GPIO pin references for the Uno format are a bit odd. The `&arduino_header` label is used, but the numbering
starts at the `A0` pin and increments as you go counter clockwise around the board. That means the `D6` pin
can be referenced by `&arduino_header 12` in your overlay files.

7
app/boards/interconnects/blackpill/blackpill.zmk.yml
View File

@@ -6,3 +6,10 @@ url: https://github.com/WeActStudio/WeActStudio.MiniSTM32F4x1
manufacturer: WeAct Studio
description: |
The WeAct Studio BlackPill has grown in popularity due to its low price, availability, and utilization of the powerful STM32F4x1CEU6 microcontroller. The BlackPill features more GPIO than most other boards, but also has a comparatively larger footprint as a result. Many clones and variations of the original BlackPill are available on the market as an affordable and more powerful alternative to many popular boards. The official WeAct variations of the WeAct Studio BlackPill are powered by the STM32F411CEU6 and STM32F401CEU6 microcontrollers.
node_labels:
gpio: blackpill
i2c: blackpill_i2c
spi: blackpill_spi
uart: blackpill_serial
design_guideline: |
ZMK uses the blue color coded pin names to generate devicetree node references. For example, to refer to the pin labeled `17` in the diagram, use `&blackpill 17` in the devicetree files.

7
app/boards/interconnects/pro_micro/pro_micro.zmk.yml
View File

@@ -12,3 +12,10 @@ description: |
Note: ZMK doesn't support boards with AVR 8-bit processors, such as the ATmega32U4, because Zephyr™ only
supports 32-bit and 64-bit platforms. As a result, controllers like the SparkFun Pro Micro and the Elite-C
are *not* supported by ZMK.
node_labels:
gpio: pro_micro
i2c: pro_micro_i2c
spi: pro_micro_spi
uart: pro_micro_serial
design_guideline: |
ZMK uses the blue color coded "Arduino" pin names to generate devicetree node references. For example, to refer to the pin labeled `0` in the diagram, use `&pro_micro 0` in the devicetree files.

7
app/boards/interconnects/seeed_xiao/seeed_xiao.zmk.yml
View File

@@ -8,3 +8,10 @@ description: |
The Seeed(uino) XIAO is a popular smaller format micro-controller, that has gained popularity as an alterative
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.
node_labels:
gpio: xiao_d
i2c: xiao_i2c
spi: xiao_spi
uart: xiao_serial
design_guideline: |
ZMK uses the "D"-prefixed, green color coded pin names, e.g. `D2`, to generate devicetree node references. For example, to refer to the pin labeled `D0` in the diagram, use `&xiao_d 0` in the devicetree files.