summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael L. Walker <michael.l.walker@intel.com>2018-04-12 08:16:35 -0700
committerJack Humbert <jack.humb@gmail.com>2018-04-12 13:14:48 -0400
commit22215a0e920a237faabdfa1b8826cd110ab20c3b (patch)
tree4681e0cb65cbc69f3bed16165de620dc6511d653 /docs
parent5319667c5504ab28b5bdb6f81ae22ecfec5e4a46 (diff)
Added support for audio using pins C4, C5, B6, B7
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md10
-rw-r--r--docs/feature_audio.md13
2 files changed, 21 insertions, 2 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index af8602c3ff..d45592f82f 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -61,10 +61,18 @@ This is a C header file that is one of the first things included, and will persi
* COL2ROW or ROW2COL - how your matrix is configured. COL2ROW means the black mark on your diode is facing to the rows, and between the switch and the rows.
* `#define AUDIO_VOICES`
* turns on the alternate audio voices (to cycle through)
+* `#define C4_AUDIO`
+ * enables audio on pin C4
+* `#define C5_AUDIO`
+ * enables audio on pin C5
* `#define C6_AUDIO`
* enables audio on pin C6
* `#define B5_AUDIO`
- * enables audio on pin B5 (duophony is enable if both are enabled)
+ * enables audio on pin B5 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
+* `#define B6_AUDIO`
+ * enables audio on pin B6 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
+* `#define B7_AUDIO`
+ * enables audio on pin B7 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
* `#define BACKLIGHT_PIN B7`
* pin of the backlight - B5, B6, B7 use PWM, others use softPWM
* `#define BACKLIGHT_LEVELS 3`
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index 5b11aa3aba..eaaa2fe512 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: