Improve entities documentation (#37666)

* Improve entities documentation

* Add a note at options to make the user know that a click is needed to see the options

* Don't bold "(click to view)"

* Fix notes

* Use the right name of the section

* Fix typos

* Fix typo

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Apply suggestion

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Improve details section of program select entities

* Apply suggestion

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Add possible values to enumeration sensors

* Fixes

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Add missing blank line

* Wrap entities in a collapsible

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
J. Diego Rodríguez Royo 2025-02-25 12:51:47 +01:00 committed by GitHub
parent abcc04c615
commit f9d4a0415c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -33,36 +33,10 @@ ha_integration_type: integration
The Home Connect integration allows users to integrate their home appliances supporting the Home Connect standard for Bosch and Siemens using the [official cloud API](https://developer.home-connect.com).
The integration will add one Home Assistant device for each connected home appliance which will have the following entities:
- A power switch
- If the device has programs:
- Two select entities that will allow you to select and start a program between the available ones.
- A timestamp sensor for remaining time and a numeric sensor for the progress percentage.
- Light:
- Hoods:
- Functional light: on/off and brightness
- Ambient light: on/off, brightness, HSV and RGB
- Dishwasher: on/off, brightness, HS and RGB
- Cooling appliances: Both, external and internal lights, on/off and brightness
- Numbers that set the temperature of cooling appliances.
- Time for alarm clock for cooktops and ovens.
- Multiple sensors that report the different states and events reported by the appliance.
- Binary sensors that show binary states of the appliance.
- Buttons to pause, resume, and stop the running program, as well as to open the door either completely or partially.
{% note %}
Some appliances don't report data while they are turned off so corresponding entities will not appear in the Home Connect integration after loading until the appliances are turned on.
{% endnote %}
{% note %}
Note that it depends on the appliance and on API permissions which of the features are supported.
{% endnote %}
{% note %}
Some devices only have the state `on` and turn off is not supported by the appliance, check [power state availability at Home Connect API documentation](https://api-docs.home-connect.com/settings/#power-state) for more information.
{% endnote %}
## Prerequisites
1. Visit [https://developer.home-connect.com](https://developer.home-connect.com) and sign up for a developer account.
@ -111,6 +85,825 @@ This integration follows standard integration removal. No extra steps are requir
After deleting the integration, go to [your applications at the Home Connect Developer portal](https://developer.home-connect.com/applications), find the application that you were using for Home Assistant, click on details and click on "Delete Application".
## Supported functionality
{% note %}
- The entities availability depends on the appliance type, but the appliance might not support all the entities for its type.
- Some appliances don't report data while they are turned off, so corresponding entities will not appear in the Home Connect integration after loading until the appliances are turned on.
{% endnote %}
### Binary sensor
{% details "List of binary sensors" %}
- **Connectivity**:
- **Description**: Shows the connectivity status of the appliance.
- **Availability**: All appliances
- **Remote control**:
- **Description**: Indicates if the remote control is enabled.
- **Availability**: Cooktop, Hood, Oven, Warming Drawer, Dishwasher, Washer, Dryer, Washer Dryer
- **Remote start**:
- **Description**: Indicates if a program can be started remotely.
- **Availability**: Coffee maker, Hood, Oven, Warming Drawer, Dishwasher, Washer, Dryer, Washer Dryer
- **Local control**:
- **Description**: Indicates whether the home appliance is currently physically controlled by the user.
- **Availability**: Coffee maker, Cooktop, Hood, Oven, Warming Drawer, Washer, Dryer, Washer Dryer
- **Bottle cooler door**:
- **Description**: Indicates if the bottle cooler door is open.
- **Availability**: Fridge freezer, Refrigerator
- **Chiller door**:
- **Description**: Indicates if the chiller door is open.
- **Availability**: Fridge freezer, Refrigerator
- **Flex compartment door**:
- **Description**: Indicates if the flex compartment door is open.
- **Availability**: Fridge freezer
- **Freezer door**:
- **Description**: Indicates if the freezer door is open.
- **Availability**: Freezer, Fridge freezer
- **Refrigerator door**:
- **Description**: Indicates if the refrigerator door is open.
- **Availability**: Fridge freezer, Refrigerator
- **Wine compartment door**:
- **Description**: Indicates if the wine compartment door is open.
- **Availability**: Wine cooler
- **Battery charging state**:
- **Description**: Describes if the appliance is charging or discharging.
- **Availability**: Cleaning robot
- **Charging connection**:
- **Description**: Indicates if the appliance is connected or disconnected.
- **Availability**: Cleaning robot
{% enddetails %}
### Button
{% details "List of buttons" %}
- **Stop program**:
- **Description**: Stops the active program.
- **Availability**: All the appliances with programs
- **Pause program**
- **Description**: Pauses the active program.
- **Availability**: Oven, Cleaning robot, Washer, Dryer, Washer dryer
- **Resume program**
- **Description**: Resumes the paused program.
- **Availability**: Oven, Cleaning robot, Dishwasher, Washer, Dryer, Washer dryer
- **Open door**
- **Description**: Opens the door of the appliance.
- **Availability**: Oven, Freezer, Fridge freezer, Refrigerator
- **Partial open door**
- **Description**: Opens the door of the appliance partially.
- **Availability**: Oven
{% enddetails %}
### Light
{% details "List of light entities" %}
- **Internal light**:
- **Description**: Controls the internal light of cooling appliances.
- **Availability**: Freezer, Fridge freezer, Refrigerator, Wine cooler
- **Controls**: On/off, brightness
- **External light**:
- **Description**: Controls the external light of cooling appliances.
- **Availability**: Freezer, Fridge freezer, Refrigerator, Wine cooler
- **Controls**: On/off, brightness
- **Functional light**:
- **Description**: Controls the functional light of a hood.
- **Availability**: Hood
- **Controls**: On/off, brightness
- **Ambient light**:
- **Description**: Controls the ambient light of an appliance.
- **Availability**: Hood, Dishwasher
- **Controls**: On/off, brightness, HSV, RGB
{% enddetails %}
### Number
{% details "List of number entities" %}
#### Settings
- **Refrigerator setpoint temperature**:
- **Description**: Sets the refrigerator temperature.
- **Availability**: Fridge freezer, Refrigerator
- **Freezer setpoint temperature**:
- **Description**: Sets the freezer temperature.
- **Availability**: Freezer, Fridge freezer
- **Bottle cooler setpoint temperature**:
- **Description**: Sets the bottle cooler temperature.
- **Availability**: Fridge freezer, Refrigerator
- **Chiller setpoint temperature**:
- **Description**: Sets the chiller temperature.
- **Availability**: Fridge freezer, Refrigerator
- **Left Chiller setpoint temperature**:
- **Description**: Sets the left chiller temperature.
- **Availability**: Fridge freezer, Refrigerator
- **Right Chiller setpoint temperature**:
- **Description**: Sets the right chiller temperature.
- **Availability**: Fridge freezer, Refrigerator
- **Wine compartment setpoint temperature**:
- **Description**: Sets the wine compartment temperature.
- **Availability**: Wine cooler
- **Wine compartment 2 setpoint temperature**:
- **Description**: Sets the second wine compartment temperature.
- **Availability**: Wine cooler
- **Wine compartment 3 setpoint temperature**:
- **Description**: Sets the third wine compartment temperature.
- **Availability**: Wine cooler
- **Color temperature percent**:
- **Description**: Sets the color temperature of the functional light in percent (warm light: 0 %, cold light: 100 %). To use it, Color temperature select entity must be set to `custom`.
- **Availability**: Hood
- **i-Dos 1 Base Level**:
- **Description**: Sets the basis dosing volume for i-Dos content 1.
- **Availability**: Washer, Washer dryer
- **i-Dos 2 Base Level**:
- **Description**: Sets the basis dosing volume for i-Dos content 2.
- **Availability**: Washer, Washer dryer
#### Program options
- **Duration**:
- **Description**: Defines the run-time of the program. Afterwards, the appliance is stopped.
- **Availability**: Oven
- **Start in relative**:
- **Description**: Defines when the program should start, in seconds from now.
- **Availability**: Oven, Dishwasher
- **Finish in relative**:
- **Description**: Defines when the program should end, in seconds from now.
- **Availability**: Dryer, Washer, Washer dryer
- **Fill quantity**:
- **Description**: Describes the amount of water (in ml) used in a coffee machine program.
- **Availability**: Coffee maker
- **Setpoint temperature**:
- **Description**: Defines the target cavity temperature, which will be held by the oven.
- **Availability**: Oven
{% enddetails %}
### Select
{% details "List of select entities" %}
#### Programs
- **Active program**:
- **Description**: Represents the active program of the appliance, and selecting an option will start the program.
- **Availability**: All the appliances with programs
- **Selected program**:
- **Description**: Represents the selected program of the appliance, and selecting an option will select the program.
- **Availability**: All the appliances with programs
{% details "Program options" %}
Both entities can use these options, but the availability of these will depend on the appliance.
- **Clean all**: `consumer_products_cleaning_robot_program_cleaning_clean_all`
- **Clean map**: `consumer_products_cleaning_robot_program_cleaning_clean_map`
- **Go home**: `consumer_products_cleaning_robot_program_basic_go_home`
- **Ristretto**: `consumer_products_coffee_maker_program_beverage_ristretto`
- **Espresso**: `consumer_products_coffee_maker_program_beverage_espresso`
- **Espresso doppio**: `consumer_products_coffee_maker_program_beverage_espresso_doppio`
- **Coffee**: `consumer_products_coffee_maker_program_beverage_coffee`
- **XL coffee**: `consumer_products_coffee_maker_program_beverage_x_l_coffee`
- **Caffe grande**: `consumer_products_coffee_maker_program_beverage_caffe_grande`
- **Espresso macchiato**: `consumer_products_coffee_maker_program_beverage_espresso_macchiato`
- **Cappuccino**: `consumer_products_coffee_maker_program_beverage_cappuccino`
- **Latte macchiato**: `consumer_products_coffee_maker_program_beverage_latte_macchiato`
- **Caffe latte**: `consumer_products_coffee_maker_program_beverage_caffe_latte`
- **Milk froth**: `consumer_products_coffee_maker_program_beverage_milk_froth`
- **Warm milk**: `consumer_products_coffee_maker_program_beverage_warm_milk`
- **Kleiner brauner**: `consumer_products_coffee_maker_program_coffee_world_kleiner_brauner`
- **Grosser brauner**: `consumer_products_coffee_maker_program_coffee_world_grosser_brauner`
- **Verlaengerter**: `consumer_products_coffee_maker_program_coffee_world_verlaengerter`
- **Verlaengerter braun**: `consumer_products_coffee_maker_program_coffee_world_verlaengerter_braun`
- **Wiener melange**: `consumer_products_coffee_maker_program_coffee_world_wiener_melange`
- **Flat white**: `consumer_products_coffee_maker_program_coffee_world_flat_white`
- **Cortado**: `consumer_products_coffee_maker_program_coffee_world_cortado`
- **Cafe cortado**: `consumer_products_coffee_maker_program_coffee_world_cafe_cortado`
- **Cafe con leche**: `consumer_products_coffee_maker_program_coffee_world_cafe_con_leche`
- **Cafe au lait**: `consumer_products_coffee_maker_program_coffee_world_cafe_au_lait`
- **Doppio**: `consumer_products_coffee_maker_program_coffee_world_doppio`
- **Kaapi**: `consumer_products_coffee_maker_program_coffee_world_kaapi`
- **Koffie verkeerd**: `consumer_products_coffee_maker_program_coffee_world_koffie_verkeerd`
- **Galao**: `consumer_products_coffee_maker_program_coffee_world_galao`
- **Garoto**: `consumer_products_coffee_maker_program_coffee_world_garoto`
- **Americano**: `consumer_products_coffee_maker_program_coffee_world_americano`
- **Red eye**: `consumer_products_coffee_maker_program_coffee_world_red_eye`
- **Black eye**: `consumer_products_coffee_maker_program_coffee_world_black_eye`
- **Dead eye**: `consumer_products_coffee_maker_program_coffee_world_dead_eye`
- **Hot water**: `consumer_products_coffee_maker_program_beverage_hot_water`
- **Pre_rinse**: `dishcare_dishwasher_program_pre_rinse`
- **Auto 1**: `dishcare_dishwasher_program_auto_1`
- **Auto 2**: `dishcare_dishwasher_program_auto_2`
- **Auto 3**: `dishcare_dishwasher_program_auto_3`
- **Eco 50ºC**: `dishcare_dishwasher_program_eco_50`
- **Quick 45ºC**: `dishcare_dishwasher_program_quick_45`
- **Intensive 70ºC**: `dishcare_dishwasher_program_intensiv_70`
- **Normal 65ºC**: `dishcare_dishwasher_program_normal_65`
- **Glass 40ºC**: `dishcare_dishwasher_program_glas_40`
- **Glass care**: `dishcare_dishwasher_program_glass_care`
- **Night wash**: `dishcare_dishwasher_program_night_wash`
- **Quick 65ºC**: `dishcare_dishwasher_program_quick_65`
- **Normal 45ºC**: `dishcare_dishwasher_program_normal_45`
- **Intensive 45ºC**: `dishcare_dishwasher_program_intensiv_45`
- **Auto half load**: `dishcare_dishwasher_program_auto_half_load`
- **Intensive power**: `dishcare_dishwasher_program_intensiv_power`
- **Magic daily**: `dishcare_dishwasher_program_magic_daily`
- **Super 60ºC**: `dishcare_dishwasher_program_super_60`
- **Kurz 60ºC**: `dishcare_dishwasher_program_kurz_60`
- **Express sparkle 65ºC**: `dishcare_dishwasher_program_express_sparkle_65`
- **Machine care**: `dishcare_dishwasher_program_machine_care`
- **Steam fresh**: `dishcare_dishwasher_program_steam_fresh`
- **Maximum cleaning**: `dishcare_dishwasher_program_maximum_cleaning`
- **Mixed load**: `dishcare_dishwasher_program_mixed_load`
- **Cotton**: `laundry_care_dryer_program_cotton`
- **Synthetic**: `laundry_care_dryer_program_synthetic`
- **Mix**: `laundry_care_dryer_program_mix`
- **Blankets**: `laundry_care_dryer_program_blankets`
- **Business shirts**: `laundry_care_dryer_program_business_shirts`
- **Down feathers**: `laundry_care_dryer_program_down_feathers`
- **Hygiene**: `laundry_care_dryer_program_hygiene`
- **Jeans**: `laundry_care_dryer_program_jeans`
- **Outdoor**: `laundry_care_dryer_program_outdoor`
- **Synthetic refresh**: `laundry_care_dryer_program_synthetic_refresh`
- **Towels**: `laundry_care_dryer_program_towels`
- **Delicates**: `laundry_care_dryer_program_delicates`
- **Super 40ºC**: `laundry_care_dryer_program_super_40`
- **Shirts 15ºC**: `laundry_care_dryer_program_shirts_15`
- **Pillow**: `laundry_care_dryer_program_pillow`
- **Anti shrink**: `laundry_care_dryer_program_anti_shrink`
- **My drying time**: `laundry_care_dryer_program_my_time_my_drying_time`
- **Cold (variable time)**: `laundry_care_dryer_program_time_cold`
- **Warm (variable time)**: `laundry_care_dryer_program_time_warm`
- **In basket**: `laundry_care_dryer_program_in_basket`
- **Cold (20 min)**: `laundry_care_dryer_program_time_cold_fix_time_cold_20`
- **Cold (30 min)**: `laundry_care_dryer_program_time_cold_fix_time_cold_30`
- **Cold (60 min)**: `laundry_care_dryer_program_time_cold_fix_time_cold_60`
- **Warm (30 min)**: `laundry_care_dryer_program_time_warm_fix_time_warm_30`
- **Warm (40 min)**: `laundry_care_dryer_program_time_warm_fix_time_warm_40`
- **Warm (60 min)**: `laundry_care_dryer_program_time_warm_fix_time_warm_60`
- **Dessous**: `laundry_care_dryer_program_dessous`
- **Automatic**: `cooking_common_program_hood_automatic`
- **Venting**: `cooking_common_program_hood_venting`
- **Delayed shut off**: `cooking_common_program_hood_delayed_shut_off`
- **Pre-heating**: `cooking_oven_program_heating_mode_pre_heating`
- **Hot air**: `cooking_oven_program_heating_mode_hot_air`
- **Hot air eco**: `cooking_oven_program_heating_mode_hot_air_eco`
- **Hot air grilling**: `cooking_oven_program_heating_mode_hot_air_grilling`
- **Top bottom heating**: `cooking_oven_program_heating_mode_top_bottom_heating`
- **Top bottom heating eco**: `cooking_oven_program_heating_mode_top_bottom_heating_eco`
- **Bottom heating**: `cooking_oven_program_heating_mode_bottom_heating`
- **Pizza setting**: `cooking_oven_program_heating_mode_pizza_setting`
- **Slow cook**: `cooking_oven_program_heating_mode_slow_cook`
- **Intensive heat**: `cooking_oven_program_heating_mode_intensive_heat`
- **Keep warm**: `cooking_oven_program_heating_mode_keep_warm`
- **Preheat ovenware**: `cooking_oven_program_heating_mode_preheat_ovenware`
- **Special Heat-Up for frozen products**: `cooking_oven_program_heating_mode_frozen_heatup_special`
- **Desiccation**: `cooking_oven_program_heating_mode_desiccation`
- **Defrost**: `cooking_oven_program_heating_mode_defrost`
- **Proof**: `cooking_oven_program_heating_mode_proof`
- **Hot air + 30 RH**: `cooking_oven_program_heating_mode_hot_air_30_steam`
- **Hot air + 60 RH**: `cooking_oven_program_heating_mode_hot_air_60_steam`
- **Hot air + 80 RH**: `cooking_oven_program_heating_mode_hot_air_80_steam`
- **Hot air + 100 RH**: `cooking_oven_program_heating_mode_hot_air_100_steam`
- **Sabbath programme**: `cooking_oven_program_heating_mode_sabbath_programme`
- **90 Watt**: `cooking_oven_program_microwave_90_watt`
- **180 Watt**: `cooking_oven_program_microwave_180_watt`
- **360 Watt**: `cooking_oven_program_microwave_360_watt`
- **600 Watt**: `cooking_oven_program_microwave_600_watt`
- **900 Watt**: `cooking_oven_program_microwave_900_watt`
- **1000 Watt**: `cooking_oven_program_microwave_1000_watt`
- **Max**: `cooking_oven_program_microwave_max`
- **Warming drawer**: `cooking_oven_program_heating_mode_warming_drawer`
- **Cotton**: `laundry_care_washer_program_cotton`
- **Cotton eco**: `laundry_care_washer_program_cotton_cotton_eco`
- **Cotton eco 40/60ºC**: `laundry_care_washer_program_cotton_eco_4060`
- **Cotton color**: `laundry_care_washer_program_cotton_colour`
- **Easy care**: `laundry_care_washer_program_easy_care`
- **Mix**: `laundry_care_washer_program_mix`
- **Mix night wash**: `laundry_care_washer_program_mix_night_wash`
- **Delicates silk**: `laundry_care_washer_program_delicates_silk`
- **Wool**: `laundry_care_washer_program_wool`
- **Sensitive**: `laundry_care_washer_program_sensitive`
- **Auto 30ºC**: `laundry_care_washer_program_auto_30`
- **Auto 40ºC**: `laundry_care_washer_program_auto_40`
- **Auto 60ºC**: `laundry_care_washer_program_auto_60`
- **Chiffon**: `laundry_care_washer_program_chiffon`
- **Curtains**: `laundry_care_washer_program_curtains`
- **Dark wash**: `laundry_care_washer_program_dark_wash`
- **Dessous**: `laundry_care_washer_program_dessous`
- **Monsoon**: `laundry_care_washer_program_monsoon`
- **Outdoor**: `laundry_care_washer_program_outdoor`
- **Plush toy**: `laundry_care_washer_program_plush_toy`
- **Shirts blouses**: `laundry_care_washer_program_shirts_blouses`
- **Sport fitness**: `laundry_care_washer_program_sport_fitness`
- **Towels**: `laundry_care_washer_program_towels`
- **Water proof**: `laundry_care_washer_program_water_proof`
- **Power speed <59 min**: `laundry_care_washer_program_power_speed_59`
- **Super 15 min**: `laundry_care_washer_program_super_153045_super_15`
- **Super 15/30 min**: `laundry_care_washer_program_super_153045_super_1530`
- **Down duvet**: `laundry_care_washer_program_down_duvet_duvet`
- **Rinse spin drain**: `laundry_care_washer_program_rinse_rinse_spin_drain`
- **Drum clean**: `laundry_care_washer_program_drum_clean`
- **Cotton**: `laundry_care_washer_dryer_program_cotton`
- **Cotton eco 40/60ºC**: `laundry_care_washer_dryer_program_cotton_eco_4060`
- **Mix**: `laundry_care_washer_dryer_program_mix`
- **Easy care**: `laundry_care_washer_dryer_program_easy_care`
- **Wash and dry (60 min)**: `laundry_care_washer_dryer_program_wash_and_dry_60`
- **Wash and dry (90 min)**: `laundry_care_washer_dryer_program_wash_and_dry_90`
{% enddetails %}
#### Settings
- **Current map**:
- **Description**: Represents the currently selected map of the cleaning robot.
- **Availability**: Cleaning robot
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Temporary map**: `consumer_products_cleaning_robot_option_reference_map_id_temp_map`
- **Map 1**:`consumer_products_cleaning_robot_option_reference_map_id_map_1`
- **Map 2**:`consumer_products_cleaning_robot_option_reference_map_id_map_2`
- **Map 3**:`consumer_products_cleaning_robot_option_reference_map_id_map_3`
</details>
- **Functional light color temperature**:
- **Description**: Represents the color temperature of the functional light.
- **Availability**: Hood
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Custom**: `cooking_hood_enum_type_color_temperature_custom`
- **Warm**: `cooking_hood_enum_type_color_temperature_warm`
- **Warm to Neutral**: `cooking_hood_enum_type_color_temperature_warm_to_neutral`
- **Neutral**: `cooking_hood_enum_type_color_temperature_neutral`
- **Neutral to Cold**: `cooking_hood_enum_type_color_temperature_neutral_to_cold`
- **Cold**: `cooking_hood_enum_type_color_temperature_cold`
</details>
- **Ambient light color**:
- **Description**: Represents the color of the ambient light.
- **Availability**: Hood, Dishwasher
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Custom**: `b_s_h_common_enum_type_ambient_light_color_custom_color`
- **1**: `b_s_h_common_enum_type_ambient_light_color_color_1`
- ...
- **99**: `b_s_h_common_enum_type_ambient_light_color_color_99`
</details>
#### Program options
- **Reference map ID**:
- **Description**: Defines which reference map is to be used.
- **Availability**: Cleaning robot
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Temporary map**: `consumer_products_cleaning_robot_option_reference_map_id_temp_map`
- **Map 1**:`consumer_products_cleaning_robot_option_reference_map_id_map_1`
- **Map 2**:`consumer_products_cleaning_robot_option_reference_map_id_map_2`
- **Map 3**:`consumer_products_cleaning_robot_option_reference_map_id_map_3`
</details>
- **Cleaning mode**:
- **Description**: Defines the favoured cleaning mode.
- **Availability**: Cleaning robot
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Silent**: `consumer_products_cleaning_robot_enum_type_cleaning_modes_silent`
- **Standard**: `consumer_products_cleaning_robot_enum_type_cleaning_modes_standard`
- **Power**: `consumer_products_cleaning_robot_enum_type_cleaning_modes_power`
</details>
- **Bean amount**:
- **Description**: Represents the amount of coffee beans used in a coffee machine program.
- **Availability**: Coffee maker
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Very mild**: `consumer_products_coffee_maker_enum_type_bean_amount_very_mild`
- **Mild**: `consumer_products_coffee_maker_enum_type_bean_amount_mild`
- **Mild +**: `consumer_products_coffee_maker_enum_type_bean_amount_mild_plus`
- **Normal**: `consumer_products_coffee_maker_enum_type_bean_amount_normal`
- **Normal +**: `consumer_products_coffee_maker_enum_type_bean_amount_normal_plus`
- **Strong**: `consumer_products_coffee_maker_enum_type_bean_amount_strong`
- **Strong +**: `consumer_products_coffee_maker_enum_type_bean_amount_strong_plus`
- **Very strong**: `consumer_products_coffee_maker_enum_type_bean_amount_very_strong`
- **Very strong +**: `consumer_products_coffee_maker_enum_type_bean_amount_very_strong_plus`
- **Extra strong**: `consumer_products_coffee_maker_enum_type_bean_amount_extra_strong`
- **Double shot**: `consumer_products_coffee_maker_enum_type_bean_amount_double_shot`
- **Double shot +**: `consumer_products_coffee_maker_enum_type_bean_amount_double_shot_plus`
- **Double shot ++**: `consumer_products_coffee_maker_enum_type_bean_amount_double_shot_plus_plus`
- **Triple shot**: `consumer_products_coffee_maker_enum_type_bean_amount_triple_shot`
- **Triple shot +**: `consumer_products_coffee_maker_enum_type_bean_amount_triple_shot_plus`
- **Coffee ground**: `consumer_products_coffee_maker_enum_type_bean_amount_coffee_ground`
</details>
- **Coffee temperature**:
- **Description**: Represents the coffee temperature used in a coffee machine program.
- **Availability**: Coffee maker
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **88ºC**: `consumer_products_coffee_maker_enum_type_coffee_temperature_88_c`
- **90ºC**: `consumer_products_coffee_maker_enum_type_coffee_temperature_90_c`
- **92ºC**: `consumer_products_coffee_maker_enum_type_coffee_temperature_92_c`
- **94ºC**: `consumer_products_coffee_maker_enum_type_coffee_temperature_94_c`
- **95ºC**: `consumer_products_coffee_maker_enum_type_coffee_temperature_95_c`
- **96ºC**: `consumer_products_coffee_maker_enum_type_coffee_temperature_96_c`
</details>
- **Bean container**:
- **Description**: Defines the preferred bean container.
- **Availability**: Coffee maker
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Left**: `consumer_products_coffee_maker_enum_type_bean_container_selection_right`
- **Right**: `consumer_products_coffee_maker_enum_type_bean_container_selection_left`
</details>
- **Flow rate**:
- **Description**: Defines the water-coffee contact time. The duration extends to coffee intensity.
- **Availability**: Coffee maker
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Normal**: `consumer_products_coffee_maker_enum_type_flow_rate_normal`
- **Intense**: `consumer_products_coffee_maker_enum_type_flow_rate_intense`
- **Intense plus**: `consumer_products_coffee_maker_enum_type_flow_rate_intense_plus`
</details>
- **Coffee milk ratio**:
- **Description**: Defines the amount of milk.
- **Availability**: Coffee maker
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **10%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_10_percent`
- **20%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_20_percent`
- **25%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_25_percent`
- **30%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_30_percent`
- **40%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_40_percent`
- **50%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_50_percent`
- **55%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_55_percent`
- **60%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_60_percent`
- **65%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_65_percent`
- **67%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_67_percent`
- **70%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_70_percent`
- **75%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_75_percent`
- **80%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_80_percent`
- **85%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_85_percent`
- **90%**: `consumer_products_coffee_maker_enum_type_coffee_milk_ratio_90_percent`
</details>
- **Hot water temperature**:
- **Description**: Defines the temperature suitable for the type of tea.
- **Availability**: Coffee maker
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **White tea**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_white_tea`
- **Green tea**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_green_tea`
- **Black tea**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_black_tea`
- **50ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_50_c`
- **55ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_55_c`
- **60ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_60_c`
- **65ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_65_c`
- **70ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_70_c`
- **75ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_75_c`
- **80ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_80_c`
- **85ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_85_c`
- **90ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_90_c`
- **95ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_95_c`
- **97ºC**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_97_c`
- **122ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_122_f`
- **131ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_131_f`
- **140ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_140_f`
- **149ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_149_f`
- **158ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_158_f`
- **167ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_167_f`
- **176ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_176_f`
- **185ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_185_f`
- **194ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_194_f`
- **203ºF**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_203_f`
- **Max**: `consumer_products_coffee_maker_enum_type_hot_water_temperature_max`
</details>
- **Drying target**:
- **Description**: Describes the drying target for a dryer program.
- **Availability**: Dryer
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Iron dry**: `laundry_care_dryer_enum_type_drying_target_iron_dry`
- **Gentle dry**: `laundry_care_dryer_enum_type_drying_target_gentle_dry`
- **Cupboard dry**: `laundry_care_dryer_enum_type_drying_target_cupboard_dry`
- **Cupboard dry plus**: `laundry_care_dryer_enum_type_drying_target_cupboard_dry_plus`
- **Extra dry**: `laundry_care_dryer_enum_type_drying_target_extra_dry`
</details>
- **Venting level**:
- **Description**: Defines the required fan setting.
- **Availability**: Hood
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Fan off** `cooking_hood_enum_type_stage_fan_off`
- **Fan stage 1** `cooking_hood_enum_type_stage_fan_stage01`
- **Fan stage 2** `cooking_hood_enum_type_stage_fan_stage02`
- **Fan stage 3** `cooking_hood_enum_type_stage_fan_stage03`
- **Fan stage 4** `cooking_hood_enum_type_stage_fan_stage04`
- **Fan stage 5** `cooking_hood_enum_type_stage_fan_stage05`
</details>
- **Intensive level**:
- **Description**: Defines the intensive setting.
- **Availability**: Hood
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Intensive stage off**: `cooking_hood_enum_type_intensive_stage_intensive_stage_off`
- **Intensive stage 1**: `cooking_hood_enum_type_intensive_stage_intensive_stage1`
- **Intensive stage 2**: `cooking_hood_enum_type_intensive_stage_intensive_stage2`
</details>
- **Warming level**:
- **Description**: Defines the level of the warming drawer.
- **Availability**: Oven
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Low**: `cooking_oven_enum_type_warming_level_low`
- **Medium**: `cooking_oven_enum_type_warming_level_medium`
- **High**: `cooking_oven_enum_type_warming_level_high`
</details>
- **Temperature**:
- **Description**: Defines the temperature of the washing program.
- **Availability**: Washer, Washer dryer
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Cold**: `laundry_care_washer_enum_type_temperature_cold`
- **20ºC clothes**: `laundry_care_washer_enum_type_temperature_g_c20`
- **30ºC clothes**: `laundry_care_washer_enum_type_temperature_g_c30`
- **40ºC clothes**: `laundry_care_washer_enum_type_temperature_g_c40`
- **50ºC clothes**: `laundry_care_washer_enum_type_temperature_g_c50`
- **60ºC clothes**: `laundry_care_washer_enum_type_temperature_g_c60`
- **70ºC clothes**: `laundry_care_washer_enum_type_temperature_g_c70`
- **80ºC clothes**: `laundry_care_washer_enum_type_temperature_g_c80`
- **90ºC clothes**: `laundry_care_washer_enum_type_temperature_g_c90`
- **Cold**: `laundry_care_washer_enum_type_temperature_ul_cold`
- **Warm**: `laundry_care_washer_enum_type_temperature_ul_warm`
- **Hot**: `laundry_care_washer_enum_type_temperature_ul_hot`
- **Extra hot**: `laundry_care_washer_enum_type_temperature_ul_extra_hot`
</details>
- **Spin speed**:
- **Description**: Defines the spin speed of a washer program.
- **Availability**: Washer, Washer dryer
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Off**: `laundry_care_washer_enum_type_spin_speed_off`
- **400 rpm**: `laundry_care_washer_enum_type_spin_speed_r_p_m400`
- **600 rpm**: `laundry_care_washer_enum_type_spin_speed_r_p_m600`
- **800 rpm**: `laundry_care_washer_enum_type_spin_speed_r_p_m800`
- **1000 rpm**: `laundry_care_washer_enum_type_spin_speed_r_p_m1000`
- **1200 rpm**: `laundry_care_washer_enum_type_spin_speed_r_p_m1200`
- **1400 rpm**: `laundry_care_washer_enum_type_spin_speed_r_p_m1400`
- **1600 rpm**: `laundry_care_washer_enum_type_spin_speed_r_p_m1600`
- **Off**: `laundry_care_washer_enum_type_spin_speed_ul_off`
- **Low**: `laundry_care_washer_enum_type_spin_speed_ul_low`
- **Medium**: `laundry_care_washer_enum_type_spin_speed_ul_medium`
- **High**: `laundry_care_washer_enum_type_spin_speed_ul_high`
</details>
- **Vario perfect**:
- **Description**: Defines if a cycle saves energy (Eco Perfect) or time (Speed Perfect).
- **Availability**: Washer
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Off**: `laundry_care_common_enum_type_vario_perfect_off`
- **Eco perfect**: `laundry_care_common_enum_type_vario_perfect_eco_perfect`
- **Speed perfect**: `laundry_care_common_enum_type_vario_perfect_speed_perfect`
</details>
{% enddetails %}
### Sensor
{% details "List of binary sensors" %}
- **Finish time**:
- **Description**: Represents the time when the program will end.
- **Availability**: Coffee maker, Hood, Oven, Dishwasher, Dryer, Washer, Washer dryer
{% note %}
This sensor will be available only if the program is running
{% endnote %}
- **Program progress**:
- **Description**: Represents the progress of the program.
- **Availability**: Coffee maker, Hood, Oven, Warming drawer, Dishwasher, Dryer, Washer, Washer dryer
{% note %}
This sensor will be available only if the program is running
{% endnote %}
- **Operation state**:
- **Description**: Represents the current operation state of the device.
- **Availability**: All the appliances with programs
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Inactive**: `inactive`
- **Ready**: `ready`
- **Delayed start**: `delayedstart`
- **Run**: `run`
- **Pause**: `pause`
- **Action required**: `actionrequired`
- **Finished**: `finished`
- **Error**: `error`
- **Aborting**: `aborting`
</details>
- **Door state**:
- **Description**: Represents the current state of the door.
- **Availability**: Oven, Dishwasher, Dryer, Washer, Washer dryer, Freezer, Fridge freezer, Refrigerator, Wine cooler
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Closed**: `closed`
- **Locked**: `locked`
- **Open**: `open`
</details>
- **Coffee counter**:
- **Description**: Represents the number of coffees made.
- **Availability**: Coffee maker
- **Powder coffee counter**:
- **Description**: Represents the number of powder coffees made.
- **Availability**: Coffee maker
- **Hot water counter**:
- **Description**: Represents the milliliters of hot water dispensed.
- **Availability**: Coffee maker
- **Hot water cups**:
- **Description**: Represents the number of hot water cups dispensed.
- **Availability**: Coffee maker
- **Hot milk counter**:
- **Description**: Represents the number of hot milk cups dispensed.
- **Availability**: Coffee maker
- **Frothy milk counter**:
- **Description**: Represents the number of frothy milk cups dispensed.
- **Availability**: Coffee maker
- **Milk counter**:
- **Description**: Represents the number of milk cups dispensed.
- **Availability**: Coffee maker
- **Coffee and milk counter**:
- **Description**: Represents the number of coffee and milk cups dispensed.
- **Availability**: Coffee maker
- **Ristretto Espresso counter**:
- **Description**: Represents the number of Ristretto Espresso cups dispensed.
- **Availability**: Coffee maker
- **Battery level**:
- **Description**: Represents the level of the battery.
- **Availability**: Cleaning robot
- **Camera state**:
- **Description**: Represents the state of the camera.
- **Availability**: Cleaning robot
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Disabled**: `disabled`
- **Sleeping**: `sleeping`
- **Ready**: `ready`
- **Streaming local**: `streaminglocal`
- **Streaming cloud**: `streamingcloud`
- **Streaming local and cloud**: `streaminglocalancloud`
- **Error**: `error`
</details>
- **Last selected map**:
- **Description**: Represents the last selected map of the cleaning robot.
- **Availability**: Cleaning robot
- <details>
<summary><b>Options:</b> (click to view)</summary>
- **Temporary map**: `tempmap`
- **Map 1**: `map1`
- **Map 2**: `map2`
- **Map 3**: `map3`
</details>
#### Event sensors
{% details "Event sensor options" %}
All the event sensors will have the following possible values:
- **Confirmed**: `confirmed`
- **Present**: `present`
- **Off**: `off`
{% enddetails %}
- **Freezer door alarm**:
- **Description**: Represents the alarm state of the freezer door.
- **Availability**: Freezer, Fridge freezer
- **Refrigerator door alarm**:
- **Description**: Represents the alarm state of the refrigerator door.
- **Availability**: Fridge freezer, Refrigerator
- **Freezer temperature alarm**:
- **Description**: Represents the alarm state of the freezer temperature.
- **Availability**: Freezer, Fridge freezer
- **Bean container empty**:
- **Description**: Indicates whether the bean container is empty.
- **Availability**: Coffee maker
- **Water tank empty**:
- **Description**: Indicates whether the water tank is empty.
- **Availability**: Coffee maker
- **Drip tray full**:
- **Description**: Indicates whether the drip tray is full.
- **Availability**: Coffee maker
- **Salt nearly empty**:
- **Description**: Indicates whether the salt is nearly empty.
- **Availability**: Dishwasher
- **Rinse aid nearly empty**:
- **Description**: Indicates whether the rinse aid is nearly empty.
- **Availability**: Dishwasher
{% enddetails %}
### Switch
{% details "List of switch entities" %}
- **Power**:
- **Description**: Turns on and turns off or sets the standby mode of the device.
- **Availability**: All the appliances
{% note %}
Some devices only have the state `on` and turn off is not supported by the appliance, check [power state availability at Home Connect API documentation](https://api-docs.home-connect.com/settings/#power-state) for more information.
{% endnote %}
- **Child lock**:
- **Description**: Represents the state of the child lock.
- **Availability**: Coffee maker, Cooktop, Oven, Warming drawer, Dishwasher, Dryer, Washer, Washer dryer, Freezer, Fridge freezer, Refrigerator, Wine cooler
- **Cup warmer**:
- **Description**: Enables/Disables the cup warmer.
- **Availability**: Coffee maker
- **Freezer super mode**:
- **Description**: Cool the freezer compartment to the lowest temperature until disabled or a timeout.
- **Availability**: Freezer, Fridge freezer
- **Refrigerator super mode**:
- **Description**: Cool the refrigerator compartment to the lowest temperature until disabled or a timeout.
- **Availability**: Fridge freezer, Refrigerator
- **Eco mode**:
- **Description**: Enables/Disables the eco-friendly mode.
- **Availability**: Freezer, Fridge freezer, Refrigerator
- **Sabbath mode**:
- **Description**: Enables/Disables the Sabbath mode, which disables various functions (e.g. lighting, acoustic signals) to ensure that practising Jews can use the appliance on the Sabbath.
- **Availability**: Oven, Freezer, Fridge freezer, Refrigerator, Wine cooler
- **Vacation mode**:
- **Description**: Enables/Disables the vacation mode, which reduces the energy consumption of the appliance by switching the refrigerator temperature to +14ºC. The temperature in the freezer is maintained according to the setting.
- **Availability**: Fridge freezer, Refrigerator
- **Fresh mode**:
- **Description**: Enables/Disables the fresh mode, which reduces the temperature automatically in the refrigerator compartment to 2ºC. The freezer remains unchanged.
- **Availability**: Fridge freezer, Refrigerator
- **Dispenser enabled**:
- **Description**: Enables/Disables the ice water dispenser.
- **Availability**: Fridge freezer, Refrigerator
- **Freezer door assistant**:
- **Description**: Enables/Disables the automatic door opening for the freezer compartment
- **Availability**: Freezer, Fridge freezer
- **Fridge door assistant**:
- **Description**: Enables/Disables the automatic door opening for the refrigerator/freezer compartment
- **Availability**: Fridge freezer, Refrigerator
{% enddetails %}
### Time
{% details "List of time entities" %}
- **Alarm clock**
- **Description**: Sets the alarm clock.
- **Availability**: Cooktop, Oven
{% enddetails %}
## Actions
The Home Connect integration makes various actions available.
@ -148,7 +941,7 @@ Starts or selects a program. If the `program` attribute is not set, this action
| `laundry_care_dryer_option_drying_target` | yes | Describes the drying target for a dryer program. For example: Iron Dry, Cupboard Dry, Extra Dry. |
| `cooking_hood_option_venting_level` | yes | Defines the required fan setting. |
| `cooking_hood_option_intensive_level` | yes | Defines the intensive setting. |
| `cooking_oven_option_setpoint_temperature` | yes | Defines the target cavity temperature, which will be hold by the oven. |
| `cooking_oven_option_setpoint_temperature` | yes | Defines the target cavity temperature, which will be held by the oven. |
| `b_s_h_common_option_duration` | yes | Defines the run-time of the program. Afterwards, the appliance is stopped. |
| `cooking_oven_option_fast_pre_heat` | yes | Defines if the cooking compartment is heated up quickly. Please note that the setpoint temperature has to be equal to or higher than 100 °C or 212 °F. Otherwise, the fast pre-heat option is not activated. |
| `cooking_oven_option_warming_level` | yes | Defines the level of the warming drawer. |