From 4d72aa428fb8dc72634bded428f78ffba2284fdc Mon Sep 17 00:00:00 2001 From: fauxpark Date: Fri, 9 Aug 2019 06:12:12 +1000 Subject: Improve backlight PWM pin support (#6202) * Improve backlight PWM pin support * I accidentally an equals sign * Another typo * Order by pin number * Throw an error if backlight pin is C4 or C5 on 16/32U4 * Use else for clarity * Minor alignment adjustments --- docs/hardware_avr.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'docs/hardware_avr.md') diff --git a/docs/hardware_avr.md b/docs/hardware_avr.md index 7c28ab6dbc..c6987d1bdf 100644 --- a/docs/hardware_avr.md +++ b/docs/hardware_avr.md @@ -125,7 +125,7 @@ To configure a keyboard where each switch is connected to a separate pin and gro ### Backlight Configuration -By default QMK supports backlighting on pins `B5`, `B6`, and `B7`. If you are using one of those you can simply enable it here. For more details see the [Backlight Documentation](feature_backlight.md). +QMK supports backlighting on most GPIO pins. A select few of these can be driven by the MCU in hardware. For more details see the [Backlight Documentation](feature_backlight.md). ```c #define BACKLIGHT_PIN B7 @@ -134,8 +134,6 @@ By default QMK supports backlighting on pins `B5`, `B6`, and `B7`. If you are us #define BREATHING_PERIOD 6 ``` -?> You can use backlighting on any pin you like, but you will have to do more work to support that. See the [Backlight Documentation](feature_backlight.md) for more details. - ### Other Configuration Options There are a lot of features that can be configured or tuned in `config.h`. You should see the [Config Options](config_options.md) page for more details. -- cgit v1.2.3 From ddaf37ffa98683be925ae7c396c55f336dce4ad2 Mon Sep 17 00:00:00 2001 From: fauxpark Date: Sun, 18 Aug 2019 04:41:55 +1000 Subject: Reword a note about the MANUFACTURER and PRODUCT defines in hardware_avr.md (#6558) --- docs/hardware_avr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/hardware_avr.md') diff --git a/docs/hardware_avr.md b/docs/hardware_avr.md index c6987d1bdf..0c1b31bb26 100644 --- a/docs/hardware_avr.md +++ b/docs/hardware_avr.md @@ -78,7 +78,7 @@ Do change the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` lines to accurately r #define DESCRIPTION A custom keyboard ``` -?> Note: On Windows and macOS the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` fields will be displayed in the list of USB devices. ?> On Linux these values will not be visible in lsusb by default, since Linux takes the information from the list maintained by [USB ID Repository](http://www.linux-usb.org/usb-ids.html) by default. lsusb will show the information reported by the device when executed with -v option. It is also present in kernel logs after plugging in the device. +?> Windows and macOS will display the `MANUFACTURER` and `PRODUCT` in the list of USB devices. `lsusb` on Linux instead takes these from the list maintained by the [USB ID Repository](http://www.linux-usb.org/usb-ids.html) by default. `lsusb -v` will show the values reported by the device, and they are also present in kernel logs after plugging it in. ### Keyboard Matrix Configuration -- cgit v1.2.3 From f87908228ab0bcd5302feb5701443b8af708d947 Mon Sep 17 00:00:00 2001 From: Max Rumpf Date: Tue, 22 Oct 2019 14:47:43 +0200 Subject: Remove apostrophe from various abbreviations' plural forms (#7050) While this was historically a valid possibility, nowadays, it reads kinda weird, and the [Oxford Dictionaries Online suggests to avoid it](https://english.stackexchange.com/a/56010). Thus, I removed it everywhere I found it. --- docs/hardware_avr.md | 2 +- docs/hardware_drivers.md | 2 +- docs/reference_glossary.md | 8 ++++---- docs/understanding_qmk.md | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) (limited to 'docs/hardware_avr.md') diff --git a/docs/hardware_avr.md b/docs/hardware_avr.md index 0c1b31bb26..697c55d2a8 100644 --- a/docs/hardware_avr.md +++ b/docs/hardware_avr.md @@ -1,6 +1,6 @@ # Keyboards with AVR Processors -This page describes the support for for AVR processors in QMK. AVR processors include the atmega32u4, atmega32u2, at90usb1286, and other processors from Atmel Corporation. AVR processors are 8-bit MCU's that are designed to be easy to work with. The most common AVR processors in keyboards have on-board USB and plenty of GPIO for supporting large keyboard matrices. They are the most popular MCU for use in keyboards today. +This page describes the support for for AVR processors in QMK. AVR processors include the atmega32u4, atmega32u2, at90usb1286, and other processors from Atmel Corporation. AVR processors are 8-bit MCUs that are designed to be easy to work with. The most common AVR processors in keyboards have on-board USB and plenty of GPIO for supporting large keyboard matrices. They are the most popular MCU for use in keyboards today. If you have not yet you should read the [Keyboard Guidelines](hardware_keyboard_guidelines.md) to get a sense of how keyboards fit into QMK. diff --git a/docs/hardware_drivers.md b/docs/hardware_drivers.md index 023e92982c..321ba2a4bc 100644 --- a/docs/hardware_drivers.md +++ b/docs/hardware_drivers.md @@ -20,7 +20,7 @@ Support for SSD1306 based OLED displays. For more information see the [OLED Driv ## uGFX -You can make use of uGFX within QMK to drive character and graphic LCD's, LED arrays, OLED, TFT, and other display technologies. This needs to be better documented, if you are trying to do this and reading the code doesn't help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) and we can help you through the process. +You can make use of uGFX within QMK to drive character and graphic LCDs, LED arrays, OLED, TFT, and other display technologies. This needs to be better documented, if you are trying to do this and reading the code doesn't help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) and we can help you through the process. ## WS2812 (AVR Only) diff --git a/docs/reference_glossary.md b/docs/reference_glossary.md index 422abb2ece..08a22050cf 100644 --- a/docs/reference_glossary.md +++ b/docs/reference_glossary.md @@ -1,16 +1,16 @@ # Glossary of QMK Terms ## ARM -A line of 32-bit MCU's produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI. +A line of 32-bit MCUs produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI. ## AVR -A line of 8-bit MCU's produced by [Atmel](http://www.microchip.com/). AVR was the original platform that TMK supported. +A line of 8-bit MCUs produced by [Atmel](http://www.microchip.com/). AVR was the original platform that TMK supported. ## AZERTY The standard Français (French) keyboard layout. Named for the first 6 keys on the keyboard. ## Backlight -A generic term for lighting on a keyboard. The backlight is typically, but not always, an array of LED's that shine through keycaps and/or switches. +A generic term for lighting on a keyboard. The backlight is typically, but not always, an array of LEDs that shine through keycaps and/or switches. ## Bluetooth A short range peer to peer wireless protocol. Most common wireless protocol for a keyboard. @@ -147,7 +147,7 @@ A feature that lets you assign multiple keycodes to the same key based on how ma A low-cost AVR development board that is commonly used for hand-wired builds. A teensy is often chosen despite costing a few dollars more due to its halfkay bootloader, which makes flashing very simple. ## Underlight -A generic term for LEDs that light the underside of the board. These LED's typically shine away from the bottom of the PCB and towards the surface the keyboard rests on. +A generic term for LEDs that light the underside of the board. These LEDs typically shine away from the bottom of the PCB and towards the surface the keyboard rests on. ## Unicode In the larger computer world Unicode is a set of encoding schemes for representing characters in any language. As it relates to QMK it means using various OS schemes to send unicode codepoints instead of scancodes. diff --git a/docs/understanding_qmk.md b/docs/understanding_qmk.md index a94c9c3191..81cedfcf53 100644 --- a/docs/understanding_qmk.md +++ b/docs/understanding_qmk.md @@ -22,7 +22,7 @@ This section of code is called "The Main Loop" because it's responsible for loop keyboard_task(); ``` -This is where all the keyboard specific functionality is dispatched. The source code for `keyboard_task()` can be found in [tmk_core/common/keyboard.c](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/tmk_core/common/keyboard.c#L216), and it is responsible for detecting changes in the matrix and turning status LED's on and off. +This is where all the keyboard specific functionality is dispatched. The source code for `keyboard_task()` can be found in [tmk_core/common/keyboard.c](https://github.com/qmk/qmk_firmware/blob/e1203a222bb12ab9733916164a000ef3ac48da93/tmk_core/common/keyboard.c#L216), and it is responsible for detecting changes in the matrix and turning status LEDs on and off. Within `keyboard_task()` you'll find code to handle: @@ -30,7 +30,7 @@ Within `keyboard_task()` you'll find code to handle: * Mouse Handling * Serial Link(s) * Visualizer -* Keyboard status LED's (Caps Lock, Num Lock, Scroll Lock) +* Keyboard status LEDs (Caps Lock, Num Lock, Scroll Lock) #### Matrix Scanning @@ -175,7 +175,7 @@ FIXME: This needs to be written FIXME: This needs to be written -#### Keyboard state LED's (Caps Lock, Num Lock, Scroll Lock) +#### Keyboard state LEDs (Caps Lock, Num Lock, Scroll Lock) FIXME: This needs to be written -- cgit v1.2.3