mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-17 06:16:50 +00:00
Stefan
GitHub
parent
910cc1b4bc
commit
7717ed9800
@ -29,7 +29,7 @@ The Broadlink integration allows you to control and monitor Broadlink universal
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
### Entities and subdomains
|
||||
## Entities and subdomains
|
||||
|
||||
There is no more need to set up platforms, except for custom IR/RF switches. Once the device is configured, all entities will be created automatically.
|
||||
|
||||
@ -49,7 +49,6 @@ The `remote` entities allow you to learn and send codes with universal remotes.
|
||||
|
||||
Use `remote.learn_command` to learn IR and RF codes. These codes are grouped by device and stored as commands in the [storage folder](#Learned%20codes%20storage%20location). They can be sent with the `remote.send_command` service later.
|
||||
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------- |
|
||||
| `entity_id` | no | ID of the remote. |
|
||||
|
||||
@ -43,7 +43,6 @@ longitude:
|
||||
default: Your home zone longitude defined in your configuration.
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
### Area
|
||||
|
||||
@ -20,13 +20,16 @@ To load this component, add the following lines to your `configuration.yaml`:
|
||||
browser:
|
||||
```
|
||||
|
||||
#### Service `browser/browse_url`
|
||||
### Services
|
||||
|
||||
Once loaded, the `browser` platform will expose services that can be called to perform various actions.
|
||||
|
||||
Available services: `browser/browse_url`.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `url` | no | The URL to open.
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
To use this service, choose **Call Service** from the **Developer Tools**. Choose the service *browser/browse_url* from the list of **Available services:** and enter the URL into the **Service Data** field and hit **CALL SERVICE**.
|
||||
|
||||
@ -44,47 +44,47 @@ The Buienradar integration will set up separate sensor entities with more detail
|
||||
|
||||
The following entities will be created:
|
||||
|
||||
- **Station name**: The name of the selected meteo-station.
|
||||
- **Barometer forecast**: A numeric barametric forecast (1 to 7)
|
||||
- **Barometer forecast name**: "A textual representation of the barometer forecast (eg: Thunderstorms, Stable, etc.)."
|
||||
- **Condition code**: "A symbol and a unique code identifying the current weather condition ([a..z])."
|
||||
- **Condition**: A symbol and the current weather condition (`clear`, `cloudy`, `fog`, `rainy`, `snowy` or `lightning`).
|
||||
- **Condition detailed**: A symbol and detailed current weather condition (`clear`, `partlycloudy`, `cloudy`, `partlycloudy-fog`, `partlycloudy-light-rain`, `partlycloudy-rain`, `light-rain`, `rainy`, `snowy-rainy`, `partlycloudy-light-snow`, `partlycloudy-snow`, `light-snow`, `snowy`, `partlycloudy-lightning` or `lightning`).
|
||||
- **Condition exact**: A symbol with the full current weather condition (in English).
|
||||
- **Symbol**: A symbol for the current weather with the full current condition (in Dutch).
|
||||
- **Feel temperature**: "The current feel temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
|
||||
- **Humidity**: The relative humidity (%).
|
||||
- **Temperature**: "The current temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
|
||||
- **Ground temperature**: "The current ground temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
|
||||
- **Wind speed**: "The wind speed in [km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour)."
|
||||
- **Wind force**: "The wind speed/force in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale)."
|
||||
- **Wind direction**: "Where the wind is coming from: N (North), Z (south), NO (North-East), etc."
|
||||
- **Wind azimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.
|
||||
- **Pressure**: "The sea-level air pressure in [hPa](https://en.wikipedia.org/wiki/Hectopascal)."
|
||||
- **Visibility**: "Visibility in meters ([m](https://en.wikipedia.org/wiki/Metre))."
|
||||
- **Wind gust**: "The wind speed of wind gusts ([km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))."
|
||||
- **Precipation**: The amount of precipitation/rain in mm/h.
|
||||
- **Precipation forecast average**: The average expected precipitation/rain in mm/h within the given time-frame.
|
||||
- **Precipation forecast total**: The total expected precipitation/rain in mm within the given time-frame. The total expected rain in the configured time-frame will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with time-frame configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If time-frame is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
|
||||
- **Irradiance**: "Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2))."
|
||||
- **Rain last 24h**: The rain over the last 24 hours (in mm).
|
||||
- **Rain last hour**: The rain over the last hour (in mm).
|
||||
- **Temperature n days ahead**: "The forecasted temperature n days ahead (in [C](https://en.wikipedia.org/wiki/Celsius))."
|
||||
- **Minimum temperature n days ahead**: "The forecasted minimum temperature n days ahead (in [C](https://en.wikipedia.org/wiki/Celsius))."
|
||||
- **Rain chance n days ahead**: The forecasted chance for rain n days ahead (%).
|
||||
- **Sun chance n days ahead**: The forecasted chance for sun n days ahead (%).
|
||||
- **Rain n days ahead**: "The forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead; the average of minrain_1d and maxrain_1d."
|
||||
- **Minimum rain n days ahead**: "The minimum forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead."
|
||||
- **Maximum rain n days ahead**: "The maximum forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead."
|
||||
- **Wind azimuth n days ahead**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise for n days ahead. (derived from winddirection_1d)
|
||||
- **Wind direction n days ahead**: "Where the wind will be coming from n days ahead: N (North), Z (south), NO (North-East), etc."
|
||||
- **Wind force n days ahead**: "The expected windforce in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale) n days ahead."
|
||||
- **Wind speed n days ahead**: "The expected windspeed in [m/s](https://en.wikipedia.org/wiki/M/s) n days ahead (derived from windforce_1d)."
|
||||
- **Condition code n days ahead**: Symbol and condition code of the expected condition n days ahead.
|
||||
- **Condition n days ahead**: Symbol and expected condition n days ahead.
|
||||
- **Detailed condition n days ahead**: Symbol and detailed expected condition n days ahead.
|
||||
- **Full condition (english) n days ahead**: Symbol and full expected condition n days ahead (in English).
|
||||
- **Full condition (dutch) n days ahead**: Symbol and full expected condition n days ahead (in Dutch).
|
||||
- **Station name**: The name of the selected meteo-station
|
||||
- **Barometer forecast**: A numeric barometric forecast (1 to 7)
|
||||
- **Barometer forecast name**: A textual representation of the barometer forecast (eg: Thunderstorms, Stable, etc.)
|
||||
- **Condition code**: A symbol and a unique code identifying the current weather condition (`[a..z]`)
|
||||
- **Condition**: A symbol and the current weather condition (`clear`, `cloudy`, `fog`, `rainy`, `snowy` or `lightning`)
|
||||
- **Condition detailed**: A symbol and detailed current weather condition (`clear`, `partlycloudy`, `cloudy`, `partlycloudy-fog`, `partlycloudy-light-rain`, `partlycloudy-rain`, `light-rain`, `rainy`, `snowy-rainy`, `partlycloudy-light-snow`, `partlycloudy-snow`, `light-snow`, `snowy`, `partlycloudy-lightning` or `lightning`)
|
||||
- **Condition exact**: A symbol with the full current weather condition (in English)
|
||||
- **Symbol**: A symbol for the current weather with the full current condition (in Dutch)
|
||||
- **Feel temperature**: The current wind chill factor (in [°C](https://en.wikipedia.org/wiki/Celsius))
|
||||
- **Humidity**: The relative humidity (in %)
|
||||
- **Temperature**: The current temperature (in [°C](https://en.wikipedia.org/wiki/Celsius))
|
||||
- **Ground temperature**: The current ground temperature (in [°C](https://en.wikipedia.org/wiki/Celsius))
|
||||
- **Wind speed**: The wind speed (in [km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))
|
||||
- **Wind force**: The wind speed/force (in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale))
|
||||
- **Wind direction**: Where the wind is coming from: N (North), Z (south), NO (North-East), etc.
|
||||
- **Wind azimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise
|
||||
- **Pressure**: The sea-level air pressure (in [hPa](https://en.wikipedia.org/wiki/Hectopascal))
|
||||
- **Visibility**: Visibility (in [m](https://en.wikipedia.org/wiki/Metre))
|
||||
- **Wind gust**: The wind speed of wind gusts ([km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))
|
||||
- **Precipitation**: The amount of precipitation/rain (in mm/h)
|
||||
- **Precipitation forecast average**: The average expected precipitation/rain within the given time-frame (in mm/h)
|
||||
- **Precipitation forecast total**: The total expected precipitation/rain in mm within the given time-frame. The total expected rain in the configured time-frame will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with time-frame configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If time-frame is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
|
||||
- **Irradiance**: Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2))
|
||||
- **Rain last 24h**: The rain over the last 24 hours (in [mm](https://en.wikipedia.org/wiki/Millimeter))
|
||||
- **Rain last hour**: The rain over the last hour (in [mm](https://en.wikipedia.org/wiki/Millimeter))
|
||||
- **Temperature n days ahead**: The forecasted temperature n days ahead (in [°C](https://en.wikipedia.org/wiki/Celsius))
|
||||
- **Minimum temperature n days ahead**: The forecasted minimum temperature n days ahead (in [°C](https://en.wikipedia.org/wiki/Celsius))
|
||||
- **Rain chance n days ahead**: The forecasted chance for rain n days ahead (in %)
|
||||
- **Sun chance n days ahead**: The forecasted chance for sun n days ahead (in %)
|
||||
- **Rain n days ahead**: The forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead; the average of `Minimum rain n days ahead` and `Maximum rain n days ahead`
|
||||
- **Minimum rain n days ahead**: The minimum forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead
|
||||
- **Maximum rain n days ahead**: The maximum forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead
|
||||
- **Wind azimuth n days ahead**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise for n days ahead (derived from `Wind direction n days ahead`)
|
||||
- **Wind direction n days ahead**: Where the wind will be coming from n days ahead: N (North), Z (south), NO (North-East), etc.
|
||||
- **Wind force n days ahead**: The expected wind force (in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale)) n days ahead
|
||||
- **Wind speed n days ahead**: The expected wind speed (in [m/s](https://en.wikipedia.org/wiki/M/s)) n days ahead (derived from `Wind force n days ahead`)
|
||||
- **Condition code n days ahead**: Symbol and condition code of the expected condition n days ahead
|
||||
- **Condition n days ahead**: Symbol and expected condition n days ahead
|
||||
- **Detailed condition n days ahead**: Symbol and detailed expected condition n days ahead
|
||||
- **Full condition (english) n days ahead**: Symbol and full expected condition n days ahead (in English)
|
||||
- **Full condition (dutch) n days ahead**: Symbol and full expected condition n days ahead (in Dutch)
|
||||
|
||||
{% include integrations/option_flow.md %}
|
||||
|
||||
@ -98,5 +98,9 @@ timeframe:
|
||||
description: Minutes to look ahead for precipitation forecast sensors (minimum 5, maximum 120).
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
_[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
|
||||
Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission._
|
||||
<div class='note'>
|
||||
|
||||
**Usage statement**
|
||||
Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the [full usage statement](https://www.buienradar.nl/overbuienradar/gratis-weerdata) to confirm your use or to request permission.
|
||||
|
||||
</div>
|
||||
|
||||
@ -21,7 +21,6 @@ The `Preload stream` option will start the camera feed on Home Assistant startup
|
||||
Example showing the Preload Stream option in the camera dialog.
|
||||
</p>
|
||||
|
||||
|
||||
### Services
|
||||
|
||||
Once loaded, the `camera` platform will expose services that can be called to perform various actions.
|
||||
|
||||
@ -44,6 +44,7 @@ cast_downstairs_on_kitchen:
|
||||
view_path: downstairs
|
||||
service: cast.show_lovelace_view
|
||||
```
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `external_url` in your [configuration](/docs/configuration/basic).
|
||||
@ -145,7 +146,7 @@ Optional:
|
||||
|
||||
- `media_type`: Media type, e.g. `video/mp4`, `audio/mp3`, `image/jpeg`, defaults to `video/mp4`.
|
||||
|
||||
#### Example:
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
'cast_bubbleupnp_to_my_chromecast':
|
||||
@ -178,7 +179,7 @@ Optional:
|
||||
- `enqueue`: Enqueue only
|
||||
- `playlist_id`: Play video with `media_id` from this playlist
|
||||
|
||||
#### Example:
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
'cast_youtube_to_my_chromecast':
|
||||
@ -201,16 +202,18 @@ Optional:
|
||||
#### Media parameters
|
||||
|
||||
Mandatory:
|
||||
|
||||
- `app_name`: `supla`
|
||||
- `media_id`: Supla item ID
|
||||
|
||||
|
||||
Optional:
|
||||
|
||||
- `is_live`: Item is a livestream
|
||||
|
||||
#### Example:
|
||||
#### Example
|
||||
|
||||
Example values to cast the item at <https://www.supla.fi/audio/3601824>
|
||||
|
||||
```yaml
|
||||
'cast_supla_to_my_chromecast':
|
||||
alias: "Cast supla to My Chromecast"
|
||||
@ -258,7 +261,7 @@ Optional:
|
||||
|
||||
- `is_live`: Item is a live stream
|
||||
|
||||
#### Example:
|
||||
#### Example
|
||||
|
||||
Example values to cast [BBC Radio 1](https://www.bbc.co.uk/sounds/play/live:bbc_radio_one)
|
||||
|
||||
@ -290,8 +293,10 @@ This app doesn't retrieve its own metadata, so if you want the cast interface or
|
||||
|
||||
Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing video. E.g., [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover) shows:
|
||||
|
||||
2908kbps | dash (mf_cloudfront_dash_https)
|
||||
b09w70r2 | 960x540
|
||||
| | |
|
||||
| --- | --- |
|
||||
| 2908kbps | dash (mf_cloudfront_dash_https) |
|
||||
| b09w70r2 | 960x540 |
|
||||
|
||||
With b09w70r2 being the `media_id`
|
||||
|
||||
@ -306,7 +311,7 @@ Optional:
|
||||
|
||||
- `is_live`: Item is a live stream
|
||||
|
||||
#### Example:
|
||||
#### Example
|
||||
|
||||
Example values to cast [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover)
|
||||
|
||||
|
||||
@ -14,6 +14,8 @@ The Channels platform allows you to control [Channels](https://getchannels.com/)
|
||||
|
||||
Your favorite channels will appear as sources in the Source List in Home Assistant.
|
||||
|
||||
## Configuration
|
||||
|
||||
To add Channels to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -49,7 +51,6 @@ Seek forward by the number of seconds currently set in settings on the instance
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | String that points at `entity_id` of Channels app.
|
||||
|
||||
|
||||
### Service `seek_backward`
|
||||
|
||||
Seek backward by the number of seconds currently set in settings on the instance of Channels.
|
||||
|
||||
@ -14,17 +14,22 @@ ha_platforms:
|
||||
|
||||
The `cisco_webex_teams` notification platform allows you to deliver rich notifications from Home Assistant to [Cisco Webex Teams](https://www.webex.com/team-collaboration.html) (formerly known as Cisco Spark).
|
||||
|
||||
To use this notification platform you will need an app (bot) token. To obtain a token visit [Cisco Webex for Developers](https://developer.webex.com/).
|
||||
To use this notification platform you will need an app (bot) token. To obtain a token visit [Cisco Webex for Developers](https://developer.webex.com/).
|
||||
|
||||
* Detailed instructions can be found in the section titled **Creating a Webex Teams Bot** on the [Webex Teams bot documentation](https://developer.webex.com/docs/bots).
|
||||
|
||||
You also need to specify the `room_id` that you wish to post messages into. The `room_id` can be found in one of two ways:
|
||||
|
||||
1. Logging in at [Cisco Webex for Developers](https://developer.webex.com/) and navigate to `Documentation`>`API Reference`>`Messages` and select List Messages, or
|
||||
2. Log into the web client at [teams.webex.com](https://teams.webex.com/),
|
||||
* select the room (or create a new room),
|
||||
* then copying the room ID from the URL.
|
||||
|
||||
<strong>**Note:** you must add the bot email (in the format `mybot@webex.bot`) as a participant to the room specified above.</strong>
|
||||
1. Logging in at [Cisco Webex for Developers](https://developer.webex.com/) and navigate to `Documentation`>`API Reference`>`Messages` and select List Messages, or
|
||||
2. Log into the web client at [teams.webex.com](https://teams.webex.com/),
|
||||
* select the room (or create a new room),
|
||||
* then copying the room ID from the URL.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
You must add the bot email (in the format `mybot@webex.bot`) as a participant to the room specified above.
|
||||
|
||||
</div>
|
||||
|
||||
To enable this platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -39,7 +44,7 @@ notify:
|
||||
|
||||
## Rich Text Formatting
|
||||
|
||||
Webex Teams clients can render rich text via a whitelisted set of html tags.
|
||||
Webex Teams clients can render rich text via a whitelisted set of html tags.
|
||||
|
||||
For example, you could configure automations to display details in an easy to read fashion like so:
|
||||
|
||||
@ -113,8 +118,8 @@ Here are the automations for the above screenshot:
|
||||
The following is a list of the allowed html tags and attributes:
|
||||
|
||||
Tag | More Info
|
||||
--- | ---
|
||||
`<@personEmail:email@examplecompany.com>` | Used to tag another Webex Team user by email address.
|
||||
--- | ---
|
||||
`<@personEmail:email@examplecompany.com>` | Used to tag another Webex Team user by email address.
|
||||
`<a>` | Defines a hyperlink. Allows attribute `href`.
|
||||
`<blockquote>` | Defines a section that is quoted from another source. Allows attribute `class` with allowed values `danger`, `warning`, `info`, `primary`, `secondary`.
|
||||
`<b>` | Defines bold text.
|
||||
|
||||
@ -52,7 +52,6 @@ stations:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
Additional configuration samples:
|
||||
|
||||
@ -357,11 +357,11 @@ value_template:
|
||||
required: false
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Optimistic mode
|
||||
## Optimistic mode
|
||||
|
||||
If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic.
|
||||
|
||||
#### Using Templates
|
||||
## Using Templates
|
||||
|
||||
For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topics can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting.
|
||||
|
||||
@ -386,9 +386,9 @@ climate:
|
||||
|
||||
This will parse the incoming `"auto"` as JSON, resulting in `auto`. Obviously, in this case you could also just set `value_template: {% raw %}"{{ value_json }}"{% endraw %}`.
|
||||
|
||||
Similarly for `*_command_topic`s, a template can be specified to render the outgoing payloads on these topics.
|
||||
Similarly for `*_command_topic`s, a template can be specified to render the outgoing payloads on these topics.
|
||||
|
||||
### Example
|
||||
## Example
|
||||
|
||||
A full configuration example looks like the one below.
|
||||
|
||||
|
||||
@ -55,6 +55,7 @@ This platform uses the API from [ipify.org](https://www.ipify.org/) to set the p
|
||||
### Home Assistant Companion App
|
||||
|
||||
If you would like to use [iOS App](https://companion.home-assistant.io/) via Cloudflare set **Minimum TLS version as 1.2**, in order to do that, do the following:
|
||||
|
||||
1. Login to your [Cloudflare](https://dash.cloudflare.com/) account.
|
||||
2. Choose your domain.
|
||||
3. Click on the `SSL/TLS` icon.
|
||||
|
||||
@ -119,7 +119,7 @@ binary_sensor:
|
||||
payload_off: "fail"
|
||||
```
|
||||
|
||||
Consider to use the [`ping` sensor ](/integrations/ping#binary-sensor) as an alternative to the samples above.
|
||||
Consider to use the [ping sensor](/integrations/ping#binary-sensor) as an alternative to the samples above.
|
||||
|
||||
### Check if a system service is running
|
||||
|
||||
|
||||
@ -20,6 +20,7 @@ The Control4 integration allows you to control and monitor lights from your loca
|
||||
Before setting up, you should assign a static IP address/DHCP reservation on your router to your Control4 controller. Home Assistant must be able to communicate with the controller over the local network; 4Sight remote access is not supported.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Options
|
||||
|
||||
The Control4 integration offers additional options in **Configuration** -> **Integrations** -> **Control4** -> **Options**:
|
||||
|
||||
@ -94,7 +94,7 @@ intent_script:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
#### Service `conversation.process`
|
||||
## Service `conversation.process`
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------|
|
||||
|
||||
@ -34,10 +34,9 @@ Generate a Client ID and Client Secret on
|
||||
1. You will then be automatically taken to the OAuth consent screen, you do not need to add any scopes here so click `SAVE AND CONTINUE` to move to the `Test users` page. You will need to add the Gmail address you will be using with this integration as a test user before you will be allowed to use the API. Once you have added your email address under `Test users` click `SAVE AND CONTINUE` which will take to the 'Summary' page (you do not need to do anything here).
|
||||
1. Click Credentials in the menu on the left hand side of the screen, then click `+ Create credentials` (at the top of the screen), then select `OAuth client ID`.
|
||||
1. Set the Application type to `TV and Limited Input` and give this credential set a name (like "Home Assistant Credentials") then click 'Create'.
|
||||
1. You will then be presented with a pop-up saying 'OAuth client created' showing `Your Client ID` and `Your Client Secret`. Make a note of these (for example, copy and paste them into a text editor) as you will need to put these in your `configuration.yaml` file shortly. Once you have noted these strings, click `OK`. If you need to find these credentials again at any point then simply nagivate to `APIs & Services` > `Credentials` and you will see `Home Assistant Credentials` (or whatever you named them in the previous step) under `OAuth 2.0 Clident IDs`. To view both the `Client ID` and `Client secret`, click on the pencil icon, this will take you to the settings page for these credentials and the information will be on the right hand side of the page.
|
||||
1. You will then be presented with a pop-up saying 'OAuth client created' showing `Your Client ID` and `Your Client Secret`. Make a note of these (for example, copy and paste them into a text editor) as you will need to put these in your `configuration.yaml` file shortly. Once you have noted these strings, click `OK`. If you need to find these credentials again at any point then simply navigate to `APIs & Services` > `Credentials` and you will see `Home Assistant Credentials` (or whatever you named them in the previous step) under `OAuth 2.0 Clident IDs`. To view both the `Client ID` and `Client secret`, click on the pencil icon, this will take you to the settings page for these credentials and the information will be on the right hand side of the page.
|
||||
1. We need to double check that the "Google Calendar API" has been automatically enabled. To do this, select `Library` from the menu, then search for "Google Calendar API". If it is enabled you will see `API Enabled` with a green tick next to it. If it is not enabled, then enable it.
|
||||
|
||||
|
||||
If you will later be adding more scopes than just the "Google Calendar API" to the OAuth for this application, you will need to delete your token file under your Home Assistant Profile. You will lose your refresh token due to the re-authenticating to add more API access. It's recommended to use different authorizations for different pieces of Google.
|
||||
|
||||
## Troubleshooting
|
||||
@ -173,17 +172,15 @@ entities:
|
||||
default: true
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
|
||||
### Sensor attributes
|
||||
|
||||
- **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts.
|
||||
- **all_day**: `true`/`false` if this is an all day event. Will be `false` if there is no event found.
|
||||
- **message**: The event title with the `search` and `offset` values extracted. So in the above example for **offset_reached** the **message** would be set to `Very important meeting`
|
||||
- **description**: The event description.
|
||||
- **location**: The event Location.
|
||||
- **start_time**: Start time of event.
|
||||
- **end_time**: End time of event.
|
||||
- **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts.
|
||||
- **all_day**: `true`/`false` if this is an all day event. Will be `false` if there is no event found.
|
||||
- **message**: The event title with the `search` and `offset` values extracted. So in the above example for **offset_reached** the **message** would be set to `Very important meeting`
|
||||
- **description**: The event description.
|
||||
- **location**: The event Location.
|
||||
- **start_time**: Start time of event.
|
||||
- **end_time**: End time of event.
|
||||
|
||||
### Service `google.add_event`
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user