-
Notifications
You must be signed in to change notification settings - Fork 80
Fix #35: Clarify palette modification persistence #40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Fix #35: Clarify palette modification persistence #40
Conversation
…ghtness command The command list table incorrectly showed that Get Display Brightness (0x09) does not send a reply. This commit fixes the table to correctly indicate that the command does send a reply, matching the command description.
Add a note explaining how to retrieve the complete default RGB color palette (all 128 entries from index 0 to 127) using the Get LED Color Palette Entry sysex command (0x04). This addresses the request to document the full palette beyond the subset currently shown in the documentation.
Add a note clarifying that in User mode, MIDI system real time messages (start, stop, continue, clock) must be sent on Port 2, as Port 1 messages are ignored. This explains why animations may not run at the default 120 bpm tempo in User mode when no MIDI start message has been received on the active port.
…palette indices Add a new section explaining how to convert arbitrary RGB color values to the closest Push 2 color palette index. This includes: - Instructions for retrieving the complete palette - Distance calculation methods (Euclidean and perceptual) - Alternative approach of modifying the palette with custom colors This addresses the question about translating Max For Live colors to Palette Color Index values.
Add link to push2_display crate on crates.io as mentioned in issue Ableton#29. This provides a Rust implementation for the Push 2 display interface.
Add a note clarifying that palette modifications made using 'Set LED Color Palette Entry' command are temporary and reset on reboot. This matches the clarity provided in the White Balance section and helps users understand the behavior of palette modifications. This addresses the documentation gap where users might assume palette changes are persistent, similar to how white balance has both temporary and persistent (flashed) options.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR addresses issue #35 by clarifying that color palette modifications are temporary and reset on device reboot. The changes add comprehensive documentation about RGB color palette usage, including conversion methods and persistence behavior.
Changes:
- Added NOTE clarifying palette modifications are temporary and not persisted to flash memory
- Added new section explaining how to convert RGB values to palette indices
- Added NOTE explaining the default color palette table is a subset
- Added NOTE about MIDI system real time messages in User mode
- Added link to Rust display driver in README
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| doc/AbletonPush2MIDIDisplayInterface.asc | Added documentation clarifying palette modification persistence, RGB conversion methods, MIDI message routing, and fixed table formatting |
| README.md | Added link to Rust display driver library |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Adds a note clarifying that palette modifications made using "Set LED Color
Palette Entry" command are temporary and reset on reboot.
Changes:
Files Changed:
Ready for squash-and-merge.