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

2022.9.0 (#24029)

Browse Source
This commit is contained in:
Paulus Schoutsen 2022-09-07 12:51:24 -04:00 committed by GitHub
commit 87abd3d26a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
115 changed files with 4168 additions and 828 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.vscode/cSpell.json vendored
View File

@ -4,6 +4,7 @@
"version": "0.2",
"language": "en",
"words": [
"Accu",
"aeotec",
"Alexa",
"arest",
@ -16,6 +17,7 @@
"BTLE",
"CEST",
"Chromecast",
"codeowners",
"deCONZ",
"Denon",
"DSMR",
@ -44,9 +46,11 @@
"HomeKit",
"Homematic",
"HVAC",
"Hygro",
"IBAN",
"icloud",
"IFTTT",
"Jeelink",
"kardon",
"laundrify",
"Lutron",
@ -54,6 +58,7 @@
"Meteobridge",
"Modbus",
"Mosquitto",
"Multiday",
"Nabu Casa",
"nginx",
"Nijhof",
@ -65,6 +70,7 @@
"OwnTracks",
"Paulus",
"PECO",
"POOLV",
"Powerwall",
"Pushbullet",
"Schoutsen",
@ -80,6 +86,9 @@
"waqi",
"WLED",
"worldclock",
"WRTHV",
"WSDTH",
"WTHV",
"Xiaomi",
"Zigbee"
],

36
CODEOWNERS
View File

@ -37,6 +37,7 @@ source/_integrations/ambient_station.markdown @bachya
source/_integrations/amcrest.markdown @flacjacket
source/_integrations/amp_motorization.markdown @starkillerOG
source/_integrations/analytics.markdown @home-assistant/core @ludeeus
source/_integrations/android_ip_webcam.markdown @engrbm87
source/_integrations/androidtv.markdown @JeffLIrion @ollo69
source/_integrations/anthemav.markdown @hyralex
source/_integrations/apache_kafka.markdown @bachya
@ -53,6 +54,7 @@ source/_integrations/atag.markdown @MatsNL
source/_integrations/aten_pe.markdown @mtdcr
source/_integrations/atome.markdown @baqs
source/_integrations/august.markdown @bdraco
source/_integrations/august_ble.markdown @bdraco
source/_integrations/aurora.markdown @djtimca
source/_integrations/aurora_abb_powerone.markdown @davet2001
source/_integrations/aussie_broadband.markdown @nickw444 @Bre77
@ -87,6 +89,7 @@ source/_integrations/brother.markdown @bieniu
source/_integrations/brunt.markdown @eavanvalkenburg
source/_integrations/bsblan.markdown @liudger
source/_integrations/bt_smarthub.markdown @jxwolstenholme
source/_integrations/bthome.markdown @Ernst79
source/_integrations/buienradar.markdown @mjj4791 @ties @Robbie1221
source/_integrations/button.markdown @home-assistant/core
source/_integrations/calendar.markdown @home-assistant/core
@ -151,7 +154,8 @@ source/_integrations/dwd_weather_warnings.markdown @runningman84 @stephan192 @Hu
source/_integrations/dynalite.markdown @ziv1234
source/_integrations/ecobee.markdown @marthoc
source/_integrations/econet.markdown @vangorra @w1ll1am23
source/_integrations/ecovacs.markdown @OverloadUT
source/_integrations/ecovacs.markdown @OverloadUT @mib1185
source/_integrations/ecowitt.markdown @pvizeli
source/_integrations/edl21.markdown @mtdcr
source/_integrations/efergy.markdown @tkdrob
source/_integrations/egardia.markdown @jeroenterheerdt
@ -176,6 +180,7 @@ source/_integrations/ephember.markdown @ttroy50
source/_integrations/epson.markdown @pszafer
source/_integrations/epsonworkforce.markdown @ThaStealth
source/_integrations/eq3btsmart.markdown @rytilahti
source/_integrations/escea.markdown @lazdavila
source/_integrations/esphome.markdown @OttoWinter @jesserockz
source/_integrations/evil_genius_labs.markdown @balloob
source/_integrations/evohome.markdown @zxdavb
@ -195,7 +200,7 @@ source/_integrations/flexom.markdown @imicknl @vlebourl @tetienne
source/_integrations/flick_electric.markdown @ZephireNZ
source/_integrations/flipr.markdown @cnico
source/_integrations/flo.markdown @dmulcahey
source/_integrations/flume.markdown @ChrisMandich @bdraco
source/_integrations/flume.markdown @ChrisMandich @bdraco @jeeftor
source/_integrations/flunearyou.markdown @bachya
source/_integrations/flux_led.markdown @icemanch @bdraco
source/_integrations/forecast_solar.markdown @klaasnicolaas @frenck
@ -210,6 +215,7 @@ source/_integrations/fritzbox_callmonitor.markdown @cdce8p
source/_integrations/fronius.markdown @nielstron @farmio
source/_integrations/frontend.markdown @home-assistant/frontend
source/_integrations/frontier_silicon.markdown @wlcrs
source/_integrations/fully_kiosk.markdown @cgarwood
source/_integrations/garages_amsterdam.markdown @klaasnicolaas
source/_integrations/gaviota.markdown @starkillerOG
source/_integrations/gdacs.markdown @exxamalte
@ -242,6 +248,7 @@ source/_integrations/guardian.markdown @bachya
source/_integrations/habitica.markdown @ASMfreaK @leikoilja
source/_integrations/harmony.markdown @ehendrix23 @bramkragten @bdraco @mkeesey @Aohzan
source/_integrations/hassio.markdown @home-assistant/supervisor
source/_integrations/hdmi_cec.markdown @inytar
source/_integrations/heatmiser.markdown @andylockran
source/_integrations/heos.markdown @andrewsayre
source/_integrations/here_travel_time.markdown @eifinger
@ -305,6 +312,7 @@ source/_integrations/izone.markdown @Swamp-Ig
source/_integrations/jellyfin.markdown @j-stienstra
source/_integrations/jewish_calendar.markdown @tsvi
source/_integrations/juicenet.markdown @jesserockz
source/_integrations/justnimbus.markdown @kvanzuijlen
source/_integrations/kaiterra.markdown @Michsior14
source/_integrations/kaleidescape.markdown @SteveEasley
source/_integrations/keba.markdown @dannerph
@ -318,10 +326,13 @@ source/_integrations/konnected.markdown @heythisisnate
source/_integrations/kostal_plenticore.markdown @stegm
source/_integrations/kraken.markdown @eifinger
source/_integrations/kulersky.markdown @emlove
source/_integrations/lacrosse_view.markdown @IceBotYT
source/_integrations/lametric.markdown @robbiet480 @frenck
source/_integrations/landisgyr_heat_meter.markdown @vpathuis
source/_integrations/launch_library.markdown @ludeeus @DurgNomis-drol
source/_integrations/laundrify.markdown @xLarry
source/_integrations/lcn.markdown @alengwenus
source/_integrations/led_ble.markdown @bdraco
source/_integrations/leviton_z_wave.markdown @home-assistant/z-wave
source/_integrations/lg_netcast.markdown @Drafteed
source/_integrations/life360.markdown @pnbruckner
@ -329,7 +340,7 @@ source/_integrations/lifx.markdown @bdraco @Djelibeybi
source/_integrations/light.markdown @home-assistant/core
source/_integrations/linux_battery.markdown @fabaff
source/_integrations/litejet.markdown @joncar
source/_integrations/litterrobot.markdown @natekspencer
source/_integrations/litterrobot.markdown @natekspencer @tkdrob
source/_integrations/local_ip.markdown @issacg
source/_integrations/lock.markdown @home-assistant/core
source/_integrations/logbook.markdown @home-assistant/core
@ -340,7 +351,7 @@ source/_integrations/luci.markdown @mzdrale
source/_integrations/luftdaten.markdown @fabaff @frenck
source/_integrations/lupusec.markdown @majuss
source/_integrations/lutron.markdown @JonGilmore
source/_integrations/lutron_caseta.markdown @swails @bdraco
source/_integrations/lutron_caseta.markdown @swails @bdraco @danaues
source/_integrations/luxaflex.markdown @bdraco @kingy444 @trullock
source/_integrations/lyric.markdown @timmo001
source/_integrations/marantz.markdown @ol-iver @starkillerOG
@ -354,6 +365,7 @@ source/_integrations/media_source.markdown @hunterjm
source/_integrations/mediaroom.markdown @dgomes
source/_integrations/melcloud.markdown @vilppuvuorinen
source/_integrations/melissa.markdown @kennedyshead
source/_integrations/melnor.markdown @vanstinator
source/_integrations/met.markdown @danielhiversen @thimic
source/_integrations/met_eireann.markdown @DylanGore
source/_integrations/meteo_france.markdown @hacf-fr @oncleben31 @Quentame
@ -414,6 +426,7 @@ source/_integrations/nuki.markdown @pschmitt @pvizeli @pree
source/_integrations/numato.markdown @clssn
source/_integrations/number.markdown @home-assistant/core @Shulyaka
source/_integrations/nut.markdown @bdraco @ollo69
source/_integrations/nutrichef.markdown @bdraco
source/_integrations/nws.markdown @MatthewFlamm
source/_integrations/nzbget.markdown @chriscla
source/_integrations/obihai.markdown @dshokouhi
@ -428,6 +441,7 @@ source/_integrations/onewire.markdown @garbled1 @epenet
source/_integrations/onvif.markdown @hunterjm
source/_integrations/open_meteo.markdown @frenck
source/_integrations/openerz.markdown @misialq
source/_integrations/openexchangerates.markdown @MartinHjelmare
source/_integrations/opengarage.markdown @danielhiversen
source/_integrations/openhome.markdown @bazwilliams
source/_integrations/opentherm_gw.markdown @mvn23
@ -458,12 +472,15 @@ source/_integrations/progettihwsw.markdown @ardaseremet
source/_integrations/prometheus.markdown @knyar
source/_integrations/prosegur.markdown @dgomes
source/_integrations/proxmoxve.markdown @jhollowe @Corbeno
source/_integrations/prusalink.markdown @balloob
source/_integrations/ps4.markdown @ktnrg45
source/_integrations/pure_energie.markdown @klaasnicolaas
source/_integrations/push.markdown @dgomes
source/_integrations/pushover.markdown @engrbm87
source/_integrations/pvoutput.markdown @frenck
source/_integrations/pvpc_hourly_pricing.markdown @azogue
source/_integrations/qbittorrent.markdown @geoffreylagaisse
source/_integrations/qingping.markdown @bdraco
source/_integrations/qld_bushfire.markdown @exxamalte
source/_integrations/qnap_qsw.markdown @Noltari
source/_integrations/quantum_gateway.markdown @cisasteelersfan
@ -507,6 +524,7 @@ source/_integrations/safe_mode.markdown @home-assistant/core
source/_integrations/saj.markdown @fredericvl
source/_integrations/samsungtv.markdown @chemelli74 @epenet
source/_integrations/scene.markdown @home-assistant/core
source/_integrations/schedule.markdown @home-assistant/core
source/_integrations/schluter.markdown @prairieapps
source/_integrations/scrape.markdown @fabaff
source/_integrations/screenlogic.markdown @dieselrabbit @bdraco
@ -518,6 +536,8 @@ source/_integrations/sense.markdown @kbickar
source/_integrations/senseme.markdown @mikelawrence @bdraco
source/_integrations/sensibo.markdown @andrey-git @gjohansson-ST
source/_integrations/sensor.markdown @home-assistant/core
source/_integrations/sensorblue.markdown @bdraco
source/_integrations/sensorpro.markdown @bdraco
source/_integrations/sensorpush.markdown @bdraco
source/_integrations/sentry.markdown @dcramer @frenck
source/_integrations/senz.markdown @milanmeu
@ -586,7 +606,7 @@ source/_integrations/swiss_hydrological_data.markdown @fabaff
source/_integrations/swiss_public_transport.markdown @fabaff
source/_integrations/switch.markdown @home-assistant/core
source/_integrations/switch_as_x.markdown @home-assistant/core
source/_integrations/switchbot.markdown @bdraco @danielhiversen @RenierM26 @murtas
source/_integrations/switchbot.markdown @bdraco @danielhiversen @RenierM26 @murtas @Eloston
source/_integrations/switcher_kis.markdown @tomerfi @thecode
source/_integrations/switchmate.markdown @danielhiversen @qiz-li
source/_integrations/syncthing.markdown @zhulik
@ -605,6 +625,9 @@ source/_integrations/tellduslive.markdown @fredrike
source/_integrations/template.markdown @PhracturedBlue @tetienne @home-assistant/core
source/_integrations/tesla_wall_connector.markdown @einarhauks
source/_integrations/tfiac.markdown @fredrike @mellado
source/_integrations/thermobeacon.markdown @bdraco
source/_integrations/thermoplus.markdown @bdraco
source/_integrations/thermopro.markdown @bdraco
source/_integrations/thethingsnetwork.markdown @fabaff
source/_integrations/threshold.markdown @fabaff
source/_integrations/tibber.markdown @danielhiversen
@ -656,7 +679,7 @@ source/_integrations/vivotek.markdown @HarlemSquirrel
source/_integrations/vizio.markdown @raman325
source/_integrations/vlc_telnet.markdown @rodripf @MartinHjelmare
source/_integrations/volumio.markdown @OnFreund
source/_integrations/volvooncall.markdown @molobrakos @decompil3d
source/_integrations/volvooncall.markdown @molobrakos
source/_integrations/vulcan.markdown @Antoni-Czaplicki
source/_integrations/wake_on_lan.markdown @ntilley905
source/_integrations/wallbox.markdown @hesselonline
@ -690,6 +713,7 @@ source/_integrations/xiaomi_miio.markdown @rytilahti @syssi @starkillerOG @bieni
source/_integrations/xiaomi_tv.markdown @simse
source/_integrations/xmpp.markdown @fabaff @flowolf
source/_integrations/yale_smart_alarm.markdown @gjohansson-ST
source/_integrations/yalexs_ble.markdown @bdraco
source/_integrations/yamaha_musiccast.markdown @vigonotion @micha91
source/_integrations/yandex_transport.markdown @rishatik92 @devbis
source/_integrations/yeelight.markdown @zewelor @shenxn @starkillerOG @alexyao2015

6
_config.yml
View File

@ -106,9 +106,9 @@ social:
# Home Assistant release details
current_major_version: 2022
current_minor_version: 8
current_patch_version: 7
date_released: 2022-08-25
current_minor_version: 9
current_patch_version: 0
date_released: 2022-09-07
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

42
source/_docs/blueprint/selectors.markdown
View File

@ -21,6 +21,7 @@ The following selectors are currently available:
- [Attribute selector](#attribute-selector)
- [Boolean selector](#boolean-selector)
- [Color temperature selector](#color-temperature-selector)
- [Config entry selector](#config-entry-selector)
- [Date selector](#date-selector)
- [Date & time selector](#date--time-selector)
- [Device selector](#device-selector)
@ -33,6 +34,7 @@ The following selectors are currently available:
- [Object selector](#object-selector)
- [RGB color selector](#rgb-color-selector)
- [Select selector](#select-selector)
- [State selector](#state-selector)
- [Target selector](#target-selector)
- [Template selector](#template-selector)
- [Text selector](#text-selector)
@ -279,6 +281,27 @@ max_mireds:
The output of this selector is the number of mired selected, for example, `243`.
## Config entry selector
The config entry selector allows the user to select an integration
configuration entry. The selector returns the entry ID of the selected
integration configuration entry.
![Screenshot of the Configuration entry selector](/images/blueprints/selector-config-entry.png)
```yaml
config_entry:
```
{% configuration config_entry %}
integration:
description: Limits the list of selectable configuration entries to a single integration domain.
type: string
required: false
{% endconfiguration %}
The output of this selector is the entry ID of the config entry, for example, `6b68b250388cbe0d620c92dd3acc93ec`.
## Date selector
The date selector shows a date input that allows the user to specify a date.
@ -820,6 +843,25 @@ When `multiple` is `true`, the output of this selector is the list of selected
option values. In this case, if `Green` was selected, in the first example it
would return ["Green"] and in the last example it returns ["g"].
## State selector
The state selector shows a list of states for a provided entity of which
one can be selected.
![Screenshot of an state selector](/images/blueprints/selector-state.png)
{% configuration state %}
entity_id:
description: The entity ID of which an state can be selected from.
type: string
required: true
{% endconfiguration %}
The output of this selector is the select state (not the translated or
prettified name shown in the frontend).
For example: `heat_cool`.
## Target selector
The target selector is a rather special selector, allowing the user to select

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

@ -857,7 +857,7 @@ With given payload:
Template {% raw %}```{{ value_json.temperature | round(1) }}```{% endraw %} renders to `21.9`.
Additional the MQTT entity attributes `entity_id` and `name` can be used as variables in the template.
Additional the MQTT entity attributes `entity_id`, `name` and `this` can be used as variables in the template. The `this` attribute refers to the [entity state](/docs/configuration/state_object) of the MQTT item.
</div>
@ -877,7 +877,7 @@ With given value `21.9` template {% raw %}```{"temperature": {{ value }} }```{%
}
```
Additional the MQTT entity attributes `entity_id` and `name` can be used as variables in the template.
Additional the MQTT entity attributes `entity_id`, `name` and `this` can be used as variables in the template. The `this` attribute refers to the [entity state](/docs/configuration/state_object) of the MQTT item.
</div>

1
source/_docs/mqtt/discovery.markdown
View File

@ -308,6 +308,7 @@ Supported abbreviations for device registry configuration:
'name': 'name',
'mf': 'manufacturer',
'mdl': 'model',
'hw': 'hw_version',
'sw': 'sw_version',
'sa': 'suggested_area',
```

19
source/_integrations/advantage_air.markdown
View File

@ -3,6 +3,7 @@ title: Advantage Air
description: Instructions on how to integrate Advantage Air A/C controller into Home Assistant.
ha_category:
- Climate
- Updates
ha_release: 0.117
ha_iot_class: Local Polling
ha_config_flow: true
@ -15,9 +16,11 @@ ha_platforms:
- climate
- cover
- diagnostics
- light
- select
- sensor
- switch
- update
ha_integration_type: integration
---
@ -60,6 +63,14 @@ The `advantage_air` switch platform will create a switch entity to toggle fresh
The `advantage_air` select platform allows you to change the zone used for the "MyZone" feature.
### Update
The `advantage_air` update platform shows if the controller app requires an update.
### Light
The `advantage_air` light platform will create a light entity for each light in MyLights tab of the MyPlace app.
## Services
### Service `advantage_air.set_time_to`
@ -70,11 +81,3 @@ Set the On/Off Timer using the relevant sensor entity.
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | `sensor.[name]_time_to_on` or `sensor.[name]_time_to_off`
| `minutes` | no | Number of minutes between `0` and `720`.
### Service `advantage_air.set_myzone`
Change the MyZone setting to the provided zone climate entity.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | `climate.[zone name]`

4
source/_integrations/alarm_control_panel.mqtt.markdown
View File

@ -135,6 +135,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: "A list of IDs that uniquely identify the device. For example a serial number."
required: false

174
source/_integrations/android_ip_webcam.markdown
View File

@ -9,6 +9,7 @@ ha_category:
- Switch
ha_release: '0.40'
ha_iot_class: Local Polling
ha_config_flow: true
ha_domain: android_ip_webcam
ha_platforms:
- binary_sensor
@ -16,9 +17,11 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
ha_codeowners:
- '@engrbm87'
---
The `android_ip_webcam` integration connects with Android IP Webcam to turn any Android phone or tablet into a network camera with multiple viewing options.
The Android IP Webcam integration connects with Android IP Webcam to turn any Android phone or tablet into a network camera with multiple viewing options.
The integration is setup as an MJPEG camera with all settings as switches inside Home Assistant. You can also integrate the sensors exposed by the app. If you have multiple phones, you can use all options inside a list.
@ -33,177 +36,10 @@ There is currently support for the following device types within Home Assistant:
Download [Android IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen.
## Configuration
To set up the component, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
android_ip_webcam:
- host: 192.168.1.10
```
{% configuration %}
host:
description: The IP address of the phone on the network.
required: true
type: string
port:
description: The port the IP Webcam listens on.
required: false
default: 8080
type: integer
name:
description: Override the name of the phone.
required: false
default: IP Webcam
type: string
username:
description: The username to access the phone. If username is specified then password must be also.
required: inclusive
type: string
password:
description: The password to access the phone. If password is specified then username must be also.
required: inclusive
type: string
scan_interval:
description: The update interval to use (in seconds).
required: false
default: 10
type: integer
sensors:
description: List of sensor entities to be created by this component (if supported by the phone and app).
required: false
type: list
keys:
audio_connections:
description: The audio connections
battery_level:
description: The battery level
battery_temp:
description: The battery temperature
battery_voltage:
description: The battery voltage
light:
description: The light level
motion:
description: Analog (not binary) amount of motion detected
pressure:
description: The current pressure
proximity:
description: The proximity
sound:
description: The sound level
video_connections:
description: The video connections
switches:
description: List of switch entities to be created by this component.
required: false
type: list
keys:
exposure_lock:
description: Control the exposure lock
ffc:
description: Control the front-facing camera
focus:
description: Control the focus
gps_active:
description: Control the GPS
motion_detect:
description: Control the motion detector
night_vision:
description: Control the night vision
overlay:
description: Control the overlay
torch:
description: Control the torch
whitebalance_lock:
description: Control the white balance lock
video_recording:
description: Control the video recording
motion_sensor:
description: Create a binary_sensor.<name>_motion_active entity. Note that `auto_discovery` may also create this sensor.
required: false
type: boolean
default: false
{% endconfiguration %}
{% include integrations/config_flow.md %}
<div class='note'>
You need to enable logging in the Android app (`Data logging` > `Enable data logging`) if you wish to see the sensor states in Home Assistant. The sensor states stay as `unknown`, until this is enabled.
</div>
## Full example
```yaml
# Example configuration.yaml entry
android_ip_webcam:
- host: 192.168.1.202
port: 8000
sensors:
- audio_connections
- battery_level
- battery_temp
- battery_voltage
- light
- motion
- pressure
- proximity
- sound
- video_connections
switches:
- exposure_lock
- ffc
- focus
- gps_active
- motion_detect
- night_vision
- overlay
- torch
- whitebalance_lock
- video_recording
- host: 192.168.1.203
port: 8000
sensors:
- light
switches:
- torch
```
## Alternate Configuration Method
The configuration described above will cause the `android_ip_webcam` binary sensor platform to automatically create and configure the devices. Alternatively you can omit the `android_ip_webcam` component from your `configuration.yaml` file and add individual devices instead.
### Binary Sensor
You can setup the binary motion sensor with the following in your `configuration.yaml` file:
{% raw %}
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: rest
name: Kitchen Motion
device_class: motion
resource: http://IP_ADDRESS:PORT/sensors.json?sense=motion_active
value_template: "{{ value_json.motion_active.data[0][1][0] | round(0) }}"
```
{% endraw %}
### Camera
To enable only the camera in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: mjpeg
mjpeg_url: http://IP_ADDRESS:PORT/video
```
### Other Sensors
You can setup your own sensors by examining the JSON file from the webcam server: `http://IP:8080/sensors.json`

15
source/_integrations/anthemav.markdown
View File

@ -18,9 +18,21 @@ Both [Anthem]'s current and last generation of A/V Receivers and Processors supp
## Supported Models
* [MRX 520](https://www.anthemav.com/products-current/series=mrx-series-gen3/model=mrx-520/page=overview), [MRX 720](https://www.anthemav.com/products-current/collection=performance/model=mrx-720/page=overview), [MRX 1120](https://www.anthemav.com/products-current/collection=performance/model=mrx-1120/page=overview), and [AVM 60](https://www.anthemav.com/products-current/model=avm-60/page=overview)
### A/V Receiver
* [MRX 540](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-540/page=overview), [MRX 740](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-740/page=overview), [MRX 1140](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-1140/page=overview)
* [MRX 520](https://www.anthemav.com/products-current/series=mrx-series-gen3/model=mrx-520/page=overview), [MRX 720](https://www.anthemav.com/products-current/collection=performance/model=mrx-720/page=overview), [MRX 1120](https://www.anthemav.com/products-current/collection=performance/model=mrx-1120/page=overview)
* [MRX 310](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-310/page=overview), [MRX 510](https://www.anthemav.com/products-archived/series=mrx-series/model=mrx-510/page=overview), [MRX 710](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-710/page=overview)
### A/V Processor
* [AVM 60](https://www.anthemav.com/products-current/model=avm-60/page=overview)
### Distribution Solution
* [MDX 8](https://www.anthemav.com/products-current/type=distribution/model=mdx-8/page=overview), [MDX 16](https://www.anthemav.com/products-current/type=distribution/model=mdx-16/page=overview)
* Martin Logan [MDA 8](https://www.martinlogan.com/en/product/mda8), [MDA 16](https://www.martinlogan.com/en/product/mda16)
If your model is not on the list then give it a test, if everything works correctly then add it to the list by clicking on the **Edit this page on GitHub** link above.
Support is provided through the Python [anthemav] module. Older, RS-232 serial-based units like the [D2v series](https://www.anthemav.com/products-archived/model=d2v/page=overview) use a different protocol entirely and are not currently supported.
@ -41,7 +53,6 @@ port:
* The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls.
* Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
* Only Zone 1 is currently supported.
<div class='note warning'>

19
source/_integrations/august.markdown
View File

@ -103,6 +103,25 @@ If you have an August Keypad, once you have enabled the August component, you sh
- Keypad Battery
## Integration with Yale Access Bluetooth
Following Assa Abloy, Yale's parent company, purchasing August in 2017, most newer devices use the Yale Access branding.
The [Yale Access Bluetooth](/integrations/yalexe_ble) provides local control over Bluetooth of many Yale Access locks and some August locks that use the same system.
For locks that support the Yale Access system, the August integration can keep your offline access keys up to date to ensure you can operate your lock over Bluetooth. The following requirements must be met for the offline key updates to work:
- The August integration must support the lock.
- The [Yale Access Bluetooth integration](/integrations/yalexe_ble) must support the lock.
- The Bluetooth integration must be active and functional.
- The lock must be discoverable by the [Yale Access Bluetooth integration](/integrations/yalexe_ble).
- The account logged in with the August integration must have the offline keys.
### Troubleshooting offline keys updates
- If you do not know which account has the offline keys, configure August integration with each different Owner account until you find the one that holds the keys. You may need to make a new owner account and grant the account access to your lock to force the keys to synchronize with the cloud service.
- Ensure the lock is in range and discoverable by the [Yale Access Bluetooth integration](/integrations/yalexe_ble).
## Presence Detection with Lock Operation
Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below automation example (added to `automations.yaml`) will trigger when the user named “John Doe” in August locks or unlocks the door from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by August.

28
source/_integrations/august_ble.markdown Normal file
View File

@ -0,0 +1,28 @@
---
title: August Bluetooth
description: Instructions on how to integrate August Bluetooth locks into Home Assistant.
ha_category:
- Binary Sensor
- Lock
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: august_ble
ha_config_flow: true
ha_platforms:
- binary_sensor
- lock
- sensor
ha_integration_type: integration
ha_supporting_domain: yalexs_ble
ha_supporting_integration: Yale Access Bluetooth
---
Integrates [August](https://august.com/) locks over Bluetooth into Home Assistant.
Following Assa Abloy, Yale's parent company, purchasing August in 2017, most newer devices use the Yale Access branding.
{% include integrations/supported_brand.md %}

20
source/_integrations/awair.markdown
View File

@ -5,7 +5,7 @@ ha_category:
- Health
ha_config_flow: true
ha_release: 0.84
ha_iot_class: Cloud Polling
ha_iot_class: Local Polling
ha_codeowners:
- '@ahayworth'
- '@danielsjf'
@ -13,17 +13,29 @@ ha_domain: awair
ha_platforms:
- sensor
ha_integration_type: integration
ha_zeroconf: true
ha_dhcp: true
---
The Awair integration will fetch data from your [Awair devices](https://getawair.com).
You will need to request access to the Awair API and obtain an access token from the Awair [Developer Console](https://developer.getawair.com/). It is free, but getting a token can take up to 24 hours.
## Prerequisites
### Connect locally (preferred)
When connecting locally, the integration will poll the device every 30 seconds. Awair provides a [list of devices](https://support.getawair.com/hc/en-us/articles/360049221014-Awair-Element-Local-API-Feature#h_01F40FB3ETMR4TZKPVXJNE86HQ) that support the Local API. This API must be enabled via the Awair app via [these steps](https://support.getawair.com/hc/en-us/articles/360049221014-Awair-Element-Local-API-Feature#h_01F40FBBW5323GBPV7D6XMG4J8). If you add new Awair devices to your home, you must follow these steps again.
### Connect via the cloud
When connecting via the cloud, data is summarized over 5-minute intervals. All devices are supported. You will need to request access to the Awair API and obtain an access token from the Awair [Developer Console](https://developer.getawair.com/). It is free, but getting a token can take up to 24 hours.
This integration refreshes once every 5 minutes, based on the [default per-device quota](https://docs.developer.getawair.com/?version=latest#tiers--quotas) of 300 API calls per day.
{% include integrations/config_flow.md %}
## Available Sensors
The integration will fetch data from each device linked to your Awair developer account. The following sensors are supported:
The integration will fetch data from each device. The following sensors are supported:
* Temperature
* Humidity
@ -35,5 +47,3 @@ The integration will fetch data from each device linked to your Awair developer
* Luminescence
Not all devices support all sensors; consult Awair's documentation to find out what sensors are present on your device. For first-generation Awair devices with a "dust" sensor, the integration will create identical PM2.5 and PM10 sensors (which reflects the capabilities of the sensor - it can detect dust between PM2.5 and PM10 but cannot differentiate between them).
This integration refreshes once every 5 minutes, based on the [default per-device quota](https://docs.developer.getawair.com/?version=latest#tiers--quotas) of 300 API calls per day.

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

@ -99,6 +99,10 @@ device:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`."
required: false
type: [list, map]
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

27
source/_integrations/bluemaestro.markdown Normal file
View File

@ -0,0 +1,27 @@
---
title: BlueMaestro
description: Instructions on how to integrate BlueMaestro devices into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: bluemaestro
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
---
Integrates [BlueMaestro](https://www.sigmawit.com/) devices into Home Assistant.
## Supported devices
- Tempo Disc THD
- Tempo Disc THPD
The BlueMaestro integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
{% include integrations/config_flow.md %}

71
source/_integrations/bluetooth.markdown
View File

@ -11,6 +11,8 @@ ha_codeowners:
- '@bdraco'
ha_integration_type: integration
ha_config_flow: true
ha_platforms:
- 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.
@ -59,35 +61,72 @@ If you experience an unreliable Bluetooth connection, installing a short USB ext
### Known working adapters
- ASUS USB-BT400
- ASUS USB-BT500
- Avantree DG45
- Kinivo BTD-400
- Maxuni BT-501
- SUMEE BT501
- UGREEN CM390
- XDO BT802 (Long Range)
- ZEXMTE BT-505 (Long Range)
- ZEXMTE BT-DG54
- ASUS USB-BT400 [BCM20702A1]
- ASUS USB-BT500 [RTL8761BU]
- Avantree DG45 [RTL8761BU]
- EDUP LOVE EP-B3536 [RTL8761BU] (Long Range)
- Feasycom FSC-BP119 [CSR8510A10] (Long Range)
- Kinivo BTD-400 [BCM20702A1]
- Maxuni BT-501 [RTL8761B]
- SUMEE BT501 [RTL8761B]
- UGREEN CM390 [RTL8761BU]
- XDO BT802 [RTL8761BU] (Long Range)
- ZEXMTE BT-505 [RTL8761BU] (Long Range)
- ZEXMTE BT-DG54 [RTL8761BU]
### Unsupported adapters
- tp-link UB400 - Frequent connection failures
- tp-link UB500 - Frequent connection failures
- tp-link UB400 [BCM20702A1] - Frequent connection failures with active connections
- tp-link UB500 [RTL8761BU] - Frequent connection failures with active connections
## Multiple adapters
Support for multiple local Bluetooth adapters is available on Linux systems only. Place adapters far enough away from each other to reduce interference.
The following methods are known to work to add multiple adapters:
- Long USB Extension cables
- USB-Ethernet extenders
- [USB/IP](http://usbip.sourceforge.net/)
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 on Linux can be enabled in the options flow per adapter if the host system runs BlueZ 4.63 or later with experimental features enabled.
Many integrations require active scanning and may not function when scanning is passive.
{% include integrations/option_flow.md %}
### Multiple adapters
## Remote adapters
Support for multiple Bluetooth adapters is available on Linux systems only. Select the adapter you wish to use via the options flow on the integrations page. The adapter selection only affects integrations that use the Bluetooth integration interfaces.
The Bluetooth integration supports receiving advertisement data from external adapters for devices and sensors that do not need an active connection. The number of remote scanners is limited only by the performance of the host system.
## Integrations that require exclusive use of the Bluetooth Adapter
The following remote adapters are supported:
- [ESPHome](https://esphome.io)
### ESPHome requirements
Devices with an ESP32 chip running ESPHome must enable the `bluetooth_proxy` component and be added to Home Assistant before advertisements are forwarded.
```yaml
esp32_ble_tracker:
bluetooth_proxy:
```
Many integrations require an active scan for discovery. By default, the [ESPHome tracker](https://esphome.io/components/esp32_ble_tracker.html) runs in active mode. Adding ESPHome remotes that have active scanning disabled may cause some integrations to malfunction.
## Troubleshooting
### Integrations that require exclusive use of the Bluetooth Adapter
While newer integrations can share the Bluetooth Adapter, some legacy integrations require exclusive use of the adapter. Enabling this integration may prevent an integration that has not been updated to use newer methods from functioning.
Deleting the config entry for this integration will release control of the adapter and allow another integration to gain exclusive use of the Bluetooth adapter. If you have manually added `bluetooth:` to your `configuration.yaml`, you must also remove it to prevent the configuration from being recreated. Consider adding a second Bluetooth adapter on Linux systems if you need to continue using legacy integrations, as more integrations will move to use the Bluetooth integration in the future.
## Bluetooth interference with other devices
### Bluetooth interference with other devices
Devices that are using the 2.4 GHz band, like Wi-Fi, Zigbee, and USB3 devices (and their cable connections) are known to affect Bluetooth reception. Especially external SSD drives with USB3 cables are known to block the Bluetooth signal. Also, metal casings can decrease the Bluetooth performance of internal Bluetooth Adapters.

205
source/_integrations/braviatv.markdown
View File

@ -17,23 +17,14 @@ ha_platforms:
ha_integration_type: integration
---
The `braviatv` platform allows you to control a [Sony Bravia TV](https://www.sony.com/).
The Bravia TV 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. A more generic method for older TVs connected to a Raspberry Pi with HDMI-CEC is explained further [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).
{% include integrations/config_flow.md %}
## Common Issues
### Previous Configurations
To ensure a clean re-configuration, please perform the following steps:
- Remove the entities you are reconfiguring from Home Assistant.
- Restart Home Assistant.
- Perform the [TV does not generate new pin](#tv-does-not-generate-new-pin) steps.
- Retry [configuration](#configuration).
### TV does not generate new pin
If you have previously set up your TV with any Home Assistant instances, 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:
@ -43,173 +34,41 @@ If you have previously set up your TV with any Home Assistant instances, you mus
## Remote
When the integration is configured, two entities will be created: a `media_player` and a `remote`. The remote allows you to send key commands to your TV with the `remote.send_command` service.
The integration supports `remote` platform. The remote allows you to send key commands to your TV with the `remote.send_command` service.
Some of the known valid key values are (may depend on your TV model):
The commands that can be sent to the TV depends on the model of your TV. To display a list of supported commands for your TV, call the service `remote.send_command` with non-valid command (e.g. `Test`). A list of available commands will be displayed in [Home Assistant System Logs](https://my.home-assistant.io/redirect/logs).
- `Num1`
- `Num2`
- `Num3`
- `Num4`
- `Num5`
- `Num6`
- `Num7`
- `Num8`
- `Num9`
- `Num0`
- `Num11`
- `Num12`
- `Enter`
- `GGuide`
- `ChannelUp`
- `ChannelDown`
- `VolumeUp`
- `VolumeDown`
- `Mute`
- `TvPower`
- `Audio`
- `MediaAudioTrack`
- `Tv`
- `Input`
- `TvInput`
- `TvAntennaCable`
- `WakeUp`
- `PowerOff`
- `Sleep`
- `Right`
- `Left`
- `SleepTimer`
- `Analog2`
- `TvAnalog`
- `Display`
- `Jump`
- `PicOff`
- `PictureOff`
- `Teletext`
- `Video1`
- `Video2`
- `AnalogRgb1`
- `Home`
- `Exit`
- `PictureMode`
- `Confirm`
- `Up`
- `Down`
- `ClosedCaption`
- `Component1`
- `Component2`
- `Wide`
- `EPG`
- `PAP`
- `TenKey`
- `BSCS`
- `Ddata`
- `Stop`
- `Pause`
- `Play`
- `Rewind`
- `Forward`
- `DOT`
- `Rec`
- `Return`
- `Blue`
- `Red`
- `Green`
- `Yellow`
- `SubTitle`
- `CS`
- `BS`
- `Digital`
- `Options`
- `Media`
- `Prev`
- `Next`
- `DpadCenter`
- `CursorUp`
- `CursorDown`
- `CursorLeft`
- `CursorRight`
- `ShopRemoteControlForcedDynamic`
- `FlashPlus`
- `FlashMinus`
- `DemoMode`
- `Analog`
- `Mode3D`
- `DigitalToggle`
- `DemoSurround`
- `AD`
- `AudioMixUp`
- `AudioMixDown`
- `PhotoFrame`
- `Tv_Radio`
- `SyncMenu`
- `Hdmi1`
- `Hdmi2`
- `Hdmi3`
- `Hdmi4`
- `TopMenu`
- `PopUpMenu`
- `OneTouchTimeRec`
- `OneTouchView`
- `DUX`
- `FootballMode`
- `iManual`
- `Netflix`
- `Assists`
- `FeaturedApp`
- `FeaturedAppVOD`
- `GooglePlay`
- `ActionMenu`
- `Help`
- `TvSatellite`
- `WirelessSubwoofer`
- `AndroidMenu`
{% details "Some commonly used commands" %}
## Extra configuration for the integration
- Up
- Down
- Left
- Right
- Confirm
- Return
- Home
- Exit
- Rewind
- Forward
- ActionMenu
- SyncMenu
- Num0
- Num1
- Num2
- Num3
- Num4
- Num5
- Num6
- Num7
- Num8
- Num9
The integration allows you to change ignored TV sources from the front end. Enter which Sony Bravia TV integration you want to change options on and press the cog wheel.
{% enddetails %}
### For TVs older than 2013
{% include integrations/option_flow.md %}
<div class='note warning'>
The integration allows you to customize the list of ignored sources.
This is not part of the Bravia TV integration. Extra Configuration does not apply to the steps below.
## For TVs older than 2013
</div>
Users of TVs older than 2013 have another option for controlling their TV via Home Assistant.
### Using HDMI-CEC
If you have a Raspberry Pi connected to your TV:
{% raw %}
```yaml
switch:
- platform: command_line
switches:
tv_rpi:
command_on: ssh root@[IP] "echo 'on 0' | cec-client -s"
command_off: ssh root@[IP] "echo 'standby 0' | cec-client -s"
command_state: ssh root@[IP] "echo 'pow 0' | cec-client -s |grep 'power status:'"
value_template: '{{ value == "power status: on" }}'
```
{% endraw %}
Using `cec-client` is a great method to turn your TV off/on, however the trade off is if you're using Kodi, it will no longer be able to control your TV using the TV Remote.
This is because only one process can control the CEC functionality within the Raspberry Pi at a time and running the above commands terminates the functionality inside libCEC within Kodi. Kodi must be restarted for TV remove functionality to work again.
#### Workaround
If your desire is only to turn on your TV, the following "workaround" may be desirable:
Change the 'on' command to a restart for Kodi. This doesn't reboot the Kodi device.
Restarting Kodi will trigger a HDMI-CEC event to bring the TV out of standby. The following can replace your TV 'on' command.
```yaml
command_on: ssh root@[IP] "systemctl restart kodi"
```
Users of TVs older than 2013 can control their devices using [HDMI-CEC](/integrations/hdmi_cec/), [Broadlink](/integrations/broadlink/) or [Kodi](/integrations/kodi/) integrations.

32
source/_integrations/bthome.markdown Normal file
View File

@ -0,0 +1,32 @@
---
title: BTHome
description: Instructions on how to integrate BThome BLE devices into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@Ernst79'
ha_domain: bthome
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
---
Integrates [BTHome](https://bthome.io/) BLE devices into Home Assistant.
{% include integrations/config_flow.md %}
The BTHome BLE integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
BTHome is an energy effective but flexible BLE format to broadcast data with Bluetooth and allows you to create your own DIY BLE sensors. More information about the BTHome BLE format and projects that use the format can be found on the [BTHome website](https://bthome.io/).
## Supported sensor measurements
The current release only supports sensors, no binary sensors.
## Bindkey
When using encryption for your BTHome sensor, you will promted 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).

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

@ -96,6 +96,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

13
source/_integrations/camera.mqtt.markdown
View File

@ -98,6 +98,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false
@ -132,10 +136,10 @@ enabled_by_default:
type: boolean
default: true
encoding:
description: The encoding of the image payloads received. Set to `"b64"` to enable base64 decoding of image payload. If not set, or if set to `null`, the image payload must be raw binary data.
description: The encoding of the payloads received. Set to `""` to disable decoding of incoming payload. Use `image_encoding` to enable `Base64` decoding on `topic`.
required: false
type: string
default: null
default: "utf-8"
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
@ -145,6 +149,11 @@ icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false
type: icon
image_encoding:
description: The encoding of the image payloads received. Set to `"b64"` to enable base64 decoding of image payload. If not set, the image payload must be raw binary data.
required: false
type: string
default: None
json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`."
required: false

4
source/_integrations/climate.mqtt.markdown
View File

@ -122,6 +122,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false

4
source/_integrations/cover.mqtt.markdown
View File

@ -109,6 +109,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.'
required: false
type: list
hw_version:
description: "The hardware version of the device."
required: false
type: string
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false

1
source/_integrations/deconz.markdown
View File

@ -33,6 +33,7 @@ ha_platforms:
- lock
- number
- scene
- select
- sensor
- siren
- switch

1
source/_integrations/default_config.markdown
View File

@ -21,6 +21,7 @@ This integration is a meta-component and configures a default set of integration
- [DHCP Discovery](/integrations/dhcp/) (`dhcp`)
- [Energy](/integrations/energy/) (`energy`)
- [Frontend](/integrations/frontend/) (`frontend`)
- [Hardware](/integrations/hardware/) (`hardware`)
- [History](/integrations/history/) (`history`)
- [Home Assistant Alerts](/integrations/homeassistant_alerts) (`homeassistant_alerts`)
- [Home Assistant Cloud](/integrations/cloud/) (`cloud`)

4
source/_integrations/deutsche_bahn.markdown
View File

@ -11,6 +11,10 @@ ha_platforms:
ha_integration_type: integration
---
<div class='note warning'>
This integration is pending removal from Home Assistant and will be no longer available as of Home Assistant 2022.11.
</div>
The `deutsche_bahn` sensor will give you the departure time of the next train for the given connection. In case of a delay, the delay is also shown. Additional details are used to inform about, e.g., the type of the train, price, and if it is on time.
To enable this sensor, add the following lines to your `configuration.yaml` file:

4
source/_integrations/device_tracker.mqtt.markdown
View File

@ -133,6 +133,10 @@ device:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`."
required: false
type: [list, map]
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

1
source/_integrations/ecovacs.markdown
View File

@ -8,6 +8,7 @@ ha_iot_class: Cloud Push
ha_release: 0.77
ha_codeowners:
- '@OverloadUT'
- '@mib1185'
ha_domain: ecovacs
ha_platforms:
- vacuum

31
source/_integrations/ecowitt.markdown Normal file
View File

@ -0,0 +1,31 @@
---
title: Ecowitt
description: Instructions on how to integrate Ecowitt Weather Station within Home Assistant.
ha_category:
- Binary Sensor
- Sensor
ha_release: 2022.9
ha_iot_class: Local Push
ha_domain: ecowitt
ha_config_flow: true
ha_codeowners:
- '@pvizeli'
ha_platforms:
- binary_sensor
- diagnostics
- sensor
ha_integration_type: integration
---
{% include integrations/config_flow.md %}
## Ecowitt Weather Station configuration
The following steps must be performed to set up this integration. For security reason, use the token path that you get from the Home Assistant config flow.
1. Use the Ecowitt App (on your phone) or access the Ecowitt WebUI in a browser at the station IP address.
2. Pick your station -> Menu Others -> DIY Upload Servers.
3. Hit next and select 'Customized'
4. Pick the protocol Ecowitt, and put in the ip/hostname of your Home Assistant server.
5. Path have to match, you can copy with secure token /.
6. Save configuration.

48
source/_integrations/escea.markdown Normal file
View File

@ -0,0 +1,48 @@
---
title: Escea
description: Instructions on how to integrate Escea fireplaces with Home Assistant.
ha_category:
- Climate
ha_release: 2022.9
ha_iot_class: Local Push
ha_config_flow: true
ha_codeowners:
- '@lazdavila'
ha_domain: escea
ha_homekit: true
ha_platforms:
- climate
ha_integration_type: integration
---
The Escea integration allows monitoring and control of local [Escea](https://escea.com/) fireplaces. These fireplaces are manufactured in New Zealand and sold throughout Australia and New Zealand.
## Supported hardware
Support all current Escea fireplaces with the Smart Heat feature, including the DF, DL, DS, and DX series.
Though these fireplaces are supported, they can only be integrated if they were connected via Ethernet when installed (i.e., these fireplaces do not support Wi-Fi).
{% include integrations/config_flow.md %}
## Network settings
The Escea system uses UDP over the local network to find and communicate with Escea devices. For this to work properly, UDP port 3300 must be available for broadcasting and messaging fireplaces, and similarly, UDP port 3300 must be available to listen for responses. The integration currently listens on `0.0.0.0` and broadcasts to all broadcast IPv4 local addresses, which is not configurable.
## Master controller
Fireplace on / off, fan settings, and desired temperature settings are supported. The current room temperature, as measured by the fireplace, is also supported.
## Debugging
If you're trying to track down issues with the component, set up logging for it:
```yaml
# Example configuration.yaml with logging for Escea
logger:
default: warning
logs:
homeassistant.components.escea: debug
pescea: debug
```
This will help you to find network connection issues etc.

4
source/_integrations/fan.mqtt.markdown
View File

@ -104,6 +104,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: [list, map]
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

12
source/_integrations/file_upload.markdown Normal file
View File

@ -0,0 +1,12 @@
---
title: File Upload
description: File upload integration supports various frontend features within Home Assistant
ha_release: 2022.9
ha_quality_scale: internal
ha_domain: file_upload
ha_integration_type: integration
ha_codeowners:
- '@home-assistant/core'
---
The file upload integration allows various features in the frontend to upload files.

1
source/_integrations/flume.markdown
View File

@ -9,6 +9,7 @@ ha_config_flow: true
ha_codeowners:
- '@ChrisMandich'
- '@bdraco'
- '@jeeftor'
ha_domain: flume
ha_dhcp: true
ha_platforms:

7
source/_integrations/fritzbox.markdown
View File

@ -15,6 +15,7 @@ ha_ssdp: true
ha_platforms:
- binary_sensor
- climate
- cover
- diagnostics
- light
- sensor
@ -31,6 +32,7 @@ There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Climate
- Cover
- Light
- Sensor
- Switch
@ -47,6 +49,7 @@ There is currently support for the following device types within Home Assistant:
- [FRITZ!DECT 500](https://en.avm.de/products/fritzdect/fritzdect-500/)
- [Eurotronic Comet DECT](https://eurotronic.org/produkte/dect-ule-heizkoerperthermostat/comet-dect/)
- [Magenta SmartHome LED E27](https://www.smarthome.de/geraete/smarthome-led-lampe-e27-farbig-weiss)
- [Rademacher RolloTron DECT 1213](https://www.rademacher.de/shop/rollladen-sonnenschutz/elektrischer-gurtwickler/rollotron-dect-1213)
{% include integrations/config_flow.md %}
@ -108,3 +111,7 @@ To get AVM FRITZ!DECT lightbulbs (e.g., FRITZ!DECT 500) follow the [configuratio
<div class='note'>
The FRITZ!DECT 500 lightbulb supports only 36 colors. When a color is picked in home assistant that is not supported by the device, a color that comes close will be activated.
</div>
## Cover
To get AVM FRITZ!DECT compatible covers (e.g., Rademacher RolloTron DECT 1213) follow the [configuration instructions](#configuration) above.

69
source/_integrations/fully_kiosk.markdown Normal file
View File

@ -0,0 +1,69 @@
---
title: Fully Kiosk Browser
description: Instructions on how to integrate Fully Kiosk Browser with Home Assistant
ha_category:
- Binary Sensor
- Sensor
- Switch
ha_release: 2022.9
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@cgarwood'
ha_domain: fully_kiosk
ha_platforms:
- binary_sensor
- button
- diagnostics
- media_player
- number
- sensor
- switch
ha_integration_type: integration
ha_dhcp: true
---
[Fully Kiosk Browser](https://www.fully-kiosk.com) is a powerful kiosk browser for Android devices. It provides a number of features for monitoring and controlling your Android device. This integration gives you access to control your device and view the status in Home Assistant.
## Requirements
This integration requires the Fully Remote Admin feature to be enabled in the Fully Kiosk Browser app. This feature requires the paid Fully Plus license. You can test it out for free, but Fully Kiosk Browser will display a watermark on your device.
You will need the IP address of your device, and the Fully Remote Admin password you set in the Fully Kiosk Browser app.
{% include integrations/config_flow.md %}
## Capabilities
The following is available as sensors:
- Device plugged in
- Kiosk mode enabled/disabled
- Battery level
- Current page
- Current foreground app
- Device storage space available
- Device RAM available
The following controls are available:
- Bring Fully Kiosk to the foreground
- Send Fully Kiosk to the background
- Load the start URL
- Restart the Fully Kiosk Browser app
- Reboot your device (requires root)
- Maintenance mode on/off
- Lock/unlock kiosk mode
- Motion detection on/off
- Screensaver on/off
- Screensaver timer
- Screensaver brightness
- Screen on/off
- Screen off timer
- Screen brightness
- Play and stop media files
- Set device volume
<div class='note warning'>
The Fully Kiosk Browser app does not provide feedback on the device volume or media playback status, so we are unable to display the current volume level or playback status.
</div>

1
source/_integrations/goodwe.markdown
View File

@ -12,6 +12,7 @@ ha_codeowners:
- '@starkillerOG'
ha_domain: goodwe
ha_platforms:
- button
- number
- select
- sensor

2
source/_integrations/govee_ble.markdown
View File

@ -23,6 +23,7 @@ The Govee BLE integration will automatically discover devices once the [Bluetoot
## Supported devices
- H5071 Hygrometer Thermometer
- H5072 Hygrometer Thermometer
- H5074 Hygrometer Thermometer
- [H5075 Bluetooth Hygrometer Thermometer](https://us.govee.com/collections/thermo-hydrometer/products/govee-bluetooth-hygrometer-thermometer-h5075)
@ -32,4 +33,5 @@ The Govee BLE integration will automatically discover devices once the [Bluetoot
- H5179 Hygrometer Thermometer
- 5181 Meat Thermometer
- 5183 Meat Thermometer
- 5184 Meat Thermometer
- 5185 Meat Thermometer

2
source/_integrations/hdmi_cec.markdown
View File

@ -10,6 +10,8 @@ ha_platforms:
- media_player
- switch
ha_integration_type: integration
ha_codeowners:
- '@inytar'
---
The `hdmi_cec` integration provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.

4
source/_integrations/humidifier.mqtt.markdown
View File

@ -106,6 +106,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: [list, map]
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

57
source/_integrations/hunterdouglas_powerview.markdown
View File

@ -51,17 +51,21 @@ Calling the update entity service (`homeassistant.update_entity`) on a shade ent
If your shade is not listed please raise a feature request on the community forum.
</div>
| Name (Type) | Capabilities |
| :------------------------------------- | :------------------------------ |
| Roman (4) | Bottom Up |
| Bottom Up (5) | Bottom Up |
| Duette (6) | Bottom Up |
| Duette, Top Down Bottom Up (8) | Top Down, Bottom Up |
| Silhouette (23) | 90° Tilt when closed |
| M25T Roller Blind (42) | Bottom Up |
| Twist (44) | 180° Tilt when closed |
| Pleated, Top Down Bottom Up (47) | Top Down, Bottom Up |
| AC Roller (49) | Bottom Up |
| Name (Type) | Capabilities |
| :---------------------------------------- | :------------------------------ |
| Roman (4) | Bottom Up |
| Bottom Up (5) | Bottom Up |
| Duette (6) | Bottom Up |
| Duette, Top Down Bottom Up (8) | Top Down, Bottom Up |
| Duette DuoLite, Top Down Bottom Up (9) | Top Down, Bottom Up |
| Silhouette (18) | 90° Tilt when closed |
| Silhouette (23) | 90° Tilt when closed |
| Duette Architella, Top Down Bottom Up (9) | Top Down, Bottom Up |
| M25T Roller Blind (42) | Bottom Up |
| Facette (43) | 90° Tilt when closed |
| Twist (44) | 180° Tilt when closed |
| Pleated, Top Down Bottom Up (47) | Top Down, Bottom Up |
| AC Roller (49) | Bottom Up |
### Devices with limited functionality
@ -69,23 +73,20 @@ If your shade is not listed please raise a feature request on the community foru
These devices are currently still being tested. We ask you wait patiently while this completes. Until this is completed these may perform basic or slightly odd functionality.
</div>
| Name (Type) | Capabilities |
| :------------------------------------- | :------------------------------ |
| Top Down (7) | Top Down |
| Duette DuoLite, Top Down Bottom Up (9) | Top Down, Bottom Up |
| Silhouette (18) | 90° Tilt when closed |
| Silhouette Duolite (38) | Dual Shade Blackout + 90° Tilt |
| Facette (43) | 90° Tilt when closed |
| Venetian, Tilt Anywhere (51) | 180° Tilt Anywhere |
| Vertical Slats, Left Stack (54) | 180° Tilt when closed, Vertical |
| Vertical Slats, Right Stack (55) | 180° Tilt when closed, Vertical |
| Vertical Slats, Split Stack (56) | 180° Tilt when closed, Vertical |
| Venetian, Tilt Anywhere (62) | 180° Tilt Anywhere, Vertical |
| Vignette Duolite (65) | Dual Shade Blackout |
| Curtain, Left Stack (69) | 180° Tilt when closed, Vertical |
| Curtain, Right Stack (70) | 180° Tilt when closed, Vertical |
| Curtain, Split Stack (71) | 180° Tilt when closed, Vertical |
| Duolite Lift (79) | Dual Shade Blackout |
| Name (Type) | Capabilities |
| :---------------------------------------- | :------------------------------ |
| Top Down (7) | Top Down |
| Silhouette Duolite (38) | Dual Shade Blackout + 90° Tilt |
| Venetian, Tilt Anywhere (51) | 180° Tilt Anywhere |
| Vertical Slats, Left Stack (54) | 180° Tilt when closed, Vertical |
| Vertical Slats, Right Stack (55) | 180° Tilt when closed, Vertical |
| Vertical Slats, Split Stack (56) | 180° Tilt when closed, Vertical |
| Venetian, Tilt Anywhere (62) | 180° Tilt Anywhere, Vertical |
| Vignette Duolite (65) | Dual Shade Blackout |
| Curtain, Left Stack (69) | 180° Tilt when closed, Vertical |
| Curtain, Right Stack (70) | 180° Tilt when closed, Vertical |
| Curtain, Split Stack (71) | 180° Tilt when closed, Vertical |
| Duolite Lift (79) | Dual Shade Blackout 90° Tilt |
## Capabilities Information

12
source/_integrations/inkbird.markdown
View File

@ -19,11 +19,13 @@ Integrates [INKBIRD](https://www.inkbird.com/) devices into Home Assistant.
## Supported devices
- [Bluetooth Thermometer IBS-TH1](https://inkbird.com/products/bluetooth-thermometer-ibs-th1)
- [Temperature and humidity Hygrometer IBS-TH2](https://inkbird.com/products/hygrometer-ibs-th2)
- [Bluetooth Smart Sensor ITH-12S](https://inkbird.com/products/bluetooth-smart-sensor-ith-12s)
- [Bluetooth Grill Thermometer IBT-4XS](https://inkbird.com/products/bluetooth-grill-thermometer-ibt-4xs)
- [Bluetooth Grill Thermometer IBT-2X](https://inkbird.com/products/bluetooth-grill-thermometer-ibt-2x)
- [INKBIRD Bluetooth Thermometer IBS-TH1](https://inkbird.com/products/bluetooth-thermometer-ibs-th1)
- [INKBIRD Temperature and humidity Hygrometer IBS-TH2](https://inkbird.com/products/hygrometer-ibs-th2)
- [INKBIRD Bluetooth Smart Sensor ITH-12S](https://inkbird.com/products/bluetooth-smart-sensor-ith-12s)
- [INKBIRD Bluetooth Grill Thermometer IBT-4XS](https://inkbird.com/products/bluetooth-grill-thermometer-ibt-4xs)
- [INKBIRD Bluetooth Grill Thermometer IBT-2X](https://inkbird.com/products/bluetooth-grill-thermometer-ibt-2x)
- [Nutrichef Smart Wireless Grill Thermometer](https://nutrichefkitchen.com/products/pwirbbq40)
- [Nutrichef Smart Bluetooth BBQ Grill Thermometer](https://nutrichefkitchen.com/products/pwirbbq80-1)
The INKBIRD integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.

1
source/_integrations/islamic_prayer_times.markdown
View File

@ -22,6 +22,7 @@ This platform calculates prayer times using the following calculation methods:
- Islamic Society of North America
- Muslim World League
- Umm Al-Qura University in Makkah
- Moonsighting
{% include integrations/config_flow.md %}

14
source/_integrations/iss.markdown
View File

@ -1,26 +1,24 @@
---
title: International Space Station (ISS)
description: Know if or when ISS will be above your home location
description: Show the ISS location and how many people are in space
ha_category:
- Binary Sensor
- Sensor
ha_iot_class: Cloud Polling
ha_release: 0.36
ha_domain: iss
ha_platforms:
- binary_sensor
- sensor
ha_codeowners:
- '@DurgNomis-drol'
ha_config_flow: true
ha_integration_type: integration
---
The `iss` platform uses the
The International Space Station (ISS) integration uses the
[Open Notify API](http://open-notify.org/Open-Notify-API/ISS-Location-Now/)
to let you know if the station is above your home location.
This means that ISS is 10° above the horizon of your home.
to let you know where the station is.
You can check in the attributes of the sensor to see the timestamp for the next
rise of the station, its current coordinates, and the number of people in space.
It will also tell you how many people are in space.
{% include integrations/config_flow.md %}

4
source/_integrations/jewish_calendar.markdown
View File

@ -76,10 +76,12 @@ Time sensor states are represented as ISO8601 formatted *UTC time*.
- `first_light`: First light of dawn (Alot Hashachar - עלות השחר)
- `talit`: Earliest time for tallit and tefillin (Misheyakir - משיכיר)
- `sunrise`: Earliest time for Shacharit (Hanetz Hachama - הנץ החמה)
- `gra_end_shma`: Last time for reading of the Shma according to the Gr"a.
- `mga_end_shma`: Last time for reading of the Shma according to the MG"A.
- `gra_end_tefilla`: Last time for full shacharit according to the Gr"a.
- `mga_end_tefilla`: Last time for full shacharit according to the MG"A.
- `midday`: Half way through the day (Chatzot Hayom - חצות היום)
- `big_mincha`: Earliest time for Mincha (Mincha Gedola - מנחה גדולה)
- `little_mincha`: Preferable earliest time for Mincha (Mincha Ketana - מנחה קטנה)
- `plag_mincha`: Time of the Plag Hamincha (פלג המנחה)
@ -93,6 +95,8 @@ Time sensor states are represented as ISO8601 formatted *UTC time*.
### Binary sensors
- `issur_melacha_in_effect`: A boolean sensor indicating if melacha is currently not permitted. The value is _on_ when it is currently Shabbat or Yom Tov and _off_ otherwise.
- `erev_shabbat_hag`: A boolean sensor indicating that there is an upcoming Shabbat or Hag.
- `motzei_shabbat_hag`: A boolean sensor indicating that Shabbat or Hag has ended.
### Holiday sensor

45
source/_integrations/justnimbus.markdown Normal file
View File

@ -0,0 +1,45 @@
---
title: JustNimbus
description: Instructions on how to configure the JustNimbus integration within Home Assistant
ha_category:
- Environment
ha_release: 2022.9
ha_iot_class: Cloud Polling
ha_domain: justnimbus
ha_platforms:
- sensor
ha_config_flow: true
ha_integration_type: integration
ha_codeowners:
- '@kvanzuijlen'
---
The JustNimbus integration queries the JustNumbus API used by the JustNimbus web dashboard.
This integration allows you to collect and save data to get an historic overview of your water bag
usage.
## Prerequisites
To configure and use this integration, you need to have a
[JustNimbus water bag](https://justnimbus.com/regenwatersysteem/) (Dutch), and
you need to be subscribed for the web dashboard functionality. For this configuration, you need the
client ID from the URL. For example: `https://dashboard.justnimbus.com/api/installation/<client_id>/data`.
{% include integrations/config_flow.md %}
## Sensor Types
When configured, the integration will create twelve sensors for each configured client ID:
- Pump flow, in `L/min` (Liters/minute)
- Drink flow, in `L/min` (Liters/minute)
- Pump pressure, in `bar`
- Pump starts, a number counting the number of times the pump has started
- Pump hours, a number counting the number of hours the pump has been used
- Reservoir temperature, in `°C`
- Reservoir content, in `L` (Liters)
- Total saved, in `L` (Liters)
- Total replenished, in `L` (Liters)
- Error code
- Total use, in `L` (Liters)
- Max reservoir content, in `L` (Liters)

29
source/_integrations/lacrosse_view.markdown Normal file
View File

@ -0,0 +1,29 @@
---
title: LaCrosse View
description: Get data for LaCrosse View-connected sensors
ha_release: '2022.9'
ha_category:
- Sensor
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@IceBotYT'
ha_domain: lacrosse_view
ha_platforms:
- sensor
ha_integration_type: integration
---
[**LaCrosse View**](https://www.lacrossetechnology.com/pages/la-crosse-view) is the service provided by LaCrosse Technology that allows access to LaCrosse sensors.
<div class='note'>
If you are looking for an integration for [**Jeelink LaCrosse sensors**](/integrations/lacrosse), you can find that integration [**here**](/integrations/lacrosse).
</div>
{% include integrations/config_flow.md %}
## Supported sensors
All of the sensors on [**this page**](https://www.lacrossetechnology.com/collections/lacrosse-view-connected) are supported by this integration.

217
source/_integrations/lametric.markdown
View File

@ -1,150 +1,181 @@
---
title: LaMetric
description: Instructions on how to integrate LaMetric with Home Assistant.
description: Instructions on how to integrate LaMetric TIME with Home Assistant.
ha_category:
- Hub
- Button
- Notifications
ha_iot_class: Cloud Push
- Number
ha_iot_class: Local Polling
ha_release: 0.49
ha_codeowners:
- '@robbiet480'
- '@frenck'
ha_domain: lametric
ha_platforms:
- button
- notify
- number
ha_integration_type: integration
ha_config_flow: true
ha_ssdp: true
---
[LaMetric Time](https://lametric.com/) is a smart clock that can be used to access applications, listen to web radio and display notifications.
[LaMetric TIME](https://lametric.com/) is a smart clock that can be used to access applications, listen to web radio and display notifications.
There is currently support for the following device types within Home Assistant:
- [Notify](#notifications)
The LaMetric Time can only be accessed by authorized applications. Therefore, each application that wants to access the LaMetric time needs to be registered at the LaMetric Developer web page. Sign Up and login to the developer web page. Click the Create button in the upper right corner, then select Notification App and click Create again. Enter an app name, a description and a redirect URL. Finally, click Save to create the application. For the newly created app you will obtain a client id and a client secret that is required in the following configuration.
```yaml
# configuration.yaml example
lametric:
client_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx
client_secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
## Setup Steps
LaMetric needs an OAuth2 `client_id` and `client_secret` from the LaMetric developer portal to use it with Home Assistant.
These are the steps to take:
1. Log in with your LaMetric device account to [developer.lametric.com](https://developer.lametric.com).
2. Hit the Create button and choose [Notification](https://developer.lametric.com/applications/createsource).
3. Fill in the form. You can put almost anything in the fields, they just need to be populated:
* App Name: Home Assistant
* Description: Home Assistant
* Privacy Policy: `http://localhost/`
* Check all permission boxes
* Hit Save
4. You should be directed to your [Notification Apps list](https://developer.lametric.com/applications/sources), click on "Home Assistant", copy your client ID and client Secret and paste into the Home Assistant configuration block in the previous section.
5. Set up some notifications in Home Assistant by following the instructions on the [Lametric Notify](/integrations/lametric) page.
6. Save all configuration files and restart Home Assistant.
{% include integrations/config_flow.md %}
## Notifications
The `lametric` notification platform allows to send notification to a LaMetric device. It needs the LaMetric platform to be configured first.
You can send notifications to your LaMetric device using
the [Notifications](/integrations/notify) integration.
To enable LaMetric notifications in your installation, add the following to your `configuration.yaml` file:
Each LaMetric device added to your Home Assistant will have its own
`notify.` service. The service name matches the name of your device
as shown in your LaMetric account. For example, if you have a device
called "My LaMetric", the service would become `notify.my_lametric`.
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: lametric
```
The notification service call against an LaMetric device can take the
following, additional, optional parameters:
{% configuration %}
name:
description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
required: false
type: string
default: notify
lifetime:
description: Defines how long the message remains in LaMetric notification queue (in seconds).
required: false
type: integer
default: 10
icon:
description: An icon or animation. List of all icons available at [https://developer.lametric.com/icons](https://developer.lametric.com/icons). Note that icons always begin with "i" while animations begin with "a". This is part of the name, you can't just use the number!
description: "An icon or animation. List of all icons available at [https://developer.lametric.com/icons](https://developer.lametric.com/icons)."
required: false
type: string
cycles:
description: Defines how long the notification will be displayed. Set to 0 to require manual dismissal
description: "Defines how long the notification will be displayed. Set to `0` to require manual dismissal."
required: false
type: integer
default: 1
priority:
description: Defines the priority of the notification. Allowed values are info, warning, and critical
description: "Defines the priority of the notification. Allowed values are `info`, `warning`, and `critical`."
required: false
type: string
default: warning
icon_type:
description: Defines the nature of notification. Allowed values are none, info, and alert
description: "Defines the nature of notification. Allowed values are `none`, `info`, and `alert`."
required: false
type: string
default: info
default: none
sound:
description: "Defines the sound of the notification. Allowed are listed [below](#list-of-notification-sounds)."
required: false
type: string
default: none
{% endconfiguration %}
## Example
## Examples
### Full configuration example
```yaml
# Example configuration.yaml entry
notify:
name: NOTIFIER_NAME
platform: lametric
lifetime: 20
icon: a7956
cycles: 3
priority: info
icon_type: none
```
### Changing sounds and icons
To add a notification sound, icon, cycles, or priority override, it has to be done via service data.
To add a notification sound, icon, cycles, or priority override,
```yaml
- alias: "Send notification on arrival at school"
trigger:
platform: state
entity_id: device_tracker.son_mobile
entity_id: device_tracker.tom_mobile
from: "not_home"
to: "school"
action:
service: notify.lametric
service: notify.my_lametric
data:
message: "Son has arrived at school!"
message: "Tom has arrived at school!"
data:
sound: "notification"
icon: "i51"
icon: "51"
cycles: 0
priority: "critical"
icon_type: "none"
icon_type: "info"
```
### Only notify specific device
## List of notification sounds
If you have more than one La Metric device, you can specify which will receive the message by adding `target:` to the service data:
The following notification sounds can be used with the `sound` parameter on
notify service calls:
```yaml
action:
service: notify.lametric
data:
message: "Son has arrived at school!"
target: "Office LaMetric"
data:
sound: "notification"
icon: "i51"
```
- `alarm1`
- `alarm10`
- `alarm11`
- `alarm12`
- `alarm13`
- `alarm2`
- `alarm3`
- `alarm4`
- `alarm5`
- `alarm6`
- `alarm7`
- `alarm8`
- `alarm9`
- `bicycle`
- `car`
- `cash`
- `cat`
- `dog`
- `dog2`
- `energy`
- `knock-knock`
- `letter_email`
- `lose1`
- `lose2`
- `negative1`
- `negative2`
- `negative3`
- `negative4`
- `negative5`
- `notification`
- `notification2`
- `notification3`
- `notification4`
- `open_door`
- `positive1`
- `positive2`
- `positive3`
- `positive4`
- `positive5`
- `positive6`
- `statistic`
- `thunder`
- `water1`
- `water2`
- `win`
- `win2`
- `wind_short`
- `wind`
If target is not specified, all LaMetric devices will be notified.
## Manual automatic import configuration
If you prefer not to use the Home Assistant account linking service, you
can set up the LaMetric application manually.
However, please note! At this point, it is easier to choose the "Enter manually"
option during the integration setup; this also avoids the use of the account
linking service and doesn't need all the steps below either.
If you still want to set up your own LaMetric application for importing
your LaMetric devices, use the following steps:
1. Log in with your LaMetric device account to [developer.lametric.com](https://developer.lametric.com).
2. Click the Create button and choose [Notification](https://developer.lametric.com/applications/createsource) app.
3. Fill in the form. You can put almost anything in the fields, they just need to be populated:
* App Name: Home Assistant
* Description: Home Assistant
* Redirect URI: `https://my.home-assistant.io/redirect/oauth`
* Privacy Policy: `http://localhost/`
* Check the "basic" and "read_devices" permission boxes
* Click Save
4. You should be directed to your [Notification Apps list](https://developer.lametric.com/applications/sources),
click on "Home Assistant", copy your client ID and Client Secret.
You may then add the credentials to [Application Credentials](/integrations/application_credentials/) and then setup the integration.
{% details "I have manually disabled My Home Assistant" %}
If you don't have [My Home Assistant](/integrations/my) on your installation,
you can use `<HOME_ASSISTANT_URL>/auth/external/callback` as the redirect URI
instead.
The `<HOME_ASSISTANT_URL>` must be the same as used during the configuration/
authentication process.
Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://homeassistant.local:8123/auth/external/callback`."
{% enddetails %}

87
source/_integrations/landisgyr_heat_meter.markdown Normal file
View File

@ -0,0 +1,87 @@
---
title: Landis+Gyr Heat Meter
description: Instructions on how to integrate your Landis+Gyr Heat Meter device into Home Assistant.
ha_category:
- Energy
- Sensor
ha_iot_class: Local Polling
ha_config_flow: true
ha_release: 2022.9
ha_domain: landisgyr_heat_meter
ha_codeowners:
- '@vpathuis'
ha_platforms:
- sensor
ha_integration_type: integration
---
The Landis+Gyr Heat Meter integration for Home Assistant allows you to read the meter values from Ultraheat devices by Landis & Gyr. These devices are commonly used for district heating. The integration has been tested with the Landis & Gyr Ultraheat 50 (UH50), type LUGCUH50. Other models are likely to work as well.
The device is read through the optical interface. An (USB) IR reader is needed and connected to Home Assistant.
![USB IR reader](/images/integrations/landisgyr_heat_meter/usb_ir_reader.png)
{% include integrations/config_flow.md %}
## Sensors
The integration will create the following sensors:
- Heat usage (MWh)
- Volume usage (m3)
To be compatible with the Home Assistant energy units of measurement, heat usage is converted to MWh, from usage in GJ, which is supplied by the device, using a conversion factor: 1 GJ = 0.277778 MWh.
Further data that is read from the device is added as diagnostic entities:
- Heat usage measured in GJ, as is read from the device before conversion
- Ownership number
- Volume previous year (m3)
- Heat previous year (MWh)
- Error number
- Device number
- Measurement period minutes
- Power max (kW)
- Power max previous year (kW)
- Flow rate max (m3ph)
- Flow rate max previous year (m3ph)
- Flow temperature max (°C)
- Return temperature max (°C)
- Flow temperature max previous year (°C)
- Return temperature max previous year (°C)
- Operating hours
- Fault hours
- Fault hours previous year
- Yearly set day
- Monthly set day
- Meter date time
- Measuring range (m3ph)
- Settings and firmware
- Flow hours
## Energy Dashboard
Either heat usage or volume usage can be used as "Gas" on the energy dashboard. If you want to supply a price per MWh, make sure to apply the conversion factor first.
## Polling the device
Polling is by default done only once per day (and once right after adding the integration). Every time the Heat Meter values are read, battery time of the device will (supposedly) go down by about 30 minutes.
For detailed control on polling and time of polling, consider disabling polling in the integration panel and poll manually. For instructions, see below.
### Polling manually (optional)
For detailed control on when the device is polled, disable the default polling for this integration and create an automation that will update one of the entities (the other entities will be updated as well)
If you're comfortable with YAML, this game could be used:
```yaml
alias: "Heat Meter manual update"
trigger:
- platform: time
at: "23:30:00"
action:
- service: homeassistant.update_entity
target:
entity_id: sensor.heat_meter_heat_usage_gj
```

53
source/_integrations/led_ble.markdown Normal file
View File

@ -0,0 +1,53 @@
---
title: LED BLE
description: Instructions on how to integrate LED BLE devices into Home Assistant.
ha_category:
- Light
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Polling
ha_codeowners:
- '@bdraco'
ha_domain: led_ble
ha_config_flow: true
ha_platforms:
- light
ha_integration_type: integration
---
Integrates multiple brands of Bluetooth Low Energy LED devices into Home Assistant.
{% include integrations/config_flow.md %}
This integration works with devices that identify with the following names:
- LEDnet (except LEDnetWF models)
- BLE-LED
- LEDBLE
- Triones
- LEDBlue
- Dream
- QHM
- AP
These devices have been sold under many brands, including:
- ALED
- AVERYSHOP
- BLE-LED
- EPBOWPT
- HaoDeng (some models)
- Happy Lighting
- hun hun
- ILC
- LEDBlue
- LED BLE
- MCWOFI
- PHOPOLLO
- RESHAKE
- REYSURPIUS
- SUPERNIGHT
- Triones
- Zengee
- YONEDA
- Zerproc

2
source/_integrations/leviton_z_wave.markdown
View File

@ -22,6 +22,7 @@ ha_category:
- Sensor
- Siren
- Switch
- Updates
ha_domain: leviton_z_wave
ha_integration_type: integration
works_with:
@ -41,6 +42,7 @@ ha_platforms:
- sensor
- siren
- switch
- update
ha_zeroconf: true
ha_supporting_domain: zwave_js
ha_supporting_integration: Z-Wave

15
source/_integrations/lifx.markdown
View File

@ -2,6 +2,7 @@
title: LIFX
description: Instructions on how to integrate LIFX into Home Assistant.
ha_category:
- Button
- Light
ha_iot_class: Local Polling
ha_release: 0.81
@ -9,6 +10,8 @@ ha_config_flow: true
ha_domain: lifx
ha_homekit: true
ha_platforms:
- binary_sensor
- button
- light
ha_integration_type: integration
ha_codeowners:
@ -114,6 +117,18 @@ Run an effect that does nothing, thereby stopping any other effect that might be
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all.
## Buttons
The LIFX button platform creates two buttons for each LIFX device.
### Identify Button
The Identify button will flash the bulb three times at maximum brightness then return the bulb to the state it was in prior. Successful identification requires the bulb to be powered on and already configured in Home Assistant.
### Restart Button
The Restart button triggers the bulb to restart in exactly the same way as a physical power cycle, which makes it ideal for triggering a new DHCP request from the bulb.
## HomeKit Accessory Protocol
Most LIFX devices support Apple HomeKit via the HomeKit Accessory Protocol (HAP). If a LIFX device has not already been added to HomeKit natively using an Apple iOS or macOS device, it can be paired with Home Assistant using via the [HomeKit Controller](/integrations/homekit_controller) integration which uses HAP.

11
source/_integrations/light.mqtt.markdown
View File

@ -167,6 +167,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false
@ -720,13 +724,18 @@ state_topic:
required: false
type: string
supported_color_modes:
description: A list of color modes supported by the list. This is required if `color_mode` is `True`. Possible color modes are `onoff`, `brightness`, `color_temp`, `hs`, `xy`, `rgb`, `rgbw`, `rgbww`.
description: A list of color modes supported by the list. This is required if `color_mode` is `True`. Possible color modes are `onoff`, `brightness`, `color_temp`, `hs`, `xy`, `rgb`, `rgbw`, `rgbww`, `white`.
required: false
type: list
unique_id:
description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception.
required: false
type: string
white_scale:
description: "Defines the maximum white level (i.e., 100%) of the MQTT device. This is used when setting the light to white mode."
required: false
type: integer
default: 255
{% endconfiguration %}
<div class='note warning'>

49
source/_integrations/litterrobot.markdown
View File

@ -12,7 +12,9 @@ ha_release: 2021.3
ha_config_flow: true
ha_codeowners:
- '@natekspencer'
- '@tkdrob'
ha_domain: litterrobot
ha_dhcp: true
ha_platforms:
- button
- select
@ -22,30 +24,39 @@ ha_platforms:
ha_integration_type: integration
---
The Litter-Robot integration allows you to control and monitor your Wi-Fi-enabled, automatic, self-cleaning litter box for cats.
The Litter-Robot integration allows you to control and monitor your Wi-Fi-enabled, automatic, self-cleaning litter box and pet feeders.
You will need a Litter-Robot account as well as a Wi-Fi-enabled Litter-Robot unit that has already been associated with your account.
The Feeder-Robot and Litter-Robot 4 are not currently supported by this integration.
You will need a Litter-Robot account as well as a Wi-Fi-enabled Litter-Robot or Feeder-Robot unit that has already been associated with your account.
{% include integrations/config_flow.md %}
## Entities
The following entities are created for this component and identified by a single device per Litter-Robot unit:
### Litter-Robot
| Entity | Domain | Description |
| ----------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Litter Box | `vacuum` | Main entity that represents a Litter-Robot unit. |
| Night Light Mode | `switch` | When turned on, automatically turns on the night light in darker settings. |
| Panel Lockout | `switch` | When turned on, disables the buttons on the unit to prevent changes to settings. |
| Last Seen | `sensor` | Displays the time the unit was last seen / reported an update. |
| Sleep Mode Start Time | `sensor` | When sleep mode is enabled, displays the current or next sleep mode start time. |
| Sleep Mode End Time | `sensor` | When sleep mode is enabled, displays the current or last sleep mode end time. |
| Status Code | `sensor` | Displays the status code (Clean Cycle in Progress, Ready, Drawer Full, etc). |
| Waste Drawer | `sensor` | Displays the current waste drawer level. |
| Clean Cycle Wait Time Minutes | `select` | View and select the clean cycle wait time. |
| Reset Waste Drawer | `button` | Button to reset the waste drawer level to 0%. |
| Entity | Domain | Description |
| ----------------------------- | -------- | -------------------------------------------------------------------------------- |
| Litter Box | `vacuum` | Main entity that represents a Litter-Robot unit. |
| Night Light Mode | `switch` | When turned on, automatically turns on the night light in darker settings. |
| Panel Lockout | `switch` | When turned on, disables the buttons on the unit to prevent changes to settings. |
| Last Seen | `sensor` | Displays the time the unit was last seen / reported an update. |
| Pet weight | `sensor` | Displays the last measured pet weight, only for Litter-Robot 4. |
| Sleep Mode Start Time | `sensor` | When sleep mode is enabled, displays the current or next sleep mode start time. |
| Sleep Mode End Time | `sensor` | When sleep mode is enabled, displays the current or last sleep mode end time. |
| Status Code | `sensor` | Displays the status code (Clean Cycle in Progress, Ready, Drawer Full, etc). |
| Waste Drawer | `sensor` | Displays the current waste drawer level. |
| Clean Cycle Wait Time Minutes | `select` | View and select the clean cycle wait time. |
| Reset Waste Drawer | `button` | Button to reset the waste drawer level to 0%, only for Litter-Robot 3. |
### Feeder-Robot
| Entity | Domain | Description |
| ---------------- | -------- | -------------------------------------------------------------------------------- |
| Give snack | `button` | Button to dispense a single snack portion. |
| Meal insert size | `select` | View and select the meal insert size. |
| Food level | `sensor` | Displays the approximate food level remaining in the hopper. |
| Night light mode | `switch` | When turned on, automatically turns on the night light in darker settings. |
| Panel lockout | `switch` | When turned on, disables the buttons on the unit to prevent changes to settings. |
## Additional Attributes
@ -61,11 +72,11 @@ Some entities have attributes in addition to the default ones that are available
## Services
Services are utilized for additional functionality that is available in the Litter-Robot companion app. The following are currently available:
Services are utilized for additional functionality that is available in the Whisker (previously Litter-Robot) companion app. The following are currently available:
### set_sleep_mode
Enables (with `start_time` parameter) or disables sleep mode on the Litter-Robot.
Enables (with `start_time` parameter) or disables sleep mode on the Litter-Robot. Currently, this is limited to only the Litter-Robot 3. To make changes to the sleep schedule on your Litter-Robot 4, please continue to use the Whisker app.
| Parameter | Type | Required | Description |
| ---------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

4
source/_integrations/lock.mqtt.markdown
View File

@ -102,6 +102,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false

1
source/_integrations/lutron_caseta.markdown
View File

@ -17,6 +17,7 @@ ha_config_flow: true
ha_codeowners:
- '@swails'
- '@bdraco'
- '@danaues'
ha_zeroconf: true
ha_homekit: true
ha_platforms:

36
source/_integrations/melnor.markdown Normal file
View File

@ -0,0 +1,36 @@
---
title: Melnor Bluetooth
description: Instructions on setting up Melnor Bluetooth devices within Home Assistant.
ha_category:
- Switch
ha_iot_class: Local Polling
ha_bluetooth: true
ha_release: 2022.9
ha_config_flow: true
ha_codeowners:
- '@vanstinator'
ha_domain: melnor
ha_platforms:
- switch
ha_integration_type: integration
---
The Melnor Bluetooth integration allows you to control your Melnor Bluetooth watering valves.
The devices are set up through Bluetooth and don't need any additional bridge or gateway.
1-zone, 2-zone, and 4-zone valves are supported.
These devices have been sold under at least the following brands:
- [Melnor](https://melnor.com/)
- [Eden](https://edengarden.com/)
{% include integrations/config_flow.md %}
The Melnor Bluetooth integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth/) integration is enabled and functional.
## Troubleshooting
### No devices found on the network
Make sure nothing else is connected to the valve. The valve will not respond to Bluetooth discovery requests from Home Assistant if another device, such as your phone, is already connected.

1
source/_integrations/mjpeg.markdown
View File

@ -60,4 +60,3 @@ use is automatically detected when using a username and password.
- Legacy Foscam / wanscam
- MJPEG URL: `http://IP:PORT/videostream.cgi` (add ?resultion=32 for 640x480 or ?resultion=32 for 320x240)
- Still Image URL: `http://IP:PORT/snapshot.cgi`

2
source/_integrations/nextdns.markdown
View File

@ -10,11 +10,13 @@ ha_codeowners:
- '@bieniu'
ha_domain: nextdns
ha_platforms:
- binary_sensor
- button
- diagnostics
- sensor
- switch
ha_integration_type: integration
ha_quality_scale: platinum
---
NextDNS is a DNS service that protects from all kinds of security threats, blocks ADS and trackers on websites and in apps, and provides a safe and supervised Internet for kids — on all devices and on all networks. The NextDNS integration allows you to monitor NextDNS statistics and control its configuration.

9
source/_integrations/number.mqtt.markdown
View File

@ -89,6 +89,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false
@ -159,6 +163,11 @@ max:
required: false
type: float
default: 100
mode:
description: Control how the number should be displayed in the UI. Can be set to `box` or `slider` to force a display mode.
required: false
type: string
default: '"auto"'
name:
description: The name of the Number.
required: false

20
source/_integrations/nutrichef.markdown Normal file
View File

@ -0,0 +1,20 @@
---
title: Nutrichef
description: Instructions on how to integrate Nutrichef devices into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: 2022.8
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: nutrichef
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
ha_supporting_domain: inkbird
ha_supporting_integration: INKBIRD
---
{% include integrations/supported_brand.md %}

1
source/_integrations/nzbget.markdown
View File

@ -34,6 +34,7 @@ This component will create these sensors:
- `nzbget_post_processing_paused`: Whether post processing is paused.
- `nzbget_uptime`: NZBGet server uptime.
- `nzbget_size`: Amount of data downloaded since server start in MB.
- `nzbget_speed_limit`: Download queue speed limit in MB/s.
## Event Automation

3
source/_integrations/octoprint.markdown
View File

@ -2,6 +2,7 @@
title: OctoPrint
description: Integration between OctoPrint and Home Assistant.
ha_category:
- 3D Printing
- Binary Sensor
- Button
- Sensor
@ -57,7 +58,7 @@ verify ssl:
### API Key
For the integration to work, please check that in Octoprint, the plugin Discovery is enabled and in the settings -> printer notifications menu pop-ups are enabled.
The Octoprint integration will attempt to register itself via the [application keys plugin](https://docs.octoprint.org/en/master/bundledplugins/appkeys.html). After submitting the configuration UI in Home Assistant, open the Octoprint UI and click allow on the prompt.
The Octoprint integration will attempt to register itself via the [application keys plugin](https://docs.octoprint.org/en/master/bundledplugins/appkeys.html). After submitting the configuration UI in Home Assistant, open the Octoprint UI and click allow on the prompt.
## Binary Sensor

36
source/_integrations/openexchangerates.markdown
View File

@ -4,44 +4,18 @@ description: Instructions on how to integrate exchange rates from https://openex
ha_category:
- Finance
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_release: 0.23
ha_domain: openexchangerates
ha_platforms:
- sensor
ha_integration_type: integration
ha_codeowners:
- '@MartinHjelmare'
---
The `openexchangerates` sensor will show you the current exchange rate from [Open Exchange Rates](https://openexchangerates.org) that provides realtime exchange rates for [170 currencies](https://openexchangerates.org/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour.
The Open Exchange Rates integration will show you the current exchange rate from [Open Exchange Rates](https://openexchangerates.org) that provides real-time exchange rates for [170 currencies](https://openexchangerates.org/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour.
Obtain your API key [here](https://openexchangerates.org/signup)
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: openexchangerates
api_key: YOUR_API_KEY
quote: EUR
```
{% configuration %}
name:
description: The name of the sensor.
required: false
type: string
default: Exchange Rate Sensor
api_key:
description: "The API Key for [Open Exchange Rates](https://openexchangerates.org)."
required: true
type: string
quote:
description: The symbol of the quote or target currency.
required: true
type: string
base:
description: The symbol of the base currency. Note that, changing the API `base` currency is not part of the freemium API plan.
required: false
type: string
default: USD
{% endconfiguration %}
{% include integrations/config_flow.md %}

184
source/_integrations/openuv.markdown
View File

@ -31,20 +31,6 @@ trained medical professional.
To generate an API key,
[simply log in to the OpenUV website](https://www.openuv.io/auth/google).
<div class='note warning'>
Beginning February 1, 2019, the "Limited" plan (which is what new users are
given by default) is limited to 50 API requests per day. Because different
API plans and locations will have different requirements, the `openuv`
component does not automatically query the API for new data after it initially
loads. To request new data, the `update_data` service may be used.
</div>
<div class='note warning'>
Each use of the `update_data` service will consume 2 API calls from the daily quota
(since it performs the same tasks as back-to-back calls of the `update_uv_index_data` and
the `update_protection_data` services).
</div>
{% include integrations/config_flow.md %}
## Sensors
@ -56,6 +42,44 @@ the `update_protection_data` services).
| Current UV Level | Sensor | UV Level (as literal) |
| Max UV Index | Sensor | max UV Index for the day (at solar noon) |
| Protection Window | Binary Sensor | whether sunblock protection should be used |
| Skin Type 1 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 1](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
| Skin Type 2 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 2](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
| Skin Type 3 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 3](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
| Skin Type 4 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 4](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
| Skin Type 5 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 5](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
| Skin Type 6 Safe Exposure Time | Sensor | the amount of time [Fitzpatrick skin type 6](https://en.wikipedia.org/wiki/Fitzpatrick_scale) can be in the sun unprotected |
## Updating Data
<div class='note warning'>
OpenUV does _not_ automatically update data for its entities! Users must manually
update data via the `homeassistant.update_entity` service.
</div>
Beginning February 1, 2019, the "Limited" plan (which is what new users are given by
default) is limited to 50 API requests per day. Because different API plans and
locations will have different requirements, the `openuv` component does not automatically
query the API for new data after it initially loads. To request new data, the
`homeassistant.update_entity` service should be used.
Note that in the case of UV and ozone data, selecting any one of:
* Current Ozone Level
* Current UV Index
* Current UV Level
* Max UV Index
* Skin Type 1 Safe Exposure Time
* Skin Type 2 Safe Exposure Time
* Skin Type 3 Safe Exposure Time
* Skin Type 4 Safe Exposure Time
* Skin Type 5 Safe Exposure Time
* Skin Type 6 Safe Exposure Time
...as the target for the `homeassistant.update_entity` service will update the data for
_all_ of these entities.
To protect against possible API call waste, all calls to `homeassistant.update_entity`
that reference an OpenUV entity are throttled to a minimum of 15 minutes between calls.
### Protection Window
@ -64,81 +88,20 @@ The Protection Window binary sensor will be `on` when sunblock protection should
By default, this occurs anytime the UV index is above 3.5. This behavior can be
configured via the config entry options within the UI. Two parameters are given:
* `Starting UV index for the protection window`: the UV index that, when passed, indicates protection should be utilized
* `Ending UV index for the protection window`: the UV index that, when passed, indicates protection is no longer required
### The Fitzpatrick Scale
The approximate number of minutes of a particular skin type can be exposed to
the sun before burning/tanning starts is based on the
[Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale).
OpenUV integration provide sensors for safe exposure time (in minutes) based on skin type:
- Skin Type 1 Safe Exposure Time
- Skin Type 2 Safe Exposure Time
- Skin Type 3 Safe Exposure Time
- Skin Type 4 Safe Exposure Time
- Skin Type 5 Safe Exposure Time
- Skin Type 6 Safe Exposure Time
## Services
### `openuv.update_data`
Perform an on-demand update of OpenUV data.
### `openuv.update_uv_index_data`
Perform an on-demand update of OpenUV sensor data including current UV index, but not the `uv_protection_window`, saving an API call over `update_data`.
### `openuv.update_protection_data`
Perform an on-demand update of OpenUV `uv_protection_window` data, but not the sensors, saving an API call.
* `Starting UV index for the protection window`: the UV index that, when passed, indicates
protection should be utilized
* `Ending UV index for the protection window`: the UV index that, when passed, indicates
protection is no longer required
## Examples of Updating Data
To perform an optimal amount of API calls you need to know the hours of daylight on the longest day of the year. If for example this is 17 hours, you can perform 2 calls around every 45 minutes without running into the 50 API call limit per day:
Update the UV index data every 20 minutes while the sun is at least 10 degrees above the
horizon:
{% raw %}
```yaml
automation:
- alias: "Update OpenUV"
trigger:
# Time pattern of /45 will not work as expected, it will trigger on the whole hour and on the whole hour + 45 minutes.
# Using more frequent time pattern and a condition to get the intended behavior.
- platform: time_pattern
minutes: "/15"
condition:
- condition: sun
after: sunrise
before: sunset
# The last call will most likely fall before the sunset, thus leaving an UV index value not at 0 for the remaining night.
# To fix this, we allow one more service call after the sun has set.
before_offset: "+00:45:00"
# We check if the last trigger has been 40 minutes or more ago so we don't run into timing issues.
# By checking for 40 minutes or greater we ensure this is only true at the 45 minute mark.
- condition: template
value_template: >-
{{
state_attr('automation.update_openuv', 'last_triggered') == None or
(now() - state_attr('automation.update_openuv', 'last_triggered')) >= timedelta(hours = 0, minutes = 40)
}}
action:
- service: openuv.update_data
```
{% endraw %}
Update the UV index data every 20 minutes while the sun is at least 10 degrees above the horizon:
{% raw %}
```yaml
automation:
- alias: "Update OpenUV every 20 minutes while the sun is at least 10 degrees above the horizon"
trigger:
platform: time_pattern
minutes: "/20"
@ -148,33 +111,66 @@ automation:
value_template: "{{ state.attributes.elevation }}"
above: 10
action:
service: openuv.update_uv_index_data
service: homeassistant.update_entity
target:
entity_id: sensor.LATITUDE_LONGITUDE_current_uv_index
```
{% endraw %}
Update the protection window once a day:
Update the protection window once a day at 12:00pm:
```yaml
automation:
- alias: "Update OpenUV protection window once a day"
- alias: "Update OpenUV"
trigger:
platform: time
at: "02:12:00"
at: "12:00:00"
action:
service: openuv.update_protection_data
service: homeassistant.update_entity
target:
entity_id: binary_sensor.LATITUDE_LONGITUDE_protection_window
```
Another method (useful when monitoring locations other than the Home Assistant latitude
and longitude, in locations where there is a large amount of sunlight per day,
etc.) might be to simply query the API less often:
To perform an optimal amount of API calls in locations where the amount of daylight
varies, you need to know the total hours of daylight on the longest day of the year. If,
for example, this is 17 hours, you can perform 2 calls around every 45 minutes without
running into the 50 API call limit per day:
{% raw %}
```yaml
automation:
- alias: "Update OpenUV every hour (48 of 50 calls per day)"
- alias: "Update OpenUV"
trigger:
platform: time_pattern
hours: "*"
# Time pattern of /45 will not work as expected, as it will sometimes be true
# twice per hour (on the whole hour and on the whole hour + 45 minutes); use a
# more frequent time pattern and a condition to get the intended behavior:
- platform: time_pattern
minutes: "/15"
condition:
- condition: sun
after: sunrise
before: sunset
# The last call will most likely fall before the sunset, leaving the UV index at
# something other than 0 for the remainder of the night; to fix this, we allow
# one more service call after the sun has set:
before_offset: "+00:45:00"
- condition: template
# We check if the last trigger has been 40 minutes or more ago so we don't run
# into timing issues; by checking for 40 minutes or greater, we ensure this is
# only true at the 45 minute mark:
value_template: >-
{{
state_attr('automation.update_openuv', 'last_triggered') == None
or (
now() - state_attr('automation.update_openuv', 'last_triggered')
) >= timedelta(hours = 0, minutes = 40)
}}
action:
service: openuv.update_data
service: homeassistant.update_entity
target:
entity_id:
# Update both UV and protection window data:
- binary_sensor.LATITUDE_LONGITUDE_protection_window
- sensor.LATITUDE_LONGITUDE_current_uv_index
```
{% endraw %}

8
source/_integrations/p1_monitor.markdown
View File

@ -49,6 +49,14 @@ See per phase what your voltage, current and power consumption/production is.
- Power consumed phases L1/2/3 (W)
- Power Produced phases L1/2/3 (W)
### WaterMeter
See how much water you consume per day, in total and the number of counted pulses.
- Water Consumption - day (liters)
- Water Consumption - total (m3)
- Pulse Count
### Settings
You can use the rates set in P1 Monitor for your calculations in Home Assistant.

23
source/_integrations/prusalink.markdown Normal file
View File

@ -0,0 +1,23 @@
---
title: PrusaLink
description: Instructions on monitoring Prusa 3D printers using PrusaLink.
ha_category:
- 3D Printing
ha_iot_class: Local Polling
ha_release: '2022.9'
ha_config_flow: true
ha_codeowners:
- '@balloob'
ha_domain: prusalink
ha_integration_type: integration
ha_platforms:
- camera
- sensor
ha_dhcp: true
---
The PrusaLink integration allows you to monitor your [Prusa 3D printer](https://www.prusa3d.com) and its progress with your Home Assistant installation.
{% include integrations/config_flow.md %}
This integration requires PrusaLink v2. If you have the Prusa MINI, you need to run firmware 4.4.0 or later.

1
source/_integrations/pure_energie.markdown
View File

@ -10,6 +10,7 @@ ha_codeowners:
- '@klaasnicolaas'
ha_domain: pure_energie
ha_platforms:
- diagnostics
- sensor
ha_quality_scale: platinum
ha_zeroconf: true

30
source/_integrations/pushover.markdown
View File

@ -4,11 +4,14 @@ description: Instructions on how to add Pushover notifications to Home Assistant
ha_category:
- Notifications
ha_release: pre 0.7
ha_config_flow: true
ha_iot_class: Cloud Push
ha_domain: pushover
ha_platforms:
- notify
ha_integration_type: integration
ha_codeowners:
- '@engrbm87'
---
The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows integrations to send messages to the user using Pushover.
@ -17,32 +20,7 @@ The [Pushover service](https://pushover.net/) is a platform for the notify compo
In order to get an API key you need to [register an application](https://pushover.net/apps/clone/home_assistant) on the Pushover website. Your Pushover user key can be found on the [Pushover dashboard](https://pushover.net/dashboard).
To use Pushover notifications, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
- name: NOTIFIER_NAME
platform: pushover
api_key: YOUR_API_KEY
user_key: YOUR_USER_KEY
```
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
api_key:
description: Your API key.
required: true
type: string
user_key:
description: Your user key for Pushover.
required: true
type: string
{% endconfiguration %}
{% include integrations/config_flow.md %}
Example Automation:

34
source/_integrations/qingping.markdown Normal file
View File

@ -0,0 +1,34 @@
---
title: Qingping
description: Instructions on how to integrate Qingping devices into Home Assistant.
ha_category:
- Binary Sensor
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: qingping
ha_config_flow: true
ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
---
Integrates [Qingping](https://qingping.co/) devices into Home Assistant.
{% include integrations/config_flow.md %}
The Qingping integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
## Supported devices
- [Air Monitor Lite](https://www.qingping.co/air-monitor-lite/overview) (CGDN1)
- [Alarm Clock](https://www.qingping.co/bluetooth-alarm-clock/overview) (CGD1)
- [BT Clock Lite](https://www.qingping.co/bluetooth-clock/overview) (CGC1)
- [Door/Window Sensor](https://www.qingping.co/door-window-sensor/overview) (CGH1)
- [LEE GUITARS Thermo-Hygrometer](https://www.qingping.co/lee-guitars-thermo-hygrometer/overview) (CGM1)
- [Motion & Ambient Light Sensor](https://www.qingping.co/motion-light-sensor/overview) (CGPR1)
- [Temp RH M](https://www.qingping.co/temp-rh-monitor/overview#mi) (CGG1)

10
source/_integrations/rainmachine.markdown
View File

@ -6,6 +6,8 @@ ha_category:
- Irrigation
- Sensor
- Switch
- Update
- Updates
ha_release: 0.69
ha_iot_class: Local Polling
ha_config_flow: true
@ -14,9 +16,11 @@ ha_codeowners:
ha_domain: rainmachine
ha_platforms:
- binary_sensor
- button
- diagnostics
- sensor
- switch
- update
ha_zeroconf: true
ha_homekit: true
ha_integration_type: integration
@ -27,6 +31,7 @@ The RainMachine integration is the main integration to integrate all platforms r
There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Button
- Sensor
- [Switch](#switch)
@ -139,3 +144,8 @@ Programs and zones are linked. While a program is running, you will see both the
Many RainMachine entities are enabled by default. Others, like those related to flow sensors, are disabled by default if they only apply to some controllers. You can view all entities for a controller and enable/disable them as appropriate in the Device screen for your RainMachine controller.
[wnum reference]: https://github.com/sprinkler/rainmachine-developer-resources/blob/d47e1ad59dee59e34094ad41636ae289275eb973/sdk-parsers/RMDataFramework/rmWeatherData.py#L13
## Firmware Updates
The integration has an [update entity](/integrations/update/) that provides information on the latest available RainMachine firmware version. The firmware update can be triggered and installed onto your RainMachine controller
directly from Home Assistant.

1
source/_integrations/repairs.markdown
View File

@ -4,7 +4,6 @@ description: Home Assistant Repairs informs you about issues it has found in you
ha_release: 2022.8
ha_category:
- Other
ha_iot_class: internal
ha_codeowners:
- '@home-assistant/core'
ha_domain: repairs

24
source/_integrations/risco.markdown
View File

@ -5,7 +5,7 @@ ha_category:
- Alarm
- Binary Sensor
ha_release: '0.115'
ha_iot_class: Cloud Polling
ha_iot_class: Local Push
ha_config_flow: true
ha_codeowners:
- '@OnFreund'
@ -18,14 +18,17 @@ ha_platforms:
ha_integration_type: integration
---
This integration connects with Risco Alarms over [Risco Cloud](https://riscocloud.com/).
This integration connects with Risco Alarms, in one of two ways:
## Risco Cloud (recommended)
The integration will connect with your alarm over [Risco Cloud](https://riscocloud.com/).
This is easiest to configure, and is widely supported, but is cloud based, and requires polling.
<div class='note'>
As from January 2021, Risco have implemented charges for use of their Cloud Features.
As of January 2021, Risco have implemented charges for use of their Cloud Features.
</div>
{% include integrations/config_flow.md %}
<div class='note warning'>
It is recommended to use a regular (non-owner) account with the Risco app/website, and use a different regular account with the integration. Risco has restrictions on concurrent uses by different users, especially if they have different permission levels.
</div>
@ -35,6 +38,17 @@ has the event timestamp as the state, and other event information in attributes.
If you have multiple sites, only the first site will be used.
## Local (advanced)
The integration will connect locally to your system.
No dependency on the cloud, and instantaneous updates, but is harder to set up.
You will need the master code to your system, and with older models,
you might need to either disconnect your system from the cloud, or set up a proxy that will allow you to connect both locally and via the cloud.
The local version of the integration does not support events, and the `arming` state.
{% include integrations/config_flow.md %}
## Options
You can configure additional behavior by clicking on **Options** in the relevant box in the Integration panel:

110
source/_integrations/schedule.markdown Normal file
View File

@ -0,0 +1,110 @@
---
title: Schedule
description: Instructions on how use make weekly schedule in Home Assistant.
ha_category:
- Automation
- Helper
ha_release: 2022.9
ha_quality_scale: internal
ha_codeowners:
- '@home-assistant/core'
ha_domain: schedule
ha_integration_type: helper
---
The schedule integration provides a way to create a weekly schedule in
Home Assistant that can be used to trigger or make decisions in your
automations and scripts.
The preferred way to configure a schedule is via the user interface at
**Settings** -> **Devices & Services** -> **Helpers**. Click the add button
and then choose the **Schedule** option, or click the My button below.
{% include integrations/config_flow.md %}
To be able to add **Helpers** via the user interface you should
have `default_config:` in your `configuration.yaml`, it should already
be there by default unless you removed it.
If you removed `default_config:` from your configuration,
you must add it back or, alternatively, `schedule:` to your
`configuration.yaml` first, before you can create them via the UI.
Alternatively, a schedule can also be created and configured via YAML
configuration. For example:
```yaml
# Example configuration.yaml entry
schedule:
thermostat_schedule:
name: "Thermostat schedule"
monday:
- from: "17:00:00"
to: "21:00:00"
tuesday:
- from: "17:00:00"
to: "21:00:00"
wednesday:
- from: "17:00:00"
to: "21:00:00"
thursday:
- from: "17:00:00"
to: "21:00:00"
friday:
- from: "17:00:00"
to: "23:00:00"
saturday:
- from: "07:00:00"
to: "10:00:00"
- from: "16:00:00"
to: "23:00:00"
sunday:
- from: "07:00:00"
to: "21:00:00"
```
{% configuration %}
schedule:
description: Alias for the schedule. Multiple entries are allowed.
required: true
type: map
keys:
name:
description: Friendly name of the schedule.
required: true
type: string
icon:
description: Icon to display in the frontend for this schedule.
required: false
type: icon
"monday|tuesday|wednesday|thursday|friday|saturday|sunday":
description: A schedule for each day of the week.
required: false
required: true
type: list
keys:
from:
description: The start time to mark the schedule as active/on.
required: true
type: time
to:
description: The end time to mark as inactive/off again.
required: true
type: time
{% endconfiguration %}
### Attributes
A schedule entity's state exports attributes that can be useful in
automations and templates.
| Attribute | Description |
| ----- | ----- |
| `next_event` | A datetime object containing the next time the schedule is going to change state. |
### Services
Available service: `schedule.reload`.
#### schedule.reload
`schedule.reload` service allows one to reload the schedule's configuration without restarting Home Assistant itself.

4
source/_integrations/select.mqtt.markdown
View File

@ -106,6 +106,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
required: false

4
source/_integrations/sensor.mqtt.markdown
View File

@ -90,6 +90,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

20
source/_integrations/sensorblue.markdown Normal file
View File

@ -0,0 +1,20 @@
---
title: SensorBlue
description: Instructions on how to integrate SensorBlue devices into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: sensorblue
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
ha_supporting_domain: thermobeacon
ha_supporting_integration: ThermoBeacon
---
{% include integrations/supported_brand.md %}

27
source/_integrations/sensorpro.markdown Normal file
View File

@ -0,0 +1,27 @@
---
title: SensorPro
description: Instructions on how to integrate SensorPro devices into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: sensorpro
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
---
Integrates [SensorPro](https://www.sigmawit.com/) devices into Home Assistant.
## Supported devices
- T201
- T301
The SensorPro integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
{% include integrations/config_flow.md %}

4
source/_integrations/siren.mqtt.markdown
View File

@ -112,6 +112,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

97
source/_integrations/sms.markdown
View File

@ -26,38 +26,89 @@ This integration provides the following platforms:
## Notifications
To configure the notification service, edit your `configuration.yaml` file:
```yaml
notify:
- platform: sms
name: sms_person1
recipient: PHONE_NUMBER
- platform: sms
name: sms_person2
recipient: PHONE_NUMBER
```
You can also receive SMS messages that are sent to the SIM card number in your device.
Every time there is a message received, `event: sms.incoming_sms` is fired with date, phone number and text message.
An SMS message can be sent by calling the `notify.sms`. It will send the message to all phone numbers specified in the `target` parameter.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
If the integration is used with the Home Assistant Operating System, then version [3.6](https://github.com/home-assistant/hassos/releases/tag/3.6) or higher is required.
### Send message
For installations not running on Home Assistant or Home Assistant Core using Docker, you must install `gammu-dev` package:
```bash
sudo apt-get install libgammu-dev
```yaml
action:
service: notify.sms
data:
message: "This is a message for you!"
target: "+5068081-8181"
```
Before running for the first time, check that the system recognizes the modem by running:
### Sending SMS using GSM alphabet
```bash
ls -l /dev/*USB*
Some devices (receiving or sending) do not support Unicode (the default encoding). For these you can disable Unicode:
```yaml
action:
service: notify.sms
data:
message: "This is a message for you in ANSI"
target: "+5068081-8181"
data:
unicode: False
```
Note: When running Home Assistant, you need to install the SSH add-on.
### Getting SMS messages
You can also receive SMS messages that are sent to the SIM card number in your device.
Every time there is a message received, `event: sms.incoming_sms` is fired with date, phone number and text message.
Sample automation that forward all SMS to `user1`:
#### Define a sensor in `configuration.yaml` to protect user phone number
```yaml
template:
- sensor:
- name: "User1 Phone Number"
state: !secret user1_phone_number
```
#### Define a script in `scripts.yaml` to use the sensor
{% raw %}
```yaml
notify_sms_user1:
alias: "Notify via SMS to User1"
fields:
message:
description: "The message content"
example: "The light is on!"
sequence:
- service: notify.sms
data:
message: "{{ message }}"
target: "{{ states('sensor.user1_phone_number') }}"
mode: single
icon: mdi:chat-alert
```
{% endraw %}
#### Putting it all together in `automations.yaml`
{% raw %}
```yaml
- alias: "Forward SMS"
trigger:
- platform: event
event_type: sms.incoming_sms
action:
- service: script.notify_sms_user1
data:
message: |
From: {{trigger.event.data.phone}}
{{trigger.event.data.text}} mode: single
```
{% endraw %}
## Required Hardware

4
source/_integrations/switch.mqtt.markdown
View File

@ -100,6 +100,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

2
source/_integrations/switch_as_x.markdown
View File

@ -48,4 +48,4 @@ Type:
Where compatible, Switch as X will appear on entity properties. A list of entities can be found in {% my entities title="Settings -> Devices & Services -> Entities" %}.
![Entity properties exampl](/images/integrations/switch_as_x/Entities_Properties.png)
![Entity properties exampl](/images/integrations/switch_as_x/Entities_Properties.png)

6
source/_integrations/switchbot.markdown
View File

@ -4,6 +4,7 @@ description: Instructions on how to set up SwitchBot Devices.
ha_category:
- Binary Sensor
- Cover
- Light
- Sensor
- Switch
ha_release: 0.78
@ -13,11 +14,13 @@ ha_codeowners:
- '@danielhiversen'
- '@RenierM26'
- '@murtas'
- '@Eloston'
ha_domain: switchbot
ha_bluetooth: true
ha_platforms:
- binary_sensor
- cover
- light
- sensor
- switch
ha_config_flow: true
@ -43,10 +46,13 @@ Please note, device names configured in the SwitchBot app are not transferred in
## Supported Devices
- Color Bulb (WoBulb)
- Bot (WoHand)
- Contact Sensor (WoContact)
- Curtain (WoCurtain)
- Light Strip (WoStrip)
- Meter (WoSensorTH)
- Motion Sensor (WoPresence)
- Plug Mini (WoPlug), both the original (model W1901400) and HomeKit-enabled (model W1901401)
## SwitchBot Entity

4
source/_integrations/system_bridge.markdown
View File

@ -80,6 +80,10 @@ These sensors are also available, but are not enabled by default:
| GPU Power Usage | GPU power usage |
| GPU Temperature | The current temperature of the GPU |
## Media Source
This integration is available as a media source to use with the media browser integration. You can browse and view media from your system to media players such as your web browser and other supported media players.
## Services
### Service `system_bridge.open_path`

4
source/_integrations/tag.mqtt.markdown
View File

@ -37,6 +37,10 @@ device:
description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`."
required: false
type: [list, map]
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

10
source/_integrations/telegram.markdown
View File

@ -387,10 +387,14 @@ action:
service: notify.NOTIFIER_NAME
data:
title: "*Send a message*"
message: "That's an example that sends a message with message_tag and disable_notification."
message: |-
That's an example that sends a message with message_tag, disable_notification and disable_web_page_preview.
<a href="https://www.home-assistant.io/">HA site</a>
data:
parse_mode: html
message_tag: "example_tag"
disable_notification: True
disable_web_page_preview: True
```
{% configuration %}
@ -403,6 +407,10 @@ disable_notification:
required: false
default: false
type: boolean
disable_web_page_preview:
description: True/false to display a webpage preview.
default: false
type: boolean
message_tag:
description: Tag for sent message.
required: false

15
source/_integrations/telegram_bot.markdown
View File

@ -253,7 +253,7 @@ Remove the bot from the chat group where it was added.
## Telegram notification platform
The [`telegram` notification platform](/integrations/telegram) requires the `telegram_bot` integration to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The data attributes `parse_mode`, `disable_notification` and `message_tag` are also supported.
The [`telegram` notification platform](/integrations/telegram) requires the `telegram_bot` integration to work with, and it's designed to generate a customized shortcut (`notify.USERNAME`) to send notifications (messages, photos, documents and locations) to a particular `chat_id` with the old syntax, allowing backward compatibility. The data attributes `parse_mode`, `disable_notification`, `message_tag` and `disable_web_page_preview` are also supported.
The required YAML configuration now reduces to:
@ -556,3 +556,16 @@ action:
data:
message_tag: "example_tag"
```
## Example: send_message with disabled webpage preview:
```yaml
action:
- service: notify.telegram
data:
message: >-
<a href="https://www.home-assistant.io/">HA site</a>
data:
parse_mode: html
disable_web_page_preview: true
```

27
source/_integrations/thermobeacon.markdown Normal file
View File

@ -0,0 +1,27 @@
---
title: ThermoBeacon
description: Instructions on how to integrate ThermoBeacon devices into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: thermobeacon
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
---
Integrates [ThermoBeacon](http://www.seven-like.com/) devices into Home Assistant.
## Supported devices
- SensorBlue WS07
- SensorBlue WS08
The ThermoBeacon integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
{% include integrations/config_flow.md %}

20
source/_integrations/thermoplus.markdown Normal file
View File

@ -0,0 +1,20 @@
---
title: ThermoPlus
description: Instructions on how to integrate ThermoPlus devices into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: thermoplus
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
ha_supporting_domain: thermobeacon
ha_supporting_integration: ThermoBeacon
---
{% include integrations/supported_brand.md %}

27
source/_integrations/thermopro.markdown Normal file
View File

@ -0,0 +1,27 @@
---
title: ThermoPro
description: Instructions on how to integrate ThermoPro devices into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: thermopro
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
---
Integrates [ThermoPro](https://buythermopro.com/) devices into Home Assistant.
## Supported devices
- [TP359](https://buythermopro.com/product/thermopro-tp59-bluetooth-wireless-thermometer-hygrometer-humidity-monitor/)
- [TP357](https://buythermopro.com/product/thermopro-tp357-bluetooth-digital-indoor-hygrometer-thermometer/)
The ThermoPro integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
{% include integrations/config_flow.md %}

2
source/_integrations/tibber.markdown
View File

@ -20,7 +20,7 @@ ha_integration_type: integration
---
The `tibber` integration provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer.
If you have a [Tibber Pulse](https://norge.tibber.com/products/pulse/) or [Watty](https://tibber.com/se/store/produkt/watty-smart-energimatare) it will also show the electricity consumption in real-time. You get a sensor for monthly consumption, monthly cost, and monthly peak hour. If you do have a real-time meter it is updated once every hour, oterwise it is updated once per day. Statistics with hourly consumption and cost data is generated that can be used in the [Energy Dashboard](/docs/energy/). (The ids are `tibber:energy_consumption_HOMEID` and `tibber:energy_totalcost_HOMEID` )
If you have a [Tibber Pulse](https://norge.tibber.com/products/pulse/) or [Watty](https://tibber.com/se/store/produkt/watty-smart-energimatare) it will also show the electricity consumption in real-time. You get a sensor for monthly consumption, monthly cost, and monthly peak hour. If you do have a real-time meter it is updated once every hour, otherwise it is updated once per day. Statistics with hourly consumption and cost data is generated that can be used in the [Energy Dashboard](/docs/energy/) (the ids are `tibber:energy_consumption_HOMEID` and `tibber:energy_totalcost_HOMEID`). If you produce energy there are also statistics with hourly production and profit data generated which can also be used there (the ids are `tibber:energy_production_HOMEID` and `tibber:energy_profit_HOMEID`).
There is currently support for the following device types within Home Assistant:

4
source/_integrations/ukraine_alarm.markdown
View File

@ -14,10 +14,12 @@ ha_platforms:
ha_integration_type: integration
---
The Ukraine Alarm integration uses the siren.pp.ua API - public wrapper for [Ukraine Alarm](https://www.ukrainealarm.com/) web service to offer air-raid siren notifications. The integration will create 4 binary sensors for your selected region in Ukraine:
The Ukraine Alarm integration uses the siren.pp.ua API - public wrapper for [Ukraine Alarm](https://www.ukrainealarm.com/) web service to offer air-raid siren notifications. The integration will create 6 binary sensors for your selected region in Ukraine:
- Air
- Artillery
- Chemical
- Nuclear
- Urban Fights
- Unknown

43
source/_integrations/unifiprotect.markdown
View File

@ -10,6 +10,7 @@ ha_category:
- Light
- Lock
- Media Player
- Media Source
- Number
- Select
- Sensor
@ -116,7 +117,7 @@ check that this is done. To check and enable the feature:
{% include integrations/config_flow.md %}
## Features
## Device Support
All known UniFi Protect devices should be supported. Each UniFi Protect device will get a variety of entities added for
each of the different entity platforms.
@ -212,6 +213,35 @@ Your main UniFi Protect NVR device also gets a number of diagnostics sensors tha
* **Disk Health**: Each disk installed in your NVR will have a disk health sensor. These are simple good/bad sensors and the order is not promised to match the order in UniFi OS. Disk model number is provided as a state attribute though to help map sensor to disk.
* **Utilization and Storage Sensors**: Several other sensors are also added for uptime, hardware utilization, and distribution details of the video on disk.
## Media Source
A media source is provided for your UniFi Protect cameras so you can fetch video clips and event thumbnails.
### Media Browser
The media source is split into 5 folders/levels:
1. NVR Console Selector - only appears if you have more then one Protect NVR Console. Allows you to select your NVR Console you want to view events for.
2. Camera Selector - either lets you select all cameras or a specific camera to view events for.
3. Event Selector - either lets you select all events or a specific event type to view events for.
4. Time Selector - filters events for a given time range:
* Last 24 Hours
* Last 7 Days
* Last 30 Days
* By Month since start of recording - selecting a month lets you either view the whole month or a specific date
5. Event Selector - lets you select the specific event for playback
Since the media browser does not have any pagination or filtering, all of the events must be loaded into memory. As a result, the number of events loaded at once is truncated to 10,000 by default. The number of events will be listed at "10000 (TRUNCATED)" if the event count was truncated. You can raise or lower the limit of the number of events that can be loaded using the Config Entry Options.
### Media Identifiers
Below are the accepted identifiers to resolve media. Since events do not necessarily map to any Home Assistant entity, all IDs are in reference to the UniFi Protect IDs, not Home Assistant ones.
| Identifier Format | Description |
| -------------------------------- | ---------------------------------- |
| `{nvr_id}:event:{event_id}` | MP4 video clip for specific event. |
| `{nvr_id}:eventthumb:{event_id}` | JPEG thumbnail for specific event. |
## Services
### Service unifiprotect.set_default_doorbell_text
@ -260,6 +290,17 @@ Use to set the paired doorbell(s) with a smart chime.
| `device_id` | No | The device ID of the Chime you want to pair or unpair doorbells to. |
| `doorbells` | Yes | A target selector for any number of doorbells you want to pair to the chime. No value means unpair all. |
## Views
The integration provides two proxy views to proxy media content from your Home Assistant instance so you can access thumbnails and video clips from within the context of Home Assistant without having to expose your UniFi Protect NVR Console. As with the media identifiers, all IDs are UniFi Protect IDs as they may not map to specific Home Assistant entities depending on how you have configured your integration.
These URLs work great when trying to send notifications. Home Assistant will automatically sign the URLs and make them safe for external consumption if used in an automation or [notify service](/integrations/notify/).
| View URL | Description |
| ------------------------------------------------------------ | -------------------------------------------------- |
| `/api/unifiprotect/thumbnail/{nvr_id}/{event_id}` | Proxies a JPEG event thumbnail from UniFi Protect. |
| `/api/unifiprotect/video/{nvr_id}/{camera_id}/{start}/{end}` | Proxies a MP4 video clip from UniFi Protect for a specific camera. Start and end must be in [ISO 8601 format](https://www.iso.org/iso-8601-date-and-time-format.html). |
## Troubleshooting
### Enabling Debug Logging

4
source/_integrations/vacuum.mqtt.markdown
View File

@ -396,6 +396,10 @@ device:
description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
required: false
type: list
hw_version:
description: The hardware version of the device.
required: false
type: string
identifiers:
description: A list of IDs that uniquely identify the device. For example a serial number.
required: false

4
source/_integrations/vesync.markdown
View File

@ -96,8 +96,8 @@ All VeSync air purifiers expose the remaining filter life, and some also expose
| Sensor | Description | Example |
| --------------------------------------- | ------------------------------------------------------------------ | ------- |
| `filter_life` | Remaining percentage of the filter. (LV-PUR131S, Core200S/300s/400s/600s) | 142 |
| `air_quality` | The current air quality reading. (LV-PUR131S, Core400s/600s) | excellent |
| `pm2_5` | The current air quality reading. (Core400s/600s) | 8 |
| `air_quality` | The current air quality reading. (LV-PUR131S, Core300s/400s/600s) | excellent |
| `pm2_5` | The current air quality reading. (Core300s/400s/600s) | 8 |
## Fan Exposed Attributes

87
source/_integrations/volvooncall.markdown
View File

@ -14,79 +14,13 @@ ha_platforms:
- switch
ha_codeowners:
- '@molobrakos'
- '@decompil3d'
ha_integration_type: integration
ha_config_flow: true
---
The `volvooncall` integration offers integration with the [Volvo On Call](https://www.volvocars.com/intl/why-volvo/human-innovation/future-of-driving/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
## Configuration
To use Volvo On Call in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
volvooncall:
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
Users registered with Volvo in North America or China will need to specify a region:
```yaml
# North America
volvooncall:
username: YOUR_USERNAME
password: YOUR_PASSWORD
region: na
```
or
```yaml
# China
volvooncall:
username: YOUR_USERNAME
password: YOUR_PASSWORD
region: cn
```
{% configuration %}
username:
description: The username associated with your Volvo On Call account.
required: true
type: string
password:
description: The password for your given Volvo On Call account.
required: true
type: string
region:
description: The region where the Volvo is registered. Needs to be set for users in North America or China.
required: false
type: string
service_url:
description: The service URL to use for Volvo On Call. Normally not necessary to specify.
required: false
type: string
mutable:
description: If set to true, include components that can make changes to the vehicle (unlock, start engine, start heater etc).
required: false
default: true
type: boolean
name:
description: "Make it possible to provide a name for the vehicles. Note: Use all lower case letters when inputting your VIN number."
required: false
type: string
resources:
description: A list of resources to display (defaults to all available).
required: false
type: list
scandinavian_miles:
description: If set to true, Scandinavian miles ("mil") are used for distances and fuel range.
required: false
type: boolean
default: false
{% endconfiguration %}
{% include integrations/config_flow.md %}
### Available Resources
@ -130,20 +64,3 @@ The list of currently available resources:
- `tyre_pressure_rear_right_tyre_pressure`
- `any_door_open`
- `any_window_open`
## Advanced Examples
A more advanced example for setting the vehicle name and selecting what resources to display:
```yaml
# Example configuration.yaml entry
volvooncall:
username: YOUR_USERNAME
password: YOUR_PASSWORD
name:
YOUR_VIN_NUMBER: "NEW_NAME"
resources:
- odometer
- lock
- heater
```

55
source/_integrations/wilight.markdown
View File

@ -4,7 +4,9 @@ description: Instructions on how to integrate WiLight devices into Home Assistan
ha_category:
- Cover
- Fan
- Irrigation
- Light
- Switch
ha_release: 0.115
ha_config_flow: true
ha_iot_class: Local Polling
@ -17,6 +19,7 @@ ha_platforms:
- cover
- fan
- light
- switch
ha_integration_type: integration
---
@ -25,8 +28,9 @@ The `wilight` integration is to integrate [WiLight](http://www.wilight.com.br) d
There is currently support for the following device types within Home Assistant:
- Cover (WiLight model C-103).
- Fan (WiLight model V-104).
- Light (WiLight model I-100, I-102 and I-107).
- [Fan](#fan) (WiLight model V-104).
- Light (WiLight model I-100, I-102, I-107, I-110 and I-112).
- [Irrigation](#irrigation) / Switch (WiLight model R-105).
{% include integrations/config_flow.md %}
@ -34,14 +38,49 @@ There is currently support for the following device types within Home Assistant:
The `wilight` integration allows you to control your Fans from within Home Assistant.
### Services
### Fan Services
There are several services which can be used for automations and control of the fan:
| Service | Description |
| --------- | ----------- |
| `set_percentage` | Calling this service sets the fan speed (entity_id and percentage are required parameters). Percentage must be in the range 0-100, percentage = 0 turns off the fan. There are three speed levels 33%, 66% and 100%. Adjusting to intermediate levels goes to the next higher level.
| `set_direction` | Calling this service will set the fan direction (entity_id and direction are required parameters, and direction must be one of the following: forward or reverse). Calling this service will turn the fan on.
| `toggle` | Calling this service will toggle the fan between on and off states (entity_id is required).
| `turn_off` | Calling this service will turn the fan off (entity_id is required).
| `turn_on` | Calling this service will turn the fan on and set the speed and direction to the last used ones (defaults to high and forward, entity_id is required).
| `set_percentage` | Calling this service sets the fan speed (`entity_id` and `percentage` are required parameters). Percentage must be in the range 0-100, percentage = 0 turns off the fan. There are three speed levels 33%, 66% and 100%. Adjusting to intermediate levels goes to the next higher level.
| `set_direction` | Calling this service will set the fan direction (`entity_id` and `direction` are required parameters, and direction must be one of the following: forward or reverse). Calling this service will turn the fan on.
| `toggle` | Calling this service will toggle the fan between on and off states (`entity_id` is required).
| `turn_off` | Calling this service will turn the fan off (`entity_id` is required).
| `turn_on` | Calling this service will turn the fan on and set the speed and direction to the last used ones (defaults to high and forward, `entity_id` is required).
## Irrigation
The `wilight` integration allows you to control your Irrigation from within Home Assistant. This is exposed via switches in Home Assistant.
There are two switch types for Irrigation: `watering switch` and `pause switch`.
A `watering switch` can turn on and off the irrigation valve, while the `pause switch` can disable / enable the action of a `watering switch`.
`Triggers` activate (turn on) the `watering switch` (irrigation valve) at the programmed time. The trigger can be set to run on a day of the week or only once (today).
### Irrigation Services
There are several services which can be used for automations and control of the Irrigation:
- For `watering switch`:
| Service | Description |
| --------- | ----------- |
| `turn_off` | Calling this service will turn the irrigation valve off (`entity_id` is required).
| `turn_on` | Calling this service will turn the irrigation valve on (`entity_id` is required).
| `set_watering_time` | Calling this service sets the watering time (`entity_id` and `watering_time` are required parameters), `watering_time` must be in the range 1-1800 seconds.
| `set_trigger` | Calling this service sets the trigger_1, trigger_2, trigger_3 or trigger_4 (`entity_id`, `trigger_index` and `trigger` are required parameters), `trigger_index` must be between 1 and 4 and `trigger` must be according Trigger rules (see below).
- For `pause switch`:
| Service | Description |
| --------- | ----------- |
| `turn_off` | Calling this service will turn the pause switch off, enabling watering switch (`entity_id` is required).
| `turn_on` | Calling this service will turn the pause switch on, disabling watering switch (`entity_id` is required).
| `set_pause_time` | Calling this service sets the pause time (`entity_id` and `pause_time` are required parameters), `pause_time` must be in the range 1-24 hours.
Trigger rules:
- String with 8 decimal characters ("0" to "9").
- The first three characters (String[0,3]) represent an integer from 0 to 127, which corresponds to Bitfield of: 1 - Sunday, 2 - Monday, 4 - Tuesday, 8 - Wednesday, 16 - Thursday, 32 - Friday and 64 - Saturday. Setting zero, trigger is only valid for today.
- String[3,5] represents the hour of trigger, from 0 to 23.
- String[5,7] represents the minute of trigger, from 0 to 59.
- String[7,8] represents the enable trigger, 0 - disabled, 1- enabled.

8
source/_integrations/xiaomi_ble.markdown
View File

@ -2,6 +2,7 @@
title: Xiaomi BLE
description: Instructions on how to integrate Xiaomi BLE devices into Home Assistant.
ha_category:
- Binary Sensor
- Sensor
ha_bluetooth: true
ha_release: 2022.8
@ -12,6 +13,7 @@ ha_codeowners:
ha_domain: xiaomi_ble
ha_config_flow: true
ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
---
@ -36,6 +38,12 @@ It is possible that we detect your device because it uses the MiBeacon protocol
- Voltage
- Battery
It also supports the following classes of binary sensors:
- Light
- Smoke
- Moisture
## Encryption
Some devices use AES encryption to protect the sensor values they are broadcasting.

88
source/_integrations/xiaomi_miio.markdown
View File

@ -216,8 +216,11 @@ Supported devices:
| Air Purifier 3 (2019) | zhimi.airpurifier.ma4 | |
| Air Purifier 3H (2019) | zhimi.airpurifier.mb3 | |
| Air Purifier 3C | zhimi.airpurifier.mb4 | |
| Air Purifier 4 | zhimi.airp.mb5 | |
| Air Purifier 4 PRO | zhimi.airp.vb4 | |
| Air Fresh A1 | dmaker.airfresh.a1 | MJXFJ-150-A1 |
| Air Fresh VA2 | zhimi.airfresh.va2 | |
| Air Fresh VA4 | zhimi.airfresh.va4 | |
| Air Fresh T2017 | dmaker.airfresh.t2017 | MJXFJ-300-G1 |
| Air Humidifier | zhimi.humidifier.v1 | |
| Air Humidifier CA1 | zhimi.humidifier.ca1 | |
@ -496,6 +499,49 @@ Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
LED | Turn on/off the LED
### Air Purifier 4/4 PRO (zhimi.airp.mb5/zhimi.airp.vb4)
These models use newer MiOT communication protocol.
- Power (on, off)
- Operation modes (Auto, Silent, Favorite, Fan)
- Attributes (fan platform)
- Number entities
Number | Description
----------------------- | -----------------------
Fan Level | Set the fan level
Favorite Level | Set the favorite level
- Select entities
Select | Description
----------------------- | -----------------------
LED Brightness | Controls the brightness of the Display (bright, dim, off)
- Sensor entities
Sensor | Description | Enabled by default
----------------------- | ----------------------- | -----------------------
Filter Life Remaining | The remaining life of the filter in % | True
Filter Time Left | The remaining life of the filter in days | True
Filter Use | Filter usage time in hours | True
Humidity | The current humidity measured | True
Motor Speed | The current motor speed measured in rpm | True
PM2.5 | The current particulate matter 2.5 measured | True
PM10 | The current particulate matter 10 measured(4 PRO only) | True
Purify Volume | The volume of purified air in qubic meter | False
Temperature | The current temperature measured | True
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off the buzzer
Child Lock | Turn on/off the child lock
Ionizer | Turn on/off the negative ion generator
### Air Fresh A1 (dmaker.airfresh.a1)
- Power (on, off)
@ -567,6 +613,41 @@ Child Lock | Turn on/off `child lock`
LED | Turn on/off `led`
### Air Fresh VA4
- Power (on, off)
- Operation modes (Auto, Silent, Interval, Low, Middle, Strong)
- Attributes (fan platform)
- `use_time`
- `extra_features`
- Sensor entities
Sensor | Description | Enabled by default
----------------------- | ----------------------- | -----------------------
Carbon Dioxide | The current carbon dioxide measured in ppm | True
Filter Life Remaining | The remaining life of the filter | True
Filter Use | Filter usage time in hours | True
Humidity | The current humidity measured | True
PM2.5 | The current particulate matter 2.5 measured | True
Temperature | The current temperature measured | True
Use Time | The accumulative number of seconds the device has been in use | False
- Select entities
Select | Description
----------------------- | -----------------------
LED Brightness | Controls the brightness of the LEDs (bright, dim, off)
- Switch entities
Switch | Description
----------------------- | -----------------------
Buzzer | Turn on/off `buzzer`
Child Lock | Turn on/off `child lock`
LED | Turn on/off `led`
Auxiliary Heat | Turn on/off `heater`
### Air Fresh T2017 (dmaker.airfresh.t2017)
- Power (on, off)
@ -584,6 +665,13 @@ Button | Description
Reset Dust Filter | Resets filter lifetime and usage of the dust filter
Reset Upper Filter | Resets filter lifetime and usage of the upper filter
- Select entities
Select | Description
----------------------- | -----------------------
Auxiliary Heat Level | Controls the level of the heater (Low, Medium, High)
Display Orientation | Controls the orientation of the display (Forward, Left, Right)
- Sensor entities
Sensor | Description

80
source/_integrations/yalexs_ble.markdown Normal file
View File

@ -0,0 +1,80 @@
---
title: Yale Access Bluetooth
description: Instructions on how to integrate Yale Access Bluetooth devices into Home Assistant.
ha_category:
- Binary Sensor
- Lock
- Sensor
ha_bluetooth: true
ha_release: 2022.9
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
ha_domain: yalexs_ble
ha_config_flow: true
ha_platforms:
- binary_sensor
- lock
- sensor
ha_integration_type: integration
---
Integrates [Yale Access](https://www.yalehome.com/us/en/products/smart-technology/yale-access) Bluetooth devices into Home Assistant.
{% include integrations/config_flow.md %}
The Yale Access Bluetooth integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
Devices must have a Yale Access module installed to function with this integration if one is not already built-in.
## Supported devices
- YRD216 (Yale Assure Lock Keypad with Physical Key)
- YRL216 (Yale Assure Door Lever Lock with Push Button Keypad)
- YRD226 (Yale Assure Lock Touchscreen Deadbolt with Physical Key)
- YRL226 (Yale Assure Door Lever Lock Keypad)
- YRD256 (Yale Assure Lock Keypad)
- ASL-05 (August WiFi Smart Lock - Gen 4)
- ASL-03 (August Smart Lock Pro - Gen 3)
- ASL-02 (August Smart Lock Pro - Gen 2)
## Limited support devices
These devices do not send updates, but can be locked and unlocked.
- MD-04I (Yale Conexis L1)
- YRCB-490 (Yale Smart Cabinet Lock)
## Push updates
Some locks only send push updates when they have an active HomeKit pairing. If your lock is not sending push updates, ensure it's paired with a HomeKit using an iOS device or the HomeKit controller integration. The lock cannot be paired via HomeKit Controller and the Yale Access Bluetooth integration on the same Home Assistant instance as they will both try to access the lock simultaneously and fail.
Alternatively, call the `homeassistant.update_entity` service to force the integration to update the lock state.
## Door Sensors
The lock must be calibrated in the Yale Access App for the door sensors to function correctly. If the door sensor has an unknown state or is not updating, try recalibrating the lock in the app.
## Obtaining the offline key
The offline key and slot number are required to operate the lock. These credentials can be found in multiple places depending on the lock brand and model.
### Yale Access or August Cloud
The [August](/integrations/august) integration will automatically provision the offline key if the configured account has the key loaded. You may need to create or use a non-primary existing account with owner-level access to the lock, as not all accounts will have the key loaded.
Most Yale branded locks can use the August cloud to obtain the keys. Accessing the August cloud to receive the key may not work unless the lock was purchased in a market that sells under both brands.
### iOS - Yale Access App or August App
The iOS app will only save the offline key to your device's filesystem if Auto-Unlock has been enabled and used at least once. Auto-Unlock can be disabled once the key has been loaded.
- Using [iMazing](https://imazing.com/) or [iPhone Backup Extractor](https://www.iphonebackupextractor.com/), find the backup files for the Yale Access app.
- Look in the `Library/Preferences` `.plist` files for the Yale Access app and find the one with the value of `key` and `slot` using `Xcode` or any binary `plist` viewer.
### Android - Yale Access App or August App
The Android app will only save the offline key to your device's filesystem if Auto-Unlock has been enabled and used at least once. Auto-Unlock can be disabled once the key has been loaded.
Root access is required to read the `key` and `slot` stored in `/data/data/com.august.luna/shared_prefs/PeripheralInfoCache.xml`

1
source/_integrations/zha.markdown
View File

@ -172,6 +172,7 @@ Some devices can be auto-discovered, which can simplify the ZHA setup process. T
| Device | Discovery Method | Identifier |
| -------| ---------------- | ---------- |
| [ITead SONOFF Zigbee 3.0 USB Dongle Plus V2 Model "ZBDongle-E" (EFR32MG21 variant)](https://itead.cc/product/zigbee-3-0-usb-dongle/) | USB | 1A86:55D4 |
| [ITead SONOFF Zigbee 3.0 USB Dongle Plus Model "ZBDongle-P" (CC2652P variant)](https://itead.cc/product/sonoff-zigbee-3-0-usb-dongle-plus/) | USB | 10C4:EA60 |
| [Bitron Video/SMaBiT BV AV2010/10](https://bv.smabit.eu/index.php/smart-home-produkte/zb-funkstick/) | USB | 10C4:8B34 |
| [ConBee II](https://phoscon.de/conbee2) | USB | 1CF1:0030 |

6
source/_integrations/zwave_js.markdown
View File

@ -17,6 +17,7 @@ ha_category:
- Sensor
- Siren
- Switch
- Updates
ha_release: '2021.2'
ha_iot_class: Local Push
ha_config_flow: true
@ -38,6 +39,7 @@ ha_platforms:
- sensor
- siren
- switch
- update
ha_integration_type: integration
ha_zeroconf: true
---
@ -370,6 +372,7 @@ These are notification events fired by devices using the Multilevel Switch comma
"command_class": 38,
"command_class_name": "Multilevel Switch",
"event_type": 4,
"event_type_label": "label 1",
"direction": "up"
},
```
@ -384,6 +387,7 @@ These are notification events fired by devices using the Multilevel Switch comma
"command_class": 38,
"command_class_name": "Multilevel Switch",
"event_type": 5,
"event_type_label": "label 2",
"direction": null
},
```
@ -401,7 +405,9 @@ These are notification events fired by devices using the Entry Control command c
"command_class": 111,
"command_class_name": "Entry Control",
"event_type": 6,
"event_type_label": "label 1",
"data_type": 5,
"data_type_label": "label 2",
"event_data": "555"
}
```

Some files were not shown because too many files have changed in this diff Show More