1
0
Fork 0
Commit graph

524 commits

Author SHA1 Message Date
Brian Choromanski
7f6bb82b9d Added link to One Shot Keys 2018-10-09 10:27:03 -07:00
Brian Choromanski
04e28470bc Added OSL to list of layer toggles 2018-10-09 10:27:03 -07:00
chipperdoodles
914d42acd0 Update Bluetooth docs (#4062)
* syncing upstream

* Bluetooth Doc update

More Description in bluetooth section, Addition to Config options rules.mk section.

* merge upstream

chibios

* lib/chibios checkout

* Additional EZ key Section

added back EZ-Key diy link, Cleaned up some errors
2018-10-07 11:23:41 -07:00
Drashna Jaelre
f86c0c2643 Update and clarify Unicode documentation (#4065)
* Update and clarify Unicode documentation

* Fixed UCIS info based on feedback from algernon

* Further clarifications and cleanup

* Formatting

* Add an example for unicode map

* fix AutoHotKey title
2018-10-06 20:44:33 -04:00
Drashna Jaelre
7458ac9489 Update Contrib doc (#4068)
* Add link for style

* ignore java

* Add example and update link?

* Minor fixes

* Change 1TBS text

* comments
2018-10-06 20:43:37 -04:00
yiancar
ac7b2d92bf ARM SWD guide
- Added a detailed (but saddly long) debugging guide.
- Modified sidebar and summary to include the links.
2018-10-05 11:03:30 -07:00
Yan-Fa Li
713ec91147 Add C hint to inline code 2018-10-01 22:55:51 -04:00
Drashna Jaelre
f5ae3760c6 Add send_unicode_hex_string function (#3828)
* Add send_string_unicode function

Co-authored-by: kdb424 <kdb424@gmail.com>
Co-authored-by: Konstantin <vomindoraan@gmail.com>

* Clean up code based on feedback

* Fix includes
2018-10-01 20:56:04 -04:00
Drashna Jaelre
26f4e7031a Add tap_code function (#3784)
* Add tap_code

* formatting

* Doc clarification

* Rename variable to make more consistent
2018-10-01 20:53:47 -04:00
Drashna Jaelre
e885c793bc Add Function level EECONFIG code for EEPROM (#3084)
* 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-10-01 20:53:14 -04:00
Daniel Shields
da6c58175a Make digital rain RGB matrix effect #define configurable. 2018-10-01 12:54:37 -04:00
Anthony Som
b3f6aa9480 Correct small typo
A small typo (it -> in) that I noticed while reading through the documentation
2018-10-01 12:42:05 -04:00
noroadsleft
f1b2d46eaf Spell-check update for Userspace documentation
Because leaving review comments on a PR that's already been merged doesn't make any sense.
2018-09-28 14:39:52 -04:00
yiancar
7fe03d085c Update quantum matrix to support both AVR and Chibios ARM (#3968)
* Update quantum matrix to support both AVR and Chibios ARM

- Addition of STM32 pin definitions
- Created abstruction layer defines to control GPIO (This is a bit pointless for Chibios as we are creating a PAL ontop of a PAL but it is necessary for uniformity with AVR)
- Modified matrix.c to use the above functions

* minor ifdef fix

* Rename of functions and docs

- Added documentation.
- Renamed functions according to Jack's spec.

* Massdrop fix

* Update matrix.c

* Update quantum.h

* Update quantum.h

* Update quantum.h

* Update internals_gpio_control.md
2018-09-28 12:33:11 -04:00
Drashna Jaelre
fa47f5fb15 Update to the Userspace documentation (#4005)
* Overhaul to Userspace Documentation

* Formatting issues

* Additionaly formatting fixes

* Add Readme info

* Additionaly Readme info

* Formatting fixes
2018-09-28 12:27:51 -04:00
Drashna Jaelre
8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006)
* Add pragma once info to contributing guidelines

* Fix links in readme template to match doc site

* Revert changes to contributing doc as somebody already changed it
2018-09-28 12:04:30 -04:00
Takeshi ISHII
baebbc0967 add 'mavrdude' target into tmk_core/avr.mk (#3986)
* add 'mavrdude' target into tmk_core/avr.mk

I made it a little convenient when writing the same binary to multiple Pro Micro.

* rename target name 'mavrdude' to 'avrdude-loop'

* modify docs/flashing.md about avrdude-loop

* mdify docs/flashing.md again

* modifi docs/flashing.md 3rd
2018-09-27 22:02:12 -04:00
Drashna Jaelre
a0309db983 Add On/Off keycodes 2018-09-25 13:28:36 -07:00
Drashna Jaelre
e72e4b6920 Store Clicky status in EEPROM 2018-09-25 13:28:36 -07:00
Luca
58b9b22670 Circuitry sample for PS/2 Mouse (#3959)
Added a sample circuitry for handling the connection of a PS/2 Mouse.
    Even if it's written that a circuitry is needed, there're a lot of other
    things and the information gets lost really fast. A really simple sample
    helps to remember who wants to implement the functionality about the
    circuitry.
2018-09-23 13:49:17 -07:00
Anthony Wharton
334e2629df Remove redefinition of _______ in documentation example (#3924)
* Remove redefinition of `_______` in documentation example

* Slight rewording to include purpose of defintions

* Update include to newer macro
2018-09-19 16:18:15 -07:00
Joe Wasson
a6d1db2c27 Create AG_TOGG code to toggle Alt/Gui swap. 2018-09-17 15:04:22 -07:00
dsissitka
244e1c5a57 Fix LEADER_KEY docs.
LEADER_KEY needs to be set in config.h, not keymap.c. Credit goes to @randywallace for figuring this one out:

https://github.com/qmk/qmk_firmware/issues/2514#issuecomment-384847485
2018-09-17 14:38:06 -07:00
Joe Wasson
743449472e Make PREVENT_STUCK_MODIFIERS the default (#3107)
* Remove chording as it is not documented, not used, and needs work.

* Make Leader Key an optional feature.

* Switch from `PREVENT_STUCK_MODIFIERS` to `STRICT_LAYER_RELEASE`

* Remove `#define PREVENT_STUCK_MODIFIERS` from keymaps.
2018-09-17 13:48:02 -04:00
James Laird-Wah
b1f11636c6 docs/contributing: add #pragma once to Coding Conventions
This supersedes the older include guard mechanism since all the
compilers now support it. It's easier for new users and less prone
to error.
2018-09-15 09:37:06 -07:00
MechMerlin
170de1273c Add an easy way to create new keymaps for your favorite keyboard (#3868)
* initial commit of keymap creation script

* create default keymap

* pass shellcheck

* provide a better usage message

* change printf string to more accurately reflect the path

* make it more easily understood

* found another typo

* add documentation regarding the new_keymap script

* enforce lowercase for userinputs
2018-09-13 11:22:05 -07:00
Takeshi ISHII
6d6d91c834 rgblight.[ch] more configurable (#3582)
* add temporary test code rgblight-macro-test1.[ch]

* rgblight.h : mode auto numberring and auto generate mode name symbol

No change in build result.

* rgblight.c use RGBLIGHT_MODE_xxx symbols

No change in build result.

* quantum.c use RGBLIGHT_MODE_xxx symbols

No change in build result.

* fix build break. when RGB_MATRIX_ENABLE defined

* add temporary test code rgblight-macro-test2.[ch]

* modify rgblight_mode_eeprom_helper() and rgblight_sethsv_eeprom_helper()

* modify rgblight_task()

* configurable each effect compile on/off in config.h

* update docs/feature_rgblight.md

* fix conflict. docs/feature_rgblight.md

* remove temporary test code rgblight-macro-test*.[ch]

* fix comment typo.

* remove old mode number from comment

* update docs/feature_rgblight.md about effect mode

* Revert "update docs/feature_rgblight.md about effect mode"

This reverts commit 43890663fcc9dda1899df7a37d382fc38b1a6d6d.

* some change docs/feature_rgblight.md

* fix typo

* docs/feature_rgblight.md update: revise mode number table
2018-09-13 10:24:09 -07:00
yiancar
73a3399d0e Add the ability to disable the USB startup check for Chibios
- Added support for NO_USB_STARTUP_CHECK. This allows the keyboard do function and not get stuck in a SUSPENDED state loop in case of no USB connection.
- Added support for WAIT_FOR_USB. In LUFA no keyboard has this flag enable therefor no keyboard waits for usb to be active.
- Added documentation for both configuration flags as they were missing.
2018-09-05 09:42:04 -04:00
fauxpark
ce3ccd3f4a Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs (#3799) 2018-08-30 09:37:05 -07:00
fauxpark
1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" 2018-08-30 07:39:58 -04:00
arlenk
4cd4e1ded6 Docs: add process_terminal() and update links to other functions (#3778)
* add process_terminal() and update links to other functions

* convert links to permalinks and add a few missing process_* functions

* update links in main text as well
2018-08-29 18:20:41 -07:00
fauxpark
097f1a299f Mask off keycode/layer/mod where possible in LT(), MT(), etc. (#3430)
* Mask off keycode/layer/mod where possible in LT(), MT(), etc.

* Don't need these parentheses

* Put back parentheses for order of operations
2018-08-29 21:05:02 -04:00
Alex Ong
a55c838961
Added bold in a few areas. 2018-08-29 10:49:53 +10:00
Alex Ong
e8e6268765
Fixed missing whitespace in debounce documentation
Table wasn't working due to missing newline.
2018-08-29 10:48:11 +10:00
Alex Ong
4db27a2c76 Changed order of rules in TMK. Documented feature. 2018-08-29 10:45:53 +10:00
Evan Travers
08c682c193 Docs: Add docs for the LAYOUT_* macro to layouts (#3772)
When moving my planck layout to my let's split, I ran into this issue
because I had copied my planck layout from the default layout which just
used the `{}` array form for the keymap layers. I checked the docs, but
this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on
discord, but this seemed to be the logical place to add a helpful hint.
2018-08-28 17:35:24 -07:00
yiancar
fdd0f91527 ISSI31FL3733 driver (#3679)
* ISSI31FL3733 driver

- Addapted IS31 driver for the above driver

* fix my branch

* ISSI31FL3733 driver

- Inclusion of above ISSI led driver

* IS31fl3733 driver

- Added correct function for control registers

* Finalized support for ISSI31fl3733 led driver

- Finalized and tested driver.
- Modified i2c_master for arm due to declaration mistake.
- Fixed spaces/tabs in quantum.h file.
- Fixed spaces/tabs in common_features.mk file.
- Removed unnecessary includes from rgb_matrix.c file.
- Added local definitions for MIN and MAX macros in rgb_matrix.c file.
- Adjusted chevron effect.
- Added necessary define (RGB_3733_MATRIX_ENABLE) for makefile.
- Added necessary C define (ISSI3733) to aid with inclusion of the correct header file.
- Added documentation for the new driver.

* Driver structure update

- Changed rule includes to be more condensed (RGB_MATRIX_ENABLE = IS31FL3731) and (RGB_MATRIX_ENABLE = IS31FL3733)
- Updated documentation
- Reverted to the use of differently named functions for each driver and selecting the needed ones within rgb_matrix.c

* ISSI Drivers refractoring

- Moved issi drivers in a dedicated folder
- Updated documentation

* I2C library fix

I released the special pins incorrectly before. It is now fixed.
2018-08-28 09:03:11 -04:00
Drashna Jaelre
eb19fb5b57 Helpful functions 2018-08-26 07:32:15 -07:00
skullY
da24a34efb First pass at reorganizing docs 2018-08-16 09:16:05 -07:00
zgtm
bfc9aa66f9 Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660) 2018-08-15 09:48:14 -07:00
skullydazed
09759c20ae Document FIRMWARE_FORMAT (#3631) 2018-08-11 23:02:06 -07:00
fauxpark
2a49832db3 Update FAQ section on power keys 2018-08-11 14:30:53 -07:00
fauxpark
d263b27c9a Dedupe shifted keycodes listing 2018-08-11 14:29:53 -07:00
yiancar
435e9b7bdb RGB Driver Documentation Update (#3601)
- Minor formating in rgb matrix page
- Added a short discription for is31fl3731 in drivers page
2018-08-09 17:41:48 -07:00
wanleg
fd085837e1 fix swap_hands keycodes in documentation (#3588) 2018-08-07 14:20:29 -07:00
fauxpark
d8e6ada5d7 Improve RGB lighting documentation (#3580) 2018-08-07 09:07:19 -07:00
fauxpark
f6ec2ce201 Update Shifted keycodes docs (#3575) 2018-08-05 08:55:53 -07:00
fauxpark
e818b29879 Update FAQ section on Apple Fn (#3574) 2018-08-05 08:51:33 -07:00
fauxpark
435a1202e7 More improvements to keycode docs (#3567)
* Reorder keycode list docs according to HID usage

* Add missing keycodes/descriptions/aliases
2018-08-04 09:09:22 -07:00
Jack Humbert
ac46378ac6
Update ISP flashing guide with pre-compiled binary (#3217)
* update flashing guide with pre-compiled binary

* Add files via upload

* Update isp_flashing_guide.md

* update file and instructions

* update instructions
2018-08-02 23:07:33 -04:00
fauxpark
03ad6927cb Docs: Format Space Cadet documentation (#3540)
* Format Space Cadet documentation

* Fix page filenames

* Move Caveats section up
2018-08-01 08:43:54 -07:00
fauxpark
c11a26ba54 Docs: Format Key Lock documentation (#3538) 2018-07-31 18:07:50 -07:00
Emmanuel Odongo
bb86d8a00c Docs: Fix some minor errors in tap dance example (#3530)
* Fix some minor errors in tap dance example

Fix for #3529
Fix minor errors in the code examples for __Example 4: 'Quad Function Tap-Dance'__ and relevant documentation. 
Clarified the need to include the header file in `keymap.c`.

* Use #pragma once in header guard

Fix for #3529
Implement change requested in #3530
2018-07-31 17:50:02 -07:00
fauxpark
2bc34b09cd Docs: Format Grave Escape documentation (#3536) 2018-07-31 17:40:55 -07:00
fauxpark
9b7a3a0bc8 Docs: Add Usage section to backlight docs (#3537) 2018-07-31 17:40:09 -07:00
fauxpark
98fa82ceef Backlighting docs (#3526)
* Some words about backlighting

* Link to RGB feature pages
2018-07-30 23:22:52 -07:00
fauxpark
25d757284c Docs: Fix Command docs escaping (#3523) 2018-07-29 21:08:59 -07:00
Evan Travers
6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 2018-07-29 08:59:39 -07:00
fauxpark
f2ebafcee8 Docs: Make Bootmagic and Command docs a little easier to read (#3499)
* Make Bootmagic and Command docs a little easier to read

* Sometimes Bootmagic/Command is default on

* "Escape" pipe character so it renders correctly
2018-07-29 08:42:51 -07:00
Evan Travers
bd874b9577 Docs: Clarify "right" -> "right-handed" (#3507)
I couldn't understand this sentence at first owing to the confusion
between right meaning "correct," and right meaning "right-handed."
2018-07-26 18:07:24 -07:00
Bruno Fagundez
9fc7bb1f6a Docs: Fixed the link to the advanced keycodes wiki (#3505) 2018-07-26 17:37:24 -07:00
Drashna Jaelre
4df6b7ba19 Fix for the Split Common I2C code's SCL_CLOCK issue (#3474)
* Fix the SLC_CLOCK setting for the Split Common code

Make the SCL_CLOCK setting configurable per board, since some use different settings
And change the Iris  to use 100000L instead of 400000L

* Add SCL_CLOCK variable to documentation

* Change SCL_CLOCK default to 100000L
2018-07-25 08:26:10 -07:00
Fredric Silberberg
e9755521ab Update README with rules.mk ordering information. 2018-07-17 00:10:42 -04:00
That-Canadian
0fab3bbde3 Lets split eh (#3120)
* Line ending stuff again

* Added Let's Split Eh? Files and updated #USE_IC2 checks to also include th EH revision (can only be used in I2C)

* Added personal keymap, updated some of the EH files

* Created new keyboard file for testing "lets_split_eh" will merge into lets_split once fully functional

* Added split code from lets_split, removed pro micro imports and LED code

THIS IS WORKING CODE, WITHOUT RGB AND BACKLIGHT

* Took back original Lets Slit files for the lets_split keyboard, working in the lets_split_eh folder for now

* Updated eh.c

* More rework of the I2C code, added global flags for split boards.

* Introduced RGB over I2C, having weird edge case issues at the moment though

* Fixed weird I2C edgecase with RGB, although still would like to track down route cause..

* Changed RGB keycodes (static ones) to activate on key-up instead of key-down to elimate weird ghosting issue over I2C

* Lots of changes, mainly externalized the Split keyboard code and added logic for only including when needed.

- Added makefile option "SPLIT_KEYBOARD" that when = yes will include the split keyboard files and custom matrix
- Split keyboard files placed into quantum/split_common/
- Added define option for config files "SPLIT_HAND_PIN" FOr using high/low pin to determine handedness, low = right hand, high = left hand
- Cleaned up split logic for RGB and Backlight so it is only exectuted / included when needed

* Updated documentation for the new makefile options and #defines specific to split keyboards

* Added a bit more info to docs, so people aren't confused

* Modifed Let's Split to use externalized code, also added left and right hand eeprom files to the split_common folder

* Removed some debugging from eh.c

* Small changes to keyboard configs. Also added a default keymap (just a copy of my that_canadian keymap).

* Added a README file to the Let's Split Eh?

* Changed it so RGB static updates are done on key-up ONLY for split boards rather than all boards. Also fixed leftover un-used variable in rgblight.c

* Updated default keymap and my keymap for Let's Split Eh? Updated the comments so it reflects RGB control, and removed audio functions.

* Fixed lets_split_eh not having a default version

* Removed "eh" references from lets_split folder for now

* Took lets_split folder from master to fix travis build errors, weird my local was overriding.

* Changed LAYOUT_ortho_4x12_kc -> LAYOUT_kc_ortho_4x12 to match bakingpy and others

* Removed rules.mk from my lets_split keymap, not needed

* Updated the config_options doc to better explain the usage of "#define SPLIT_HAND_PIN"
2018-07-16 22:25:02 -04:00
Drashna Jaelre
e0c9cfad86 Fix sidebard doc 2018-07-16 21:04:12 -04:00
Evan Travers
f2fcffab0d Docs: Adjust prompt to be more recognizable (#3417) 2018-07-15 21:23:22 -07:00
Drashna Jaelre
8ffeaec3aa Overhaul to keycode related docs
* Adds Audio Keycodes to both the feature page and master list
* Re-orders the keycode list, so it's alphabetical (mostly)
* Add additional (missing) sections to the keycode list
* Add and update links in the keycode page
* Add and reorder links in sidebar's keycode section
2018-07-15 13:40:18 -04:00
Max Audron
bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209)
* integrated Peter Fleury's LCD library for HD44780 LCDs

* fixed typo

* cleanup finished

* add documentation

* added HD44780 documentation

* removed keyboard from .gitmodules

* resolved merge conflict

* removed edit of kira75s rules.mk made by merge

* moved hd44780 to drivers/avr

* Added licence info to hd44780 files

* Added link to hd44780 docs.
2018-07-15 13:31:45 -04:00
Evan Travers
c5c112ae29 Update config.h boilerplate to use #pragma once
According to @fredizzimo, this is a safer and easier way to handle the
boilerplate.
2018-07-15 13:21:20 -04:00
Evan Travers
3d7bfae232 Add Userspace mention
@drashna mentioned it'd be good to have a mention of the userspace in
the QMK structure section. Rather than rewrite the docs on userspace, I
chose to link to the existing documentation.
2018-07-15 13:21:20 -04:00
Evan Travers
b666921e25 Reword the config.h section
This section didn't include the possibility of a user `config.h`, and it
wasn't clear exactly how the settings override works.
2018-07-15 13:21:20 -04:00
Evan Travers
b4f4576631 Update docs: Makefile -> rules.mk
I think this was a typo, or perhaps an older way to handle it.
2018-07-15 13:21:20 -04:00
KeLorean
c7b8e45ba1 Docs: add resources for git (#3390)
* add resources for git

* add more resources
2018-07-13 08:52:15 -07:00
Fred Silberberg
48913153c3 Replace gitter links with Discord. (#3368) 2018-07-11 00:01:56 -07:00
Evan Travers
0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337)
If you run `brew install avr-gcc`, you get a version that has
compatibility issues with LUFA. I updated the getting started guide for
osx, the qmk_install setup script, and added a section to the FAQ for
folks like me who accidentally updated avr-gcc past 7.
2018-07-07 17:37:37 -07:00
Nicolas Schodet
7fef5ca240 Add documentation for TAPPING_FORCE_HOLD (#2957) (#3320)
Also improve documentation for related settings.
2018-07-06 08:12:46 -07:00
yiancar
a7df902734 Addition of hard brigtness limit for RGB_Matrix (#3299)
* Addition of hard brigtness limit for RGB_Matrix

- Added a define "RGB_MATRIX_MAXIMUM_BRIGHTNESS" to enable hard limiting the maximum brightness for rgb_matrix
- Used the above define to limit the maximum brigthness of HS60 for better stability

* Added docs for new rgb_matrix define

* Addition of check for maximum brightness
2018-07-03 12:52:04 -04:00
fauxpark
6590f3c811 Clean up SEND_STRING keycodes and add media keys (#3214)
* Clean up SEND_STRING keycodes and add media keys

* Remove stray define

* Add missing SEND_STRING keycodes for completeness

Also, add KC_EJCT to the keycode references
2018-06-28 08:55:04 -04:00
Takeshi ISHII
5229734647 Add rgblight mode 35 (R,G,B test mode) (#3114)
* add rgblight mode 35 (RGB cyclic mode) into quantum/rgblight.c

* Update docs, add rgblight mode 35(RGB cyclic)

* rename RGBCYCLIC to RGBTEST
2018-06-04 08:10:39 -07:00
Drashna Jaelre
cb91320d6d Add Suspend functions (#3112)
* 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-06-03 17:57:35 -04:00
Dan Hertz
9fb1e5d171 Remove bootloader key as it is no longer used (#3093) 2018-06-01 12:26:48 -07:00
Drashna Jaelre
751719e6cb Add and fix _noeeprom functions to many of the RGB Underglow functions (#3070)
* And and fix _noeeprom functions to many of the RGB Underglow functions

* Many functions are unnecessarily calling the eeprom write code. The toggle/enable is command is especially guilty of this, as it writes to EEPROM 3 times.  But rgb mode writes twice, every time it's called. And init resets the rgb eeprom range and then writes back to it twice!
* Fixed the rgblight_sethsv_noeeprom to work as expected, by moving a lot of the code to a helper function.
* Added a noeeprom function for mode, enable, disable, and toggle functions. (didn't bother for increase/decrease stuff, and didn't add new keycodes)
* Add to predefined colors list
* Add new functions to manual/docs

* Update RGB Sleep feature to use _noeeprom

Because that's exactly what it should be doing, actually!
2018-05-29 11:05:22 -04:00
arlenk
a87b36d791 fix a few simple typos (#3068)
* Update feature_tap_dance.md

* minor typos
2018-05-28 20:23:33 -07:00
Leo Wzukw
3b1ddd12a5 Refresh & improve leader documentation page (#2990)
* Refresh & improve leader documentation page

- register_code/unregister_code are not the recommanded way to do macro.
- Provide some details I wish I had found when first used the leader
  functionality.

* Add old way to use macro.
2018-05-26 11:29:02 -07:00
Alexander Dang-Tran
73ddb764cc Fix readme and contributing hyperlinks 2018-05-24 00:00:20 -04:00
yiancar
470c50ddb6 Update documentation for rgb matrix (#3023)
* Update documentation for rgb matrix

- Updated keycodes.md to include RGB matrix keycodes + necessary link
2018-05-22 14:18:40 -07:00
GreenShadowMaker
06b3637266 added some helpful notes to the documentation (#2981) 2018-05-22 12:48:33 -07:00
Jack Humbert
4d26137e2a Create CNAME 2018-05-21 16:29:37 -04:00
Drashna Jaelre
9f2bb11412 Make sure new features (RGB Matrix) are actually listed 2018-05-15 22:35:17 -04:00
Chris Fung
7d49a17781 override hamburger placement 2018-05-14 08:56:41 -07:00
Drashna Jaelre
bfb5922f87 List all Tap Dancing functions (#2945)
* List all Tap Dancing functions

* Spelling, which drashna can't do apparently
2018-05-14 10:17:50 -04:00
yiancar
c89565cc3d General RGB matrix fixes (#2931)
* Added Modular keyboards L,R and NUM

Created code modules for the 3 modules of the modular keyboard.
Original idea by MechboardsUK. Uses i2c implementation similar to lets
split

* Remove modular from master

This is to fix incorrect branching

* General fixes for RGB_matrix

- Complited speed support for all effects
- Fixed raindrop effects to initialized after toggle
- Fixed raindrop effects to use all available LEDs
- Fixed effect step reverse function
- Moved RGB_MATRIX_SOLID_REACTIVE under correct flag

* Documentation update for RGBmatrix

* More doc updates
2018-05-10 00:31:24 -04:00
Mikkel Jeppesen
00596d55e3 Added propper support for Lets split vitamins (#2559)
* Added support for the upcomming Lets_split vitamins included

* Updated readme

* Corrected header of readme

* Enabled RGB

* Broke everything

* broke some more shit

* Revert "broke some more shit"

This reverts commit 6ad68e6269cc0d04c16564ce9598dfd3db1e23c1.

* Revert "Broke everything"

This reverts commit feeee4e40db15a726f2292b6a9406ef45c1e54a7.

* Fixed USB detection, and RGB on slave

* started modifying readme, to use msys2

* Added support for the upcomming Lets_split vitamins included

* Updated readme

* Corrected header of readme

* Enabled RGB

* Broke everything

* broke some more shit

* Revert "broke some more shit"

This reverts commit 6ad68e6269cc0d04c16564ce9598dfd3db1e23c1.

* Revert "Broke everything"

This reverts commit feeee4e40db15a726f2292b6a9406ef45c1e54a7.

* Fixed USB detection, and RGB on slave

* started modifying readme, to use msys2

* Updated readme to reflect use of msys2 Added avrdude to msys path

* added avrdude option to msys installer

* Removed extra installation of avrdude

* Renamed to vitamins_included and implemented drashnas changes

* Fixed include guard

* Fixed some includes, and added avrdude target to docs.

* Fixed default keyboard
2018-05-09 09:14:30 -07:00
Jack Humbert
6ba73e0e04 update doc options 2018-05-09 00:59:07 -04:00
yiancar
afacd42368 Add effect speed support for RGB Matrix *No EEPROM yet* (#2922)
* Added Modular keyboards L,R and NUM

Created code modules for the 3 modules of the modular keyboard.
Original idea by MechboardsUK. Uses i2c implementation similar to lets
split

* Remove modular from master

This is to fix incorrect branching

* Add effect speed support for RGB Matrix *No eeprom yet*

Keycodes RGB_SPI and RGB_SPD have been added to increase and decrease effect speed.

Speed is not saved in EEPROM yet as per Jack's request.

* Update rgb_matrix.c

* RGB Matrix speed fix rgblight.h

* More fixes for rgb speed. Speed functions declared but not used in rgblight

* More travis fixes..

* Another one for travis..
2018-05-08 23:23:21 -04:00
Jack Humbert
c6ea96ab43 Merge branch 'master' of github.com:qmk/qmk_firmware 2018-05-08 17:19:42 -04:00
Jack Humbert
63d5c947d3 updated music mask 2018-05-08 17:18:15 -04:00
skullY
466ee76423 switch to the vue theme and add search 2018-05-08 12:47:08 -07:00
Jack Humbert
14b7602a65
Adds IS31FL3731 RGB Matrix Implementation (#2910)
* adds is31fl3731 rgb matrix implementation

* fix build script for force pushes

* allow bootloader size to be overwritten

* adds planck light implementation

* split led config into 2 arrays

* idk

* betterize register handling

* update planck implementation

* update planck

* refine rgb interface

* cleanup names, rgb matrix

* start documentation

* finish up docs

* add effects list

* clean-up merge

* add RGB_MATRIX_SKIP_FRAMES

* add support for at90usb1286 to bootloader options
2018-05-08 15:24:18 -04:00
skullY
ccc87421e7 Some more tweaks to make everything look nice 2018-05-07 23:42:41 -07:00
skullY
303f425c6b Fix up info boxes. 2018-05-07 22:46:26 -07:00
skullY
9e5676650e Use docsfy to replace gitbook 2018-05-07 22:46:26 -07:00
Daniel Gordon
e6be4484e9 Update to tap dance docs (#2895)
* Added more comments
    * Documentation for 'quad function' tap dance now suggests to use the
      user's directory, and explains how to do so.
2018-05-04 10:39:57 -07:00
Charles Pletcher
9b91789193 Add dilly/pletcher layout (#2880)
* Add pletcher keymap to dilly/keymaps

For the moment, this keymap just removes unneeded RGB keycodes, since
an iPad will cut the keyboard off if LEDs are turned on.

* Drop support for A_RSFT, add media and autoshift

* Lower USB_MAX_POWER_CONSUMPTION for dilly on iPad

* Document USB_MAX_POWER_CONSUMPTION

This config option is useful for limiting the requested power by, e.g.,
an iOS device. While the default value is 500, a much lower value--say,
50--can sufficiently power a small keyboard without LEDs.
2018-05-02 18:35:16 -07:00
M1K
5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855)
* Implemented Terminal + added song to song_list.h

* Added wait() in order to prevent misbehaviour of 'command not found'
2018-05-01 13:39:46 -04:00
Joe Wasson
5ca9aecfb4 Talljoe's layout with common keymap. (#2764)
* Add userspace to talljoe layout.

* Move more authority to userspace and create Bananasplit layout.

* Move more things into userspace.

* Common Core example

* More work on common layout.

* Num layer.

* talljoe-ansi layout

* Updates for Zeal60

* Add Zeal60 to 60_ansi_split_bs_rshift

* Swap Escape and Grave

* Num-layer tweaks

* More tweaks.

* Add 1up60rgb to world of layouts.

* Rename ansi_split_bs_rshift layout to hhkb.

* Control RGB Backlight.

* change capslock led

* Remove obsolete line from rules.mk.

* Add user-friendly userspace override.

* Fix enter for 1uprgb60

* Revert "Rename ansi_split_bs_rshift layout to hhkb."

This reverts commit 53133719db25c7cb6a199108bbf5d980481a45f4.
2018-04-21 10:48:30 -07:00
Mike Kozlowski
d1c3419d2a Rework layer function docs (#2656)
* Rework layer function docs

* Update per PR feedback
2018-04-21 09:21:46 -07:00
bjacques
e36d6bbbe3 Update feature_tap_dance.md (#2643) 2018-04-21 00:43:36 -07:00
Joe Wasson
5226e4c79b Correct documentation for PREVENT_STUCK_MODIFIERS 2018-04-19 01:52:34 -04:00
Drashna Jaelre
8b0b17a369 Add Faux Clicking as subset of Audio feature (#2748)
* Add Faux Clicky to main Audio feature

* Make clicky settings user configurable

* Add additional documentation

* Don't play when music mode is enabled (hopefully)
2018-04-19 01:47:04 -04:00
internetirl
a7fca47686 Link to Atmel's flip is broken. (#2752)
The link to Atmel's flip is broken. It re-directs to http://www.microchip.com/. Please update!

I think this is the correct link. Please verify.

http://www.microchip.com/developmenttools/productdetails.aspx?partno=flip
2018-04-18 22:21:36 -04:00
Kevin Foley
cdb967f22b Fix link to command page 2018-04-15 11:53:31 -04:00
Michael L. Walker
22215a0e92 Added support for audio using pins C4, C5, B6, B7 2018-04-12 13:14:48 -04:00
skullydazed
3b525dcf9c
Remove obsolete info.json entries (#2712) 2018-04-07 17:37:31 -07:00
Seebs
c0baf2a964 Improve state/chord handling and clean up namespace
Some values that can never, ever, change were held in local
variables, rather than in PROGMEM. Fixed.

Change "pressed" to a signed int so the test for < 0 makes
sense, and to avoid possible weird failure modes in the
case where a key release comes in when pressed is already
zero. (Shouldn't happen, sure, but computers are weird.)

A lot of things in process_steno had external linkage for no
particular reason. They've been marked static. Stuff still
builds.

Distinguish between currently-held keys and keys that have
been held, and expose these values through a nicely-named API
so other code could, say, check on the current set of steno
chording in order to make displays. Also in passing fix up the
"state" value having external linkage so it could clash with
other people's variable declarations.

The API also provides hooks for key processing and steno chord
events, so you can monitor those events without having to
run in matrix_scan_user and recheck the values directly. Also
document these.

There is no path through processing a key that doesn't
end with a return false, so the nested return foo() are
gone and we just return false.
2018-04-07 17:12:44 -04:00
Drashna Jaelre
162a67cbc5 Add userspace config.h handling to build script (#2640)
* Add userspace 'config.h' file

* Add more robust docs

* Remove config.h code from drashna userspace

* Spelling error

* Include links to Config Options page

* Remove config.h documentation from userspace doc, as it's no longer needed
2018-04-01 00:02:40 -04:00
Mike Kozlowski
cc323df9ba Fix broken Markdown (#2652)
Fix links in Keyboard Guidelines page
2018-03-31 20:54:01 -07:00
U-LANDSRAAD\drashna
331288233d Add rgblist to docs 2018-03-28 16:55:58 -04:00
Jack Humbert
ae7284edb8 rename api docs to internals 2018-03-26 11:43:37 -07:00
Drashna Jaelre
ee1bb85542 Expand Newb Guide flashing document (#2588)
* Add header info

* Add DFU section

* Add Caterina section

* Add Halfkay section

* Fix Typos

* More typos
2018-03-26 13:34:18 -04:00
Drashna Jaelre
07b90db897 Fixes and updates to docs (#2611)
* Fix advanced keycode headers

* Add caveat for OSM over Remote Desktop

* Hopefully add better anchors to docs

* Add Action code list reference

* Formatting of RGB Underglow doc

* Add brew update issue on macOS

* Revert formatting

* Revert RGB doc formatting

* Make Config Options doc's sections linkable
2018-03-25 16:44:17 -07:00
U-LANDSRAAD\drashna
d965d72d4a Fix custom functions documation for layer_state_set* 2018-03-24 12:49:56 -04:00
Daniel Hoek
3ee59a79aa Add HSV value specification (#2481)
* Update feature_rgblight.md

I got caught out with this as most color pickers use a percentage NOT 0-255 for this number

* Amended description

Woops! Was focused on s/v not being a percentage i got h wrong.
2018-03-23 16:10:32 -07:00
Andrew Macpherson
d0054c41e2 Fix typo in autoshift docs: statn (#2579) 2018-03-23 16:03:19 -07:00
skullydazed
7c9d5ace14 Generate API docs from source code comments (#2491)
* Generate api docs from source code

* Add a bunch of doxygen comments

* more doxygen comments

* Add the in-progress api docs

* script to generate docs from travis

* Add doc generation to the travis job

* make travis_docs.sh commit the work it does

* make sure the docs script exits cleanly
2018-03-22 02:50:38 -04:00
snyman
7a5ce36f23 Add macro for momentarily switching to a layer while some mods are active (#2460)
* Macro for a momentary layer switch with mods

Passes through to the existing ACTION_LAYER_MODS macro, albeit with more
limited options due to lack of space in the quantum_keycodes enum.

* Add documentation for LM layer-mod macro

* Clean up Tap Toggle documentation
2018-03-20 22:59:54 -04:00
Merlin04
6d66fe0c0c Added bootloader options
I think I got all of them, so I removed the "FIXME".
2018-03-20 11:47:22 -04:00
Drashna Jaelre
ff728a8a01 [Proposal?] Allow RGB Underglow to turn off when host is idle/asleep (#2104)
* Add RGB Underglow Sleeping

* Add RGBLIGHT_SLEEP to toggle/control RGB light behavior

* Update rgb docs

* Update for RGB disable command
2018-03-19 23:59:58 -04:00
Jason Stillwell
00b4dce605 Rule to enable Modifiers with Auto-Shift (#2542)
* Re-enable modifiers with auto-shift

* Auto-shift modifiers rule

* missed a line

* Documentation

* fixing whitespace
2018-03-16 16:41:01 -04:00
fauxpark
a2e12faa19 Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc. 2018-03-16 16:37:44 -04:00
Joe Wasson
23ac2a02ef Add keycodes for swap-hands feature. 2018-03-16 16:33:43 -04:00
Joe Wasson
7230923b05 Rename ONEHAND_ENABLE to SWAP_HANDS_ENABLE for consistency 2018-03-16 16:33:43 -04:00
Drashna Jael're
3f1d147529 Add SS_RALT for AltGR usage in macros 2018-03-09 13:15:10 -05:00
skullydazed
566399794a
Disable the glossary linking to fix #2498 (#2499) 2018-03-08 10:31:08 -08:00
U-LANDSRAAD\drashna
42e85d2b92 Add layer_state_set_* to custom function lists 2018-03-07 17:05:38 -05:00
U-LANDSRAAD\drashna
d27d854913 Examples should all use _user functions for consistency 2018-03-07 17:05:38 -05:00
Joe Wasson
7b80aea8b2 Add back docs for hand-swapping feature. 2018-03-07 16:56:57 -05:00
skullY
48e11240a6 Move the linux tutorials to an info box on newbs_getting_started 2018-03-06 20:51:26 -08:00
skullY
75354f12d7 warn->danger 2018-03-06 15:39:46 -08:00
skullY
6a4e08938e Flesh out the newbs guide 2018-03-06 15:22:47 -08:00
skullydazed
08e48eb6f5
Add a newbie guide for people completely new to QMK (#2480) 2018-03-06 14:37:48 -08:00
Graham P Heath
b36b4382d0 Mention invalid names in the readme. (#2458) 2018-03-03 09:52:09 -08:00
skullydazed
e87c39d302
More thoroughly document Bootmagic and Command (#2455) 2018-03-02 09:21:03 -08:00
Mitchell van Manen
31cae1f1bd Update feature_macros.md (#2387)
break statements are never reached due to the return statement, so unnecessary
2018-03-01 08:05:15 -08:00
fauxpark
b713feb6f2 Add a little aside explaining that shifted keys with mod-tap doesn't work (#2446) 2018-03-01 07:49:50 -08:00
Brian Choromanski
7f7f763598 Fixed dead links (#2451)
* Fixed typo of 'confid.h' to 'config.h'

* Fixed broken links in docs

* Fixed a lot of dead links
2018-03-01 07:45:47 -08:00
Brian Choromanski
8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448)
* Fixed typo of 'confid.h' to 'config.h'

* Fixed broken links in docs
2018-02-28 16:43:15 -05:00
Yan-Fa Li
a8daf3ffba Document bootmagic hot keys
- covers most of tmk_core/common/bootmagic.h
2018-02-23 13:14:53 -05:00
ferbie
767f7a8cf0 Fixed formatting for Fedora example 2018-02-23 13:13:30 -05:00
Jose Pablo Mora
d54de1c5f2 ergobox -> ergodox 2018-02-23 13:11:31 -05:00
Ben Hilburn
8df2ee4ec3 Minor updates to docs (#2406)
* [docs/] Cleaning up some language to make it more clear.

* [docs/] Adding instructions for installing deps on RH / Fedora.
2018-02-19 14:09:05 -05:00
Gomme_Bidule
63df056013 Update feature_auto_shift.md 2018-02-12 15:45:54 -05:00
Drashna Jaelre
6835ae8209 Add the ability to disable Music Mode completely (#2339)
* Skip process_music in NO_MUSIC_MODE is defined

* Skip matrix_scan_music if NO_MUSIC_MODE is defined

* Skip music_all_notes_off if NO_MUSIC_MODE is defined

* Leave matrix_scan_music in, because it reduces firmware size by 150b....

* Add docs for NO_MUSIC_MODE
2018-02-08 15:16:06 -05:00
skullY
2018df1a61 Clarify the format for layout names 2018-01-19 11:58:19 -08:00
fauxpark
4764e77121 Clarify that we actually have max 16 total backlight levels 2018-01-12 12:52:35 -05:00
fauxpark
cfcf0fd36b Remove reference to BL_x in keycodes.md, and add BL_BRTG 2018-01-12 12:52:35 -05:00
YouCanFly
6c24e28b8d ADD RGBLIGHT_LIMIT_VAL (#2214) 2018-01-02 21:54:56 -05:00
Rickard von Essen
4beb5e72f8 macOS also requires avrdude 2018-01-02 14:07:10 -05:00
Balz Guenat
4931510ad3 backlight breathing overhaul (#2187)
* add breathing to bananasplit

* backlight breathing overhaul

* fix the backlight_tick thing.

* fix for vision_division backlight

* fix a few keymaps and probably break breathing for some weirdly set-up boards.

* remove BL_x keycodes because they made unreasonable assumptions

* some fixes for BL keycodes

* integer cie lightness scaling

* use cie lightness for non-breathing backlight and make breathing able to reach true max brightness
2018-01-01 17:47:51 -05:00
Drashna Jael're
4f484bc1c9 Add on/off/toggle keycodes for Auto Shift 2017-12-20 14:38:56 -05:00
Hugo Gayosso
d8f0faabda Fixed typo 2017-12-20 14:38:24 -05:00
kamisamamizu
eab41f7b38 Added default case to process_record_user
I tried using process_record_user and if I had to add the default case for it to compile.
2017-12-17 11:52:06 -05:00
Zach Richard
8a1e656099 new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) (#2100)
* new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!)

* corrected documentation to specify rules.mk file instead of Makefile
2017-12-14 00:20:44 -05:00
fauxpark
bb53635f33 Trim trailing whitespace 2017-12-09 10:46:11 -05:00
fauxpark
af37bb2f78 Fix some of the more obvious typos 2017-12-09 10:46:11 -05:00
fauxpark
4c675a83ba Format keycode tables 2017-12-09 10:46:11 -05:00
fauxpark
7b0356d1d4 Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
Balz Guenat
8b1862330a fix link for grave escape in docs 2017-12-08 16:12:46 -05:00
Colin T.A. Gray
16546ee06f Add 'rgblight_disable' and 'rgblight_setrgb_at/rgblight_sethsv_at'
Refactors rgblight_toggle to use rgblight_enable or rgblight_disable
Use 'rgblight_setrgb_at/rgblight_sethsv_at' to control an individual LED
2017-12-08 16:10:42 -05:00
Colin T.A. Gray
53b043d4ef adds 'RGB_RMOD' to go through RGB modes in reverse 2017-12-04 11:12:52 -08:00
Drashna Jaelre
7b51f050d7 Fix typo in make example
It has `:all" when it clearly is referencing the command without `:all`.
2017-12-04 11:17:53 -05:00
mmikeww
0740e84d63 update advanced_keycodes; oneshot = sticky/dead keys 2017-12-03 00:03:04 -05:00
mmikeww
c917888262 update glossary; oneshot key = sticky/dead key 2017-12-03 00:03:04 -05:00
skullY
0b54e7f5ae Flesh out the grave escape overrides 2017-12-03 00:00:23 -05:00
mmikeww
b9f426ae1e Fix broken link in docs
This link was broken. And the latest, live version of that keymap link doesn't line up with the docs below, so the link will now point to the older version of the file in the git history
2017-12-02 23:55:58 -05:00
Devin J. Pohly
7aaef16266 Fix internal links in docs/ (#2080)
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-11-30 10:18:01 -08:00
Drashna Jael're
28874a9f33 Fixed minor typo in bootloader code 2017-11-29 13:01:06 -05:00
Drashna Jael're
319ff649ab 16 byte optimization of macro ;) 2017-11-28 22:59:41 -05:00
Drashna Jael're
92f6d6ec02 Update Userspace info to include Bootloader detection 2017-11-27 23:36:55 -05:00
Jack Humbert
9fdc276260
Updates bootloader settings, adds file size check (#2029)
* pull fuse settings for bootloader jump

* fix 32a chips

* make automatic bootloader selection optional

* quantify bootloaders

* fixs #164, speeds up dfu reset

* fix for chips w/o usb

* missing an n

* fix bootloader sizes, use words for addresses

* fix bmini, pearl, and [[ issue, make things quiet

* ignore avr errors on arm for now

* update settings for the light

* document bootloader stuff

* add bootloader title
2017-11-27 23:08:21 -05:00
Jack Humbert
62eed0e4a3
Update config_options.md 2017-11-21 21:26:29 -05:00
Jack Humbert
c8bdc75e1d
Update feature_layouts.md 2017-11-21 21:22:56 -05:00
Seebs
39d3d92364 Allow multiple process_record() calls per scan
This is particularly relevant for, e.g., the ergodox EZ and
other keyboards with slow scan rates. Without changing the API or
behavior of individual process_record() calls, we allow a
configuration flag to make multiple calls in a single scan.

This will probably have miniscule effects on non-steno users,
and it's not enabled by default for any keyboards. Added note
about it to ergodox README.

Signed-off-by: seebs <seebs@seebs.net>
2017-11-21 00:20:52 -05:00
Gilbert Consellado
7ff96877d2 added SS_LSFT to featured macros 2017-11-20 12:25:42 -05:00
Balz Guenat
858c09f370 add example keymap 2017-11-16 09:39:00 -05:00
Balz Guenat
179d64d33c extend macro docs a bit 2017-11-16 09:39:00 -05:00
drashna
3c15c48e6a Add "KC_MAKE" to userspace example 2017-11-14 11:02:00 -05:00
James
309a400b3e Update hand_wire.md
Change "Resin" to "Rosin"
2017-11-13 18:48:55 -05:00
Erin Call
392121b10e Document the Teensy hardware reset problem 2017-11-12 11:51:12 -05:00
skullY
4df4fa7c26 Clarify KC_PWR vs KC_POWER. Fixes #1994. 2017-11-10 17:58:32 -05:00
skullY
66f13e4972 Move keycodes to their own section 2017-11-10 17:58:32 -05:00
Jack Humbert
bb11df6b7a update some docs 2017-11-09 16:19:13 -05:00
Zach Burchill
e236f1eba1 Fixed some grammar and typos on the docs (#1989)
* fixed grammar and references

* fixed typo
2017-11-09 16:18:31 -05:00
Fred Silberberg
89357b96d4 333fred layout update (#1971)
* Set up tap dance for layers on the lower button.

* Refactored code to share in the users directory between my two keyboard layouts.

* Small keyboard layout change.

* Updated documentation on oneshot usage in macros/tap dance.
2017-11-06 12:09:01 -05:00
Jeremy Cowgar
245b3376d6 Correct the rules.mk documentation for auto shift.
fixes #1965
2017-11-06 12:03:36 -05:00
skullY
535c2f60a9 use real greater than and less than chars 2017-11-02 16:27:17 -07:00
skullY
432674781a Document info.json files 2017-11-02 01:31:02 -07:00
skullY
4e41beeaa6 Fix a typo 2017-11-02 01:30:51 -07:00
Jack Humbert
00733f4b87 update contributing guidelines 2017-11-01 21:42:05 -04:00
Jack Humbert
d069a42c07
Update getting_started_github.md 2017-11-01 14:10:28 -04:00