History

Michael Richters cf5c19dd6c Standardize namespace block closing comments This standardizes namespace closing brackets for namespace blocks. Each one is on its own line, with a comment clearly marking which namespace it closes. Consecutive lines closing namespace blocks have no whitespace between them, but there is one blank line before and after a set of namespace block closing lines. To generate the namespace comments, I used clang-format, with `FixNamespaceComments: true`. But since clang-format can't exactly duplicate our astyle formatting, it made lots of other changes, too. To isolate the namespace comments from the other formatting changes, I first ran clang-format with `FixNamespaceComments: false`, committed those changes, then ran it again to generate the namespace comments. Then I stashed the namespace comments, reset `HEAD` to remove the other changes, applied the stashed namespace comments, and committed the results (after examining them and making a few minor adjustments by hand). Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>		3 years ago
..
src	Standardize namespace block closing comments	3 years ago
README.md	Cleanups for typos and broken links across the documentation	4 years ago
library.properties	More library tweaking to comply with arduino requirements	4 years ago

README.md

USB-Quirks

USB-Quirks provides a few methods to deal with more obscure parts of the USB spec, such as changing between Boot and Report protocols. These are in a separate plugin, because these features are not part of the USB spec, and are often workarounds for various issues. See the provided methods for more information about what they're useful for.

Using the plugin

#include <Kaleidoscope.h>
#include <Kaleidoscope-Macros.h>
#include <Kaleidoscope-USB-Quirks.h>

KALEIDOSCOPE_INIT_PLUGINS(USBQuirks, Macros);

const macro_t *macroAction(uint8_t macroIndex, uint8_t keyState) {
  if (macroIndex == 0) {
    USBQuirks.toggleKeyboardProtocol();
  }
  return MACRO_NONE;
}

void setup() {
  Kaleidoscope.setup();
}

Plugin methods

The plugin provides one object, USBQuirks, which provides the following method:

`.toggleKeyboardProtocol()`

Toggle between Boot and Report protocol by detaching, and then re-attaching the USB devices, and setting the BootKeyboard protocol in between.

This is most useful when one needs to have a boot keyboard, when one's in a BIOS, boot loader, or early password prompt or the like, and the host does not explicitly request the boot protocol for one reason or the other. With this toggle, we can switch between the two on-demand.