summaryrefslogtreecommitdiffstats
path: root/keyboards/scarletbandana/readme.md
diff options
context:
space:
mode:
authorCole Markham <github@themarkhams.us>2019-02-05 23:56:17 +0100
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-02-05 23:56:17 +0100
commit0affcc8bc3fbe6ed1f5ef6791a41b459421f0ed8 (patch)
tree3718b15a37f983d61ac19414f16d1f13b89c9ac1 /keyboards/scarletbandana/readme.md
parent5c7a31eae2518b2630f31cf825ecbb08e358ae76 (diff)
downloadqmk_firmware-0affcc8bc3fbe6ed1f5ef6791a41b459421f0ed8.tar.gz
qmk_firmware-0affcc8bc3fbe6ed1f5ef6791a41b459421f0ed8.tar.xz
Add Scarlet Bandana Version IV mark.2 (#3397)
* Add scarlet bandana * updates for scarlet bandana
Diffstat (limited to 'keyboards/scarletbandana/readme.md')
-rw-r--r--keyboards/scarletbandana/readme.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/scarletbandana/readme.md b/keyboards/scarletbandana/readme.md
new file mode 100644
index 000000000..6d5d9b553
--- /dev/null
+++ b/keyboards/scarletbandana/readme.md
@@ -0,0 +1,31 @@
+# Meira
+
+![Miera](https://imgur.com/kF4MFlW)
+
+A 4x12 ortholinear low-profile keyboard.
+
+Keyboard Maintainer: [Cole Markham](https://github.com/colemarkham)
+Hardware Supported: Meira/ProMicro, Meira/FeatherBLE
+Hardware Availability: [WoodKeys.click](https://woodkeys.click/meira)
+
+Two controllers are support: the Pro Micro, and the Adafruit Feather BLE 32u4. Support for each is defined as a hardware revision subfolder in QMK. Main differences include processor frequencies and matrix pinouts.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make meira/promicro:default
+
+or
+
+ make meira/featherble:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information on generic QMK configuration and setup.
+
+Both the Pro Micro and the Feather BLE use the Catalina bootloader, which is typically programmed using avrdude.
+
+## Matrix
+
+In order to have enough pins for the matrix and other functions, a custom matrix is implemented using a demultiplexer to scan the columns. Since the demux is active low, the diodes must be oriented with the cathode connected to the demux pin. When looking at the bottom of the board with the controller at the top right, the cathode mark on the diode should be toward the left.
+
+## LED Controller
+
+The in-switch LEDs are driven by an ISSI LED controller (IS31FL3731). The micro controller communicates with this chip using I2C. Individual LED control is possible, but currently only general backlighting support is implemented. This functionality is located in lighting.c, issi.c, and TWILib.c. \ No newline at end of file