di0ib
/
keybrd
Obserwuj 1
Gwiazdka 0
Forkuj 0
Kod Wydania 7 Aktywność
Przeglądaj źródła

document

tags/v0.5.0
wolfv6 8 lat temu
rodzic
b31ac841df
commit
14feaec364
2 zmienionych plików z 10 dodań i 10 usunięć
Zunifikowany widok Pokaż statystyki zmian
  1. 6
    6
      README.md
  2. 4
    4
      doc/keybrd_library_user_guide.md

+ 6
- 6
README.md Wyświetl plik

<!-- todo after teensy LC bb, copy and remove annotations from keybrd_single-layer_2_annotated.ino --> <!-- todo after teensy LC bb, copy and remove annotations from keybrd_single-layer_2_annotated.ino -->
A [minimal keybrd sketch](tutorials/keybrd_2_single-layer_annotated/keybrd_2_single-layer_annotated.ino). A [minimal keybrd sketch](tutorials/keybrd_2_single-layer_annotated/keybrd_2_single-layer_annotated.ino).
has about 50 lines of code and runs on a 4-key keyboard. has about 50 lines of code and runs on a 4-key keyboard.
It runs on a breadboard with rows, columns, and diodes just like the big keyboards.
It runs on a breadboard and has rows, columns, and diodes just like the big keyboards.
The sketch is small because the keybrd library takes care of the low-level details. The sketch is small because the keybrd library takes care of the low-level details.
The keybrd tutorial 1 shows how to make a breadboard keyboard. The keybrd tutorial 1 shows how to make a breadboard keyboard.
It has 72 keys, 4 layers, a sub-layer, 2 matrices, and many features. It has 72 keys, 4 layers, a sub-layer, 2 matrices, and many features.
The keybrd_DH and its instantiation files contain about 800 lines of code. The keybrd_DH and its instantiation files contain about 800 lines of code.
[mainSketch.ino](https://github.com/wolfv6/keybrd_DH/blob/master/examples/keybrd_DH/mainSketch.cpp)<br>
[instantiations_ports.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_ports.h)<br>
[instantiations_LEDs.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_LEDs.h)<br>
[instantiations_codes.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_codes.h)<br>
[instantiations_matrix.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_matrix.h)
[mainSketch.ino](https://github.com/wolfv6/keybrd_DH/blob/master/examples/keybrd_DH/mainSketch.cpp)<br>
[instantiations_ports.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_ports.h)<br>
[instantiations_LEDs.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_LEDs.h)<br>
[instantiations_codes.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_codes.h)<br>
[instantiations_matrix.h](https://github.com/wolfv6/keybrd_DH/blob/master/src/instantiations_matrix.h)
Support Support
------- -------

+ 4
- 4
doc/keybrd_library_user_guide.md Wyświetl plik

<--! todo update after testing Arduino library manager <--! todo update after testing Arduino library manager
link from tutorial 7 ## Publishing link from tutorial 7 ## Publishing
https://www.arduino.cc/en/Guide/Libraries https://www.arduino.cc/en/Guide/Libraries
> Installing Additional Arduino Libraries
> Using the Library Manager
* Installing Additional Arduino Libraries
* Using the Library Manager
--> -->
Down load keybrd-master.zip from the [Download ZIP](https://github.com/wolfv6/keybrd) button. Down load keybrd-master.zip from the [Download ZIP](https://github.com/wolfv6/keybrd) button.
The example sketch names use the following conventions. The example sketch names use the following conventions.
**keybrd_extension_feature_version.ino**
**keybrd_extension_feature_version.ino**
where where
* **keybrd_extension** is the extension library name e.g. keybrd_DH * **keybrd_extension** is the extension library name e.g. keybrd_DH
The physical martix rows and columns on a keyboard can be in any direction or shape. The physical martix rows and columns on a keyboard can be in any direction or shape.
[diode](https://en.wikipedia.org/wiki/Diode) orientation is specified in [Matrix.h](https://github.com/wolfv6/keybrd/blob/master/src/Matrix.h) [diode](https://en.wikipedia.org/wiki/Diode) orientation is specified in [Matrix.h](https://github.com/wolfv6/keybrd/blob/master/src/Matrix.h)
[Diode](../tutorials/images/120px-Diode_pinout_en_fr.svg.png)
[Diode](https://github.com/wolfv6/keybrd/blob/master/tutorials/images/120px-Diode_pinout_en_fr.svg.png)
Diagram is of typical through-the-hole diode in same alignment as diode symbol. Diagram is of typical through-the-hole diode in same alignment as diode symbol.
Cross bar and band depict the cathode. Cross bar and band depict the cathode.