keyboardio/chrysalis-api

Chrysalis low-level, backend API

chrysalis-api's Issues

keymap: Media Previous Track has wrong label

The label should be Track-, not Track.

keymap & colormap should auto-register their commands

The @chrysalis-api/keymap and @chrysalis-api/colormap "plugins" should automatically register themselves with @chrysalis-api/focus, now that it is a singleton.

Prepare the keymap widgets for colormap display too

The keymap widgets provided by the hardware plugins should support both labels and/or colors, depending on whether the keymap or colormap properties are set.

keymap: SpaceCadet keys are wrong

Unlike in QMK, we do not have a separate keycode for SpaceCadet keys, we override the normal shifts. The SpaceCadet keys in Ranges is for enable/disable, we should list them as such.

keymap: verbose labels should fit 1.75 keys

Lift out the standard key component

Currently the Atreus, the ErgoDox and the Planck all use slightly different versions of the same Key component. It should be lifted out into its own library, so it can be shared between all boards with standard key sizes.

Documentation should link back to the repo

The markdown documentation does not link back to the git repo. It would be much more convenient if it did.

This would also allow us to set the homepage to the docs hosted on GitHub pages.

The Model01 and Raise SVGs should be properly credited

While I did some work on them, their author is @TheBaronHimself, and should be properly credited for his beautiful work.

focus: Allow "plugins" to hook into / define global commands on Focus itself

Since both keymap and colormap have a .setLayerSize() method, and both take the same arguments, it would be neat if one could call focus.setLayerSize(), and have that dispatch to keymap & colormap (and whatever else is registered).

Add a generic ATMega Flip library

Similar to the Generic Teensy & Model01 Bootloader libs

Merge @chrysalis-api/keymap-transformer-core into keymap

At this point, there's no practical use for the transformer mechanism. Merge it into @chrysalis-api/keymap, and remove the transformer mechanism. It can always be reintroduced later on (though, probably in a different way).

Hardware libraries should have a preferredName entry or similar

Chrysalis currently uses ${vendor} ${product} to refer to hardware, but in some cases, we want something simpler, or different. Hardware libraries should therefore provide such an information. Something like .info.preferredName or .info.displayName, or something along those lines.

chrysalis-flash.js - the timeouts should be static variable with names, for clarity

Right now, they're just numbers floating in the coat, which feel hard to read and maintain

hardware/ergodox: Use verbose labels for wide keys

On wider keys, use the verbose labels, they'll fit (at least most of the time...).

Key labels should fit onto 1u keys

Move the repo to @keyboardio

The repository should be moved to the @keyboardio organisation, so that I can use the Projects set up there, and because most of the work is sponsored by Keyboard.io anyway.

Collect all the flashing in a separate library

Flashing largely depends on the application used, not on the board. Reimplementing the same flashing procedure for every board that uses the same flashing method would be a terrible idea.

For this reason, lets create @chrysalis-api/hardware-flash, and collect all the flashing there. Hardware libraries can then import the one they need, and call it from their flash methods.