-
Notifications
You must be signed in to change notification settings - Fork 80
Description
Clarify Palette Modification Persistence in Documentation
Problem Summary
The documentation section "Converting RGB Values to Color Palette Indices" (added in issue #22) mentions that users can modify the palette using "Set LED Color Palette Entry" command, but it doesn't clarify whether these modifications are temporary (reset on reboot) or persistent. This is important information for users who want to customize colors.
Current State
Location: doc/AbletonPush2MIDIDisplayInterface.asc, lines 444-467 (RGB conversion section)
The current documentation states:
"Alternatively, you can modify the palette to add custom colors by using the 'Set LED Color Palette Entry' command (0x03) to overwrite existing palette entries with your desired RGB values. After modifying palette entries, send the 'Reapply Color Palette' command (0x05) to apply the changes."
Missing Information:
- Are palette modifications temporary (reset on reboot)?
- Can they be made persistent?
- What happens if you modify a palette entry that's currently in use?
Comparison with Similar Documentation
The "White Balance" section (lines 596-600) clearly explains:
"The settings are temporary, and are reset to default on reboot. To modify the default white balance (persistently saved into flash memory and applied on reboot), use the 'Flash LED White Balance' command."
This same clarity should be applied to palette modifications.
Impact
- Priority: Medium (user clarity)
- User Experience: Users may waste time modifying palettes thinking changes are permanent
- Consistency: Matches the clarity level of White Balance documentation
Proposed Fix
Add a clarification note about palette modification persistence, similar to the White Balance section.
Code Fix
--- a/doc/AbletonPush2MIDIDisplayInterface.asc
+++ b/doc/AbletonPush2MIDIDisplayInterface.asc
@@ -461,6 +461,11 @@ available palette index:
Alternatively, you can modify the palette to add custom colors by using the
"Set LED Color Palette Entry" command (0x03) to overwrite existing palette
entries with your desired RGB values. After modifying palette entries, send
the "Reapply Color Palette" command (0x05) to apply the changes.
+
+NOTE: Palette modifications made using "Set LED Color Palette Entry" are
+temporary and are reset to default values on device reboot. Unlike white
+balance settings, there is no command to persistently save palette
+modifications to flash memory.
White LED Color ProcessingAlternative Fix (if persistence is possible)
If palette modifications CAN be made persistent, the fix would be:
+NOTE: Palette modifications made using "Set LED Color Palette Entry" are
+temporary and are reset to default values on device reboot. To make palette
+modifications persistent, [describe the process if one exists].Verification Steps
- CRITICAL: Verify with firmware/hardware expert whether palette modifications can be made persistent
- If temporary only: Use the first fix above
- If persistent option exists: Document the process (may require additional research)
- Test documentation clarity with users
Additional Notes
- This clarification is important for users implementing custom color schemes
- Should match the clarity level of White Balance documentation
- May require firmware documentation review to confirm behavior
- Consider if a "Flash Color Palette" command should exist (feature request)