-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Swisscom documentation #45751
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
Merged
+71
−24
Merged
Swisscom documentation #45751
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f0782d9
Swisscom: updated documentation
anatosun f8eea6f
fix indentation to fix build
c0ffeeca7 12ded04
Update source/_integrations/swisscom.markdown
anatosun 984889c
Update source/_integrations/swisscom.markdown
anatosun 747942f
Update source/_integrations/swisscom.markdown
anatosun bd0f34d
Update source/_integrations/swisscom.markdown
anatosun File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,72 @@ | ||
| --- | ||
| title: Swisscom Internet-Box | ||
| description: Instructions on how to integrate Swisscom Internet-Box into Home Assistant. | ||
| description: Instructions on how to integrate the Swisscom Internet-Box into Home Assistant. | ||
| ha_category: | ||
| - Presence detection | ||
| ha_release: 0.32 | ||
| ha_domain: swisscom | ||
| ha_iot_class: Local Polling | ||
| ha_config_flow: true | ||
| ha_platforms: | ||
| - device_tracker | ||
| ha_integration_type: integration | ||
| related: | ||
| - docs: /docs/configuration/ | ||
| title: Configuration file | ||
| ha_integration_type: hub | ||
| ha_quality_scale: legacy | ||
| related: | ||
| - docs: /integrations/device_tracker/ | ||
| title: Device tracker | ||
| --- | ||
|
|
||
| The **Swisscom Internet-Box** {% term integration %} offers presence detection by looking at connected devices to an [Internet-Box](https://www.swisscom.ch/en/residential/help/device/internet-router.html) router from [Swisscom](https://www.swisscom.ch) which is an Internet provider in Switzerland. | ||
| The **Swisscom Internet-Box** {% term integration %} offers presence detection by looking at the devices connected to your [Internet-Box](https://www.swisscom.ch/en/residential/help/device/internet-router.html) router. The Internet-Box is the router provided by [Swisscom](https://www.swisscom.ch), an Internet provider in Switzerland. | ||
|
|
||
| With this integration, you can use the presence of phones, tablets, and other devices on your home network to trigger automations. For example, you can turn the lights off when everyone leaves home, or send a notification when someone arrives. | ||
|
|
||
| ## Supported devices | ||
|
|
||
| The following Internet-Box models are supported: | ||
|
|
||
| - Internet-Box light | ||
| - Internet-Box standard | ||
| - Internet-Box plus | ||
|
|
||
| All models share the same web interface, so they work the same way with this integration. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To set up the integration, you need the following: | ||
|
|
||
| - The IP address of your Internet-Box. By default, this is `192.168.1.1`. | ||
|
anatosun marked this conversation as resolved.
|
||
| - The administrator password for your Internet-Box. This is the password you use to sign in to the router's web interface. | ||
|
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| {% configuration_basic %} | ||
| Host: | ||
| description: "The IP address of your Internet-Box. By default, this is `192.168.1.1`." | ||
| Username: | ||
| description: "The administrator username for your Internet-Box. By default, this is `admin`." | ||
| Password: | ||
| description: "The administrator password for your Internet-Box. This is the password you use to sign in to the router's web interface." | ||
| {% endconfiguration_basic %} | ||
|
|
||
|
anatosun marked this conversation as resolved.
|
||
| ## Supported functionality | ||
|
|
||
| The integration creates a {% term "device tracker" %} entity for each device known to your Internet-Box. Each entity reports whether the device is currently connected to your network, along with the following attributes: | ||
|
|
||
| - Hostname | ||
| - IP address | ||
| - MAC address | ||
|
|
||
| You can use these entities to track the presence of people in your home. For more information on how to assign tracked devices to people, see the [device tracker integration page](/integrations/device_tracker/). | ||
|
|
||
| ## Data updates | ||
|
|
||
| {% note %} | ||
| There are three models of Internet-Box (light, standard and plus). The platform has only been tested on the Internet-Box plus but the others should work as well because they have the same web interface. | ||
| {% endnote %} | ||
| Home Assistant {% term polling polls %} your Internet-Box every 30 seconds to retrieve the list of connected devices and update their connection status. | ||
|
anatosun marked this conversation as resolved.
|
||
|
|
||
| To use an Internet-Box router in your installation, add the following to your {% term "`configuration.yaml`" %} file. | ||
| {% include integrations/restart_ha_after_config_inclusion.md %} | ||
| ## Troubleshooting | ||
|
|
||
| ```yaml | ||
| # Example configuration.yaml entry | ||
| device_tracker: | ||
| - platform: swisscom | ||
| ``` | ||
| If the setup fails or the integration stops working, check the following: | ||
|
|
||
| {% configuration %} | ||
| host: | ||
| description: The IP address of your router. | ||
| required: false | ||
| default: 192.168.1.1 | ||
| type: string | ||
| {% endconfiguration %} | ||
| - Make sure the IP address of your Internet-Box is correct and reachable from Home Assistant. | ||
| - Make sure the administrator password is correct. The integration signs in to your Internet-Box to read the list of connected devices, so it needs valid administrator credentials. | ||
|
|
||
| See the [device tracker integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked. | ||
| {% include integrations/remove_device_service.md %} | ||
|
anatosun marked this conversation as resolved.
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.