c13fea5705
Add section on physical keyswitch events
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
3 years ago
14dcc700e9
Add section on creating additional events
...
This fills out one of the missing sections of the plugin author's guide
document.
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
3 years ago
46bc0c5dca
Add NEWS.md entry for CharShift plugin
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
301acac9ad
Add NEWS and UPGRADING entries for OneShotMetaKeys
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
453b3a8807
Add plugin authors' guide document
...
This is a guide to writing a Kaleidoscope plugin, more or less written as a
tutorial. It is (obviously) incomplete, but even in its partially-complete
state, it's still probably useful.
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
64df6161a1
Correct broken links and typos in device-apis.md
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
72d4ac8124
Merge pull request #1036 from gedankenexperimenter/plugin/autoshift
...
Add AutoShift plugin
4 years ago
a1abdf0b83
Merge pull request #1037 from gedankenexperimenter/spacecadet-no-delay
...
Add SpaceCadet "no-delay" mode
4 years ago
dbeb915196
Add note about `afterReportingState()` to UPGRADING.md
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
92f2f582f1
Add `afterReportingState()` event handler function
...
This event handler is useful for plugins that need to react to events, but
should wait until after those events are fully processed before doing so. This
is useful for OneShot, which needs to keep keys active until after events that
trigger their release. The `afterEachCycle()` hook is unfortunately
insufficient for this purpose, because the same event could trigger multiple
plugins (e.g. TapDance & OneShot) to resolve events, and the OneShot should
apply only to the first ensuing report.
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
81bbdf843c
Add AutoShift plugin entry to NEWS.md
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
f039b375de
Add SpaceCadet "no-delay" mode to NEWS.md
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
6bdcd01080
Add glossary entries for LiveKeys special values
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
60567d3d50
Begin updates to UPGRADING document for KeyEvent API changes
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
2f7fbaa3fe
Add overview documentation of event handler hook functions
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
1f24088a69
Add documentation and examples for Qukeys tap-repeat feature
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
1a63ade706
Update documentation and example sketch
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
9d06843bd2
Update documentation for keyboard state array changes
...
Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>
4 years ago
fc1296395e
New hook: onNameQuery()
...
This implements a new `FocusSerial` command: `plugins`. The `plugins` command
will reply back with a list of plugins enabled in the firmware. The list is not
exhaustive, only plugins that opt-in to this mechanism will be listed. It is
opt-in, because for a lot of plugins, having them listed isn't useful in a
practical sense.
The goal with this feature is to allow Chrysalis to detect plugins that would
affect what keys it offers, or which additional settings it displays, and do so
in a consistent way. This is why IdleLEDs has an `onNameQuery` handler too, even
though it can be detected otherwise: for consistency.
Signed-off-by: Gergely Nagy <algernon@keyboard.io>
4 years ago
59bc793c30
Fetch arduino core indices before updating our cores
...
It is entirely unclear to me how this ever worked before.
4 years ago
ccaabbc0d4
Ignore the docs/plugins dir which hosts copied plugin docs at build time
4 years ago
589c2dd799
Get the two remaining files out of the plugins directory in docs to make it easier to ignore this dir
4 years ago
a2df72735d
Document git master kaleidoscope builds for the arduino boards manager
4 years ago
b3b56efdf8
Merge pull request #1002 from keyboardio/f/remove-deprecations
...
Remove stuff that was deprecated as of december 31
4 years ago
81ae19a7ec
Cleanups for typos and broken links across the documentation
4 years ago
706c15a381
Remove deprecated QuKeys functions on schedule
4 years ago
3bfd045065
Remove deprecated Key Masking system on schedule
4 years ago
3227a2dcf4
Remove deprecated Layer API functions as per the schedule
4 years ago
8f23161d19
Glossary updates for terms related to keymaps, layers, and keys.
...
@algernon and I have been hashing out a set of terminology over the past week. While this is still fairly incomplete, it is hopefully an improvement on the previous undocumented state of things.
4 years ago
e2bee6cace
Bring testing up a level and kill the "development tips" doc section
4 years ago
f1eec6ec55
examples now dosplay
4 years ago
f20fe20bb2
doc markup typo fix
4 years ago
67e6f6c042
try to remove the "edit on github" link on the rendered docs
4 years ago
21c4503a6b
Fix the other URL on the docs index page
4 years ago
5dbc6383c4
start to fix the hyperlinks on the first page of the docs
4 years ago
e6dd184d92
Reduce some image sizes in the docs to help make the bundle smaller
4 years ago
ec275c39dc
Add an 'upgrading' note about the plugin re-layout
4 years ago
33626a569f
Move most plugin READMEs back into the plugins
4 years ago
bb95ed1de0
Make it possible to have Plugin readmes in the plugin dirs
4 years ago
5f7168665a
Clarify that developers probably don't want to be using the Arduino IDE
4 years ago
54cae3365d
Extract Kaleidoscope-Ranges back to a plugin
4 years ago
d247f2aa6a
remove documentation about paths, snaps, and flatpaks that was not relevant to our quickstart
4 years ago
dfb710f705
Move key def sections into a subdirectory to make the codebase a bit cleaner.
...
These should never have been getting called directly by end-user code, although the URLs were referenced as a resource in docs.
4 years ago
16d918247a
Add a note about the new feature to UPGRADING
4 years ago
4c538f13ea
update classic Atreus docs for the arduino-cli world
4 years ago
6115305615
try to run the makefile from inside sphinx, which is hacky
4 years ago
cdba38c762
add a title to the testing docs
4 years ago
047a5b7c04
first pass at getting our examples into readthedocs
4 years ago
c8d53d2348
remove historical dangling bits from the quick start guide
...
Signed-off-by: Jesse Vincent <jesse@keyboard.io>
4 years ago
8b9db57957
Update TapDance documentation
...
The code example was using an outdated header for `tapDanceAction` that used `row` and `col`.
Updated to use `key_addr` instead.
Solution found in this forum reply: https://community.keyboard.io/t/status-of-using-tapdance-with-chrysalis/4143/5
Signed-off-by: Pedro Diogo <158898+PedroDiogo@users.noreply.github.com>
4 years ago
Michael Richters
Gergely Nagy
Gergely Nagy
Jesse Vincent
Pedro Diogo