summaryrefslogtreecommitdiffstats
path: root/docs/feature_audio.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-07-12 19:11:07 +0200
committerJack Humbert <jack.humb@gmail.com>2018-07-15 19:40:18 +0200
commit8ffeaec3aaa8b26a8d4512eab2a04b789d717044 (patch)
treeb3ba888a0b48f5de3f0106ee456b3b08b63e0c42 /docs/feature_audio.md
parentbbea9dadbcc92c4005188860a44c7b9e2479be2e (diff)
downloadqmk_firmware-8ffeaec3aaa8b26a8d4512eab2a04b789d717044.tar.gz
qmk_firmware-8ffeaec3aaa8b26a8d4512eab2a04b789d717044.tar.xz
Overhaul to keycode related docs
* Adds Audio Keycodes to both the feature page and master list * Re-orders the keycode list, so it's alphabetical (mostly) * Add additional (missing) sections to the keycode list * Add and update links in the keycode page * Add and reorder links in sidebar's keycode section
Diffstat (limited to 'docs/feature_audio.md')
-rw-r--r--docs/feature_audio.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index 50e389605..039c62cdf 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -3,6 +3,7 @@
Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any AVR keyboard that allows access to certain PWM-capable pins, you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
Up to two simultaneous audio voices are supported, one driven by timer 1 and another driven by timer 3. The following pins can be defined as audio outputs in config.h:
+
Timer 1:
`#define B5_AUDIO`
`#define B6_AUDIO`
@@ -58,6 +59,13 @@ PLAY_LOOP(my_song);
It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif` to avoid causing problems when audio isn't built into the keyboard.
+The available keycodes for audio are:
+
+* `AU_ON` - Turn audio mode on
+* `AU_OFF` - Turn audio mode off
+* `AU_TOG` - Toggle audio mode
+
+
## Music Mode
The music mode maps your columns to a chromatic scale, and your rows to octaves. This works best with ortholinear keyboards, but can be made to work with others. All keycodes less than `0xFF` get blocked, so you won't type while playing notes - if you have special keys/mods, those will still work. A work-around for this is to jump to a different layer with KC_NOs before (or after) enabling music mode.
@@ -145,6 +153,23 @@ You can configure the default, min and max frequencies, the stepping and built i
This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
+
+## Audio Keycodes
+
+|Key |Aliases |Description |
+|----------------|---------|----------------------------------|
+|`AU_ON` | |Audio mode on |
+|`AU_OFF` | |Audio mode off |
+|`AU_TOG` | |Toggles Audio mode |
+|`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode |
+|`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks |
+|`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks |
+|`CLICKY_RESET` |`CK_RST` |Resets frequency to default |
+|`MU_ON` | |Turns on Music Mode |
+|`MU_OFF` | |Turns off Music Mode |
+|`MU_TOG` | |Toggles Music Mode |
+|`MU_MOD` | |Cycles through the music modes |
+
<!-- FIXME: this formatting needs work
## Audio