summaryrefslogtreecommitdiffstats
path: root/docs/custom_quantum_functions.md
AgeCommit message (Collapse)AuthorFilesLines
2019-04-05Custom Tapping Term per key (#5009)Drashna Jaelre1-0/+29
* Add customizable tapping terms * Add Documentation * Fix function * Fixes * It's not a pointer * Add debugging output * Update documentation to be at least vaguely accurate * Use `get_tapping_term(tapping_key.event)` instead `e` doesn't include column and row information, properly. It registers as 255, regardless of the actual keypress. However `tapping_key.event` actually gives the correct column and row information. It appears be the correct structure to use. In fact, it looks like the issue is that `e` is actually the "TICK" structure, as defined in keyboard.h * Use variable tapping term value rather than define * Silly drashna - tapping_key.event, not event * add get_event_keycode() function * Fix typo Co-Authored-By: drashna <drashna@live.com> * Remove post_process_record_quantum since it's the wrong PR * Update quantum/quantum.c Co-Authored-By: drashna <drashna@live.com> * Better handle ifdef statement for permissive hold Since we can't be sure that tapping term is actually 500 * Update quantum.c comments based on feedback * Clean up get_tapping_term function Clean up function so that users don't need to call the event function, and instead only check the keycode * Add ability to run functionality on and off * Make ifdef's more compact
2019-04-01Fix typo in keyboard_post_init_user example, remove EPRM from Persistent ↵zvecr1-13/+8
Configuration (EEPROM) (#5528)
2019-03-18[Docs] Smallish overhaul of the docs (#5281)Drashna Jaelre1-22/+22
* Fix up Common functions doc * Add to extra commands to flashing doc * Rearrange and touch up Macros * Expand Newbs Flashing guide * Update process_record documentation * Add git to best practices name in sidebar * Expand FAQ for build/flashing * Add deprecated info to functions * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Update docs/faq_build.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Fix up Common functions doc * Make pre-init example accurate * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Zadig Driver catchall * Spelling Depriciated * Completely remove fn_actions section
2019-03-05[Docs] Fix function signature (layer_state_set_*) (#5313)lf1-1/+1
`void uint32_t` is not a return type.
2019-02-15Add kb and user level keyboard initialization functions (#3113)Drashna Jaelre1-8/+60
* Add suspend functions * Disable RGB code if it's disabled * Add keyboard_init functions * Change where references so it will compile * Wrong command chained in wake up kb function * Fix non-feature file changes * Add documentation * Re-add matrix init docs * add rgblight code to example * Remove suspend code * Clean up docs * Fix docs * Fix suspend code * more doc fixes * change function to startup_* rather than keyboard_init_ * fix spelling error * fix up docs to finish removing keyboard_init * Use Pre and Post init functions * Update Documenation * Remove changes to my keymap and userspace code * Cleanup * Revert changes to extra files * Forgot a semicolon * Make sure all protocols call keyboard_setup * Cleanup functions * Unset startup_user * Remove changes from division keyboard * Readd startup_user function * Remove all to startup_user * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Add suggestion line * Rebase fixes * Update documentation to be more useful/accurate * Cleanup of documentation * Fix spacing inconsistency * Revert unexpected change to keymap
2019-01-21Tidy up IS_{,HOST_}LED_{ON,OFF} macros (#4894)Konstantin Đorđević1-18/+9
* Tidy up IS_{,HOST_}LED_{ON,OFF} macros * Tweak LED control docs
2019-01-18Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation (#4853)DidierLoiseau1-8/+46
* Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation * Update docs/custom_quantum_functions.md Co-Authored-By: DidierLoiseau <didierloiseau+github@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: DidierLoiseau <didierloiseau+github@gmail.com> * Integrated @drashna and @fauxpark's PR comments - changed all plurals of "LED" to "LEDs" in the file - rewording of the note about host_keyboard_leds() vs. led_set_user() * Update docs/custom_quantum_functions.md Co-Authored-By: DidierLoiseau <didierloiseau+github@gmail.com>
2018-10-13Fix Typo in Custom Quantum functions document (led_state) (#4129)asakuno1-2/+2
*_LOCK   ↓ DEL
2018-10-02Add C hint to inline codeYan-Fa Li1-19/+19
2018-10-02Add Function level EECONFIG code for EEPROM (#3084)Drashna Jaelre1-0/+140
* Add Function level EEPROM configuration Add kb and user functions for EEPROM, and example of how to use it. * Bug fixes and demo * Additional cleanup * Add EEPROM reset macro to example * Forgot init function in list * Move eeconfig_init_quantum function to quantum.c and actually set default layer * See if removing weak quantum function fixes issue * Fix travis compile error * Remove ifdef blocks from EECONFIG so settings are always set * Fix for ARM EEPROM updates * Fix merge issues * Fix potential STM32 EEPROM issues
2018-07-11Replace gitter links with Discord. (#3368)Fred Silberberg1-1/+1
2018-06-03Add Suspend functions (#3112)Drashna Jaelre1-2/+33
* Add suspend functions * Disable RGB code if it's disabled * Add suspend code to ChibiOS for future compatibility * Add keyboard_init functions * Change where references so it will compile * Wrong command chained in wake up kb function * Fix non-feature file changes * Add documentation * Re-add matrix init docs * add rgblight code to example * Remove keyboard init stuff for separate PR
2018-03-24Fix custom functions documation for layer_state_set*U-LANDSRAAD\drashna1-1/+1
2018-03-07Add layer_state_set_* to custom function listsU-LANDSRAAD\drashna1-1/+37
2018-03-07Examples should all use _user functions for consistencyU-LANDSRAAD\drashna1-4/+5
2017-12-20Fixed typoHugo Gayosso1-1/+1
2017-12-17Added default case to process_record_userkamisamamizu1-0/+2
I tried using process_record_user and if I had to add the default case for it to compile.
2017-12-09Trim trailing whitespacefauxpark1-4/+4
2017-12-09Fix some of the more obvious typosfauxpark1-1/+1
2017-12-09Convert all headings to Title Casefauxpark1-10/+10
2017-11-30Fix internal links in docs/ (#2080)Devin J. Pohly1-1/+1
One link in the summary (Modding your keyboard) referred to a page that was deleted; the rest have been updated to point to the new names.
2017-07-23Fix minor formatting issue.Joe Wasson1-1/+1
2017-07-03Update a bunch of docsskullY1-3/+3
2017-06-30reduce the TOC scopeskullY1-4/+4
2017-06-30tweak page-toc settingsskullY1-13/+13
2017-06-30Adjust headings to make navigator happierskullY1-18/+14
2017-06-29Fixup the gitbook configskullY1-2/+2
2017-06-29Add some gitboot pluginsskullY1-0/+2
2017-06-29Polish up custom_quantum_functionsskullY1-42/+97
2017-06-10convert docs to lowercase and underscoresJack Humbert1-0/+123