diff --git a/source/_integrations/ads.markdown b/source/_integrations/ads.markdown index 88788fea2d2..3fe52996f48 100644 --- a/source/_integrations/ads.markdown +++ b/source/_integrations/ads.markdown @@ -20,7 +20,7 @@ ha_platforms: ha_integration_type: integration --- -The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](https://www.beckhoff.hu/english.asp?twincat/default.htm) and other devices implementing this interface. +The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](https://www.beckhoff.com/en-en/products/automation/twincat/) and other devices implementing this interface. There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/counter.markdown b/source/_integrations/counter.markdown index 7c43cfadb1e..76921188162 100644 --- a/source/_integrations/counter.markdown +++ b/source/_integrations/counter.markdown @@ -18,7 +18,7 @@ The `counter` integration allows one to count occurrences fired by automations. The preferred way to configure counter helpers is via the user interface. To add one, go to **{% my helpers title="Settings -> Devices & Services -> Helpers" %}** and click the add button; -next choose the "**Counter**" option. +next choose the **{% my config_flow_start domain=counter title="Counter" %}** option. To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by diff --git a/source/_integrations/hunterdouglas_powerview.markdown b/source/_integrations/hunterdouglas_powerview.markdown index b23853631b8..2c9291ef121 100644 --- a/source/_integrations/hunterdouglas_powerview.markdown +++ b/source/_integrations/hunterdouglas_powerview.markdown @@ -178,7 +178,7 @@ Set the type for connected power source. Available options are Hardwired Power S ### Calling a Powerview Scene ``` yaml -alias: "blinds closed at night" +alias: "Blinds closed at night" trigger: platform: time at: "18:00:00" diff --git a/source/_integrations/input_boolean.markdown b/source/_integrations/input_boolean.markdown index 06c58a8f244..3aa88a2b5d2 100644 --- a/source/_integrations/input_boolean.markdown +++ b/source/_integrations/input_boolean.markdown @@ -22,7 +22,7 @@ automations by using them in their conditions. The preferred way to configure input boolean helpers is via the user interface, in which they are known as Toggle Helpers. To add one, go to **{% my helpers title="Settings -> Devices & Services -> Helpers" %}** and click the add button; -next choose the "**Toggle**" option. +next choose the **{% my config_flow_start domain=input_boolean title="Toggle" %}** option. To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by diff --git a/source/_integrations/input_button.markdown b/source/_integrations/input_button.markdown index e118a67f2fd..2c1582a4e7d 100644 --- a/source/_integrations/input_button.markdown +++ b/source/_integrations/input_button.markdown @@ -20,7 +20,7 @@ like an automation. The preferred way to configure button helpers is via the user interface. To add one, go to **{% my helpers title="Settings -> Devices & Services -> Helpers" %}** -and click the add button; next choose the "**Button**" option. +and click the add button; next choose the **{% my config_flow_start domain=input_button title="Button" %}** option. To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by diff --git a/source/_integrations/input_datetime.markdown b/source/_integrations/input_datetime.markdown index 4241c099b67..acadba486b3 100644 --- a/source/_integrations/input_datetime.markdown +++ b/source/_integrations/input_datetime.markdown @@ -16,9 +16,9 @@ The `input_datetime` integration allows the user to define date and time values that can be controlled via the frontend and can be used within automations and templates. -The preferred way to configure input datetime is via the user interface at **Settings** -> **Devices & Services** -> **Helpers**. Click the add button and then choose the **Date and/or time** option. +The preferred way to configure input datetime is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain=input_datetime title="Date and/or time" %}** option. -To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. +To be able to add **{% my helpers title="Helpers" %}** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `input_datetime:` to your `configuration.yaml` first, then you can use the UI. `input_datetime` can also be configured via YAML. To add three datetime inputs to your installation, diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown index ef0011ea2a7..7992d51b596 100644 --- a/source/_integrations/input_number.markdown +++ b/source/_integrations/input_number.markdown @@ -14,7 +14,7 @@ ha_integration_type: helper The `input_number` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. -The preferred way to configure an input number is via the user interface at **Settings** -> **Devices & Services** -> **Helpers**. Click the add button and then choose the **Number** option. +The preferred way to configure an input number is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain=input_number title="Number" %}** option. To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. If you removed `default_config:` from you configuration, you must add `input_number:` to your `configuration.yaml` first, then you can use the UI. diff --git a/source/_integrations/input_select.markdown b/source/_integrations/input_select.markdown index 838e64596be..45dea5f333a 100644 --- a/source/_integrations/input_select.markdown +++ b/source/_integrations/input_select.markdown @@ -14,7 +14,7 @@ ha_integration_type: helper The `input_select` integration allows the user to define a list of values that can be selected via the frontend and can be used within conditions of an automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. -The preferred way to configure an input select is via the user interface at **Settings** -> **Devices & Services** -> **Helpers**. Click the add button and then choose the **Dropdown** option. +The preferred way to configure an input select is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain=input_select title="Dropdown" %}** option. To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. If you removed `default_config:` from you configuration, you must add `input_select:` to your `configuration.yaml` first, then you can use the UI. diff --git a/source/_integrations/input_text.markdown b/source/_integrations/input_text.markdown index a78dd86a278..8062b4931a5 100644 --- a/source/_integrations/input_text.markdown +++ b/source/_integrations/input_text.markdown @@ -14,10 +14,10 @@ ha_integration_type: helper The `input_text` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). -The preferred way to configure an input text is via the user interface at **Settings** -> **Devices & Services** -> **Helpers**. Click the add button and then choose the **Text** option. +The preferred way to configure an input text is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain=input_text title="Text" %}** option. To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. -If you removed `default_config:` from you configuration, you must add `input_text:` to your `configuration.yaml` first, then you can use the UI. +If you removed `default_config:` from your configuration, you must add `input_text:` to your `configuration.yaml` first, then you can use the UI. It can also be configured via `configuration.yaml`: diff --git a/source/_integrations/lirc.markdown b/source/_integrations/lirc.markdown index 01bce63a6aa..12bec615c0e 100644 --- a/source/_integrations/lirc.markdown +++ b/source/_integrations/lirc.markdown @@ -9,9 +9,9 @@ ha_domain: lirc ha_integration_type: integration --- -[LIRC](http://www.lirc.org/) integration for Home Assistant allows you to receive signals from an infrared remote control and control actions based on the buttons you press. You can use them to set scenes or trigger any other [automation](/integrations/automation/). +[LIRC](https://www.lirc.org/) integration for Home Assistant allows you to receive signals from an infrared remote control and control actions based on the buttons you press. You can use them to set scenes or trigger any other [automation](/docs/automation/). -Sending IR commands is not supported in this integration (yet), but can be accomplished using the [shell_command component](/integrations/shell_command/) in conjunction with the `irsend` command. +Sending IR commands is not supported in this integration (yet), but can be accomplished using the [shell_command integration](/integrations/shell_command/) in conjunction with the `irsend` command. ## Installation @@ -36,9 +36,9 @@ For more information have a look at `/usr/share/doc/lirc/README.Debian.gz` where ## Configuring LIRC -Now teach LIRC about your particular remote control by preparing a lircd configuration file (`/etc/lirc/lircd.conf`). Search the [LIRC remote database](http://lirc.sourceforge.net/remotes/) for your model. If you can't find it, then you can always use the `irrecord` program to learn your remote. This will create a valid configuration file. Add as many remotes as you want by pasting them into the file. If `irrecord` doesn't work (e.g., for some air conditioner remotes), then the `mode2` program is capable of reading the codes in raw mode, followed by `irrecord -a` to extract hex codes. +Now teach LIRC about your particular remote control by preparing a lircd configuration file (`/etc/lirc/lircd.conf`). Search the [LIRC remote database](https://lirc.sourceforge.net/remotes/) for your model. If you can't find it, then you can always use the `irrecord` program to learn your remote. This will create a valid configuration file. Add as many remotes as you want by pasting them into the file. If `irrecord` doesn't work (e.g., for some air conditioner remotes), then the `mode2` program is capable of reading the codes in raw mode, followed by `irrecord -a` to extract hex codes. -Next, you have to make a `~/.lircrc` file that maps keypresses to system actions. The file has to be in the home dir of the user running Home Assistant, e.g., in `/home/homeassistant/.lircrc` if you're running in a virtual env. [The configuration](http://www.lirc.org/html/configure.html) is a bit tedious but it must be done. Use the `prog = home-assistant` for all keys you want to be recognized by Home Assistant. The values you set for `button` must be the same as in the `lircd.conf` file and the values you put for `config` entry will be the sensor value in Home Assistant when you press the button. An example may look like this: +Next, you have to make a `~/.lircrc` file that maps keypresses to system actions. The file has to be in the home dir of the user running Home Assistant, e.g., in `/home/homeassistant/.lircrc` if you're running in a virtual env. [The configuration](https://www.lirc.org/html/configure.html) is a bit tedious but it must be done. Use the `prog = home-assistant` for all keys you want to be recognized by Home Assistant. The values you set for `button` must be the same as in the `lircd.conf` file and the values you put for `config` entry will be the sensor value in Home Assistant when you press the button. An example may look like this: ```bash begin diff --git a/source/_integrations/python_script.markdown b/source/_integrations/python_script.markdown index cf764e30cbf..8b7de9877f9 100644 --- a/source/_integrations/python_script.markdown +++ b/source/_integrations/python_script.markdown @@ -23,7 +23,7 @@ This integration allows you to write Python scripts that are exposed as services Other imports like `min`, `max` are available as builtins. See the [python_script](https://github.com/home-assistant/core/blob/dev/homeassistant/components/python_script/__init__.py) source code for up-to-date information on the available objects inside the script. -[hass-api]: /developers/development_hass_object/ +[hass-api]: https://developers.home-assistant.io/docs/dev_101_hass/ [logger-api]: https://docs.python.org/3.7/library/logging.html#logger-objects
diff --git a/source/_integrations/schedule.markdown b/source/_integrations/schedule.markdown index b8fc078ccac..1ad04a09f4b 100644 --- a/source/_integrations/schedule.markdown +++ b/source/_integrations/schedule.markdown @@ -17,12 +17,12 @@ Home Assistant that can be used to trigger or make decisions in your automations and scripts. The preferred way to configure a schedule is via the user interface at -**Settings** -> **Devices & Services** -> **Helpers**. Click the add button -and then choose the **Schedule** option, or click the My button below. +**{% my helpers title="Settings > Devices & Services > Helpers." %}** Click the add button +and then choose the **{% my config_flow_start domain=schedule title="Schedule" %}** option, or click the My button below. {% include integrations/config_flow.md %} -To be able to add **Helpers** via the user interface you should +To be able to add **{% my helpers title="Helpers" %}** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. diff --git a/source/_integrations/statistics.markdown b/source/_integrations/statistics.markdown index 70d67be9df9..bf195114f26 100644 --- a/source/_integrations/statistics.markdown +++ b/source/_integrations/statistics.markdown @@ -119,7 +119,7 @@ sensor: {% configuration %} entity_id: - description: The source sensor to observe and compute statistical characteristics for. Only [sensors](/integrations/sensor/) and [binary sensor](/integrations/binary_sensor/) are supported. + description: The source sensor to observe and compute statistical characteristics for. Only [sensors](/integrations/sensor/) and [binary sensors](/integrations/binary_sensor/) are supported. required: true type: string name: diff --git a/source/_integrations/timer.markdown b/source/_integrations/timer.markdown index dcec1331815..0510cc73331 100644 --- a/source/_integrations/timer.markdown +++ b/source/_integrations/timer.markdown @@ -23,7 +23,7 @@ However, automations using the `timer.finished` event **will not** trigger if th
## Configuration -The preferred way to configure timer helpers is via the user interface at **Settings** -> **Devices & Services** -> **Helpers** and click the add button; next choose the **Timer** option. +The preferred way to configure timer helpers is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}** and click the add button; next choose the {% my config_flow_start domain=timer title="Timer" %} option. You can also click the following button to be redirected to the Helpers page of your Home Assistant instance. diff --git a/source/_integrations/torque.markdown b/source/_integrations/torque.markdown index 5015d4c64ff..0315b754782 100644 --- a/source/_integrations/torque.markdown +++ b/source/_integrations/torque.markdown @@ -29,7 +29,7 @@ Under the **Logging Preferences** header: Under the **Realtime Web Upload** header: - Check **Upload to web-server**. -- Enter `https://HOST/api/torque` or `https://@/HOST:PORT/api/torque` as the **Web-server URL**, where `HOST` and `PORT` are your externally accessible Home Assistant HTTP host. To use a Bearer Token, this has to be [SSL/TSL](/docs/ecosystem/certificates/). +- Enter `https://HOST/api/torque` or `https://@/HOST:PORT/api/torque` as the **Web-server URL**, where `HOST` and `PORT` are your externally accessible Home Assistant HTTP host. To use a Bearer Token, this has to be [SSL/TLS](/docs/ecosystem/certificates/). - Enable **Send https: Bearer Token** (available since Torque Pro 1.12.46) - Paste a Long-Lived Access Token from any Home Assistant user in **Set Bearer Token** field. - Enter an email address in **User Email Address** (this can be any non empty string you like). diff --git a/source/_integrations/traccar.markdown b/source/_integrations/traccar.markdown index f93bb96cd3f..f09b7b78931 100644 --- a/source/_integrations/traccar.markdown +++ b/source/_integrations/traccar.markdown @@ -80,7 +80,7 @@ monitored_conditions: required: false type: list event: - description: "Traccar events to include in the scan and fire within Home Assistant. *NOTE* For more info regarding Traccar events please refer to Traccar's documentation: https://www.traccar.org/documentation/events/." + description: "Traccar events to include in the scan and fire within Home Assistant. *NOTE* For more info regarding Traccar events please refer to [Traccar's documentation](https://www.traccar.org/events/)." required: false type: list keys: @@ -163,7 +163,7 @@ device_tracker: monitored_conditions: ['alarm', 'mycomputedattribute'] ``` -The parameter `event` allows you to import events from the traccar platform (https://www.traccar.org/documentation/events/) and fire them in your Home Assistant. It accepts a list of events to be monitored and imported and each event must be listed in lowercase snakecase. The events will be fired with the same event name defined in the aforementioned list preceded by the prefix `traccar_`. For example if you need to import the Traccar events `deviceOverspeed` and `deviceFuelDrop` in Home Assistant, you need to fill the `event` parameter with: +The parameter `event` allows you to import [events](https://www.traccar.org/events/) from the traccar platform and fire them in your Home Assistant. It accepts a list of events to be monitored and imported and each event must be listed in lowercase snakecase. The events will be fired with the same event name defined in the aforementioned list preceded by the prefix `traccar_`. For example if you need to import the Traccar events `deviceOverspeed` and `deviceFuelDrop` in Home Assistant, you need to fill the `event` parameter with: ```yaml device_tracker: