dfab177f88
* add temporary file that is rgblight.c call graph * add rgblight_update_hook() * update rgblight-call-graph.dot (temporary file) * add more hook point * add TODO comment * temporary Revert "add TODO comment" This reverts commit df6165aac9b3a31d1d3e31ce52aadc134b84eac2. * temporary Revert "add more hook point" This reverts commit 64592b06f3bcdaac47c59f922018a273bef76776. * temporary Revert "add rgblight_update_hook()" This reverts commit 432b74c912ed4333e6633e20a1bcda10c6a10eaf. * add rgblight_update_hook() * add more hook point * add TODO comment * implement rgblight_update_hook() * remove rgblight_update_hook(), add RGBLIGHT_SPLIT_SET_CHANGE_XXXX rgblight_update_hook() is too large. change to simple flag setting. * shrink rgblight_config_t * implement rgblight_update_sync() Note: The animation synchronization process has not been implemented yet. * update quantum/rgblight-call-graph.dot (temporary file) * rmove quantum/rgblight-call-graph.dot (temporary file) * update rgblight.c * Add temporary code to Helix keyboard 'five_rows' keymap to test rgblight.c . * fix build break rgblight_update_sync() when all animation off * fix quantum/rgblight.c:rgblight_disable_XX() add RGBLIGHT_SPLIT_SET_CHANGE_MODE * quantum/rgblight.c change code order: move rgblight_update_sync() * add mode_base_table[] to quantum/rgblight.c * quantum/rgblight.c use mode_base_table[] and rgblight_status.base_mode * quantum/rgblkght.c animation timer integration * quantum/rgblkght.c add animation sync for split keyboard * fix mode_base_table[] and snake effect * fix build break keyboards/mxss. keyboards/mxss's local rgblight.c need old version rgblight.h * rgblight.c: fix animation sync * quantum/rgblight.c: fix snake effect sync * quantum/rgblight.c: animation sync interverl 30 sec * quantum/rgblight.c: fix rgblight_effect_rainbow_swirl() and rgblight_effect_knight() * quantum/rgblight.c: add macro RGBLIGHT_SPLIT_ANIMATION * cherry-pick from 'rgblight_modes.h sample implementation' * fix RGBLIGHT_SPLIT_ANIMATION check position * Update temporary code in Helix keyboard 'five_rows' keymap to test rgblight.c * Reduce the firmware size by 1500 bytes when rgblight_effect_breathing() is enabled. * Changed to rgblight_sethsv_eeprom_helper() for easier reading. * add fail-safe code to quantum/rgblight.c:rgblight_task(),rgblight_timer_enable() * remove temporary code in Helix keyboard 'five_rows' keymap * quantum/rgblight.c: add split-keyboard master side sync functions add functions: uint8_t rgblight_get_change_flags(void); void rgblight_clear_change_flags(void); void rgblight_get_syncinfo(rgblight_syncinfo_t *syncinfo); change function: void rgblight_update_sync(rgblight_syncinfo_t *syncinfo, bool write_to_eeprom); * Change rgblight_update_sync() to use write_to_eeprom. * remove TODO comment from quantum/rgblight.h * Revert "fix build break keyboards/mxss." This reverts commit 90b9a1aa7d8af226751500e49e3ea0214cc4e024. (Separated this change into the newly opened PR #5461.) * Revert "Reduce the firmware size by 1500 bytes when rgblight_effect_breathing() is enabled." This reverts commit b61004e63e82cf5334cee4def4ba10cffa88885f. * update quantum/rgblight.c: Code size reduction when not using RGBLIGHT_SPLIT. * Add temporary code to Helix keyboard 'five_rows' keymap to test rgblight.c . * add temporary pdhelix(Patched Helix) code * Add temporary code to split_common/transport.c to test rgblight.c. * Finish testing rgblight.c with helix keyboard. Revert "Add temporary code to Helix keyboard 'five_rows' keymap to test rgblight.c ." This reverts commit 0bf81a4723a977adc0cb09b4272ee5c9b4f2bbbb. * Finish testing rgblight.c with quantum/split_common code. Revert "Add temporary code to split_common/transport.c to test rgblight.c." This reverts commit 71db3e24eef40d4c455fb9fd1664e4487c9d927a. * remove temporary pdhelix(Patched Helix) code This reverts commit 5287e51a394741bcb6028c7cfc0dd0c984645f76. * Added description of RGBLIGHT_SPLIT macro to docs/feature_rgblight.md. * add RGBLIGHT_SPLIT_SET_CHANGE_HSVS to rgblight_init() * Changed to restart animation only when changing mode. When changing hue, sat and val, the animation is not restarted and continues. |
||
|---|---|---|
| .. | ||
| gitbook/images | ||
| zh | ||
| .nojekyll | ||
| CNAME | ||
| LANGS.md | ||
| README.md | ||
| _summary.md | ||
| arm_debugging.md | ||
| becoming_a_qmk_collaborator.md | ||
| compatible_microcontrollers.md | ||
| config_options.md | ||
| contributing.md | ||
| custom_quantum_functions.md | ||
| documentation_best_practices.md | ||
| documentation_templates.md | ||
| faq.md | ||
| faq_build.md | ||
| faq_debug.md | ||
| faq_general.md | ||
| faq_keymap.md | ||
| feature_advanced_keycodes.md | ||
| feature_audio.md | ||
| feature_auto_shift.md | ||
| feature_backlight.md | ||
| feature_bluetooth.md | ||
| feature_bootmagic.md | ||
| feature_combo.md | ||
| feature_command.md | ||
| feature_debounce_type.md | ||
| feature_dynamic_macros.md | ||
| feature_encoders.md | ||
| feature_grave_esc.md | ||
| feature_haptic_feedback.md | ||
| feature_hd44780.md | ||
| feature_key_lock.md | ||
| feature_layouts.md | ||
| feature_leader_key.md | ||
| feature_led_matrix.md | ||
| feature_macros.md | ||
| feature_mouse_keys.md | ||
| feature_pointing_device.md | ||
| feature_ps2_mouse.md | ||
| feature_rgb_matrix.md | ||
| feature_rgblight.md | ||
| feature_space_cadet_shift.md | ||
| feature_space_cadet_shift_enter.md | ||
| feature_stenography.md | ||
| feature_swap_hands.md | ||
| feature_tap_dance.md | ||
| feature_terminal.md | ||
| feature_thermal_printer.md | ||
| feature_unicode.md | ||
| feature_userspace.md | ||
| feature_velocikey.md | ||
| features.md | ||
| flashing.md | ||
| fuse.txt | ||
| getting_started_build_tools.md | ||
| getting_started_getting_help.md | ||
| getting_started_github.md | ||
| getting_started_introduction.md | ||
| getting_started_make_guide.md | ||
| getting_started_vagrant.md | ||
| hand_wire.md | ||
| hardware.md | ||
| hardware_avr.md | ||
| hardware_drivers.md | ||
| hardware_keyboard_guidelines.md | ||
| how_keyboards_work.md | ||
| i2c_driver.md | ||
| index.html | ||
| internals_defines.md | ||
| internals_gpio_control.md | ||
| internals_input_callback_reg.md | ||
| internals_midi_device.md | ||
| internals_midi_device_setup_process.md | ||
| internals_midi_util.md | ||
| internals_send_functions.md | ||
| internals_sysex_tools.md | ||
| isp_flashing_guide.md | ||
| keycodes.md | ||
| keycodes_basic.md | ||
| keycodes_us_ansi_shifted.md | ||
| keymap.md | ||
| newbs.md | ||
| newbs_best_practices.md | ||
| newbs_building_firmware.md | ||
| newbs_building_firmware_configurator.md | ||
| newbs_flashing.md | ||
| newbs_getting_started.md | ||
| newbs_learn_more_resources.md | ||
| newbs_testing_debugging.md | ||
| other_eclipse.md | ||
| other_vscode.md | ||
| porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md | ||
| power.txt | ||
| proton_c_conversion.md | ||
| qmk.css | ||
| quantum_keycodes.md | ||
| redirects.json | ||
| ref_functions.md | ||
| reference_configurator_support.md | ||
| reference_glossary.md | ||
| reference_info_json.md | ||
| sidebar.css | ||
| support.md | ||
| sw.js | ||
| understanding_qmk.md | ||
| unit_testing.md | ||
| usb_nkro.txt | ||
README.md
Quantum Mechanical Keyboard Firmware
What is QMK Firmware?
QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Toolbox, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the tmk_keyboard with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line. It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.
How to Get It
If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is fork the repo through Github, and clone your repo locally to make your changes, push them, then open a Pull Request from your fork.
Otherwise, you can either download it directly (zip, tar), or clone it via git (git@github.com:qmk/qmk_firmware.git), or https (https://github.com/qmk/qmk_firmware.git).
How to Compile
Before you are able to compile, you'll need to install an environment for AVR or/and ARM development. Once that is complete, you'll use the make command to build a keyboard and keymap with the following notation:
make planck/rev4:default
This would build the rev4 revision of the planck with the default keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted:
make preonic:default
How to Customize
QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.