alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Kaleidoscope Style Guide conformance

Browse Source 
Updated the code to conform to the latest style guide. And added a bit of
documentation too, while there.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/365/head
Gergely Nagy 8 years ago
parent 97008a28f0
commit ba6128dddc
4 changed files with 185 additions and 138 deletions
Show Stats Download Patch File Download Diff File

74
README.md
Unescape View File

@ -5,26 +5,54 @@
[travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap.svg?branch=master [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap.svg?branch=master
[travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-EEPROM-Keymap
[st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 [st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52
[st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 [st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52
[st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52
TODO While keyboards usually ship with a keymap programmed in, to be able to change
that keymap, without flashing new firmware, we need a way to place the keymap
into a place we can update at run-time, and which persists across reboots.
Fortunately, we have a bit of `EEPROM` on the keyboard, and can use it to store
either the full keymap (and saving space in the firmware then), or store an
overlay there. In the latter case, whenever there is a non-transparent key on
the overlay, we will use that instead of the keyboard default.
In short, this plugin allows us to change our keymaps, without having to compile
and flash new firmware. It does so through the use of the [Focus][plugin:focus]
plugin.
[plugin:focus]: https://github.com/keyboardio/Kaleidoscope-Focus
## Using the plugin ## Using the plugin
TODO Using the plugin is reasonably simple: after including the header, enable the
plugin, and let the `Layer` object know that we'll be using `EEPROMKeymap` to
figure out which keys to use. We can either use the `getKeyOverride` or the
`getKey` method, depending on whether we want to override, or fully replace the
built-in keymap. Then we need to set at most how many layers we want to store in
`EEPROM`, and that is about it.
We can then update the keymap via [Focus][plugin:focus].
```c++ ```c++
#include <Kaleidoscope.h> #include <Kaleidoscope.h>
#include <Kaleidoscope-EEPROM-Keymap.h> #include <Kaleidoscope-EEPROM-Keymap.h>
#include <Kaleidoscope-EEPROM-Settings.h>
#include <Kaleidoscope-Focus.h>
void setup() { void setup() {
Serial.begin(9600);
USE_PLUGINS(&EEPROMKeymap, &Focus);
Kaleidoscope.setup(); Kaleidoscope.setup();
USE_PLUGINS (&EEPROMKeymap); Focus.addHook(FOCUS_HOOK_KEYMAP);
Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER);
Layer.getKey = EEPROMKeymap.getKeyOverride;
// TODO EEPROMKeymap.max_layers(1);
EEPROMSettings.seal();
} }
``` ```
@ -32,7 +60,37 @@ void setup () {
The plugin provides the `EEPROMKeymap` object, which has the following methods: The plugin provides the `EEPROMKeymap` object, which has the following methods:
**TODO** ### `.max_layers(max)`
> Tells the extension to reserve space in EEPROM for up to `max` layers. Can
> only be called once, any subsequent call will be a no-op.
## Focus commands
The plugin provides two `Focus` hooks: `FOCUS_HOOK_KEYMAP`, and
`FOCUS_HOOK_KEYMAP_TRANSFER`. Together, they make the following commands
available, respectively:
### `keymap.map [codes...]`
> Without arguments, displays the keymap currently in effect. Each key is
> printed as its raw, 16-bit keycode.
>
> With arguments, it stores as many keys as given. One does not need to set all
> keys, on all layers: the command will start from the first key on the first
> layer, and go on as long as it has input. It will not go past the layer set
> via the `.max_layers()` method.
### `keymap.transfer LAYER`
> Transfers the `LAYER` from the built-in memory of the keyboard into `EEPROM`
> storage.
>
> Useful mostly when one wants to remove the built-in keymap, and wants to
> easily transfer it into `EEPROM` first.
>
> This is generally not needed, and it is recommended to not enable this
> command, unless the feature this command implements is truly needed.
## Dependencies ## Dependencies

12
examples/EEPROM-Keymap/EEPROM-Keymap.ino
Unescape View File

@ -22,8 +22,7 @@
const Key keymaps[][ROWS][COLS] PROGMEM = { const Key keymaps[][ROWS][COLS] PROGMEM = {
[0] = KEYMAP_STACKED [0] = KEYMAP_STACKED
( (Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey,
Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey,
Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab,
Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G,
Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape,
@ -37,17 +36,16 @@ const Key keymaps[][ROWS][COLS] PROGMEM = {
Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus,
Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl,
Key_skip Key_skip),
),
}; };
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
Kaleidoscope.setup ();
USE_PLUGINS(&EEPROMKeymap, &Focus); USE_PLUGINS(&EEPROMKeymap, &Focus);
Kaleidoscope.setup();
Focus.addHook(FOCUS_HOOK_SETTINGS); Focus.addHook(FOCUS_HOOK_SETTINGS);
Focus.addHook(FOCUS_HOOK_KEYMAP); Focus.addHook(FOCUS_HOOK_KEYMAP);
Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER); Focus.addHook(FOCUS_HOOK_KEYMAP_TRANSFER);
@ -56,7 +54,7 @@ void setup () {
Layer.getKey = EEPROMKeymap.getKeyOverride; Layer.getKey = EEPROMKeymap.getKeyOverride;
EEPROMKeymap.reserveSpace (1); EEPROMKeymap.max_layers(1);
EEPROMSettings.seal(); EEPROMSettings.seal();
} }

60
src/Kaleidoscope/EEPROM-Keymap.cpp
Unescape View File

@ -20,41 +20,37 @@
#include <Kaleidoscope-EEPROM-Keymap.h> #include <Kaleidoscope-EEPROM-Keymap.h>
#include <Kaleidoscope-Focus.h> #include <Kaleidoscope-Focus.h>
namespace KaleidoscopePlugins { namespace kaleidoscope {
uint16_t EEPROMKeymap::keymapBase; uint16_t EEPROMKeymap::keymap_base_;
uint8_t EEPROMKeymap::maxLayers; uint8_t EEPROMKeymap::max_layers_;
EEPROMKeymap::EEPROMKeymap(void) { EEPROMKeymap::EEPROMKeymap(void) {
} }
void void EEPROMKeymap::begin(void) {
EEPROMKeymap::begin (void) {
USE_PLUGINS(&::EEPROMSettings); USE_PLUGINS(&::EEPROMSettings);
} }
void void EEPROMKeymap::max_layers(uint8_t max) {
EEPROMKeymap::reserveSpace (uint8_t layers) { max_layers_ = max;
maxLayers = layers; keymap_base_ = ::EEPROMSettings.requestSlice(max_layers_ * ROWS * COLS * 2);
keymapBase = ::EEPROMSettings.requestSlice (maxLayers * ROWS * COLS * 2);
} }
Key Key EEPROMKeymap::getKey(uint8_t layer, byte row, byte col) {
EEPROMKeymap::getKey (uint8_t layer, byte row, byte col) {
Key key; Key key;
if (layer >= maxLayers) if (layer >= max_layers_)
return Key_NoKey; return Key_NoKey;
uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2; uint16_t pos = ((layer * ROWS * COLS) + (row * COLS) + col) * 2;
key.flags = EEPROM.read (keymapBase + pos); key.flags = EEPROM.read(keymap_base_ + pos);
key.keyCode = EEPROM.read (keymapBase + pos + 1); key.keyCode = EEPROM.read(keymap_base_ + pos + 1);
return key; return key;
} }
Key Key EEPROMKeymap::getKeyOverride(uint8_t layer, byte row, byte col) {
EEPROMKeymap::getKeyOverride (uint8_t layer, byte row, byte col) {
Key key; Key key;
key = getKey(layer, row, col); key = getKey(layer, row, col);
@ -63,19 +59,16 @@ EEPROMKeymap::getKeyOverride (uint8_t layer, byte row, byte col) {
return key; return key;
} }
uint16_t uint16_t EEPROMKeymap::keymap_base(void) {
EEPROMKeymap::base (void) { return keymap_base_;
return keymapBase;
} }
void void EEPROMKeymap::updateKey(uint16_t base_pos, Key key) {
EEPROMKeymap::updateKey (uint16_t basePos, Key key) { EEPROM.update(keymap_base_ + base_pos * 2, key.flags);
EEPROM.update (keymapBase + basePos * 2, key.flags); EEPROM.update(keymap_base_ + base_pos * 2 + 1, key.keyCode);
EEPROM.update (keymapBase + basePos * 2 + 1, key.keyCode);
} }
Key Key EEPROMKeymap::parseKey(void) {
EEPROMKeymap::parseKey (void) {
Key key; Key key;
key.raw = Serial.parseInt(); key.raw = Serial.parseInt();
@ -83,18 +76,16 @@ EEPROMKeymap::parseKey (void) {
return key; return key;
} }
void void EEPROMKeymap::printKey(Key k) {
EEPROMKeymap::printKey (Key k) {
::Focus.printNumber(k.raw); ::Focus.printNumber(k.raw);
} }
bool bool EEPROMKeymap::focusKeymap(const char *command) {
EEPROMKeymap::focusKeymap (const char *command) {
if (strcmp_P(command, PSTR("keymap.map")) != 0) if (strcmp_P(command, PSTR("keymap.map")) != 0)
return false; return false;
if (Serial.peek() == '\n') { if (Serial.peek() == '\n') {
for (uint8_t layer = 0; layer < maxLayers; layer++) { for (uint8_t layer = 0; layer < max_layers_; layer++) {
for (uint8_t row = 0; row < ROWS; row++) { for (uint8_t row = 0; row < ROWS; row++) {
for (uint8_t col = 0; col < COLS; col++) { for (uint8_t col = 0; col < COLS; col++) {
Key k = getKey(layer, row, col); Key k = getKey(layer, row, col);
@ -107,7 +98,7 @@ EEPROMKeymap::focusKeymap (const char *command) {
Serial.println(); Serial.println();
} else { } else {
uint16_t i = 0; uint16_t i = 0;
while ((Serial.peek () != '\n') && (i < ROWS * COLS * maxLayers)) { while ((Serial.peek() != '\n') && (i < ROWS * COLS * max_layers_)) {
updateKey(i, parseKey()); updateKey(i, parseKey());
i++; i++;
} }
@ -116,8 +107,7 @@ EEPROMKeymap::focusKeymap (const char *command) {
return true; return true;
} }
bool bool EEPROMKeymap::focusKeymapTransfer(const char *command) {
EEPROMKeymap::focusKeymapTransfer (const char *command) {
if (strcmp_P(command, PSTR("keymap.transfer")) != 0) if (strcmp_P(command, PSTR("keymap.transfer")) != 0)
return false; return false;
@ -135,6 +125,6 @@ EEPROMKeymap::focusKeymapTransfer (const char *command) {
return true; return true;
} }
}; }
KaleidoscopePlugins::EEPROMKeymap EEPROMKeymap; kaleidoscope::EEPROMKeymap EEPROMKeymap;

17
src/Kaleidoscope/EEPROM-Keymap.h
Unescape View File

@ -21,15 +21,16 @@
#include <Kaleidoscope.h> #include <Kaleidoscope.h>
#include <Kaleidoscope-EEPROM-Settings.h> #include <Kaleidoscope-EEPROM-Settings.h>
namespace KaleidoscopePlugins { namespace kaleidoscope {
class EEPROMKeymap : public KaleidoscopePlugin { class EEPROMKeymap : public KaleidoscopePlugin {
public: public:
EEPROMKeymap(void); EEPROMKeymap(void);
virtual void begin (void) final; static void max_layers(uint8_t max);
static void reserveSpace (uint8_t layers); void begin(void) final;
static uint16_t base (void);
static uint16_t keymap_base(void);
static Key getKey(uint8_t layer, byte row, byte col); static Key getKey(uint8_t layer, byte row, byte col);
static Key getKeyOverride(uint8_t layer, byte row, byte col); static Key getKeyOverride(uint8_t layer, byte row, byte col);
@ -37,15 +38,15 @@ class EEPROMKeymap : public KaleidoscopePlugin {
static bool focusKeymap(const char *command); static bool focusKeymap(const char *command);
static bool focusKeymapTransfer(const char *command); static bool focusKeymapTransfer(const char *command);
static void updateKey (uint16_t basePos, Key key); static void updateKey(uint16_t base_pos, Key key);
private: private:
static uint16_t keymapBase; static uint16_t keymap_base_;
static uint8_t maxLayers; static uint8_t max_layers_;
static Key parseKey(void); static Key parseKey(void);
static void printKey(Key key); static void printKey(Key key);
}; };
}; };
extern KaleidoscopePlugins::EEPROMKeymap EEPROMKeymap; extern kaleidoscope::EEPROMKeymap EEPROMKeymap;

Write Preview
Loading…
Cancel
Save