Fix valve action names #36593
Fix valve action names #36593
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the documentation for valve integration in Home Assistant, focusing on updating action command names for valve control. The changes aim to improve clarity and consistency by renaming various valve-related actions, such as changing Changes
Sequence DiagramsequenceDiagram
participant User
participant HomeAssistant
participant Valve
User->>HomeAssistant: valve.open_valve
HomeAssistant->>Valve: Open valve
User->>HomeAssistant: valve.close_valve
HomeAssistant->>Valve: Close valve
User->>HomeAssistant: valve.set_valve_position
HomeAssistant->>Valve: Set specific valve position
User->>HomeAssistant: valve.stop_valve
HomeAssistant->>Valve: Stop valve operation
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? 🪧 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: 0
🧹 Nitpick comments (1)
source/_integrations/valve.markdown (1)
Line range hint
86-91: Consider adding a comment about position range.The example correctly demonstrates the
valve.set_valve_positionaction. Consider adding a comment to clarify that the position value (50) represents 50% open.- action: valve.set_valve_position target: entity_id: valve.demo data: + # Position: 0 (closed) to 100 (fully open) position: 50
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/valve.markdown(3 hunks)
🔇 Additional comments (4)
source/_integrations/valve.markdown (4)
49-50: LGTM! Action names now match the implementation.
The updated action names (valve.open_valve, valve.close_valve, valve.toggle, valve.set_valve_position, valve.stop_valve) correctly reflect the actual implementation in Home Assistant core.
64-68: LGTM! Example automation uses correct action name.
The automation example correctly demonstrates the usage of the valve.close_valve action.
69-69: LGTM! Action heading correctly updated.
The section heading correctly uses the valve.set_valve_position action name.
49-50: Verify action names in Home Assistant core.
Let's confirm that these action names match the actual implementation in the Home Assistant core.
Also applies to: 64-68, 69-69, 86-91
|
This was already fixed through #36606 without they noticed that you had opened a PR as well. Thank you though for your contribution. |
Proposed change
While coding automations for some of my heating valves, I noticed that the actions that the documentation lists do not work.
The documentation lists
valve.open,valve.close,valve.stopandvalve.set_position, but these don't exist.According to https://github.com/home-assistant/core/blob/dev/homeassistant/components/valve/services.yaml (and my HA instance) they are called
valve.open_valve,valve.close_valve,valve.stop_valveandvalve.set_valve_position.I've fixed the documentation for the valve integration to remedy that.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
valve.open→valve.open_valve)