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

Add function to check internal network availability #117483

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

stremskijdmitro
Copy link

Added a new function is_internal_network_available to determine if the Home Assistant instance has access to the internal network. This function attempts to connect to a specified router IP address and port to verify network availability. Useful for enabling or disabling features based on internal network connectivity.

Breaking change

Proposed change

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Added a new function `is_internal_network_available` to determine if the Home Assistant instance has access to the internal network. This function attempts to connect to a specified router IP address and port to verify network availability. Useful for enabling or disabling features based on internal network connectivity.
@stremskijdmitro stremskijdmitro requested a review from a team as a code owner May 15, 2024 07:52
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 @earoslav

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 added cla-needed core small-pr PRs with less than 30 lines. labels May 15, 2024
@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.

@home-assistant home-assistant bot marked this pull request as draft May 15, 2024 07:52
@frenck frenck changed the title feat(network): Add function to check internal network availability Add function to check internal network availability May 15, 2024


@bind_hass
def is_internal_network_available(hass: HomeAssistant) -> bool:
Copy link
Member

Choose a reason for hiding this comment

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

What is using this?

"""Check if the Home Assistant instance has access to the internal network."""
# Check the availability of the router's network interface
router_ip = "192.168.1.1" # IP address of the router in your network
router_port = 80 # Port for accessing the router's web interface (e.g., 80 for HTTP)
Copy link
Member

Choose a reason for hiding this comment

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

This makes an assumption the router has a web interface (hint: mine has not...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-needed core small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants