Add set_program service action to miele #38670
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Miele integration was updated to reflect new support for climate control features and a new service action. The changes add the "Climate" category and platform, describe how climate entities can manage appliance temperatures, and introduce the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant MieleIntegration
participant Appliance
User->>HomeAssistant: Invoke miele.set_program (device_id, program_id, ...)
HomeAssistant->>MieleIntegration: Process set_program request
MieleIntegration->>Appliance: Send program start command with parameters
Appliance-->>MieleIntegration: Acknowledge program start
MieleIntegration-->>HomeAssistant: Confirm action result
HomeAssistant-->>User: Notify of success/failure
sequenceDiagram
participant User
participant HomeAssistant
participant MieleIntegration
participant Appliance
User->>HomeAssistant: Adjust climate entity (e.g., set temperature)
HomeAssistant->>MieleIntegration: Forward climate control command
MieleIntegration->>Appliance: Set target temperature for zone
Appliance-->>MieleIntegration: Confirm temperature set
MieleIntegration-->>HomeAssistant: Update climate state
HomeAssistant-->>User: Reflect updated climate status
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/miele.markdown(4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/miele.markdown
[uncategorized] ~110-~110: A punctuation mark might be missing here.
Context: ...the key state::programId::value_raw.| | duration | yes | Set desir...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/miele.markdown (4)
5-5: Frontmatter: Added 'Climate' category
The addition of the Climate category toha_categorycorrectly reflects the new climate entities in the integration.
15-15: Frontmatter: Added 'climate' to supported platforms
Includingclimateinha_platformsaccurately documents the support for climate entities.
84-89: New Climate section
The "### Climate" section and details block clearly explain the use of climate entities and supported zones. This aligns with Home Assistant documentation patterns.
109-113: Skip: Table punctuation false positive
The table markup and punctuation in the data attributes section is valid Markdown; the LanguageTool hint can be safely ignored.🧰 Tools
🪛 LanguageTool
[uncategorized] ~110-~110: A punctuation mark might be missing here.
Context: ...the keystate::programId::value_raw.| |duration| yes | Set desir...(AI_EN_LECTOR_MISSING_PUNCTUATION)
source/_integrations/miele.markdown
Outdated
| ## Actions | ||
|
|
||
| ### Action `miele.set_program` | ||
|
|
||
| Set and start a program for applicable appliances. Note that the device must be in a state where it will accept a new program, for example, most washing machines must be in state `On`. An error message is displayed if the device did not accept the action command. | ||
| The service action can be set up by UI in Automations editor or Developer tools. | ||
|
|
||
| | Data attribute | Optional | Description | | ||
| | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------- | | ||
| | `device_id` | no | Select device in GUI mode, then switch to YAML mode to see the device_id. | | ||
| | `program_id` | no | Enter the program_id number. The easiest way to find the number is to fetch a diagnostic download while running the actual program. Use the value from the key `state::programId::value_raw`.| | ||
| | `duration` | yes | Set desired program duration in minutes for ovens. | | ||
| | `temperature` | yes | Set desired target temperature for oven program. | | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhancement: Add usage example for miele.set_program
Include a YAML snippet demonstrating how to call the miele.set_program service with device_id, program_id, and optional duration/temperature. This will help users to quickly apply the new action. For example:
service: miele.set_program
data:
device_id: "abcdef123456"
program_id: 3
duration: 60 # in minutes
temperature: 180 # in °C🧰 Tools
🪛 LanguageTool
[uncategorized] ~110-~110: A punctuation mark might be missing here.
Context: ...the key state::programId::value_raw.| | duration | yes | Set desir...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/miele.markdown (1)
86-90: Introduce 'Climate' documentation section
The new### Climatesection and its details clearly explain how users can control appliance temperatures and the number of zones. Consider including a brief YAML example to illustrate setting a temperature target, for example:service: climate.set_temperature target: entity_id: climate.fridge_zone_1 data: temperature: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/miele.markdown(4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/miele.markdown
[uncategorized] ~107-~107: Possible missing comma found.
Context: ...ovens. Entities are created for up to 3 zones depending on the device capabilities. {...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/miele.markdown
122-122: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/_integrations/miele.markdown (3)
5-5: Add 'Climate' to integration categories
Including "Climate" underha_categoryensures the Miele integration appears in the Climate section of Home Assistant, matching the newly added climate entities.
16-16: Register new 'climate' platform
Adding- climateinha_platformscorrectly declares support for climate entities in the Miele integration.
101-108: Relocate and preserve 'Sensor' section
The### Sensorsection has been moved below Light and retains the necessary details about operation state and temperature sensors across up to three zones. The content remains accurate and well-structured.🧰 Tools
🪛 LanguageTool
[uncategorized] ~107-~107: Possible missing comma found.
Context: ...ovens. Entities are created for up to 3 zones depending on the device capabilities. {...(AI_HYDRA_LEO_MISSING_COMMA)
Proposed change
Add documentation on service action for Miele integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
miele.set_programaction, including usage instructions and parameter descriptions.