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-07-27 03:07:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

b and c integrations: minor style change (#29898)

Browse Source 
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
c0ffeeca7 2023-11-20 08:47:18 +01:00 committed by GitHub
parent 6d15eefafc
commit fad4989470
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
59 changed files with 153 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_integrations/baf.markdown
View File

@ -2,7 +2,7 @@
title: Big Ass Fans title: Big Ass Fans
description: Instructions on how to integrate BAF devices into Home Assistant. description: Instructions on how to integrate BAF devices into Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary sensor
- Climate - Climate
- Fan - Fan
- Light - Light
@ -40,11 +40,11 @@ Integrates [Big Ass Fans](https://www.bigassfans.com/) devices into Home Assista
### Binary sensor ### Binary sensor
For devices that support Auto Comfort and are running firmware 3.1 or later, an occupancy sensor entity is available. The sensor has a hold time of about 5 minutes and pushes state updates. For devices that support Auto Comfort and are running firmware 3.1 or later, an occupancy sensor {% term entity %} is available. The sensor has a hold time of about 5 minutes and pushes state updates.
### Climate ### Climate
For devices that support Auto Comfort, a climate entity allows adjusting the target temperature. For devices that support Auto Comfort, a climate {% term entity %} allows adjusting the target temperature.
### Number ### Number

6
source/_integrations/balboa.markdown
View File

@ -2,7 +2,7 @@
title: Balboa Spa Client title: Balboa Spa Client
description: Instructions on how to integrate Balboa Spa WiFi within Home Assistant. description: Instructions on how to integrate Balboa Spa WiFi within Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary sensor
- Climate - Climate
ha_release: 2021.12 ha_release: 2021.12
ha_iot_class: Local Push ha_iot_class: Local Push
@ -17,11 +17,11 @@ ha_config_flow: true
ha_integration_type: integration ha_integration_type: integration
--- ---
This integration adds support for [Balboa](https://www.balboawatergroup.com/) Spa WiFi Modules to be used within Home Assistant. The **Balboa Spa Client** {% term integration %} adds support for [Balboa](https://www.balboawatergroup.com/) Spa WiFi Modules to be used within Home Assistant.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
- Binary Sensor (Filter cycles and circulation pumps) - Binary sensor (Filter cycles and circulation pumps)
- Climate - Climate
## Compatible hardware ## Compatible hardware

2
source/_integrations/bayesian.markdown
View File

@ -2,7 +2,7 @@
title: Bayesian title: Bayesian
description: Instructions on how to integrate threshold Bayesian sensors into Home Assistant. description: Instructions on how to integrate threshold Bayesian sensors into Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary sensor
- Utility - Utility
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: 0.53 ha_release: 0.53

2
source/_integrations/bbox.markdown
View File

@ -3,7 +3,7 @@ title: Bbox
description: Instructions on how to integrate Bouygues Bbox routers into Home Assistant. description: Instructions on how to integrate Bouygues Bbox routers into Home Assistant.
ha_category: ha_category:
- Network - Network
- Presence Detection - Presence detection
- Sensor - Sensor
ha_release: 0.31 ha_release: 0.31
ha_iot_class: Local Polling ha_iot_class: Local Polling

4
source/_integrations/binary_sensor.markdown
View File

@ -1,8 +1,8 @@
--- ---
title: Binary Sensor title: Binary sensor
description: Instructions on how-to setup binary sensors with Home Assistant. description: Instructions on how-to setup binary sensors with Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary sensor
ha_release: 0.9 ha_release: 0.9
ha_quality_scale: internal ha_quality_scale: internal
ha_domain: binary_sensor ha_domain: binary_sensor

6
source/_integrations/binary_sensor.mqtt.markdown
View File

@ -1,8 +1,8 @@
--- ---
title: "MQTT Binary Sensor" title: "MQTT binary sensor"
description: "Instructions on how to integrate MQTT binary sensors within Home Assistant." description: "Instructions on how to integrate MQTT binary sensors within Home Assistant."
ha_category: ha_category:
- Binary Sensor - Binary sensor
ha_release: 0.9 ha_release: 0.9
ha_iot_class: Configurable ha_iot_class: Configurable
ha_domain: mqtt ha_domain: mqtt
@ -158,7 +158,7 @@ name:
description: The name of the binary sensor. Can be set to `null` if only the device name is relevant. description: The name of the binary sensor. Can be set to `null` if only the device name is relevant.
required: false required: false
type: string type: string
default: MQTT Binary Sensor default: MQTT binary sensor
object_id: object_id:
description: Used instead of `name` for automatic generation of `entity_id` description: Used instead of `name` for automatic generation of `entity_id`
required: false required: false

4
source/_integrations/binary_sensor.rest.markdown
View File

@ -1,8 +1,8 @@
--- ---
title: "RESTful Binary Sensor" title: "RESTful binary sensor"
description: "Instructions on how to integrate REST binary sensors into Home Assistant." description: "Instructions on how to integrate REST binary sensors into Home Assistant."
ha_category: ha_category:
- Binary Sensor - Binary sensor
ha_release: "0.10" ha_release: "0.10"
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: rest ha_domain: rest

4
source/_integrations/binary_sensor.rflink.markdown
View File

@ -1,8 +1,8 @@
--- ---
title: "RFLink Binary Sensor" title: "RFLink binary sensor"
description: "Instructions on how to integrate RFLink binary sensors into Home Assistant." description: "Instructions on how to integrate RFLink binary sensors into Home Assistant."
ha_category: ha_category:
- Binary Sensor - Binary sensor
ha_iot_class: Local Push ha_iot_class: Local Push
ha_release: 0.81 ha_release: 0.81
ha_domain: rflink ha_domain: rflink

6
source/_integrations/binary_sensor.xiaomi_aqara.markdown
View File

@ -1,8 +1,8 @@
--- ---
title: "Xiaomi Binary Sensor" title: "Xiaomi binary sensor"
description: "Instructions on how to setup the Xiaomi binary sensors within Home Assistant." description: "Instructions on how to setup the Xiaomi binary sensors within Home Assistant."
ha_category: ha_category:
- Binary Sensor - Binary sensor
ha_release: "0.50" ha_release: "0.50"
ha_iot_class: Local Push ha_iot_class: Local Push
ha_domain: xiaomi_aqara ha_domain: xiaomi_aqara
@ -342,7 +342,7 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac
{% endraw %} {% endraw %}
#### Vibration Sensor #### Vibration sensor
This automation toggles the living room lamp on vibration/tilt. This automation toggles the living room lamp on vibration/tilt.

2
source/_integrations/blackbird.markdown
View File

@ -2,7 +2,7 @@
title: Monoprice Blackbird Matrix Switch title: Monoprice Blackbird Matrix Switch
description: Instructions on how to integrate Monoprice Blackbird 4k 8x8 HDBaseT Matrix Switch into Home Assistant. description: Instructions on how to integrate Monoprice Blackbird 4k 8x8 HDBaseT Matrix Switch into Home Assistant.
ha_category: ha_category:
- Media Player - Media player
ha_release: 0.68 ha_release: 0.68
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: blackbird ha_domain: blackbird

18
source/_integrations/blink.markdown
View File

@ -3,7 +3,7 @@ title: Blink
description: Instructions for how to integrate Blink camera/security system within Home Assistant. description: Instructions for how to integrate Blink camera/security system within Home Assistant.
ha_category: ha_category:
- Alarm - Alarm
- Binary Sensor - Binary sensor
- Camera - Camera
- Hub - Hub
- Sensor - Sensor
@ -22,7 +22,7 @@ ha_dhcp: true
ha_integration_type: integration ha_integration_type: integration
--- ---
The `blink` integration lets you view camera images and motion events from [Blink](https://blinkforhome.com/) camera and security systems. The **Blink** {% term integration %} lets you view camera images and motion events from [Blink](https://blinkforhome.com/) camera and security systems.
## Setup ## Setup
@ -51,7 +51,7 @@ Please note that each camera reports two different states: one as `sensor.blink_
## Services ## Services
Any sequential calls to services relating to blink should have a minimum of a 5 second delay in between them to prevent the calls from being throttled and ignored. Any sequential calls to {% term services %} relating to blink should have a minimum of a 5 second delay in between them to prevent the calls from being throttled and ignored.
### `blink.blink_update` ### `blink.blink_update`
@ -89,7 +89,7 @@ Send a new pin to blink. Since Blink's 2FA implementation is new and changing,
| ---------------------- | -------- | ---------------------------- | | ---------------------- | -------- | ---------------------------- |
| `pin` | no | 2FA Pin received from blink. | | `pin` | no | 2FA Pin received from blink. |
### Other Services ### Other services
In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. Blink Mini cameras linked to an existing sync module cannot be armed/disarmed individually via Home Assistant. In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. Blink Mini cameras linked to an existing sync module cannot be armed/disarmed individually via Home Assistant.
@ -97,7 +97,7 @@ In addition to the services mentioned above, there are generic `camera` and `ala
The following are some examples showing how to correctly make service calls using Blink: The following are some examples showing how to correctly make service calls using Blink:
### Snap Picture and Save Locally ### Snap picture and save locally
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in Home Assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](/integrations/camera#service-snapshot) This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in Home Assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](/integrations/camera#service-snapshot)
@ -116,7 +116,7 @@ sequence:
filename: /tmp/my_image.jpg filename: /tmp/my_image.jpg
``` ```
### Arm Blink When Away ### Arm Blink when away
This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](/integrations/camera#service-enable_motion_detection) but please note that motion will only be captured if the sync module is armed. This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](/integrations/camera#service-enable_motion_detection) but please note that motion will only be captured if the sync module is armed.
@ -135,7 +135,7 @@ Here, this example assumes your blink module is named `My Sync Module` and that
entity_id: alarm_control_panel.blink_my_sync_module entity_id: alarm_control_panel.blink_my_sync_module
``` ```
### Disarm Blink When Home ### Disarm Blink when home
Similar to the previous example, this automation will disarm blink when arriving home. Similar to the previous example, this automation will disarm blink when arriving home.
@ -152,7 +152,7 @@ Similar to the previous example, this automation will disarm blink when arriving
entity_id: alarm_control_panel.blink_my_sync_module entity_id: alarm_control_panel.blink_my_sync_module
``` ```
### Save Most Recent Video Locally When Motion Detected ### Save most recent video locally when motion detected
When motion is detected, you can use the Blink Home Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data. When motion is detected, you can use the Blink Home Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data.
@ -176,7 +176,7 @@ The following example assumes your camera's name (in the Blink app) is `My Camer
{% endraw %} {% endraw %}
### Save All Recent Clips Locally on a Schedule ### Save all recent clips locally on a schedule
A list of all the recent video clips is updated at each refresh of the Blink system. A list of all the recent video clips is updated at each refresh of the Blink system.
The video clips are available in a download list (per camera) for up to an hour, The video clips are available in a download list (per camera) for up to an hour,

6
source/_integrations/bloomsky.markdown
View File

@ -2,7 +2,7 @@
title: BloomSky title: BloomSky
description: Instructions on how to integrate the BloomSky within Home Assistant. description: Instructions on how to integrate the BloomSky within Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary sensor
- Camera - Camera
- Environment - Environment
- Sensor - Sensor
@ -17,11 +17,11 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The `bloomsky` integration allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's. The **BloomSky** {% term integration %} allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor) - [Binary sensor](#binary-sensor)
- [Camera](#camera) - [Camera](#camera)
- [Sensor](#sensor) - [Sensor](#sensor)

2
source/_integrations/bluemaestro.markdown
View File

@ -22,6 +22,6 @@ Integrates [BlueMaestro](https://www.sigmawit.com/) devices into Home Assistant.
- Tempo Disc THD - Tempo Disc THD
- Tempo Disc THPD - Tempo Disc THPD
The BlueMaestro integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional. The **BlueMaestro** {% term integration %} will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}

2
source/_integrations/bluesound.markdown
View File

@ -2,7 +2,7 @@
title: Bluesound title: Bluesound
description: Instructions on how to integrate Bluesound devices into Home Assistant. description: Instructions on how to integrate Bluesound devices into Home Assistant.
ha_category: ha_category:
- Media Player - Media player
ha_release: 0.51 ha_release: 0.51
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: bluesound ha_domain: bluesound

8
source/_integrations/bluetooth.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
- diagnostics - diagnostics
--- ---
The Bluetooth integration will detect nearby Bluetooth devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel. The **Bluetooth** {% term integration %} will detect nearby Bluetooth devices. Discovered devices will show up in the discovered section on the integrations page in the configuration panel.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
@ -77,7 +77,7 @@ On Debian based host systems, the `sudo apt-get -y install bluez` command will i
{% enddetails %} {% enddetails %}
## Installing a USB Bluetooth Adapter ## Installing a USB Bluetooth adapter
Some systems may not come with Bluetooth and require a USB adapter. Installing an adapter for the first time may require multiple restarts for the device to be fully recognized. Some systems may not come with Bluetooth and require a USB adapter. Installing an adapter for the first time may require multiple restarts for the device to be fully recognized.
@ -85,7 +85,7 @@ If you experience an unreliable Bluetooth connection, installing a short USB ext
### Known working high-performance adapters ### Known working high-performance adapters
#### Cambridge Silicon Radio (CSR) Based adapters #### Cambridge Silicon Radio (CSR) -based adapters
- ANNE PRO CSR 4.0 (CSR8510A10) - ANNE PRO CSR 4.0 (CSR8510A10)
- Avantree BTDG-40S (CSR8510A10) - Avantree BTDG-40S (CSR8510A10)
@ -234,7 +234,7 @@ The following methods are known to work to add multiple adapters:
Integrations that have followed the [Best practices for library authors](https://developers.home-assistant.io/docs/bluetooth/?_highlight=Best+practices#best-practices-for-library-authors) will automatically connect via the adapter with the best signal and failover to an active adapter if one becomes unavailable. Integrations that have followed the [Best practices for library authors](https://developers.home-assistant.io/docs/bluetooth/?_highlight=Best+practices#best-practices-for-library-authors) will automatically connect via the adapter with the best signal and failover to an active adapter if one becomes unavailable.
## Passive Scanning ## Passive scanning
Passive Scanning on Linux can be enabled in the options flow per adapter if the host system runs BlueZ 5.63 or later with experimental features enabled. This functionality is available with Home Assistant Operating System 9.4 and later. Passive Scanning on Linux can be enabled in the options flow per adapter if the host system runs BlueZ 5.63 or later with experimental features enabled. This functionality is available with Home Assistant Operating System 9.4 and later.

4
source/_integrations/bluetooth_le_tracker.markdown
View File

@ -2,7 +2,7 @@
title: Bluetooth LE Tracker title: Bluetooth LE Tracker
description: Instructions for integrating bluetooth low-energy tracking within Home Assistant. description: Instructions for integrating bluetooth low-energy tracking within Home Assistant.
ha_category: ha_category:
- Presence Detection - Presence detection
ha_iot_class: Local Push ha_iot_class: Local Push
ha_release: 0.27 ha_release: 0.27
ha_domain: bluetooth_le_tracker ha_domain: bluetooth_le_tracker
@ -17,7 +17,7 @@ Devices discovered are stored with 'BLE_' as the prefix for device mac addresses
## Setup ## Setup
This integration requires the [Bluetooth](/integrations/bluetooth) integration to be enabled and functional. This {% term integration %} requires the [Bluetooth](/integrations/bluetooth) integration to be enabled and functional.
## Configuration ## Configuration

2
source/_integrations/bluetooth_tracker.markdown
View File

@ -2,7 +2,7 @@
title: Bluetooth Tracker title: Bluetooth Tracker
description: Instructions for integrating Bluetooth tracking within Home Assistant. description: Instructions for integrating Bluetooth tracking within Home Assistant.
ha_category: ha_category:
- Presence Detection - Presence detection
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: 0.18 ha_release: 0.18
ha_domain: bluetooth_tracker ha_domain: bluetooth_tracker

12
source/_integrations/bmw_connected_drive.markdown
View File

@ -2,13 +2,13 @@
title: BMW Connected Drive title: BMW Connected Drive
description: Instructions on how to setup your BMW Connected Drive account with Home Assistant. description: Instructions on how to setup your BMW Connected Drive account with Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary sensor
- Button - Button
- Car - Car
- Lock - Lock
- Notifications - Notifications
- Number - Number
- Presence Detection - Presence detection
- Select - Select
- Sensor - Sensor
- Switch - Switch
@ -33,19 +33,19 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The `bmw_connected_drive` integration lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account and a Connected Drive enabled vehicle for this to work. The **BMW Connected Drive** {% term integration %} lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account and a Connected Drive enabled vehicle for this to work.
The `bmw_connected_drive` integration also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work. The **BMW Connected Drive** {% term integration %} also works with (recent) Mini vehicles. You need to have a working Mini Connected account, and a Mini Connected enabled vehicle for this to work.
<div class='note'> <div class='note'>
The entities available in Home Assistant heavily depend on your vehicle's capabilities (model year, headunit, etc.). The integration will make sure all available car attributes are added as entities. The {% term entities %} available in Home Assistant heavily depend on your vehicle's capabilities (model year, headunit, etc.). The integration will make sure all available car attributes are added as entities.
</div> </div>
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/bimmerconnected/bimmer_connected) on GitHub. For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/bimmerconnected/bimmer_connected) on GitHub.
This integration provides the following platforms: This integration provides the following platforms:
- Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars). - Binary sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars).
- Device tracker: The location of your car. - Device tracker: The location of your car.
- [Lock](/integrations/bmw_connected_drive/#lock): Control the lock of your car. - [Lock](/integrations/bmw_connected_drive/#lock): Control the lock of your car.
- Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars). - Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars).

10
source/_integrations/bond.markdown
View File

@ -29,7 +29,7 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The Bond integration allows you to control appliances through your [Bond Bridge](https://bondhome.io/). Duplicates your RF remote control. The **Bond** {% term integration %} allows you to control appliances through your [Bond Bridge](https://bondhome.io/). Duplicates your RF remote control.
Supported devices (see Requirements section below): Supported devices (see Requirements section below):
@ -37,7 +37,7 @@ Supported devices (see Requirements section below):
- Shades - Shades
- Fireplaces - Fireplaces
## Tested Bond Devices ## Tested Bond devices
The following devices have been tested with Home Assistant and confirmed to be working: The following devices have been tested with Home Assistant and confirmed to be working:
@ -58,7 +58,7 @@ This integration supports Bond bridges with firmware v2.10.x and up.
Bond bridges with firmware v2.9.x and lower will **not** work correctly. Please Bond bridges with firmware v2.9.x and lower will **not** work correctly. Please
upgrade your firmware from Bond app before adding this integration. upgrade your firmware from Bond app before adding this integration.
## BPUP Support (Push updates) ## BPUP support (Push updates)
Firmware version 2.10.8 or newer is required for push updates. The integration Firmware version 2.10.8 or newer is required for push updates. The integration
will fallback to polling for 2.10.x versions lower than .8 will fallback to polling for 2.10.x versions lower than .8
@ -86,7 +86,7 @@ Calling this service will change the tracked power state of any bond switch but
### Service `bond.set_light_power_tracked_state` ### Service `bond.set_light_power_tracked_state`
Sets the tracked power state of a bond light. Sets the tracked power state of a bond light.
Calling this service will change the tracked power state of any bond light but not transmit any signal to make the device change its state. Calling this {% term service %} will change the tracked power state of any bond light but not transmit any signal to make the device change its state.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
@ -96,7 +96,7 @@ Calling this service will change the tracked power state of any bond light but n
### Service `bond.set_light_brightness_tracked_state` ### Service `bond.set_light_brightness_tracked_state`
Sets the tracked brightness state of a bond light Sets the tracked brightness state of a bond light
Calling this service will change the tracked brightness state of any bond light but not transmit any signal to make the device change its state. Calling this {% term service %} will change the tracked brightness state of any bond light but not transmit any signal to make the device change its state.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |

6
source/_integrations/bosch_shc.markdown
View File

@ -2,7 +2,7 @@
title: Bosch SHC title: Bosch SHC
description: Integrate Bosch SHC. description: Integrate Bosch SHC.
ha_category: ha_category:
- Binary Sensor - Binary sensor
- Cover - Cover
- Hub - Hub
- Sensor - Sensor
@ -22,11 +22,11 @@ ha_zeroconf: true
ha_integration_type: integration ha_integration_type: integration
--- ---
The Bosch SHC integration allows you to connect your [Bosch Smart Home Controller](https://www.bosch-smarthome.com) to Home Assistant in order to control and monitor your Bosch Smart Home devices. The **Bosch SHC** {% term integration %} allows you to connect your [Bosch Smart Home Controller](https://www.bosch-smarthome.com) to Home Assistant in order to control and monitor your Bosch Smart Home devices.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor) - [Binary sensor](#binary-sensor)
- [Cover](#cover) - [Cover](#cover)
- [Sensor](#sensor) - [Sensor](#sensor)
- [Switch](#switch) - [Switch](#switch)

4
source/_integrations/brandt.markdown
View File

@ -3,7 +3,7 @@ title: Brandt Smart Control
description: Connect and control your Brandt Smart Control devices using the Overkiz integration description: Connect and control your Brandt Smart Control devices using the Overkiz integration
ha_category: ha_category:
- Alarm - Alarm
- Binary Sensor - Binary sensor
- Button - Button
- Climate - Climate
- Cover - Cover
@ -16,7 +16,7 @@ ha_category:
- Sensor - Sensor
- Siren - Siren
- Switch - Switch
- Water Heater - Water heater
ha_domain: brandt ha_domain: brandt
ha_integration_type: virtual ha_integration_type: virtual
ha_supporting_domain: overkiz ha_supporting_domain: overkiz

10
source/_integrations/braviatv.markdown
View File

@ -3,7 +3,7 @@ title: Sony Bravia TV
description: Instructions on how to integrate a Sony Bravia TV into Home Assistant. description: Instructions on how to integrate a Sony Bravia TV into Home Assistant.
ha_category: ha_category:
- Button - Button
- Media Player - Media player
- Remote - Remote
ha_release: 0.23 ha_release: 0.23
ha_iot_class: Local Polling ha_iot_class: Local Polling
@ -20,7 +20,7 @@ ha_ssdp: true
ha_integration_type: device ha_integration_type: device
--- ---
The Bravia TV integration allows you to control a [Sony Bravia TV](https://www.sony.com/). The **Bravia TV** {% term integration %} allows you to control a [Sony Bravia TV](https://www.sony.com/).
Almost all [Sony Bravia TV 2013 and newer](https://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported. For older TVs see more generic methods to control your device [below](#for-tvs-older-than-2013). Almost all [Sony Bravia TV 2013 and newer](https://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported. For older TVs see more generic methods to control your device [below](#for-tvs-older-than-2013).
@ -41,16 +41,16 @@ For more information, see [IP Control Authentication](https://pro-bravia.sony.ne
If you have previously set up your TV with any Home Assistant instances via PIN code, you must remove Home Assistant from your TV in order for your TV to generate a new pin. To do this, you must do **one** of the following: If you have previously set up your TV with any Home Assistant instances via PIN code, you must remove Home Assistant from your TV in order for your TV to generate a new pin. To do this, you must do **one** of the following:
- On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance. - On your TV, go to: **Settings** > **Network** > **Remote device settings** > **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance.
- Reset your TV to factory condition. - Reset your TV to factory condition.
## Media browser ## Media browser
Using the Media Browser, you can view a list of all installed applications and TV channels and launch them. Using the media browser, you can view a list of all installed applications and TV channels and launch them.
## Play media service ## Play media service
The `play_media` service can be used in a automation or script to switch to a specified application or TV channel. It selects the best matching application or channel according to the `media_content_id`: The `play_media` {% term service %} can be used in a automation or script to switch to a specified application or TV channel. It selects the best matching application or channel according to the `media_content_id`:
1. Channel number *(i.e., '1' or '6')* 1. Channel number *(i.e., '1' or '6')*
2. Exact app or channel name *(i.e., 'Google Play' or 'CNN')* 2. Exact app or channel name *(i.e., 'Google Play' or 'CNN')*

16
source/_integrations/broadlink.markdown
View File

@ -23,7 +23,7 @@ ha_dhcp: true
ha_integration_type: integration ha_integration_type: integration
--- ---
The Broadlink integration allows you to control and monitor Broadlink universal remotes, smart plugs, power strips, switches and sensors. The following devices are supported: The **Broadlink** {% term integration %} allows you to control and monitor Broadlink universal remotes, smart plugs, power strips, switches and sensors. The following devices are supported:
- Power Strips: `MP1-1K3S2U` and `MP1-1K4S` - Power Strips: `MP1-1K3S2U` and `MP1-1K4S`
- Sensors: `e-Sensor` - Sensors: `e-Sensor`
@ -38,9 +38,9 @@ The Broadlink integration allows you to control and monitor Broadlink universal
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. 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.
The entities have the same name as the device by default. To change the name, icon or entity id, click the entity on the frontend and click the settings icon in the upper right. You can also disable the entity there if you don't think it is useful. Don't forget to click _Update_ to save your changes when you're done. The {% term entities %} have the same name as the device by default. To change the name, icon or entity id, select the entity on the frontend and select the settings icon in the upper right. You can also disable the entity there if you don't think it is useful. Don't forget to select **Update** to save your changes when you're done.
The entities are divided into four subdomains: The {% term entities %} are divided into four subdomains:
- [Remote](#remote) - [Remote](#remote)
- [Sensor](#sensor) - [Sensor](#sensor)
@ -49,7 +49,7 @@ The entities are divided into four subdomains:
## Remote ## Remote
The `remote` entities allow you to learn and send codes with universal remotes. They are created automatically when you configure devices with IR/RF capabilities. The `remote` {% term entities %} allow you to learn and send codes with universal remotes. They are created automatically when you configure devices with IR/RF capabilities.
### Learning commands ### Learning commands
@ -327,15 +327,15 @@ script:
## Sensor ## Sensor
The `sensor` entities allow you to monitor Broadlink sensors. These entities are created automatically when you configure a device that has sensors. The `sensor` {% term entities %} allow you to monitor Broadlink sensors. These entities are created automatically when you configure a device that has sensors.
## Light ## Light
The `light` entities allow you to control Broadlink lights. You can turn them on and off, change brightness, adjust the color or set a color temperature. These entities are created automatically when you configure a device that has lights. The `light` {% term entities %} allow you to control Broadlink lights. You can turn them on and off, change brightness, adjust the color or set a color temperature. These entities are created automatically when you configure a device that has lights.
## Switch ## Switch
The `switch` entities allow you to control and monitor Broadlink smart plugs, power strips and switches. You can turn them on and off, and you can monitor their state and power consumption, when available. These entities are created automatically when you configure a device that has switches. The `switch` {% term entities %} allow you to control and monitor Broadlink smart plugs, power strips and switches. You can turn them on and off, and you can monitor their state and power consumption, when available. These entities are created automatically when you configure a device that has switches.
You can also define custom IR/RF switches to be controlled with universal remote devices. You can also define custom IR/RF switches to be controlled with universal remote devices.
@ -552,7 +552,7 @@ First get or learn all the remotes you want to add to Home Assistant in e-Contro
This is the code we need to transmit again to replicate the same remote function. This is the code we need to transmit again to replicate the same remote function.
### Using Node red to Transmit Codes ### Using Node-RED to transmit codes
1. Drag another RM node on the same flow we created earlier. The RM node should be configured to the RM device created earlier by default. 1. Drag another RM node on the same flow we created earlier. The RM node should be configured to the RM device created earlier by default.
2. In the Action field, select - Set from msg.payload -. 2. In the Action field, select - Set from msg.payload -.

4
source/_integrations/brother.markdown
View File

@ -2,7 +2,7 @@
title: Brother Printer title: Brother Printer
description: Instructions on how to integrate a Brother printer into Home Assistant. description: Instructions on how to integrate a Brother printer into Home Assistant.
ha_category: ha_category:
- System Monitor - System monitor
ha_release: 0.104 ha_release: 0.104
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_config_flow: true ha_config_flow: true
@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: device ha_integration_type: device
--- ---
The `Brother Printer` integration allows you to read current data from your local Brother printer. The **Brother Printer** {% term integration %} allows you to read current data from your local Brother printer.
It usually provides information about the device's state, the left amount of ink or toner and the remaining lifetime of the drum or other parts of the printer. It usually provides information about the device's state, the left amount of ink or toner and the remaining lifetime of the drum or other parts of the printer.
The integration monitors every supported part. The integration monitors every supported part.

6
source/_integrations/browser.markdown
View File

@ -10,7 +10,7 @@ ha_domain: browser
ha_integration_type: integration ha_integration_type: integration
--- ---
The `browser` integration provides a service to open URLs in the default browser on the host machine. The **Browser** {% term integration %} provides a service to open URLs in the default browser on the host machine.
## Configuration ## Configuration
@ -23,7 +23,7 @@ browser:
### Services ### Services
Once loaded, the `browser` platform will expose services that can be called to perform various actions. Once loaded, the `browser` platform will expose {% term services %} that can be called to perform various {% term actions %}.
Available services: `browser/browse_url`. Available services: `browser/browse_url`.
@ -33,7 +33,7 @@ Available services: `browser/browse_url`.
### Usage ### 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**. To use this {% term 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**.
```json ```json
{"url": "http://www.google.com"} {"url": "http://www.google.com"}

2
source/_integrations/brunt.markdown
View File

@ -14,7 +14,7 @@ ha_config_flow: true
ha_integration_type: integration ha_integration_type: integration
--- ---
The `brunt` integration allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use it, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app. The **Brunt Blind Energy** {% term integration %} allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use it, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app.
<div class='note warning'> <div class='note warning'>
This integration is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk. This integration is not affiliated with Brunt and retrieves data from the endpoints of the mobile application. Use at your own risk.

2
source/_integrations/bsblan.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: device ha_integration_type: device
--- ---
This integration integrates [BSBLan](https://github.com/fredlcore/BSB-LAN) devices into Home Assistant. The **BSB-Lan** {% term integration %} integrates [BSBLan](https://github.com/fredlcore/BSB-LAN) devices into Home Assistant.
BSBLan is a device that is made by `Frederik Holst` and `Ulf Dieckmann` for documentation and with BSBLan is a device that is made by `Frederik Holst` and `Ulf Dieckmann` for documentation and with
the help of many other contributors. the help of many other contributors.

2
source/_integrations/bt_home_hub_5.markdown
View File

@ -2,7 +2,7 @@
title: BT Home Hub 5 title: BT Home Hub 5
description: Instructions on how to integrate BT Home Hub 5 router into Home Assistant. description: Instructions on how to integrate BT Home Hub 5 router into Home Assistant.
ha_category: ha_category:
- Presence Detection - Presence detection
ha_release: 0.22 ha_release: 0.22
ha_domain: bt_home_hub_5 ha_domain: bt_home_hub_5
ha_iot_class: Local Polling ha_iot_class: Local Polling

2
source/_integrations/bt_smarthub.markdown
View File

@ -2,7 +2,7 @@
title: BT Smart Hub title: BT Smart Hub
description: Instructions on how to integrate BT Smart Hub router into Home Assistant. description: Instructions on how to integrate BT Smart Hub router into Home Assistant.
ha_category: ha_category:
- Presence Detection - Presence detection
ha_release: 0.82 ha_release: 0.82
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_codeowners: ha_codeowners:

2
source/_integrations/bthome.markdown
View File

@ -26,4 +26,4 @@ BTHome is an energy effective but flexible BLE format to broadcast data with Blu
## Bindkey ## Bindkey
When using encryption for your BTHome sensor, you will prompted to enter your 32 character hexadecimal (16 bytes) encryption key. This key is called the bindkey. More information about the bindkey can be found in the [specifications](https://bthome.io/#encryption). When using encryption for your BTHome sensor, you will be prompted to enter your 32 character hexadecimal (16 bytes) encryption key. This key is called the bindkey. More information about the bindkey can be found in the [specifications](https://bthome.io/#encryption).

2
source/_integrations/bticino.markdown
View File

@ -8,7 +8,7 @@ ha_category:
- Environment - Environment
- Hub - Hub
- Light - Light
- Media Source - Media source
- Sensor - Sensor
- Switch - Switch
- Weather - Weather

2
source/_integrations/bubendorff.markdown
View File

@ -8,7 +8,7 @@ ha_category:
- Environment - Environment
- Hub - Hub
- Light - Light
- Media Source - Media source
- Sensor - Sensor
- Switch - Switch
- Weather - Weather

10
source/_integrations/buienradar.markdown
View File

@ -19,9 +19,9 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The Buienradar integration uses [buienradar.nl](https://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands. The **Buienradar** {% term integration %} uses [buienradar.nl](https://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands.
The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor integration). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor integration). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0).
Besides the weather platform, there is currently support for the following additional device types: Besides the weather platform, there is currently support for the following additional device types:
@ -37,13 +37,13 @@ The `buienradar` camera platform uses [buienradar.nl](https://buienradar.nl/) as
Internally, this integration uses the radar map image as [documented](https://www.buienradar.nl/overbuienradar/gratis-weerdata) on buienradar.nl. Internally, this integration uses the radar map image as [documented](https://www.buienradar.nl/overbuienradar/gratis-weerdata) on buienradar.nl.
The downloaded image is cached to prevent Home Assistant from making a new request to buienradar.nl multiple times a minute when Home Assistant checks for new stills from the camera. The downloaded image is cached to prevent Home Assistant from making a new request to buienradar.nl multiple times a minute when Home Assistant checks for new stills from the camera.
The camera entity is disabled by default and should be [enabled](/common-tasks/general/#enabling-entities) before it reads the camera images. The camera {% term entity %} is disabled by default and should be [enabled](/common-tasks/general/#enabling-entities) before it reads the camera images.
## Sensor ## Sensor
The Buienradar integration will set up separate sensor entities with more detailed weather data. The selected weather station will provide all-weather data, with the exception of the forecasted precipitation. The forecasted precipitation data will be retrieved from Buienradar using your actual GPS location (and not the location of the nearest weather station). The sensor entities are disabled by default and should be enabled before they will be updated with data. The **Buienradar** {% term integration %} will set up separate sensor {% term entities %} with more detailed weather data. The selected weather station will provide all-weather data, with the exception of the forecasted precipitation. The forecasted precipitation data will be retrieved from Buienradar using your actual GPS location (and not the location of the nearest weather station). The sensor entities are disabled by default and should be enabled before they will be updated with data.
The following entities will be created: The following {% term entities %} will be created:
- **Station name**: The name of the selected meteo-station - **Station name**: The name of the selected meteo-station
- **Barometer forecast**: A numeric barometric forecast (1 to 7) - **Barometer forecast**: A numeric barometric forecast (1 to 7)

10
source/_integrations/button.markdown
View File

@ -11,8 +11,8 @@ ha_codeowners:
ha_integration_type: entity ha_integration_type: entity
--- ---
A button entity is an entity that can fire an event / trigger an action towards A button {% term entity %} is an entity that can fire an {% term event %} / trigger an {% term action %} towards
a device or service but remains stateless from the Home Assistant perspective. a {% term device %} or {% term service %} but remains stateless from the Home Assistant perspective.
It can be compared to a real live momentary switch, push-button, or some other It can be compared to a real live momentary switch, push-button, or some other
form of a stateless switch. form of a stateless switch.
@ -21,14 +21,14 @@ form of a stateless switch.
## The state of a button ## The state of a button
The button entity is stateless, as in, it cannot have a state like the `on` or The button {% term entity %} is stateless, as in, it cannot have a state like the `on` or
`off` state that, for example, a normal switch entity has. `off` state that, for example, a normal switch entity has.
Every button entity does keep track of the timestamp of when the last time Every button entity does keep track of the timestamp of when the last time
the button entity has been pressed in the Home Assistant UI or pressed via the button entity has been pressed in the Home Assistant UI or pressed via
a service call. a service call.
Because the state of a button entity in Home Assistant is a timestamp, it Because the {% term state %} of a button entity in Home Assistant is a timestamp, it
means we can use it in our automations. For example: means we can use it in our automations. For example:
```yaml ```yaml
@ -43,7 +43,7 @@ action:
## Services ## Services
The button entities exposes a single service: {% my developer_call_service service="button.press" %} The button entities exposes a single {% term service %}: {% my developer_call_service service="button.press" %}
This service can be called to trigger a button press for that entity. This service can be called to trigger a button press for that entity.

2
source/_integrations/button.mqtt.markdown
View File

@ -1,5 +1,5 @@
--- ---
title: "MQTT Button" title: "MQTT button"
description: "Instructions on how to integrate MQTT buttons into Home Assistant." description: "Instructions on how to integrate MQTT buttons into Home Assistant."
ha_category: ha_category:
- Button - Button

24
source/_integrations/calendar.markdown
View File

@ -10,7 +10,7 @@ ha_codeowners:
ha_integration_type: entity ha_integration_type: entity
--- ---
The calendar integration provides calendar entities, allowing other integrations The **Calendar** {% term integration %} provides calendar {% term entities %}, allowing other integrations
to integrate calendars into Home Assistant. Calendars are shown on the calendar to integrate calendars into Home Assistant. Calendars are shown on the calendar
dashboard and can be used with automations. dashboard and can be used with automations.
@ -20,25 +20,25 @@ integrations page to find integration offering calendar entities.
{% include integrations/building_block_integration.md %} {% include integrations/building_block_integration.md %}
A calendar entity has a state and attributes representing the next event (only). A calendar {% term entity %} has a {% term state %} and attributes representing the next event (only).
A calendar trigger is much more flexible, has fewer limitations, and is A calendar {% term trigger %} is much more flexible, has fewer limitations, and is
recommended for automations instead of using the entity state. recommended for automations instead of using the entity state.
## Viewing and managing calendars ## Viewing and managing calendars
Each calendar is represented as its own entity in Home Assistant and can be Each calendar is represented as its own {% term entity %} in Home Assistant and can be
viewed and managed on a calendar dashboard. You can find the calendar dashboard viewed and managed on a calendar dashboard. You can find the calendar dashboard
in the main sidebar of your Home Assistant instance. in the main sidebar of your Home Assistant instance.
Some calendar integrations allow Home Assistant to manage your calendars Some calendar integrations allow Home Assistant to manage your calendars
directly from Home Assistant. In this case, you can add new events by clicking directly from Home Assistant. In this case, you can add new events by selecting
the “Add event” button in the lower right corner of the calendar dashboard. the **Add event** button in the lower right corner of the calendar dashboard.
Also see [Services](#services) below. Also see [Services](#services) below.
## Automation ## Automation
Calendar [Triggers](/docs/automation/trigger) enable automation based on an Calendar [Triggers](/docs/automation/trigger) enable {% term automation %} based on an
event's start or end. Review the [Automating Home Assistant](/getting-started/automation/) event's start or end. Review the [Automating Home Assistant](/getting-started/automation/)
getting started guide on automations or the [Automation](/docs/automation/) getting started guide on automations or the [Automation](/docs/automation/)
documentation for full details. documentation for full details.
@ -47,7 +47,7 @@ documentation for full details.
![Screenshot Trigger](/images/integrations/calendar/trigger.png) ![Screenshot Trigger](/images/integrations/calendar/trigger.png)
An example of a calendar trigger in YAML: An example of a calendar {% term trigger %} in YAML:
```yaml ```yaml
automation: automation:
@ -65,7 +65,7 @@ Calendar triggers should not generally use automation mode `single` to ensure
the trigger can fire when multiple events start at the same time (e.g., use the trigger can fire when multiple events start at the same time (e.g., use
`queued` or `parallel` instead). Note that calendars are read once every 15 `queued` or `parallel` instead). Note that calendars are read once every 15
minutes. When testing, make sure you do not plan events less than 15 minutes minutes. When testing, make sure you do not plan events less than 15 minutes
away from the current time, or your trigger might not fire. away from the current time, or your {% term trigger %} might not fire.
See [Automation Trigger Variables: Calendar](/docs/automation/templating/#calendar) See [Automation Trigger Variables: Calendar](/docs/automation/templating/#calendar)
for additional trigger data available for conditions or actions. for additional trigger data available for conditions or actions.
@ -140,8 +140,8 @@ automation:
## Services ## Services
Some calendar integrations allow Home Assistant to manage your calendars Some calendar {% term integrations %} allow Home Assistant to manage your calendars
directly using services. The services provided by some calendar entities are described below or you can read more about [Service Calls](/docs/scripts/service-calls/). directly using {% term services %}. The services provided by some calendar {% term entity %} are described below or you can read more about [Service Calls](/docs/scripts/service-calls/).
### Service `calendar.create_event` ### Service `calendar.create_event`
@ -165,7 +165,7 @@ You either use `start_date_time` and `end_date_time`, or `start_date` and `end_d
</div> </div>
This is a full example of service call in YAML: This is a full example of a {% term service %} call in YAML:
```yaml ```yaml
service: calendar.create_event service: calendar.create_event

2
source/_integrations/camera.markdown
View File

@ -3,7 +3,7 @@ title: Camera
description: Instructions on how to integrate cameras within Home Assistant. description: Instructions on how to integrate cameras within Home Assistant.
ha_category: ha_category:
- Camera - Camera
- Media Source - Media source
ha_release: 0.7 ha_release: 0.7
ha_quality_scale: internal ha_quality_scale: internal
ha_domain: camera ha_domain: camera

2
source/_integrations/canary.markdown
View File

@ -16,7 +16,7 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The `canary` integration allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. The **Canary** {% term integration %} allows you to integrate your [Canary](https://canary.is) devices in Home Assistant.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:

2
source/_integrations/cast.markdown
View File

@ -2,7 +2,7 @@
title: Google Cast title: Google Cast
description: Instructions on how to integrate Google Cast into Home Assistant. description: Instructions on how to integrate Google Cast into Home Assistant.
ha_category: ha_category:
- Media Player - Media player
featured: true featured: true
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: Local Polling ha_iot_class: Local Polling

4
source/_integrations/cert_expiry.markdown
View File

@ -14,14 +14,14 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The Certificate Expiry integration fetches the certificate from a configured host and displays its expiration in a timestamp sensor. The **Certificate Expiry** {% term integration %} fetches the certificate from a configured host and displays its expiration in a timestamp sensor.
The sensor checks and updates the certificate information for the configured host every 12 hours. The sensor checks and updates the certificate information for the configured host every 12 hours.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
## Attributes ## Attributes
The Certificate Expiry entities provide extra attributes to represent the state of the certificate. The Certificate Expiry {% term entities %} provide extra attributes to represent the state of the certificate.
| Name | Description | | Name | Description |
| ---- | ----------- | | ---- | ----------- |

2
source/_integrations/channels.markdown
View File

@ -2,7 +2,7 @@
title: Channels title: Channels
description: Instructions on how to integrate Channels into Home Assistant. description: Instructions on how to integrate Channels into Home Assistant.
ha_category: ha_category:
- Media Player - Media player
ha_release: 0.65 ha_release: 0.65
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: channels ha_domain: channels

2
source/_integrations/cisco_ios.markdown
View File

@ -2,7 +2,7 @@
title: Cisco IOS title: Cisco IOS
description: Instructions on how to integrate Cisco IOS routers into Home Assistant. description: Instructions on how to integrate Cisco IOS routers into Home Assistant.
ha_category: ha_category:
- Presence Detection - Presence detection
ha_release: 0.33 ha_release: 0.33
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_codeowners: ha_codeowners:

2
source/_integrations/cisco_mobility_express.markdown
View File

@ -2,7 +2,7 @@
title: Cisco Mobility Express title: Cisco Mobility Express
description: Instructions on how to integrate Cisco Mobility Express wireless controllers into Home Assistant. description: Instructions on how to integrate Cisco Mobility Express wireless controllers into Home Assistant.
ha_category: ha_category:
- Presence Detection - Presence detection
ha_release: '0.90' ha_release: '0.90'
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_codeowners: ha_codeowners:

2
source/_integrations/clementine.markdown
View File

@ -2,7 +2,7 @@
title: Clementine Music Player title: Clementine Music Player
description: Instructions on how to integrate Clementine Music Player within Home Assistant. description: Instructions on how to integrate Clementine Music Player within Home Assistant.
ha_category: ha_category:
- Media Player - Media player
ha_release: 0.39 ha_release: 0.39
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: clementine ha_domain: clementine

4
source/_integrations/climate.markdown
View File

@ -11,7 +11,7 @@ ha_codeowners:
ha_integration_type: entity ha_integration_type: entity
--- ---
The climate integration allows you to control and monitor HVAC (heating, ventilating, and air conditioning) devices and thermostats. The **Climate** {% term integration %} allows you to control and monitor HVAC (heating, ventilating, and air conditioning) devices and thermostats.
{% include integrations/building_block_integration.md %} {% include integrations/building_block_integration.md %}
@ -23,7 +23,7 @@ Available services: `climate.set_aux_heat`, `climate.set_preset_mode`, `climate.
<div class='note'> <div class='note'>
Not all climate services may be available for your platform. You can check which climate services are available under **Developer Tools** -> **Services**. Not all climate {% term services %} may be available for your platform. You can check which climate services are available under **Developer Tools** -> **Services**.
</div> </div>

2
source/_integrations/cloud.markdown
View File

@ -20,7 +20,7 @@ The Home Assistant Cloud allows you to quickly integrate your local Home Assista
## Configuration ## Configuration
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually: This {% term integration %} is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
```yaml ```yaml
# Example configuration.yaml entry to enable the cloud component # Example configuration.yaml entry to enable the cloud component

2
source/_integrations/cloudflare.markdown
View File

@ -13,7 +13,7 @@ ha_config_flow: true
ha_integration_type: integration ha_integration_type: integration
--- ---
With the Cloudflare integration, you can keep your Cloudflare DNS records up to date. With the **Cloudflare** {% term integration %}, you can keep your Cloudflare DNS records up to date.
The integration runs every hour, but can also be triggered by running the {% my developer_services title="`cloudflare.update_records` service" service="cloudflare.update_records" %}. The integration runs every hour, but can also be triggered by running the {% my developer_services title="`cloudflare.update_records` service" service="cloudflare.update_records" %}.

2
source/_integrations/cmus.markdown
View File

@ -2,7 +2,7 @@
title: cmus title: cmus
description: Instructions on how to integrate cmus Music Player into Home Assistant. description: Instructions on how to integrate cmus Music Player into Home Assistant.
ha_category: ha_category:
- Media Player - Media player
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: 0.23 ha_release: 0.23
ha_domain: cmus ha_domain: cmus

16
source/_integrations/color_extractor.markdown
View File

@ -3,7 +3,7 @@ title: ColorExtractor
description: Instructions how to integrate the Color Extractor into Home Assistant. description: Instructions how to integrate the Color Extractor into Home Assistant.
ha_release: 0.118 ha_release: 0.118
ha_category: ha_category:
- Image Processing - Image processing
ha_domain: color_extractor ha_domain: color_extractor
ha_codeowners: ha_codeowners:
- '@GenericStudent' - '@GenericStudent'
@ -11,8 +11,8 @@ ha_config_flow: true
ha_integration_type: integration ha_integration_type: integration
--- ---
The color extractor integration will extract the predominant color from a given image and apply that color to a target light. The **ColorExtractor** {% term integration %} will extract the predominant color from a given image and apply that color to a target light.
Useful as part of an automation. Useful as part of an {% term automation %}.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
@ -20,7 +20,7 @@ Useful as part of an automation.
Because `color_extractor.turn_on` will then call `light.turn_on`, you can pass any valid [`light.turn_on`](/integrations/light#service-lightturn_on) parameters (`rgb_color` will be set for you though) as those will be passed along. Because `color_extractor.turn_on` will then call `light.turn_on`, you can pass any valid [`light.turn_on`](/integrations/light#service-lightturn_on) parameters (`rgb_color` will be set for you though) as those will be passed along.
Passing the key `color_extract_url` to the service call will download the linked image and extract the predominant color from it. Passing the key `color_extract_path` to the service call will process the image file from local storage instead. `color_extract_url` and `color_extract_path` are exclusive and cannot be used together. Passing the key `color_extract_url` to the {% term service %} call will download the linked image and extract the predominant color from it. Passing the key `color_extract_path` to the service call will process the image file from local storage instead. `color_extract_url` and `color_extract_path` are exclusive and cannot be used together.
|Key | Example | Description | |Key | Example | Description |
|---------------------|---------------------------------------|-------------------------------------------------------------------------------| |---------------------|---------------------------------------|-------------------------------------------------------------------------------|
@ -30,7 +30,7 @@ Passing the key `color_extract_url` to the service call will download the linked
<div class="note"> <div class="note">
Please ensure any [external URLs](/docs/configuration/basic/#allowlist_external_urls) or [external files](/docs/configuration/basic/#allowlist_external_dirs) are authorized for use. You will receive error messages if this integration is not allowed access to these external resources. Please ensure any [external URLs](/docs/configuration/basic/#allowlist_external_urls) or [external files](/docs/configuration/basic/#allowlist_external_dirs) are authorized for use. You will receive error messages if this {% term integration %} is not allowed access to these external resources.
</div> </div>
@ -38,17 +38,17 @@ Passing the key `color_extract_url` to the service call will download the linked
Add the parameter key `color_extract_url` to the service call. Add the parameter key `color_extract_url` to the service call.
This service allows you to pass in the URL of an image, have it downloaded, get the predominant color from it, and then set a light's RGB value to it. This {% term service %} allows you to pass in the URL of an image, have it downloaded, get the predominant color from it, and then set a light's RGB value to it.
### File Service Call ### File Service Call
Add the parameter key `color_extract_path` to the service call. Add the parameter key `color_extract_path` to the service call.
This service is very similar to the URL service above, except it processes a file from the local file storage. This {% term service %} is very similar to the URL service above, except it processes a file from the local file storage.
## Example Automations ## Example Automations
Example usage in an automation, taking the album art present on a Chromecast and supplying it to `light.shelf_leds` whenever it changes: Example usage in an {% term automation %}, taking the album art present on a Chromecast and supplying it to `light.shelf_leds` whenever it changes:
{% raw %} {% raw %}

4
source/_integrations/command_line.markdown
View File

@ -2,7 +2,7 @@
title: Command Line title: Command Line
description: Instructions on how to integrate the Command Line utility within Home Assistant. description: Instructions on how to integrate the Command Line utility within Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary sensor
- Cover - Cover
- Notifications - Notifications
- Sensor - Sensor
@ -690,7 +690,7 @@ command_line:
``` ```
{% endraw%} {% endraw%}
### Control Foscam Motion Sensor ### Control Foscam motion sensor
This switch will control the motion sensor of Foscam Webcams which Support CGI This switch will control the motion sensor of Foscam Webcams which Support CGI
Commands ([Source](https://www.iltucci.com/blog/wp-content/uploads/2018/12/Foscam-IPCamera-CGI-User-Guide-V1.0.4.pdf)). Commands ([Source](https://www.iltucci.com/blog/wp-content/uploads/2018/12/Foscam-IPCamera-CGI-User-Guide-V1.0.4.pdf)).

2
source/_integrations/compensation.markdown
View File

@ -14,7 +14,7 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The Compensation {% term integration %} consumes the {% term state %} from other {% term sensors %}. It exports the compensated value as state in a separate {% term entity %} and the following values as attributes: `entity_id` and `coefficients`. A single polynomial, linear by default, is fit to all data points provided. The **Compensation** {% term integration %} consumes the {% term state %} from other {% term sensors %}. It exports the compensated value as state in a separate {% term entity %} and the following values as attributes: `entity_id` and `coefficients`. A single polynomial, linear by default, is fit to all data points provided.
## Configuration ## Configuration

8
source/_integrations/concord232.markdown
View File

@ -3,7 +3,7 @@ title: Concord232
description: Instructions on how to integrate Interlogix/GE Concord4 into Home Assistant. description: Instructions on how to integrate Interlogix/GE Concord4 into Home Assistant.
ha_category: ha_category:
- Alarm - Alarm
- Binary Sensor - Binary sensor
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: 0.31 ha_release: 0.31
ha_domain: concord232 ha_domain: concord232
@ -20,9 +20,9 @@ To use this platform, you will need to have the external concord232 client and s
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm-control-panel) - [Alarm](#alarm-control-panel)
- [Binary Sensor](#binary-sensor) - [Binary sensor](#binary-sensor)
## Alarm Control Panel ## Alarm control panel
To enable the alarm control panel platform, add the following lines to your `configuration.yaml`: To enable the alarm control panel platform, add the following lines to your `configuration.yaml`:
@ -54,7 +54,7 @@ mode:
default: audible default: audible
{% endconfiguration %} {% endconfiguration %}
## Binary Sensor ## Binary sensor
To enable the binary sensor platform, add the following lines to your `configuration.yaml`: To enable the binary sensor platform, add the following lines to your `configuration.yaml`:

8
source/_integrations/configurator.markdown
View File

@ -15,11 +15,11 @@ ha_integration_type: system
This integration is intended for developers. This integration is intended for developers.
</div> </div>
The configurator integration allows integrations to request information from the user. It is currently implemented as the minimum viable product: The **Configurator** {% term integration %} allows integrations to request information from the user. It is currently implemented as the minimum viable product:
- It supports showing a text, image and button to the user - It supports showing a text, image, and a button to the user.
- Input fields can be defined with a description, and optional type - Input fields can be defined with a description, and optional type.
- It will trigger a callback when the button is pressed - It will trigger a callback when the button is pressed.
The Hue integration in [the demo](https://demo.home-assistant.io/) and Plex are implemented using the configurator. See [the source of the demo integration](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example. The Hue integration in [the demo](https://demo.home-assistant.io/) and Plex are implemented using the configurator. See [the source of the demo integration](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/demo) for a simple example.

4
source/_integrations/control4.markdown
View File

@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
--- ---
The Control4 integration allows you to control and monitor lights from your local Control4 system. Your Control4 controller must be running OS 3.0+. The **Control4** {% term integration %} allows you to control and monitor lights from your local Control4 system. Your Control4 controller must be running OS 3.0+.
## Prerequisites ## Prerequisites
@ -25,7 +25,7 @@ Before setting up, you should assign a static IP address/DHCP reservation on you
## Options ## Options
The Control4 integration offers additional options in **Settings** -> **Devices & Services** -> **Control4** -> **Options**: The Control4 {% term integration %} offers additional options in {% my integrations title="**Settings** > **Devices & Services**" %} > **Control4** > **Options**:
{% configuration %} {% configuration %}
Seconds between updates: Seconds between updates:

2
source/_integrations/conversation.markdown
View File

@ -13,7 +13,7 @@ ha_domain: conversation
ha_integration_type: system ha_integration_type: system
--- ---
The conversation integration allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text. The **Conversation** {% term integration %} allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.
<p class='img'> <p class='img'>
<img src="/images/screenshots/voice-commands.png" /> <img src="/images/screenshots/voice-commands.png" />

14
source/_integrations/cover.template.markdown
View File

@ -1,6 +1,6 @@
--- ---
title: "Template Cover" title: "Template cover"
description: "Instructions on how to integrate Template Covers into Home Assistant." description: "Instructions on how to integrate template covers into Home Assistant."
ha_category: ha_category:
- Cover - Cover
ha_release: 0.48 ha_release: 0.48
@ -130,7 +130,7 @@ with this equivalent that returns `true`/`false` and never gives an unknown
result: result:
{% raw %}`{{ is_state('cover.source', 'open') }}`{% endraw %} {% raw %}`{{ is_state('cover.source', 'open') }}`{% endraw %}
## Optimistic Mode ## Optimistic mode
In optimistic mode, the cover position state is maintained internally. This mode In optimistic mode, the cover position state is maintained internally. This mode
is automatically enabled if neither [`value_template`](#value_template) or is automatically enabled if neither [`value_template`](#value_template) or
@ -160,7 +160,7 @@ If both a [`value_template`](#value_template) and a [`position_template`](#posit
In this section you will find some real-life examples of how to use this cover. In this section you will find some real-life examples of how to use this cover.
### Garage Door ### Garage door
This example converts a garage door with a controllable switch and position This example converts a garage door with a controllable switch and position
sensor into a cover. The condition check is optional, but suggested if you sensor into a cover. The condition check is optional, but suggested if you
@ -204,7 +204,7 @@ cover:
{% endraw %} {% endraw %}
### Multiple Covers ### Multiple covers
This example allows you to control two or more covers at once. This example allows you to control two or more covers at once.
@ -296,7 +296,7 @@ automation:
{% endraw %} {% endraw %}
### Change The Icon ### Change the icon
This example shows how to change the icon based on the cover state. This example shows how to change the icon based on the cover state.
@ -331,7 +331,7 @@ cover:
{% endraw %} {% endraw %}
### Change The Entity Picture ### Change the entity picture
This example shows how to change the entity picture based on the cover state. This example shows how to change the entity picture based on the cover state.

4
source/_integrations/cozytouch.markdown
View File

@ -3,7 +3,7 @@ title: Atlantic Cozytouch
description: Connect and control your Atlantic Cozytouch devices using the Overkiz integration description: Connect and control your Atlantic Cozytouch devices using the Overkiz integration
ha_category: ha_category:
- Alarm - Alarm
- Binary Sensor - Binary sensor
- Button - Button
- Climate - Climate
- Cover - Cover
@ -16,7 +16,7 @@ ha_category:
- Sensor - Sensor
- Siren - Siren
- Switch - Switch
- Water Heater - Water heater
ha_domain: cozytouch ha_domain: cozytouch
ha_integration_type: virtual ha_integration_type: virtual
ha_supporting_domain: overkiz ha_supporting_domain: overkiz

2
source/_integrations/cpuspeed.markdown
View File

@ -2,7 +2,7 @@
title: CPU Speed title: CPU Speed
description: Instructions on how to integrate CPU speed within Home Assistant. description: Instructions on how to integrate CPU speed within Home Assistant.
ha_category: ha_category:
- System Monitor - System monitor
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: Local Push ha_iot_class: Local Push
ha_codeowners: ha_codeowners:

2
source/_integrations/cups.markdown
View File

@ -2,7 +2,7 @@
title: CUPS title: CUPS
description: Instructions on how to integrate CUPS sensors into Home Assistant. description: Instructions on how to integrate CUPS sensors into Home Assistant.
ha_category: ha_category:
- System Monitor - System monitor
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: 0.32 ha_release: 0.32
ha_codeowners: ha_codeowners: