-
Notifications
You must be signed in to change notification settings - Fork 80
Fix #34: Add missing chapter references to command list #39
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 #34: Add missing chapter references to command list #39
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 chapter references to all commands in the command list table that were missing them. This improves document navigation and consistency. Commands updated: - 0x04: Get LED Color Palette Entry -> <<RGB LED Color Processing>> - 0x05: Reapply Color Palette -> <<RGB LED Color Processing>> - 0x07: Get LED Brightness -> <<Global LED Brightness>> - 0x15: Get LED White Balance -> <<White Balance>> - 0x18: Get Touch Strip Configuration -> <<Touch Strip>> - 0x19: Set Touch Strip LEDs -> <<Touch Strip>> - 0x1F: Get Aftertouch Mode -> <<Aftertouch>> - 0x21: Get Pad Velocity Curve Entry -> <<Velocity Curve>> - 0x29: Get Selected Pad Settings -> <<Pad Settings>> - 0x31: Set Pedal Curve Limits -> <<Pedal Configuration>> - 0x32: Set Pedal Curve Entries -> <<Pedal Configuration>> All chapter references have been verified to exist in the document.
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 pull request adds missing chapter references to commands in the command list table to improve document navigation. However, it also includes additional documentation enhancements not mentioned in the title.
Changes:
- Added chapter references to 11 commands in the command list table
- Added new subsection explaining how to convert RGB values to color palette indices
- Added clarifying NOTE about retrieving the complete RGB color palette
- 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 chapter references to command table entries, added documentation sections for RGB-to-palette conversion and User mode MIDI behavior |
| README.md | Added link to Rust crates.io package for Push 2 display driver |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Adds chapter references to all commands in the command list table that were
missing them. This improves document navigation and consistency.
Changes:
Files Changed:
Ready for squash-and-merge.