Add EEPROM and focus support to ColormapOverlay

[EvyBongers]

Quick attempt to implement focus support in ColormapOverlay. I feel this should work, but I don't have my keyboard with me right now, so any debugging I'll have to do later.

[EvyBongers]

colormap.overlay seems like the most logical focus command to me. Let me know what you think.

[obra]

@EvyBongers did you end up testing this on hardware?

[EvyBongers]

I completely forgot about this. I'll see about testing it today

[EvyBongers]

So, I finally got around to testing this. The command returns the palette indexes as expected, but setting the indexes doesn't yet work 🤔

[EvyBongers]

So, I dug a little deeper to see what I was missing. I thought I had a quick fix by calling on ::LEDPaletteTheme.themeFocusEvent(), but the internal logic of the plugin never actually used LEDPaletteTheme to store its data because it was never intended to work as a theme.
Looking at #1416, it seems to me that the third PR that we discussed there was never created, so unless we want so implement a read only version here, this effort is going to have to wait until EEPROM support is added to Colormap-Overlay.

The confusing part is that Colormap-Overlay (seemed to) need to call ::LEDPaletteTheme.reserveThemes() in order to work with the palette, even though it never uses any of the theme logic. It's been ages since I implemented that part and I don't remember why I needed to add that call to reserve themes nor whether it's actually needed for the plugin to work with the palette at all.

Closing this for now

[EvyBongers]

Reopened because EEPROM supports needs to be added anyway and EEPROM and focus support should land together.

[EvyBongers]

Just found a comment about this on Discord. Cross-posting to have all of this together.

#1434 will need quite a bit of work yet, I think. My first attempt to make focus work for colormap overlay settings simply passed through the handling of the focus event to ::LEDPaletteTheme.themeFocusEvent(). I had a proper look at that today and I'm pretty sure that isn't going to work, or at least it isn't sufficient. That's partly because (iirc) I needed to reserve at least one theme to get ::LEDPaletteTheme.lookupPaletteColor() to work. However, the plugin doesn't store any other data in a theme. That means that I will either have to find a way to have the plugin work with themes or I'm gonna have to implement a second or different means for handing the focus command

[EvyBongers]

@obra I'm continued worked on this and I have a feeling I'm getting close to having a first draft that can actually compile, but I just found that my idea of using -1 for keys that don't have an overlay color isn't actually supported by FocusSerial at this point. See my comments here: Colormap-Overlay.cpp#L117-L120

At first glance it looks like implementing this in FocusSerial is as easy adding this bit of code. Can I add that as part of this PR, or would you prefer having a separate PR for that?

  void read(int8_t &i8) {
    i8 = Runtime.serialPort().parseInt();
  }
  void read(int16_t &i16) {
    i16 = Runtime.serialPort().parseInt();
  }

[obra]

Just pull it out to a separate commit and I'm good :)

…

On Tue, Mar 4, 2025 at 1:42 PM Evy Bongers ***@***.***> wrote: @obra <https://github.com/obra> I'm continued worked on this and I have a feeling I'm getting close to having a first draft that can actually compile, but I just found that my idea of using -1 for keys that don't have an overlay color isn't actually supported by FocusSerial at this point. See my comments here: https://github.com/EvyBongers/Kaleidoscope/blob/8db281269e9bf9d2b1cb97c6162f5aa434e45050/plugins/Kaleidoscope-Colormap-Overlay/src/kaleidoscope/plugin/Colormap-Overlay.cpp#L117-L120 At first glance it looks like implementing this in FocusSerial is as easy adding this bit of code. Can I add that as part of this PR, or would you prefer having a separate PR for that? void read(int8_t &i8) { i8 = Runtime.serialPort().parseInt(); } void read(int16_t &i16) { i16 = Runtime.serialPort().parseInt(); } — Reply to this email directly, view it on GitHub <#1434 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAALC2AH75N23PY24JSKBID2SYM57AVCNFSM6AAAAABKYKWNE2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOJZGAYDKMRWGY> . You are receiving this because you were mentioned.Message ID: ***@***.***> [image: EvyBongers]*EvyBongers* left a comment (keyboardio/Kaleidoscope#1434) <#1434 (comment)> @obra <https://github.com/obra> I'm continued worked on this and I have a feeling I'm getting close to having a first draft that can actually compile, but I just found that my idea of using -1 for keys that don't have an overlay color isn't actually supported by FocusSerial at this point. See my comments here: https://github.com/EvyBongers/Kaleidoscope/blob/8db281269e9bf9d2b1cb97c6162f5aa434e45050/plugins/Kaleidoscope-Colormap-Overlay/src/kaleidoscope/plugin/Colormap-Overlay.cpp#L117-L120 At first glance it looks like implementing this in FocusSerial is as easy adding this bit of code. Can I add that as part of this PR, or would you prefer having a separate PR for that? void read(int8_t &i8) { i8 = Runtime.serialPort().parseInt(); } void read(int16_t &i16) { i16 = Runtime.serialPort().parseInt(); } — Reply to this email directly, view it on GitHub <#1434 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAALC2AH75N23PY24JSKBID2SYM57AVCNFSM6AAAAABKYKWNE2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOJZGAYDKMRWGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[EvyBongers]

@obra I don't really like having to reserve memory for a theme that I don't even use. I'm happy to remove the comment and just accept it if that's what you prefer, but as stated in the comment I feel it might be better to split initialisation of the palette and logic for themes.

[obra]

I don't know that it should be in a 'setup' method? But possibly in a 'reservePalette' method (that the existing 'reserveThemes' would be refactored to call)?

[EvyBongers]

That's fine by me. Want a separate PR for that too?

[obra]

Sure!

…

On Tue, Mar 11, 2025 at 12:02 PM Evy Bongers ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In plugins/Kaleidoscope-Colormap-Overlay/src/kaleidoscope/plugin/Colormap-Overlay.cpp <#1434 (comment)> : > + // It appears that a call to ::LEDPaletteTheme.reserveThemes() is needed + // because it's where palette_base_ gets initialized. Since this plugin (and + // possibly others) don't actually use themes, requesting memory for storing + // themes doesn't make much sense. Maybe initialisation of palette_base_ + // could be moved to a setup() method, though maybe the palette should be + // split from palette theme altogether? That's fine by me. Want a separate PR for that too? — Reply to this email directly, view it on GitHub <#1434 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAALC2BIP2L773YAYSO2ZSL2T4XKVAVCNFSM6AAAAABKYKWNE2VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDMNZVHAYTAOBWGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>