aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2018-01-13 00:26:39 +1100
committerJack Humbert <jack.humb@gmail.com>2018-01-12 12:52:35 -0500
commit4764e7712109be63df6395d70b069bceb0258e61 (patch)
tree368a2ae4c613cd97a94c8408c5398e0b05a54f22 /docs
parentcfcf0fd36b1e9179e8d136731254c38fed9828b6 (diff)
downloadfirmware-4764e7712109be63df6395d70b069bceb0258e61.tar.gz
firmware-4764e7712109be63df6395d70b069bceb0258e61.tar.bz2
firmware-4764e7712109be63df6395d70b069bceb0258e61.zip
Clarify that we actually have max 16 total backlight levels
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md2
-rw-r--r--docs/feature_backlight.md2
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 1dd4cdbaa..055531b67 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -69,7 +69,7 @@ This is a C header file that is one of the first things included, and will persi
* `#define BACKLIGHT_PIN B7`
* pin of the backlight - B5, B6, B7 use PWM, others use softPWM
* `#define BACKLIGHT_LEVELS 3`
- * number of levels your backlight will have (not including off)
+ * number of levels your backlight will have (maximum 15 excluding off)
* `#define BACKLIGHT_BREATHING`
* enables backlight breathing (only works with backlight pins B5, B6 and B7)
* `#define BREATHING_PERIOD 6`
diff --git a/docs/feature_backlight.md b/docs/feature_backlight.md
index 470b9f21f..5336e8526 100644
--- a/docs/feature_backlight.md
+++ b/docs/feature_backlight.md
@@ -21,7 +21,7 @@ Note that for backlight breathing, you need to have `#define BACKLIGHT_BREATHING
## Configuration Options in `config.h`
* `BACKLIGHT_PIN B7` defines the pin that controlls the LEDs. Unless you design your own keyboard, you don't need to set this.
-* `BACKLIGHT_LEVELS 3` defines the number of brightness levels (excluding OFF).
+* `BACKLIGHT_LEVELS 3` defines the number of brightness levels (maximum 15 excluding off).
* `BACKLIGHT_BREATHING` if defined, enables backlight breathing. Note that this is only available if `BACKLIGHT_PIN` is B5, B6 or B7.
* `BREATHING_PERIOD 6` defines the length of one backlight "breath" in seconds.