mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Merge branch 'current' into rc
This commit is contained in:
Franck Nijhof
commit
e1b6a3d56e
@ -126,6 +126,8 @@
|
||||
excerpt: >
|
||||
Each integration in Home Assistant has a unique identifier: The domain.
|
||||
It is often shown as the first part (before the dot) of entity IDs.
|
||||
aliases:
|
||||
- domains
|
||||
- term: Entity
|
||||
definition: |-
|
||||
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. Entities have states.
|
||||
@ -159,6 +161,8 @@
|
||||
definition: >-
|
||||
Groups are a way to organize your entities into a single unit.
|
||||
link: /integrations/group/
|
||||
aliases:
|
||||
- groups
|
||||
- term: HASS
|
||||
definition: >-
|
||||
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for
|
||||
@ -255,10 +259,14 @@
|
||||
definition: >-
|
||||
You can use notifications to send messages, pictures, and more, to devices.
|
||||
link: /integrations/#notifications
|
||||
- term: Packages
|
||||
aliases:
|
||||
- notifications
|
||||
- term: Package
|
||||
definition: >
|
||||
Packages allow you to bundle different component configurations together.
|
||||
link: /docs/configuration/packages/
|
||||
aliases:
|
||||
- packages
|
||||
- term: Platform
|
||||
definition: >-
|
||||
Platforms are building blocks provided by some integrations to be used by
|
||||
@ -270,6 +278,8 @@
|
||||
Platforms are building blocks provided by some integrations to be used by
|
||||
other integrations.
|
||||
link: /docs/configuration/platform_options/
|
||||
aliases:
|
||||
- platforms
|
||||
- term: Reload
|
||||
definition: >-
|
||||
Applies the changes made to the Home Assistant configuration files. Changes
|
||||
@ -306,7 +316,7 @@
|
||||
link: /integrations/sensor/
|
||||
aliases:
|
||||
- sensors
|
||||
- term: Selectors
|
||||
- term: Selector
|
||||
definition: >-
|
||||
Selectors are components for the user interface. Some selectors can,
|
||||
for example, show a toggle button to turn something on or off, while another
|
||||
@ -316,6 +326,8 @@
|
||||
Selectors are components for the user interface. Like toggle, dropdown,
|
||||
and more.
|
||||
link: /docs/blueprint/selectors/
|
||||
aliases:
|
||||
- selectors
|
||||
- term: Service
|
||||
definition: |-
|
||||
The term service has 2 meanings in Home Assistant:
|
||||
|
||||
@ -17,12 +17,4 @@ Some battery vendors have an API to integrate the data into your Home Assistant
|
||||
|
||||
### Using a CT clamp sensor
|
||||
|
||||
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 and you can build your own.
|
||||
|
||||
The off-the-shelf solution that we advise is the [Shelly EM](https://www.shelly.com/en/products/shop/shelly-em-120a/shelly-em-50a?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.
|
||||
|
||||
_Attention! Installing CT clamp sensor devices requires opening your electrical cabinet. This work should be done by someone familiar with electrical wiring. Your qualified installer will know how to do this._
|
||||
|
||||
_Disclaimer: Some links on this page are affiliate links._
|
||||
{% include energy/ct_clamp.md %}
|
||||
|
||||
@ -63,13 +63,7 @@ In countries like Germany, SML (Smart Message Language) is used typically. ESPHo
|
||||
|
||||
### Using a CT clamp sensor
|
||||
|
||||
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 and you can build your own.
|
||||
|
||||
The off-the-shelf solution that we advise is the [Shelly EM](https://www.shelly.com/en/products/shop/shelly-em-120a/shelly-em-50a?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) or [PZEM-004T V3](https://esphome.io/components/sensor/pzemac.html). For the DIY route, check out [this video by digiblur](https://www.youtube.com/watch?v=n2XZzciz0s4) to get started.
|
||||
|
||||
_Attention! Installing CT clamp sensor devices requires opening your electrical cabinet. This work should be done by someone familiar with electrical wiring. Your qualified installer will know how to do this._
|
||||
{% include energy/ct_clamp.md %}
|
||||
|
||||
### Data provided by your energy provider
|
||||
|
||||
|
||||
@ -15,15 +15,7 @@ Home Assistant will need to know the amount of energy that is being produced. Th
|
||||
|
||||
### Using a CT clamp sensor
|
||||
|
||||
CT clamp sensors measure the instantaneous current passing through an electrical wire. To translate this into electrical power (W) you also need a voltage measurement, because Power = Current x Voltage.
|
||||
|
||||
In Home Assistant we have support for off-the-shelf CT clamp sensors and you can build your own with ESPHome's [CT Clamp Current sensor](https://esphome.io/components/sensor/ct_clamp.html).
|
||||
|
||||
The off-the-shelf solution that we advise is the [Shelly EM](https://www.shelly.com/en/products/shop/shelly-em-120a/shelly-em-50a?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq). The device has a local API, updates are pushed to Home Assistant and it has a high quality [integration](/integrations/shelly/).
|
||||
|
||||
_Attention! Installing CT clamp sensor devices requires opening your electrical cabinet. This work should be done by someone familiar with electrical wiring. Your qualified installer will know how to do this._
|
||||
|
||||
_Disclaimer: Some links on this page are affiliate links._
|
||||
{% include energy/ct_clamp.md %}
|
||||
|
||||
### Connecting to your inverter
|
||||
|
||||
|
||||
8
source/_includes/energy/ct_clamp.md
Normal file
8
source/_includes/energy/ct_clamp.md
Normal file
@ -0,0 +1,8 @@
|
||||
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/en/products/shop/shelly-em-120a/shelly-em-50a?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.
|
||||
|
||||
_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._
|
||||
|
||||
_Disclaimer: Some links in this section are affiliate links._
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Follow this guide if you want to get started with Home Assistant easily or if you have little to no Linux experience.
|
||||
|
||||
{% if page.installation_type == 'ODROID' %}
|
||||
{% if page.installation_type == 'odroid' %}
|
||||
|
||||
## Suggested hardware
|
||||
|
||||
@ -161,7 +161,7 @@ Use this method only if Method 1 does not work for you.
|
||||
- This means you will lose all the data as well as the previously installed operating system.
|
||||
- Back up your data before continuing with the next step.
|
||||
2. Attach the Home Assistant boot medium ({{site.installation.types[page.installation_type].installation_media}}) to your computer.
|
||||
{% if page.installation_type == 'ODROID' %}
|
||||
{% if page.installation_type == 'odroid' %}
|
||||
If you are using ODROID M1, note that booting from NVMe is not supported. If you want to boot from eMMC, [update the firmware](https://github.com/home-assistant/operating-system/blob/dev/Documentation/boards/hardkernel/odroid-m1.md) before installing the image.
|
||||
|
||||
If you are using a [Home Assistant Blue](/blue) or ODROID N2+, you can [attach your device directly](/common-tasks/os/#flashing-an-odroid-n2).
|
||||
@ -265,14 +265,14 @@ If you are running an older Windows version or have a stricter network configura
|
||||
### Download the appropriate image
|
||||
|
||||
- [VirtualBox][vdi] (.vdi)
|
||||
{% if page.installation_type == 'windows' or page.installation_type == 'Linux' %}
|
||||
{% if page.installation_type == 'linux' %}
|
||||
- [KVM][qcow2] (.qcow2)
|
||||
- [Vmware Workstation][vmdk] (.vmdk)
|
||||
{% elsif page.installation_type == 'alternative' %}
|
||||
- [KVM/Proxmox][qcow2] (.qcow2)
|
||||
- [VMware ESXi/vSphere][Virtual Appliance] (.ova)
|
||||
{% endif %}
|
||||
{% if page.installation_type == 'windows' %}
|
||||
- [VMware Workstation][vmdk] (.vmdk)
|
||||
- [Hyper-V][vhdx] (.vhdx)
|
||||
{% endif %}
|
||||
|
||||
@ -280,7 +280,7 @@ After downloading, decompress the image. If the image comes in a ZIP file, for e
|
||||
|
||||
Follow this guide if you already are running a supported virtual machine hypervisor. If you are not familiar with virtual machines, install Home Assistant OS directly on a [Home Assistant Yellow](/installation/yellow), a [Raspberry Pi](/installation/raspberrypi), or an [ODROID](/installation/odroid).
|
||||
|
||||
{% if page.installation_type == 'macOS' %}
|
||||
{% if page.installation_type == 'macos' %}
|
||||
|
||||
- If VirtualBox is not supported on your Mac, and you have experience using virtual machines, you can try running the Home Assistant Operating System on [UTM](https://mac.getutm.app/).
|
||||
{% endif %}
|
||||
@ -305,14 +305,15 @@ Minimum recommended assignments:
|
||||
content: |
|
||||
1. Create a new virtual machine.
|
||||
2. Select type **Linux** and version **Linux 2.6 / 3.x / 4.x (64-bit)**.
|
||||
3. Select **Use an existing virtual hard disk file**, select the unzipped VDI file from above.
|
||||
4. Edit the **Settings** of the VM and go to **System** > **Motherboard**. Select **Enable EFI**.
|
||||
3. Under **Hardware**, select the amount of memory and number of CPUs. Then, select **Enable EFI**.
|
||||
- Make sure **EFI** is enabled. If EFI is not enabled, HAOS won't boot.
|
||||
4. Under **Hard Disk**, select **Use an existing virtual hard disk file**, select the unzipped VDI file from above.
|
||||
5. Then go to **Network** > **Adapter 1**. Choose **Bridged Adapter** and choose your network adapter.
|
||||
<div class="note warning">
|
||||
Please keep in mind that the bridged adapter only functions over a hardwired Ethernet connection.
|
||||
Using Wi-Fi on your VirtualBox host is unsupported.
|
||||
</div>
|
||||
6. Then go to **Audio** and choose **Intel HD Audio** as audio controller.
|
||||
6. Then go to <b>Audio</b> and choose <b>Intel HD Audio</b> as audio controller.
|
||||
<div class="note info">
|
||||
|
||||
By default, VirtualBox does not free up unused disk space. To automatically shrink the vdi disk image
|
||||
@ -326,6 +327,8 @@ Minimum recommended assignments:
|
||||
|
||||
</div>
|
||||
|
||||
{% unless page.installation_type == 'macos' %}
|
||||
|
||||
- title: Unraid
|
||||
content: |
|
||||
1. Download the **.qcow2** image above and decompress it. (**Extract all** in Windows)
|
||||
@ -344,8 +347,6 @@ Minimum recommended assignments:
|
||||
14. Select the name of your new VM and select the capacity number for your disk. Here, you can expand the disk to whatever your needs are. The default is 32 GB.
|
||||
15. Select the icon of your new VM and select **start with console (VNC)**.
|
||||
|
||||
{% unless page.installation_type == 'macOS' %}
|
||||
|
||||
- title: KVM (virt-manager)
|
||||
content: |
|
||||
1. Create a new virtual machine in `virt-manager`.
|
||||
@ -393,17 +394,42 @@ Minimum recommended assignments:
|
||||
|
||||
{% endunless %}
|
||||
|
||||
{% if page.installation_type == 'windows' or page.installation_type == 'Linux' %}
|
||||
{% if page.installation_type == 'windows' %}
|
||||
|
||||
- title: Vmware Workstation
|
||||
- title: VMware Workstation
|
||||
content: |
|
||||
1. Create a new virtual machine.
|
||||
2. Select **Custom**, make it compatible with the default of Workstation and ESX.
|
||||
3. Choose **I will install the operating system later**, select **Linux** > **Other Linux 5.x or later kernel 64-bit**.
|
||||
4. Select **Use Bridged Networking**.
|
||||
5. Select **Use an existing virtual disk** and select the VMDK file above.
|
||||
1. Start VMware Workstation and select **Create a New Virtual Machine**.
|
||||
- Note: the exact name and location of the settings below depend on the VMware version. This procedure is based on version 17.
|
||||
2. Select **I will install the operating system later**, then select **Linux** > **Other Linux 5.x kernel 64-bit**.
|
||||
3. Give the VM a name, `home-assistant`, and define an easy to reach storage location, such as `C:\home-assistant`.
|
||||
4. Specify the disk size and select **Store virtual disk as a single file**.
|
||||
5. Select **Customize Hardware**.
|
||||
6. Define the amount of memory and the number of cores the VM is allowed to use.
|
||||
7. Remove the **New CD/DVD** entry. It will not be used.
|
||||
8. Connect an Ethernet cable and make sure it is connected to your network.
|
||||
9. Under **Network adapter**, select **Bridged: Connected directly to the physical network**.
|
||||
- Make sure **Replicate physical network connection state** is not selected.
|
||||
- Select **Configure Adapters**.
|
||||
- Make sure all virtual adapters and Bluetooth devices are deselected.
|
||||
- Select your host network adapter. Most likely, this is one of the first 2 checkboxes in the list:
|
||||
- Select the one for Ethernet.
|
||||
- The exact names of these adapters depend on your hardware.
|
||||
10. At the end of the wizard, select **Finish**.
|
||||
|
||||
## Edit the VM settings
|
||||
|
||||
11. In Windows Explorer, navigate to the storage location of your newly created VM, for example under `C:\home-assistant`.
|
||||
12. Delete the `home-assistant.vmdk` file.
|
||||
3. In the `Downloads` folder, find the `haos_ova_xx.x.vmdk` file.
|
||||
- If you haven't unzipped the archive, unzip it.
|
||||
- Within the folder, find the `.vmdk` file and rename it to `home-assistant.vmdk`.
|
||||
- Paste the file (not the unzipped folder) into the `C:\home-assistant` folder.
|
||||
4. Right-click the `.vmx` file and select **Open with** > **Notepad**.
|
||||
5. Under `.encoding`, add a line. Enter `firmware = "efi"`.
|
||||
6. Now continue with the next step to start your VM.
|
||||
- If you see a message about side channel mitigations, select **OK**.
|
||||
- If you see a message stating that the `.vmdk` file could not be found, in step 3, you likely pasted the folder, not the file. Repeat step 3.
|
||||
|
||||
After the VM has been created, go to **Settings** > **Options** > **Advanced**. Under **Firmware type** select **UEFI**.
|
||||
|
||||
{% elsif page.installation_type == 'alternative' %}
|
||||
|
||||
|
||||
@ -49,6 +49,6 @@ This section explains how to generate a client ID and client secret on
|
||||
- Once you have noted these strings, select **OK**.
|
||||
- If you need to find these credentials again at any point, then navigate to **APIs & Services** > **Credentials**, and you will see **Home Assistant Credentials** (or whatever you named them in the previous step) under **OAuth 2.0 Client IDs**.
|
||||
- To view both the **Client ID** and **Client secret**, select the pencil icon. This will take you to the settings page for these credentials, and the information will be on the right-hand side of the page.
|
||||
16. Congratulations! You are now the keeper of a client secret. Guard it in your treasure box.
|
||||
16. Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. In most cases your new credentials will be active within a few moments. However, Google states that activation may take up to five hours in some circumstances.
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
@ -30,7 +30,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The **Abode** {% term integration %} will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
|
||||
The **Abode** {% term integration %} allows you to integrate your Abode Home Security systems into Home Assistant and use its alarm system and sensors to trigger automations.
|
||||
|
||||
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
|
||||
|
||||
|
||||
@ -34,5 +34,5 @@ If the IP address for the hub changes, you will need to re-register it with Home
|
||||
|
||||
The integration has the following limitations:
|
||||
|
||||
- covers with position as well as tilt are not supported.
|
||||
- the integration doesn't make use of rooms and scenes configured in the hub, use the equivalent functionality in Home Assistant instead.
|
||||
- Covers with position as well as tilt are not supported.
|
||||
- The integration doesn't make use of rooms and scenes configured in the hub, use the equivalent functionality in Home Assistant instead.
|
||||
|
||||
@ -11,7 +11,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The **Actiontec** {% term integration %} allows you to detect presence by looking at connected devices to an [Actiontec](https://www.actiontec.com/) device.
|
||||
The **Actiontec** {% term integration %} allows you to detect presence by looking at devices connected to an [Actiontec](https://www.actiontec.com/) device.
|
||||
|
||||
Supported devices (tested):
|
||||
|
||||
|
||||
@ -14,13 +14,21 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The **Adax** {% term integration %} integrates Adax heater into Home Assistant.
|
||||
The **Adax** {% term integration %} integrates Adax heaters into Home Assistant and can be configured to use a local or cloud interface.
|
||||
|
||||
You can configure the heaters to use a local or cloud interface.
|
||||
## Local integration
|
||||
|
||||
The local integrations only works with newer Adax heaters with both Bluetooth and wifi. Home Assistant uses Bluetooth LE to configure the heaters, this means your machine running “Home Assistant” needs to have a Bluetooth adapter and the heater needs to be in range during setup. For the local integration, you have to reset the heater by pressing + and OK until the display shows 'Reset'. Then press and hold the OK button on the heater until the blue LED starts blinking before pressing Submit. Configuring the heater might take some minutes. Using the local integration will disable cloud communication and the Adax app will not work.
|
||||
The local integration only works with newer Adax heaters with both Bluetooth and Wi-Fi. Home Assistant uses Bluetooth LE to configure the heaters, this means the machine _running_ Home Assistant needs to have a Bluetooth adapter and the heater needs to be in range during setup. Using local control will disable cloud communication and the Adax app will not work.
|
||||
|
||||
For the cloud integration, you'll need the Account ID (which can be found in the Adax Wifi app, pressing 'Account'. Which you will find as a number between the "log out" and "close account" buttons).
|
||||
1. Reset the heater by pressing **+** and **OK** until the display shows **Reset**.
|
||||
2. Press and hold the **OK** button on the heater until the blue LED starts blinking.
|
||||
3. Press **Submit**.
|
||||
|
||||
This process may take several minutes.
|
||||
|
||||
## Cloud integration
|
||||
|
||||
For the cloud integration, you'll need your Account ID. This can be found in the Adax WiFi app by pressing **Account**. The ID will be shown as a number between the **log out** and **close account** buttons.
|
||||
|
||||
You will also need a credential, which you can create in the Adax app:
|
||||
|
||||
|
||||
@ -17,9 +17,9 @@ ha_platforms:
|
||||
ha_integration_type: service
|
||||
---
|
||||
|
||||
AdGuard Home is a network-wide ad- and tracker-blocking DNS server with parental
|
||||
control (adult content blocking) capabilities. The **AdGuard** integration allows
|
||||
you to control and monitor your AdGuard Home instance in Home Assistant.
|
||||
AdGuard Home is a network-wide DNS server that supports ad, tracker,
|
||||
and adult content blocking. The **AdGuard** integration allows you to control and
|
||||
monitor your AdGuard Home instance in Home Assistant.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
[Agent DVR](https://www.ispyconnect.com/download.aspx/) is a free* software DVR solution for windows 10, Mac and Linux. Agent DVR runs as a service or console application and can access and control a huge range of third party cameras with advanced motion detection, including DeepStack integration for object recognition. The iSpyConnect website provides secured (SSL) remote access without port forwarding needed.
|
||||
[Agent DVR](https://www.ispyconnect.com/download.aspx/) is a free* software DVR solution for Windows 10, Mac and Linux. Agent DVR runs as a service or console application and can access and control a huge range of third party cameras with advanced motion detection, including DeepStack integration for object recognition. The iSpyConnect website provides secured (SSL) remote access without port forwarding needed.
|
||||
|
||||
You can add Agent DVR via integrations using the IP address and port of the server, e.g.,: `http://192.168.1.3:8090/`.
|
||||
|
||||
@ -63,7 +63,7 @@ Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
|
||||
|
||||
## IFrame
|
||||
## Iframe
|
||||
|
||||
- Using the Webpage Card you can embed the Agent DVR viewer directly in Home Assistant. Just point it to <https://www.ispyconnect.com/app/>
|
||||
|
||||
|
||||
@ -32,7 +32,7 @@ State | Description
|
||||
### Basic example
|
||||
|
||||
The `alert` integration makes use of any of the `notification` integrations. To
|
||||
setup the `alert` integration, first, you must setup a `notification` integration.
|
||||
setup the `alert` integration, first, you must set up a [notification integration](/integrations/#notifications).
|
||||
Then, add the following to your configuration file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -13,7 +13,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `cups` sensor platform is using the open source printing system [CUPS](https://www.cups.org/) to show details about your printers, including the ink levels. It can obtain the information using a CUPS server or communicating directly with the printer with the Internet Printing Protocol.
|
||||
The `cups` sensor platform uses the open source printing system [CUPS](https://www.cups.org/) to show details about your printers, including the ink levels. It can obtain the information using a CUPS server or by communicating directly with the printer with the Internet Printing Protocol.
|
||||
|
||||
## Setup
|
||||
|
||||
@ -40,7 +40,7 @@ sensor:
|
||||
|
||||
{% configuration %}
|
||||
printers:
|
||||
description: List of printers to add. If you're not using a CUPS server, add here your "Printer Name".
|
||||
description: List of printers to add. If you're not using a CUPS server, add your "Printer Name" here.
|
||||
required: true
|
||||
type: list
|
||||
host:
|
||||
@ -73,9 +73,3 @@ sensor:
|
||||
printers:
|
||||
- ipp/print
|
||||
```
|
||||
|
||||
<div class='note'>
|
||||
|
||||
You will need to install the `python3-dev` or `python3-devel` and the development files for CUPS (`libcups2-dev` or`cups-devel`) package on your system manually (eg. `sudo apt-get install python3-dev libcups2-dev` or `sudo dnf -y install python3-devel cups-devel`) along with a compiler (`gcc`).
|
||||
|
||||
</div>
|
||||
|
||||
@ -363,7 +363,7 @@ If you receive 404 errors linked to reporting state in your log, Home Assistant
|
||||
|
||||
#### Error during linking: "Could not update the setting. Please check your connection"
|
||||
|
||||
Your fulfillment URL may be invalid or unreachable. Recheck the `Fulfillment URL` as specified in [Manual Setup](#manual-setup) and verify that it's publicly reachable.
|
||||
Your fulfillment URL may be invalid or unreachable. Recheck the `Fulfillment URL` as specified in [Manual Setup](#manual-setup-if-you-dont-have-home-assistant-cloud) and verify that it's publicly reachable.
|
||||
|
||||
#### 500 / 429 error on request sync
|
||||
|
||||
|
||||
@ -711,7 +711,7 @@ state_topic:
|
||||
required: false
|
||||
type: string
|
||||
supported_color_modes:
|
||||
description: A list of color modes supported by the list. This is required if `color_mode` is `True`. Possible color modes are `onoff`, `brightness`, `color_temp`, `hs`, `xy`, `rgb`, `rgbw`, `rgbww`, `white`.
|
||||
description: A list of color modes supported by the list. This is required if `color_mode` is `True`. Possible color modes are `onoff`, `brightness`, `color_temp`, `hs`, `xy`, `rgb`, `rgbw`, `rgbww`, `white`. Note that if `onoff` **or** `brightness` are used, that must be the _only_ value in the list.
|
||||
required: false
|
||||
type: list
|
||||
unique_id:
|
||||
|
||||
@ -24,7 +24,7 @@ LiteJet is a centralized lighting system that predates most home automation tech
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Your LiteJet MCP should be configured for 19.2 K baud, 8 data bits, 1 stop bit, no parity, and to transmit a 'CR' after each response. These settings can be configured using the [LiteJet programming software](https://www.centralite.com/helpdesk/knowledgebase.php?article=735). Connect the LiteJet's RS232-2 port to your computer.
|
||||
Your LiteJet MCP should be configured for 19.2 K baud, 8 data bits, 1 stop bit, no parity, and to transmit a 'CR' after each response. These settings can be configured using the LiteJet programming software from the [Dragon Technologies](https://www.dragontechinc.com/) Programming page. Connect the LiteJet's RS232-2 port to your computer.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Möhlenhoff Alpha 2 integration allows you to control a
|
||||
[Möhlenhoff Alpha 2](https://www.moehlenhoff.de/en/products/room-by-room-control/oem-alpha-2-system)
|
||||
[Möhlenhoff Alpha 2](https://www.moehlenhoff.de/fileadmin/user_upload/Download/Broschueren/125297_1705_Broschuere_Alpha2_DEU_final_web.pdf)
|
||||
temperature control system.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@ -685,6 +685,7 @@ The following software has built-in support for MQTT discovery:
|
||||
- [EMS-ESP32 (and EMS-ESP)](https://github.com/emsesp/EMS-ESP32)
|
||||
- [ESPHome](https://esphome.io)
|
||||
- [ESPurna](https://github.com/xoseperez/espurna)
|
||||
- [go-iotdevice](https://github.com/koestler/go-iotdevice)
|
||||
- [HASS.Agent](https://github.com/LAB02-Research/HASS.Agent)
|
||||
- [IOTLink](https://iotlink.gitlab.io) (starting with 2.0.0)
|
||||
- [MiFlora MQTT Daemon](https://github.com/ThomDietrich/miflora-mqtt-daemon)
|
||||
@ -843,7 +844,7 @@ Setting up a light, switch etc. is similar but requires a `command_topic` as men
|
||||
|
||||
```bash
|
||||
mosquitto_pub -r -h 127.0.0.1 -p 1883 -t "homeassistant/switch/irrigation/config" \
|
||||
-m '{"name": "Irrigation", "command_topic": "homeassistant/switch/irrigation/set", "state_topic": "homeassistant/switch/irrigation/state", "unique_id": "irr01ad", "device": {"identifiers": ["garden01ad"], "name": "Garden" }}}'
|
||||
-m '{"name": "Irrigation", "command_topic": "homeassistant/switch/irrigation/set", "state_topic": "homeassistant/switch/irrigation/state", "unique_id": "irr01ad", "device": {"identifiers": ["garden01ad"], "name": "Garden" }}'
|
||||
```
|
||||
|
||||
Set the state:
|
||||
|
||||
@ -9,10 +9,10 @@ ha_domain: namecheapdns
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
With the `namecheapdns` integration you can automatically update your dynamic DNS entry at [namecheapdns](https://www.namecheap.com/store/domains/freedns/).
|
||||
With the `namecheapdns` integration you can automatically update your dynamic DNS entry hosted by Namecheap's [FreeDNS](https://www.namecheap.com/store/domains/freedns/) service.
|
||||
|
||||
<div class='note warning'>
|
||||
Namecheap only supports IPv4 addresses to update.
|
||||
Namecheap only supports updating IPv4 addresses.
|
||||
</div>
|
||||
|
||||
## Configuration
|
||||
@ -32,13 +32,13 @@ namecheapdns:
|
||||
required: false
|
||||
type: string
|
||||
domain:
|
||||
description: Your namecheap TLD (example.com).
|
||||
description: Your root domain (example.com).
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The namecheap "Dynamic DNS Password" you can find under the "Advanced DNS" tab.
|
||||
description: The Namecheap "Dynamic DNS Password" you can find under the "Advanced DNS" tab.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
See the [How do I set up a Host for Dynamic DNS?](https://www.namecheap.com/support/knowledgebase/article.aspx/43/11/how-do-i-set-up-a-host-for-dynamic-dns) for further instructions
|
||||
See Namecheap's [How do I set up a Host for Dynamic DNS?](https://www.namecheap.com/support/knowledgebase/article.aspx/43/11/how-do-i-set-up-a-host-for-dynamic-dns) guide for further instructions.
|
||||
|
||||
@ -533,6 +533,8 @@ authentication process.
|
||||
|
||||
- *Something went wrong: Please contact the developer of this app if the issue persists*: This typically means you are using the wrong type of credential (e.g. *Desktop Auth*). Make sure the credential in the [Google Cloud Console](https://console.developers.google.com/apis/credentials) is a *Web Application* credential following the instructions above.
|
||||
|
||||
- *Something went wrong, please try again in a few minutes*: According to Google's [Partner Connections Manager Error Reference](https://developers.google.com/nest/device-access/reference/errors/pcm), this error covers all other undocumented internal errors within Partner Connections. One of the issues that cause this error is synchronization problems between the Nest and Google Home apps. Confirm that your Nest device is visible within both apps under the same Home. If it is missing within Google Home, create a new dummy home on the Nest app, which triggers the synchronization process. (This is the workaround recommended by the Google support team). The dummy entry can be deleted once the Nest device is visible within the Google Home app.
|
||||
|
||||
- *Can’t link to [Project Name]: Please contact [Project Name] if the issue persists*: This typically means that the *OAuth Client ID* used is mismatched
|
||||
|
||||
{% details "Resolving mismatched OAuth Client ID" %}
|
||||
|
||||
@ -25,8 +25,6 @@ notify:
|
||||
media_player: media_player.living_room
|
||||
```
|
||||
|
||||
Please note that the `tts_service` parameter, must match the `service_name` defined in the TTS integration.
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name of the notify service.
|
||||
|
||||
@ -35,7 +35,7 @@ Prompt Template:
|
||||
description: The starting text for the AI language model to generate new text from. This text can include information about your Home Assistant instance, devices, and areas and is written using [Home Assistant Templating](/docs/configuration/templating/).
|
||||
|
||||
Completion Model:
|
||||
description: The GPT-3 language model is used for text generation. You can find more details on the available models in the [OpenAI GPT-3 Documentation](https://platform.openai.com/docs/models/gpt-3).
|
||||
description: The GPT language model is used for text generation. You can find more details on the available models in the [OpenAI GPT-3 Documentation](https://platform.openai.com/docs/models/gpt-3), [OpenAI GPT-3.5 Documentation](https://platform.openai.com/docs/models/gpt-3-5), or [OpenAI GPT-4 and GPT-4 Turbo Documentation](https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo). The default is "gpt-3.5-turbo".
|
||||
|
||||
Maximum Tokens to Return in Response:
|
||||
description: The maximum number of words or "tokens" that the AI model should generate in its completion of the prompt. For more information, see the [OpenAI Completion Documentation](https://platform.openai.com/docs/guides/completion/introduction).
|
||||
|
||||
@ -175,6 +175,13 @@ Depending on the supported features of the camera, switch entities are added for
|
||||
|
||||
For NVRs, a global switch for **Record**, **Push**, **Buzzer**, **Email**, and **FTP** will be available under the NVR device as well as a switch per channel of the NVR under the camera device. The respective feature will only be active for a given channel if both the global and that channel switch are enabled (as is also the case in the Reolink app/client).
|
||||
|
||||
**Push** notifications to a phone will only be provided if the following conditions are met:
|
||||
- The **Push notifications** switch in Home Assistant is ON.
|
||||
- For NVRs, both the global and channel switch are ON.
|
||||
- The Push-notification in the Reolink App of that phone is ON.
|
||||
|
||||
The Push-notification in the Reolink app is independent of the Home Assistant setting. It is also independent of the settings on other phones connected to the same camera. Reolink does this so you have an independent way of turning off push notifications per phone.
|
||||
|
||||
## Light entities
|
||||
|
||||
Depending on the supported features of the camera, light entities are added for:
|
||||
|
||||
@ -411,7 +411,7 @@ rest:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
The example below shows how to extract multiple values from a dictionary from the XML file of a Steamist Steambath Wi-Fi interface. The values are used to create a switch and multiple sensors without having to poll the endpoint numerous times.
|
||||
The example below shows how to extract multiple values from a dictionary from the XML file of a Steamist Steambath Wi-Fi interface. The values are used to create multiple sensors without having to poll the endpoint numerous times.
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -431,32 +431,6 @@ rest:
|
||||
value_template: "{{ json_value['response']['time0'] }}"
|
||||
unit_of_measurement: "minutes"
|
||||
|
||||
switch:
|
||||
- name: "Steam"
|
||||
value_template: "{{ json_value['response']['usr0'] | int >= 1 }}"
|
||||
turn_on:
|
||||
- service: rest_command.set_steam_led
|
||||
data:
|
||||
led: 6
|
||||
- service: homeassistant.update_entity
|
||||
target:
|
||||
entity_id: sensor.steam_system_data
|
||||
- delay: 00:00:15
|
||||
- service: homeassistant.update_entity
|
||||
target:
|
||||
entity_id: sensor.steam_system_data
|
||||
turn_off:
|
||||
- service: rest_command.set_steam_led
|
||||
data:
|
||||
led: 7
|
||||
- service: homeassistant.update_entity
|
||||
target:
|
||||
entity_id: sensor.steam_system_data
|
||||
- delay: 00:00:15
|
||||
- service: homeassistant.update_entity
|
||||
target:
|
||||
entity_id: sensor.steam_system_data
|
||||
|
||||
rest_command:
|
||||
set_steam_led:
|
||||
url: http://192.168.1.105/leds.cgi?led={{ led }}
|
||||
|
||||
@ -119,7 +119,7 @@ sequence:
|
||||
mode: single
|
||||
```
|
||||
|
||||
Update the blocks array with valid Slack blocks. The easiest way to create this is using [Slack Block Kit Builder](https://app.slack.com/block-kit-builder)
|
||||
Update the blocks array with valid Slack blocks. The easiest way to create this is using [Slack Block Kit Builder](https://app.slack.com/block-kit-builder). Up to 50 blocks may be included per message.
|
||||
|
||||
Create a duplicate of this script to use for different messages, and different channels (the door was opened in #security, the light was left on on #lights, etc).
|
||||
|
||||
@ -142,7 +142,7 @@ The following attributes can be placed inside the `data` key of the service call
|
||||
| `username` | yes | The username of the Slack bot.
|
||||
| `icon` | yes | The icon of the Slack bot.
|
||||
| `file` | yes | A file to include with the message; see below.
|
||||
| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in place of** the `message` (note that the `message` is required nonetheless).
|
||||
| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in place of** the `message` within Slack apps. The message field will be used as notification text and anywhere else Slack is unable to display blocks. `message` is required regardless of whether this field is used.
|
||||
| `blocks_template` | yes | The same as `blocks`, but able to support [templates](https://www.home-assistant.io/docs/configuration/templating).
|
||||
| `thread_ts` | yes | Sends the message as a reply to a specified parent message.
|
||||
|
||||
@ -162,6 +162,16 @@ To include a remote file with the Slack message, use these attributes underneath
|
||||
| `username` | yes | An optional username if the URL is protected by HTTP Basic Auth.
|
||||
| `password` | yes | An optional password if the URL is protected by HTTP Basic Auth.
|
||||
|
||||
### Obtaining a member ID
|
||||
|
||||
Some of the examples below use a member ID. This is a unique string assigned by Slack to all users (members and guests) and not a username set by the user. To get a member ID:
|
||||
|
||||
1. Select a Slack user (both name and profile image work) to bring up their profile side panel.
|
||||
2. Open the context menu by selecting the three dots.
|
||||
3. Select **Copy member ID**.
|
||||
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
To send a file from local path:
|
||||
@ -199,7 +209,7 @@ data:
|
||||
To use the block framework:
|
||||
|
||||
```yaml
|
||||
message: Fallback message in case the blocks don't display anything.
|
||||
message: Fallback message for notifications or in case the blocks don't display anything.
|
||||
title: Title of the file.
|
||||
data:
|
||||
blocks:
|
||||
@ -227,7 +237,9 @@ data:
|
||||
1.0
|
||||
```
|
||||
|
||||
Send a message directly to a user by setting the target to their member ID. Here are [instructions](https://www.workast.com/help/articles/61000165203/) to obtain a member ID.
|
||||
|
||||
Send a message directly to a user by setting the target to their member ID.
|
||||
|
||||
|
||||
```yaml
|
||||
message: "Hello there!"
|
||||
@ -237,10 +249,10 @@ data:
|
||||
blocks: []
|
||||
```
|
||||
|
||||
Send a message to a channel that mentions (@username, highlights a users name in yellow) a user. Here are [instructions](https://www.workast.com/help/articles/61000165203/) to obtain a member ID.
|
||||
Send a message to a channel that mentions (@username, highlights a users name in yellow) a user.
|
||||
|
||||
```yaml
|
||||
message: "<@U12345> your appointment starts soon"
|
||||
message: "<@MEMBER_ID> your appointment starts soon"
|
||||
target: "#general"
|
||||
title: "Reminder"
|
||||
data:
|
||||
|
||||
@ -49,7 +49,7 @@ SmartThings is integrated into Home Assistant through the SmartThings Cloud API.
|
||||
|
||||
The PAT is used to create a Home Assistant SmartApp in your SmartThings account during setup of the integration.
|
||||
|
||||
1. Log into the [personal access tokens page](https://account.smartthings.com/tokens) and click '[Generate new token](https://account.smartthings.com/tokens/new)'
|
||||
1. Log into the [personal access tokens page](https://account.smartthings.com/tokens) and select **[Generate new token](https://account.smartthings.com/tokens/new)**.
|
||||
2. Enter a token name (can be whatever you want), for example, 'Home Assistant' and select the following authorized scopes:
|
||||
- Devices (all)
|
||||
- Installed Applications (all)
|
||||
@ -57,7 +57,7 @@ The PAT is used to create a Home Assistant SmartApp in your SmartThings account
|
||||
- Locations (all)
|
||||
- Scenes (all)
|
||||
- Schedules (all)
|
||||
3. Click 'Generate token'. When the token is displayed copy and save it somewhere safe (such as your keystore) as you will not be able to retrieve it again.
|
||||
3. Select **Generate token**. When the token is displayed copy and save it somewhere safe (such as your keystore) as you will not be able to retrieve it again.
|
||||
|
||||
### Webhook
|
||||
|
||||
@ -72,15 +72,15 @@ After completing the prerequisite steps above, you are ready to setup the integr
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
1. Confirm the callback URL is correct. If using Home Assistant Cloud, it will start with `https://hooks.nabuca.casa`. If the URL is not correct, update your Home Assistant configuration, restart, and try again.
|
||||
1. Confirm the callback URL is correct. If using Home Assistant Cloud, it will start with `https://hooks.nabu.casa`. If the URL is not correct, update your Home Assistant configuration, restart, and try again.
|
||||
2. Enter your Personal Access Token.
|
||||
3. Select the SmartThings Location to add to Home Assistant.
|
||||
4. On the window that opens:
|
||||
1. Login with your SmartThings account (if not already logged in).
|
||||
2. Optionally change the display name and click 'Done' at the bottom of the screen.
|
||||
3. Authorize the integration by clicking 'Allow' on the bottom right of the screen.
|
||||
4. Click 'Close Window' or close it manually.
|
||||
5. Back in Home Assistant click 'Finish'.
|
||||
2. Optionally change the display name and select **Done** at the bottom of the screen.
|
||||
3. Authorize the integration by selecting **Allow** on the bottom right of the screen.
|
||||
4. Select **Close Window** or close it manually.
|
||||
5. Back in Home Assistant select **Finish**.
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
@ -90,7 +90,7 @@ If you want to integrate additional SmartThings accounts or locations, repeat th
|
||||
|
||||
## Removal instructions
|
||||
|
||||
To remove the integration from Home Assistant, select the instance from the Home Assistant Integrations page and click the trash icon on the upper right corner. Alternatively, you can remove the SmartApp from the location within the SmartThings application. If the Home Assistant instance that setup the integration is no longer running or functioning, you will need to use this [utility to remove the orphaned SmartApps in your SmartThings account](https://pypi.org/project/hass-smartthings-remove/).
|
||||
To remove the integration from Home Assistant, select the instance from the Home Assistant Integrations page and select the trash icon on the upper right corner. Alternatively, you can remove the SmartApp from the location within the SmartThings application. If the Home Assistant instance that setup the integration is no longer running or functioning, you will need to use this [utility to remove the orphaned SmartApps in your SmartThings account](https://pypi.org/project/hass-smartthings-remove/).
|
||||
|
||||
## Events
|
||||
|
||||
@ -306,11 +306,11 @@ The personal access token does not match the expected format. Make sure you are
|
||||
#### Error: `pysmartthings.errors.APIInvalidGrant: Invalid refresh token:` (after a restore)
|
||||
|
||||
You can fix this by using the SmartThings App to re-grant authorization to the API token you created before.
|
||||
1. Open SmartThings app on your mobile device (not HA)
|
||||
2. Select `Automations` from bottom
|
||||
3. Select your Home Assistant automation from the list
|
||||
4. Click "Done", then click "Allow"
|
||||
5. Reload your SmartThings integration from Home Assistant Devices panel
|
||||
1. Open SmartThings app on your mobile device (not HA).
|
||||
2. Select **Automations** from bottom.
|
||||
3. Select your Home Assistant automation from the list.
|
||||
4. Select **Done**, then select **Allow**.
|
||||
5. Reload your SmartThings integration from Home Assistant Devices panel.
|
||||
|
||||
#### Error: The token is invalid or no longer authorized (not solved by above)
|
||||
|
||||
|
||||
@ -198,13 +198,18 @@ notify:
|
||||
sender: "YOUR_USERNAME@gmail.com"
|
||||
encryption: starttls
|
||||
username: "YOUR_USERNAME@gmail.com"
|
||||
password: "YOUR_PASSWORD"
|
||||
password: "YOUR_APP_PASSWORD"
|
||||
recipient:
|
||||
- "RECIPIENT_1@example.com"
|
||||
- "RECIPIENT_N@example.com"
|
||||
sender_name: "SENDER_NAME"
|
||||
```
|
||||
|
||||
Keep in mind that Google has some extra layers of protection that need special attention. By default, the usage by external applications is limited so you will need to visit the [less secure apps](https://myaccount.google.com/lesssecureapps) page and enable it to be able to send e-mails. Be aware that Google will periodically turn it off if it is not used (no e-mail is sent).
|
||||
Google has some extra layers of protection that need special attention. You must use [an application-specific password](https://support.google.com/mail/answer/185833) in your notification configuration.
|
||||
|
||||
To avoid having your e-mail notifications broken due to the less secure app's behavior, it is recommended that you enable 2-step verification on your Google account, and use [an application-specific password](https://support.google.com/mail/answer/185833) in your notification configuration.
|
||||
If any of the following conditions are met you will not be able to create an app password:
|
||||
|
||||
- You do not have 2-step verification enabled on your account.
|
||||
- You have 2-step verification enabled but have only added a security key as an authentication mechanism.
|
||||
- Your Google account is enrolled in Google's [Advanced Protection Program](https://landing.google.com/advancedprotection/).
|
||||
- Your Google account belongs to a Google Workspace that has disabled this feature. Accounts owned by a school, business, or other organization are examples of Google Workspace accounts.
|
||||
|
||||
@ -212,7 +212,7 @@ switch:
|
||||
- platform: template
|
||||
switches:
|
||||
garage:
|
||||
value_template: "{{ is_state('cover.garage_door', 'on') }}"
|
||||
value_template: "{{ is_state('cover.garage_door', 'open') }}"
|
||||
turn_on:
|
||||
service: cover.open_cover
|
||||
target:
|
||||
@ -242,7 +242,7 @@ switch:
|
||||
- platform: template
|
||||
switches:
|
||||
garage:
|
||||
value_template: "{{ is_state('cover.garage_door', 'on') }}"
|
||||
value_template: "{{ is_state('cover.garage_door', 'open') }}"
|
||||
turn_on:
|
||||
service: cover.open_cover
|
||||
target:
|
||||
|
||||
@ -37,20 +37,19 @@ This sensor will wake up your Synology NAS if it's in hibernation mode.
|
||||
|
||||
You can change the scan interval within the configuration options (default is 15 min).
|
||||
|
||||
Having cameras or the Home mode toggle from [Surveillance Station](https://www.synology.com/en-us/surveillance) will fetch every 30 seconds. Disable those entities if you don't want your NAS to be fetch as frequently.
|
||||
Having cameras or the Home mode toggle from [Surveillance Station](https://www.synology.com/en-us/surveillance) will fetch every 30 seconds. Disable those entities if you don't want your NAS to be fetched as frequently.
|
||||
|
||||
</div>
|
||||
|
||||
<div class='note'>
|
||||
|
||||
If you have two or more NICs with different IP addresses from the same subnet and SSDP is activated, this leads to problems with this integration, as the NAS is detected several times with different IPs and the integration always adopts the new "detected" IP address in its configuration and then reloads it.
|
||||
In this case, it is recommended to use NIC bonding instead or to deactivate SSDP.
|
||||
When SSDP is activated on a NAS with two or more NICs with different IP addresses on the same subnet an adoption loop will occur. The NAS will be detected several times with different IP addresses and the integration will adopt the "newly" detected IP causing a reload. To resolve this either <a href="https://kb.synology.com/en-id/DSM/help/DSM/AdminCenter/file_service_advanced_introduction?version=7" target="_blank">deactivate SSDP on the NAS</a> or use NIC bonding so that only one IP address is present.
|
||||
|
||||
</div>
|
||||
|
||||
## Separate User Configuration
|
||||
|
||||
Due to the nature of the Synology DSM API, it is required to grant the user admin rights. This is related to the fact that utilization information is stored in the core module.
|
||||
You must grant the user admin rights in order to access utilization information since it's stored in the core module.
|
||||
|
||||
When creating the user, it is possible to deny access to all locations and applications. By doing this, the user will not be able to login to the web interface or view any of the files on the Synology NAS. It is still able to read the utilization and storage information using the API.
|
||||
|
||||
@ -68,15 +67,15 @@ If you denied access to all locations and applications it is normal to receive a
|
||||
|
||||
## Sensors
|
||||
|
||||
### CPU Utilisation sensors
|
||||
### CPU utilization sensors
|
||||
|
||||
Entities reporting the current and combined CPU utilization of the NAS. There are sensors the report the current CPU load, separated by User, System and others. By default, only the User sensor is enabled.
|
||||
Entities reporting the current and combined CPU utilization of the NAS. There are sensors that report the current CPU load separated by User, System, and others. By default only the User sensor is enabled.
|
||||
|
||||
There are also combined CPU load sensors. These report the total CPU load for the entire NAS. Available as current, 1min, 5min and 15min load sensors. By default the 1min load sensor is disabled.
|
||||
|
||||
### Memory Utilisation sensors
|
||||
### Memory utilization sensors
|
||||
|
||||
Entities reporting the current and combined memory and swap utilization of the NAS. These sensors include the total installed amount, the currently free amount and the % of memory used.
|
||||
Entities reporting the current and combined memory and swap utilization of the NAS. These sensors include the total installed amount, the currently free amount, and the % of memory used.
|
||||
|
||||
### Network sensors
|
||||
|
||||
@ -116,7 +115,7 @@ A switch is available to enable/disable the [Surveillance Station](https://www.s
|
||||
|
||||
## Cameras
|
||||
|
||||
For each camera added in [Surveillance Station](https://www.synology.com/surveillance), a camera will be created in Home Assistant.
|
||||
For each camera added in [Surveillance Station](https://www.synology.com/surveillance) a camera will be created in Home Assistant.
|
||||
|
||||
## Buttons
|
||||
|
||||
@ -134,7 +133,7 @@ A media source is provided for your [Synology Photos](https://www.synology.com/e
|
||||
|
||||
The media source URIs will look like `media-source://synology_dsm/<unique_id>/<album_id>/<image>`.
|
||||
|
||||
This media browser supports multiple Synology Photos instances. `<unique_id>` is the Home Assistant ID for the NAS (_usually the serial number of the NAS_). You can find this id when using the media browser, when you hover over the NAS name, you get shown the simple name followed by the unique id ex: `192.168.0.100:5001 - 18C0PEN253705`.
|
||||
This media browser supports multiple Synology Photos instances. `<unique_id>` is the Home Assistant ID for the NAS (_usually the serial number of the NAS_). You can find this id when using the media browser by hovering over the NAS name. It will show the simple name followed by the unique id ex: `192.168.0.100:5001 - 18C0PEN253705`.
|
||||
|
||||
To find the `<album_id>` you need to go to the album in your photos instance, and the id will be in the URL ex: `https://192.168.0.100:5001/#/album/19`, where 19 is the album id. An `<album_id>` of 0 will contain all images.
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ ha_integration_type: integration
|
||||
|
||||
<div class='note warning'>
|
||||
This integration only supports TTNv2 that has been definitively switched off in 2022 (deprecated).
|
||||
For TTNv3, use the [MQTT integration](/integrations/mqtt).
|
||||
</div>
|
||||
|
||||
The `thethingsnetwork` integration allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15 km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network.
|
||||
|
||||
@ -20,17 +20,33 @@ opkg update
|
||||
opkg install rpcd-mod-file uhttpd-mod-ubus
|
||||
```
|
||||
|
||||
And create on your OpenWrt device a read-only user to be used by setting up the ACL file `/usr/share/rpcd/acl.d/user.json`.
|
||||
Add a new system user `hass` (or do it in any other way that you prefer):
|
||||
|
||||
- Add line to /etc/passwd: hass:x:10001:10001:hass:/var:/bin/false
|
||||
- Add line to /etc/shadow: hass:x:0:0:99999:7:::
|
||||
|
||||
Edit the `/etc/config/rpcd` and add the following lines:
|
||||
|
||||
```yaml
|
||||
config login
|
||||
option username 'hass'
|
||||
option password '$p$hass'
|
||||
list read hass
|
||||
list read unauthenticated
|
||||
list write hass
|
||||
```
|
||||
|
||||
Then, create an ACL file at `/usr/share/rpcd/acl.d/hass.json` for the user `hass`:
|
||||
|
||||
```json
|
||||
{
|
||||
"user": {
|
||||
"description": "Read only user access role",
|
||||
"hass": {
|
||||
"description": "Access role for OpenWrt ubus integration",
|
||||
"read": {
|
||||
"ubus": {
|
||||
"*": [ "*" ]
|
||||
"hostapd.*": ["get_clients"],
|
||||
"uci": ["get"]
|
||||
},
|
||||
"uci": [ "*" ]
|
||||
},
|
||||
"write": {}
|
||||
}
|
||||
|
||||
@ -116,6 +116,10 @@ visibility_unit:
|
||||
description: Unit for visibility_template output. Valid options are km, mi, ft, m, cm, mm, in, yd.
|
||||
required: false
|
||||
type: string
|
||||
forecast_template:
|
||||
description: Forecast data.
|
||||
required: false
|
||||
type: template
|
||||
forecast_daily_template:
|
||||
description: Daily forecast data.
|
||||
required: false
|
||||
|
||||
@ -58,3 +58,4 @@ The integration is tested and verified for the following devices from YoLink:
|
||||
- YS3604 (FlexFob)
|
||||
- YS7106 (PowerFailureAlar)
|
||||
- YS4908 (Finger)
|
||||
- YS7805 (Outdoor Motion Detector Sensor)
|
||||
|
||||
@ -692,7 +692,7 @@ trigger:
|
||||
# `event_source` and `event` are required
|
||||
event_source: node # options are node, controller, and driver
|
||||
event: "interview failed" # event names can be retrieved from the Z-Wave JS docs (see links above)
|
||||
# `event_data` and `partial_dict_match` are optional. If `event_data` isn't included, all events of a given type for the given context will trigger the automation. When the `interview failed` event is fired, all argument live in a dictionary within the `event_data` dictionary under the `args` key. The default behavior is to require a full match of the event_data dictionary below and the dictionary that is passed to the event. By setting `partial_dict_match` to true, Home Assistant will check if the isFinal argument is true and ignore any other values in the dictionary. If this setting was false, this trigger would never fire because the dictionary always contains more keys than `isFinal` so the comparsion check would never evaluate to true.
|
||||
# `event_data` and `partial_dict_match` are optional. If `event_data` isn't included, all events of a given type for the given context will trigger the automation. When the `interview failed` event is fired, all argument live in a dictionary within the `event_data` dictionary under the `args` key. The default behavior is to require a full match of the event_data dictionary below and the dictionary that is passed to the event. By setting `partial_dict_match` to true, Home Assistant will check if the isFinal argument is true and ignore any other values in the dictionary. If this setting was false, this trigger would never fire because the dictionary always contains more keys than `isFinal` so the comparison check would never evaluate to true.
|
||||
event_data:
|
||||
args:
|
||||
isFinal: true
|
||||
@ -903,7 +903,7 @@ When trying to determine why something isn't working as you expect, or when repo
|
||||
|
||||
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
|
||||
2. Select the **Z-Wave** integration. Then, select the three dots.
|
||||
3. From he dropdown menu, select **Download diagnostics**.
|
||||
3. From the dropdown menu, select **Download diagnostics**.
|
||||
|
||||
### How do I address interference issues?
|
||||
|
||||
|
||||
@ -0,0 +1,37 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Nabu Casa at the Matter Member Meeting"
|
||||
description: "Nabu Casa represented Home Assistant, our community, and the Open Home vision at the Matter Member Meeting in Geneva. And we’ll have a dedicated live stream about Matter in January!"
|
||||
date: 2023-12-04 00:00:02
|
||||
date_formatted: "December 4, 2023"
|
||||
author: Marcel van der Veldt
|
||||
comments: true
|
||||
categories: Matter
|
||||
og_image: /images/blog/2023-11-matter-member-meeting/matter-image.jpg
|
||||
---
|
||||
|
||||
TL;DR: We represented Home Assistant, our community, and the Open Home vision at the Matter member meeting in Geneva. We’re hosting a live stream to talk Matter in January to update you about our progress and answer your questions. Leave your questions in the comments below!
|
||||
|
||||
Two weeks ago me, Marcel van der Veldt, and Stefan Agner, traveled to Geneva to represent Home Assistant, our community and the Open Home Vision at the Member Meeting of the Connectivity Standards Alliance (CSA). This is an important meeting where companies from all over the world meet to talk and decide about the Matter standard and how to implement it.
|
||||
|
||||
_(Matter is the new smart home standard that promises to make everyone’s smart home devices work with each other across platforms and ecosystems, locally and privately. It’s being developed by the CSA, which is also responsible for Zigbee)._
|
||||
|
||||
<p class='img'>
|
||||
<img src="/images/blog/2023-11-matter-member-meeting/matter-image.jpg">
|
||||
Stefan and Marcel
|
||||
</p>
|
||||
|
||||
We were able to attend because [Nabu Casa](https://www.nabucasa.com) is a member of the CSA. We pay for this with the revenue from your Home Assistant Cloud subscriptions (thank you!). CSA membership ensures that we have access to official technical documentation and support to build Matter into Home Assistant. It also gives us a voice inside the CSA, which we use to advocate for the interests of Home Assistant users and our Open Home vision.
|
||||
|
||||
<!--more-->
|
||||
We love to attend these events and hear amazing stories from the people we meet. When talking with engineers working on Matter in the CSA, we noticed a lot of them run Home Assistant at their own homes and are enthusiastic supporters of the project! Talking to device manufacturers made us realize that Home Assistant is used as a test platform because our Matter server is the most flexible. This is great because it increases the likelihood that Matter devices work great in Home Assistant, as devices will have been implemented and tested on it!
|
||||
|
||||
Our participation in the development of Matter also means we’re in touch with engineers at other companies on a regular basis. One of the most popular Matter devices on the market right now, the Eve Energy Plug, has custom support for energy metering - a function not yet supported in the current Matter standard. The only way to see your energy usage was inside Eve’s own app. We’ve worked together with Eve, so we can now read the measurements from their plugs via custom Matter clusters and show them in Home Assistant! This feature will be available in the December release of Home Assistant. If you own Eve Energy Plugs, this is our early Christmas present for you.
|
||||
|
||||
## Home Assistant and Matter
|
||||
|
||||
We haven’t just joined the CSA; we also have dedicated developers working on making sure that Matter is a first-class citizen within Home Assistant. In our eyes, it’s ideal for Home Assistant users because of the local nature of the protocol. It is our goal to make Home Assistant an officially certified Matter controller registered with the CSA.
|
||||
|
||||
To talk more about our ongoing progress with Matter, we’ll host a live stream in January. It will contain a full update on the state of Matter and go in-depth about what we have planned. We’ll announce the date soon.
|
||||
|
||||
We don’t want it to be just a stream of us talking Matter to you. We know you have many questions about Matter, things that are unclear, or that you want our help to understand. So please send us your burning questions in the comments below!
|
||||
BIN
source/images/assist/assist_create_alias.png
Normal file
BIN
source/images/assist/assist_create_alias.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
source/images/assist/expose_entity_dialog.png
Normal file
BIN
source/images/assist/expose_entity_dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
BIN
source/images/assist/metno_weather_entity.png
Normal file
BIN
source/images/assist/metno_weather_entity.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
source/images/assist/weather_entity_voice_assistant.png
Normal file
BIN
source/images/assist/weather_entity_voice_assistant.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 52 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 104 KiB |
BIN
source/images/integrations/slack/slack-member-id.png
Normal file
BIN
source/images/integrations/slack/slack-member-id.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
@ -9,18 +9,44 @@ These sentences allow you, for example, to:
|
||||
- **Turn entities on and off**
|
||||
- *"turn on the living room light"*
|
||||
- *"turn off ceiling fan"*
|
||||
- *"turn on the TV"*
|
||||
- *"lock all the doors"*
|
||||
- *"open the main door"*
|
||||
- **Open and close covers**
|
||||
- *"Close the garage door"*
|
||||
- *"Open kitchen window"*
|
||||
- **Set the brightness and color of lights**
|
||||
- *"Change kitchen lights brightness to 50%"*
|
||||
- *"Set bed light to green"*
|
||||
- **Ask about the weather**
|
||||
- *"What is the weather"*
|
||||
- Struggling with this one? Check the [troubleshooting section](/voice_control/troubleshooting/).
|
||||
- **Add items to a list**
|
||||
- *"Add bread to my shopping list"*
|
||||
- *"Add decorating christmas tree to my december chores list"*
|
||||
- **Get information about a state**
|
||||
- *"What is the amount of energy from solar production?"*
|
||||
- *"what is the heat pump co2 sensor's co2 level?"*
|
||||
- *"what is the battery level of my phone?"*
|
||||
- **Run a script**
|
||||
- *"Run stealth mode script"*
|
||||
- **Activate a scene**
|
||||
- *"Activate dinner scence"*
|
||||
- *"Turn kitchen dinner scene on"*
|
||||
- **Inquire about people (that have device tracking activated in Home Assistant)**
|
||||
- *"How many people are in the kitchen"*
|
||||
- *"Who is in the garage"*
|
||||
- *"Where is Anne"*
|
||||
- **Abort wake word**
|
||||
- *"Nevermind"*: If you triggered the wake word by mistake and want to stop Home Assistant from listening
|
||||
|
||||
In addition to individual entities, commands can target **areas**:
|
||||
The sentences only work, if the {% term entities %} are available and are named exactly the way you call them. Check the [troubleshooting section](/voice_control/troubleshooting/) to see common errors when asking for the weather forecast.
|
||||
|
||||
In addition to individual {% term entities %}, commands can target **areas**:
|
||||
|
||||
- *"turn on all lights in the living room"*
|
||||
- *"open windows in the kitchen"*
|
||||
- *"change kitchen brightness to 50%"*
|
||||
- *"change office brightness to 50%"*
|
||||
- *"set bedroom lights to green"*
|
||||
|
||||
Entity [aliases](/voice_control/aliases) are also matched so that multiple names can be used, even in different languages.
|
||||
@ -29,21 +55,20 @@ You can extend the [built-in sentences](https://github.com/home-assistant/intent
|
||||
|
||||
## View existing sentences
|
||||
|
||||
Broadly speaking, you can use your voice to turn things on or off, inquire about a state, or change the brightness or color of a light.
|
||||
The list of supported sentences is constantly being updated for each language. There are so many possible sentences that they cannot be all listed here. To find out what works in your language, follow these steps.
|
||||
|
||||
If the voice assistant doesn't understand you, you may need to rephrase your sentence a bit.
|
||||
To get an idea of the specific sentences that are supported for your language, you can do the following:
|
||||
**Note**: If the voice assistant doesn't understand you, you may need to rephrase your sentence a bit. Or check if the {% term entity %} or {% term area %} name is correct for your environment.
|
||||
|
||||
1. Take a look at the test sentences:
|
||||
- On GitHub, in the [tests](https://github.com/home-assistant/intents/tree/main/sentences) folder, open the subfolder for your language.
|
||||
- Look through the test files to see the example sentences that have been tested.
|
||||
- The second part of the file name shows the {% term intent %}, the first part shows the domain. For some domains, such as covers, fans, and light, there are specific sentences.
|
||||
The other domains are covered by the generic *homeassistant_*.
|
||||
- The second part of the file name shows the {% term intent %}, the first part shows the {% term domain %}. For some {% term domains %}, such as covers, fans, and light, there are specific sentences.
|
||||
The other {% term domains %} are covered by the generic *homeassistant_*.
|
||||
|
||||
|
||||
|
||||
- The screenshot below shows sentences used to test the command to turn on the lights. Note that *Living room* here is just a place holder.
|
||||
It could be any area that you have in your home.
|
||||
It could be any {% term area %} that you have in your home.
|
||||
|
||||
|
||||
|
||||
@ -68,3 +93,4 @@ To get an idea of the specific sentences that are supported for your language, y
|
||||
- [Built-in response definitions](https://github.com/home-assistant/intents/tree/main/responses)
|
||||
- [Template sentence syntax documentation](https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax/)
|
||||
- [Sentence test cases](https://github.com/home-assistant/intents/tree/main/sentences)
|
||||
- [Sentence troubleshooting](/voice_control/troubleshooting/)
|
||||
|
||||
@ -57,3 +57,34 @@ If the **Assist** section is missing entirely, you need to add the following to
|
||||
# Example configuration.yaml entry
|
||||
assist_pipeline:
|
||||
```
|
||||
|
||||
## Assist does not understand my question about the weather forecast
|
||||
|
||||
The example below shows common pitfalls when enquiring about the weather. While some steps are specific to the weather, the general mechanics apply to other entities as well.
|
||||
|
||||
1. Make sure you have a [weather service](/integrations/#weather) installed.
|
||||
- By default, [Met.no](/integrations/met/) is installed.
|
||||
2. Make sure you have an entity set up for the location you are interested in.
|
||||
- For example, if you are interested in the weather in Berlin, add an entity for Berlin.
|
||||
|
||||
|
||||
3. Make sure the entity is exposed to Assist:
|
||||
- Under {% my entities title="**Settings** > **Devices & services** > **Entities**" %}, select the weather entity for that location.
|
||||
- In the details view that opens, select the cogwheel, then select **Voice Assistant**.
|
||||
|
||||
|
||||
|
||||
- Make sure the entity is exposed to Assist.
|
||||
|
||||
|
||||
|
||||
4. Make sure you use the exact entity name when talking to Assist.
|
||||
- To view the entity name, check the list under {% my entities title="**Settings** > **Devices & services** > **Entities**" %}.
|
||||
- For example, if the entity is called *Forecast Berlin*, you have to say "What is the weather in forecast Berlin like".
|
||||
- Assist would not recognize it if you ask "What is the weather in Berlin like".
|
||||
- If you want to use Berlin instead of *Forecast Berlin*, you can create an entity name alias.
|
||||
- You can create as many aliases as you like.
|
||||
|
||||
|
||||
5. If you just ask "What is the weather" when you have forecast entities for multiple entities, Assist always returns the data for the place that was first added. Currently, there is no way to change that.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user