[WOL] Add source ip for magic packet #38717
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough## Walkthrough
The documentation for the Wake on LAN integration was updated to introduce an optional parameter named `if`, which allows users to specify the IP address of the network interface used to send magic packets. This new parameter is now described in the integration's basic configuration, the service action data attributes, and the switch platform configuration schema. No changes were made to other parameters or the integration's logic.
## Changes
| File | Change Summary |
|----------------------------------------------|-----------------------------------------------------------------------------------------------|
| source/_integrations/wake_on_lan.markdown | Added documentation for the new optional `if` parameter in configuration, service, and schema. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant User
participant HomeAssistant
participant NetworkInterface
User->>HomeAssistant: Configure wake_on_lan with optional 'if' (interface IP)
User->>HomeAssistant: Call send_magic_packet (with optional 'if')
HomeAssistant->>NetworkInterface: Send magic packet via specified interface (if provided)
NetworkInterface-->>HomeAssistant: Packet sent
HomeAssistant-->>User: Confirmation/Result |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/wake_on_lan.markdown (3)
39-41: Unify and clarify the basic config description.The description could be more precise and consistent with other sections. For example:
Interface IP address: - description: The IP address of the network adapter of HA instance to route the magic packet through. + description: The IP address of the Home Assistant instance’s network interface through which the magic packet is sent.
67-68: Fix grammar and improve service table entry.“where magic packet is send” should be “where the magic packet is sent,” and the description can mirror the basic config. For example:
-| `if` | yes | Optional HA interface IP address where magic packet is send. | +| `if` | yes | Optional interface IP address of the Home Assistant instance through which the magic packet is sent. |🧰 Tools
🪛 LanguageTool
[grammar] ~67-~67: Consider using either the past participle “sent” or the present participle “sending” here.
Context: ...erface IP address where magic packet is send. | Sample action data: ```jso...(BEEN_PART_AGREEMENT)
133-136: Align the YAML schema description with other sections.Use a unified phrasing and spell out “Home Assistant”:
if: - description: HA interface IP address where magic packet is routed. + description: The IP address of the Home Assistant instance’s network interface through which the magic packet is sent. required: false type: string
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/wake_on_lan.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/wake_on_lan.markdown
[grammar] ~67-~67: Consider using either the past participle “sent” or the present participle “sending” here.
Context: ...erface IP address where magic packet is send. | Sample action data: ```jso...
(BEEN_PART_AGREEMENT)
⏰ 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
Open
19 tasks
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
17bbba7 to
ce748f0
Compare
|
Thank you for contributing, @netmaxt3r 👍
|
|
I'm drafting this PR, as changes are needed. Please undraft it, once the changes have been implemented and the PR is ready for review again. |
ce748f0 to
df3d370
Compare
|
[ignore] restore deleted brach to reopen PR |
df3d370 to
92b7b53
Compare
92b7b53 to
3435b89
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Add source ip option for wake_on_lan integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Summary by CodeRabbit