Skip to content
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

Create hotspot #533

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

jkt628
Copy link

@jkt628 jkt628 commented Jan 26, 2025

give NetworkManager enough configuration to create a hotspot

Summary by CodeRabbit

  • New Features

    • Added "shared" option for IPv4 network method configuration.
    • Introduced WiFi configuration options:
      • WiFi band selection (5GHz and 2.4GHz).
      • WiFi channel specification for access point mode.
  • Improvements

    • Enhanced network interface configuration capabilities.
    • Expanded command-line completion options for network settings.

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jkt628

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot marked this pull request as draft January 26, 2025 17:14
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@jkt628 jkt628 marked this pull request as ready for review January 26, 2025 17:18
Copy link

coderabbitai bot commented Jan 26, 2025

📝 Walkthrough

Walkthrough

The pull request introduces enhancements to network configuration commands in two files: cmd/network.go and cmd/network_update.go. The changes expand IP method completions to include a new "shared" option and add WiFi-specific configuration flags for band and channel selection. These modifications provide more flexibility in network interface configuration, particularly for WiFi access point settings and IP method selection.

Changes

File Change Summary
cmd/network.go Added "shared" as a fourth completion option in ipMethodCompletions function
cmd/network_update.go - Updated ipv4-method flag description to include "shared" option
- Added wifi-band flag with options for 5GHz (a) and 2.4GHz (bg)
- Added wifi-channel flag for specifying WiFi channel
- Modified flag value retrieval method in parseNetworkArgs

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI
    participant NetworkConfig
    
    User->>CLI: Execute network update command
    CLI->>NetworkConfig: Parse network configuration flags
    alt IPv4 Method
        NetworkConfig-->>CLI: Validate ipv4-method (static/auto/disabled/shared)
    end
    alt WiFi Configuration
        NetworkConfig-->>CLI: Validate wifi-band (a/bg)
        NetworkConfig-->>CLI: Validate wifi-channel
    end
    CLI-->>User: Apply network configuration
Loading

📜 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 26fa661 and 01a644c.

📒 Files selected for processing (2)
  • cmd/network.go (1 hunks)
  • cmd/network_update.go (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • cmd/network.go
  • cmd/network_update.go

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
🪧 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 or @coderabbitai title 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1cb025e and 09ad0b0.

📒 Files selected for processing (2)
  • cmd/network.go (1 hunks)
  • cmd/network_update.go (5 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
cmd/network_update.go (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

cmd/network.go (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🔇 Additional comments (4)
cmd/network_update.go (4)

78-78: LGTM! IPv4 method description updated consistently.

The description update aligns with the "shared" method addition in network.go.


90-91: LGTM! Essential WiFi hotspot configuration flags added.

The addition of band and channel flags is necessary for proper AP mode configuration:

  • wifi-band: Controls 2.4GHz (bg) vs 5GHz (a) operation
  • wifi-channel: Allows channel selection to avoid interference

113-115: LGTM! Proper completion function for WiFi band selection.

The completion function correctly provides the two valid options:

  • a: 5GHz band
  • bg: 2.4GHz band

171-172: LGTM! WiFi configuration structure updated.

The new band and channel parameters are properly integrated into the WiFi configuration structure.

@@ -25,7 +25,7 @@ func init() {
}

func ipMethodCompletions(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
return []string{"static", "auto", "disabled"}, cobra.ShellCompDirectiveNoFileComp
return []string{"static", "auto", "disabled", "shared"}, cobra.ShellCompDirectiveNoFileComp
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Inconsistency found in IPv4 method documentation

The "shared" method is inconsistently documented across commands:

  • network update correctly lists it as static|auto|disabled|shared
  • network vlan only shows static|auto|disabled

Both commands use the same completion function that now includes "shared", making the vlan command's help text outdated.

🔗 Analysis chain

LGTM! Addition of "shared" IP method supports hotspot functionality.

The addition of "shared" to IP method completions is correct and necessary for enabling hotspot functionality.

Let's verify that the "shared" method is properly handled in the network update logic:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any validation or handling of the "shared" IP method
rg -l "shared.*method" --type go

Length of output: 34


Script:

#!/bin/bash
# Search for shared IP-related code and method validation
echo "=== Searching for 'shared' in Go files ==="
rg "shared" --type go -B 2 -A 2

echo -e "\n=== Searching for IP method validation ==="
rg "method.*=|method.*:=|validateMethod|checkMethod" --type go -B 2 -A 2

Length of output: 1182


Script:

#!/bin/bash
# Search for method handling in network update logic
echo "=== Searching for network update implementation ==="
ast-grep --pattern 'func.*networkUpdate.*{
  $$$
}'

echo -e "\n=== Searching for IPv4 method handling ==="
rg "ipv4.*method" --type go -B 3 -A 3

Length of output: 3739

cmd/network_update.go Show resolved Hide resolved
@jkt628
Copy link
Author

jkt628 commented Jan 27, 2025

i signed the CLA for supervisor with home-assistant/supervisor#5577 and now here get

No pending request found for jkt628. Are you signing the CLA with the same GitHub user that created the commits in the Pull Request?

is this the same CLA? can cla-bot run again?

@jkt628
Copy link
Author

jkt628 commented Feb 3, 2025

tested in HAOS, see home-assistant/home-assistant.io#37140 (comment)

@jkt628 jkt628 force-pushed the feat/ipv4-method-shared branch from 09ad0b0 to 26fa661 Compare February 3, 2025 13:37
@jkt628 jkt628 force-pushed the feat/ipv4-method-shared branch from 26fa661 to 01a644c Compare February 7, 2025 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant