This commit is contained in:
Bram Kragten 2023-09-06 20:45:12 +02:00 committed by GitHub
commit f189500cc3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
97 changed files with 4450 additions and 159 deletions

View File

@ -23,7 +23,6 @@ source/_integrations/airnow.markdown @asymworks
source/_integrations/airq.markdown @Sibgatulin @dl2080
source/_integrations/airthings.markdown @danielhiversen
source/_integrations/airthings_ble.markdown @vincegio
source/_integrations/airtouch4.markdown @LonePurpleWolf
source/_integrations/airvisual.markdown @bachya
source/_integrations/airvisual_pro.markdown @bachya
source/_integrations/airzone.markdown @Noltari
@ -124,9 +123,11 @@ source/_integrations/cloudflare.markdown @ludeeus @ctalkington
source/_integrations/coinbase.markdown @tombrien
source/_integrations/color_extractor.markdown @GenericStudent
source/_integrations/comed.markdown @tronikos
source/_integrations/comelit.markdown @chemelli74
source/_integrations/comfoconnect.markdown @michaelarnauts
source/_integrations/command_line.markdown @gjohansson-ST
source/_integrations/compensation.markdown @Petro31
source/_integrations/coned.markdown @tronikos
source/_integrations/config.markdown @home-assistant/core
source/_integrations/configurator.markdown @home-assistant/core
source/_integrations/control4.markdown @lawtancool
@ -164,7 +165,6 @@ source/_integrations/digital_ocean.markdown @fabaff
source/_integrations/discogs.markdown @thibmaek
source/_integrations/discord.markdown @tkdrob
source/_integrations/discovergy.markdown @jpbede
source/_integrations/discovery.markdown @home-assistant/core
source/_integrations/dlink.markdown @tkdrob
source/_integrations/dlna_dmr.markdown @StevenLooman @chishm
source/_integrations/dlna_dms.markdown @chishm
@ -175,9 +175,8 @@ source/_integrations/dormakaba_dkey.markdown @emontnemery
source/_integrations/dremel_3d_printer.markdown @tkdrob
source/_integrations/dsmr.markdown @Robbie1221 @frenck
source/_integrations/dsmr_reader.markdown @depl0y @glodenox
source/_integrations/dunehd.markdown @bieniu
source/_integrations/duotecno.markdown @cereal2nd
source/_integrations/dwd_weather_warnings.markdown @runningman84 @stephan192 @Hummel95 @andarotajo
source/_integrations/dwd_weather_warnings.markdown @runningman84 @stephan192 @andarotajo
source/_integrations/dynalite.markdown @ziv1234
source/_integrations/easyenergy.markdown @klaasnicolaas
source/_integrations/ecobee.markdown @marthoc @marcolivierarsenault
@ -203,7 +202,7 @@ source/_integrations/energy.markdown @home-assistant/core
source/_integrations/energyzero.markdown @klaasnicolaas
source/_integrations/enigma2.markdown @fbradyirl
source/_integrations/enocean.markdown @bdurrer
source/_integrations/enphase_envoy.markdown @gtdiehl
source/_integrations/enphase_envoy.markdown @bdraco @cgarwood @dgomes @joostlek
source/_integrations/entur_public_transport.markdown @hfurubotten
source/_integrations/environment_canada.markdown @gwww @michaeldavie
source/_integrations/envisalink.markdown @ufodone
@ -309,6 +308,8 @@ source/_integrations/home_plus_control.markdown @chemaaa
source/_integrations/homeassistant.markdown @home-assistant/core
source/_integrations/homeassistant_alerts.markdown @home-assistant/core
source/_integrations/homeassistant_hardware.markdown @home-assistant/core
source/_integrations/homeassistant_sky_connect.markdown @home-assistant/core
source/_integrations/homeassistant_yellow.markdown @home-assistant/core
source/_integrations/homekit.markdown @bdraco
source/_integrations/homekit_controller.markdown @Jc2k @bdraco
source/_integrations/homematic.markdown @pvizeli @danielperna84
@ -351,7 +352,7 @@ source/_integrations/intesishome.markdown @jnimmo
source/_integrations/ios.markdown @robbiet480
source/_integrations/iotawatt.markdown @gtdiehl @jyavenard
source/_integrations/iperf3.markdown @rohankapoorcom
source/_integrations/ipma.markdown @dgomes @abmantis
source/_integrations/ipma.markdown @dgomes
source/_integrations/iqvia.markdown @bachya
source/_integrations/irish_rail_transport.markdown @ttroy50
source/_integrations/islamic_prayer_times.markdown @engrbm87
@ -386,6 +387,7 @@ source/_integrations/landisgyr_heat_meter.markdown @vpathuis
source/_integrations/lastfm.markdown @joostlek
source/_integrations/launch_library.markdown @ludeeus @DurgNomis-drol
source/_integrations/laundrify.markdown @xLarry
source/_integrations/lawn_mower.markdown @home-assistant/core
source/_integrations/lcn.markdown @alengwenus
source/_integrations/ld2410_ble.markdown @930913
source/_integrations/led_ble.markdown @bdraco
@ -421,6 +423,7 @@ source/_integrations/mastodon.markdown @fabaff
source/_integrations/matter.markdown @home-assistant/matter
source/_integrations/mazda.markdown @bdr99
source/_integrations/meater.markdown @Sotolotl @emontnemery
source/_integrations/media_extractor.markdown @joostlek
source/_integrations/media_player.markdown @home-assistant/core
source/_integrations/media_source.markdown @hunterjm
source/_integrations/mediaroom.markdown @dgomes
@ -521,6 +524,7 @@ source/_integrations/opnsense.markdown @mtreinish
source/_integrations/opower.markdown @tronikos
source/_integrations/oralb.markdown @bdraco @Lash-L
source/_integrations/oru.markdown @bvlaicu
source/_integrations/oru_opower.markdown @tronikos
source/_integrations/otbr.markdown @home-assistant/core
source/_integrations/overkiz.markdown @imicknl @vlebourl @tetienne @nyroDev
source/_integrations/ovo_energy.markdown @timmo001
@ -591,7 +595,6 @@ source/_integrations/renson.markdown @jimmyd-be
source/_integrations/reolink.markdown @starkillerOG
source/_integrations/repairs.markdown @home-assistant/core
source/_integrations/repetier.markdown @MTrab @ShadowBr0ther
source/_integrations/rest.markdown @epenet
source/_integrations/rexel.markdown @imicknl @vlebourl @tetienne @nyroDev
source/_integrations/rflink.markdown @javicalle
source/_integrations/rfxtrx.markdown @danielhiversen @elupus @RobBie1221
@ -607,7 +610,7 @@ source/_integrations/roon.markdown @pavoni
source/_integrations/rpi_power.markdown @shenxn @swetoast
source/_integrations/rss_feed_template.markdown @home-assistant/core
source/_integrations/rtsp_to_webrtc.markdown @allenporter
source/_integrations/ruckus_unleashed.markdown @gabe565
source/_integrations/ruckus_unleashed.markdown @gabe565 @lanrat
source/_integrations/ruuvi_gateway.markdown @akx
source/_integrations/ruuvitag_ble.markdown @akx
source/_integrations/rympro.markdown @OnFreund @elad-bar @maorcc
@ -617,8 +620,9 @@ 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/schlage.markdown @dknowles2
source/_integrations/schluter.markdown @prairieapps
source/_integrations/scrape.markdown @fabaff @gjohansson-ST @epenet
source/_integrations/scrape.markdown @fabaff @gjohansson-ST
source/_integrations/screenaway.markdown @starkillerOG
source/_integrations/screenlogic.markdown @dieselrabbit @bdraco
source/_integrations/script.markdown @home-assistant/core
@ -708,7 +712,7 @@ 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/switchbee.markdown @jafar-atili
source/_integrations/switchbot.markdown @bdraco @danielhiversen @RenierM26 @murtas @Eloston @dsypniewski
source/_integrations/switchbot.markdown @danielhiversen @RenierM26 @murtas @Eloston @dsypniewski
source/_integrations/switcher_kis.markdown @thecode
source/_integrations/switchmate.markdown @danielhiversen @qiz-li
source/_integrations/symfonisk.markdown @cgtobi @jjlawren
@ -748,6 +752,7 @@ source/_integrations/tplink.markdown @rytilahti @thegardenmonkey
source/_integrations/tplink_omada.markdown @MarkGodwin
source/_integrations/traccar.markdown @ludeeus
source/_integrations/tractive.markdown @Danielhiversen @zhulik @bieniu
source/_integrations/trafikverket_camera.markdown @gjohansson-ST
source/_integrations/trafikverket_ferry.markdown @gjohansson-ST
source/_integrations/trafikverket_train.markdown @endor-force @gjohansson-ST
source/_integrations/trafikverket_weatherstation.markdown @endor-force @gjohansson-ST
@ -787,6 +792,7 @@ source/_integrations/vilfo.markdown @ManneW
source/_integrations/vivotek.markdown @HarlemSquirrel
source/_integrations/vizio.markdown @raman325
source/_integrations/vlc_telnet.markdown @rodripf @MartinHjelmare
source/_integrations/vodafone_station.markdown @paoloantinori @chemelli74
source/_integrations/voice_assistant.markdown @balloob @synesthesiam
source/_integrations/voip.markdown @balloob @synesthesiam
source/_integrations/volumio.markdown @OnFreund
@ -829,6 +835,7 @@ 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/yardian.markdown @h3l1o5
source/_integrations/yeelight.markdown @zewelor @shenxn @starkillerOG @alexyao2015
source/_integrations/yeelightsunflower.markdown @lindsaymarkward
source/_integrations/yi.markdown @bachya

View File

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

View File

@ -138,9 +138,42 @@ modes:
type: list
{% endconfiguration %}
### Climate HVAC modes
Widget that displays buttons to control the HVAC mode for a [climate](/integrations/climate).
<p class='img'>
<img src='/images/dashboards/tile-features/climate_hvac_modes.png' alt='Screenshot of the tile card with the climate HVAC modes feature'>
Screenshot of the tile card with the climate HVAC modes feature
</p>
```yaml
features:
- type: "climate-hvac-modes"
hvac_modes:
- auto
- heat_cool
- heat
- cool
- dry
- fan_only
- "off"
```
{% configuration %}
type:
required: true
description: "`climate-hvac-modes`"
type: string
hvac_modes:
required: true
description: List of modes to show on the card. The list can contain `auto`, `heat_cool`, `heat`, `cool`, `dry`, `fan_only` and `off`.
type: list
{% endconfiguration %}
### Cover open/close
Widget that display buttons to open, close or stop a [cover](/integrations/cover).
Widget that displays buttons to open, close, or stop a [cover](/integrations/cover).
<p class='img'>
<img src='/images/dashboards/tile-features/cover_open_close.png' alt='Screenshot of the tile card with open/close feature'>
@ -159,9 +192,30 @@ type:
type: string
{% endconfiguration %}
### Cover position
Widget that displays a slider to control the position for a [cover](/integrations/cover).
<p class='img'>
<img src='/images/dashboards/tile-features/cover_position.png' alt='Screenshot of the tile card with the cover position feature'>
Screenshot of the tile card with the cover position feature
</p>
```yaml
features:
- type: "cover-position"
```
{% configuration %}
type:
required: true
description: "`cover-position`"
type: string
{% endconfiguration %}
### Cover tilt
Widget that display buttons to open, close or stop a [cover](/integrations/cover).
Widget that displays buttons to open, close, or stop a [cover](/integrations/cover).
<p class='img'>
<img src='/images/dashboards/tile-features/cover_tilt.png' alt='Screenshot of the tile card with tilt feature'>
@ -180,9 +234,30 @@ type:
type: string
{% endconfiguration %}
### Cover tilt position
Widget that displays a slider to control the tilt position for a [cover](/integrations/cover).
<p class='img'>
<img src='/images/dashboards/tile-features/cover_tilt_position.png' alt='Screenshot of the tile card with the cover tilt position feature'>
Screenshot of the tile card with the cover tilt position feature
</p>
```yaml
features:
- type: "cover-tilt-position"
```
{% configuration %}
type:
required: true
description: "`cover-tilt-position`"
type: string
{% endconfiguration %}
### Fan speed
Widget that display speed controls for a [fan](/integrations/fan).
Widget that displays speed controls for a [fan](/integrations/fan).
<p class='img'>
<img src='/images/dashboards/tile-features/fan_speed.png' alt='Screenshot of the tile card with fan speed feature'>
@ -201,9 +276,37 @@ type:
type: string
{% endconfiguration %}
### Lawn mower commands
Widget that displays buttons to control a [lawn mower](/integrations/lawn_mower).
<p class='img'>
<img src='/images/dashboards/tile-features/lawn_mower_commands.png' alt='Screenshot of the tile card with the lawn mower commands feature'>
Screenshot of the tile card with the lawn mower commands feature
</p>
```yaml
features:
- type: "lawn-mower-commands"
commands:
- start_pause
- dock
```
{% configuration %}
type:
required: true
description: "`lawn-mower-commands`"
type: string
commands:
required: true
description: List of commands to show on the card. The list can contain `start_pause` and `dock`.
type: list
{% endconfiguration %}
### Light brightness
Widget that display a slider to select the brightness for a [light](/integrations/light).
Widget that displays a slider to select the brightness for a [light](/integrations/light).
<p class='img'>
<img src='/images/dashboards/tile-features/light_brightness.png' alt='Screenshot of the tile card with light brightness feature'>
@ -222,9 +325,51 @@ type:
type: string
{% endconfiguration %}
### Light color temp
Widget that displays a slider to select the color temperature for a [light](/integrations/light).
<p class='img'>
<img src='/images/dashboards/tile-features/light_color_temp.png' alt='Screenshot of the tile card with the light color temperature feature'>
Screenshot of the tile card with the light color temperature feature
</p>
```yaml
features:
- type: "light-color-temp"
```
{% configuration %}
type:
required: true
description: "`light-color-temp`"
type: string
{% endconfiguration %}
### Target temperature
Widget that displays buttons to select the target temperature for a [climate](/integrations/climate) or a [water heater](/integrations/water_heater).
<p class='img'>
<img src='/images/dashboards/tile-features/target_temperature.png' alt='Screenshot of the tile card with the target temperature feature'>
Screenshot of the tile card with the target temperature feature
</p>
```yaml
features:
- type: "target-temperature"
```
{% configuration %}
type:
required: true
description: "`target-temperature`"
type: string
{% endconfiguration %}
### Vacuum commands
Widget that display buttons to control a [vacuum](/integrations/vacuum).
Widget that displays buttons to control a [vacuum](/integrations/vacuum).
<p class='img'>
<img src='/images/dashboards/tile-features/vacuum_commands.png' alt='Screenshot of the tile card with vacuum commands feature'>
@ -252,3 +397,36 @@ commands:
description: List of commands to show on the card. The list can contain `start_pause`, `stop`, `clean_spot`, `locate` and `return_home`.
type: list
{% endconfiguration %}
### Water heater operation modes
Widget that displays buttons to control the operation mode of a [water heater](/integrations/water_heater).
<p class='img'>
<img src='/images/dashboards/tile-features/water_heater_operation_modes.png' alt='Screenshot of the tile card with the water heater operation modes feature'>
Screenshot of the tile card with the water heater operation modes feature
</p>
```yaml
features:
- type: "water-heater-operation-modes"
operation_modes:
- electric
- gas
- heat_pump
- eco
- performance
- high_demand
- "off"
```
{% configuration %}
type:
required: true
description: "`water-heater-operation-modes`"
type: string
operation_modes:
required: true
description: List of modes to show on the card. The list can contain `electric`, `gas`, `heat_pump`, `eco`, `performance`, `high_demand` and `off`.
type: list
{% endconfiguration %}

View File

@ -23,6 +23,8 @@ Name:
description: The name of the location where the weather platform is located. If not set, the name will be the name set on the weather entity
Show Forecast:
description: Check this if you would like to show the upcoming forecast under the current weather.
Forecast type:
description: Select the forecast to display between "Daily", "Hourly" and "Twice daily".
Secondary Info Attribute:
description: Here you can specify a secondary attribute to show under the current temperature. Ex. Extrema, Precipitation, Humidity. If not set, it will default to Extrema (High/Low) if available, if not available then Precipitation and if precipitation isn't available then Humidity.
Theme:
@ -60,6 +62,11 @@ show_forecast:
description: Show next hours/days forecast.
type: boolean
default: true
forecast_type:
required: true
description: Type of forecast to display, one of `daily`, `hourly` or `twice_daily`.
type: string
default: Automatically selects in order of `daily`, `hourly` and `twice_daily`.
secondary_info_attribute:
required: false
description: Which attribute to display under the temperature.
@ -86,8 +93,11 @@ double_tap_action:
### Example
```yaml
show_current: true
show_forecast: true
type: weather-forecast
entity: weather.openweathermap
forecast_type: daily
```
### Advanced

View File

@ -986,6 +986,12 @@ translation_key:
for more information.
type: string
required: false
sort:
description: >
Display options in alphabetical order.
type: boolean
required: false
default: false
{% endconfiguration %}
Alternatively, a mapping can be used for the options. When you want to return

View File

@ -6,8 +6,6 @@ ha_category:
ha_release: 2021.9
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@LonePurpleWolf'
ha_domain: airtouch4
ha_platforms:
- climate

View File

@ -76,6 +76,12 @@ For each Airzone zone (Thermostat), the following *selects* are created:
## Sensors
For the Airzone DHW, the following *sensors* are created:
| Condition | Description |
| :------------------ | :--------------------------------- |
| temperature | Current DHW temperature. |
For the Airzone WebServer, the following *sensors* are created:
| Condition | Description |

View File

@ -46,6 +46,12 @@ Password:
## Binary Sensors
For each Airzone system (HVAC machine), the following *binary sensors* are created:
| Condition | Description |
| :------------------ | :-------------------------------------------------------- |
| problems | Indicates that the current system has errors or warnings. |
For each Airzone zone (thermostat), the following *binary sensors* are created:
| Condition | Description |

View File

@ -244,6 +244,11 @@ state_topic:
description: The MQTT topic subscribed to receive state updates.
required: true
type: string
supported_features:
description: A list of features that the alarm control panel supports. The available list options are `arm_home`, `arm_away`, `arm_night`, `arm_vacation`, `arm_custom_bypass`, and `trigger`.
required: false
type: list
default: ["arm_home", "arm_away", "arm_night", "arm_vacation", "arm_custom_bypass", "trigger"]
unique_id:
description: An ID that uniquely identifies this alarm panel. If two alarm panels have the same unique ID, Home Assistant will raise an exception.
required: false
@ -258,6 +263,26 @@ value_template:
In this section you find some real-life examples of how to use this alarm control panel.
### Configuration with partial feature support
The example below shows a full configuration with an alarm panel that only supports the `arm_home` and `arm_away` features.
{% raw %}
```yaml
# Example with partial feature support
mqtt:
- alarm_control_panel:
name: "Alarm Panel"
supported_features:
- arm_home
- arm_away
state_topic: "alarmdecoder/panel"
command_topic: "alarmdecoder/panel/set"
```
{% endraw %}
### Configuration with local code validation
The example below shows a full configuration with local code validation.

View File

@ -43,9 +43,12 @@ The `august` integration allows you to integrate your [August](https://august.co
| Yale Assure Lock 2 | yes |
| Yale Conexis L1 | yes |
| Yale Conexis L2 | yes |
| Yale Doorman L3 | yes |
| Yale Linus | yes |
| Yale Smart Safe | yes |
Other devices not listed above have not been tested and may not function as expected.
There is currently support for the following device types within Home Assistant:
- Doorbell
@ -65,11 +68,13 @@ The August Wi-Fi Smart Lock (Gen 4) uses different battery technology (lithium-i
Other August locks expect to be powered by AA alkaline (non-rechargeable) batteries. Rechargeable batteries in these locks will result in incorrect reporting of battery charge.
## Known Unsupported Devices
## Push updates not available for some entities
- The Yale Doorman L3
While most entities can be updated via the push API, August/Yale does not offer a push API for some data, which means these entities will update slower:
Other devices not listed above have not been tested and may not function as expected.
- Doorbell ding sensor (Doorman models only)
- Lock Battery sensor
- Lock Operation sensor
## Binary Sensor

View File

@ -83,8 +83,20 @@ method:
name:
description: Name of the REST binary sensor.
required: false
type: string
type: template
default: REST Binary Sensor
icon:
description: Defines a template for the icon of the entity.
required: false
type: template
picture:
description: Defines a template for the entity picture of the entity.
required: false
type: template
availability:
description: Defines a template if the entity state is available or not.
required: false
type: template
device_class:
description: Sets the [class of the device](/integrations/binary_sensor/#device-class), changing the device state and icon that is displayed on the frontend.
required: false

View File

@ -48,7 +48,7 @@ This integration adds BleBox device as a binary_sensor in Home Assistant.
Currently, this includes support for the following product classes:
- BleBox rainSensor
- BleBox wind&rainSensor (rain only)
- BleBox wind&rainSensor
## Sensors
@ -57,6 +57,8 @@ This integration adds the BleBox device as a sensor in Home Assistant.
Currently, this includes support for the following product classes and their features:
- BleBox tempSensor (temperature only)
- Blebox humiditySensor
- BleBox airSensor
## Switches
@ -76,13 +78,6 @@ Currently, this includes support for the following product classes:
- BleBox saunaBox
- BleBox thermoBox
## Air Quality
This integration adds the BleBox device as an air quality entity in Home Assistant.
Currently, this includes support for the following product classes:
- BleBox airSensor
## Lights

View File

@ -135,10 +135,6 @@ The `button.<your_vehicle>_find_vehicle` button requests the vehicle to update t
</div>
### Update the state / refresh from cloud
The `button.<vehicle_model>_refresh_from_cloud` button fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles.
## Selects
If you have a (PH)EV, you can control the charging process through Home Assistant. The selects are created automatically depending on your vehicle's capabilities and can be pressed/executed from the UI or using the `select.select_option` service. For more information, please see the [select documentation](/integrations/select/).

View File

@ -38,6 +38,7 @@ There is currently support for the following device types within Home Assistant:
The binary sensor platform allows you to monitor the states of your shutter contact and battery sensors. Binary sensor devices are added for each of the following devices:
- Shutter Contact
- Shutter Contact II
- Battery powered devices
### Cover

View File

@ -35,18 +35,6 @@ action_topic:
Valid values: `off`, `heating`, `cooling`, `drying`, `idle`, `fan`.
required: false
type: string
aux_command_topic:
description: The MQTT topic to publish commands to switch auxiliary heat.
required: false
type: string
aux_state_template:
description: A template to render the value received on the `aux_state_topic` with.
required: false
type: template
aux_state_topic:
description: The MQTT topic to subscribe for changes of the auxiliary heat mode. If this is not set, the auxiliary heat mode works in optimistic mode (see below).
required: false
type: string
availability:
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
required: false
@ -183,7 +171,7 @@ fan_modes:
initial:
description: Set the initial target temperature. The default value depends on the temperature unit and will be 21° or 69.8°F.
required: false
type: integer
type: float
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false

View File

@ -0,0 +1,27 @@
---
title: Comelit SimpleHome
description: Instructions on how to integrate Comelit SimpleHome home automation devices into Home Assistant.
ha_category:
- Light
ha_release: '2023.9'
ha_domain: comelit
ha_config_flow: true
ha_codeowners:
- '@chemelli74'
ha_iot_class: Local Polling
ha_platforms:
- light
ha_ssdp: false
ha_integration_type: integration
---
The Comelit SimpleHome integration allows you to control your [Comelit home automation devices](https://comelitgroup.it/installatore/offerta/domotica-e-smart-home).
There is support for the following platform types within Home Assistant:
- **Comelit Serial Bridge** - allows local control for climate, light and cover devices.
{% include integrations/config_flow.md %}
## Configuration
The configuration in the UI asks for a a few information: host, alarm_pin.

View File

@ -0,0 +1,20 @@
---
title: Consolidated Edison (ConEd)
description: Get energy usage from Consolidated Edison (ConEd) using the Opower integration
ha_category:
- Energy
- Sensor
ha_release: 2023.9
ha_domain: coned
ha_integration_type: virtual
ha_supporting_domain: opower
ha_supporting_integration: Opower
ha_codeowners:
- '@tronikos'
ha_config_flow: true
ha_platforms:
- sensor
ha_iot_class: Cloud Polling
---
{% include integrations/supported_brand.md %}

View File

@ -4,9 +4,11 @@ description: Instructions on how to integrate devolo Home Network devices with H
ha_category:
- Binary Sensor
- Button
- Image
- Presence Detection
- Sensor
- Switch
- Update
ha_release: '2021.12'
ha_iot_class: Local Polling
ha_config_flow: true
@ -20,8 +22,10 @@ ha_platforms:
- button
- device_tracker
- diagnostics
- image
- sensor
- switch
- update
ha_zeroconf: true
ha_integration_type: device
---
@ -47,6 +51,12 @@ Currently the following device types within Home Assistant are supported.
- Restart the device
- Start WPS
### Images
- QR code of your guest wifi credentials
- Updates every 15 seconds if changes are detected
- Is enabled by default
### Presence Detection
- Detect presence of devices connected to the main or the guest wifi
@ -72,6 +82,11 @@ Currently the following device types within Home Assistant are supported.
- Turn on/off the device LEDs
- Is enabled by default
## Update
- Update the firmware of a device.
- Is enabled by default but will only give a result if regular checks are enabled on the device.
## Supported devolo Devices
The list of supported devolo devices depends on the device firmware and the device features. The following devices were tested running firmware 5.6.0:

View File

@ -13,7 +13,7 @@ ha_config_flow: true
ha_platforms:
- diagnostics
- sensor
ha_integration_type: hub
ha_integration_type: service
---
The `discovergy` integration allows users to integrate their [Discovergy](https://discovergy.com/) smart meters into Home Assistant.

View File

@ -7,8 +7,6 @@ ha_iot_class: Local Polling
ha_release: 0.34
ha_domain: dunehd
ha_config_flow: true
ha_codeowners:
- '@bieniu'
ha_platforms:
- media_player
ha_integration_type: integration

View File

@ -2,6 +2,8 @@
title: Duotecno
description: Access and control your Duotecno nodes.
ha_category:
- Cover
- Light
- Switch
ha_iot_class: Local Push
ha_release: '2023.8'
@ -11,6 +13,7 @@ ha_codeowners:
ha_domain: duotecno
ha_platforms:
- cover
- light
- switch
ha_integration_type: integration
---

View File

@ -10,7 +10,6 @@ ha_domain: dwd_weather_warnings
ha_codeowners:
- '@runningman84'
- '@stephan192'
- '@Hummel95'
- '@andarotajo'
ha_platforms:
- sensor

View File

@ -10,11 +10,12 @@ ha_codeowners:
ha_domain: electric_kiwi
ha_config_flow: true
ha_platforms:
- select
- sensor
ha_integration_type: hub
---
[Electric Kiwi](https://www.electrickiwi.co.nz/) is an independent power and broadband company in New Zealand, offering variable rates for peak, shoulder, and off-peak pricing with a selectable hour of free power. This integration uses the official [Electric Kiwi API](https://developer.electrickiwi.co.nz) to show the hour of free power.
[Electric Kiwi](https://www.electrickiwi.co.nz/) is an independent power and broadband company in New Zealand, offering variable rates for peak, shoulder, and off-peak pricing with a selectable hour of free power. This integration uses the official [Electric Kiwi API](https://developer.electrickiwi.co.nz) to show and select the hour of free power.
{% include integrations/config_flow.md %}

View File

@ -12,6 +12,7 @@ ha_domain: elmax
ha_platforms:
- alarm_control_panel
- binary_sensor
- cover
- switch
ha_integration_type: integration
---

View File

@ -9,19 +9,53 @@ ha_domain: enphase_envoy
ha_zeroconf: true
ha_config_flow: true
ha_codeowners:
- '@gtdiehl'
- '@bdraco'
- '@cgarwood'
- '@dgomes'
- '@joostlek'
ha_platforms:
- binary_sensor
- diagnostics
- number
- select
- sensor
- switch
ha_integration_type: integration
---
A sensor platform for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. Works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S).
An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). Firmware version 3.9 or newer is required.
{% include integrations/config_flow.md %}
### Obtaining the password
## Capabilities
For newer models, the username `envoy` without a password will grant access to the device. For older models, the password for the `installer` user can be obtained with this: [tool](https://thecomputerperson.wordpress.com/2016/08/28/reverse-engineering-the-enphase-installer-toolkit/).
This integration will offer various sensors depending on the configuration of your Enphase system. Sensors are available for the following:
In some cases, you need to use the username `envoy` with the last 6 digits of the unit's serial number as password. See [the enphase documentation](https://support.enphase.com/s/article/What-is-the-Username-and-Password-for-the-Administration-page-of-the-Envoy-local-interface) for more details on other units.
- Current energy production & consumption
- Historical energy production & consumption
- Power production per-inverter
_Consumption sensors require your Envoy to be properly configured with consumption CT sensors installed._
For Enphase Ensemble systems with the Enpower/IQ System Controller and Encharge/IQ Batteries installed, additional features are available:
- Sensors for battery status and usage
- Sensors for grid status
- Sensors for the state of the Enpower's 4 load-shedding relays
- A switch allowing you to take your system on-grid and off-grid. Note that the Enpower has a slight delay built-in between receiving these commands and actually switching the system on or off grid.
## Envoy authentication requirements
For newer models running firmware 7 and greater, you will need your Enlighten cloud username and password. The integration will use these credentials to obtain an Envoy access token from the Enlighten cloud.
For models running firmware 5 and older, use `installer` for the username. No password is required. The integration will automatically detect the `installer` password.
## Enpower Load Shedding Relays
The Enphase Enpower has 4 load shedding relays that can be used to control non-essential loads in your home. These have two main modes of operation:
### Standard
When the mode entity is set to standard, you can simply set the state of the relay to be powered or not powered for each mode of operation: on grid, off grid, and on generator.
### Battery Level
When the relay mode is set to battery level, the relays will turn on and off based on the remaining battery level of your Encharge batteries. Two number entities are available to control the cutoff and restore levels for the relays. When the battery level drops below the cutoff level, the relays will turn off. When the battery level rises above the restore level, the relays will turn back on.

View File

@ -21,6 +21,7 @@ ha_platforms:
- number
- select
- sensor
- siren
- switch
- update
ha_integration_type: integration
@ -141,6 +142,11 @@ Trigger device OTA firmware update process for latest stable version.
The motion detection sensitivity can be adjusted using the "Detection sensitivity" Number entity. It's important to note that this entity fetches information from the device and will not update if your battery-powered camera is in sleep mode, as this measure is implemented to preserve battery life and prevent excessive drainage.
### Siren
The Siren entity allows you to activate the Alarm function on the device. In most cameras, the Alarm function incorporates a strobe light and/or an audible siren that is designed to deter potential intruders.
Once triggered, the siren will automatically deactivate after 60 seconds (EZVIZ does this, not done via integration). Alternatively, you can manually deactivate the siren by using the entity.
### PTZ
PTZ up/down/left/right buttons are available on supported PTZ cameras for pan and tilt control.

View File

@ -26,6 +26,7 @@ ha_codeowners:
- '@mib1185'
- '@flabbamann'
ha_integration_type: hub
ha_quality_scale: gold
---
The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [FRITZ!DECT](https://en.avm.de/products/smart-home/) devices like switches, sensors and thermostats.

View File

@ -30,6 +30,7 @@ See device section for support information: [Water Control](#water-control), [Ir
## Water Control
- Water Control Bluetooth ([01889-20](https://www.gardena.com/int/products/watering/water-controls/water-control-bluetooth))
- Soil Moisture Sensors ([1867-20](https://www.gardena.com/int/products/watering/water-controls/soil-moisture-sensor/))
The paring of the device may require a [Factory Reset](#factory-reset) before it allows a connection.

View File

@ -141,7 +141,7 @@ data:
media_player: media_player.living_room_speaker
```
You can also send multiple commands in the same conversation context which is useful to unlock doors or open covers that need a PIN. Example:
You can send multiple commands in the same conversation context which is useful to unlock doors or open covers that need a PIN. Example:
```yaml
service: google_assistant_sdk.send_text_command
@ -151,6 +151,28 @@ data:
- "1234"
```
You can get responses. Example:
```yaml
service: google_assistant_sdk.send_text_command
data:
command:
- "tell me a joke"
- "tell me another one"
```
returns:
```yaml
responses:
- text: |-
What do you call a belt made of watches?
A waist of time 👖 🕝
- text: |-
What's the most musical part of the turkey?
The drumsticks 🍗
```
### Service `notify.google_assistant_sdk`
You can use the service `notify.google_assistant_sdk` to broadcast messages to Google Assistant speakers and displays without interrupting music/video playback.

View File

@ -4,6 +4,7 @@ description: Instructions on how to setup groups within Home Assistant.
ha_category:
- Binary Sensor
- Cover
- Event
- Fan
- Helper
- Light
@ -23,6 +24,7 @@ ha_config_flow: true
ha_platforms:
- binary_sensor
- cover
- event
- fan
- light
- lock
@ -38,7 +40,7 @@ The group integration lets you combine multiple entities into a single entity. E
This can be useful for cases where you want to control, for example, the
multiple bulbs in a light fixture as a single light in Home Assistant.
Home Assistant can group multiple binary sensors, covers, fans, lights, locks, media players, switches as a single entity, with the option of hiding the individual member entities.
Home Assistant can group multiple binary sensors, covers, events, fans, lights, locks, media players, switches as a single entity, with the option of hiding the individual member entities.
{% include integrations/config_flow.md %}
@ -70,6 +72,11 @@ In short, when any group member entity is `open`, the group will also be `open`.
- Otherwise, the group state is `open` if at least one group member is `open`.
- Otherwise, the group state is `closed`.
### Event groups
- The group state is `unavailable` if all group members are `unavailable`.
- Otherwise, the group state is the last event received from any group member.
### Fan groups
In short, when any group member entity is `on`, the group will also be `on`. A complete overview of how fan groups behave:
@ -149,6 +156,20 @@ cover:
- cover.living_room_window
```
Example YAML configuration of an event group:
```yaml
# Example configuration.yaml entry
event:
- platform: group
name: "Remote events"
entities:
- event.remote_button_1
- event.remote_button_2
- event.remote_button_3
- event.remote_button_4
```
Example YAML configuration of a fan group:
```yaml
@ -377,7 +398,7 @@ Old style groups can calculate group state with entities from the following doma
When member entities all have a single `on` and `off` state, the group state will be calculated as follows:
| Domain | on | off |
|-------------------|----------|----------|
| -------------- | -------- | -------- |
| device_tracker | home | not_home |
| cover | open | closed |
| lock | unlocked | locked |
@ -395,13 +416,13 @@ These groups can still be in templates with the `expand()` directive, called usi
This integration provides the following services to modify groups and a service to reload the configuration without restarting Home Assistant itself.
| Service | Data | Description |
| ------- | ---- | ----------- |
| `set` | `Object ID` | Group id and part of entity id.
| | `Name` | Name of the group.
| | `Icon` | Name of the icon for the group.
| | `Entities` | List of all members in the group. Not compatible with **delta**.
| | `Add Entities` | List of members that will change on group listening.
| | `Remove Entities` | List of members that will be removed from group listening.
| | `All` | Enable this option if the group should only turn on when all entities are on.
| `remove` | `Object ID` | Group id and part of entity id.
| `reload` | `Object ID` | Group id and part of entity id.
| -------- | ----------------- | ----------------------------------------------------------------------------- |
| `set` | `Object ID` | Group id and part of entity id. |
| | `Name` | Name of the group. |
| | `Icon` | Name of the icon for the group. |
| | `Entities` | List of all members in the group. Not compatible with **delta**. |
| | `Add Entities` | List of members that will change on group listening. |
| | `Remove Entities` | List of members that will be removed from group listening. |
| | `All` | Enable this option if the group should only turn on when all entities are on. |
| `remove` | `Object ID` | Group id and part of entity id. |
| `reload` | `Object ID` | Group id and part of entity id. |

View File

@ -35,11 +35,11 @@ Home Assistant is integrated with the following devices through [https://mytotal
- Every thermostat is exposed as a climate entity
- Known working devices: [TH6320R1004](https://customer.resideo.com/en-US/Pages/Product.aspx?cat=HonECC%2520Catalog&pid=TH6320R1004/U), [RTH9585WF1004](https://www.honeywellhome.com/us/en/products/air/thermostats/wifi-thermostats/wifi-color-touchscreen-thermostat-rth9585wf1004-u/), [RTH6580WF](https://www.honeywellhome.com/us/en/products/air/thermostats/wifi-thermostats/wifi-7-day-programmable-thermostat-rth6580wf1001-u1/)
- Sensors
- A Temperature sensor entity.
- A Humidity sensor entity.
- Known working devices: [C7089R1013](https://customer.resideo.com/en-US/Pages/Product.aspx?cat=HonECC%20Catalog&pid=C7089R1013/U)
- A Temperature sensor entity
- A Humidity sensor entity
- Known working devices: [C7089R1013](https://customer.resideo.com/en-US/Pages/Product.aspx?cat=HonECC%20Catalog&pid=C7089R1013/U), [RTH6580WF](https://www.honeywellhome.com/us/en/products/air/thermostats/wifi-thermostats/wifi-7-day-programmable-thermostat-rth6580wf1001-u1/)
Others devices like Security systems are not currently supported by this integration
Other devices like Security systems are not currently supported by this integration.
## Climate
@ -49,10 +49,12 @@ All [climate services](/integrations/climate) are supported except set_swing_mod
## Sensor
The sensor platform integrates outside temperature and outside humidity into Home Assistant as sensors for each device.
The sensor platform integrates inside and outside temperature and humidity into Home Assistant as sensors for each device. Not every supported thermostat will support all sensors.
This integration will add Home Assistant sensors for the following:
|Sensor|Value|
--- | ---
|Outdoor temperature | Average temperature of all Honeywell Wireless Outdoor Sensors|
|Outdoor humidity | Average humidity of all Honeywell Wireless Outdoor Sensors|
|Indoor temperature | Current temperature as measured at the specific thermostat|
|Indoor humidity | Current humidity as measured at the specific thermostat|

View File

@ -62,6 +62,11 @@ use_x_forwarded_for:
required: false
type: boolean
default: false
use_x_frame_options:
description: "Controls the `X-Frame-Options` header to help prevent [clickjacking](https://en.wikipedia.org/wiki/Clickjacking)."
required: false
type: boolean
default: true
trusted_proxies:
description: "List of trusted proxies, consisting of IP addresses or networks, that are allowed to set the `X-Forwarded-For` header. This is required when using `use_x_forwarded_for` because all requests to Home Assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario, this option should be set with extreme care. If the immediate upstream proxy is not in the list, the request will be rejected. If any other intermediate proxy is not in the list, the first untrusted proxy will be considered the client."
required: false

View File

@ -8,7 +8,6 @@ ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@dgomes'
- '@abmantis'
ha_domain: ipma
ha_platforms:
- sensor

View File

@ -0,0 +1,46 @@
---
title: Lawn Mower
description: Instructions on how to setup and use lawn mowers in Home Assistant.
ha_release: 2023.9
ha_domain: lawn_mower
ha_quality_scale: internal
ha_category:
- Lawn Mower
ha_codeowners:
- '@home-assistant/core'
ha_integration_type: entity
---
The lawn mower integration allows the control of robotic lawn mowers to be reflected within Home Assistant.
Please note, the lawn mower integration cannot be directly used; you cannot create your own lawn mower entities using this integration. This integration is a building block for other integrations to use, enabling them to create lawn mower entities for you.
## Services
Available services: `start_mowing`, `pause` and `dock`.
Before calling one of these services, make sure your lawn_mower platform supports it.
### Service `lawn_mower.start_mowing`
Start or resume a mowing task.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |
### Service `lawn_mower.pause`
Pause a mowing task.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |
### Service `lawn_mower.dock`
Tell the lawn_mower to return to dock.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |

View File

@ -0,0 +1,222 @@
---
title: "MQTT Lawn Mower"
description: "Instructions on how to integrate MQTT lawn mowers into Home Assistant."
ha_category:
- Lawn Mower
ha_release: 2023.9
ha_iot_class: Configurable
ha_domain: mqtt
---
The `mqtt` `lawn_mower` platform allows controlling a lawn mower over MQTT.
## Configuration
To enable MQTT Lawn Mower in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
mqtt:
- lawn_mower:
command_topic: topic
name: "Test Lawn Mower"
```
{% configuration %}
activity_state_topic:
description: The MQTT topic subscribed to receive an update of the activity. Valid activities are `mowing`, `paused`, `docked`, and `error`. Use `value_template` to extract the activity state from a custom payload. When payload `none` is received, the activity state will be reset to `unknown`.
required: false
type: string
activity_value_template:
description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the value."
required: false
type: template
availability:
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
required: false
type: list
keys:
payload_available:
description: The payload that represents the available state.
required: false
type: string
default: online
payload_not_available:
description: The payload that represents the unavailable state.
required: false
type: string
default: offline
topic:
description: An MQTT topic subscribed to receive availability (online/offline) updates.
required: true
type: string
value_template:
description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the device's availability from the `topic`. To determine the device's availability, the result of this template will be compared to `payload_available` and `payload_not_available`."
required: false
type: template
availability_topic:
description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`.
required: false
type: string
availability_mode:
description: When `availability` is configured, this controls the conditions needed to set the entity to `available`. Valid entries are `all`, `any`, and `latest`. If set to `all`, `payload_available` must be received on all configured availability topics before the entity is marked as online. If set to `any`, `payload_available` must be received on at least one configured availability topic before the entity is marked as online. If set to `latest`, the last `payload_available` or `payload_not_available` received on any configured availability topic controls the availability.
required: false
type: string
default: latest
availability_template:
description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract device's availability from the `availability_topic`. To determine the devices's availability, the result of this template will be compared to `payload_available` and `payload_not_available`."
required: false
type: template
device:
description: "Information about the device this lawn mower is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when the [`unique_id`](#unique_id) is set. At least one of the identifiers or connections must be present to identify the device."
required: false
type: map
keys:
configuration_url:
description: 'A link to the webpage that can manage the configuration of this device. Can be either an `http://`, `https://`, or an internal `homeassistant://` URL.'
required: false
type: string
connections:
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
type: [list, string]
manufacturer:
description: The manufacturer of the device.
required: false
type: string
model:
description: The model of the device.
required: false
type: string
name:
description: The name of the device.
required: false
type: string
suggested_area:
description: 'Suggest an area if the device isnt in one yet.'
required: false
type: string
sw_version:
description: The firmware version of the device.
required: false
type: string
via_device:
description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs or parent devices of a sub-device. This is used to show the device topology in Home Assistant.'
required: false
type: string
dock_command_template:
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `dock_command_topic`. The `value` parameter in the template will be set to `dock`.
required: false
type: template
dock_command_topic:
description: The MQTT topic that publishes commands when the service `lawn_mower.dock` service call is executed. The value `dock` is published when the service is called. Use a `dock_command_template` to publish a custom format.
required: false
type: string
enabled_by_default:
description: Flag which defines if the entity should be enabled when first added.
required: false
type: boolean
default: true
encoding:
description: The encoding of the payloads received and published messages. Set to `""` to disable decoding of the incoming payload.
required: false
type: string
default: "utf-8"
entity_category:
description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity.
required: false
type: string
default: None
icon:
description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity."
required: false
type: icon
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
type: template
json_attributes_topic:
description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as entity attributes. Implies `force_update` of the current activity state when a message is received on this topic.
required: false
type: string
name:
description: The name of the lawn mower. Can be set to `null` if only the device name is relevant.
required: false
type: string
object_id:
description: Used instead of `name` for automatic generation of `entity_id`
required: false
type: string
optimistic:
description: Flag that defines if the lawn mower works in optimistic mode.
required: false
type: boolean
default: "`true` if no `state_topic` defined, else `false`."
pause_command_template:
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `pause_command_topic`. The `value` parameter in the template will be set to `pause`.
required: false
type: template
pause_command_topic:
description: The MQTT topic that publishes commands when the service `lawn_mower.pause` service call is executed. The value `pause` is published when the service is called. Use a `pause_command_template` to publish a custom format.
required: false
type: string
qos:
description: The maximum QoS level to be used when receiving and publishing messages.
required: false
type: integer
default: 0
start_mowing_template:
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `dock_command_topic`. The `value` parameter in the template will be set to `dock`.
required: false
type: template
start_mowing_command_topic:
description: The MQTT topic that publishes commands when the service `lawn_mower.start_mowing` service call is executed. The value `start_mowing` is published when the service is called. Use a `start_mowing_command_template` to publish a custom format.
required: false
type: string
retain:
description: If the published message should have the retain flag on or not.
required: false
type: boolean
default: false
unique_id:
description: An ID that uniquely identifies this lawn mower. If two lawn mowers have the same unique ID, Home Assistant will raise an exception.
required: false
type: string
{% endconfiguration %}
<div class='note warning'>
Make sure that your topic matches exactly. `some-topic/` and `some-topic` are different topics.
</div>
## Example
The example below shows how to use a single command topic with a command template.
{% raw %}
```yaml
# Example configuration.yaml entry
mqtt:
- alarm_control_panel:
name: "Lawn Mower Plus"
activity_state_topic: "lawn_mower_plus/state"
activity_value_template: "{{ value_json.activity }}"
pause_command_topic: "lawn_mower_plus/set"
pause_command_template: '{"activity": "{{ value }}"}'
dock_command_topic: "lawn_mower_plus/set"
dock_command_template: '{"activity": "{{ value }}"}'
start_mowing_command_topic: "lawn_mower_plus/set"
start_mowing_command_template: '{"activity": "{{ value }}"}'
```
{% endraw %}

View File

@ -8,6 +8,8 @@ ha_release: 0.49
ha_quality_scale: internal
ha_domain: media_extractor
ha_integration_type: integration
ha_codeowners:
- '@joostlek'
---
The `media_extractor` integration gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly.

View File

@ -1,5 +1,5 @@
---
title: modbus
title: Modbus
description: Instructions on how to integrate modbus and platforms.
ha_category:
- Hub
@ -613,7 +613,8 @@ climates:
required: true
type: integer
write_registers:
description: "Request type, use `write_registers` if true else `write_register`."
description: "Request type, use `write_registers` if true else `write_register`.
If more than one value is specified for a specific mode, only the first one is used for writing to the register."
required: false
type: boolean
default: false
@ -625,15 +626,15 @@ climates:
state_off:
description: "Value corresponding to HVAC Off mode."
required: false
type: integer
type: [integer, list]
state_heat:
description: "Value corresponding to HVAC Heat mode."
required: false
type: integer
type: [integer, list]
state_cool:
description: "Value corresponding to HVAC Cool mode."
required: false
type: integer
type: [integer, list]
state_auto:
description: "Value corresponding to HVAC Auto mode."
required: false
@ -641,15 +642,15 @@ climates:
state_dry:
description: "Value corresponding to HVAC Dry mode."
required: false
type: integer
type: [integer, list]
state_fan_only:
description: "Value corresponding to HVAC Fan only mode."
required: false
type: integer
type: [integer, list]
state_heat_cool:
description: "Value corresponding to HVAC Heat/Cool mode."
required: false
type: integer
type: [integer, list]
hvac_onoff_register:
description: "Address of On/Off state.
When zero is read from this register, the HVAC state is set to Off, otherwise the `hvac_mode_register`
@ -1252,6 +1253,14 @@ sensors:
description: "The maximum allowed value of a sensor. If value > max_value --> max_value. Can be float or integer"
required: false
type: float
nan_value:
description: If a Modbus sensor has a defined NaN value, this value can be set as a hex string starting with `0x` containing one or more bytes (for example, `0xFFFF` or `0x80000000`) or provided as an integer directly. If triggered, the sensor becomes `unavailable`. Please note that the hex to int conversion for `nan_value` does currently not obey home-assistants Modbus encoding using the `data_type`, `structure`, or `swap` arguments.
required: false
type: string
zero_suppress:
description: Suppress values close to zero. If -zero_suppress <= value <= +zero_suppress --> 0. Can be float or integer
required: false
type: float
offset:
description: "Final offset (output = scale * value + offset)."
required: false
@ -1282,6 +1291,10 @@ sensors:
required: false
type: string
default: ">f"
slave_count:
description: Generates x-1 slave sensors, allowing read of multiple registers with a single read message.
required: false
type: integer
swap:
description: "Swap the order of bytes/words, **not valid with `custom` and `datatype: string`**"
required: false
@ -1523,14 +1536,14 @@ Some parameters exclude other parameters, the following tables show what can be
The modbus integration provides two generic write services in addition to the platform-specific services.
| Service | Description |
| ------- | ----------- |
| --------------------- | --------------------------- |
| modbus.write_register | Write register or registers |
| modbus.write_coil | Write coil or coils |
Description:
| Attribute | Description |
| --------- | ----------- |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| hub | Hub name (defaults to 'modbus_hub' when omitted) |
| unit | Slave address (0-255), alternative to slave |
| slave | Slave address (0-255), alternative to unit |
@ -1541,14 +1554,14 @@ Description:
The modbus integration also provides communication stop/restart services. These services will not do any reconfiguring, but simply stop/start the modbus communication layer.
| Service | Description |
| ------- | ----------- |
| -------------- | --------------------------------------------- |
| modbus.stop | Stop communication |
| modbus.restart | Restart communication (Stop first if running) |
Description:
| Attribute | Description |
| --------- | ----------- |
| --------- | ------------------------------------------------ |
| hub | Hub name (defaults to 'modbus_hub' when omitted) |
## Example: writing a float32 type register
@ -1567,13 +1580,13 @@ data:
## Service `modbus.set-temperature`
| Service | Description |
| ------- | ----------- |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| set_temperature | Set temperature. Requires `value` to be passed in, which is the desired target temperature. `value` should be in the same type as `data_type` |
## Service `modbus.set_hvac_mode`
| Service | Description |
| ------- | ----------- |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| set_hvac_mode | Set HVAC mode. Requires `value` to be passed in, which is the desired mode. `value` should be a valid HVAC mode. A mapping between the desired state and the value to be written to the HVAC mode register must exist. Calling this service will also set the On/Off register to an appropriate value, if such a register is defined. |

View File

@ -3,7 +3,7 @@ title: Moon
description: Instructions on how to integrate the moon sensor into Home Assistant.
ha_category:
- Environment
ha_iot_class: Local Polling
ha_iot_class: Calculated
ha_release: 0.38
ha_quality_scale: internal
ha_codeowners:

View File

@ -227,6 +227,7 @@ The discovery of MQTT devices will enable one to use MQTT devices with only mini
- [Humidifier](/integrations/humidifier.mqtt/)
- [Image](/integrations/image.mqtt/)
- [Climate/HVAC](/integrations/climate.mqtt/)
- [Lawn Mower](/integrations/lawn_mower.mqtt/)
- [Light](/integrations/light.mqtt/)
- [Lock](/integrations/lock.mqtt/)
- [Number](/integrations/number.mqtt/)
@ -276,6 +277,18 @@ In the value of configuration variables ending with `_topic`, `~` will be replac
Configuration variable names in the discovery payload may be abbreviated to conserve memory when sending a discovery message from memory constrained devices.
It is encouraged to add additional information about the origin that supplies MQTT entities via MQTT discovery by adding the `origin` option (can abbreviated to `o`) to the discovery payload. Note that these options also support abbreviations. Information of the origin will be logged to the core event log when an item is discovered or updated.
{% configuration_basic %}
name:
description: The name of the application that is the origin the discovered MQTT item. This option is required.
sw_version:
description: Software version of the application that supplies the discovered MQTT item.
support_url:
description: Support URL of the application that supplies the discovered MQTT item.
{% endconfiguration_basic %}
{% details "Supported abbreviations" %}
```txt
@ -391,6 +404,7 @@ Configuration variable names in the discovery payload may be abbreviated to cons
'mode_stat_t': 'mode_state_topic',
'modes': 'modes',
'name': 'name',
'o': 'origin',
'obj_id': 'object_id',
'off_dly': 'off_delay',
'on_cmd_type': 'on_command_type',
@ -555,6 +569,14 @@ Configuration variable names in the discovery payload may be abbreviated to cons
'sa': 'suggested_area',
```
{% enddetails %}
{% details "Supported abbreviations for origin info" %}
```txt
'name': 'name',
'sw': 'sw_version',
'url': 'support_url',
```
{% enddetails %}
### Support by third-party tools
@ -679,7 +701,7 @@ Setting up a [light that takes JSON payloads](/integrations/light.mqtt/#json-sch
{
"~": "homeassistant/light/kitchen",
"name": "Kitchen",
"unique_id": "kitchen_light",
"uniq_id": "kitchen_light",
"cmd_t": "~/set",
"stat_t": "~/state",
"schema": "json",
@ -687,6 +709,32 @@ Setting up a [light that takes JSON payloads](/integrations/light.mqtt/#json-sch
}
```
#### Example with using abbreviated Device and Origin info in discovery messages
```json
{
"~": "homeassistant/light/kitchen",
"name": null,
"uniq_id": "kitchen_light",
"cmd_t": "~/set",
"stat_t": "~/state",
"schema": "json",
"dev": {
"ids": "ea334450945afc",
"name": "Kitchen",
"mf": "Bla electronics",
"mdl": "xya",
"sw": "1.0",
"hw": "1.0rev2",
},
"o": {
"name":"bla2mqtt",
"sw": "2.1",
"url": "https://bla2mqtt.example.com/support",
}
}
```
#### Use object_id to influence the entity id
The entity id is automatically generated from the entity's name. All MQTT integrations optionally support providing an `object_id` which will be used instead if provided.
@ -750,6 +798,7 @@ mqtt:
- [Humidifier](/integrations/humidifier.mqtt/)
- [Image](/integrations/imahe.mqtt/)
- [Climate/HVACs](/integrations/climate.mqtt/)
- [Lawn Mower](/integrations/lawn_mower.mqtt/)
- [Light](/integrations/light.mqtt/)
- [Lock](/integrations/lock.mqtt/)
- [Number](/integrations/number.mqtt/)

View File

@ -2,6 +2,7 @@
title: Neato Botvac
description: Instructions on how to integrate your Neato within Home Assistant.
ha_category:
- Button
- Camera
- Sensor
- Switch
@ -14,6 +15,7 @@ ha_codeowners:
- '@Santobert'
ha_domain: neato
ha_platforms:
- button
- camera
- sensor
- switch
@ -28,6 +30,7 @@ There is support for the following platform types within Home Assistant:
- **Camera** - allows you to view the latest cleaning map.
- **Sensor** - allows you to view the battery level.
- **Switch** - allows you to enable or disable the schedule.
- [**Button**](#button) - allows you to dismiss an alert visible in the app.
- [**Vacuum**](#vacuum)
## Prerequisites
@ -73,6 +76,10 @@ After the update to firmware 4.0 (which adds cleaning maps) there is also suppor
</div>
## Button
Each `neato` vacuum has a _Dismiss alert_ button. This allows to dismiss an alert visible in the app (e.g. dust bin full) and preventing the vacuum to start cleaning.
## Vacuum
The `neato` vacuum platform allows you to control your [Neato Botvac Connected][botvac-connected].

View File

@ -17,7 +17,6 @@ ha_domain: nest
ha_quality_scale: platinum
ha_dhcp: true
ha_platforms:
- binary_sensor
- camera
- climate
- diagnostics

View File

@ -18,6 +18,7 @@ ha_platforms:
- binary_sensor
- climate
- diagnostics
- number
- scene
- sensor
- switch
@ -71,6 +72,10 @@ The following thermostats are not supported: `XL624`, `XL950`, `AZONE950`, `AZEM
Other thermostats may work, but they have not been tested.
### Number
The number platform lets you adjust the fan speed on systems with variable-speed fan support.
### Scene
The scene platform lets you activate a nexia automation.

View File

@ -20,6 +20,40 @@ For each county/city it creates warning slots that change to Unsafe when warning
{% include integrations/config_flow.md %}
### Filter
The integration includes the possibility to filter warnings in two ways via a regex.
<div class='note'>
All filters are applied to lowercase text only.
</div>
#### Headline filter
This filter filters warnings based on the headline as a **blacklist**. In other words, if the regular expression matches the headline of the warning, the warning will be **ignored**.
Default: Match nothing (`/(?!)/`)
##### Example
Ignore warnings that contain the word `corona`
Regex: `.*corona.*` <br>
Headline: `corona-verordnung des landes: warnstufe durch landesgesundheitsamt ausgerufen`
#### Affected area filter
This filter **whitelists** warnings based on the affected area. In other words, if the regular expression matches the area, the warning will be **displayed**.
Default: Match all (`.*`)
##### Example
Show only warnings from the city of nagold.
Regex: `.*nagold.*` <br>
Areas: `gemeinde oberreichenbach, gemeinde neuweiler, stadt nagold`
### Attributes
| Attribute | Description |
@ -28,6 +62,8 @@ For each county/city it creates warning slots that change to Unsafe when warning
| `description` | *(str)* Official description of the warning. |
| `sender` | *(str)* Sender of the warning. Can be empty. |
| `severity` | *(str)* Severity of the warning. <br>Extreme - Extraordinary threat to life or property <br>Severe - Significant threat to life or property <br>Moderate - Possible threat to life or property <br>Minor Minimal to no known threat to life or property <br>Unknown - Severity unknown |
| `recommended_actions` | *(str)* The recommendations for action. |
| `affected_areas` | *(str)* Areas where the warning applies. |
| `id` | *(str)* Individual ID for each warning. |
| `sent` | *(time)* Transmission time and date (UTC) of the issued warning. |
| `start` | *(time)* Starting time and date (UTC) of the issued warning. Can be empty. |

View File

@ -29,6 +29,12 @@ altitude:
description: The maximum altitude in meters in which the planes are tracked. No input (or 0) means all planes in the area are tracked.
{% endconfiguration_basic %}
## Authentication
By default, polling is done every 15 minutes not to hit the API limit.
More API requests are allowed as authenticated users.
You can add your credentials after setting up the integration.
## Events
- **opensky_entry**: Fired when a flight enters the region.

View File

@ -17,8 +17,10 @@ ha_integration_type: integration
The Opower integration allows you to get energy information from utilities that use [Opower](https://www.oracle.com/industries/utilities/opower-energy-efficiency/).
More than 175 utilities use Opower. Currently only the following ones are supported:
More than 175 utilities use Opower. Currently only the following utilities are supported by this integration:
- Consolidated Edison (ConEd) and subsidiaries
- Orange & Rockland Utilities (ORU)
- Evergy
- Exelon subsidiaries
- Atlantic City Electric
@ -30,9 +32,35 @@ More than 175 utilities use Opower. Currently only the following ones are suppor
- Pacific Gas & Electric (PG&E)
- Puget Sound Energy (PSE)
To add this integration to your installation, you will need your login username and password for your utility website. Two-factor authentication is not supported.
When you add the Opower integration to Home Assistant, you will need to provide your utility account's authentication details to enable retrieving your energy data.
This is typically the same information needed to access your utility's website.
When using Opower with any of the Exelon subsidiaries, you need to actively disable two-factor authentication. Log onto the website, select **Don't use 2FA** and **Don't ask me again**. If you have already enabled 2FA, disable it.
## Utility Authentication Requirements
For many utilities, only a username and password are required to access your accounts. Some utilities requires additional authentication information.
It might be necessary to configure your utility account with an authentication method that is compatible with the Opower integration.
Utility-specific authentication requirements are listed below:
### Consolidated Edison (ConEd)
Your ConEd account must be set up to use two-factor authentication using time-based one time passwords (TOTP). Other authentication methods, such as secret questions, are not supported.
When adding the Opower ConEd integration you will need to provide the TOTP secret that is used to synchronize your authenticator app, such as Google Authenticator, to your ConEd account.
NOTE: The TOTP secret is not one of the 6 digit time-based numeric codes.
It is a string of around 16 characters containing the shared secret that enables your authenticator app to generate the correct time-based code at the appropriate time.
The QR codes used for setting up TOTP accounts contain the secret.
Using the TOTP secret, the Opower integration will be able to generate the correct time-based code when it needs to authenticate to the ConEd website.
If you have an existing TOTP set up, there are methods for exporting the account from your authenticator app and then using a tool to obtain the TOTP secret from the encoded string.
Alternatively, you can create a new TOTP secret for your account and use the "no camera to scan" option to capture the TOTP secret. You may also want to capture the QR code by taking a picture, or using a QR code scanner. There are tools available that can decode the TOTP data from a QR code.
**NOTE: At this time, ConEd only has a single TOTP set up per account. Therefore, it is important that you configure the same TOTP secret for ConEd access in both Opower and your authenticator app.**
### Exelon subsidiaries
When using Opower with any of the Exelon subsidiaries, such as such as BGE, ComEd, PECO, Pepco, etc., you need to actively disable two-factor authentication. Log onto the website, select **Don't use 2FA** and **Don't ask me again**. If you have already enabled 2FA, disable it.
{% include integrations/config_flow.md %}

View File

@ -0,0 +1,20 @@
---
title: Orange and Rockland Utilities (ORU) Opower
description: Get energy usage from Orange and Rockland Utilities using the Opower integration
ha_category:
- Energy
- Sensor
ha_release: 2023.8
ha_domain: oru_opower
ha_integration_type: virtual
ha_supporting_domain: opower
ha_supporting_integration: Opower
ha_codeowners:
- '@tronikos'
ha_config_flow: true
ha_platforms:
- sensor
ha_iot_class: Cloud Polling
---
{% include integrations/supported_brand.md %}

View File

@ -1,6 +1,6 @@
---
title: PEGELONLINE
description: Instructions on how to integrate Radarr sensors with Home Assistant
description: Instructions on how to integrate PEGELONLINE measurements into Home Assistant.
ha_category:
- Environment
- Sensor
@ -15,6 +15,21 @@ ha_codeowners:
ha_integration_type: service
---
This integration uses the data from the German Federal Waterways and Shipping Administration (_Wasserstraßen- und Schifffahrtsverwaltung des Bundes_) [PEGELONLINE](https://www.pegelonline.wsv.de/) to provide water level sensors.
This integration uses the data from the German Federal Waterways and Shipping Administration (_Wasserstraßen- und Schifffahrtsverwaltung des Bundes_) [PEGELONLINE](https://www.pegelonline.wsv.de/) to provide different [sensors](#sensors), based on the available data of the selected measurement station.
{% include integrations/config_flow.md %}
## Sensors
Currently, the integration supports the following sensors:
| Sensor name | Common unit of measurement |
| --- | --- |
| Air temperature | °C |
| Clearance height (_only for bridges_) | cm |
| Oxygen level | mg/l |
| pH | `None` |
| Water flow speed | m/s |
| Water level | cm |
| Water temperature | °C |
| Water volume flow | m³/s |

View File

@ -2,6 +2,7 @@
title: Renson
description: Instructions on how to integrate Renson Endura Delta sensors into Home Assistant.
ha_category:
- Binary Sensor
- Sensor
ha_release: 2023.7
ha_iot_class: Local Polling
@ -10,6 +11,7 @@ ha_codeowners:
- '@jimmyd-be'
ha_domain: renson
ha_platforms:
- binary_sensor
- sensor
ha_integration_type: integration
---

View File

@ -77,9 +77,13 @@ Depending on the supported features of the camera, number entities are added for
- Guard return time
- Motion sensitivity
- AI face sensitivity
- AI people sensitivity
- AI person sensitivity
- AI vehicle sensitivity
- AI pet sensitivity
- AI face delay*
- AI person delay*
- AI vehicle delay*
- AI pet delay*
- Auto quick reply time
- Auto track limit left
- Auto track limit right
@ -104,11 +108,13 @@ Depending on the supported features of the camera, button entities are added for
- PTZ up
- PTZ down
- PTZ calibrate
- PTZ zoom in*
- PTZ zoom out*
- Guard go to
- Guard set current position
- Restart*
PTZ left, right, up and down will continually move the camera in the respective position until the PTZ stop is called or the hardware limit is reached.
PTZ left, right, up, down, zoom in and zoom out will continually move the camera in the respective position until the PTZ stop is called or the hardware limit is reached.
"Guard set current position" will set the current position as the new guard position.
@ -168,6 +174,7 @@ When IR light entity is OFF always OFF, when ON IR LEDs will be on when the came
Depending on the supported features of the camera, the following sensor entities are added:
- PTZ pan position
- Wi-Fi signal*
## Update entity

View File

@ -13,8 +13,6 @@ ha_platforms:
- sensor
- switch
ha_integration_type: integration
ha_codeowners:
- '@epenet'
---
The `rest` sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The sensor has support for GET and POST requests.

View File

@ -8,10 +8,11 @@ ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@gabe565'
- '@lanrat'
ha_domain: ruckus_unleashed
ha_platforms:
- device_tracker
ha_integration_type: integration
ha_integration_type: hub
---
This platform allows you to connect to a [Ruckus Unleashed](https://support.ruckuswireless.com/product_families/19-ruckus-unleashed) access point.

View File

@ -0,0 +1,42 @@
---
title: Schlage
description: Instructions on how to integrate Schlage WiFi smart locks into Home Assistant.
ha_category:
- Lock
- Sensor
- Switch
ha_release: 2023.9
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@dknowles2'
ha_platforms:
- lock
- sensor
- switch
ha_integration_type: integration
ha_domain: schlage
---
The Schlage integration provides connectivity with Schlage WiFi smart locks through Schlage's cloud API.
{% include integrations/config_flow.md %}
There is currently support for the following device types within Home Assistant:
- Lock
- Sensor
- Switch
## Sensor
Once you have enabled the Schlage integration, you should see the following sensors:
- Lock Battery
## Switch
Once you have enabled the Schlage integration, you should see the following switches:
- **1-Touch Locking** - When enabled, locks the lock with a press of the Schlage button.
- **Keypress Beep** - Controls whether the lock will emit beeping tones on use.

View File

@ -8,7 +8,6 @@ ha_iot_class: Cloud Polling
ha_codeowners:
- '@fabaff'
- '@gjohansson-ST'
- '@epenet'
ha_domain: scrape
ha_platforms:
- sensor

View File

@ -56,6 +56,10 @@ authentication:
description: Type of the HTTP authentication. `basic` or `digest`.
required: false
type: string
availability:
description: Defines a template if the entity state is available or not.
required: false
type: template
device_class:
description: Sets the [class of the device](/integrations/sensor#device-class), changing the device state and icon that is displayed on the frontend.
required: false

View File

@ -282,6 +282,16 @@ The first will allow specifying a temperature, the second instead of a percentag
will be disabled.
As soon as you change the temperature, it gets enabled again.
## Shelly Gas with Valve add-on
If you have Valve add-on connected to Shelly Gas, the integration will create two entities for the valve. The `switch` entity allows you to control the valve, the `sensor` entity shows exact states of the valve.
<div class="note">
The `switch` entity in Home Assistant does not support transition states. For this reason, the `opening` state of the valve maps to the `on` (opened) state of the entity and the `closing` state of the valve maps to the `off` (closed) state of the entity.
</div>
## CoAP port (generation 1)
In some cases, it may be needed to customize the CoAP UDP port (default: `5683`) your Home Assistant instance is listening to.

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate Starlink into Home Assistant.
ha_category:
- Binary Sensor
- Button
- Device Tracker
- Network
- Sensor
- Switch
@ -16,6 +17,7 @@ ha_domain: starlink
ha_platforms:
- binary_sensor
- button
- device_tracker
- diagnostics
- sensor
- switch
@ -59,3 +61,7 @@ The Starlink integration allows you to integrate your [Starlink](https://www.sta
### Switch
- Stowed - Controls whether Dishy is stowed
### Device Tracker
- Device location - Tracks the location of Dishy. Note you need to allow location access on the local network via the Starlink app for this to work. This is disabled by default in the Starlink app and is thus disabled by default in Home Assistant.

View File

@ -48,7 +48,7 @@ api_key:
required: true
type: string
total_bandwidth:
description: Your bandwidth limit in gigabytes. Set to `0` for unlimited plans without a cap.
description: Your data limit in gigabytes. Set to `0` for unlimited plans without a cap.
required: true
type: string
monitored_conditions:
@ -57,27 +57,27 @@ monitored_conditions:
type: list
keys:
usage:
description: Bandwidth usage (percentage).
description: Data usage (percentage). This sensor is not supported for unlimited plans.
usage_gb:
description: Bandwidth usage (gigabytes).
description: Data usage (gigabytes).
limit:
description: Monthly bandwidth limit (gigabytes).
description: Monthly data limit (gigabytes). This sensor is not supported for unlimited plans.
used_download:
description: Bandwidth used by download outside the grace period (gigabytes).
description: Data used by download outside the grace period (gigabytes).
used_upload:
description: Bandwidth used by upload outside the grace period (gigabytes).
description: Data used by upload outside the grace period (gigabytes).
used_total:
description: Total bandwidth (download and upload sum calculation) used outside the grace period (gigabytes).
description: Total data (download and upload sum calculation) used outside the grace period (gigabytes).
grace_download:
description: Bandwidth used by download during the grace period (gigabytes).
description: Data used by download during the grace period (gigabytes).
grace_upload:
description: Bandwidth used by upload during the grace period (gigabytes).
description: Data used by upload during the grace period (gigabytes).
grace_total:
description: Total bandwidth (download and upload sum calculation) used during the unlimited period (gigabytes).
description: Total data (download and upload sum calculation) used during the unlimited period (gigabytes).
total_download:
description: Total bandwidth download (Grace + Used) (gigabytes).
description: Total data download (Grace + Used) (gigabytes).
total_upload:
description: Total bandwidth upload (Grace + Used) (gigabytes).
description: Total data upload (Grace + Used) (gigabytes).
used_remaining:
description: Remaining bandwidth calculated from used and supplied total bandwidth (gigabytes).
description: Remaining bandwidth calculated from used and supplied total bandwidth (gigabytes). This sensor is not supported for unlimited plans.
{% endconfiguration %}

View File

@ -4,6 +4,7 @@ description: Instructions on how to setup your Subaru account with Home Assistan
ha_category:
- Car
- Lock
- Presence Detection
- Sensor
ha_release: 2021.3
ha_iot_class: Cloud Polling
@ -12,6 +13,7 @@ ha_codeowners:
- '@G-Two'
ha_domain: subaru
ha_platforms:
- device_tracker
- diagnostics
- lock
- sensor
@ -34,7 +36,7 @@ Subaru has deployed two generations of telematics, Gen 1 and Gen 2. The latter o
| Outback | 2016-2019 | 2020+ |
| WRX | 2017+ | |
In addition to the telematics generational differences, there are two levels of STARLINK subscriptions, "Safety Plus" and "Security Plus". All remote services (such as locks) require a "Security Plus" level subscription.
In addition to the telematics generational differences, there are two levels of STARLINK subscriptions, "Safety Plus" and "Security Plus". All remote services (such as locks and location tracking) require a "Security Plus" level subscription.
{% include integrations/config_flow.md %}
@ -67,6 +69,11 @@ This integration supports remote locking and unlocking of vehicle doors.
The current lock status is always unknown due to the fact that the Subaru API does not report this data.
</p>
## Device Tracker
Tracks the most recently reported location of the vehicle. The vehicle reports its location when it is turned off.
## Options
Subaru integration options are set via:

View File

@ -38,8 +38,20 @@ method:
name:
description: Name of the REST Switch.
required: false
type: string
type: template
default: REST Switch
icon:
description: Defines a template for the icon of the entity.
required: false
type: template
picture:
description: Defines a template for the entity picture of the entity.
required: false
type: template
availability:
description: Defines a template if the entity state is available or not.
required: false
type: template
device_class:
description: Sets the [class of the device](/integrations/switch/#device-class), changing the device state and icon that is displayed on the frontend.
required: false

View File

@ -11,7 +11,6 @@ ha_category:
ha_release: 0.78
ha_iot_class: Local Push
ha_codeowners:
- '@bdraco'
- '@danielhiversen'
- '@RenierM26'
- '@murtas'

View File

@ -137,3 +137,26 @@ data:
bridge: "deviceid"
text: "Hello"
```
### Service `system_bridge.power_command`
Sends power command to the system.
{% my developer_call_service service="system_bridge.power_command" title="Show service in your Home Assistant instance." %}
```yaml
service: system_bridge.power_command
data:
bridge: "device"
command: "sleep"
```
Supported commands are:
- `hibernate`
- `lock`
- `logout`
- `restart`
- `shutdown`
- `sleep`

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate Template Sensors into Home Assista
ha_category:
- Binary Sensor
- Button
- Helper
- Image
- Number
- Select
@ -31,7 +32,8 @@ ha_platforms:
- switch
- vacuum
- weather
ha_integration_type: integration
ha_integration_type: helper
ha_config_flow: true
---
The `template` integration allows creating entities which derive their values from other data. This is done by specifying [templates](/docs/configuration/templating/) for properties of an entity, like the name or the state.
@ -112,6 +114,10 @@ unique_id:
description: The unique ID for this config block. This will be prefixed to all unique IDs of all entities in this block.
required: false
type: string
action:
description: Define actions to be executed when the trigger fires. Optional. Variables set by the action script are available when evaluating entity templates. This can be used to interact with anything via services, in particular services with [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data). [See action documentation](/docs/automation/action).
required: false
type: list
sensor:
description: List of sensors
required: true
@ -660,6 +666,36 @@ template:
{% endraw %}
### Trigger based handling of service response data
This example demonstrates how to use an `action` to call a [service with response data](/docs/scripts/service-calls/#use-templates-to-handle-response-data)
and use the response in a template.
{% raw %}
```yaml
template:
- trigger:
- platform: time_pattern
hours: /1
action:
- service: weather.get_forecast
data:
type: hourly
target:
entity_id: weather.home
response_variable: hourly
sensor:
- name: Weather Forecast Hourly
unique_id: weather_forecast_hourly
state: "{{ now().isoformat() }}"
attributes:
forecast: "{{ hourly.forecast }}"
```
{% endraw %}
## Legacy binary sensor configuration format
_This format still works but is no longer recommended. [Use modern configuration](#configuration-variables)._

View File

@ -5,7 +5,7 @@ ha_category:
- Binary Sensor
- Helper
ha_release: 0.89
ha_iot_class: Local Push
ha_iot_class: Calculated
ha_quality_scale: internal
ha_config_flow: true
ha_domain: tod

View File

@ -0,0 +1,31 @@
---
title: Trafikverket Camera
description: Instructions how to integrate Trafikverket Camera within Home Assistant.
ha_category:
- Camera
ha_release: 2023.9
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@gjohansson-ST'
ha_domain: trafikverket_camera
ha_platforms:
- camera
ha_integration_type: integration
---
Retrieve camera feed from [Trafikverket](https://www.trafikverket.se/).
The name of the location needs to be precisely as Trafikverket has them. See examples and look for your camera [here](https://www.trafikverket.se/trafikinformation/vag/?TrafficType=personalTraffic&map=0%2F650778%2F7200000%2F&Layers=TrafficCameras%2B=)
## Prerequisites
Please click [here](https://api.trafikinfo.trafikverket.se/) and register to obtain the API key.
{% include integrations/config_flow.md %}
## Additional attributes
- Location (placement of camera)
- Description (free text description)
- Type (Type of camera)

View File

@ -37,6 +37,8 @@ Retrieve train departure information from [Trafikverket](https://www.trafikverke
The next departure is calculated from actual, estimated, and planned to provide the most accurate information about departure.
You can filter based on product descriptions such as `SJ Regionaltåg` to only see specific trains between the two stations.
## Prerequisites
Please click [here](https://api.trafikinfo.trafikverket.se/) and register to obtain the API key.

View File

@ -17,6 +17,7 @@ ha_codeowners:
ha_domain: unifi
ha_ssdp: true
ha_platforms:
- button
- device_tracker
- diagnostics
- image
@ -30,6 +31,7 @@ ha_integration_type: hub
There is currently support for the following device types within Home Assistant:
- [Button](#button)
- [Image](#image)
- [Presence Detection](#presence-detection)
- [Switch](#switch)
@ -58,6 +60,10 @@ The UniFi Network application can either be a UniFi OS console device (like the
It is recommended that you run the UniFi Network application in a dedicated virtual machine to avoid that situation.
## Button
Provides the ability to restart a UniFi device. This feature requires admin privileges.
## Image
Provides QR Code images that can be scanned to easily join a specific WLAN. Entities are disabled by default. This feature requires admin privileges.
@ -104,6 +110,10 @@ Provides per-port PoE control. Entities are disabled by default. This feature re
Entities appear automatically for each restriction group. If there are no restrictions in a group, no entity will be visible. Toggling the switch in Home Assistant will enable or disable all restrictions inside a group.
### Control Port forward functonality
Entities appear for each port forwarding rule.
### Control WLAN availability
Entities appear for each WLAN. Changing the state of WLAN will trigger a reconfiguration of affected access points, limiting access to all WLANs exposed by the access point.
@ -122,6 +132,10 @@ Entities reporting connected clients to a WLAN.
Get entities reporting uptime per network client.
### Power Outlet sensor
Get entities reporting the power utilization for outlets that support metrics (such as the AC outlets on the USP-PDU-Pro).
## Firmware updates
This will show if there are firmware updates available for the UniFi network devices connected to the controller. If the configured user has admin privileges, the firmware upgrades can also be installed directly from Home Assistant.

View File

@ -0,0 +1,51 @@
---
title: Vodafone Station
description: Instructions on how to integrate Vodafone Station routers into Home Assistant.
ha_category:
- Presence Detection
ha_release: 2023.9
ha_domain: vodafone_station
ha_config_flow: true
ha_codeowners:
- '@paoloantinori'
- '@chemelli74'
ha_iot_class: Local Polling
ha_platforms:
- device_tracker
ha_integration_type: integration
---
The Vodafone Station integration allows you to control your [Vodafone Station](https://www.vodafone.it/privati/area-supporto/assistenza-dispositivi/vodafone-station.html) based router.
There is support for the following platform types within Home Assistant:
- **Device tracker** - presence detection by looking at connected devices.
{% include integrations/config_flow.md %}
## Configuration
The configuration in the UI asks for a a few information: host, username, password and SSL.
Depending on the model of the router, the login URL can be based on http:// or https://.
The default username is `vodafone`.
## Integration options
It is possible to change some behaviors through the integration options.
To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. On the **Vodafone Station** integration, select the cogwheel. Then select **Configure**.
- **Consider home**: Number of seconds that must elapse before considering a disconnected device "not at home".
## Additional info
### Device Tracker
**Note**: If you don't want to automatically track newly detected devices, disable the integration system option `Enable new added entities`.
### Tested models
This integartion was tested against the following models:
- Vodafone Power Station
- Vodafone WiFi 6 Station

View File

@ -15,7 +15,10 @@ The `weather` platforms gather meteorological information from web services and
Home Assistant currently supports free web services some of which require registration.
## Condition mapping
## State and state attributes
A weather entity's state is used to indicate the current overall conditions, e.g. 'cloudy' or 'sunny'.
### Condition mapping
The `weather` platform only knows the below listed conditions. The reason for this is that for these conditions is an icon from [Material Design Icons](https://pictogrammers.com/library/mdi/) available and mapped in the frontend.
@ -35,21 +38,85 @@ The `weather` platform only knows the below listed conditions. The reason for th
- 'windy-variant'
- 'exceptional'
### Forecast Information
### State attributes
Periodic forecast information is stored in the `forecast` attribute on the entity. To access and use the information should be reserved for advanced users using [Templates](/docs/configuration/templating/).
Detailed weather conditions as well as the unit of measurements used for the conditions are indicated by state attributes. A weather entity may not support all the state attributes.
{% raw %}
```yaml
temperature: 14.2
temperature_unit: °C
apparent_temperature: 12.0
cloud_coverage: 0
dew_point: 5.0
humidity: 76
precipitation_unit: mm
pressure: 1019
pressure_unit: hPa
temperature: 14.2
temperature_unit: °C
uv_index: 2
visibility: 10
visibility_unit: km
wind_bearing: 260
wind_gust_speed: 51.56
wind_speed: 35.17
wind_speed_unit: km/h
visibility_unit: km
precipitation_unit: mm
```
{% endraw %}
## Service `weather.get_forecast`
Weather integrations which support weather forecasts expose the forecast using services. The services provided by weather entities are described below, and you can also read more about [Service Calls](/docs/scripts/service-calls/).
<div class='note'>
Some integrations may not support the `weather.get_forecast` service, but instead expose weather forecasts as a state attribute named `forecast`. This behavior is deprecated and will be removed in a future release of Home Assistant Core.
</div>
This service populates [Response Data](/docs/scripts/service-calls#use-templates-to-handle-response-data)
with a weather forecast.
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `type` | no | The type of forecast, must be one of `daily`, `twice_daily` or `hourly`. | daily
{% raw %}
```yaml
service: weather.get_forecast
target:
entity_id: weather.home
data:
type: daily
response_variable: weather_forecast
```
{% endraw %}
The response data field `forecast` is a list of forecasted conditions at a given point in time:
| Response data | Description | Example |
| ---------------------- | ----------- | -------- |
| `datetime` | The time of the forecasted conditions. | 2023-02-17T14:00:00+00:00
| `is_daytime` | Only set for `twice_daily` forecasts. | False
| `apparent_temperature` | The apparent (feels-like) temperature in the unit indicated by the `temperature_unit` state attribute. | 10.2
| `cloud_coverage` | The cloud coverage in %. | 15
| `condition` | The weather condition. | Sunny
| `dew_point` | The dew point temperature in the unit indicated by the `temperature_unit` state attribute. | 6.0
| `humidity` | The relative humidity in %. | 82
| `precipitation_probability` | The probability of precipitation in %. | 0
| `precipitation` | The precipitation amount in the unit indicated by the `precipitation_unit` state attribute. | 0
| `pressure` | The air pressure in the unit indicated by the `pressure_unit` state attribute. | 1019
| `temperature` | The temperature in the unit indicated by the `temperature_unit` state attribute. If templow is also provided, this is the higher temperature. | 14.2
| `templow` | The lower temperature in the unit indicated by the `temperature_unit` state attribute. | 5.0
| `uv_index` | The UV index. | 3
| `wind_bearing` | The wind bearing in azimuth angle (degrees) or 1-3 letter cardinal direction. | 268
| `wind_gust_speed` | The wind gust speed in the unit indicated by the `wind_speed_unit` state attribute. | 34.41
| `wind_speed` | The wind speed in the unit indicated by the `wind_speed_unit` state attribute. | 24.41
Example forecast:
{% raw %}
```yaml
forecast:
- condition: cloudy
precipitation_probability: 0
@ -76,3 +143,4 @@ forecast:
wind_speed: 20.27
precipitation: 0
```
{% endraw %}

View File

@ -34,7 +34,7 @@ weather:
temperature_template: "{{ states('sensor.temperature') | float }}"
temperature_unit: "°C"
humidity_template: "{{ states('sensor.humidity') | float }}"
forecast_template: "{{ state_attr('weather.my_region', 'forecast') }}"
forecast_daily_template: "{{ state_attr('weather.my_region', 'forecast') }}"
```
{% endraw %}
@ -43,7 +43,7 @@ weather:
name:
description: Name to use in the frontend.
required: true
type: string
type: template
unique_id:
description: An ID that uniquely identifies this weather entity. Set this to a unique value to allow customization through the UI.
required: false
@ -116,10 +116,18 @@ visibility_unit:
description: Unit for visibility_template output. Valid options are km, mi, ft, m, cm, mm, in, yd.
required: false
type: string
forecast_template:
forecast_daily_template:
description: Daily forecast data.
required: false
type: template
forecast_hourly_template:
description: Hourly forecast data.
required: false
type: template
forecast_twice_daily_template:
description: Twice daily forecast data.
required: false
type: template
precipitation_unit:
description: Unit for precipitation output. Valid options are km, mi, ft, m, cm, mm, in, yd.
required: false

View File

@ -81,4 +81,3 @@ use_webhook:
default: false
type: boolean
{% endconfiguration %}

View File

@ -0,0 +1,28 @@
---
title: Yardian
description: Instructions on how to integrate Yardian device within Home Assistant.
ha_category:
- Irrigation
- Switch
ha_config_flow: true
ha_release: 2023.9
ha_iot_class: Local Polling
ha_codeowners:
- '@h3l1o5'
ha_domain: yardian
ha_platforms:
- switch
ha_integration_type: integration
---
The Yardian integration allows you to control your [Yardian Smart Sprinkler Controller](https://yardian.com/products/yardian-pro-smart-sprinkler-controller/).
There is currently support for the following platform within Home Assistant:
- [Switch](#switch) - Allows you to view the status of zones and control them.
{% include integrations/config_flow.md %}
During the configuration, you will have to manually set the **Host** and the **Access Token**. You can find them inside your [Yardian App](https://yardian.com/app/).
![Yardian Host/Token Location](/images/integrations/yardian/yardian_config_flow.jpg)

View File

@ -203,6 +203,7 @@ Some devices can be auto-discovered, which can simplify the ZHA setup process. T
| [Tubes EFR32 Pro Ethernet/Serial Coordinator](https://www.tubeszb.com/) | USB | 10C4:EA60 |
| [ZigStar Coordinators](https://zig-star.com/) | USB | 1A86:7523 |
| [SMLIGHT SLZB-06 POE Zigbee LAN WiFi USB Adapter](https://smlight.tech/product/slzb-06/) | Zeroconf | slzb-06.local. |
| [ZigStar UZG Universal Zigbee Gateway (UZG-01)](https://uzg.zig-star.com) | Zeroconf | uzg-01._tcp.local. |
| [ZigStar LAN/POE Coordinators](https://zig-star.com/projects/zigbee-gw-lan/) | Zeroconf | zigstargw.local. |
| [Tube's CC2652P2 USB-powered Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_cc2652p2.local. |
| [Tube's CC2652P2 PoE-powered Zigbee to Ethernet Serial Coordinator)](https://www.tubeszb.com/) | Zeroconf | tube_zb_gw_cc2652p2_poe.local. |

View File

@ -0,0 +1,582 @@
---
layout: post
title: "2023.9: New climate entity dialogs, lots of tile features, and template sensors from the UI!"
description: "New entity dialogs for climate and others, lots of tile features, create template sensors from the UI and more!"
date: 2023-09-06 00:00:00
date_formatted: "September 6, 2023"
author: Bram Kragten
author_twitter: bramkragten
comments: true
categories:
- Release-Notes
- Core
og_image: /images/blog/2023-09/social.png
---
<a href='/integrations/#version/2023.9'><img src='/images/blog/2023-09/social.png' style='border: 0;box-shadow: none;'></a>
Home Assistant Core 2023.9! 🎉
Frenck is enjoying a well earned holiday, so I'm taking care of the release this month.
This month, on the 17th, it has been 10 years since Home Assistant started. We'll be preparing a special event on the [Home Assistant YouTube channel](https://www.youtube.com/channel/UCbX3YkedQunLt7EQAdVxh7w) to celebrate, reflect and look ahead. We will have some cool announcements too! We hope you can join us on the 17th @ 12:00 PDT / 21:00 CET!
This release is pretty packed! With some very nice updates to the UI with new entity dialogs for climate entities, and lots of tile card features. Template sensors can be created from the UI now, and for the more advanced template sensors, the ability to get data from services!
A new service to get the weather forecast, and better options to display different forecasts.
And something you will probably not see when you are already using Home Assistant: the onboarding flow is completely redesigned!
I absolutely love it!
Enjoy the release!
Bram
<!--more-->
- [New climate, humidifier, and water heater entity dialogs](#new-climate-humidifier-and-water-heater-entity-dialogs)
- [Lots of new tile features](#lots-of-new-tile-features)
- [Lawn mower](#lawn-mower)
- [Group previews](#group-previews)
- [Template sensors from the UI](#template-sensors-from-the-ui)
- [Weather forecast service](#weather-forecast-service)
- [Onboarding](#onboarding)
- [Other noteworthy changes](#other-noteworthy-changes)
- [New integrations](#new-integrations)
- [Need help? Join the community!](#need-help-join-the-community)
- [Breaking changes](#breaking-changes)
- [All changes](#all-changes)
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=JSNRrWk9IHs)
6 September 2023, at 12:00 PDT / 21:00 CEST!
<lite-youtube videoid="JSNRrWk9IHs" videotitle="Home Assistant 2023.9 Release Party"></lite-youtube>
## New climate, humidifier, and water heater entity dialogs
The entity dialogs for climate, humidifier, and water heater entities got an update, and if you ask me, it looks absolutely stunning!
It now has a newly designed circular slider showing the current and target temperatures and allows you to easily swipe to the desired target temperature.
There are also dedicated buttons to change the target, so it is easy to use if you are not using a touchscreen.
It will glow in the middle to show its current action, for example when it is heating or cooling.
<p class='img'>
<img src='/images/blog/2023-09/climate-card.png'>
Screenshot of the more info dialog of a climate entity.
</p>
## Lots of new tile features
The tile card gets many new features this release.
The features of a tile card are a great way to bring more functionalities directly into your dashboard, without needing to open the more info dialog.
- HVAC mode
- Water heater mode
- Temperature control
- Cover position
- Cover tilt
- Lawn mower commands
- Color temperature
<p class='img'>
<img src='/images/blog/2023-09/tile-features.png'>
Screenshot of tile cards with the new features.
</p>
## Lawn mower
A new entity type was added this release: the lawn mower!
You can now integrate your lawn mower into Home Assistant!
Never worry about the lawn mower when it starts raining, you can now automate the lawn mower to stop and go back when it rains.
For now, just MQTT is supported, but keep an eye out for other integrations!
<p class='img'>
<img src='/images/blog/2023-09/lawn-mower.png'>
Screenshot of the more info dialog of a lawn mower entity.
</p>
## Group previews
When setting up a helper, sometimes it can be useful to see how the entity that you are creating looks while you are setting it up. That's why we added a preview when you create or change a group helper.
It will show exactly what the entity will look like with the current settings.
And talking about groups, we also got a new group, the `event` group!
<p class='img'>
<img src='/images/blog/2023-09/group-preview.png'>
Screenshot of creating a sensor group.
</p>
## Template sensors from the UI
We also added preview support to another helper that finally made its way into the UI, the template sensor.
From the UI you can use a template to set the state of the sensor.
You can pick a unit of measurement, set the device class, and select a state class.
Both sensors and binary sensors are supported.
This will make most of the use cases for template sensors available through the UI and one less need for YAML!
Other more advanced fields, like attributes, are unavailable from the UI. You will still have to set those up in YAML.
With the preview, you see a live update of the sensor value while writing the template.
<p class='img'>
<img src='/images/blog/2023-09/template-sensor.png'>
Screenshot of creating a template sensor.
</p>
## Actions for trigger template entities
Trigger template entities can now have an action block that is executed after the trigger but before the entities are rendered.
This will allow users to fetch things like calendar events and weather forecasts using services with responses and use them in their template entities. You can even use OpenAI to set the value of your entities now!
All variables from the action block will be available in the template.
An example that checks at midnight if you have something on your calendar tomorrow and sets a binary sensor:
{% raw %}
```yaml
template:
- trigger:
- platform: time
at: "00:00:00"
action:
- service: calendar.list_events
target:
entity_id: calendar.calendar
data:
start_date_time: "{{ today_at() + timedelta(days=1) }}"
duration:
hours: 24
response_variable: events
binary_sensor:
- name: Calendar events tomorrow
state: "{{ events.events is defined and events.events | count > 0 }}"
```
{% endraw %}
## Weather forecast service
We added a new service for weather entities, `weather.get_forecast`, that responds with the weather forecast.
Previously you would have to look at the `forecast` attribute of a weather entity to get the forecast, now this can be done by calling a new service, `weather.get_forecast`, that will respond with the forecast.
You can also specify what type of forecast you want. Do you want to see the forecast by day or do you want to know it for every hour? This means you no longer need separate entities for every forecast type, but it can all be done in 1 entity.
All weather integrations are updated to support this new service.
<p class='img'>
<img src='/images/blog/2023-09/get-forecast-service.png'>
Screenshot of service developer tools showing the weather forecast service.
</p>
If an entity supports multiple forecasts, you can choose which forecast you want to see in the more info dialog.
In the weather card in your dashboard, you can also now pick what kind of weather forecast you want to show in that card.
<p class='img'>
<img src='/images/blog/2023-09/weather-more-info.png'>
Screenshot of the weather more info dialog.
</p>
With this change, the `forecast` attribute of the weather entity is deprecated, and will be removed in Home Assistant Core 2024.3.
This will make it possible to have on-demand forecasts, that update when you want them to, instead of them being updated all the time.
It will also make the system faster; all state data gets sent to your browser or mobile app every time it is opened so the frontend has the latest states of your entities. The forecast attribute makes the state of weather entities very big, causing everything to be loaded slower.
While the way to access this data has changed and may impact your automations, you will not experience any loss in functionality. Even with this change, rest assured that the forecast cards in your dashboard will still work, they will now just use the service to retrieve the forecast data asynchronously instead of reading it from the state attribute. The end result is that your dashboards will load faster, and the frontend will be leaner.
You can use the newly added `action` part of a template entity to fetch the forecast and use it in your template:
{% raw %}
```yaml
template:
- trigger:
- platform: time
at: "00:00:00"
action:
- service: weather.get_forecast
target:
entity_id: weather.home
data:
type: daily
response_variable: forecast
binary_sensor:
- name: Is it going to rain?
state: "{{ forecast.forecast[0].precipitation > 0 }}"
```
{% endraw %}
## Onboarding
While it is certain that Home Assistant is a great tool once you understand how it works, one part that was often overlooked is its associated learning curve.
We are now actively working to flatten that curve so that you can get more from your home faster and simpler.
This release shows the first result of that effort, a new onboarding flow.
Something you probably have not seen for a while, but we gave our onboarding a fresh new look! It is shortened to get users in Home Assistant as fast as possible, so they can enjoy tinkering with their home faster!
<p class='img'>
<img src='/images/blog/2023-09/onboarding.png'>
Screenshot of the onboarding screen.
</p>
## Other noteworthy changes
There are many more improvements in this release; here are some of the other
noteworthy changes this release:
- [Enphase Envoy] has gotten a lot of love this release, ensure it works
perfectly with the latest firmware available. Thanks [@bdraco] and [@cgarwood]!
- The [Shelly] integration now supports the Shelly Gas Valve addon. Thanks [@bieniu]!
- [@starkillerOG] added zoom buttons and AI detection delay time controls to
the [Reolink] integration. Nice!
- You can now set separate damping factors for morning and evening in the
[Forecast Solar] integration. Thanks [@joostlek]!
- [@Kane610] added a restart device button to the [UniFi] integration. Thanks!
- The [Tomorrow.io] integration now reports humidity and dew point in its weather
forecasts. Thanks [@lymanepp]!
- Support for soil moisture sensors was added to the [Gardena] integration.
Thanks [@elupus]!
- [@timmo001] added a power service to the [System Bridge] integration. Thanks!
- If you change your password, you will be asked if you want to logout everywhere.
- The file and image upload elements have been revamped.
- You can now sort the options of an input select entity. Thanks [@karwosts]!
- Local Bluetooth has been optimized and is now faster, thanks [@bdraco]!
[@karwosts]: https://github.com/karwosts
[@bdraco]: https://github.com/bdraco
[@bieniu]: https://github.com/bieniu
[@cgarwood]: https://github.com/cgarwood
[@elupus]: https://github.com/elupus
[@joostlek]: https://github.com/joostlek
[@Kane610]: https://github.com/Kane610
[@lymanepp]: https://github.com/lymanepp
[@starkillerOG]: https://github.com/starkillerOG
[@timmo001]: https://github.com/timmo001
[Enphase Envoy]: /integrations/enphase_envoy
[Forecast Solar]: /integrations/forecast_solar
[Gardena]: /integrations/gardena
[Reolink]: /integrations/reolink
[Shelly]: /integrations/shelly
[System Bridge]: /integrations/system_bridge
[Tomorrow.io]: /integrations/tomorrowio
[Unifi]: /integrations/unifi
## New integrations
We welcome the following new integrations in this release:
- **[Comelit SimpleHome]**, added by [@chemelli74]<br />
Control your Comelit home automation devices.
- **[Lawn mower]**, added by [@mikey0000]<br />
A new entity type, that allows integrations to provide lawn mower entities.
- **[Schlage]**, added by [@dknowles2]<br />
Use your Schlage WiFi smart locks with Home Assistant.
- **[Trafikverket Camera]**, added by [@gjohansson-ST]<br />
Adds Swedish traffic camera feeds from Trafikverket.
- **[Vodafone Station]**, added by [@chemelli74]<br />
Provides device tracker support for Vodafone Station router.
- **[Yardian]**, added by [@h3l1o5]<br />
Support for your Yardan Smart Sprinkler Controller.
This release also has a new virtual integration. Virtual integrations are stubs that are handled by other (existing) integrations to help with findability. These are new:
- **[Consolidated Edison (ConEd)]** provided by [Opower]
- **[Orange and Rockland Utilities (ORU) Opower]** provided by [Opower]
[@chemelli74]: https://github.com/chemelli74
[@dknowles2]: https://github.com/dknowles2
[@gjohansson-ST]: http://github.com/gjohansson-ST
[@h3l1o5]: https://github.com/h3l1o5
[@mikey0000]: https://github.com/mikey0000
[Comelit SimpleHome]: /integrations/comelit
[Lawn mower]: /integrations/lawn_mower
[Schlage]: /integrations/schlage
[Trafikverket Camera]: /integrations/trafikverket_camera
[Vodafone Station]: /integrations/vodafone_station
[Yardian]: /integrations/yardian
[Opower]: /integrations/opower
[Consolidated Edison (ConEd)]: /integrations/coned
[Orange and Rockland Utilities (ORU) Opower]: /integrations/oru_opower
## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing
to help each other out. So, join us!
Our very active [Discord chat server](/join-chat) is an excellent place to be
at, and don't forget to join our amazing [forums](https://community.home-assistant.io/).
Found a bug or issue? Please report it in our [issue tracker](https://github.com/home-assistant/core/issues),
to get it fixed! Or, check [our help page](/help) for guidance for more
places you can go.
Are you more into email? [Sign-up for our Building the Open Home Newsletter](/newsletter)
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
## Breaking changes
{% details "BMW Connected Drive" %}
The "Refresh from cloud" button has been removed. Use the
`homeassistant.update_entity` service with any BMW entity for a
full reload instead.
([@rikroe] - [#97864]) ([documentation](/integrations/bmw_connected_drive))
[@rikroe]: https://github.com/rikroe
[#97864]: https://github.com/home-assistant/core/pull/97864
{% enddetails %}
{% details "DoorBird" %}
The `doorbird_reset_favorites` event is no longer fired when the clear webhook
is called. Note: this event was never documented.
([@bdraco] - [#98585]) ([documentation](/integrations/doorbird))
[@bdraco]: https://github.com/bdraco
[#98585]: https://github.com/home-assistant/core/pull/98585
{% enddetails %}
{% details "Enphase Envoy" %}
Envoy versions < 3.9 (pre-API) are no longer supported as they require
web scraping which is disallowed by [ADR-0004](https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md).
([@bdraco] - [#97862]) ([documentation](/integrations/enphase_envoy))
[@bdraco]: https://github.com/bdraco
[#97862]: https://github.com/home-assistant/core/pull/97862
{% enddetails %}
{% details "ESPHome" %}
To prevent cross-linked devices, replacing an ESPHome device with a different
board is no longer allowed. Instead, delete the integration entry and re-add
the new device when the mac address of the board changes.
([@bdraco] - [#98787]) ([documentation](/integrations/esphome))
[@bdraco]: https://github.com/bdraco
[#98787]: https://github.com/home-assistant/core/pull/98787
{% enddetails %}
{% details "EZVIZ" %}
Only switches supported by the camera will be created. Non switchable switches have been removed.
([@RenierM26] - [#95672]) ([documentation](/integrations/ezviz))
[@RenierM26]: https://github.com/RenierM26
[#95672]: https://github.com/home-assistant/core/pull/95672
{% enddetails %}
{% details "Flume" %}
You might get false positives for leak detected and high flow sensors if you
have old unread notifications in the Flume app.
Before, the leak detected and high flow sensors would only trigger until you
read the notification in the Flume app which was too late for Home Assistant
to take any automated action.
Now, they trigger regardless if you have read or not the notification. They will
remain active until you delete the notification in the Flume app,
similar to [the old behavior documented](/integrations/flume/#notifications).
([@tronikos] - [#98560]) ([documentation](/integrations/flume))
[@tronikos]: https://github.com/tronikos
[#98560]: https://github.com/home-assistant/core/pull/98560
{% enddetails %}
{% details "Hive" %}
The previously deprecated service `hive.boost_heating` has been removed.
([@gjohansson-ST] - [#97444]) ([documentation](/integrations/hive))
[@gjohansson-ST]: https://github.com/gjohansson-ST
[#97444]: https://github.com/home-assistant/core/pull/97444
{% enddetails %}
{% details "HTTP / Webserver" %}
Home Assistant can't be put in an iframe anymore by default. If you still want
to embed the Home Assistant interface in a frame, you can do so by disabling
`use_x_frame_options` by setting it to `false` in the `http` configuration.
([@frenck] - [#97784]) ([documentation](/integrations/http))
[@frenck]: https://github.com/frenck
[#97784]: https://github.com/home-assistant/core/pull/97784
{% enddetails %}
{% details "Météo-France" %}
The Météo-France weather entities have been updated:
- The `forecast` state attribute is deprecated and will be removed in
Home Assistant Core 2024.3, you should instead use the `weather.get_forecast`
service.
- The config entry option to select hourly or daily forecast can no longer be
adjusted, but any existing configuration of the forecast period will be
respected until Home Assistant Core 2024.3.
- Météo-France now provides a single weather entity which supports both
hourly and daily forecast.
([@emontnemery] - [#98022]) ([documentation](/integrations/meteo_france))
[@emontnemery]: https://github.com/emontnemery
[#98022]: https://github.com/home-assistant/core/pull/98022
{% enddetails %}
{% details "Mill" %}
Mill has moved to a new IoT solution and released a new API. The unique ID from
the old API is no longer available, so all devices will be shown as new devices.
Support for the heater fan will be added later.
([@Danielhiversen] - [#97497]) ([documentation](/integrations/mill))
[@Danielhiversen]: https://github.com/Danielhiversen
[#97497]: https://github.com/home-assistant/core/pull/97497
{% enddetails %}
{% details "MQTT" %}
MQTT device trackers no longer always update when there is no state change.
This means that automations that trigger on a state change no longer are
triggered if there is no change.
([@jbouwh] - [#98838]) ([documentation](/integrations/mqtt))
[@jbouwh]: https://github.com/jbouwh
[#98838]: https://github.com/home-assistant/core/pull/98838
{% enddetails %}
{% details "Nextcloud" %}
The CPU load sensor has been replaced, it is not a list of 3 values anymore,
but there are now three single sensors for
CPU load within last 1, 5, and 15 minutes.
([@mib1185] - [#99141]) ([documentation](/integrations/nextcloud))
[@mib1185]: https://github.com/mib1185
[#99141]: https://github.com/home-assistant/core/pull/99141
{% enddetails %}
{% details "Plugwise" %}
The `maximum_boiler_temperature` sensor entity has been replaced by a number
entity, allowing control as well.
([@CoMPaTech] - [#97203]) ([documentation](/integrations/plugwise))
[@CoMPaTech]: https://github.com/CoMPaTech
[#97203]: https://github.com/home-assistant/core/pull/97203
---
The additional schema state attributes of the climate entity have been removed.
They have beeen previously replaced by a select entity.
([@bouwew] - [#98153]) ([documentation](/integrations/plugwise))
[@bouwew]: https://github.com/bouwew
[#98153]: https://github.com/home-assistant/core/pull/98153
{% enddetails %}
{% details "Start.ca" %}
Start.ca `limit`, `usage`, and `used_remaining` sensors will no longer be created
when there's no bandwidth cap.
([@emontnemery] - [#98525]) ([documentation](/integrations/startca))
[@emontnemery]: https://github.com/emontnemery
[#98525]: https://github.com/home-assistant/core/pull/98525
{% enddetails %}
{% details "Trafikverket Train" %}
All attributes have been converted into their own sensors.
The original sensor is now renamed with suffix "Departure time".
Any automation or script depending on these attributes needs to be adjusted
to use these new sensors.
([@gjohansson-ST] - [#71432]) ([documentation](/integrations/trafikverket_train))
[@gjohansson-ST]: https://github.com/gjohansson-ST
[#71432]: https://github.com/home-assistant/core/pull/71432
{% enddetails %}
{% details "Z-Wave" %}
The entity naming logic has been updated to be less brittle. As a result,
some `zwave_js` entities that you haven't given a custom name to may be renamed.
Since they are registered in the entity registry, the entity IDs will not change
and your automations should therefore not be impacted by the change.
([@raman325] - [#98140]) ([documentation](/integrations/zwave_js))
With this release, you will need to update your zwave-js-server instance. You must use zwave-js-server 1.31.0 or greater (schema 31).
If you use the Z-Wave JS add-on, you need at least version 0.1.88.
If you use the Z-Wave JS UI add-on, you need at least version 1.15.9.
If you use the Z-Wave JS UI Docker container, you need at least version 8.23.2.
If you run your own Docker container or some other installation method, you will need to update your zwave-js-server instance to at least 1.31.0.
([@raman325] - [#99250]) ([documentation](/integrations/zwave_js))
[@raman325]: https://github.com/raman325
[#98140]: https://github.com/home-assistant/core/pull/98140
[#99250]: https://github.com/home-assistant/core/pull/99250
{% enddetails %}
If you are a custom integration developer and want to learn about breaking
changes and new features available for your integration: Be sure to follow our
[developer blog][devblog]. The following are the most notable for this release:
- [Entity state formatting](https://developers.home-assistant.io/blog/2023/08/29/hass-format-state)
- [HomeAssistant.__init__ requires passing a string to it](https://developers.home-assistant.io/blog/2023/08/29/homeassistant-changed-signature)
- [Numerical sensors are no longer allowed to set their state to NaN or inf](https://developers.home-assistant.io/blog/2023/08/23/sensor-updates)
- [Weather entity forecast types](https://developers.home-assistant.io/blog/2023/08/07/weather_entity_forecast_types/)
[devblog]: https://developers.home-assistant.io/blog/
## All changes
Of course, there is a lot more in this release. You can find a list of
all changes made here: [Full changelog for Home Assistant Core 2023.9](/changelogs/core-2023.9)

File diff suppressed because it is too large Load Diff

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 179 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.1 KiB

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.9 KiB

After

Width:  |  Height:  |  Size: 8.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB