aboutsummaryrefslogtreecommitdiff
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)
downloadqmk_firmware-22215a0e920a237faabdfa1b8826cd110ab20c3b.tar.gz
qmk_firmware-22215a0e920a237faabdfa1b8826cd110ab20c3b.zip
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 af8602c3f..d45592f82 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
61 * 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. 61 * 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.
62* `#define AUDIO_VOICES` 62* `#define AUDIO_VOICES`
63 * turns on the alternate audio voices (to cycle through) 63 * turns on the alternate audio voices (to cycle through)
64* `#define C4_AUDIO`
65 * enables audio on pin C4
66* `#define C5_AUDIO`
67 * enables audio on pin C5
64* `#define C6_AUDIO` 68* `#define C6_AUDIO`
65 * enables audio on pin C6 69 * enables audio on pin C6
66* `#define B5_AUDIO` 70* `#define B5_AUDIO`
67 * enables audio on pin B5 (duophony is enable if both are enabled) 71 * 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)
72* `#define B6_AUDIO`
73 * 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)
74* `#define B7_AUDIO`
75 * 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)
68* `#define BACKLIGHT_PIN B7` 76* `#define BACKLIGHT_PIN B7`
69 * pin of the backlight - B5, B6, B7 use PWM, others use softPWM 77 * pin of the backlight - B5, B6, B7 use PWM, others use softPWM
70* `#define BACKLIGHT_LEVELS 3` 78* `#define BACKLIGHT_LEVELS 3`
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 @@
1# Audio 1# Audio
2 2
3Your 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. 3Your 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.
4
5Up 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:
6Timer 1:
7`#define B5_AUDIO`
8`#define B6_AUDIO`
9`#define B7_AUDIO`
10
11Timer 3:
12`#define C4_AUDIO`
13`#define C5_AUDIO`
14`#define C6_AUDIO`
4 15
5If you add `AUDIO_ENABLE = yes` to your `rules.mk`, there's a couple different sounds that will automatically be enabled without any other configuration: 16If you add `AUDIO_ENABLE = yes` to your `rules.mk`, there's a couple different sounds that will automatically be enabled without any other configuration:
6 17