aboutsummaryrefslogtreecommitdiffstats
path: root/docs/feature_audio.md
diff options
context:
space:
mode:
authorGravatar Michael L. Walker <michael.l.walker@intel.com>2018-04-12 08:16:35 -0700
committerGravatar Jack Humbert <jack.humb@gmail.com>2018-04-12 13:14:48 -0400
commit22215a0e920a237faabdfa1b8826cd110ab20c3b (patch)
tree4681e0cb65cbc69f3bed16165de620dc6511d653 /docs/feature_audio.md
parent5319667c5504ab28b5bdb6f81ae22ecfec5e4a46 (diff)
downloadqmk_firmware-22215a0e920a237faabdfa1b8826cd110ab20c3b.tar.gz
Added support for audio using pins C4, C5, B6, B7
Diffstat (limited to 'docs/feature_audio.md')
-rw-r--r--docs/feature_audio.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index 5b11aa3ab..eaaa2fe51 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -1,6 +1,17 @@
# Audio
-Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any AVR keyboard that allows access to the C6 or B5 port (`#define C6_AUDIO` and/or `#define B5_AUDIO`), 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.
+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`
+`#define B7_AUDIO`
+
+Timer 3:
+`#define C4_AUDIO`
+`#define C5_AUDIO`
+`#define C6_AUDIO`
If you add `AUDIO_ENABLE = yes` to your `rules.mk`, there's a couple different sounds that will automatically be enabled without any other configuration: