Home Assistant Unofficial Reference 2024.12.1
const.py
Go to the documentation of this file.
1 """Constants for the Home Connect integration."""
2 
3 DOMAIN = "home_connect"
4 
5 OAUTH2_AUTHORIZE = "https://api.home-connect.com/security/oauth/authorize"
6 OAUTH2_TOKEN = "https://api.home-connect.com/security/oauth/token"
7 
8 APPLIANCES_WITH_PROGRAMS = (
9  "CleaningRobot",
10  "CoffeeMaker",
11  "Dishwasher",
12  "Dryer",
13  "Hood",
14  "Oven",
15  "WarmingDrawer",
16  "Washer",
17  "WasherDryer",
18 )
19 
20 BSH_POWER_STATE = "BSH.Common.Setting.PowerState"
21 BSH_POWER_ON = "BSH.Common.EnumType.PowerState.On"
22 BSH_POWER_OFF = "BSH.Common.EnumType.PowerState.Off"
23 BSH_POWER_STANDBY = "BSH.Common.EnumType.PowerState.Standby"
24 BSH_SELECTED_PROGRAM = "BSH.Common.Root.SelectedProgram"
25 BSH_ACTIVE_PROGRAM = "BSH.Common.Root.ActiveProgram"
26 BSH_REMOTE_CONTROL_ACTIVATION_STATE = "BSH.Common.Status.RemoteControlActive"
27 BSH_REMOTE_START_ALLOWANCE_STATE = "BSH.Common.Status.RemoteControlStartAllowed"
28 BSH_CHILD_LOCK_STATE = "BSH.Common.Setting.ChildLock"
29 
30 BSH_REMAINING_PROGRAM_TIME = "BSH.Common.Option.RemainingProgramTime"
31 BSH_COMMON_OPTION_DURATION = "BSH.Common.Option.Duration"
32 BSH_COMMON_OPTION_PROGRAM_PROGRESS = "BSH.Common.Option.ProgramProgress"
33 
34 BSH_EVENT_PRESENT_STATE_PRESENT = "BSH.Common.EnumType.EventPresentState.Present"
35 BSH_EVENT_PRESENT_STATE_CONFIRMED = "BSH.Common.EnumType.EventPresentState.Confirmed"
36 BSH_EVENT_PRESENT_STATE_OFF = "BSH.Common.EnumType.EventPresentState.Off"
37 
38 BSH_OPERATION_STATE = "BSH.Common.Status.OperationState"
39 BSH_OPERATION_STATE_RUN = "BSH.Common.EnumType.OperationState.Run"
40 BSH_OPERATION_STATE_PAUSE = "BSH.Common.EnumType.OperationState.Pause"
41 BSH_OPERATION_STATE_FINISHED = "BSH.Common.EnumType.OperationState.Finished"
42 
43 COOKING_LIGHTING = "Cooking.Common.Setting.Lighting"
44 COOKING_LIGHTING_BRIGHTNESS = "Cooking.Common.Setting.LightingBrightness"
45 
46 COFFEE_EVENT_BEAN_CONTAINER_EMPTY = (
47  "ConsumerProducts.CoffeeMaker.Event.BeanContainerEmpty"
48 )
49 COFFEE_EVENT_WATER_TANK_EMPTY = "ConsumerProducts.CoffeeMaker.Event.WaterTankEmpty"
50 COFFEE_EVENT_DRIP_TRAY_FULL = "ConsumerProducts.CoffeeMaker.Event.DripTrayFull"
51 
52 DISHWASHER_EVENT_SALT_NEARLY_EMPTY = "Dishcare.Dishwasher.Event.SaltNearlyEmpty"
53 DISHWASHER_EVENT_RINSE_AID_NEARLY_EMPTY = (
54  "Dishcare.Dishwasher.Event.RinseAidNearlyEmpty"
55 )
56 
57 REFRIGERATION_INTERNAL_LIGHT_POWER = "Refrigeration.Common.Setting.Light.Internal.Power"
58 REFRIGERATION_INTERNAL_LIGHT_BRIGHTNESS = (
59  "Refrigeration.Common.Setting.Light.Internal.Brightness"
60 )
61 REFRIGERATION_EXTERNAL_LIGHT_POWER = "Refrigeration.Common.Setting.Light.External.Power"
62 REFRIGERATION_EXTERNAL_LIGHT_BRIGHTNESS = (
63  "Refrigeration.Common.Setting.Light.External.Brightness"
64 )
65 
66 REFRIGERATION_SUPERMODEFREEZER = "Refrigeration.FridgeFreezer.Setting.SuperModeFreezer"
67 REFRIGERATION_SUPERMODEREFRIGERATOR = (
68  "Refrigeration.FridgeFreezer.Setting.SuperModeRefrigerator"
69 )
70 REFRIGERATION_DISPENSER = "Refrigeration.Common.Setting.Dispenser.Enabled"
71 
72 REFRIGERATION_STATUS_DOOR_CHILLER = "Refrigeration.Common.Status.Door.ChillerCommon"
73 REFRIGERATION_STATUS_DOOR_FREEZER = "Refrigeration.Common.Status.Door.Freezer"
74 REFRIGERATION_STATUS_DOOR_REFRIGERATOR = "Refrigeration.Common.Status.Door.Refrigerator"
75 
76 REFRIGERATION_STATUS_DOOR_CLOSED = "Refrigeration.Common.EnumType.Door.States.Closed"
77 REFRIGERATION_STATUS_DOOR_OPEN = "Refrigeration.Common.EnumType.Door.States.Open"
78 
79 REFRIGERATION_EVENT_DOOR_ALARM_REFRIGERATOR = (
80  "Refrigeration.FridgeFreezer.Event.DoorAlarmRefrigerator"
81 )
82 REFRIGERATION_EVENT_DOOR_ALARM_FREEZER = (
83  "Refrigeration.FridgeFreezer.Event.DoorAlarmFreezer"
84 )
85 REFRIGERATION_EVENT_TEMP_ALARM_FREEZER = (
86  "Refrigeration.FridgeFreezer.Event.TemperatureAlarmFreezer"
87 )
88 
89 
90 BSH_AMBIENT_LIGHT_ENABLED = "BSH.Common.Setting.AmbientLightEnabled"
91 BSH_AMBIENT_LIGHT_BRIGHTNESS = "BSH.Common.Setting.AmbientLightBrightness"
92 BSH_AMBIENT_LIGHT_COLOR = "BSH.Common.Setting.AmbientLightColor"
93 BSH_AMBIENT_LIGHT_COLOR_CUSTOM_COLOR = (
94  "BSH.Common.EnumType.AmbientLightColor.CustomColor"
95 )
96 BSH_AMBIENT_LIGHT_CUSTOM_COLOR = "BSH.Common.Setting.AmbientLightCustomColor"
97 
98 BSH_DOOR_STATE = "BSH.Common.Status.DoorState"
99 BSH_DOOR_STATE_CLOSED = "BSH.Common.EnumType.DoorState.Closed"
100 BSH_DOOR_STATE_LOCKED = "BSH.Common.EnumType.DoorState.Locked"
101 BSH_DOOR_STATE_OPEN = "BSH.Common.EnumType.DoorState.Open"
102 
103 BSH_PAUSE = "BSH.Common.Command.PauseProgram"
104 BSH_RESUME = "BSH.Common.Command.ResumeProgram"
105 
106 SIGNAL_UPDATE_ENTITIES = "home_connect.update_entities"
107 
108 SERVICE_OPTION_ACTIVE = "set_option_active"
109 SERVICE_OPTION_SELECTED = "set_option_selected"
110 SERVICE_PAUSE_PROGRAM = "pause_program"
111 SERVICE_RESUME_PROGRAM = "resume_program"
112 SERVICE_SELECT_PROGRAM = "select_program"
113 SERVICE_SETTING = "change_setting"
114 SERVICE_START_PROGRAM = "start_program"
115 
116 ATTR_ALLOWED_VALUES = "allowedvalues"
117 ATTR_AMBIENT = "ambient"
118 ATTR_BSH_KEY = "bsh_key"
119 ATTR_CONSTRAINTS = "constraints"
120 ATTR_DESC = "desc"
121 ATTR_DEVICE = "device"
122 ATTR_KEY = "key"
123 ATTR_PROGRAM = "program"
124 ATTR_SENSOR_TYPE = "sensor_type"
125 ATTR_SIGN = "sign"
126 ATTR_STEPSIZE = "stepsize"
127 ATTR_UNIT = "unit"
128 ATTR_VALUE = "value"
129 
130 SVE_TRANSLATION_PLACEHOLDER_APPLIANCE_NAME = "appliance_name"
131 SVE_TRANSLATION_PLACEHOLDER_ENTITY_ID = "entity_id"
132 SVE_TRANSLATION_PLACEHOLDER_SETTING_KEY = "setting_key"
133 SVE_TRANSLATION_PLACEHOLDER_VALUE = "value"
134 
135 OLD_NEW_UNIQUE_ID_SUFFIX_MAP = {
136  "ChildLock": BSH_CHILD_LOCK_STATE,
137  "Operation State": BSH_OPERATION_STATE,
138  "Light": COOKING_LIGHTING,
139  "AmbientLight": BSH_AMBIENT_LIGHT_ENABLED,
140  "Power": BSH_POWER_STATE,
141  "Remaining Program Time": BSH_REMAINING_PROGRAM_TIME,
142  "Duration": BSH_COMMON_OPTION_DURATION,
143  "Program Progress": BSH_COMMON_OPTION_PROGRAM_PROGRESS,
144  "Remote Control": BSH_REMOTE_CONTROL_ACTIVATION_STATE,
145  "Remote Start": BSH_REMOTE_START_ALLOWANCE_STATE,
146  "Supermode Freezer": REFRIGERATION_SUPERMODEFREEZER,
147  "Supermode Refrigerator": REFRIGERATION_SUPERMODEREFRIGERATOR,
148  "Dispenser Enabled": REFRIGERATION_DISPENSER,
149  "Internal Light": REFRIGERATION_INTERNAL_LIGHT_POWER,
150  "External Light": REFRIGERATION_EXTERNAL_LIGHT_POWER,
151  "Chiller Door": REFRIGERATION_STATUS_DOOR_CHILLER,
152  "Freezer Door": REFRIGERATION_STATUS_DOOR_FREEZER,
153  "Refrigerator Door": REFRIGERATION_STATUS_DOOR_REFRIGERATOR,
154  "Door Alarm Freezer": REFRIGERATION_EVENT_DOOR_ALARM_FREEZER,
155  "Door Alarm Refrigerator": REFRIGERATION_EVENT_DOOR_ALARM_REFRIGERATOR,
156  "Temperature Alarm Freezer": REFRIGERATION_EVENT_TEMP_ALARM_FREEZER,
157  "Bean Container Empty": COFFEE_EVENT_BEAN_CONTAINER_EMPTY,
158  "Water Tank Empty": COFFEE_EVENT_WATER_TANK_EMPTY,
159  "Drip Tray Full": COFFEE_EVENT_DRIP_TRAY_FULL,
160 }