added support for custom palettes

[bcpearce]

Proposed Changes

Add support for custom palettes.

Related Issues

#1602

Summary by CodeRabbit

• New Features

  • Added a display of the count of custom palettes available on the WLED device.
  • Enhanced palette management to include custom palettes alongside standard ones.

• Bug Fixes

  • Improved handling and population of palette data structures to ensure accurate representation of both standard and custom palettes.

[coderabbitai]

Walkthrough

The pull request introduces enhancements to the WLED CLI and device models, focusing on custom palette management. A new field custom_palette_count is added to the Info class in models.py, allowing tracking of custom palettes. The CLI's command_info function is updated to display this count, providing users with more detailed information about device palette configurations. The palette handling logic is also refined to incorporate custom palettes using itertools.chain.

Changes

File	Change Summary
src/wled/cli/__init__.py	Added display of custom palette count in device info table
src/wled/models.py	- Added custom_palette_count field to Info class - Updated palette population logic in Device class to include custom palettes

Sequence Diagram

sequenceDiagram
    participant CLI
    participant Device
    participant Info
    
    CLI->>Device: Request device info
    Device->>Info: Retrieve palette details
    Info-->>Device: Return custom_palette_count
    Device->>Device: Generate palette list
    Device-->>CLI: Provide device information
    CLI->>CLI: Display palette count

Loading

Poem

🐰 Palettes dancing, colors bright
Custom hues now in our sight
Counting rainbows, one by one
WLED's magic has just begun!
A rabbit's palette of delight 🌈

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f05ac7 and 6879987.

📒 Files selected for processing (2)

• src/wled/cli/__init__.py (1 hunks)
• src/wled/models.py (4 hunks)

🔇 Additional comments (5)

src/wled/cli/__init__.py (1)

118-120: Great addition to the CLI output!
Displaying the number of custom palettes is helpful for users who need to manage or verify their custom configurations. This aligns well with the PR objective to support custom palettes.

src/wled/models.py (4)

468-472: Informative new field.
Introducing a dedicated “custom_palette_count” field enhances maintainability and clarity regarding user-created palettes. The docstring is concise and helpful.

---

753-759: Smart chaining approach for palettes.
Chaining standard palettes with custom ones is clean, but ensure no collisions occur between IDs if the device ever uses 255 for standard palettes.

Consider verifying if 255 is always reserved for custom palettes or if there's an overlap risk.

---

817-823: Consistent update mechanism for custom palettes.
Reusing the same chaining logic in “update_from_dict” consolidates palette handling. This ensures any changes for palette indexing stay consistent in both deserialization paths.

---

5-5: Optional: Confirm the need for itertools.
While using itertools chain is elegant for merging two sequences, ensure that no other standard approach (like extending lists) was simpler and more readable.

Would you like to run a usage check to confirm the necessity of itertools?

✅ Verification successful

Based on the search results, I can generate the final response as we have sufficient information about the usage of itertools in the codebase.

The use of itertools.chain is justified and well-applied
The itertools import is used specifically for itertools.chain() to elegantly merge two sequences: an enumerated list of predefined palettes with dynamically generated custom palette entries. This is a clean and efficient approach, especially when dealing with iterables of different types (enumeration and generator expression). Alternative approaches like list extension would require materializing the second sequence first, making the code less memory efficient.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verifies if itertools is used elsewhere or only for merging palettes
rg 'itertools' -A 5

Length of output: 2338

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.