diff options
| author | Drashna Jaelre <drashna@live.com> | 2018-04-18 22:47:04 -0700 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2018-04-19 01:47:04 -0400 |
| commit | 8b0b17a369be6d3dff4cb9bad4253960252a5e95 (patch) | |
| tree | 11d453ef480983571de84147db3bc9c1bfcb5054 /docs | |
| parent | 23b45710acc57ed147e006a8c79a1caf6fa57fd7 (diff) | |
Add Faux Clicking as subset of Audio feature (#2748)
* Add Faux Clicky to main Audio feature
* Make clicky settings user configurable
* Add additional documentation
* Don't play when music mode is enabled (hopefully)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_audio.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md index eaaa2fe512..1b8ca86f49 100644 --- a/docs/feature_audio.md +++ b/docs/feature_audio.md @@ -97,6 +97,36 @@ You can completely disable Music Mode as well. This is useful, if you're pressed #define NO_MUSIC_MODE +## Faux Click + +This adds a click sound each time you hit a button, to simulate click sounds from the keyboard. And the sounds are slightly different for each keypress, so it doesn't sound like a single long note, if you type rapidly. + +* `CK_TOGG` - Toggles the status (will play sound if enabled) +* `CK_RST` - Resets the frequency to the default state +* `CK_UP` - Increases the frequency of the clicks +* `CK_DOWN` - Decreases the frequency of the clicks + +The feature is disabled by default, to save space. To enable it, add this to your `config.h`: + + #define AUDIO_CLICKY + +Additionally, even when enabled, the feature is not enabled by default, so you would need to turn it on first. And since we don't use EEPROM to store the setting (yet), you can default this to on by adding this to your `config.h`: + + #define AUDIO_CLICKY_ON + +You can configure the default, min and max frequencies, the stepping and built in randomness by defining these values: + +| Option | Default Value | Description | +|--------|---------------|-------------| +| `AUDIO_CLICKY_FREQ_DEFAULT` | 440.0f | Sets the default/starting audio frequency for the clicky sounds. | +| `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). | +| `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the the highest frequency. Too high may result in coworkers attacking you. | +| `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. | +| `AUDIO_CLICKY_FREQ_RANDOMNESS` | 0.05f | Sets a factor of randomness for the clicks, Setting this to `0f` will make each click identical. | + + + + ## MIDI Functionality This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile. |