avr/qmk/firmware - [no description]

diff options

author	William Chang <william@factual.com>	2019-04-25 10:27:04 -0700
committer	William Chang <william@factual.com>	2019-04-25 10:27:04 -0700
commit	89e8e0d2774064362fa5e73d19df3b1e760d7016 (patch)
tree	14330e33b653234621478afc391a725855fcfdaa /lib/lufa/Projects/XPLAINBridge/Lib/SoftUART.h
parent	d7c5cf6e5bfe0be17173f42aabdd981036c4c940 (diff)
download	firmware-89e8e0d2774064362fa5e73d19df3b1e760d7016.tar.gz firmware-89e8e0d2774064362fa5e73d19df3b1e760d7016.tar.bz2 firmware-89e8e0d2774064362fa5e73d19df3b1e760d7016.zip

updated right alt key to apply shift key for emacs

Diffstat (limited to 'lib/lufa/Projects/XPLAINBridge/Lib/SoftUART.h')

0 files changed, 0 insertions, 0 deletions

# How to Customize Your Keyboard's Behavior For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations. This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.md) will help you understand what is going on at a more fundamental level. ## A Word on Core vs Keyboards vs Keymap We have structured QMK as a hierarchy: * Core (`_quantum`) * Keyboard/Revision (`_kb`) * Keymap (`_user`) Each of the functions described below can be defined with a `_kb()` suffix or a `_user()` suffix. We intend for you to use the `_kb()` suffix at the Keyboard/Revision level, while the `_user()` suffix should be used at the Keymap level. When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` before executing anything else- otherwise the keymap level function will never be called. # Custom Keycodes By far the most common task is to change the behavior of an existing keycode or to create a new keycode. From a code standpoint the mechanism for each is very similar. ## Defining a New Keycode The first step to creating your own custom keycode(s) is to enumerate them. This means both naming them and assigning a unique number to that keycode. Rather than limit custom keycodes to a fixed range of numbers QMK provides the `SAFE_RANGE` macro. You can use `SAFE_RANGE` when enumerating your custom keycodes to guarantee that you get a unique number. Here is an example of enumerating 2 keycodes. After adding this block to your `keymap.c` you will be able to use `FOO` and `BAR` inside your keymap. ```c enum my_keycodes { FOO = SAFE_RANGE, BAR }; ``` ## Programming the Behavior of Any Keycode When you want to override the behavior of an existing key, or define the behavior for a new key, you should use the `process_record_kb()` and `process_record_user()` functions. These are called by QMK during key processing before the actual key event is handled. If these functions return `true` QMK will process the keycodes as usual. That can be handy for extending the functionality of a key rather than replacing it. If these functions return `false` QMK will skip the normal key handling, and it will be up to you to send any key up or down events that are required. These function are called every time a key is pressed or released. ### Example `process_record_user()` Implementation This example does two things. It defines the behavior for a custom keycode called `FOO`, and it supplements our Enter key by playing a tone whenever it is pressed. ```c bool process_record_user(uint16_t keycode, keyrecord_t *record) { switch (keycode) { case FOO: if (record->event.pressed) { // Do something when pressed } else { // Do something else when release } return false; // Skip all further processing of this key case KC_ENTER: // Play a tone when enter is pressed if (record->event.pressed) { PLAY_NOTE_ARRAY(tone_qwerty); } return true; // Let QMK send the enter press/release events default: return true; // Process all other keycodes normally } } ``` ### `process_record_*` Function Documentation * Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` * Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)` The `keycode` argument is whatever is defined in your keymap, eg `MO(1)`, `KC_L`, etc. You should use a `switch...case` block to handle these events. The `record` argument contains information about the actual press: ```c keyrecord_t record { keyevent_t event { keypos_t key { uint8_t col uint8_t row } bool pressed uint16_t time } } ``` # LED Control QMK provides methods to read the 5 LEDs defined as part of the HID spec: * `USB_LED_NUM_LOCK` * `USB_LED_CAPS_LOCK` * `USB_LED_SCROLL_LOCK` * `USB_LED_COMPOSE` * `USB_LED_KANA` These five constants correspond to the positional bits of the host LED state. There are two ways to get the host LED state: * by implementing `led_set_user()` * by calling `host_keyboard_leds()` ## `led_set_user()` This function will be called when the state of one of those 5 LEDs changes. It receives the LED state as a parameter. Use the `IS_LED_ON(usb_led, led_name)` and `IS_LED_OFF(usb_led, led_name)` macros to check the LED status. !> `host_keyboard_leds()` may already reflect a new value before `led_set_user()` is called. ### Example `led_set_user()` Implementation ```c void led_set_user(uint8_t usb_led) { if (IS_LED_ON(usb_led, USB_LED_NUM_LOCK)) { writePinLow(B0); } else { writePinHigh(B0); } if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK)) { writePinLow(B1); } else { writePinHigh(B1); } if (IS_LED_ON(usb_led, USB_LED_SCROLL_LOCK)) { writePinLow(B2); } else { writePinHigh(B2); } if (IS_LED_ON(usb_led, USB_LED_COMPOSE)) { writePinLow(B3); } else { writePinHigh(B3); } if (IS_LED_ON(usb_led, USB_LED_KANA)) { writePinLow(B4); } else { writePinHigh(B4); } } ``` ### `led_set_*` Function Documentation * Keyboard/Revision: `void led_set_kb(uint8_t usb_led)` * Keymap: `void led_set_user(uint8_t usb_led)` ## `host_keyboard_leds()` Call this function to get the last received LED state. This is useful for reading the LED state outside `led_set_*`, e.g. in [`matrix_scan_user()`](#matrix-scanning-code). For convenience, you can use the `IS_HOST_LED_ON(led_name)` and `IS_HOST_LED_OFF(led_name)` macros instead of calling and checking `host_keyboard_leds()` directly. ## Setting Physical LED State Some keyboard implementations provide convenience methods for setting the state of the physical LEDs. ### Ergodox Boards The Ergodox implementations provide `ergodox_right_led_1`/`2`/`3_on`/`off()` to turn individual LEDs on or off, as well as `ergodox_right_led_on`/`off(uint8_t led)` to turn them on or off by their index. In addition, it is possible to specify the brightness level of all LEDs with `ergodox_led_all_set(uint8_t n)`; of individual LEDs with `ergodox_right_led_1`/`2`/`3_set(uint8_t n)`; or by index with `ergodox_right_led_set(uint8_t led, uint8_t n)`. Ergodox boards also define `LED_BRIGHTNESS_LO` for the lowest brightness and `LED_BRIGHTNESS_HI` for the highest brightness (which is the default). # Keyboard Initialization Code There are several steps in the keyboard initialization process. Depending on what you want to do, it will influence which function you should use. These are the three main initialization functions, listed in the order that they're called. * `keyboard_pre_init_*` - Happens before most anything is started. Good for hardware setup that you want running very early. * `matrix_init_*` - Happens midway through the firmware's startup process. Hardware is initialized, but features may not be yet. * `keyboard_post_init_*` - Happens at the end of the firmware's startup process. This is where you'd want to put "customization" code, for the most part. !> For most people, the `keyboard_post_init_user` function is what you want to call. For instance, this is where you want to set up things for RGB Underglow. ## Keyboard Pre Initialization code This runs very early during startup, even before the USB has been started. Shortly after this, the matrix is initialized. For most users, this shouldn't be used, as it's primarily for hardware oriented initialization. However, if you have hardware stuff that you need initialized, this is the best place for it (such as initializing LED pins). ### Example `keyboard_pre_init_user()` Implementation This example, at the keyboard level, sets up B0, B1, B2, B3, and B4 as LED pins. ```c void keyboard_pre_init_user(void) { // Call the keyboard pre init code. // Set our LED pins as output setPinOutput(B0); setPinOutput(B1); setPinOutput(B2); setPinOutput(B3); setPinOutput(B4); } ``` ### `keyboard_pre_init_*` Function Documentation * Keyboard/Revision: `void keyboard_pre_init_kb(void)` * Keymap: `void keyboard_pre_init_user(void)` ## Matrix Initialization Code This is called when the matrix is initialized, and after some of the hardware has been set up, but before many of the features have been initialized. This is useful for setting up stuff that you may need elsewhere, but isn't hardware related nor is dependant on where it's started. ### `matrix_init_*` Function Documentation * Keyboard/Revision: `void matrix_init_kb(void)` * Keymap: `void matrix_init_user(void)` ## Keyboard Post Initialization code This is ran as the very last task in the keyboard initialization process. This is useful if you want to make changes to certain features, as they should be initialized by this point. ### Example `keyboard_post_init_user()` Implementation This example, running after everything else has initialized, sets up the rgb underglow configuration. ```c void keyboard_post_init_user(void) { // Call the post init code. rgblight_enable_noeeprom(); // enables Rgb, without saving settings rgblight_sethsv_noeeprom(180, 255, 255); // sets the color to teal/cyan without saving rgblight_mode_noeeprom(RGBLIGHT_MODE_BREATHING + 3); // sets mode to Fast breathing without saving } ``` ### `keyboard_post_init_*` Function Documentation * Keyboard/Revision: `void keyboard_post_init_kb(void)` * Keymap: `void keyboard_post_init_user(void)` # Matrix Scanning Code Whenever possible you should customize your keyboard by using `process_record_*()` and hooking into events that way, to ensure that your code does not have a negative performance impact on your keyboard. However, in rare cases it is necessary to hook into the matrix scanning. Be extremely careful with the performance of code in these functions, as it will be called at least 10 times per second. ### Example `matrix_scan_*` Implementation This example has been deliberately omitted. You should understand enough about QMK internals to write this without an example before hooking into such a performance sensitive area. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on Discord](https://discord.gg/Uq7gcHh). ### `matrix_scan_*` Function Documentation * Keyboard/Revision: `void matrix_scan_kb(void)`


context:
space:
mode: