Apple-1-HW/unified_retro_keyboard
1
0
Fork 0
mirror of https://github.com/osiweb/unified_retro_keyboard.git synced 2024-06-01 20:41:31 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
dfnr2 2019-12-12 20:24:04 -06:00 committed by GitHub
parent f2527e4d69
commit 4c0d3b1084
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
firmware/asdf/README.md
View File

@ -1,13 +1,11 @@
ASDF Keyboard scanning firmware ASDF Keyboard scanning firmware
-
The ASDF (Auto Scan by DF) firmware is a key matrix scanner that can detect and The ASDF (Auto Scan by DF) firmware is a key matrix scanner that can detect and
debounce keypress and release events on a key matrix and either send codes or debounce keypress and release events on a key matrix and either send codes or
perform actions on keypress or release. Keymaps are defined per application and perform actions on keypress or release. Keymaps are defined per application and
may, for example, generate ASCII codes, special keyscan codes, etc. The code is may, for example, generate ASCII codes, special keyscan codes, etc. The code is
modular and may be integrated into a larger system easily. modular and may be integrated into a larger system easily.
By default, the code supports any number of rows by 8 columns, which will give By default, the code supports any number of rows by 8 columns, which will give
the bestperformance on an 8-bit microcontroller. For more than 8 columns per the bestperformance on an 8-bit microcontroller. For more than 8 columns per
row, the row datatype would need to be changed to uint16_t to support 16 row, the row datatype would need to be changed to uint16_t to support 16
@ -21,7 +19,7 @@ boolean variables, and via the key maps. The key maps are organized in
row,column format, with separate keymaps shift, capslock, and control-key modes. row,column format, with separate keymaps shift, capslock, and control-key modes.
Features: Features:
--
* modifiers: A set of modifier keys may be specified. When only a few modifiers * modifiers: A set of modifier keys may be specified. When only a few modifiers
are used, this mechanism is a low-overhead alternative to a keymap overlay for are used, this mechanism is a low-overhead alternative to a keymap overlay for
keyboard states that only change the key value, such as SHIFT, CAPS LOCK, CONTROL, keyboard states that only change the key value, such as SHIFT, CAPS LOCK, CONTROL,
@ -76,7 +74,7 @@ Features:
functions. functions.
Compiling and configuration Compiling and configuration
--
The source files are in the ./src directory. The final build files go in the ./build directory. The source files are in the ./src directory. The final build files go in the ./build directory.
To build, enter the ./src directory. You should be able to build a binary and To build, enter the ./src directory. You should be able to build a binary and
@ -88,7 +86,7 @@ keys), and specify the character output buffer size (if you are implementing
macros, etc.) macros, etc.)
Porting Porting
--
This firmware was written in modular, portable C99, to be compiled with GCC This firmware was written in modular, portable C99, to be compiled with GCC
(avr-gcc for the Atmega). The hardware-sepecific files are in Arch/*.[ch]. To (avr-gcc for the Atmega). The hardware-sepecific files are in Arch/*.[ch]. To
adapt the Atmega port for additional hardware, enter the ./src/Arch directory, adapt the Atmega port for additional hardware, enter the ./src/Arch directory,