mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-12-10 00:30:02 -06:00
Merge branch 'current' into rc
This commit is contained in:
Franck Nijhof
commit
6fb9dd0398
2
.github/workflows/stale.yml
vendored
2
.github/workflows/stale.yml
vendored
@ -12,7 +12,7 @@ jobs:
|
||||
pull-requests: write
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/stale@5f858e3efba33a5ca4407a664cc011ad407f2008 # v10.1.0
|
||||
- uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10.1.1
|
||||
if: ${{ github.repository_owner == 'home-assistant' }}
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
8
.github/workflows/test.yml
vendored
8
.github/workflows/test.yml
vendored
@ -8,9 +8,9 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out files from GitHub
|
||||
uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||
- name: Setting up Node.js
|
||||
uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
|
||||
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
|
||||
with:
|
||||
node-version: 20
|
||||
cache: "npm"
|
||||
@ -35,9 +35,9 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out files from GitHub
|
||||
uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
|
||||
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
|
||||
- name: Setting up Node.js
|
||||
uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
|
||||
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
|
||||
with:
|
||||
node-version: 20
|
||||
cache: "npm"
|
||||
|
||||
@ -83,7 +83,7 @@ GEM
|
||||
rb-inotify (~> 0.9, >= 0.9.10)
|
||||
logger (1.7.0)
|
||||
mercenary (0.4.0)
|
||||
multi_json (1.17.0)
|
||||
multi_json (1.18.0)
|
||||
mustermann (3.0.4)
|
||||
ruby2_keywords (~> 0.0.1)
|
||||
nokogiri (1.18.10-arm64-darwin)
|
||||
@ -167,7 +167,7 @@ GEM
|
||||
tzinfo-data (1.2025.2)
|
||||
tzinfo (>= 1.0.0)
|
||||
unicode-display_width (2.6.0)
|
||||
webrick (1.9.1)
|
||||
webrick (1.9.2)
|
||||
|
||||
PLATFORMS
|
||||
arm64-darwin-23
|
||||
|
||||
643
package-lock.json
generated
643
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -15,7 +15,7 @@
|
||||
"remark-lint-prohibited-strings": "^4.0.0",
|
||||
"remark-lint-unordered-list-marker-style": "^4.0.1",
|
||||
"remark-stringify": "^11.0.0",
|
||||
"textlint": "^15.4.0",
|
||||
"textlint": "^15.4.1",
|
||||
"textlint-filter-rule-allowlist": "^4.0.0",
|
||||
"textlint-filter-rule-comments": "^1.2.2",
|
||||
"textlint-rule-common-misspellings": "^1.0.1",
|
||||
|
||||
@ -53,7 +53,7 @@ The IEC62056-21 is a common protocol not only for electric meters. It uses an in
|
||||
|
||||
#### Using (Smart Message Language) interface
|
||||
|
||||
In countries like Germany, SML (Smart Message Language) is used typically. ESPHome's [SML (Smart Message Language)](https://esphome.io/components/sml.html) is one way to integrate it. If you prefer to integrate it via MQTT, [sml2mqtt](https://github.com/spacemanspiff2007/sml2mqtt) is another open source option.
|
||||
In countries like Germany, SML (Smart Message Language) is used typically. ESPHome's [SML (Smart Message Language)](https://esphome.io/components/sml/) is one way to integrate it. If you prefer to integrate it via MQTT, [sml2mqtt](https://github.com/spacemanspiff2007/sml2mqtt) is another open source option.
|
||||
|
||||
#### Read the meter using an AI-on-the-edge-device
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
Current transformer (CT) clamp sensors measure your energy usage by looking at the current passing through an electrical wire. This makes it possible to calculate the energy usage. In Home Assistant we have support for off-the-shelf CT clamp sensors or you can build your own.
|
||||
|
||||
- The off-the-shelf solution that we advise is the [Shelly EM](https://www.shelly.com/products/shelly-em-50a-clamp-1?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality [integration](/integrations/shelly/).
|
||||
- You can build your own using ESPHome's [CT Clamp Current sensor](https://esphome.io/components/sensor/ct_clamp.html) or energy meter sensors like the [ATM90E32](https://esphome.io/components/sensor/atm90e32.html). For the DIY route, check out [this video by digiblur](https://www.youtube.com/watch?v=n2XZzciz0s4) to get started.
|
||||
- You can build your own using ESPHome's [CT Clamp Current sensor](https://esphome.io/components/sensor/ct_clamp/) or energy meter sensors like the [ATM90E32](https://esphome.io/components/sensor/atm90e32/). For the DIY route, check out [this video by digiblur](https://www.youtube.com/watch?v=n2XZzciz0s4) to get started.
|
||||
- Using a Raspberry Pi, you can use a CT clamp HAT from LeChacal called [RPICT hats](https://lechacal.com/docs/RPICT/Raspberrypi_Current_and_Temperature_Sensor_Adaptor/). They can be stacked to expand the number of lines to monitor. They also provide Active, Apparent, and Reactive power and power factor for single-phase and three-phase installations. They integrate with Home Assistant using MQTT.
|
||||
|
||||
_Attention! Installing CT clamp sensor devices requires opening your electrical cabinet. This work should be done by someone familiar with electrical wiring and may require a licensed professional in some regions. Your qualified installer will know how to do this._
|
||||
|
||||
@ -49,7 +49,7 @@
|
||||
<div class="grid__item one-quarter lap-one-half palm-one-whole">
|
||||
<h3>Companion apps</h3>
|
||||
<ul>
|
||||
<li><a class="external-link" href="https://apps.apple.com/us/app/home-assistant/id1099568401">iOS and Apple devices</a></li>
|
||||
<li><a class="external-link" href="https://apps.apple.com/app/home-assistant/id1099568401">iOS and Apple devices</a></li>
|
||||
<li><a class="external-link" href="https://play.google.com/store/apps/details?id=io.homeassistant.companion.android">Android and Wear OS</a></li>
|
||||
<li><a class="external-link" href="https://companion.home-assistant.io/">...and more!</a></li>
|
||||
</ul>
|
||||
|
||||
@ -118,5 +118,5 @@ This integration follows standard integration removal, no extra steps are requir
|
||||
|
||||
{% details "Device not discovered or found" %}
|
||||
|
||||
Make sure your scale is turned on and in Bluetooth range to your Home Assistant instance. [ESPHome Bluetooth Proxies](https://esphome.io/components/bluetooth_proxy.html) are a great way to increase the range if your instance is too far away. Turn on debug settings in the acaia integration and check your logs.
|
||||
Make sure your scale is turned on and in Bluetooth range to your Home Assistant instance. [ESPHome Bluetooth Proxies](https://esphome.io/components/bluetooth_proxy/) are a great way to increase the range if your instance is too far away. Turn on debug settings in the acaia integration and check your logs.
|
||||
{% enddetails %}
|
||||
|
||||
@ -15,11 +15,11 @@ ha_platforms:
|
||||
ha_integration_type: service
|
||||
---
|
||||
|
||||
The **Airly** {% term integration %} uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location.
|
||||
The **Airly** {% term integration %} uses the [Airly](https://airly.org/) web service as a source for air quality data for your location.
|
||||
|
||||
## Setup
|
||||
|
||||
To generate an Airly API key, go to [Airly for developers](https://developer.airly.eu/register) page.
|
||||
To generate an Airly API key, go to [Airly for developers](https://developer.airly.org/register) page.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -107,6 +107,10 @@ This action essentially allows you to control Alexa using text commands rather t
|
||||
|
||||
This action allows you to play one of the built-in Alexa sounds. The full list of sounds is available in [Amazon's documentation (needs authentication)](https://alexa.amazon.com/api/behaviors/entities?skillId=amzn1.ask.1p.sound)
|
||||
|
||||
{%tip%}
|
||||
Additional sounds are available through advanced markup using the `notify.send_message` [action](#action-notifysend_message)
|
||||
{%endtip%}
|
||||
|
||||
| Data attribute | Optional | Description |
|
||||
| -------------- | -------- | ----------------------------------------- |
|
||||
| `device_id` | no | Device on which you want to play sound |
|
||||
|
||||
@ -28,9 +28,9 @@ These models are also recognizable by the required curved salt blocks.
|
||||
- [HarveyArc Water Softener](https://www.harveywatersofteners.co.uk/products/water-softeners/harveyarc-water-softener)
|
||||
- [TwinTec Cobalt](https://www.twintec.com/our-products/tt-cobalt/)
|
||||
|
||||
The Mijn AquaCell app can be found on the [Apple App Store](https://apps.apple.com/us/app/mijn-aquacell/id1632415201) or on [Google Play](https://play.google.com/store/apps/details?id=com.aquacell.sws).
|
||||
The Mijn AquaCell app can be found on the [Apple App Store](https://apps.apple.com/app/mijn-aquacell/id1632415201) or on [Google Play](https://play.google.com/store/apps/details?id=com.aquacell.sws).
|
||||
|
||||
The myHarvey app can be found on the [Apple App Store](https://apps.apple.com/us/app/myharvey/id1551338436) or on [Google Play](https://play.google.com/store/apps/details?id=com.harvey.sws).
|
||||
The myHarvey app can be found on the [Apple App Store](https://apps.apple.com/app/myharvey/id1551338436) or on [Google Play](https://play.google.com/store/apps/details?id=com.harvey.sws).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ ha_integration_type: integration
|
||||
ha_zeroconf: true
|
||||
---
|
||||
|
||||
[BleBox](https://blebox.eu/?lang=en) produces small, low-power, surprisingly affordable, feature-rich WiFi devices for serverless home automation.
|
||||
[BleBox](https://blebox.eu/) produces small, low-power, surprisingly affordable, feature-rich WiFi devices for serverless home automation.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -343,12 +343,12 @@ When switching to an adapter with better performance, disable the old, less perf
|
||||
|
||||
The below adapters are listed from best-performing to worst-performing:
|
||||
|
||||
- [Ethernet-connected Bluetooth proxies](#remote-adapters-bluetooth-proxies) running ESPHome 2023.6.0 or later with [passive scanning](https://esphome.io/components/esp32_ble_tracker.html#configuration-variables)
|
||||
- [Ethernet-connected Bluetooth proxies](#remote-adapters-bluetooth-proxies) running ESPHome 2023.6.0 or later with [passive scanning](https://esphome.io/components/esp32_ble_tracker/#configuration-variables)
|
||||
- [USB High performance adapter](#known-working-high-performance-adapters) with [passive scanning](#passive-scanning)
|
||||
- [Wi-Fi-connected Bluetooth proxies](#remote-adapters-bluetooth-proxies) running ESPHome 2023.6.0 or later with [passive scanning](https://esphome.io/components/esp32_ble_tracker.html#configuration-variables)
|
||||
- [Ethernet-connected Bluetooth proxies](#remote-adapters-bluetooth-proxies) running ESPHome 2023.6.0 or later with [active scanning](https://esphome.io/components/esp32_ble_tracker.html#configuration-variables)
|
||||
- [Wi-Fi-connected Bluetooth proxies](#remote-adapters-bluetooth-proxies) running ESPHome 2023.6.0 or later with [passive scanning](https://esphome.io/components/esp32_ble_tracker/#configuration-variables)
|
||||
- [Ethernet-connected Bluetooth proxies](#remote-adapters-bluetooth-proxies) running ESPHome 2023.6.0 or later with [active scanning](https://esphome.io/components/esp32_ble_tracker/#configuration-variables)
|
||||
- [USB High performance adapter](#known-working-high-performance-adapters) with active scanning
|
||||
- [Wi-Fi-connected Bluetooth proxies](#remote-adapters-bluetooth-proxies) running ESPHome 2023.6.0 or later with [active scanning](https://esphome.io/components/esp32_ble_tracker.html#configuration-variables)
|
||||
- [Wi-Fi-connected Bluetooth proxies](#remote-adapters-bluetooth-proxies) running ESPHome 2023.6.0 or later with [active scanning](https://esphome.io/components/esp32_ble_tracker/#configuration-variables)
|
||||
- [Onboard high performance adapter](#cypress-based-adapters) with [passive scanning](#passive-scanning)
|
||||
- [Onboard high performance adapter](#cypress-based-adapters) with active scanning
|
||||
- [Known working adapters](#known-working-adapters) with [passive scanning](#passive-scanning)
|
||||
|
||||
@ -34,7 +34,7 @@ The **Bring!** integration allows you to sync your [Bring!](https://www.getbring
|
||||
|
||||
**Bring!** is a grocery shopping list app that allows users to create shared lists and organize grocery shopping with family, partners, or roommates.
|
||||
|
||||
Available as a mobile app on [Google Play for Android](https://play.google.com/store/apps/details?id=ch.publisheria.bring) and the [App Store for iOS](https://itunes.apple.com/app/apple-store/id580669177). **Bring!** also offers a web version at [web.getbring.com](https://web.getbring.com).
|
||||
Available as a mobile app on [Google Play for Android](https://play.google.com/store/apps/details?id=ch.publisheria.bring) and the [App Store for iOS](https://apps.apple.com/app/id580669177). **Bring!** also offers a web version at [web.getbring.com](https://web.getbring.com).
|
||||
|
||||
## How you can use this integration
|
||||
|
||||
|
||||
@ -41,11 +41,11 @@ api_key:
|
||||
required: true
|
||||
type: string
|
||||
recipient:
|
||||
description: An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like `+14151234567`. This is the phone number that you want to call and notify via TTS, see [ClickSend Documentation](https://developers.clicksend.com/docs/rest/v3/#Send-Voice-Message) for more info.
|
||||
description: An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like `+14151234567`. This is the phone number that you want to call and notify via TTS, see [ClickSend Documentation](https://developers.clicksend.com/docs/messaging/voice-messaging/other/send-voice-message) for more info.
|
||||
required: true
|
||||
type: string
|
||||
language:
|
||||
description: The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](https://developers.clicksend.com/docs/rest/v3/#Send-Voice-Message).
|
||||
description: The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](https://developers.clicksend.com/docs/messaging/voice-messaging/other/send-voice-message).
|
||||
required: false
|
||||
default: en-us
|
||||
type: string
|
||||
|
||||
@ -28,7 +28,7 @@ As the device doesn't contain a temperature sensor ([read more](https://forum.fh
|
||||
|
||||
Pairing your eQ-3 Bluetooth Smart Thermostat device works differently based on your method of connection and the device's firmware version.
|
||||
|
||||
#### [ESPHome Bluetooth Proxies](https://esphome.io/components/bluetooth_proxy.html)
|
||||
#### [ESPHome Bluetooth Proxies](https://esphome.io/components/bluetooth_proxy/)
|
||||
|
||||
For firmware versions below 148, no additional configuration is required when using ESPHome Bluetooth Proxies.
|
||||
Since version 148, a security flaw in the devices has been fixed that now requires entering a passkey.
|
||||
@ -50,7 +50,7 @@ ble_client:
|
||||
passkey: <PIN code displayed on the thermostat. To display the PIN hold down the main button.>
|
||||
```
|
||||
|
||||
For further information see the [ESPHome documentation](https://esphome.io/components/ble_client.html#on-passkey-request).
|
||||
For further information see the [ESPHome documentation](https://esphome.io/components/ble_client/#on_passkey_request).
|
||||
|
||||
#### Other
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ ha_quality_scale: platinum
|
||||
|
||||
## Overview
|
||||
|
||||
The **ESPHome** {% term integration %} allows [ESPHome](https://esphome.io) devices to connect directly to Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html).
|
||||
The **ESPHome** {% term integration %} allows [ESPHome](https://esphome.io) devices to connect directly to Home Assistant with the [native ESPHome API](https://esphome.io/components/api/).
|
||||
|
||||
ESPHome is a firmware generator and configuration system that enables the transformation of microcontrollers into fully customizable smart home devices. Using a simple YAML configuration file, ESPHome allows users to define hardware components like sensors, actuators, and peripherals. These configurations are then compiled into custom firmware that can be flashed onto the target device.
|
||||
|
||||
@ -56,7 +56,7 @@ ESPHome is a firmware generator and configuration system that enables the transf
|
||||
|
||||
- **YAML Configuration**: Specify hardware components, sensors, actuators, and integrations using a clean and straightforward YAML syntax.
|
||||
- **Custom Firmware Generation**: ESPHome compiles the provided configuration into a highly optimized, device-specific firmware image that is ready to be flashed onto microcontrollers.
|
||||
- **Seamless Integration**: After flashing, ESPHome devices can integrate seamlessly with Home Assistant using the ESPHome native API. This documentation page focuses on the [native API](https://esphome.io/components/api.html), which allows devices to communicate directly with Home Assistant for real-time automation and monitoring. For other integrations, such as MQTT or HTTP, please refer to the relevant sections of the [ESPHome documentation](https://esphome.io/).
|
||||
- **Seamless Integration**: After flashing, ESPHome devices can integrate seamlessly with Home Assistant using the ESPHome native API. This documentation page focuses on the [native API](https://esphome.io/components/api/), which allows devices to communicate directly with Home Assistant for real-time automation and monitoring. For other integrations, such as MQTT or HTTP, please refer to the relevant sections of the [ESPHome documentation](https://esphome.io/).
|
||||
|
||||
ESPHome supports a variety of microcontrollers beyond just the ESP family. These include:
|
||||
|
||||
@ -68,7 +68,7 @@ ESPHome supports a variety of microcontrollers beyond just the ESP family. These
|
||||
|
||||
For a list of officially supported microcontrollers and devices, refer to the [ESPHome device database](https://devices.esphome.io/). Keep in mind that this database represents only a portion of the ecosystem—many other devices and peripherals are supported but may not appear in the database.
|
||||
|
||||
For inspiration and examples of complete, ready-to-use configurations, check out the [ESPHome ready-made projects](https://esphome.io/projects/index.html). These include setups like [Bluetooth proxies](https://esphome.io/components/bluetooth_proxy.html), which can extend the [Bluetooth](/integrations/bluetooth/#remote-adapters-bluetooth-proxies) range of Home Assistant.
|
||||
For inspiration and examples of complete, ready-to-use configurations, check out the [ESPHome ready-made projects](https://esphome.io/projects/index.html). These include setups like [Bluetooth proxies](https://esphome.io/components/bluetooth_proxy/), which can extend the [Bluetooth](/integrations/bluetooth/#remote-adapters-bluetooth-proxies) range of Home Assistant.
|
||||
|
||||
If you're looking for pre-built solutions, the [Voice PE](https://www.home-assistant.io/voice-pe/) is an excellent example. It's a pre-built voice assistant device powered by ESPHome, offering an easy way to integrate voice control into your Home Assistant system. Many pre-built solutions, like the Voice PE, are open-source and can be customized, giving you flexibility to adapt them to your needs.
|
||||
|
||||
@ -93,7 +93,7 @@ password:
|
||||
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
For more information, see the [ESPHome Native API Component documentation](https://esphome.io/components/api.html).
|
||||
For more information, see the [ESPHome Native API Component documentation](https://esphome.io/components/api/).
|
||||
|
||||
{% include integrations/option_flow.md %}
|
||||
|
||||
@ -108,7 +108,7 @@ Subscribe to logs from the device:
|
||||
|
||||
## Supported devices
|
||||
|
||||
The ESPHome {% term integration %} works with devices that run ESPHome firmware and expose their functionality through the [native ESPHome API](https://esphome.io/components/api.html). This API is designed for tight, efficient integration with Home Assistant, enabling ESPHome devices to push updates directly to Home Assistant in **near real time**.
|
||||
The ESPHome {% term integration %} works with devices that run ESPHome firmware and expose their functionality through the [native ESPHome API](https://esphome.io/components/api/). This API is designed for tight, efficient integration with Home Assistant, enabling ESPHome devices to push updates directly to Home Assistant in **near real time**.
|
||||
|
||||
## Updating data
|
||||
|
||||
@ -125,27 +125,27 @@ This real-time behavior enables fast, reactive automations and a smooth user exp
|
||||
|
||||
### Entities
|
||||
|
||||
The available entities depend on the components defined in the ESPHome YAML configuration for each device. These entities are exposed through the [Native API Component](https://esphome.io/components/api.html).
|
||||
The available entities depend on the components defined in the ESPHome YAML configuration for each device. These entities are exposed through the [Native API Component](https://esphome.io/components/api/).
|
||||
|
||||
### Firing events on the Home Assistant event bus
|
||||
|
||||
When using the native API with Home Assistant, you can trigger events on the Home Assistant event bus directly from ESPHome. For more details, see the [homeassistant.event Action](https://esphome.io/components/api.html#homeassistant-event-action).
|
||||
When using the native API with Home Assistant, you can trigger events on the Home Assistant event bus directly from ESPHome. For more details, see the [homeassistant.event Action](https://esphome.io/components/api/#homeassistantevent-action).
|
||||
|
||||
### Actions
|
||||
|
||||
Each device can define Home Assistant Actions based on its ESPHome YAML configuration. For more information, refer to the [Actions](https://esphome.io/components/api.html#actions) section in the [Native API Component](https://esphome.io/components/api.html) documentation.
|
||||
Each device can define Home Assistant Actions based on its ESPHome YAML configuration. For more information, refer to the [Actions](https://esphome.io/components/api/#actions) section in the [Native API Component](https://esphome.io/components/api/) documentation.
|
||||
|
||||
### Retrieving data from Home Assistant
|
||||
|
||||
ESPHome can retrieve the state of Home Assistant entities using the [Native API](https://esphome.io/components/api.html) with [User-Defined Actions](https://esphome.io/components/api.html#user-defined-actions).
|
||||
ESPHome can retrieve the state of Home Assistant entities using the [Native API](https://esphome.io/components/api/) with [User-Defined Actions](https://esphome.io/components/api/#user-defined-actions).
|
||||
|
||||
### Home Assistant actions
|
||||
|
||||
ESPHome devices can call any [Home Assistant Action](https://esphome.io/components/api.html#homeassistant-service-action). This feature is not enabled by default for newly added devices but can be enabled through the options flow on a per-device basis.
|
||||
ESPHome devices can call any [Home Assistant Action](https://esphome.io/components/api/#homeassistantaction-action). This feature is not enabled by default for newly added devices but can be enabled through the options flow on a per-device basis.
|
||||
|
||||
### Tag scanning support
|
||||
|
||||
The [Native API Component](https://esphome.io/components/api.html) also supports sending tag scan events to Home Assistant. See the [homeassistant.tag_scanned Action](https://esphome.io/components/api.html#homeassistant-tag-scanned-action) for more information.
|
||||
The [Native API Component](https://esphome.io/components/api/) also supports sending tag scan events to Home Assistant. See the [homeassistant.tag_scanned Action](https://esphome.io/components/api/#homeassistanttag_scanned-action) for more information.
|
||||
|
||||
## Entity naming and IDs
|
||||
|
||||
@ -204,7 +204,7 @@ To troubleshoot your ESPHome devices, you can easily view live logs, whether you
|
||||
|
||||
#### Using the **ESPHome CLI**
|
||||
|
||||
If you're using the **ESPHome CLI**, follow the instructions for the [logs Command](https://esphome.io/guides/cli.html#logs-command) to access the logs.
|
||||
If you're using the **ESPHome CLI**, follow the instructions for the [logs Command](https://esphome.io/guides/cli/#logs-command) to access the logs.
|
||||
|
||||
### Obtaining logs from the device
|
||||
|
||||
@ -229,7 +229,7 @@ This integration supports reconfiguration, allowing you to make changes—such a
|
||||
|
||||
### Name conflict resolution
|
||||
|
||||
If Home Assistant detects multiple devices with the same [**name**](https://esphome.io/components/esphome.html#configuration-variables), it will automatically initiate **Name Conflict Resolution**. This process is designed to help you seamlessly replace a failed or retired device with new hardware, while preserving your existing configuration if desired.
|
||||
If Home Assistant detects multiple devices with the same [**name**](https://esphome.io/components/esphome/#configuration-variables), it will automatically initiate **Name Conflict Resolution**. This process is designed to help you seamlessly replace a failed or retired device with new hardware, while preserving your existing configuration if desired.
|
||||
|
||||
This process gives you two options:
|
||||
|
||||
@ -248,7 +248,7 @@ If you’re using the same YAML file on the new device, choose **Migrate**. If i
|
||||
To trigger Name Conflict Resolution, all of the following must be true:
|
||||
|
||||
- The new device must be running **ESPHome 2025.4.0 or later**.
|
||||
- The new device must use the same [**name**](https://esphome.io/components/esphome.html#configuration-variables) (not just the friendly name).
|
||||
- The new device must use the same [**name**](https://esphome.io/components/esphome/#configuration-variables) (not just the friendly name).
|
||||
- The original (old) device must be **offline**.
|
||||
|
||||
---
|
||||
|
||||
@ -249,11 +249,11 @@ percentage_command_template:
|
||||
required: false
|
||||
type: template
|
||||
percentage_command_topic:
|
||||
description: The MQTT topic to publish commands to change the fan speed state based on a percentage.
|
||||
description: The MQTT topic to publish commands to change the fan speed state based on a percentage setting. The value shall be in the range from `speed_range_min` to `speed_range_max`.
|
||||
required: false
|
||||
type: string
|
||||
percentage_state_topic:
|
||||
description: The MQTT topic subscribed to receive fan speed based on percentage.
|
||||
description: The MQTT topic subscribed to receive fan speed state. This is a value in the range from `speed_range_min` to `speed_range_max`.
|
||||
required: false
|
||||
type: string
|
||||
percentage_value_template:
|
||||
|
||||
@ -17,7 +17,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
[Go flipr](https://www.goflipr.com) company sells smart pool monitor and management devices. The Flipr and Flipr Hub devices publish data to the cloud via Wi-Fi and SigFox.
|
||||
Go flipr company sells smart pool monitor and management devices. The Flipr and Flipr Hub devices publish data to the cloud via Wi-Fi and SigFox.
|
||||
This {% term integration %} gives you access on Home Assistant to the information measured by your Flipr with the same data as the vendor's smartphone application.
|
||||
This {% term integration %} gives you also access to the Flipr Hub to control your pool equipments like pump, heater, light, etc.
|
||||
|
||||
@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
You will need to use the standalone app for this device to register a username and password.
|
||||
|
||||
- [Google](https://play.google.com/store/apps/details?id=com.goflipr.flipr)
|
||||
- [Apple](https://apps.apple.com/fr/app/flipr/id1225898851)
|
||||
- [Apple](https://apps.apple.com/app/flipr/id1225898851)
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ This integration lets you control all [Freedompro](https://freedompro.eu/) acces
|
||||
|
||||
You will need to obtain an API key from Freedompro's app to use this integration.
|
||||
|
||||
1. Download the app on your phone: ([Android](https://play.google.com/store/apps/details?id=eu.freedompro.app&hl=en&gl=US) / [iOS](https://apps.apple.com/en/app/freedompro/id1598082027)).
|
||||
1. Download the app on your phone: ([Android](https://play.google.com/store/apps/details?id=eu.freedompro.app) / [iOS](https://apps.apple.com/app/id1598082027)).
|
||||
2. Register and create your first home.
|
||||
3. Make sure you have at least one accessory paired with the Freedompro Cloud before starting integration.
|
||||
4. Switch to the **Profile** tab (bottom right corner).
|
||||
|
||||
@ -33,6 +33,7 @@ The integration supports all inverters with integrated Datamanager or external "
|
||||
- Symo
|
||||
- Symo Hybrid
|
||||
- Tauro
|
||||
- Verto (Plus)
|
||||
|
||||
Devices connected to those inverters or dataloggers are supported as well.
|
||||
|
||||
|
||||
@ -25,7 +25,6 @@ The Google Assistant SDK integration allows Home Assistant to interact with Goog
|
||||
This integration allows:
|
||||
|
||||
- Sending text commands to Google Assistant to control devices supported by Google Assistant but not by Home Assistant. Examples:
|
||||
- Set Nest Guard to home and guarding
|
||||
- Start vacuuming
|
||||
- Stream front door on living room TV
|
||||
- Turn off kitchen TV
|
||||
|
||||
@ -74,10 +74,10 @@ To get the Estimated distance sensor to work, in most cases, it has to be calibr
|
||||
- Blue Charm Beacons BC037G-GeoPattern-iBeacon (discontinued)
|
||||
- Blue Charm Beacons BC037S-SmoothPattern-iBeacon (discontinued)
|
||||
- [Blue SLIM ID](https://elainnovation.com/en/catalogue/blue-slim-id-en/)
|
||||
- [Feasycom FSC-BP103B](https://www.feasycom.com/bluetooth-ibeacon-da14531)
|
||||
- [Feasycom FSC-BP104D](https://www.feasycom.com/dialog-da14531-bluetooth-low-energy-beacon)
|
||||
- [Feasycom FSC-BP103B](https://www.feasycom.com/product/fsc-bp103b/)
|
||||
- [Feasycom FSC-BP104D](https://www.feasycom.com/product/fsc-bp104d/)
|
||||
- [Feasycom FSC-BP106](https://www.feasycom.com/fsc-bp106)
|
||||
- [Feasycom FSC-BP108](https://www.feasycom.com/bluetooth-5-1-waterproof-bluetooth-beacon)
|
||||
- [Feasycom FSC-BP108](https://www.feasycom.com/product/fsc-bp108b/)
|
||||
- [MikroTik TG-BT5-IN](https://mikrotik.com/product/tg_bt5_in) (Additional sensors such as angle or impact are not compatible)
|
||||
- [NRF51822 iBeacon](https://www.aliexpress.com/item/32826502025.html)
|
||||
- [NRF52810 iBeacon](https://www.aliexpress.com/item/1005003211033416.html)
|
||||
|
||||
@ -21,7 +21,7 @@ The iotty {% term integration%} lets you integrate iotty devices into Home Assis
|
||||
## Prerequisites
|
||||
|
||||
In order to use this integration, you must have an iotty account, and enter its credentials during account pairing.
|
||||
To create an iotty account, you need to get the App from the [App Store](https://apps.apple.com/it/app/iotty-smart-home/id1230937401) or [Play Store](https://play.google.com/store/apps/details?id=com.dynamicait.iotty&hl=en).
|
||||
To create an iotty account, you need to get the App from the [App Store](https://apps.apple.com/app/iotty-smart-home/id1230937401) or [Play Store](https://play.google.com/store/apps/details?id=com.dynamicait.iotty).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ ha_config_flow: true
|
||||
ha_integration_type: device
|
||||
---
|
||||
|
||||
This integration allows you to locally control a [MicroBot Push](https://keymitt.com/products/microbot-push) (previously manufactured by Naran but now under the Keymitt brand).
|
||||
This integration allows you to locally control a MicroBot Push (previously manufactured by Naran but now under the Keymitt brand).
|
||||
|
||||
### Prerequisites
|
||||
|
||||
|
||||
@ -12,11 +12,11 @@ ha_config_flow: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
This platform allows you to detect presence using [Locative](https://www.locative.app/). Locative is an open source app for [iOS](https://apps.apple.com/us/app/locative/id725198453?ign-mpt=uo%3D4) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
|
||||
This platform allows you to detect presence using [Locative](https://www.locative.app/). Locative is an open source app for [iOS](https://apps.apple.com/app/id725198453) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
|
||||
|
||||
Install on your smartphone:
|
||||
|
||||
- [iOS](https://apps.apple.com/us/app/locative/id725198453?ign-mpt=uo%3D4)
|
||||
- [iOS](https://apps.apple.com/app/id725198453)
|
||||
|
||||
To configure Locative, you must set it up via the integrations panel in the configuration screen. You must set up the app to send a POST request to your Home Assistant instance at the webhook URL provided by the integration during setup. When you enter or exit a geofence, Locative will send the appropriate request to that URL, updating Home Assistant. You are not able to specify a device name in Locative. Instead, you will need to look in your `dev-state` menu for a new device that Locative will have created on its first `GET`. If you had been or are using Owntracks as well, you will need to update the device name used in the Owntracks setup with the name that Locative generated.
|
||||
|
||||
|
||||
@ -27,9 +27,9 @@ ha_integration_type: integration
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron` integration in Home Assistant is responsible for communicating with the main hub for these systems.
|
||||
[Lutron](https://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron` integration in Home Assistant is responsible for communicating with the main hub for these systems.
|
||||
|
||||
Presently, there's only support for communicating with the [RadioRA 2](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RadioRA2/Overview.aspx) Main Repeater and only handle light switches, dimmers, and seeTouch keypad scenes.
|
||||
Presently, there's only support for communicating with the RadioRA 2 Main Repeater and only handle light switches, dimmers, and seeTouch keypad scenes.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -33,9 +33,9 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](https://www.casetawireless.com/) product line of dimmers, switches, shades, and sensors. It will also communicate with the Lutron Radio RA2 Main Repeater for the [RA2 Select](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RA2Select/Overview.aspx) product line of dimmers, switches, shades, and sensors.
|
||||
[Lutron](https://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](https://www.casetawireless.com/) product line of dimmers, switches, shades, and sensors. It will also communicate with the Lutron Radio RA2 Main Repeater for the [RA2 Select](https://www.lutron.com/controls/systems/ra2select) product line of dimmers, switches, shades, and sensors.
|
||||
|
||||
This integration supports the [Caséta](https://www.casetawireless.com/), [RA2 Select](https://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RA2Select/Overview.aspx), [RadioRA 3](https://radiora3.lutron.com/), and [Homeworks QSX](https://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/Homeworks/Overview.aspx) **(not QS)** lines of products.
|
||||
This integration supports the [Caséta](https://www.casetawireless.com/), [RA2 Select](https://www.lutron.com/controls/systems/ra2select), [RadioRA 3](https://radiora3.lutron.com/), and [Homeworks QSX](https://residential.lutron.com/homeworks) **(not QS)** lines of products.
|
||||
|
||||
Supports Bridges:
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ The Mobile App integration allows Home Assistant mobile apps to easily integrate
|
||||
|
||||
If you are planning to use a mobile application that integrates with Home Assistant, we recommend that you keep this integration enabled.
|
||||
|
||||
If you are a mobile app developer, see the [developer documentation](https://developers.home-assistant.io/docs/api/native-app-integration.html) for instructions on how to build your app on top of the mobile app component.
|
||||
If you are a mobile app developer, see the [developer documentation](https://developers.home-assistant.io/docs/api/native-app-integration/) for instructions on how to build your app on top of the mobile app component.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -35,7 +35,7 @@ mobile_app:
|
||||
|
||||
## Apps that use Mobile App
|
||||
|
||||
- [Home Assistant for iOS](https://apps.apple.com/us/app/home-assistant/id1099568401?ls=1) (official)
|
||||
- [Home Assistant for iOS](https://apps.apple.com/app/home-assistant/id1099568401?ls=1) (official)
|
||||
- [Beta release](https://testflight.apple.com/join/1AlPbnLZ) (Testflight)
|
||||
- [Home Assistant for Android](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android) (official)
|
||||
- [Beta release](https://play.google.com/apps/testing/io.homeassistant.companion.android)
|
||||
|
||||
@ -28,14 +28,14 @@ Additionally the following brands have been reported to also work with this inte
|
||||
- [Brel Home](https://www.brel-home.nl/)
|
||||
- [3 Day Blinds](https://www.3dayblinds.com/)
|
||||
- [Decorquip Dream](https://www.decorquip.com/post.php?dream)
|
||||
- [Diaz](https://www.diaz.be/en/)
|
||||
- [Diaz](https://www.diaz.be/)
|
||||
- [Dooya](http://www.dooya.com/)
|
||||
- [Gaviota](https://www.gaviotagroup.com/en/)
|
||||
- [Havana Shade](https://havanashade.com/)
|
||||
- Havana Shade
|
||||
- [Heicko](https://heicko.de/en/tubular-motors/controls/e-smart-home/usb-smart-home-stick-bi-direktional-1-st.html)
|
||||
- [Hurrican Shutters Wholesale](https://www.hurricaneshutterswholesale.com/)
|
||||
- [Inspired Shades](https://www.inspired-shades.com/)
|
||||
- [iSmartWindow](https://www.ismartwindow.co.nz/)
|
||||
- [iSmartWindow](https://www.autoblinds.co.nz/)
|
||||
- [Kaiser Nienhaus](https://www.kaiser-nienhaus.de/)
|
||||
- [Krispol](https://krispol.eu/en/drives/)
|
||||
- [Linx](https://linxautomation.com.au/)
|
||||
@ -48,7 +48,7 @@ Additionally the following brands have been reported to also work with this inte
|
||||
- [Smartblinds](https://www.smartblinds.nl/)
|
||||
- [Smart Home](https://www.smart-home.hu)
|
||||
- [Ublockout](https://www.ublockout.com/)
|
||||
- [Uprise Smart Shades](http://uprisesmartshades.com)
|
||||
- [Uprise Smart Shades](https://upriseshades.com/)
|
||||
|
||||
This integration allows for both directly controlling blinds that support wifi-connection and controlling Uni- and Bi-direction blinds that connect to a 433MHz WiFi bridge.
|
||||
The following bridges are reported to work with this integration:
|
||||
@ -81,7 +81,7 @@ In that app the key can often be found by clicking multiple times on specific pl
|
||||
|
||||
### Motionblinds app
|
||||
|
||||
The Motionblinds API uses a 16 character key that can be retrieved from the official "Motionblinds" app for [IOS](https://apps.apple.com/us/app/motion-blinds/id1437234324) or [Android](https://play.google.com/store/apps/details?id=com.coulisse.motion).
|
||||
The Motionblinds API uses a 16 character key that can be retrieved from the official "Motionblinds" app for [IOS](https://apps.apple.com/app/id1437234324) or [Android](https://play.google.com/store/apps/details?id=com.coulisse.motion).
|
||||
|
||||
Open the app, click the 3 dots in the top right corner, go to "settings", go to "Motion APP About", Please quickly tap this "Motion APP About" page 5 times, a popup will appear that gives you the key.
|
||||
|
||||
@ -107,7 +107,7 @@ In the 3 Day Blinds app go to the home screen, go to settings (three bars in the
|
||||
|
||||
### Connector app
|
||||
|
||||
To get the API key ([iOS app](https://apps.apple.com/us/app/connector/id1344058317), [Android app](https://play.google.com/store/apps/details?id=com.smarthome.app.connector)), follow these steps:
|
||||
To get the API key ([iOS app](https://apps.apple.com/app/id1344058317), [Android app](https://play.google.com/store/apps/details?id=com.smarthome.app.connector)), follow these steps:
|
||||
|
||||
1. In the left sidebar of the app, open the **Settings** {% icon "mdi:gear-outline" %} (gear icon).
|
||||
2. Select the **About** page of the Connector app.
|
||||
|
||||
@ -30,8 +30,8 @@ There is currently support for the following information within Home Assistant:
|
||||
|
||||
You will need to use the associated standalone app for this device to register a username and password.
|
||||
|
||||
- [Google](https://play.google.com/store/apps/details?id=co.proautomation.app.poolSense&hl=en_ZA)
|
||||
- [Apple](https://apps.apple.com/us/app/poolsense/id1288535609)
|
||||
- [Google](https://play.google.com/store/apps/details?id=co.proautomation.app.poolSense)
|
||||
- [Apple](https://apps.apple.com/app/poolsense/id1288535609)
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -60,7 +60,7 @@ This integration can be used to monitor food temperatures, you could combine thi
|
||||
|
||||
{% details "Device not discovered or found" %}
|
||||
|
||||
Make sure your probe is removed from the charging dock and the dock is within Bluetooth range to your Home Assistant instance. [ESPHome Bluetooth Proxies](https://esphome.io/components/bluetooth_proxy.html) are a great way to increase the range if your instance is too far away. Turn on debug settings in the Probe Plus integration and check your logs.
|
||||
Make sure your probe is removed from the charging dock and the dock is within Bluetooth range to your Home Assistant instance. [ESPHome Bluetooth Proxies](https://esphome.io/components/bluetooth_proxy/) are a great way to increase the range if your instance is too far away. Turn on debug settings in the Probe Plus integration and check your logs.
|
||||
{% enddetails %}
|
||||
|
||||
## Removing the integration
|
||||
|
||||
@ -15,7 +15,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
Integrates [RAPT Pill](https://www.kegland.com.au/rapt-pill-hydrometer-thermometer-wifi-bluetooth.html) hydrometers into Home Assistant.
|
||||
Integrates [RAPT Pill](https://kegland.com.au/products/yellow-rapt-pill-hydrometer-thermometer-wifi-bluetooth) hydrometers into Home Assistant.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -23,4 +23,4 @@ The RAPT Pill BLE integration will automatically discover devices once the [Blue
|
||||
|
||||
## Supported devices
|
||||
|
||||
- [RAPT Pill Hydrometer & Thermometer](https://www.kegland.com.au/rapt-pill-hydrometer-thermometer-wifi-bluetooth.html)
|
||||
- [RAPT Pill Hydrometer & Thermometer](https://kegland.com.au/products/yellow-rapt-pill-hydrometer-thermometer-wifi-bluetooth)
|
||||
|
||||
@ -27,6 +27,15 @@ This integration provides the following platforms:
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
{% configuration_basic %}
|
||||
Host:
|
||||
description: "The hostname, IP address, or full URL of your SFR device."
|
||||
Username (optional):
|
||||
description: "The username for accessing your SFR box's web interface. The default is 'admin'."
|
||||
Password (optional):
|
||||
description: "The password for accessing your SFR box's web interface. The default is the Wi-Fi security key found on the device label."
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## Compatibility
|
||||
|
||||
The integration uses the REST API, which is known to be available on models `NB4`, `NB5`, `NB6`, `NB6V`, and `NB6VAC`.
|
||||
|
||||
@ -56,6 +56,13 @@ Port:
|
||||
description: "Custom TCP port of the device. Change this only if the device is connected via Shelly Range Extender."
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
{% include integrations/option_flow.md %}
|
||||
|
||||
{% configuration_basic %}
|
||||
Bluetooth scanner mode:
|
||||
description: "The scanner mode to use for Bluetooth scanning. Bluetooth scanning can be active or passive. With active, the Shelly requests data from nearby devices. With passive, the Shelly receives unsolicited data from nearby devices."
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## Shelly device generations
|
||||
|
||||
There are four generations of devices and all generations are supported by this integration. There are some differences in how devices should be configured and in the naming of entities and devices between generations.
|
||||
@ -121,8 +128,6 @@ Shelly devices do **not** support proxying active (GATT) connections.
|
||||
|
||||
For more details, see [Remote Adapters](/integrations/bluetooth/#remote-adapters-bluetooth-proxies) in the [Bluetooth integration](/integrations/bluetooth).
|
||||
|
||||
{% include integrations/option_flow.md %}
|
||||
|
||||
## Range Extender Support
|
||||
|
||||
Shelly generation 2+ devices that are not battery-powered can act as a Range Extender.
|
||||
|
||||
@ -11,7 +11,7 @@ ha_integration_type: system
|
||||
|
||||
The System Health integration provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems.
|
||||
|
||||
System Health integration data can be viewed at **Settings** -> **System** -> **Repairs** -> **System Information** in the overflow menu (top right).
|
||||
System Health integration data can be viewed at **Settings** -> **System** -> **Repairs** -> **System Information** in the three dots menu (top right).
|
||||
|
||||
{% my system_health badge %}
|
||||
|
||||
|
||||
@ -10,12 +10,12 @@ ha_integration_type: integration
|
||||
ha_quality_scale: legacy
|
||||
---
|
||||
|
||||
The `thingspeak` integrations makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/).
|
||||
The `thingspeak` integrations makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.mathworks.com/).
|
||||
For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB integration](/integrations/influxdb/).
|
||||
|
||||
## Configuration
|
||||
|
||||
You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use.
|
||||
You will have to create a [new channel](https://thingspeak.mathworks.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use.
|
||||
|
||||
To setup the ThingSpeak integration in your installation, add the following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
|
||||
@ -141,6 +141,7 @@ Follow these steps if you want to turn Home Assistant into a Thread border route
|
||||
- [Enable Thread on Home Assistant Yellow](https://support.nabucasa.com/hc/en-us/articles/25742476767517).
|
||||
- [Enable Thread on Home Assistant Connect ZBT-1](https://support.nabucasa.com/hc/en-us/sections/26122472719517).
|
||||
- [Enable Thread on Home Assistant Connect ZBT-2](https://support.nabucasa.com/hc/en-us/sections/31260019451421).
|
||||
- [Adding a Thread adapter to Home Assistant](#adding-a-thread-adapter-to-home-assistant).
|
||||
|
||||
2. Make sure the Home Assistant Thread network is defined as preferred network.
|
||||
- This should happen automatically, but check to be sure.
|
||||
@ -192,15 +193,96 @@ Note: the steps and images here show the process with a Google Thread network. B
|
||||
|
||||
|
||||
|
||||
5. To enable Thread support on your Home Assistant Yellow, Connect ZBT-1, or [Connect ZBT-2](/connect/zbt-2/), you need to install the **OpenThread Border Router** add-on. Follow the corresponding procedure:
|
||||
5. To enable Thread support, you need to install the **OpenThread Border Router** add-on. Follow the corresponding procedure:
|
||||
- [Enable Thread on Home Assistant Yellow](https://support.nabucasa.com/hc/en-us/articles/25742476767517).
|
||||
- [Enable Thread on Home Assistant Connect ZBT-1](https://support.nabucasa.com/hc/en-us/sections/26122472719517).
|
||||
- [Enable Thread on Home Assistant Connect ZBT-2](https://support.nabucasa.com/hc/en-us/sections/31260019451421).
|
||||
- [Adding a Thread adapter to Home Assistant](#adding-a-thread-adapter-to-home-assistant).
|
||||
- **Result**: The network now shows as the preferred network, joined with the third-party network.
|
||||
|
||||
|
||||
- 🎉 You successfully created a Home Assistant Thread network and joined it with a pre-existing third-party network.
|
||||
|
||||
## Adding a third-party Thread adapter to Home Assistant
|
||||
|
||||
Follow these steps if you want to set up a third-party Thread adapter.
|
||||
|
||||
If you have a Home Assistant Thread adapter, follow the corresponding instructions instead:
|
||||
|
||||
- [Enable Thread on Home Assistant Yellow](https://support.nabucasa.com/hc/en-us/articles/25742476767517).
|
||||
- [Enable Thread on Home Assistant Connect ZBT-1](https://support.nabucasa.com/hc/en-us/sections/26122472719517).
|
||||
- [Enable Thread on Home Assistant Connect ZBT-2](https://support.nabucasa.com/hc/en-us/sections/31260019451421).
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Home Assistant Operating System](/docs/glossary/#home-assistant-operating-system) installed on your smart home hub. For example:
|
||||
- On a Home Assistant Green, where Home Assistant OS is preinstalled
|
||||
- On a Home Assistant Yellow or on a Raspberry Pi
|
||||
- Latest updates installed
|
||||
- A new Thread adapter and a USB extension cable
|
||||
- If your adapter supports multiple protocols:
|
||||
- They might have another firmware installed by default (Zigbee, for example).
|
||||
- Check their documentation and install the OpenThread firmware on the adapter.
|
||||
- Check their documentation and take a note of the baudrate.
|
||||
|
||||
### To add a Thread adapter to the OpenThread Border Router add-on
|
||||
|
||||
1. Install the **OpenThread Border Router** add-on.
|
||||
- Go to {% my supervisor_addon title="**Settings** > **Add-ons**" addon="core_openthread_border_router" %} and select the **OpenThread Border Router** add-on.
|
||||
2. Plug the adapter into the extension cable and plug it into the Home Assistant hub.
|
||||
3. Go to {% my supervisor_addon title="**Settings** > **Add-ons** > **OpenThread Border Router**" addon="core_openthread_border_router" %} and select the **Configuration** tab.
|
||||
4. Under **Devices**, select your adapter.
|
||||
5. Enter the **Baudrate** as specified in the documentation of your adapter.
|
||||
- If you can't find the baudrate, try `460800` or contact the manufacturer's support.
|
||||
- **Save** your changes.
|
||||
- **Troubleshooting**:
|
||||
- Check the logs.
|
||||
- If the add-on crashes or fails to communicate with the Thread integration: Toggle the **Hardware flow control** option and try again.
|
||||
6. Restart the add-on and check the logs. Wait.
|
||||
7. Go to {% my integrations title="**Settings** > **Devices & services**" %}, select the **Thread** integration.
|
||||
- Select the cogwheel {% icon "mdi:cog-outline" %}.
|
||||
- **Result**: You should now see a new `ha-thread` Thread network.
|
||||
- **Troubleshooting**: If you don't see the network there, go back to the add-on configuration and adjust your settings, if needed, and try again.
|
||||
|
||||
## Migrating a Thread network to a new adapter
|
||||
|
||||
Follow these steps if you already have a Thread adapter running but want to switch to a new adapter.
|
||||
|
||||
If you want to migrate to a Home Assistant Connect ZBT-2, follow the steps in the [Home Assistant Connect ZBT-2 documentation](https://support.nabucasa.com/hc/en-us/articles/32087461954589).
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Home Assistant Operating System](/docs/glossary/#home-assistant-operating-system) installed on your smart home hub. For example:
|
||||
- On a Home Assistant Green, where Home Assistant OS is preinstalled
|
||||
- On a Home Assistant Yellow or on a Raspberry Pi
|
||||
- Existing Thread adapter connected to your Home Assistant hub
|
||||
- Latest updates installed
|
||||
- A new Thread adapter and a USB extension cable
|
||||
- If your adapter supports multiple protocols:
|
||||
- They might have another firmware installed by default (Zigbee, for example).
|
||||
- Check their documentation and install the OpenThread firmware on the adapter.
|
||||
- Check their documentation and take a note of the baudrate.
|
||||
- Thread devices
|
||||
|
||||
### To migrate an existing Thread network to a new adapter
|
||||
|
||||
1. Plug the new adapter into the extension cable and plug it into the Home Assistant hub.
|
||||
2. Go to {% my supervisor_addon title="**Settings** > **Add-ons** > **OpenThread Border Router**" addon="core_openthread_border_router" %} and select the **Configuration** tab.
|
||||
3. Under **Devices**, select your adapter.
|
||||
4. Enter the **Baudrate** as specified in the documentation of your adapter.
|
||||
- If you can't find the baudrate, try `460800` or contact the manufacturer's support.
|
||||
- **Save** your changes.
|
||||
- **Troubleshooting**:
|
||||
- Check the logs.
|
||||
- If the add-on crashes or fails to communicate with the Thread integration: Toggle the **Hardware flow control** option and try again.
|
||||
5. Restart the add-on and check the logs. Wait.
|
||||
- **Info**: Your Thread network is managed by Home Assistant. It is not stored on the adapter. Migrating the adapter means that Home Assistant will start to use your new adapter's radio instead of the old one.
|
||||
6. Go to {% my integrations title="**Settings** > **Devices & services**" %}, select the **Thread** integration.
|
||||
- Select the cogwheel {% icon "mdi:cog-outline" %}.
|
||||
- **Result**: You should now see that the Thread network is still there.
|
||||
- **Troubleshooting**: If you don't see the network there, go back to the add-on configuration and adjust your settings, if needed, and try again.
|
||||
7. If you no longer want to use the old adapter, you can unplug it now.
|
||||
|
||||
## Understanding the Thread configuration page
|
||||
|
||||
This section explains why you might see multiple networks on the Thread configuration page and what this means for your network.
|
||||
|
||||
@ -29,11 +29,11 @@ Off time:
|
||||
|
||||
## YAML configuration
|
||||
|
||||
Alternatlively, this integration can be configured and set up manually via YAML instead. This has some additional functionality over the UI version.
|
||||
Alternatively, this integration can be configured and set up manually via YAML. This has some additional functionality over the UI setup.
|
||||
|
||||
The time ranges can be provided as absolute local time or using the `sunrise` or `sunset` keyword calculated based on the sun position for location. The location must be provided in the configuration.
|
||||
The time ranges can be provided as an absolute local time or by using the `sunrise` or `sunset` keyword, calculated based on the sun position for the location.
|
||||
|
||||
In addition for sun position based ranges, the negative or positive offset can be configured.
|
||||
In addition, for sun position-based ranges, a negative or positive offset can be configured.
|
||||
|
||||
To enable the Times of Day binary sensor in your installation, add the
|
||||
following to your {% term "`configuration.yaml`" %} file:
|
||||
|
||||
@ -42,7 +42,7 @@ ha_integration_type: integration
|
||||
ha_quality_scale: platinum
|
||||
---
|
||||
|
||||
The `tplink` integration allows you to control your [TP-Link Kasa Smart Home Devices](https://www.tp-link.com/kasa-smart/) and [TP-Link Tapo Devices](https://www.tapo.com/) such as cameras, doorbells, chimes, lights, plugs, wall switches, robot vacuums, hubs, and hub-attached devices.
|
||||
The `tplink` integration allows you to control your [TP-Link Kasa Smart Home Devices](https://www.kasasmart.com/) and [TP-Link Tapo Devices](https://www.tapo.com/) such as cameras, doorbells, chimes, lights, plugs, wall switches, robot vacuums, hubs, and hub-attached devices.
|
||||
|
||||
## How you can use this integration
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ toc: true
|
||||
%}</a
|
||||
>
|
||||
<a
|
||||
href="https://support.nabucasa.com/hc/en-us/categories/24638797677853-Home-Assistant-Green"
|
||||
href="https://support.nabucasa.com/hc/en-us/articles/24737667232413"
|
||||
class="button"
|
||||
target="_blank"
|
||||
>View tutorial {% include assets/chevron_right.html %}</a
|
||||
@ -94,7 +94,7 @@ toc: true
|
||||
<div>
|
||||
<b>TOOLS REQUIRED</b>
|
||||
<ul>
|
||||
<li>Raspberry Pi 4 or 5 with power supply</li>
|
||||
<li>Raspberry Pi 4 or 5 with power supply (minimum 2 GB RAM)</li>
|
||||
<li>MicroSD card</li>
|
||||
<li>Ethernet connection</li>
|
||||
</ul>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user