jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-04-19 10:57:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enforce Markdown ordered list numbering (#28179)

Browse Source
This commit is contained in:
Franck Nijhof 2023-07-11 21:28:37 +02:00 committed by GitHub
parent baf3c87cb8
commit ca962cf860
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
39 changed files with 484 additions and 465 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.remarkrc.js
View File

@ -16,6 +16,7 @@ var remarkrc = {
["remark-lint-heading-style", "atx"],
["remark-lint-unordered-list-marker-style", "-"],
["remark-lint-ordered-list-marker-style", "."],
["remark-lint-ordered-list-marker-value"],
[
"remark-lint-prohibited-strings",
[

19
package-lock.json generated
View File

@ -16,6 +16,7 @@
"remark-lint-heading-style": "^3.1.2",
"remark-lint-no-shell-dollars": "^3.1.2",
"remark-lint-ordered-list-marker-style": "^3.1.2",
"remark-lint-ordered-list-marker-value": "^3.1.2",
"remark-lint-prohibited-strings": "^3.1.0",
"remark-lint-unordered-list-marker-style": "^3.1.2",
"remark-stringify": "^10.0.3",
@ -3609,6 +3610,24 @@
"url": "https://opencollective.com/unified"
}
},
"node_modules/remark-lint-ordered-list-marker-value": {
"version": "3.1.2",
"resolved": "https://registry.npmjs.org/remark-lint-ordered-list-marker-value/-/remark-lint-ordered-list-marker-value-3.1.2.tgz",
"integrity": "sha512-kG08nhsFk8rhoXK5EeDN/wN28CxefraDud/MaZnji8LEyxF3HAkzFuETr9laOn8Ey+n8h/C0mpqAwUf4thyJ5g==",
"dev": true,
"dependencies": {
"@types/mdast": "^3.0.0",
"unified": "^10.0.0",
"unified-lint-rule": "^2.0.0",
"unist-util-generated": "^2.0.0",
"unist-util-position": "^4.0.0",
"unist-util-visit": "^4.0.0"
},
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/unified"
}
},
"node_modules/remark-lint-prohibited-strings": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/remark-lint-prohibited-strings/-/remark-lint-prohibited-strings-3.1.0.tgz",

1
package.json
View File

@ -11,6 +11,7 @@
"remark-lint-heading-style": "^3.1.2",
"remark-lint-no-shell-dollars": "^3.1.2",
"remark-lint-ordered-list-marker-style": "^3.1.2",
"remark-lint-ordered-list-marker-value": "^3.1.2",
"remark-lint-prohibited-strings": "^3.1.0",
"remark-lint-unordered-list-marker-style": "^3.1.2",
"remark-stringify": "^10.0.3",

18
source/_docs/automation/using_blueprints.markdown
View File

@ -14,10 +14,10 @@ Quick links:
Automations based on a blueprint need to be configured. What needs to be configured differs on each blueprint.
1. To create your first automation based on a blueprint, go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
1. Find the blueprint that you want to use and select **Create Automation**.
2. Find the blueprint that you want to use and select **Create Automation**.
- This opens the automation editor with the blueprint selected.
1. Give it a name and configure the blueprint.
1. Select the blue **Save Automation** button in the bottom right corner.
3. Give it a name and configure the blueprint.
4. Select the blue **Save Automation** button in the bottom right corner.
Done! If you want to revisit the configuration values, go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
@ -32,10 +32,10 @@ Home Assistant can import blueprints from the Home Assistant forums, GitHub, and
https://github.com/home-assistant/core/blob/dev/homeassistant/components/automation/blueprints/motion_light.yaml
```
1. Go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
1. Select the blue **{% my blueprint_import blueprint="https://github.com/home-assistant/core/blob/master/homeassistant/components/automation/blueprints/motion_light.yaml" %}** button in the bottom right.
2. Go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
3. Select the blue **{% my blueprint_import blueprint="https://github.com/home-assistant/core/blob/master/homeassistant/components/automation/blueprints/motion_light.yaml" %}** button in the bottom right.
- A new dialog will pop-up asking you for the URL.
1. Enter the URL and select **Preview**.
4. Enter the URL and select **Preview**.
- This will load the blueprint and show a preview in the import dialog.
- You can change the name and finish the import.
@ -52,13 +52,13 @@ its YAML content to keep it up to date:
1. Navigate to the blueprints directory (`blueprints/automation/`).
The location of this directory depends on the installation method. It's
similar to how you find [`configuration.yaml`](/docs/configuration/#editing-configurationyaml).
1. Next, you must find the blueprint to update. The path name of a blueprint consists of:
2. Next, you must find the blueprint to update. The path name of a blueprint consists of:
- The username of the user that created it. The name depends on the source of the blueprint:
the forum, or GitHub.
- The name of the YAML file. For the forum it's the title of the topic in the URL, for GitHub
it's the name of the YAML file.
1. Open the YAML file with your editor and update its contents.
1. Reload the automations for the changes to take effect.
3. Open the YAML file with your editor and update its contents.
4. Reload the automations for the changes to take effect.
The new changes will appear to your existing automations as well.

6
source/_docs/configuration/templating.markdown
View File

@ -51,9 +51,9 @@ script:
There are a few very important rules to remember when adding templates to YAML:
1. You **must** surround single-line templates with double quotes (`"`) or single quotes (`'`).
1. It is advised that you prepare for undefined variables by using `if ... is not none` or the [`default` filter](https://jinja.palletsprojects.com/en/latest/templates/#jinja-filters.default), or both.
1. It is advised that when comparing numbers, you convert the number(s) to a [`float`](https://jinja.palletsprojects.com/en/latest/templates/#float) or an [`int`](https://jinja.palletsprojects.com/en/latest/templates/#int) by using the respective [filter](https://jinja.palletsprojects.com/en/latest/templates/#list-of-builtin-filters).
1. While the [`float`](https://jinja.palletsprojects.com/en/latest/templates/#float) and [`int`](https://jinja.palletsprojects.com/en/latest/templates/#int) filters do allow a default fallback value if the conversion is unsuccessful, they do not provide the ability to catch undefined variables.
2. It is advised that you prepare for undefined variables by using `if ... is not none` or the [`default` filter](https://jinja.palletsprojects.com/en/latest/templates/#jinja-filters.default), or both.
3. It is advised that when comparing numbers, you convert the number(s) to a [`float`](https://jinja.palletsprojects.com/en/latest/templates/#float) or an [`int`](https://jinja.palletsprojects.com/en/latest/templates/#int) by using the respective [filter](https://jinja.palletsprojects.com/en/latest/templates/#list-of-builtin-filters).
4. While the [`float`](https://jinja.palletsprojects.com/en/latest/templates/#float) and [`int`](https://jinja.palletsprojects.com/en/latest/templates/#int) filters do allow a default fallback value if the conversion is unsuccessful, they do not provide the ability to catch undefined variables.
Remembering these simple rules will help save you from many headaches and endless hours of frustration when using automation templates.

6
source/_docs/z-wave/controllers.markdown
View File

@ -134,7 +134,7 @@ This procedure has been tested with the following modules:
1. Make sure the module is properly seated on the Home Assistant Yellow.
![Aeotec Z-Pi 7 on Home Assistant Yellow](/images/docs/z-wave/zpi-7-yellow.jpg).
1. Carefully [close the case](https://yellow.home-assistant.io/guides/add-ssd-existing-installation/#reassembling-top-part) and power up Home Assistant Yellow.
1. Follow the procedure on [setting up a Z-Wave JS server](/integrations/zwave_js/#setting-up-a-z-wave-js-server).
2. Carefully [close the case](https://yellow.home-assistant.io/guides/add-ssd-existing-installation/#reassembling-top-part) and power up Home Assistant Yellow.
3. Follow the procedure on [setting up a Z-Wave JS server](/integrations/zwave_js/#setting-up-a-z-wave-js-server).
1. In step 2, follow the manual setup steps to install the Z-Wave integration.
1. in Step 4, you will be prompted to choose a **Device path**. Choose **ttyAMA0**.
2. in Step 4, you will be prompted to choose a **Device path**. Choose **ttyAMA0**.

10
source/_includes/common-tasks/enable_entities.md
View File

@ -3,10 +3,10 @@
Some entities are disabled by default. To enable them, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & Services" %}** and select the integration of interest.
1. Select **entities**.
1. From the list of entities, select the entity you want to enable.
2. Select **entities**.
3. From the list of entities, select the entity you want to enable.
![Select entity from list](/images/screenshots/enable_entities_01.png)
1. In the pop-up, select the cogwheel.
1. Toggle the **Enabled** button.
4. In the pop-up, select the cogwheel.
5. Toggle the **Enabled** button.
![Enable entities](/images/screenshots/enable_entities_03.png)
1. To save the changes, select **Update**.
6. To save the changes, select **Update**.

26
source/_includes/common-tasks/flashing_n2_otg.md
View File

@ -18,17 +18,17 @@ To flash your eMMC using Petitboot and OTG-USB, you will need the following item
To enable the SPI boot mode:
1. Power off the ODROID-N2+ by unplugging the power cable.
1. Remove the case.
2. Remove the case.
![Photo of the removed case](/images/hassio/screenshots/case-removed.jpg)
1. Locate the toggle for boot mode and switch it from MMC to SPI.
3. Locate the toggle for boot mode and switch it from MMC to SPI.
![Photo of the SPI toggle switch](/images/hassio/screenshots/toggle_spi.jpg)
1. Connect the ODROID-N2+ directly to your computer via the USB-OTG port located on the front of the board.
1. Connect a USB keyboard and a monitor (using HDMI) to your ODROID-N2+.
1. Plug in the power cable to power on the ODROID-N2+.
4. Connect the ODROID-N2+ directly to your computer via the USB-OTG port located on the front of the board.
5. Connect a USB keyboard and a monitor (using HDMI) to your ODROID-N2+.
6. Plug in the power cable to power on the ODROID-N2+.
### Enabling USB drive mode
@ -46,13 +46,13 @@ You can safely ignore this message and proceed with the installation
</div>
1. Use the following command at the console to confirm the storage device node:
2. Use the following command at the console to confirm the storage device node:
```bash
ls /dev/mmc*
```
1. Set the storage device on the ODROID-N2+ as a mass storage device using the `ums` command (USB Mass storage mode).
3. Set the storage device on the ODROID-N2+ as a mass storage device using the `ums` command (USB Mass storage mode).
This will configure the ODROID-N2+ and OTG to act as a memory card reader:
```bash
@ -62,18 +62,18 @@ This will configure the ODROID-N2+ and OTG to act as a memory card reader:
### Flashing Home Assistant
1. Connect the ODROID-N2+ to your PC via the micro-USB port at the front of the ODROID-N2+.
1. When the ODROID-N2 is recognized as a USB connected storage device, you can flash the eMMC with [Etcher](https://www.balena.io/etcher/).
2. When the ODROID-N2 is recognized as a USB connected storage device, you can flash the eMMC with [Etcher](https://www.balena.io/etcher/).
- Use the latest stable version of Home Assistant OS for the [ODROID-N2+](https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos['odroid-n2']}}/haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz) (haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz).
1. When the flash process is complete, disconnect the ODROID-N2+ from your PC.
3. When the flash process is complete, disconnect the ODROID-N2+ from your PC.
- Remove the power cable.
- Remove the USB and HDMI cables.
- Make sure to toggle the boot mode switch back to MMC.
1. Put the ODROID back in its case.
1. Connect your ODROID-N2+ to your network with an Ethernet cable and plug in power.
4. Put the ODROID back in its case.
5. Connect your ODROID-N2+ to your network with an Ethernet cable and plug in power.
1. If your router supports mDNS, you can reach your installation at `http://homeassistant.local:8123`.
6. If your router supports mDNS, you can reach your installation at `http://homeassistant.local:8123`.
- If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of `homeassistant.local`. For example, `http://192.168.0.9:8123`.
- You should be able to find the IP address of your ODROID-N2+ from the admin interface of your router.
1. Continue with [onboarding](/getting-started/onboarding/).
7. Continue with [onboarding](/getting-started/onboarding/).

14
source/_includes/common-tasks/network_storage.md
View File

@ -30,9 +30,9 @@ To list all your currently connected network storages, go to **{% my storage tit
### Add a new network storage
1. Go to **{% my storage title="Settings > System > Storage" %}** in the UI.
1. Select **Add network storage**.
1. Fill out all the information for your network storage.
1. Select **Connect**.
2. Select **Add network storage**.
3. Fill out all the information for your network storage.
4. Select **Connect**.
<p class='img'>
<picture>
@ -85,10 +85,10 @@ By default, the first network storage of type **Backup** that you add will be se
If you want to change the default backup target, you can do the following:
1. Go to **{% my backup title="Settings > System > Backups" %}** in the UI.
1. Select the menu in the top right of the screen and select the **Change default backup location** option.
1. In the dialog, there is a single option to set the default backup target.
1. Choose the one you want from the list.
1. Select **Save**.
2. Select the menu in the top right of the screen and select the **Change default backup location** option.
3. In the dialog, there is a single option to set the default backup target.
4. Choose the one you want from the list.
5. Select **Save**.
This list will contain all the network storage targets you have added of usage type **Backup**. It also contains another option to set it back to use `/backup` again.

8
source/_includes/common-tasks/update.md
View File

@ -3,11 +3,11 @@
Best practice for updating a Home Assistant installation:
1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the backup functionality Home Assistant offers{% endif %}.
1. Check the release notes for breaking changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Breaking Changes**.
2. Check the release notes for breaking changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Breaking Changes**.
{% if page.installation == "os" or page.installation == "supervised" %}
1. Select "Create backup before updating" in case you encounter an issue that requires a rollback.
1. Update Home Assistant.
1. Review persistent notifications and log to see if there are any issues with your configuration that need to be addressed.
3. Select "Create backup before updating" in case you encounter an issue that requires a rollback.
4. Update Home Assistant.
5. Review persistent notifications and log to see if there are any issues with your configuration that need to be addressed.
{% endif %}
{% if page.installation == "os" or page.installation == "supervised" %}

68
source/_includes/installation/operating_system.md
View File

@ -72,13 +72,13 @@ To boot Home Assistant OS, the BIOS needs to have UEFI boot mode enabled and Sec
1. To enter the BIOS, start up your x86-64 hardware and repeatedly press the `F2` key (on some systems this might be `Del`, `F1` or `F10`).
![Enter BIOS using F2, Del, F1 or F10 key](/images/installation/intel-nuc-enter-bios.jpg)
1. Make sure the UEFI Boot mode is enabled.
2. Make sure the UEFI Boot mode is enabled.
![Enable UEFI Boot mode](/images/installation/intel-nuc-uefi-boot.jpg)
1. Disable Secure Boot.
3. Disable Secure Boot.
![Disable Secure Boot mode](/images/installation/intel-nuc-disable-secure-boot.jpg)
1. Save your changes and exit.
4. Save your changes and exit.
The BIOS configuration is now complete.
@ -95,7 +95,7 @@ To write the HAOS image to the boot medium on your x86-64 hardware, there are 2
1. Write the HAOS disk image from your desktop computer directly to the boot medium (e.g. using a USB to S-ATA adapter).
If you can use this method, proceed to "[Write the image to your boot medium](#write-the-image-to-your-boot-medium)" and follow all steps. If you have non-removable internal mediums or don't have the necessary adapter, try the next method instead.
1. Create a "live operating system" on a USB device running e.g. Ubuntu ([how-to guide](https://ubuntu.com/tutorials/try-ubuntu-before-you-install)). Insert it into your system and boot the live operating system. Then follow from step 2 in "[Write the image to your boot medium](#write-the-image-to-your-boot-medium)".
2. Create a "live operating system" on a USB device running e.g. Ubuntu ([how-to guide](https://ubuntu.com/tutorials/try-ubuntu-before-you-install)). Insert it into your system and boot the live operating system. Then follow from step 2 in "[Write the image to your boot medium](#write-the-image-to-your-boot-medium)".
{% details "Ubuntu dependencies for Etcher" %}
@ -120,11 +120,11 @@ sudo apt install libfuse2
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).
{% endif %}
1. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>. You may need to run it with administrator privileges on Windows.
1. Select **Flash from URL**.
2. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>. You may need to run it with administrator privileges on Windows.
3. Select **Flash from URL**.
![Screenshot of the Etcher software showing flash from URL selected.](/images/installation/etcher1.png)
1. Copy the URL for the image. If there are multiple links below, make sure to select the correct link for your version of {{site.installation.types[page.installation_type].board}}:
4. Copy the URL for the image. If there are multiple links below, make sure to select the correct link for your version of {{site.installation.types[page.installation_type].board}}:
{% if site.installation.types[page.installation_type].variants.size > 1 %}
{% tabbed_block %}
{% for variant in site.installation.types[page.installation_type].variants %}
@ -157,13 +157,13 @@ _Select and copy the URL or use the "copy" button that appear when you hover it.
5. Paste the URL for the {{site.installation.types[page.installation_type].board}} image into Balena Etcher and select **OK**.
![Screenshot of the Etcher software showing the URL bar with a URL pasted in.](/images/installation/etcher2.png)
1. When Balena Etcher has downloaded the image, click **Select target**.
![Screenshot of the Etcher software showing the select target button highlighted.](/images/installation/etcher3.png)
1. Select the boot medium ({{site.installation.types[page.installation_type].installation_media}}) you want to use for your installation.
6. When Balena Etcher has downloaded the image, click **Select target**.
[Screenshot of the Etcher software showing the select target button highlighted.](/images/installation/etcher3.png)
7. Select the boot medium ({{site.installation.types[page.installation_type].installation_media}}) you want to use for your installation.
![Screenshot of the Etcher software showing teh targets available.](/images/installation/etcher4.png)
1. Select **Flash!** to start writing the image.
8. Select **Flash!** to start writing the image.
![Screenshot of the Etcher software showing the Flash button highlighted.](/images/installation/etcher5.png)
1. When Balena Etcher has finished writing the image, you will see a confirmation.
9. When Balena Etcher has finished writing the image, you will see a confirmation.
![Screenshot of the Etcher software showing that the installation has completed.](/images/installation/etcher6.png)
- If you are having issues with Balena Etcher, try version [1.10](https://github.com/balena-io/etcher/releases/tag/v1.10.4).
@ -176,7 +176,7 @@ _Select and copy the URL or use the "copy" button that appear when you hover it.
- If you used a live operating system (e.g. Ubuntu), shut it down and remove the live operating system USB device.
1. Plug in an Ethernet cable that is connected to the network.
1. Power the system on. If you have a screen connected to the {{site.installation.types[page.installation_type].board}} system, after a minute or so the Home Assistant welcome banner will appear in the console.
2. Power the system on. If you have a screen connected to the {{site.installation.types[page.installation_type].board}} system, after a minute or so the Home Assistant welcome banner will appear in the console.
<div class="note">
@ -255,10 +255,10 @@ _All these can be extended if your usage calls for more resources._
- title: VirtualBox
content: |
1. Create a new virtual machine.
1. Select type **Linux** and version **Linux 2.6 / 3.x / 4.x (64-bit)**.
1. Select **Use an existing virtual hard disk file**, select the unzipped VDI file from above.
1. Edit the **Settings** of the VM and go to **System** > **Motherboard**. Select **Enable EFI**.
1. Then go to **Network** > **Adapter 1**. Choose **Bridged Adapter** and choose your network adapter.
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**.
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.
@ -277,15 +277,15 @@ _All these can be extended if your usage calls for more resources._
- title: KVM (virt-manager)
content: |
1. Create a new virtual machine in `virt-manager`.
1 Select **Import existing disk image**, provide the path to the QCOW2 image above.
1. Choose **Generic Default** for the operating system.
1. Check the box for **Customize configuration before install**.
1. Under **Network Selection**, select your bridge.
2. Select **Import existing disk image**, provide the path to the QCOW2 image above.
3. Choose **Generic Default** for the operating system.
4. Check the box for **Customize configuration before install**.
5. Under **Network Selection**, select your bridge.
6. Under customization select **Overview** > **Firmware** > **UEFI x86_64: ...**. Make sure to select a non-secureboot version of OVMF (does not contain the word `secure`, `secboot`, etc.), e.g., `/usr/share/edk2/ovmf/OVMF_CODE.fd`.
1. Click **Add Hardware** (bottom left), and select **Channel**.
1. Select device type: **unix**.
1. Select name: **org.qemu.guest_agent.0**.
1. Finally, select **Begin Installation** (upper left corner).
7. Click **Add Hardware** (bottom left), and select **Channel**.
8. Select device type: **unix**.
9. Select name: **org.qemu.guest_agent.0**.
10. Finally, select **Begin Installation** (upper left corner).
- title: KVM (virt-install)
content: |
@ -322,10 +322,10 @@ _All these can be extended if your usage calls for more resources._
- title: Vmware Workstation
content: |
1. Create a new virtual machine.
1. Select **Custom**, make it compatible with the default of Workstation and ESX.
1. Choose **I will install the operating system later**, select **Linux** > **Other Linux 5.x or later kernel 64-bit**.
1. Select **Use Bridged Networking**.
1. Select **Use an existing virtual disk** and select the VMDK file above.
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.
After the VM has been created, go to **Settings** > **Options** > **Advanced**. Under **Firmware type** select **UEFI**.
@ -343,9 +343,9 @@ _All these can be extended if your usage calls for more resources._
</div>
1. Create a new virtual machine.
1. Select **Generation 2**.
1. Select **Connection** > **Your Virtual Switch that is bridged**.
1. Select **Use an existing virtual hard disk** and select the VHDX file from above.
2. Select **Generation 2**.
3. Select **Connection** > **Your Virtual Switch that is bridged**.
4. Select **Use an existing virtual hard disk** and select the VHDX file from above.
After creation, go to **Settings** > **Security** and deselect **Enable Secure Boot**.
{% endif %}
@ -355,8 +355,8 @@ _All these can be extended if your usage calls for more resources._
### Start up your virtual machine
1. Start the virtual machine.
1. Observe the boot process of the Home Assistant Operating System.
1. Once completed, you will be able to reach Home Assistant on <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at <a href="http://homeassistant:8123" target="_blank">homeassistant:8123</a> or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).
2. Observe the boot process of the Home Assistant Operating System.
3. Once completed, you will be able to reach Home Assistant on <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>. If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at <a href="http://homeassistant:8123" target="_blank">homeassistant:8123</a> or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}’s IP address).
{% endif %}

78
source/_integrations/fireservicerota.markdown
View File

@ -49,36 +49,36 @@ The following entity types are created:
This is the main entity of the integration containing the incident message as its `value`, it has several attributes which are described below.
| Attribute | Description |
| --------- | ----------- |
| `trigger` | Type of trigger, `new` or `update`.|
| `state` | The state of the incident. |
| `created_at` | Date and time when incident was created.|
| `message_to_speech_url` | The URL of the mp3 file containing the spoken text of the incident.|
| `prio` | Priority of the incident, `a1`, `a2`, `b1` or `b2`.|
| `type` | Type of incident, e.g. `incident_alert`.|
| `responder_mode` | Modes of response, e.g. `available_in_schedule_is_acknowledgment`.|
| `can_respond_until` | Date and time until response is accepted.|
| `latitude` | The Latitude of the incident.|
| `longitude` | The Longitude of the incident.|
| `address_type` | Type of address, e.g. `home`.|
| `formatted_address` | Address in string format.|
| `task_ids` | ID(s) of appliance(s) or task(s).|
| Attribute | Description |
| ----------------------- | ------------------------------------------------------------------- |
| `trigger` | Type of trigger, `new` or `update`. |
| `state` | The state of the incident. |
| `created_at` | Date and time when incident was created. |
| `message_to_speech_url` | The URL of the mp3 file containing the spoken text of the incident. |
| `prio` | Priority of the incident, `a1`, `a2`, `b1` or `b2`. |
| `type` | Type of incident, e.g. `incident_alert`. |
| `responder_mode` | Modes of response, e.g. `available_in_schedule_is_acknowledgment`. |
| `can_respond_until` | Date and time until response is accepted. |
| `latitude` | The Latitude of the incident. |
| `longitude` | The Longitude of the incident. |
| `address_type` | Type of address, e.g. `home`. |
| `formatted_address` | Address in string format. |
| `task_ids` | ID(s) of appliance(s) or task(s). |
### Duty Binary Sensor
This entity reflects the duty you have scheduled, the value can be `on` = on duty, `off` = no duty. When you have no duty the response switch is disabled which means you cannot respond to a call.
| Attribute | Description |
| --------- | ----------- |
| `start_time` | Start date and time of duty schedule.|
| `end_time` | End date and time of duty schedule.|
| `available` | `true` or `false`.|
| `active` | `true` or `false`.|
| `assigned_function_ids` | Function id's, e.g. `540`.|
| `skill_ids` | Skill id's, e.g. `6, 8`.|
| `type` | Type, e.g. `standby_duty`.|
| `assigned function` | Assigned function, e.g. `Chauffeur`.|
| Attribute | Description |
| ----------------------- | ------------------------------------- |
| `start_time` | Start date and time of duty schedule. |
| `end_time` | End date and time of duty schedule. |
| `available` | `true` or `false`. |
| `active` | `true` or `false`. |
| `assigned_function_ids` | Function id's, e.g. `540`. |
| `skill_ids` | Skill id's, e.g. `6, 8`. |
| `type` | Type, e.g. `standby_duty`. |
| `assigned function` | Assigned function, e.g. `Chauffeur`. |
### Incident Response Switch
@ -87,26 +87,26 @@ It gets reset to `unknown` value with every incident received. Switching it to `
The following attributes are available:
| Attribute | Description |
| --------- | ----------- |
| `user_name` | Your username.|
| `assigned_skill_ids` | Assigned skill ID's.|
| `responded_at` | Time you responded.|
| `start_time` | Incident response start time.|
| `status` | Status of response, e.g., `pending`.|
| `reported_status` | Reported status, e.g., `shown_up`.|
| `arrived_at_station` | `true` or `false`.|
| `available_at_incident_creation` | `true` or `false`.|
| `active_duty_function_ids` | Active function ID's, e.g., `540`.|
| Attribute | Description |
| -------------------------------- | ------------------------------------ |
| `user_name` | Your username. |
| `assigned_skill_ids` | Assigned skill ID's. |
| `responded_at` | Time you responded. |
| `start_time` | Incident response start time. |
| `status` | Status of response, e.g., `pending`. |
| `reported_status` | Reported status, e.g., `shown_up`. |
| `arrived_at_station` | `true` or `false`. |
| `available_at_incident_creation` | `true` or `false`. |
| `active_duty_function_ids` | Active function ID's, e.g., `540`. |
## Advanced Configuration
With Automation you can configure one or more of the following useful actions:
1. Sound an alarm and/or switch on lights when an emergency incident is received.
1. Use text-to-speech to play incident details via a media player while getting dressed.
1. Respond with a response acknowledgment using a door-sensor when leaving the house or by pressing a button to let your teammates know you are underway.
1. Cast a FireServiceRota dashboard to a Chromecast device. (this requires a Nabu Casa subscription)
2. Use text-to-speech to play incident details via a media player while getting dressed.
3. Respond with a response acknowledgment using a door-sensor when leaving the house or by pressing a button to let your teammates know you are underway.
4. Cast a FireServiceRota dashboard to a Chromecast device. (this requires a Nabu Casa subscription)
These are documented below.

6
source/_integrations/forecast_solar.markdown
View File

@ -132,6 +132,6 @@ To adjust the configuration settings for your Forecast.Solar integration
instance:
1. Browse to your Home Assistant instance.
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. If multiple instances of {{ name }} are configured, choose the instance you want to configure.
1. Select **Configure**.
2. Go to **{% my integrations title="Settings > Devices & Services" %}**.
3. If multiple instances of {{ name }} are configured, choose the instance you want to configure.
4. Select **Configure**.

8
source/_integrations/google_assistant.markdown
View File

@ -83,10 +83,10 @@ To use Google Assistant, your Home Assistant configuration has to be [externally
9. This will start a download of a JSON file.
1. Rename the file to `SERVICE_ACCOUNT.JSON`.
2. Add this file to your config-folder. This will be the same folder as your `configuration.yaml`.
12. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
13. Then select **SAVE**.
14. Go to the **Search products and resources** and search for **Homegraph API** and select it.
15. Enable the HomeGraph API.
10. Go back to [Google Cloud Platform](https://console.cloud.google.com/) and select **Close**.
11. Then select **SAVE**.
12. Go to the **Search products and resources** and search for **Homegraph API** and select it.
13. Enable the HomeGraph API.
5. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#yaml-configuration) below.
6. Add services in the Google Home App (note that app versions may be slightly different).

16
source/_integrations/homekit_controller.markdown
View File

@ -95,9 +95,9 @@ The integration will automatically discover Bluetooth devices once the [Bluetoot
1. Power up your HomeKit device.
- If you have Bluetooth enabled, the device should be discovered under **{% my integrations title="Settings > Devices & Services" %}**.
1. Under **{% my integrations title="Settings > Devices & Services" %}**, on the HomeKit integration, select **Configure**.
2. Under **{% my integrations title="Settings > Devices & Services" %}**, on the HomeKit integration, select **Configure**.
![HomeKit integration](/images/integrations/homekit_controller/homekit_controller_add_01.png)
1. To pair the device, enter the HomeKit pairing code. The code is on the device itself or the packaging.
3. To pair the device, enter the HomeKit pairing code. The code is on the device itself or the packaging.
- To pair a battery-powered device, you may need to press a button on the device to wake it.
- Bluetooth devices may take significantly longer to pair than IP devices.
- Add the device to a room and **Finish**.
@ -125,9 +125,9 @@ This section describes how to add it via Home Assistant's preferred Thread netwo
### To add a HomeKit device to a Thread network via Home Assistant
1. To open the device configuration page, on the **HomeKit** integration, select the **device**.
1. Under **Diagnostic**, you can see the **Thread Status** as **Disabled**.
2. Under **Diagnostic**, you can see the **Thread Status** as **Disabled**.
![Device configuration page](/images/integrations/homekit_controller/homekit_controller_add_02.png)
1. To enable Thread, under **Configuration**, select **Press**. This will provision the preferred Thread credentials.
3. To enable Thread, under **Configuration**, select **Press**. This will provision the preferred Thread credentials.
- The status has now changed:
- Depending on the device type, the mesh size and health, the Thread status can be **Child**, **Router**, or **Leader**.
![Thread status](/images/integrations/homekit_controller/homekit_controller_add_02.png)
@ -155,16 +155,16 @@ This section describes how to add a HomeKit device using an Apple Thread border
- This leaves the Thread network details on the HomeKit device.
- The device will be automatically discovered by the HomeKit controller integration in Home Assistant.
- It will appear as a discovered device over Thread.
1. Under **{% my integrations title="Settings > Devices & Services" %}**, on the HomeKit integration, select **Configure**.
2. Under **{% my integrations title="Settings > Devices & Services" %}**, on the HomeKit integration, select **Configure**.
![HomeKit integration](/images/integrations/homekit_controller/homekit_controller_add_01.png)
1. To pair the device, enter the HomeKit pairing code. The code is on the device itself or the packaging.
3. To pair the device, enter the HomeKit pairing code. The code is on the device itself or the packaging.
- To pair a battery-powered device, you may need to press a button on the device to wake it.
- Bluetooth devices may take significantly longer to pair than IP devices.
- Add the device to a room and **Finish**.
1. To open the device configuration page, on the **HomeKit** integration, select the **device**.
1. Under **Diagnostic**, check the status:
4. To open the device configuration page, on the **HomeKit** integration, select the **device**.
5. Under **Diagnostic**, check the status:
- Depending on the device type, the mesh size and health, the Thread status can be **Child**, **Router**, or **Leader**.
![Thread status](/images/integrations/homekit_controller/homekit_controller_add_02.png)
- That's it. Your HomeKit device now communicates via Thread.

6
source/_integrations/logi_circle.markdown
View File

@ -23,15 +23,15 @@ The `logi_circle` implementation allows you to integrate your [Logi Circle](http
1. Navigate to the [Circle OAuth2 Client Request Form](https://docs.google.com/forms/d/184FUILJ10rVxotyOQR5DAiu6GcCbK31AZszUdzT1ybs).
2. Fill out your contact name and e-mail address.
3. For the User Visible Client Name, specify "Home Assistant"
3. Request the following scopes:
4. Request the following scopes:
- `circle:activities`
- `circle:accessories`
- `circle:live_image`
- `circle:live`
- `circle:notifications`
- `circle:summaries`
4. Request the `authorization_code` grant type.
5. For the redirect URI, specify your Home Assistant URL followed by `/api/logi_circle`. For example, if your Home Assistant URL is `https://abc123.ui.nabu.casa`, then request `https://abc123.ui.nabu.casa/api/logi_circle`. The redirect URI must meet the following criteria:
5. Request the `authorization_code` grant type.
6. For the redirect URI, specify your Home Assistant URL followed by `/api/logi_circle`. For example, if your Home Assistant URL is `https://abc123.ui.nabu.casa`, then request `https://abc123.ui.nabu.casa/api/logi_circle`. The redirect URI must meet the following criteria:
- The URL must be HTTPS with a SSL certificate issued by a trusted CA (i.e., trusted by normal browsers).
- At the time you submit your request to Logitech, you need to demonstrate that you have exclusive control of the fully qualified domain name in your redirect URI. An active Home Assistant instance at the redirect URI will suffice. If you don't want to expose your Home Assistant instance publicly, you may also place a static page at the redirect URI with a short message that you will manage redirection of the authorization token to your local Home Assistant instance. Free static hosts that issue subdomains for hosting (e.g., Netlify) are permitted.
- As the redirect URI must be public facing, no local/reserved TLDs are permitted (eg. .local, .localhost, .example, etc. are not allowed).

4
source/_integrations/lyric.markdown
View File

@ -25,9 +25,9 @@ The Honeywell Lyric integration integrates the Lyric thermostat platform into Ho
To set up this integration, you first **must** set up a developer account with Honeywell:
1. Go to the [developer site](https://developer.honeywellhome.com) and register with an account.
1. Next, create a [new app](https://developer.honeywellhome.com/user/me/apps/add) via the `My Apps` section.
2. Next, create a [new app](https://developer.honeywellhome.com/user/me/apps/add) via the `My Apps` section.
1. App Name: You can use any name here, but it must not contain special characters.
1. Callback URL: `https://my.home-assistant.io/redirect/oauth`
2. Callback URL: `https://my.home-assistant.io/redirect/oauth`
{% details "I have manually disabled My Home Assistant" %}

14
source/_integrations/meraki.markdown
View File

@ -16,13 +16,13 @@ Use your Meraki AP as device tracker. Note that Meraki will see all devices, not
### Prerequisites
1. Go to Network-wide/General page, and find the Location and scanning section.
1. Make sure analytics and Scanning API are both enabled.
1. Make note of the Validator string, which will be used in the `device_tracker` configuration.
1. Click **Add a Post URL**:
1. Set the Post URL to `https://YOUR_HOSTNAME/api/meraki`
1. Set the Secret to a randomly generated string, and make note of it for the `device_tracker` configuration.
1. Make sure the API Version is set to `2.0`.
1. Hit **Save** in the bottom right of the page.
2. Make sure analytics and Scanning API are both enabled.
3. Make note of the Validator string, which will be used in the `device_tracker` configuration.
4. Click **Add a Post URL**:
1. Set the Post URL to `https://YOUR_HOSTNAME/api/meraki`
2. Set the Secret to a randomly generated string, and make note of it for the `device_tracker` configuration.
3. Make sure the API Version is set to `2.0`.
4. Hit **Save** in the bottom right of the page.
## Configuration

38
source/_integrations/mqtt.markdown
View File

@ -73,8 +73,8 @@ MQTT broker settings are configured when the MQTT integration is first set up an
Add the MQTT integration, then provide your broker's hostname (or IP address) and port and (if required) the username and password that Home Assistant should use. To change the settings later, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. Select the MQTT integration.
1. Select **Configure**, then **Re-configure MQTT**.
2. Select the MQTT integration.
3. Select **Configure**, then **Re-configure MQTT**.
<div class='note'>
@ -129,9 +129,9 @@ A configured client certificate will only be active if broker certificate valida
To change the settings, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. Select the MQTT integration.
1. Select **Configure**, then **Re-configure MQTT**.
1. To open the MQTT options page, select **Next**.
2. Select the MQTT integration.
3. Select **Configure**, then **Re-configure MQTT**.
4. To open the MQTT options page, select **Next**.
### Discovery options
@ -157,8 +157,8 @@ mosquitto_pub -h 127.0.0.1 -t homeassistant/switch/1/on -m "Switch is ON"
Another way to send MQTT messages manually is to use the **MQTT** integration in the frontend. Choose "Settings" on the left menu, click "Devices & Services", and choose "Configure" in the "Mosquitto broker" tile. Enter something similar to the example below into the "topic" field under "Publish a packet" and press "PUBLISH" .
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. Select the Mosquitto broker integration, then select **Configure**.
1. Enter something similar to the example below into the **topic** field under **Publish a packet**. Select **Publish**.
2. Select the Mosquitto broker integration, then select **Configure**.
3. Enter something similar to the example below into the **topic** field under **Publish a packet**. Select **Publish**.
```bash
homeassistant/switch/1/power
@ -786,14 +786,14 @@ The MQTT integration will register the service `mqtt.publish` which allows publi
### Service `mqtt.publish`
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `topic` | no | Topic to publish payload to.
| `topic_template` | no | Template to render as topic to publish payload to.
| `payload` | yes | Payload to publish.
| `payload_template` | yes | Template to render as payload value.
| `qos` | yes | Quality of Service to use. (default: 0)
| `retain` | yes | If message should have the retain flag set. (default: false)
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------ |
| `topic` | no | Topic to publish payload to. |
| `topic_template` | no | Template to render as topic to publish payload to. |
| `payload` | yes | Payload to publish. |
| `payload_template` | yes | Template to render as payload value. |
| `qos` | yes | Quality of Service to use. (default: 0) |
| `retain` | yes | If message should have the retain flag set. (default: false) |
<p class='note'>
You must include either `topic` or `topic_template`, but not both. If providing a payload, you need to include either `payload` or `payload_template`, but not both.
@ -870,10 +870,10 @@ retain: true
Listen to the specified topic matcher and dumps all received messages within a specific duration into the file `mqtt_dump.txt` in your configuration folder. This is useful when debugging a problem.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `topic` | no | Topic to dump. Can contain a wildcard (`#` or `+`).
| `duration` | yes | Duration in seconds that we will listen for messages. Default is 5 seconds.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------- |
| `topic` | no | Topic to dump. Can contain a wildcard (`#` or `+`). |
| `duration` | yes | Duration in seconds that we will listen for messages. Default is 5 seconds. |
```yaml
topic: openzwave/#

112
source/_integrations/nest.markdown
View File

@ -55,10 +55,10 @@ Adding Nest to your Home Assistant instance can be done via the user interface,
{% details "Manual configuration steps" %}
1. Browse to your Home Assistant instance.
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. In the bottom right corner, select the
2. Go to **{% my integrations title="Settings > Devices & Services" %}**.
3. In the bottom right corner, select the
**{% my config_flow_start icon domain=page.ha_domain %}** button.
1. From the list, select **Nest** and follow the instructions on screen.
4. From the list, select **Nest** and follow the instructions on screen.
{% enddetails %}
@ -70,23 +70,23 @@ By the end of this section you will have a Cloud Project with the necessary APIs
1. Go to the [Google Cloud Console](https://console.developers.google.com/apis/credentials).
1. If this is your first time here, you likely need to create a new Google Cloud project. Click **Create Project** then **New
2. If this is your first time here, you likely need to create a new Google Cloud project. Click **Create Project** then **New
Project**.
![Screenshot of APIs and Services Cloud Console with no existing project](/images/integrations/nest/api_project_needed.png)
1. Give your Cloud Project a name then click **Create**.
3. Give your Cloud Project a name then click **Create**.
1. You will need to hold on to your *Cloud Project ID* to enable a subscription to receive updates from devices. Visit the [Cloud Console](https://console.cloud.google.com/home/dashboard) and copy the *Project ID* needed by Home Assistant.
4. You will need to hold on to your *Cloud Project ID* to enable a subscription to receive updates from devices. Visit the [Cloud Console](https://console.cloud.google.com/home/dashboard) and copy the *Project ID* needed by Home Assistant.
![Screenshot of success](/images/integrations/nest/console_project_id.png)
1. Go to [APIs & Services > Library](https://console.cloud.google.com/apis/library) where you can enable APIs.
5. Go to [APIs & Services > Library](https://console.cloud.google.com/apis/library) where you can enable APIs.
1. From the API Library search for [Smart Device management](https://console.cloud.google.com/apis/library/smartdevicemanagement.googleapis.com) and click **Enable**.
6. From the API Library search for [Smart Device management](https://console.cloud.google.com/apis/library/smartdevicemanagement.googleapis.com) and click **Enable**.
![Screenshot of Search for SDM API](/images/integrations/nest/enable_sdm_api.png)
1. From the API Library search for [Cloud Pub/Sub API](https://console.developers.google.com/apis/library/pubsub.googleapis.com) in the Cloud Console and click **Enable**.
7. From the API Library search for [Cloud Pub/Sub API](https://console.developers.google.com/apis/library/pubsub.googleapis.com) in the Cloud Console and click **Enable**.
You now have a cloud project ready for the next section to configure authentication with OAuth.
@ -99,25 +99,25 @@ your cloud project.
1. Go to the [Google API Console](https://console.developers.google.com/apis/credentials).
1. Click [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) and configure it.
2. Click [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) and configure it.
1. Select **External** (the only choice if you are not a G-Suite user) then click **Create**. While you are here, you may click the *Let us know what you think* to give Google's OAuth team any feedback about your experience configuring credentials for self-hosted software. They make regular improvements to this flow and appear to value feedback.
3. Select **External** (the only choice if you are not a G-Suite user) then click **Create**. While you are here, you may click the *Let us know what you think* to give Google's OAuth team any feedback about your experience configuring credentials for self-hosted software. They make regular improvements to this flow and appear to value feedback.
![Screenshot of OAuth consent screen creation](/images/integrations/nest/oauth_consent_create.png)
1. The *App Information* screen needs you to enter an **App name** and **User support email**, then enter your email again under **Developer contact email**. These are only shown while you later go through the OAuth flow to authorize Home Assistant to access your account. Click **Save and Continue**. Omit unnecessary information (e.g. logo) to avoid additional review by Google.
4. The *App Information* screen needs you to enter an **App name** and **User support email**, then enter your email again under **Developer contact email**. These are only shown while you later go through the OAuth flow to authorize Home Assistant to access your account. Click **Save and Continue**. Omit unnecessary information (e.g. logo) to avoid additional review by Google.
1. On the *Scopes* step click **Save and Continue**.
5. On the *Scopes* step click **Save and Continue**.
1. On the *Test Users* step, you need to add your Google Account (e.g., your @gmail.com address) to the list. Click *Save* on your test account then **Save and Continue** to finish the consent flow.
6. On the *Test Users* step, you need to add your Google Account (e.g., your @gmail.com address) to the list. Click *Save* on your test account then **Save and Continue** to finish the consent flow.
![Screenshot of OAuth consent screen test users](/images/integrations/nest/oauth_consent_test_users.png)
1. Navigate back to the *OAuth consent screen* and click **Publish App** to set the *Publishing status* is **In Production**.
7. Navigate back to the *OAuth consent screen* and click **Publish App** to set the *Publishing status* is **In Production**.
![Screenshot of OAuth consent screen production status](/images/integrations/nest/oauth_consent_production_status.png)
1. The warning says your *app will be available to any user with a Google Account* which refers to the fields you entered on the *App Information* screen if someone finds the URL. This does not expose your Google Account or Nest data.
8. The warning says your *app will be available to any user with a Google Account* which refers to the fields you entered on the *App Information* screen if someone finds the URL. This does not expose your Google Account or Nest data.
1. Make sure the status is not *Testing*, or you will get logged out every 7 days.
9. Make sure the status is not *Testing*, or you will get logged out every 7 days.
{% enddetails %}
@ -130,23 +130,23 @@ The steps below use *Web Application Auth* with *My Home Assistant* to handle Go
1. Navigate to the [Credentials](https://console.cloud.google.com/apis/credentials) page and click **Create Credentials**.
![Screenshot of APIs and Services Cloud Console](/images/integrations/nest/create_credentials.png)
1. From the drop-down list select *OAuth client ID*.
2. From the drop-down list select *OAuth client ID*.
![Screenshot of OAuth client ID selection](/images/integrations/nest/oauth_client_id.png)
1. Enter *Web Application* for the Application type.
3. Enter *Web Application* for the Application type.
1. Pick a name for your credential.
4. Pick a name for your credential.
1. Add **Authorized redirect URIs** end enter `https://my.home-assistant.io/redirect/oauth`
5. Add **Authorized redirect URIs** end enter `https://my.home-assistant.io/redirect/oauth`
1. Click *Create* to create the credential.
6. Click *Create* to create the credential.
![Screenshot of creating OAuth credentials](/images/integrations/nest/oauth_redirect_uri.png)
1. You should now be presented with an *OAuth client created* message.
7. You should now be presented with an *OAuth client created* message.
![Screenshot of OAuth Client ID and Client Secret](/images/integrations/nest/oauth_created.png)
1. You now have *OAuth Client ID* and *OAuth Client Secret* needed by Home Assistant. See [Application Credentials](/integrations/application_credentials) for more general detail about how Home Assistant manages credentials.
8. You now have *OAuth Client ID* and *OAuth Client Secret* needed by Home Assistant. See [Application Credentials](/integrations/application_credentials) for more general detail about how Home Assistant manages credentials.
{% enddetails %}
@ -157,25 +157,25 @@ Now that you have authentication configured, you will create a Nest Device Acces
1. Go to the [Device Access Registration](https://developers.google.com/nest/device-access/registration) page. Click on the button **[Go to the Device Access Console](https://console.nest.google.com/device-access/)**.
![Screenshot of Device Access Registration](/images/integrations/nest/device_access.png)
1. Check the box to "Accept the Terms of Service" and click **Continue to Payment** where you need to pay a fee (currently US$5).
2. Check the box to "Accept the Terms of Service" and click **Continue to Payment** where you need to pay a fee (currently US$5).
![Screenshot of accepting terms](/images/integrations/nest/accept_terms.png)
<div class='note'>
It is currently not possible to share/be invited to a home with a G-Suite account. Make sure that you pay the fee with an account that has access to your devices.
</div>
1. Now the [Device Access Console](https://console.nest.google.com/device-access/project-list) should be visible. Click on **Create project**.
3. Now the [Device Access Console](https://console.nest.google.com/device-access/project-list) should be visible. Click on **Create project**.
1. Give your Device Access project a name and click **Next**.
4. Give your Device Access project a name and click **Next**.
![Screenshot of naming a project](/images/integrations/nest/project_name.png)
1. Next you will be asked for an *OAuth client ID* which you created in the previous step and click **Next**.
5. Next you will be asked for an *OAuth client ID* which you created in the previous step and click **Next**.
![Screenshot of Device Access Console OAuth client ID](/images/integrations/nest/device_access_oauth_client_id.png)
1. Enable Events by clicking on **Enable** and **Create project**.
6. Enable Events by clicking on **Enable** and **Create project**.
![Screenshot of enabling events](/images/integrations/nest/enable_events.png)
1. You now have a *Device Access Project ID* needed by Home Assistant.
7. You now have a *Device Access Project ID* needed by Home Assistant.
{% enddetails %}
@ -190,28 +190,28 @@ Note that *OAuth for Apps* has been [deprecated](https://developers.googleblog.c
1. In Home Assistant, you should already be going through the setup flow. If not, go back and click the *My: Add Integration* button above to start the setup. The integration will ask you for all of the necessary integration configuration.
1. Once all configuration information is entered in Home Assistant, a new tab opens, allowing you to choose a Google account. This should be the same developer account you configured above.
2. Once all configuration information is entered in Home Assistant, a new tab opens, allowing you to choose a Google account. This should be the same developer account you configured above.
1. The *Google Nest permissions* screen will allow you to choose which devices to configure and lets you select devices from multiple homes. You likely want to enable everything, however, you can leave out any feature you do not wish to use with Home Assistant.
3. The *Google Nest permissions* screen will allow you to choose which devices to configure and lets you select devices from multiple homes. You likely want to enable everything, however, you can leave out any feature you do not wish to use with Home Assistant.
![Screenshot of Nest permissions authorization](/images/integrations/nest/oauth_approve.png)
1. You will get redirected to another account selection page.
4. You will get redirected to another account selection page.
1. You may see a warning screen that says *Google hasn't verified this app* since you just set up an un-verified developer workflow. Click *Continue* to proceed.
5. You may see a warning screen that says *Google hasn't verified this app* since you just set up an un-verified developer workflow. Click *Continue* to proceed.
![Screenshot OAuth warning](/images/integrations/nest/oauth_app_verification.png)
1. Then you will be asked to grant access to additional permissions. Click *Allow*.
6. Then you will be asked to grant access to additional permissions. Click *Allow*.
![Screenshot 1 of granting permissions](/images/integrations/nest/oauth_grant1.png)
![Screenshot 2 of granting permissions](/images/integrations/nest/oauth_grant2.png)
1. Confirm you want to allow persistent access to Home Assistant.
7. Confirm you want to allow persistent access to Home Assistant.
![Screenshot of OAuth confirmation](/images/integrations/nest/oauth_confirm.png)
1. You will now see a page hosted by *My Home Assistant* asking if you would like to *Link account to Home Assistant?* Click **Link Account** to continue.
8. You will now see a page hosted by *My Home Assistant* asking if you would like to *Link account to Home Assistant?* Click **Link Account** to continue.
1. If all went well, you are ready to go!
9. If all went well, you are ready to go!
![Screenshot of success](/images/integrations/nest/finished.png)
@ -422,12 +422,12 @@ To improve security and reduce phishing risk Google has [deprecated](https://dev
{% details "Reconfigure the integration %}
1. Make sure to upgrade to the latest version of Home Assistant.
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. The **Nest** integration should appear with alert.
2. Go to **{% my integrations title="Settings > Devices & Services" %}**.
3. The **Nest** integration should appear with alert.
![Screenshot of success](/images/integrations/nest/attention.png)
1. Click **Reconfigure**.
4. Click **Reconfigure**.
![Screenshot of success](/images/integrations/nest/deprecation.png)
@ -439,27 +439,27 @@ If the *Nest* integration does not have an Alert then you probably used *Web Aut
{% details "Create new Web Auth Application Credentials" %}
1. In the Home Assistant flow confirm your *Google Cloud Project ID* and proceed to the next step.
1. You will be prompted to enter new *Application Credentials*.
1. In another tab visit the [Google Cloud Console](https://console.cloud.google.com/apis/credentials)
1. On the *Credentials* page click **Create Credential**.
1. From the drop-down list select **OAuth client ID**.
1. Enter **Web Application** for the Application type.
1. Pick a new name for your credential.
1. Add **Authorized redirect URIs** end enter `https://my.home-assistant.io/redirect/oauth`
1. Click *Create* to create the credential.
1. You now have *OAuth Client ID* and *OAuth Client Secret* needed by Home Assistant.
1. Back in Home Assistant, you should now be prompted to create [Application Credentials](/integrations/application_credentials) where you will enter the *Client ID* and *Client Secret*.
2. You will be prompted to enter new *Application Credentials*.
3. In another tab visit the [Google Cloud Console](https://console.cloud.google.com/apis/credentials)
4. On the *Credentials* page click **Create Credential**.
5. From the drop-down list select **OAuth client ID**.
6. Enter **Web Application** for the Application type.
7. Pick a new name for your credential.
8. Add **Authorized redirect URIs** end enter `https://my.home-assistant.io/redirect/oauth`
9. Click *Create* to create the credential.
10. You now have *OAuth Client ID* and *OAuth Client Secret* needed by Home Assistant.
11. Back in Home Assistant, you should now be prompted to create [Application Credentials](/integrations/application_credentials) where you will enter the *Client ID* and *Client Secret*.
{% enddetails %}
{% details "Update Device Access Project" %}
1. Visit the [Device Access Console](https://console.nest.google.com/device-access/)
1. Select the *Device Access Project* used by *Home Assistant*
1. You need to then delete the old *OAuth Client ID* by clicking the Trash icon to unlink your Nest project from the deprecated Auth method.
1. Click the overflow menu `...` then *Add Client ID*
1. Enter the new *OAuth Client ID* for *Web App Auth* credentials
1. Back in Home Assistant confirm your *Device Access Project ID*
2. Select the *Device Access Project* used by *Home Assistant*
3. You need to then delete the old *OAuth Client ID* by clicking the Trash icon to unlink your Nest project from the deprecated Auth method.
4. Click the overflow menu `...` then *Add Client ID*
5. Enter the new *OAuth Client ID* for *Web App Auth* credentials
6. Back in Home Assistant confirm your *Device Access Project ID*
{% enddetails %}

11
source/_integrations/owntracks.markdown
View File

@ -21,7 +21,7 @@ By default, the integration listens for incoming messages from OwnTracks via HTT
## Configuration
1. To set up OwnTracks in Home Assistant, go to **{% my integrations title="Settings > Devices & Services" %}**.
1. Add the **OwnTracks** integration.
2. Add the **OwnTracks** integration.
- This will give you the **Webhook** URL as well as the **Encryption key** to use during mobile device configuration (below).
### Configuring the app - Android
@ -29,8 +29,8 @@ By default, the integration listens for incoming messages from OwnTracks via HTT
1. Install the [OwnTracks](https://play.google.com/store/apps/details?id=org.owntracks.android) application for Android.
- If you need a version of OwnTracks without Google Play Services, the "OSS" flavour is available [here](https://github.com/owntracks/android/releases).
1. In the app, open the sidebar and select **Preferences**, then **Connection**.
1. Change the following settings:
2. In the app, open the sidebar and select **Preferences**, then **Connection**.
3. Change the following settings:
- **Mode**: HTTP
- **Host**: `<URL given to you when setting up the integration>`
@ -45,9 +45,8 @@ By default, the integration listens for incoming messages from OwnTracks via HTT
### Configuring the app - iOS
1. [Install the OwnTracks application for iOS.](https://itunes.apple.com/us/app/owntracks/id692424691?mt=8)
1. In the OwnTracks app, tap the (i) in the top left and select **Settings**.
1. Change the following settings:
2. In the OwnTracks app, tap the (i) in the top left and select **Settings**.
3. Change the following settings:
- **Mode**: HTTP
- **URL**: `<URL given to you when setting up the integration>`

10
source/_integrations/roon.markdown
View File

@ -21,11 +21,11 @@ This integration uses Roon Core, a Roon application that runs on a machine on yo
## Configuration
1. From the Home Assistant front-end, go to {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **Roon** integration. Then, select **Configure**.
1. Home Assistant will then try to find your Roon Core - if it is successful it will display `Authorize HomeAssistant in Roon`. Select **Submit** and skip to step 4.
1. If your Roon Core is not automatically found, enter the `Hostname` or `IP address` for the Roon Core machine when requested and select **Submit**.
1. Home Assistant will then contact your Roon Core and ask to be authorized. You will need to enable this extension in the Room Application. Go to **Settings** and then **Extensions**. There, you will see an entry for Home Assistant with a button next to it. Select **Enable**.
1. Roon core will then provide Home Assistant with the details of your media players.
1. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
2. Home Assistant will then try to find your Roon Core - if it is successful it will display `Authorize HomeAssistant in Roon`. Select **Submit** and skip to step 4.
3. If your Roon Core is not automatically found, enter the `Hostname` or `IP address` for the Roon Core machine when requested and select **Submit**.
4. Home Assistant will then contact your Roon Core and ask to be authorized. You will need to enable this extension in the Room Application. Go to **Settings** and then **Extensions**. There, you will see an entry for Home Assistant with a button next to it. Select **Enable**.
5. Roon core will then provide Home Assistant with the details of your media players.
6. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
## Services

6
source/_integrations/sentry.markdown
View File

@ -28,9 +28,9 @@ Before configuring the Sentry integration, you'll need to get Sentry account and
Follow these steps to get the DSN:
1. Go to **Projects**.
1. Select **Create project**.
1. Fill out the **Give your project a name** and **choose Assign a Team** fields and select the **Create project** button.
1. Select the **Get your DSN** link in top of the page.
2. Select **Create project**.
3. Fill out the **Give your project a name** and **choose Assign a Team** fields and select the **Create project** button.
4. Select the **Get your DSN** link in top of the page.
- Your DSN is now visible and looks like <https://sdasdasdasdsadsadas@sentry.io/sdsdfsdf>
{% include integrations/config_flow.md %}

6
source/_integrations/sigfox.markdown
View File

@ -18,9 +18,9 @@ ha_integration_type: integration
Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following:
1. Log into [Sigfox backend](https://backend.sigfox.com)
1. Select `GROUP`
1. Select `API ACCESS`
1. Click on `new` and create new access entry
2. Select `GROUP`
3. Select `API ACCESS`
4. Click on `new` and create new access entry
## Configuration

214
source/_integrations/smartthings.markdown
View File

@ -36,28 +36,28 @@ ha_integration_type: integration
SmartThings is integrated into Home Assistant through the SmartThings Cloud API. The features of this integration include:
1. Controlling SmartThings devices as Home Assistant entities ([see platforms for supported devices and capabilities](#platforms)).
1. Entities automatically synchronized upon restart of Home Assistant when changed in SmartThings.
1. Support for multiple SmartThings accounts and locations with each represented as an integration instance in Home Assistant.
1. No brokers, bridges, or additional dependencies.
2. Entities automatically synchronized upon restart of Home Assistant when changed in SmartThings.
3. Support for multiple SmartThings accounts and locations with each represented as an integration instance in Home Assistant.
4. No brokers, bridges, or additional dependencies.
## Prerequisites
1. A SmartThings [personal access token](https://account.smartthings.com/tokens).
1. An internet accessible incoming webhook or active Home Assistant Cloud subscription.
2. An internet accessible incoming webhook or active Home Assistant Cloud subscription.
### Personal Access Token (PAT)
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. Enter a token name (can be whatever you want), for example, 'Home Assistant' and select the following authorized scopes:
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)
- Apps (all)
- Locations (all)
- Scenes (all)
- Schedules (all)
1. 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. 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.
### Webhook
@ -73,14 +73,14 @@ 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. Enter your Personal Access Token.
1. Select the SmartThings Location to add to Home Assistant.
1. On the window that opens:
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).
1. Optionally change the display name and click 'Done' at the bottom of the screen.
1. Authorize the integration by clicking 'Allow' on the bottom right of the screen.
1. Click 'Close Window' or close it manually.
1. Back in Home Assistant click 'Finish'.
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'.
<div class='note info'>
@ -110,13 +110,13 @@ The integration will trigger an event when a device with the [button](https://de
}
```
| Attribute | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. For multi-button devices, the current SmartThings API will no longer pass the ButtonNumber but use a child component_id for each button. The device handler installed on SmartThings must be able to create those child components. |
| `device_id` | The unique id of the device in SmartThings. This can be located in the Home Assistant device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
| `location_id` | The unique id of the location the device is part of. This can be found in the configuration entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
| `value` | Describes the action taken on the button. See the [button](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability reference for a list of possible values (not all are supported by every device). |
| `name` | The name given to the device in SmartThings. |
| Attribute | Description |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. For multi-button devices, the current SmartThings API will no longer pass the ButtonNumber but use a child component_id for each button. The device handler installed on SmartThings must be able to create those child components. |
| `device_id` | The unique id of the device in SmartThings. This can be located in the Home Assistant device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
| `location_id` | The unique id of the location the device is part of. This can be found in the configuration entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
| `value` | Describes the action taken on the button. See the [button](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability reference for a list of possible values (not all are supported by every device). |
| `name` | The name given to the device in SmartThings. |
Event data payloads are logged at the debug level, see [debugging](#debugging) for more information.
@ -140,15 +140,15 @@ Support for additional platforms will be added in the future.
The SmartThings Binary Sensor platform lets you view devices that have binary sensor-related capabilities. A Binary Sensor entity will be created for each attribute (below) supported by the device.
| Capability | Attribute | On-Value |
| ----------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
| Capability | Attribute | On-Value |
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
| [`accelerationSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#accelerationSensor) | `acceleration` | `active` |
| [`contactSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#contactSensor) | `contact` | `open` |
| [`filterStatus`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#filterStatus) | `filterStatus` | `replace` |
| [`filterStatus`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#filterStatus) | `filterStatus` | `replace` |
| [`motionSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#motionSensor) | `motion` | `active` |
| [`presenceSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#presenceSensor) | `presence` | `present` |
| [`tamperAlert`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#tamperAlert) | `tamper` | `detected` |
| [`valve`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) | `valve` | `open` |
| [`valve`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) | `valve` | `open` |
| [`waterSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#waterSensor) | `water` | `wet` |
### Climate
@ -159,25 +159,25 @@ The SmartThings Climate platform lets you control devices that have air conditio
For a SmartThings Air Conditioner to be represented by the climate platform, it must have all of the following required capabilities:
| Capability | Climate Features |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) (required) | `hvac mode`, `hvac action` |
| [`airConditionerFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerFanMode) (required) | `fan mode` |
| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (required) | `temperature` |
| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (required) | `target temp` |
| [`demandResponseLoadControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#demandResponseLoadControl) | `drlc_status_duration` (state attribute), `drlc_status_level` (state attribute), `drlc_status_override` (state attribute), `drlc_status_start` (state attribute) |
| Capability | Climate Features |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) (required) | `hvac mode`, `hvac action` |
| [`airConditionerFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerFanMode) (required) | `fan mode` |
| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (required) | `temperature` |
| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (required) | `target temp` |
| [`demandResponseLoadControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#demandResponseLoadControl) | `drlc_status_duration` (state attribute), `drlc_status_level` (state attribute), `drlc_status_override` (state attribute), `drlc_status_start` (state attribute) |
#### Thermostats
For a SmartThings thermostat to be represented by the climate platform, it must have all the capabilities from either "set a" _or_ "set b":
| Capability | Climate Features |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [`thermostat`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostat) (set a) | `hvac mode`, `hvac action`, `target temp high`, `target temp low` and `fan mode` |
| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) (set b) | `hvac mode` |
| Capability | Climate Features |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [`thermostat`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostat) (set a) | `hvac mode`, `hvac action`, `target temp high`, `target temp low` and `fan mode` |
| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) (set b) | `hvac mode` |
| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (seb b) | `target temp low` |
| [`thermostatHeatingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) (set b) | `target temp high` |
| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (set b) |
| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (set b) |
| [`thermostatOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `hvac action` |
| [`thermostatFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `fan mode` |
| [`relativeHumidityMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` (state attribute) |
@ -186,28 +186,28 @@ For a SmartThings thermostat to be represented by the climate platform, it must
The SmartThings Cover platform lets you control devices that have open/close related capabilities. For a device to be represented by the cover platform, it must have one of the capabilities from "set a" below.
| Capability | Cover Features |
| ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- |
| [`doorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#doorControl) (set a) | `open` and `close` |
| Capability | Cover Features |
| ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| [`doorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#doorControl) (set a) | `open` and `close` |
| [`garageDoorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#garageDoorControl) (seb a) | `open` and `close` |
| [`windowShade`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#windowShade) (set a) | `open` and `close` |
| [`switchLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `position` |
| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
| [`windowShade`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#windowShade) (set a) | `open` and `close` |
| [`switchLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `position` |
| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
### Fan
The SmartThings Fan platform lets you control devices that have fan-related capabilities. For a SmartThings device to be represented by the fan platform, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
| Capability | Fan Features |
| --------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| Capability | Fan Features |
| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| [`fanSpeed`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#fanSpeed) | `speed` (`off`, `low`, `medium`, and `high`) |
### Light
The SmartThings Light platform lets you control devices that have light-related capabilities. For a SmartThings device to be represented by the light platform, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
| Capability | Light Features |
| ------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| Capability | Light Features |
| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| [`switchLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `brightness` and `transition` |
| [`colorControl`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#colorControl) | `color` |
| [`colorTemperature`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#colorTemperature) | `color_temp` |
@ -220,62 +220,62 @@ The SmartThings Lock platform lets you control devices that have the [`lock`](ht
The SmartThings Sensor platform lets your view devices that have sensor-related capabilities. A Sensor entity is created for each attribute (below) supported by the device.
| Capability | Attributes |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [`activityLightingMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#activityLightingMode) | `lightingMode` |
| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) | `airConditionerMode` |
| [`airQualitySensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#airQualitySensor) | `airQuality` |
| [`alarm`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#alarm) | `alarm` |
| [`audioVolume`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#audioVolume) | `volume` |
| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery` |
| [`bodyMassIndexMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyMassIndexMeasurement) | `bmiMeasurement` |
| [`bodyWeightMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyWeightMeasurement) | `bodyWeightMeasurement` |
| [`carbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonDioxideMeasurement) | `carbonDioxide` |
| [`carbonMonoxideDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonMonoxideDetector) | `carbonMonoxide` |
| [`carbonMonoxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#carbonMonoxideMeasurement) | `carbonMonoxideLevel` |
| [`dishwasherOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dishwasherOperatingState) | `machineState`, `dishwasherJobState` and `completionTime` |
| [`dryerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerMode) | `dryerMode` |
| [`dryerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerOperatingState) | `machineState`, `dryerJobState` and `completionTime` |
| [`dustSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#dustSensor) | `fineDustLevel` and `dustLevel` |
| [`energyMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | `energy` |
| [`equivalentCarbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#equivalentCarbonDioxideMeasurement) | `equivalentCarbonDioxideMeasurement` |
| [`formaldehydeMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#formaldehydeMeasurement) | `formaldehydeLevel` |
| [`gasMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#gasMeter) | `gasMeter`, `meterCalorific`, `meterTime`, and `meterVolume` |
| [`illuminanceMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#illuminanceMeasurement) | `illuminance` |
| [`infraredLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#infraredLevel) | `infraredLevel` |
| [`lock`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) | `lock` |
| [`mediaInputSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaInputSource) | `inputSource` |
| [`mediaPlaybackRepeat`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackRepeat) | `playbackRepeatMode` |
| [`mediaPlaybackShuffle`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackShuffle) | `playbackShuffle` |
| [`mediaPlayback`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlayback) | `playbackStatus` |
| [`odorSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#odorSensor) | `odorLevel` |
| [`ovenMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenMode) | `ovenMode` |
| [`ovenOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenOperatingState) | `machineState`, `ovenJobState` and `completionTime` |
| [`ovenSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenSetpoint) | `ovenSetpoint` |
| [`powerConsumptionReport`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#powerConsumptionReport) | `deltaEnergy`, `energy`, `energySaved`, `power`, `powerEnergy` |
| [`powerMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | `power` |
| [`powerSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerSource) | `powerSource` |
| [`refrigerationSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#refrigerationSetpoint) | `refrigerationSetpoint` |
| [`relativeHumidityMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` |
| [`robotCleanerCleaningMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerCleaningMode) | `robotCleanerCleaningMode` |
| [`robotCleanerMovement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerMovement) | `robotCleanerMovement` |
| [`robotCleanerTurboMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerTurboMode) | `robotCleanerTurboMode` |
| [`signalStrength`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#signalStrength) | `lqi` and `rssi` |
| [`smokeDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#smokeDetector) | `smoke` |
| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) | `temperature` |
| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) | `coolingSetpoint` |
| [`thermostatFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `thermostatFanMode` |
| [`thermostatHeatingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) | `heatingSetpoint` |
| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) | `thermostatMode` |
| [`thermostatOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `thermostatOperatingState` |
| [`thermostatSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostatSetpoint) | `thermostatSetpoint` |
| [`threeAxis`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#threeAxis) | `threeAxis` (as discrete sensors `X`, `Y` and `Z`) |
| [`tvChannel`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#tvChannel) | `tvChannel` and `tvChannelName` |
| [`tvocMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#tvocMeasurement) | `tvocLevel` |
| [`ultravioletIndex`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#ultravioletIndex) | `ultravioletIndex` |
| [`voltageMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#voltageMeasurement) | `voltage` |
| [`washerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerMode) | `washerMode` |
| [`washerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerOperatingState) | `machineState`, `washerJobState` and `completionTime` |
| Capability | Attributes |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| [`activityLightingMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#activityLightingMode) | `lightingMode` |
| [`airConditionerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) | `airConditionerMode` |
| [`airQualitySensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#airQualitySensor) | `airQuality` |
| [`alarm`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#alarm) | `alarm` |
| [`audioVolume`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#audioVolume) | `volume` |
| [`battery`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery` |
| [`bodyMassIndexMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyMassIndexMeasurement) | `bmiMeasurement` |
| [`bodyWeightMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#bodyWeightMeasurement) | `bodyWeightMeasurement` |
| [`carbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonDioxideMeasurement) | `carbonDioxide` |
| [`carbonMonoxideDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#carbonMonoxideDetector) | `carbonMonoxide` |
| [`carbonMonoxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#carbonMonoxideMeasurement) | `carbonMonoxideLevel` |
| [`dishwasherOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dishwasherOperatingState) | `machineState`, `dishwasherJobState` and `completionTime` |
| [`dryerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerMode) | `dryerMode` |
| [`dryerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#dryerOperatingState) | `machineState`, `dryerJobState` and `completionTime` |
| [`dustSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#dustSensor) | `fineDustLevel` and `dustLevel` |
| [`energyMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | `energy` |
| [`equivalentCarbonDioxideMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#equivalentCarbonDioxideMeasurement) | `equivalentCarbonDioxideMeasurement` |
| [`formaldehydeMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#formaldehydeMeasurement) | `formaldehydeLevel` |
| [`gasMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#gasMeter) | `gasMeter`, `meterCalorific`, `meterTime`, and `meterVolume` |
| [`illuminanceMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#illuminanceMeasurement) | `illuminance` |
| [`infraredLevel`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#infraredLevel) | `infraredLevel` |
| [`lock`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) | `lock` |
| [`mediaInputSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaInputSource) | `inputSource` |
| [`mediaPlaybackRepeat`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackRepeat) | `playbackRepeatMode` |
| [`mediaPlaybackShuffle`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlaybackShuffle) | `playbackShuffle` |
| [`mediaPlayback`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#mediaPlayback) | `playbackStatus` |
| [`odorSensor`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#odorSensor) | `odorLevel` |
| [`ovenMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenMode) | `ovenMode` |
| [`ovenOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenOperatingState) | `machineState`, `ovenJobState` and `completionTime` |
| [`ovenSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#ovenSetpoint) | `ovenSetpoint` |
| [`powerConsumptionReport`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#powerConsumptionReport) | `deltaEnergy`, `energy`, `energySaved`, `power`, `powerEnergy` |
| [`powerMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | `power` |
| [`powerSource`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerSource) | `powerSource` |
| [`refrigerationSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#refrigerationSetpoint) | `refrigerationSetpoint` |
| [`relativeHumidityMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#relativeHumidityMeasurement) | `humidity` |
| [`robotCleanerCleaningMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerCleaningMode) | `robotCleanerCleaningMode` |
| [`robotCleanerMovement`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerMovement) | `robotCleanerMovement` |
| [`robotCleanerTurboMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#robotCleanerTurboMode) | `robotCleanerTurboMode` |
| [`signalStrength`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#signalStrength) | `lqi` and `rssi` |
| [`smokeDetector`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#smokeDetector) | `smoke` |
| [`temperatureMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) | `temperature` |
| [`thermostatCoolingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) | `coolingSetpoint` |
| [`thermostatFanMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatFanMode) | `thermostatFanMode` |
| [`thermostatHeatingSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatHeatingSetpoint) | `heatingSetpoint` |
| [`thermostatMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) | `thermostatMode` |
| [`thermostatOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatOperatingState) | `thermostatOperatingState` |
| [`thermostatSetpoint`](https://developer-preview.smartthings.com/docs/devices/capabilities/deprecated#thermostatSetpoint) | `thermostatSetpoint` |
| [`threeAxis`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#threeAxis) | `threeAxis` (as discrete sensors `X`, `Y` and `Z`) |
| [`tvChannel`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#tvChannel) | `tvChannel` and `tvChannelName` |
| [`tvocMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#tvocMeasurement) | `tvocLevel` |
| [`ultravioletIndex`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#ultravioletIndex) | `ultravioletIndex` |
| [`voltageMeasurement`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#voltageMeasurement) | `voltage` |
| [`washerMode`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerMode) | `washerMode` |
| [`washerOperatingState`](https://developer-preview.smartthings.com/docs/devices/capabilities/proposed#washerOperatingState) | `machineState`, `washerJobState` and `completionTime` |
### Scene
@ -285,8 +285,8 @@ The SmartThings Scene platform lets you activate scenes defined in SmartThings w
The SmartThings Switch platform lets you control devices that have the [`switch`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#switch) capability that are not already represented by a more specific platform. The following optional capabilities will provide energy and power utilization information:
| Capability | Switch Features |
| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| Capability | Switch Features |
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| [`energyMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | energy consumption (`today_energy_kwh` state attribute) |
| [`powerMeter`](https://developer-preview.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | power consumption (`current_power_w` state attribute) |
@ -330,8 +330,8 @@ This error message occurs when all of the SmartThings locations under the accoun
#### Webhook Troubleshooting Checklist
1. Ensure external URL is properly set to the _external address_ that Home Assistant is available to the internet. SmartThings must be able to reach this address.
1. Validate there are no problems with your certificate or SSL configuration by using an online checker, such as [https://www.digicert.com/help/](https://www.digicert.com/help/).
1. Some reverse proxy configuration settings can interfere with communication from SmartThings. For example, TLSv1.3 is not supported. Setting the supported cipher suite too restrictly will prevent handshaking. The following NGINX SSL configuration is known to work:
2. Validate there are no problems with your certificate or SSL configuration by using an online checker, such as [https://www.digicert.com/help/](https://www.digicert.com/help/).
3. Some reverse proxy configuration settings can interfere with communication from SmartThings. For example, TLSv1.3 is not supported. Setting the supported cipher suite too restrictly will prevent handshaking. The following NGINX SSL configuration is known to work:
```nginx
# cert.crt also contains intermediate certificates
ssl_certificate /path/to/cert.crt;
@ -345,7 +345,7 @@ This error message occurs when all of the SmartThings locations under the accoun
ssl_session_cache shared:SSL:10m;
ssl_session_tickets off;
```
1. While the error message (above) is being displayed, run the following command from outside your local network to confirm it is responding to the ping lifecycle event:
4. While the error message (above) is being displayed, run the following command from outside your local network to confirm it is responding to the ping lifecycle event:
```bash
curl -X POST https://{EXTERNAL_URL}/api/webhook/{WEBHOOK_ID} -H "Content-Type: application/json; charset=utf-8" -d $'{"lifecycle": "PING", "executionId": "00000000-0000-0000-0000-000000000000", "locale": "en", "version": "1.0.0", "pingData": { "challenge": "00000000-0000-0000-0000-000000000000"}}'
```

15
source/_integrations/telegram.markdown
View File

@ -24,10 +24,10 @@ To create your first [Telegram bot](https://core.telegram.org/bots#how-do-i-crea
- Follow the instructions on screen and give your bot a name.
- BotFather will give you a link to your new bot and an HTTP API token.
- Store the token somewhere safe.
1. To get a chat ID, send any message to the [GetIDs bot](https://t.me/getidsbot).
2. To get a chat ID, send any message to the [GetIDs bot](https://t.me/getidsbot).
- Then, enter `/start`.
- The bot will return your chat ID and the user name.
1. Create a [Telegram bot in Home Assistant](/integrations/telegram_bot):
3. Create a [Telegram bot in Home Assistant](/integrations/telegram_bot):
- Paste this into your [configuration file](/docs/configuration/):
- Replace the `api_key` and the `allowed_chat_ids` with your data.
@ -40,7 +40,7 @@ To create your first [Telegram bot](https://core.telegram.org/bots#how-do-i-crea
- 44441111
```
1. Create a notifier:
4. Create a notifier:
- Paste this into your configuration file:
- Replace the `name` and the `chat_id` with your data.
@ -53,9 +53,9 @@ To create your first [Telegram bot](https://core.telegram.org/bots#how-do-i-crea
```
- Restart Home Assistant.
1. From the conversation with BotFather, select the link to open a chat with your new bot.
1. In the chat with the new bot, enter `/start`.
1. Test the service:
5. From the conversation with BotFather, select the link to open a chat with your new bot.
6. In the chat with the new bot, enter `/start`.
7. Test the service:
- Go to [**Developer tools** > **Services** > **YAML mode**](https://my.home-assistant.io/redirect/developer_call_service/?service=homeassistant.turn_on).
- Paste this into the YAML file:
- Replace the `service` and the `message` with your data.
@ -67,8 +67,7 @@ To create your first [Telegram bot](https://core.telegram.org/bots#how-do-i-crea
```
- Select **Call service**. You should now get a message.
1. You can do more with this. Check out the configuration descriptions and examples below.
8. You can do more with this. Check out the configuration descriptions and examples below.
## Methods to retrieve a `chat_id`

8
source/_integrations/unifiprotect.markdown
View File

@ -119,10 +119,10 @@ you can stream your camera in Home Assistant. This may already be enabled by def
check that this is done. To check and enable the feature:
1. Open UniFi Protect and click on _Devices_.
1. Select the camera you want to ensure can stream in UniFi Protect.
1. Click the _Settings_ tab in the top right.
1. Expand the _Advanced_ section at the bottom.
1. Enable a minimum 1 stream out of the 3 available. The Stream with the Highest resolution is the default enabled one.
2. Select the camera you want to ensure can stream in UniFi Protect.
3. Click the _Settings_ tab in the top right.
4. Expand the _Advanced_ section at the bottom.
5. Enable a minimum 1 stream out of the 3 available. The Stream with the Highest resolution is the default enabled one.
{% include integrations/config_flow.md %}

8
source/_integrations/zha.markdown
View File

@ -387,10 +387,10 @@ Tip! It is highly recommended that you read through the two segments under the t
**To add a new Zigbee device:**
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. Select the **Zigbee Home Automation** integration. Then, select **Configure**.
1. To start a scan for new devices, on the bottom right corner of the screen, select **Add device**.
1. Reset your Zigbee devices to factory default settings according to the device instructions provided by the manufacturer (e.g., turn on/off lights up to 10 times; switches usually have a reset button/pin). It might take a few seconds for the devices to appear. You can click on **Show logs** for more verbose output.
1. Once the device is found, it will appear on that page and will be automatically added to your devices. You can optionally change its name and add it to an area (you can change this later). You can search again to add another device, or you can go back to the list of added devices.
2. Select the **Zigbee Home Automation** integration. Then, select **Configure**.
3. To start a scan for new devices, on the bottom right corner of the screen, select **Add device**.
4. Reset your Zigbee devices to factory default settings according to the device instructions provided by the manufacturer (e.g., turn on/off lights up to 10 times; switches usually have a reset button/pin). It might take a few seconds for the devices to appear. You can click on **Show logs** for more verbose output.
5. Once the device is found, it will appear on that page and will be automatically added to your devices. You can optionally change its name and add it to an area (you can change this later). You can search again to add another device, or you can go back to the list of added devices.
### Using router devices to add more devices

44
source/_integrations/zwave_js.markdown
View File

@ -64,7 +64,7 @@ For other ways to setup a Z-Wave server, refer to the [advanced installation ins
Follow these steps:
1. Open the Home Assistant user interface.
1. Plug the Z-Wave dongle into the device running Home Assistant.
2. Plug the Z-Wave dongle into the device running Home Assistant.
- Most likely, your dongle will be recognized automatically. On the user interface, you will be asked if you want to set up this device with the Z-Wave JS add-on. Select **Submit**.
- If your dongle is not recognized, follow these steps:
@ -83,12 +83,12 @@ Use this My button:
{% enddetails %}
3. Wait for the installation to complete.
1. You are prompted for network security keys.
4. You are prompted for network security keys.
- If you are using Z-Wave for the first time, leave all the fields empty and select **Submit**. The system will generate network security keys for you.
- If this Z-Wave dongle has already been paired with secure devices, you need to enter the previously used network key as the S0 network key. S2 security keys will be automatically generated for you.
- Make sure that you keep a backup of these keys in a safe place in case you need to move your Z-Wave dongle to another device. Copy and paste them somewhere safe.
1. Wait for the Z-Wave JS add-on to start up.
1. Once the installation is complete, the **Device info** of the Z-Wave controller is shown.
5. Wait for the Z-Wave JS add-on to start up.
6. Once the installation is complete, the **Device info** of the Z-Wave controller is shown.
- You successfully installed the Z-Wave integration and the Z-Wave JS add-on.
- You can now [add](/integrations/zwave_js/#adding-a-new-device-to-the-z-wave-network) devices to the Z-Wave network.
@ -99,30 +99,30 @@ While your Z-Wave mesh is permanently stored on your dongle, the additional meta
### Adding a new device to the Z-Wave network
1. In Home Assistant, go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. Select the Z-Wave integration. Then select **Configure**.
1. Select **Add device**.
2. Select the Z-Wave integration. Then select **Configure**.
3. Select **Add device**.
- The Z-Wave controller is now in inclusion mode.
1. If your device supports SmartStart (700 series controller), select **Scan QR code** and scan the QR code on your device.
1. If your device does not support SmartStart, set the device in inclusion mode. Refer to the device manual to see how this is done.
4. If your device supports SmartStart (700 series controller), select **Scan QR code** and scan the QR code on your device.
5. If your device does not support SmartStart, set the device in inclusion mode. Refer to the device manual to see how this is done.
- If your device is included using S2 security, you may be prompted to enter a PIN number provided with your device. Often, this PIN is provided with the documentation _and_ is also printed on the device itself. For more information on secure inclusion, refer to [this section](/integrations/zwave_js/#should-i-use-secure-inclusion).
1. The UI should confirm that the device was added. After a short while (seconds to minutes), the entities should also be created.
1. If the controller fails to add/find your device, cancel the inclusion process.
6. The UI should confirm that the device was added. After a short while (seconds to minutes), the entities should also be created.
7. If the controller fails to add/find your device, cancel the inclusion process.
- In some cases, it might help to first [remove](/integrations/zwave_js/#removing-a-device-from-the-z-wave-network) a device (exclusion) before you add it, even when the device has not been added to this Z-Wave network yet.
- Another approach would be to factory reset the device. Refer to the device manual to see how this is done.
**Important:**
1. **Do not move your Z-Wave stick to include devices.** This is no longer necessary and leads to broken routes.
1. **Do not initiate device inclusion from the Z-Wave stick itself.** This is no longer supported.
2. **Do not initiate device inclusion from the Z-Wave stick itself.** This is no longer supported.
### Removing a device from the Z-Wave network
1. In Home Assistant, go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. Select the **Z-Wave** integration. Then, select **Configure**.
1. Select **Remove device**, then **Start exclusion**.
2. Select the **Z-Wave** integration. Then, select **Configure**.
3. Select **Remove device**, then **Start exclusion**.
- The Z-Wave controller is now in exclusion mode.
1. Put the device you want to remove in exclusion mode. Refer to its manual how this is done.
1. The UI should confirm that the device was removed and the device and entities will be removed from Home Assistant.
4. Put the device you want to remove in exclusion mode. Refer to its manual how this is done.
5. The UI should confirm that the device was removed and the device and entities will be removed from Home Assistant.
## Special Z-Wave entities
@ -131,8 +131,8 @@ The Z-Wave integration provides several special entities, some of which are avai
### Entities available for every Z-Wave device
1. **Node status** sensor: This sensor shows the node status for a given Z-Wave device. The sensor is disabled by default. The available node statuses are explained in the [Z-Wave JS documentation](https://zwave-js.github.io/node-zwave-js/#/api/node?id=status). They can be used in state change automations. For example to ping a device when it is dead, or refresh values when it wakes up.
1. **Ping** button: This button can be pressed to ping a device. It is an alternative to the `zwave_js.ping` service.
1. **Controller/node statistics** sensors: Z-Wave JS collects statistics about communications between [nodes](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotstatistics-updatedquot) and the [controller](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=quotstatistics-updatedquot). The statistics can be used to troubleshoot RF issues in your environment. These statistics are available in the network configuration and device info panels. But they are also available as sensors which are disabled by default.
2. **Ping** button: This button can be pressed to ping a device. It is an alternative to the `zwave_js.ping` service.
3. **Controller/node statistics** sensors: Z-Wave JS collects statistics about communications between [nodes](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotstatistics-updatedquot) and the [controller](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=quotstatistics-updatedquot). The statistics can be used to troubleshoot RF issues in your environment. These statistics are available in the network configuration and device info panels. But they are also available as sensors which are disabled by default.
### Conditional entities
@ -861,8 +861,8 @@ If the interview is complete, then the device does not yet have a device file fo
When trying to determine why something isn't working as you expect, or when reporting an issue with the integration, it is helpful to know what Z-Wave JS sees as the current state of your Z-Wave network. To get a dump of your current network state, follow these steps:
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. Select the **Z-Wave** integration. Then, select the three dots.
1. From he dropdown menu, select **Download diagnostics**.
2. Select the **Z-Wave** integration. Then, select the three dots.
3. From he dropdown menu, select **Download diagnostics**.
### Interference issues
@ -873,9 +873,9 @@ Many users have reported issues with interference when the USB stick was directl
Z-Wave JS writes details to its logs. To access these logs, follow these steps:
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
1. Select the **Z-Wave** integration. Then, select **Configure**.
1. Open the **Logs** tab.
1. Make sure to keep this browser tab open. Otherwise the logging is not active.
2. Select the **Z-Wave** integration. Then, select **Configure**.
3. Open the **Logs** tab.
4. Make sure to keep this browser tab open. Otherwise the logging is not active.
## Z-Wave terminology

8
source/getting-started/onboarding.markdown
View File

@ -20,26 +20,26 @@ In this step, you will create the owner account of Home Assistant. This account
![Set your username and password.](/images/getting-started/username.png)
1. Enter a name for your home and define the location specific settings and the language of the user interface.
2. Enter a name for your home and define the location specific settings and the language of the user interface.
- To automatically populate these settings, select **Detect**.
- If you'd rather not send your location, you can set these values manually.
![Define your location specific settings.](/images/getting-started/onboarding_location.png)
1. Select which information you are willing to share.
3. Select which information you are willing to share.
- Sharing is disabled by default. However, we would like to encourage you to share some of this data.
- This information helps us to find out which platforms we need to support and where to focus our efforts.
- The data is anonymized and aggregated. To see the charts we generate out of this data, take a look at our [analytics page](https://analytics.home-assistant.io/).
![Share anonymized data](/images/getting-started/onboarding_share_anonymized_info.png)
1. Once you are done, select **Next**.
4. Once you are done, select **Next**.
- Home Assistant will then show any {% term devices %} it has discovered on your network.
- Don't be alarmed if you see fewer items than shown below; you can always manually add devices later.
![Discovery of devices on your network.](/images/getting-started/onboarding_devices.png)
1. Finally, select **Finish**.
5. Finally, select **Finish**.
- Now you're brought to the Home Assistant web interface. This screen will show all of your devices.
{% include getting-started/next_step.html step="Concepts & Terminologies" link="/getting-started/concepts-terminology/" %}

38
source/installation/raspberrypi.markdown
View File

@ -36,30 +36,30 @@ If Raspberry Pi Imager is not supported by your platform, you can use [Balena Et
1. Download and install the Raspberry Pi Imager on your computer as described under [https://www.raspberrypi.com/software/](https://www.raspberrypi.com/software/).
![Install Raspberry Pi Imager](/images/installation/rpi_imager.png)
1. Open the Raspberry Pi Imager.
2. Open the Raspberry Pi Imager.
![Open Raspberry Pi Imager](/images/installation/rpi-imager-start.png)
1. Choose the operating system:
3. Choose the operating system:
1. Select **Choose OS**.
1. Select **Other specific-purpose OS** > **Home assistants and home automation** > **Home Assistant**.
1. Choose the Home Assistant OS that matches your hardware (RPi&nbsp;3 or RPi&nbsp;4).
2. Select **Other specific-purpose OS** > **Home assistants and home automation** > **Home Assistant**.
3. Choose the Home Assistant OS that matches your hardware (RPi&nbsp;3 or RPi&nbsp;4).
![Choose the operating system](/images/installation/rpi-ha.gif)
1. Choose the storage:
4. Choose the storage:
1. Insert the SD card into the computer. Note: the contents of the card will be overwritten.
1. Select your SD card.
2. Select your SD card.
![Select the storage](/images/installation/rpi-select-sd-card.png)
1. Write the installer onto the SD card:
5. Write the installer onto the SD card:
1. To start the process, select **Write**.
1. Wait for the Home Assistant OS to be written to the SD card.
2. Wait for the Home Assistant OS to be written to the SD card.
![Select write](/images/installation/rpi-select-write.png)
1. Eject the SD card.
6. Eject the SD card.
### Start up your Raspberry Pi
1. Insert the SD card into your Raspberry Pi.
1. Plug in an Ethernet cable that is connected to the network.
1. Connect the power supply to start up the device.
2. Plug in an Ethernet cable that is connected to the network.
3. Connect the power supply to start up the device.
1. In the browser of your desktop system, within a few minutes you will be able to reach your new Home Assistant at <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>.
4. In the browser of your desktop system, within a few minutes you will be able to reach your new Home Assistant at <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>.
<div class="note">
If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at <a href="http://homeassistant:8123" target="_blank">homeassistant:8123</a> or `http://X.X.X.X:8123` (replace X.X.X.X with your Raspberry Pi’s IP address).
@ -79,11 +79,11 @@ With the Home Assistant Operating System installed and accessible, you can now c
Use this procedure if Raspberry Pi Imager is not supported by your platform.
1. Insert the SD card into the computer. Note: the contents of the card will be overwritten.
1. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>. You may need to run it with administrator privileges on Windows.
1. Select **Flash from URL**.
2. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>. You may need to run it with administrator privileges on Windows.
3. Select **Flash from URL**.
![Screenshot of the Etcher software showing flash from URL selected.](/images/installation/etcher1.png)
1. Copy the correct URL for the Raspberry Pi 3 or 4 (Note: there are 2 different links below!):
4. Copy the correct URL for the Raspberry Pi 3 or 4 (Note: there are 2 different links below!):
{% tabbed_block %}
{% for variant in site.installation.types[page.installation_type].variants %}
@ -101,13 +101,13 @@ _Select and copy the URL or use the "copy" button that appear when you hover it.
1. Paste the URL for the image into Balena Etcher and select **OK**.
![Screenshot of the Etcher software showing the URL bar with a URL pasted in.](/images/installation/etcher2.png)
1. When Balena Etcher has downloaded the image, select **Select target**.
2. When Balena Etcher has downloaded the image, select **Select target**.
![Screenshot of the Etcher software showing the select target button highlighted.](/images/installation/etcher3.png)
1. Select the SD card you want to use for your installation.
3. Select the SD card you want to use for your installation.
![Screenshot of the Etcher software showing teh targets available.](/images/installation/etcher4.png)
1. Select **Flash!** to start writing the image.
4. Select **Flash!** to start writing the image.
![Screenshot of the Etcher software showing the Flash button highlighted.](/images/installation/etcher5.png)
1. Once Balena Etcher has finished writing the image, you will see a confirmation.
5. Once Balena Etcher has finished writing the image, you will see a confirmation.
![Screenshot of the Etcher software showing that the installation has completed.](/images/installation/etcher6.png)

10
source/tag/index.markdown
View File

@ -11,8 +11,8 @@ You've reached this page because you navigated to an NFC, QR Code, or other URL-
If you arrived here after scanning a tag on iOS, and you have the [Home Assistant Companion App](https://companion.home-assistant.io) installed, you may need to activate Universal Links:
1. Long-press on [this link](https://www.home-assistant.io/tag/example_from_documentation)
1. Choose "Open in 'Home Assistant'"
1. Attempt to scan the tag again
2. Choose "Open in 'Home Assistant'"
3. Attempt to scan the tag again
If you do not have it, you must [install the iOS app](https://apps.apple.com/us/app/home-assistant/id1099568401?mt=8) for these tags to function.
@ -21,8 +21,8 @@ If you do not have it, you must [install the iOS app](https://apps.apple.com/us/
If you arrived here after scanning a tag on Android, and you have the [Home Assistant Companion App](https://companion.home-assistant.io) installed, you may need to change the link settings.
1. Launch Settings and navigate to "Apps & Notifications", revealing the "Advanced" section if necessary
1. Navigate to "Default apps" and then "Opening links"
1. Open the "Home Assistant" settings and choose "Clear defaults"
1. Attempt to scan the tag again, choosing to open in Home Assistant
2. Navigate to "Default apps" and then "Opening links"
3. Open the "Home Assistant" settings and choose "Clear defaults"
4. Attempt to scan the tag again, choosing to open in Home Assistant
If you do not have it, you must [install the Android app](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android) for these tags to function.

10
source/voice_control/custom_sentences.markdown
View File

@ -18,16 +18,16 @@ If you have not set up voice control yet, set up the hardware first. For instruc
### To add a custom sentence to trigger an automation
1. Under **{% my automations title="Settings > Automations & Scenes" %}**, in the bottom right corner, select **Create automation**.
1. In the **Trigger** drop-down menu, select **Sentence**.
1. Enter one or more sentences that you would like to trigger an automation.
2. In the **Trigger** drop-down menu, select **Sentence**.
3. Enter one or more sentences that you would like to trigger an automation.
- Do not use punctuation.
- You can add multiple sentences. They will then all trigger that automation.
![Add a custom sentence](/images/assist/sentence_trigger_01.png)
2. To test the automation, go to **Overview** and in the top right corner, open Assist.
4. To test the automation, go to **Overview** and in the top right corner, open Assist.
- Enter one of the sentences.
3. If it did not work out, checkout the [troubleshooting](/voice_control/troubleshooting/) section.
5. If it did not work out, checkout the [troubleshooting](/voice_control/troubleshooting/) section.
- One of the causes could be that the device you're targeting has not been exposed to Assist.
4. Pick up your voice control device and speak the custom sentence.
6. Pick up your voice control device and speak the custom sentence.
- Your automation should now be triggered.
## Setting up custom sentences in configuration.yaml

22
source/voice_control/thirteen-usd-voice-remote.markdown
View File

@ -31,7 +31,7 @@ Before you can use this device with Home Assistant, you need to install a bit of
<esp-web-install-button manifest="https://firmware.esphome.io/voice-assistant/m5stack-atom-echo/manifest.json"></esp-web-install-button>
- **For advanced users**: The configuration file is available on [GitHub](https://github.com/esphome/firmware/blob/main/voice-assistant/m5stack-atom-echo.yaml).
1. Connect the ATOM Echo to your computer.
2. Connect the ATOM Echo to your computer.
- In the popup window, view the available ports.
- Plug the USB-C cable into the ATOM Echo and connect it to your computer.
- In the pop-up window, there should now appear a new entry. Select this USB serial port and select **Connect**.
@ -40,42 +40,42 @@ Before you can use this device with Home Assistant, you need to install a bit of
- If no new port shows, your system may be missing a driver. Close the pop-up window.
- In the dialog, select the CH342 driver, install it, then **Try again**.
![Open My link](/images/assist/esp32-atom-flash-no-port.png)
1. Select **Install Voice Assistant**, then **Install**.
3. Select **Install Voice Assistant**, then **Install**.
- Follow the instructions provided by the installation wizard.
- Add the ATOM Echo to your Wi-Fi:
- When prompted, select your network from the list and enter the credentials to your 2.4&nbsp;GHz Wi-Fi network.
- Select **Connect**.
- The ATOM Echo now joined your network. Select **Add to Home Assistant**.
1. This opens the **My** link to Home Assistant.
4. This opens the **My** link to Home Assistant.
- If you have not used My Home Assistant before, you will need to configure it. If your Home Assistant URL is not accessible on `http://homeassistant.local:8123`, replace it with the URL to your Home Assistant instance.
- Open the link.
![Open My link](/images/assist/esp32-atom-flash-06.png)
1. Select **OK**.
5. Select **OK**.
![Set up ESPHome](/images/assist/esp32-atom-flash-07.png)
1. To add the newly discovered device, select the ATOM Echo from the list.
6. To add the newly discovered device, select the ATOM Echo from the list.
- Add your ATOM Echo to a room and select **Finish**.
1. You should now see the **ESPHome** integration.
7. You should now see the **ESPHome** integration.
![New ESPHome device discovered](/images/assist/m5stack-atom-echo-discovered-33.png)
1. Select the **ESPHome** integration. Under **Devices**, you should see the **M5Stack Atom Echo** listed.
8. Select the **ESPHome** integration. Under **Devices**, you should see the **M5Stack Atom Echo** listed.
![ATOM Echo discovered](/images/assist/m5stack-atom-echo-discovered-new-03.png)
- Your ATOM Echo is connected to Home Assistant over Wi-Fi. You can now move it to any place in your home with a USB power supply.
1. Congratulations! You can now voice control Home Assistant using a button with a built-in microphone. Now give some commands.
9. Congratulations! You can now voice control Home Assistant using a button with a built-in microphone. Now give some commands.
## Controlling Home Assistant over the ATOM Echo
1. Press and hold the flat button with rounded shape on your ATOM Echo.
- The rectangular button on the side is the reset button. Do not press that one.
- The LED should light up in blue.
1. Say a [supported voice command](/voice_control/builtin_sentences/). For example, *Turn off the light in the kitchen*.
2. Say a [supported voice command](/voice_control/builtin_sentences/). For example, *Turn off the light in the kitchen*.
- Make sure you’re using the area name exactly as you defined it in Home Assistant.
- You can also ask a question, such as
- *Is the front door locked?*
- *Which lights are on in the living room?*
1. Let go of the button.
3. Let go of the button.
- The LED should light up in green.
- Home Assistant will confirm the action.
1. Your command is not supported? [Add your own commands](/integrations/conversation/).
4. Your command is not supported? [Add your own commands](/integrations/conversation/).
## Troubleshooting

14
source/voice_control/troubleshooting.markdown
View File

@ -7,23 +7,23 @@ This section lists a few steps that may help you troubleshoot issues with Assist
## View debug information
1. Go to **Settings** > **Voice assistants**.
1. From the list of assistants, select your assistant.
2. From the list of assistants, select your assistant.
![Select your assistant](/images/assist/assistant-select.png)
1. In the dialog, select **Debug**.
3. In the dialog, select **Debug**.
![Open the debug dialog](/images/assist/assistant-debug-03.png)
1. At the top of the screen, from the dropdown menu, select the run you are interested in.
4. At the top of the screen, from the dropdown menu, select the run you are interested in.
![Debug speech-to-text](/images/assist/assistant-debug-02.png)
## Test if the phrase works without voice
1. [Open the debug view](#view-debug-information).
1. In the top right corner, select the icon.
2. In the top right corner, select the icon.
![Open the pipeline debug dialog](/images/assist/assistant-debug-04.png)
1. Select **Run text pipeline**.
3. Select **Run text pipeline**.
![Open the pipeline debug dialog](/images/assist/assistant-debug-pipeline-01.png)
1. Enter the phrase you want to test and select **Run**.
4. Enter the phrase you want to test and select **Run**.
![Open the pipeline debug dialog](/images/assist/assistant-debug-pipeline-02.png)
1. Check if it worked.
5. Check if it worked.
![Open the pipeline debug dialog](/images/assist/assistant-debug-pipeline-03.png)
- If the phrase does not work, try a variant. For example, if *Turn off the light* doesn't work, try: *Turn off the lights in the kitchen*.
- Check if your phrase is [supported](/voice_control/builtin_sentences/).

22
source/voice_control/using_tts_in_automation.markdown
View File

@ -5,15 +5,15 @@ title: "Using Piper TTS in automations"
This procedure shows you how to create a text-to-speech {% term action %}. For this, we use our local text-to-speech engine, Piper, and the media player {% term service %}. Home Assistant can then speak to you over your media player as part of an {% term automation %}.
1. Go to **{% my automations title="Settings > Automations & Scenes" %}**, and select **Create automation**.
1. Select **Create new automation**, then **Add action**.
1. From the drop-down menu, select **Play media** and select the media player you want to use for this automation.
2. Select **Create new automation**, then **Add action**.
3. From the drop-down menu, select **Play media** and select the media player you want to use for this automation.
![Select your media player](/images/assist/tts_select_media_player.png)
1. Select **Pick media**, then, select **Text-to-speech**.
![Select your media source](/images/assist/tts_select_media_source.png)
1. To use fully local text-to-speech processing, select **Piper**.
![Select Piper](/images/assist/tts_select_piper.png)
1. Enter the text you want to hear for this automation.
![Enter text to be spoken](/images/assist/tts_enter_text.png)
1. Your text-to-speech action is now ready to be used in your script or automation.
![Enter text to be spoken](/images/assist/tts_action.png)
1. Save your action.
4. Select **Pick media**, then, select **Text-to-speech**.
![Select your media source](/images/assist/tts_select_media_source.png)
5. To use fully local text-to-speech processing, select **Piper**.
![Select Piper](/images/assist/tts_select_piper.png)
6. Enter the text you want to hear for this automation.
![Enter text to be spoken](/images/assist/tts_enter_text.png)
7. Your text-to-speech action is now ready to be used in your script or automation.
![Enter text to be spoken](/images/assist/tts_action.png)
8. Save your action.

4
source/voice_control/voice_remote_expose_devices.markdown
View File

@ -8,8 +8,8 @@ This is to avoid that sensitive devices, such as locks and garage doors, can ina
## Exposing your devices to Assist
1. Go to **Settings** > **Voice assistants**.
1. Open the **Expose** tab.
2. Open the **Expose** tab.
![Expose entities tab](/images/assist/assistant-expose-01.png)
1. Select **Expose entities**.
3. Select **Expose entities**.
1. Select all entities you want to be able to control by voice.
![Expose entities tab](/images/assist/assistant-expose-02.png)

4
source/voice_control/voice_remote_local_assistant.markdown
View File

@ -47,8 +47,8 @@ For the quickest way to get your local Assist pipeline started, follow these ste
- Under **Text-to-speech**, select **piper**.
- Depending on your language, you may be able to select different language variants.
1. That's it. You ensured your voice commands can be processed locally on your device.
1. If you haven't done so yet, [expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices).
3. That's it. You ensured your voice commands can be processed locally on your device.
4. If you haven't done so yet, [expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices).
- Otherwise you won't be able to control them by voice.
## Fine-tuning Whisper and Piper for your setup

36
source/voice_control/worlds-most-private-voice-assistant.markdown
View File

@ -22,22 +22,22 @@ your smart home and issue commands and get responses.
1. Connect the RJ11 cable from the phone to the green socket on the Grandstream.
![Grandstream HT801 ports](/images/assist/grandstream-ht801-interfaces.png)
1. Connect the Grandstream to your network:
2. Connect the Grandstream to your network:
- Plug the Ethernet cable into the blue socket and connect it to your router.
1. Start up the Grandstream.
3. Start up the Grandstream.
- Connect the power supply.
- Once the Grandstream has booted, the two LEDs for power and Ethernet light up solid blue. The phone LED won't light up.
1. Identify the IP address of the Grandstream.
4. Identify the IP address of the Grandstream.
- If your phone has a star * key, you can get your phone to tell you it's IP address:
- Press *** (press the star key three times) and wait until you hear *Enter the menu option*.
- Press 02 and the phone will tell you its IP address.
- If your phone does not have a star * key, log onto your router to find the IP address.
1. Enter the IP address into a browser window and log onto the Grandstream *Device Configuration* software.
5. Enter the IP address into a browser window and log onto the Grandstream *Device Configuration* software.
- The default credentials are:
- **Username**: `admin`
- **Password**: `admin`
![Login to Grandstream](/images/assist/grandstream_login.png)
1. Open the **FXS Port** tab and in the **Offhook Auto-Dial** field, enter the Home Assistant IP address in the following format:
6. Open the **FXS Port** tab and in the **Offhook Auto-Dial** field, enter the Home Assistant IP address in the following format:
- \*47192\*168\*1\*100\*5060
![Define IP for autodial](/images/assist/grandstream_autodial.png)
- Note: instead of 192\*168\*1\*100\*, enter the IP address of your Home Assistant instance.
@ -49,17 +49,17 @@ your smart home and issue commands and get responses.
1. In Home Assistant, go to {% my config_flow_start domain="voip" title="**Settings** > **Devices & Services** > **Add integration**" %} and add the **Voice over IP** integration.
![Voice over IP integration](/images/assist/voip_install.png)
1. Once you see the integration, pick up the phone.
2. Once you see the integration, pick up the phone.
- You should now hear the message *This is your smart home speaking. Your phone is connected, but you must configure it within Home Assistant.*
- The integration should now include a device and entities.
![Voice over IP integration with device and entities](/images/assist/voip_device_available.png)
- Don't hear the voice? Try these [troubleshooting steps](/voice_control/worlds-most-private-voice-assistant/#troubleshoot-grandstream).
1. Allow calls.
3. Allow calls.
- Calls from new devices are blocked by default since voice commands could be used to control sensitive devices, such as locks and garage doors.
- In the **Voice over IP** integration, select the **device** link.
- To allow this phone to control your smart home, under **Configuration**, enable **Allow calls**.
![Voice over IP integration - allow calls](/images/assist/voip_configuration.png)
1. Congratulations! You set up your analog phone to work with Home Assistant. Now pick up the phone and control your device.
4. Congratulations! You set up your analog phone to work with Home Assistant. Now pick up the phone and control your device.
- Say a [supported voice command](/voice_control/builtin_sentences/). For example, *Turn off the light in the kitchen*.
- You can also ask a question, such as
- *Is the front door locked?*
@ -76,7 +76,7 @@ To reproduce this example, follow these steps:
Note: this procedure requires an OpenAI account. To just run the example, the free trial option is sufficient. No need to leave your credit card information.
1. [Set up an OpenAI account and install the OpenAI conversation](/integrations/openai_conversation/) integration.
1. Create a Mario personality.
2. Create a Mario personality.
- Once you installed the OpenAI Conversation integration, go to {% my integrations title="**Settings** > **Devices & Services**" %} and in OpenAI Conversation integration, the select **Configure**.
![Configure the OpenAI integration](/images/assist/assistant-openai-mario-config.png)
@ -85,16 +85,16 @@ Note: this procedure requires an OpenAI account. To just run the example, the fr
`You are Super Mario from Mario Bros. Be funny.` and select **Submit**.
![Add prompt for Mario personality](/images/assist/assistant-openai-mario-02.png)
1. Create a Mario assistant:
3. Create a Mario assistant:
- Under {% my voice_assistants title="**Settings** > **Voice assistants**" %}, select **Add assistant**.
- Give it a name, select a language and under **Conversation agent**, select the Mario OpenAI Conversation integration.
![Add a new assistant](/images/assist/assistant-openai-mario-04.png)
- Leave the other settings unchanged and select **Create**.
1. In the **Voice over IP** integration, under **Configuration**, select the Mario assistant you just created.
4. In the **Voice over IP** integration, under **Configuration**, select the Mario assistant you just created.
![VoIP: select OpenAI](/images/assist/assistant-openai-mario-03.png)
1. That's it! Pick up your phone and ask Mario a question.
1. You can repeat this with other characters. You can add as many OpenAI Conversation integrations as you would like.
5. That's it! Pick up your phone and ask Mario a question.
6. You can repeat this with other characters. You can add as many OpenAI Conversation integrations as you would like.
## Troubleshoot Grandstream
@ -105,10 +105,10 @@ If you’re unable to call Home Assistant, confirm the following settings in you
1. On the **FXS Port** tab, check the **Preferred Vocoder** list.
- Make sure that **OPUS** is selected for one of the choices:
![Vocoder OPUS option](/images/assist/grandstream_vocoder.png)
1. Under **OPUS Payload type**, make sure the value is `123`. It's the default option.
2. Under **OPUS Payload type**, make sure the value is `123`. It's the default option.
![Vocoder OPUS payload type](/images/assist/grandstream_opus_payload.png)
1. At the bottom of the page, select **Apply**.
1. Pick up the phone again and check if you hear the voice.
3. At the bottom of the page, select **Apply**.
4. Pick up the phone again and check if you hear the voice.
### The Voice over IP integration no longer works
@ -118,10 +118,10 @@ The [debug information](/voice_control/troubleshooting#view-debug-information) s
**Potential remedy**
1. Log onto the Grandstream *Device Configuration* software.
1. On the **Status** page, check if the **Hook** status changes from **On Hook** to **In Use** after you picked up the phone.
2. On the **Status** page, check if the **Hook** status changes from **On Hook** to **In Use** after you picked up the phone.
![Check the Grandstream status](/images/assist/grandstream-troubleshoot-10.png)
- The software is quite slow. Refresh the page and wait for a while before hanging up again.
1. If the status does not change, reboot the Grandstream and try calling Home Assistant again.
3. If the status does not change, reboot the Grandstream and try calling Home Assistant again.
## Other troubleshooting steps