Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation #4853

Merged
merged 5 commits into from
Jan 18, 2019

Conversation

DidierLoiseau
Copy link
Contributor

Description

This is a simple change to provide the following new macros for host LED reading:

  • IS_LED_ON() and IS_LED_OFF() to use in led_set_user
  • IS_HOST_LED_ON() and IS_HOST_LED_OFF() to use everywhere

Updated documentation accordingly, and generally improved the LED documentation.

Types of changes

  • Core
  • Bugfix
  • New Feature
  • Enhancement/Optimization
  • Keyboard (addition or update)
  • Keymap/Layout/Userspace (addition or update)
  • Documentation

Issues Fixed or Closed by this PR

  • N/A

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document. (https://docs.qmk.fm/#/contributing)
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

docs/custom_quantum_functions.md Outdated Show resolved Hide resolved
fauxpark and others added 3 commits January 15, 2019 23:49
- changed all plurals of "LED" to "LEDs" in the file
- rewording of the note about host_keyboard_leds() vs. led_set_user()
@DidierLoiseau
Copy link
Contributor Author

@drashna, @fauxpark, do you still expect changes from me?

@fauxpark
Copy link
Member

I think you missed one of my suggestions. LGTM otherwise :)

@drashna
Copy link
Member

drashna commented Jan 18, 2019

Thanks!

@drashna drashna merged commit 94ba2e5 into qmk:master Jan 18, 2019
akrob pushed a commit to akrob/qmk_firmware that referenced this pull request Jan 19, 2019
* upstream/master: (390 commits)
  [Keyboard] handwired/ortho60 Configurator update, readme update, and rules tidy (qmk#4877)
  Fix Encoder documentation (qmk#4861)
  TKC1800 refactor and Configurator visual fixes (qmk#4870)
  Fixed the build break of helix/rev1:OLED_sample caused by PR qmk#4462. (qmk#4874)
  Add cursor keys to top layer (qmk#4876)
  [Keyboard] Fix bootloader size for v60_type_r (qmk#4873)
  Flip definitions of macOS brightness alias
  Grammatical fixes for GPIO Control doc (qmk#4869)
  handwired/ortho5x13: layout macro refactor
  Add new brightness aliases to keycodes_basic.md
  [Keyboard] update VENDOR_ID, PRODUCT_ID, and DEVICE_VER for Duck boards (qmk#4612)
  Add Planck rev1 and rev2, clean up rev3-5 config.h
  Allows Terminal to use ModTap/LayerTap keys (qmk#4586)
  Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation (qmk#4853)
  MacOS Brightness Alias (qmk#4836)
  [Keymap] added custom led effect keymap.c (qmk#4856)
  Simplify split_common Code significantly (qmk#4772)
  Add documentation and fix formating (qmk#4860)
  [Keymap] Adding bdk keymap for ergobox_ez (qmk#4850)
  40percent.club Luddite: Configurator update (qmk#4859)
  ...
dlhextall pushed a commit to dlhextall/qmk_firmware that referenced this pull request May 24, 2019
* Defined IS_(HOST_)LED_ON/OFF() and improved LED documentation

* Update docs/custom_quantum_functions.md

Co-Authored-By: DidierLoiseau <[email protected]>

* Update docs/custom_quantum_functions.md

Co-Authored-By: DidierLoiseau <[email protected]>

* 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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants