diff options
| author | fauxpark <fauxpark@gmail.com> | 2019-06-20 15:33:39 +1000 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-06-19 22:33:39 -0700 |
| commit | 317b8095647e208a7ac1ecf6b110051ca46553a8 (patch) | |
| tree | 724a2dc9d0b5071999f25400c453ca061e1c0827 /docs | |
| parent | 67e0c951afee99ac1e1e96354655296457f57b78 (diff) | |
| download | qmk_firmware-317b8095647e208a7ac1ecf6b110051ca46553a8.tar.gz qmk_firmware-317b8095647e208a7ac1ecf6b110051ca46553a8.zip | |
Fix breathing always on for soft PWM (#5983)
* Fix breathing always on for soft PWM
* Remove reference to hardware PWM pins in BACKLIGHT_BREATHING description
Now, breathing will only be unsupported when Timers 1 and 3 are both used by Audio
* Document BACKLIGHT_ON_STATE and its purpose
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config_options.md | 2 | ||||
| -rw-r--r-- | docs/feature_backlight.md | 10 |
2 files changed, 9 insertions, 3 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index 7418e8dbf..eb0a441cc 100644 --- a/docs/config_options.md +++ b/docs/config_options.md | |||
| @@ -80,7 +80,7 @@ This is a C header file that is one of the first things included, and will persi | |||
| 80 | * `#define BACKLIGHT_LEVELS 3` | 80 | * `#define BACKLIGHT_LEVELS 3` |
| 81 | * number of levels your backlight will have (maximum 15 excluding off) | 81 | * number of levels your backlight will have (maximum 15 excluding off) |
| 82 | * `#define BACKLIGHT_BREATHING` | 82 | * `#define BACKLIGHT_BREATHING` |
| 83 | * enables backlight breathing (only works with backlight pins B5, B6 and B7) | 83 | * enables backlight breathing |
| 84 | * `#define BREATHING_PERIOD 6` | 84 | * `#define BREATHING_PERIOD 6` |
| 85 | * the length of one backlight "breath" in seconds | 85 | * the length of one backlight "breath" in seconds |
| 86 | * `#define DEBOUNCE 5` | 86 | * `#define DEBOUNCE 5` |
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md index 5a21a6790..b06db89e4 100644 --- a/docs/feature_backlight.md +++ b/docs/feature_backlight.md | |||
| @@ -64,11 +64,17 @@ To change the behaviour of the backlighting, `#define` these in your `config.h`: | |||
| 64 | |Define |Default |Description | | 64 | |Define |Default |Description | |
| 65 | |---------------------|-------------|-------------------------------------------------------------------------------------------------------------| | 65 | |---------------------|-------------|-------------------------------------------------------------------------------------------------------------| |
| 66 | |`BACKLIGHT_PIN` |`B7` |The pin that controls the LEDs. Unless you are designing your own keyboard, you shouldn't need to change this| | 66 | |`BACKLIGHT_PIN` |`B7` |The pin that controls the LEDs. Unless you are designing your own keyboard, you shouldn't need to change this| |
| 67 | |`BACKLIGHT_PINS` |*Not defined*|experimental: see below for more information| | 67 | |`BACKLIGHT_PINS` |*Not defined*|experimental: see below for more information | |
| 68 | |`BACKLIGHT_LEVELS` |`3` |The number of brightness levels (maximum 15 excluding off) | | 68 | |`BACKLIGHT_LEVELS` |`3` |The number of brightness levels (maximum 15 excluding off) | |
| 69 | |`BACKLIGHT_CAPS_LOCK`|*Not defined*|Enable Caps Lock indicator using backlight (for keyboards without dedicated LED) | | 69 | |`BACKLIGHT_CAPS_LOCK`|*Not defined*|Enable Caps Lock indicator using backlight (for keyboards without dedicated LED) | |
| 70 | |`BACKLIGHT_BREATHING`|*Not defined*|Enable backlight breathing, if supported | | 70 | |`BACKLIGHT_BREATHING`|*Not defined*|Enable backlight breathing, if supported | |
| 71 | |`BREATHING_PERIOD` |`6` |The length of one backlight "breath" in seconds | | 71 | |`BREATHING_PERIOD` |`6` |The length of one backlight "breath" in seconds | |
| 72 | |`BACKLIGHT_ON_STATE` |`0` |The state of the backlight pin when the backlight is "on" - `1` for high, `0` for low | | ||
| 73 | |||
| 74 | ## Backlight On State | ||
| 75 | |||
| 76 | Most backlight circuits are driven by an N-channel MOSFET or NPN transistor. This means that to turn the transistor *on* and light the LEDs, you must drive the backlight pin, connected to the gate or base, *low*. | ||
| 77 | Sometimes, however, a P-channel MOSFET, or a PNP transistor is used. In this case you must `#define BACKLIGHT_ON_STATE 1`, so that when the transistor is on, the pin is driven *high* instead. | ||
| 72 | 78 | ||
| 73 | ## Multiple backlight pins | 79 | ## Multiple backlight pins |
| 74 | 80 | ||
