This new plugin lets us store a default palette and colormap in PROGMEM. Rather than teaching Colormap to pull from either EEPROM or PROGMEM, this implements an entirely separate plugin, `DefaultColormap`, which is able to *push* a palette and colormaps into Colormap. When `DefaultColormap.setup()` is called, it checks if Colormap's storage area is empty (both palette and the map must be empty), and if so, copies the built-in palette and colormap over, and forces a refresh, and it has done its job. It does provide an additional Focus command too, `colormap.install`, which will forcibly copy both palette and colormaps over. Useful for resetting back to a factory setting. Signed-off-by: Gergely Nagy <algernon@keyboard.io>pull/1188/head
Gergely Nagy
2 years ago
parent
0c6f608704
commit
e59a09e19e
@ -0,0 +1,94 @@
|
||||
/* -*- mode: c++ -*-
|
||||
* Kaleidoscope-Colormap -- Per-layer colormap effect
|
||||
* Copyright (C) 2022 Keyboard.io, Inc
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify it under it under
|
||||
* the terms of the GNU General Public License as published by the Free Software
|
||||
* Foundation, version 3.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
* details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along with along with
|
||||
* this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include "kaleidoscope/plugin/Colormap.h" // for Colormap
|
||||
#include "kaleidoscope/plugin/DefaultColormap.h"
|
||||
|
||||
#include <Arduino.h> // for F, PSTR, __FlashStringHelper
|
||||
#include <Kaleidoscope-FocusSerial.h> // for Focus, FocusSerial
|
||||
#include <Kaleidoscope-LEDControl.h> // for LEDControl
|
||||
#include <Kaleidoscope-LED-Palette-Theme.h> // for LEDPaletteTheme
|
||||
#include <stdint.h> // for uint8_t, uint16_t
|
||||
|
||||
#include "kaleidoscope/KeyAddr.h" // for KeyAddr
|
||||
#include "kaleidoscope/Runtime.h" // for Runtime, Runtime_
|
||||
|
||||
namespace kaleidoscope {
|
||||
namespace plugin {
|
||||
|
||||
namespace defaultcolormap {
|
||||
__attribute__((weak)) extern const cRGB palette[] = {};
|
||||
__attribute__((weak)) extern bool palette_defined = false;
|
||||
__attribute__((weak)) extern const uint8_t colormaps[][kaleidoscope_internal::device.matrix_rows * kaleidoscope_internal::device.matrix_columns] = {};
|
||||
__attribute__((weak)) extern uint8_t colormap_layers = 0;
|
||||
} // namespace defaultcolormap
|
||||
|
||||
void DefaultColormap::setup() {
|
||||
// If the colormap is already initialized, return early.
|
||||
if (!::ColormapEffect.isUninitialized())
|
||||
return;
|
||||
|
||||
install();
|
||||
}
|
||||
|
||||
void DefaultColormap::install() {
|
||||
if (!defaultcolormap::palette_defined) return;
|
||||
|
||||
for (uint8_t i = 0; i < 16; i++) {
|
||||
cRGB color;
|
||||
|
||||
color.r = pgm_read_byte(&(defaultcolormap::palette[i].r));
|
||||
color.g = pgm_read_byte(&(defaultcolormap::palette[i].g));
|
||||
color.b = pgm_read_byte(&(defaultcolormap::palette[i].b));
|
||||
|
||||
::LEDPaletteTheme.updatePaletteColor(i, color);
|
||||
}
|
||||
|
||||
if (defaultcolormap::colormap_layers == 0) return;
|
||||
|
||||
for (uint8_t layer = 0; layer < defaultcolormap::colormap_layers; layer++) {
|
||||
for (int8_t i = 0; i < Runtime.device().numKeys(); i++) {
|
||||
const int8_t post = Runtime.device().ledDriver().getLedIndex(i);
|
||||
const uint8_t idx = pgm_read_byte(&(defaultcolormap::colormaps[layer][i]));
|
||||
::ColormapEffect.updateColorIndexAtPosition(layer, post, idx);
|
||||
}
|
||||
}
|
||||
Runtime.storage().commit();
|
||||
|
||||
::LEDControl.refreshAll();
|
||||
}
|
||||
|
||||
EventHandlerResult DefaultColormap::onFocusEvent(const char *command) {
|
||||
if (!Runtime.has_leds)
|
||||
return EventHandlerResult::OK;
|
||||
|
||||
const char *cmd = PSTR("colormap.install");
|
||||
|
||||
if (::Focus.handleHelp(command, cmd))
|
||||
return EventHandlerResult::OK;
|
||||
|
||||
if (strcmp_P(command, cmd) != 0)
|
||||
return EventHandlerResult::OK;
|
||||
|
||||
install();
|
||||
return EventHandlerResult::EVENT_CONSUMED;
|
||||
}
|
||||
|
||||
} // namespace plugin
|
||||
} // namespace kaleidoscope
|
||||
|
||||
kaleidoscope::plugin::DefaultColormap DefaultColormap;
|
||||
@ -0,0 +1,98 @@
|
||||
/* -*- mode: c++ -*-
|
||||
* Kaleidoscope-Colormap -- Per-layer colormap effect
|
||||
* Copyright (C) 2022 Keyboard.io, Inc
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify it under it under
|
||||
* the terms of the GNU General Public License as published by the Free Software
|
||||
* Foundation, version 3.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
* details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along with along with
|
||||
* this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <Arduino.h> // for PROGMEM
|
||||
#include <stdint.h> // for uint8_t
|
||||
|
||||
#include "kaleidoscope_internal/device.h" // for device
|
||||
#include "kaleidoscope/device/device.h" // for cRGB
|
||||
#include "kaleidoscope/event_handler_result.h" // for EventHandlerResult
|
||||
#include "kaleidoscope/plugin.h" // for Plugin
|
||||
|
||||
namespace kaleidoscope {
|
||||
namespace plugin {
|
||||
|
||||
// clang-format off
|
||||
|
||||
#define COLORMAPS(layers...) \
|
||||
namespace kaleidoscope { \
|
||||
namespace plugin { \
|
||||
namespace defaultcolormap { \
|
||||
const uint8_t colormaps[][kaleidoscope_internal::device.matrix_rows * kaleidoscope_internal::device.matrix_columns] PROGMEM = { \
|
||||
layers \
|
||||
}; \
|
||||
uint8_t colormap_layers = \
|
||||
sizeof(colormaps) / sizeof(*colormaps); \
|
||||
} /* defaultcolormap */ \
|
||||
} /* plugin */ \
|
||||
} /* kaleidoscope */
|
||||
|
||||
#define __IDENTITY__(X) X
|
||||
|
||||
#ifdef PER_KEY_DATA_STACKED
|
||||
#define COLORMAP_STACKED(...) \
|
||||
{ \
|
||||
MAP_LIST(__IDENTITY__, PER_KEY_DATA_STACKED(0, __VA_ARGS__)) \
|
||||
}
|
||||
#endif
|
||||
|
||||
#ifdef PER_KEY_DATA
|
||||
#define COLORMAP(...) \
|
||||
{ \
|
||||
MAP_LIST(__IDENTITY__, PER_KEY_DATA(0, __VA_ARGS__)) \
|
||||
}
|
||||
#endif
|
||||
|
||||
#define PALETTE(p0, p1, p2, p3, p4, p5, p6, p7, \
|
||||
p8, p9, pa, pb, pc, pd, pe, pf) \
|
||||
namespace kaleidoscope { \
|
||||
namespace plugin { \
|
||||
namespace defaultcolormap { \
|
||||
const cRGB palette[] PROGMEM = { \
|
||||
p0, p1, p2, p3, p4, p5, p6, p7, \
|
||||
p8, p9, pa, pb, pc, pd, pe, pf \
|
||||
}; \
|
||||
bool palette_defined = true; \
|
||||
} /* defaultcolormap */ \
|
||||
} /* plugin */ \
|
||||
} /* kaleidoscope */
|
||||
|
||||
// clang-format on
|
||||
|
||||
namespace defaultcolormap {
|
||||
extern bool palette_defined;
|
||||
extern const cRGB palette[];
|
||||
extern const uint8_t colormaps[][kaleidoscope_internal::device.matrix_rows * kaleidoscope_internal::device.matrix_columns];
|
||||
extern uint8_t colormap_layers;
|
||||
} // namespace defaultcolormap
|
||||
|
||||
class DefaultColormap : public Plugin {
|
||||
public:
|
||||
static void setup();
|
||||
|
||||
EventHandlerResult onFocusEvent(const char *command);
|
||||
|
||||
private:
|
||||
static void install();
|
||||
};
|
||||
|
||||
} // namespace plugin
|
||||
} // namespace kaleidoscope
|
||||
|
||||
extern kaleidoscope::plugin::DefaultColormap DefaultColormap;
|
||||
Loading…
Reference in new issue