Home Assistant Unofficial Reference 2024.12.1
abbreviations.py
Go to the documentation of this file.
1 """Abbreviations supported by MQTT discovery."""
2 
3 ABBREVIATIONS = {
4  "act_t": "action_topic",
5  "act_tpl": "action_template",
6  "act_stat_t": "activity_state_topic",
7  "act_val_tpl": "activity_value_template",
8  "atype": "automation_type",
9  "av_tones": "available_tones",
10  "avty": "availability",
11  "avty_mode": "availability_mode",
12  "avty_t": "availability_topic",
13  "avty_tpl": "availability_template",
14  "b_tpl": "blue_template",
15  "bri_cmd_tpl": "brightness_command_template",
16  "bri_cmd_t": "brightness_command_topic",
17  "bri_scl": "brightness_scale",
18  "bri_stat_t": "brightness_state_topic",
19  "bri_tpl": "brightness_template",
20  "bri_val_tpl": "brightness_value_template",
21  "clr_temp_cmd_tpl": "color_temp_command_template",
22  "clrm": "color_mode",
23  "clrm_stat_t": "color_mode_state_topic",
24  "clrm_val_tpl": "color_mode_value_template",
25  "clr_temp_cmd_t": "color_temp_command_topic",
26  "clr_temp_stat_t": "color_temp_state_topic",
27  "clr_temp_tpl": "color_temp_template",
28  "clr_temp_val_tpl": "color_temp_value_template",
29  "cmd_off_tpl": "command_off_template",
30  "cmd_on_tpl": "command_on_template",
31  "cmd_t": "command_topic",
32  "cmd_tpl": "command_template",
33  "cmps": "components",
34  "cod_arm_req": "code_arm_required",
35  "cod_dis_req": "code_disarm_required",
36  "cod_form": "code_format",
37  "cod_trig_req": "code_trigger_required",
38  "cont_type": "content_type",
39  "curr_hum_t": "current_humidity_topic",
40  "curr_hum_tpl": "current_humidity_template",
41  "curr_temp_t": "current_temperature_topic",
42  "curr_temp_tpl": "current_temperature_template",
43  "dev": "device",
44  "dev_cla": "device_class",
45  "dir_cmd_t": "direction_command_topic",
46  "dir_cmd_tpl": "direction_command_template",
47  "dir_stat_t": "direction_state_topic",
48  "dir_val_tpl": "direction_value_template",
49  "dsp_prc": "display_precision",
50  "dock_cmd_t": "dock_command_topic",
51  "dock_cmd_tpl": "dock_command_template",
52  "e": "encoding",
53  "en": "enabled_by_default",
54  "ent_cat": "entity_category",
55  "ent_pic": "entity_picture",
56  "evt_typ": "event_types",
57  "fanspd_lst": "fan_speed_list",
58  "flsh_tlng": "flash_time_long",
59  "flsh_tsht": "flash_time_short",
60  "fx_cmd_tpl": "effect_command_template",
61  "fx_cmd_t": "effect_command_topic",
62  "fx_list": "effect_list",
63  "fx_stat_t": "effect_state_topic",
64  "fx_tpl": "effect_template",
65  "fx_val_tpl": "effect_value_template",
66  "exp_aft": "expire_after",
67  "fan_mode_cmd_tpl": "fan_mode_command_template",
68  "fan_mode_cmd_t": "fan_mode_command_topic",
69  "fan_mode_stat_tpl": "fan_mode_state_template",
70  "fan_mode_stat_t": "fan_mode_state_topic",
71  "frc_upd": "force_update",
72  "g_tpl": "green_template",
73  "hs_cmd_t": "hs_command_topic",
74  "hs_cmd_tpl": "hs_command_template",
75  "hs_stat_t": "hs_state_topic",
76  "hs_val_tpl": "hs_value_template",
77  "ic": "icon",
78  "img_e": "image_encoding",
79  "img_t": "image_topic",
80  "init": "initial",
81  "hum_cmd_t": "target_humidity_command_topic",
82  "hum_cmd_tpl": "target_humidity_command_template",
83  "hum_stat_t": "target_humidity_state_topic",
84  "hum_state_tpl": "target_humidity_state_template",
85  "json_attr": "json_attributes",
86  "json_attr_t": "json_attributes_topic",
87  "json_attr_tpl": "json_attributes_template",
88  "lrst_val_tpl": "last_reset_value_template",
89  "max": "max",
90  "min": "min",
91  "max_hum": "max_humidity",
92  "min_hum": "min_humidity",
93  "max_mirs": "max_mireds",
94  "min_mirs": "min_mireds",
95  "max_temp": "max_temp",
96  "min_temp": "min_temp",
97  "migr_discvry": "migrate_discovery",
98  "mode": "mode",
99  "mode_cmd_tpl": "mode_command_template",
100  "mode_cmd_t": "mode_command_topic",
101  "mode_stat_t": "mode_state_topic",
102  "mode_stat_tpl": "mode_state_template",
103  "modes": "modes",
104  "name": "name",
105  "o": "origin",
106  "obj_id": "object_id",
107  "off_dly": "off_delay",
108  "on_cmd_type": "on_command_type",
109  "ops": "options",
110  "opt": "optimistic",
111  "osc_cmd_t": "oscillation_command_topic",
112  "osc_cmd_tpl": "oscillation_command_template",
113  "osc_stat_t": "oscillation_state_topic",
114  "osc_val_tpl": "oscillation_value_template",
115  "p": "platform",
116  "pause_cmd_t": "pause_command_topic",
117  "pause_mw_cmd_tpl": "pause_command_template",
118  "pct_cmd_t": "percentage_command_topic",
119  "pct_cmd_tpl": "percentage_command_template",
120  "pct_stat_t": "percentage_state_topic",
121  "pct_val_tpl": "percentage_value_template",
122  "pl": "payload",
123  "pl_arm_away": "payload_arm_away",
124  "pl_arm_home": "payload_arm_home",
125  "pl_arm_nite": "payload_arm_night",
126  "pl_arm_vacation": "payload_arm_vacation",
127  "pl_arm_custom_b": "payload_arm_custom_bypass",
128  "pl_avail": "payload_available",
129  "pl_cln_sp": "payload_clean_spot",
130  "pl_cls": "payload_close",
131  "pl_disarm": "payload_disarm",
132  "pl_home": "payload_home",
133  "pl_lock": "payload_lock",
134  "pl_loc": "payload_locate",
135  "pl_not_avail": "payload_not_available",
136  "pl_not_home": "payload_not_home",
137  "pl_off": "payload_off",
138  "pl_on": "payload_on",
139  "pl_open": "payload_open",
140  "pl_osc_off": "payload_oscillation_off",
141  "pl_osc_on": "payload_oscillation_on",
142  "pl_paus": "payload_pause",
143  "pl_prs": "payload_press",
144  "pl_rst": "payload_reset",
145  "pl_rst_hum": "payload_reset_humidity",
146  "pl_rst_mode": "payload_reset_mode",
147  "pl_rst_pct": "payload_reset_percentage",
148  "pl_rst_pr_mode": "payload_reset_preset_mode",
149  "pl_stop": "payload_stop",
150  "pl_strt": "payload_start",
151  "pl_ret": "payload_return_to_base",
152  "pl_toff": "payload_turn_off",
153  "pl_ton": "payload_turn_on",
154  "pl_trig": "payload_trigger",
155  "pl_unlk": "payload_unlock",
156  "pos": "reports_position",
157  "pos_clsd": "position_closed",
158  "pos_open": "position_open",
159  "pow_cmd_t": "power_command_topic",
160  "pow_cmd_tpl": "power_command_template",
161  "pr_mode_cmd_t": "preset_mode_command_topic",
162  "pr_mode_cmd_tpl": "preset_mode_command_template",
163  "pr_mode_stat_t": "preset_mode_state_topic",
164  "pr_mode_val_tpl": "preset_mode_value_template",
165  "pr_modes": "preset_modes",
166  "ptrn": "pattern",
167  "r_tpl": "red_template",
168  "rel_s": "release_summary",
169  "rel_u": "release_url",
170  "ret": "retain",
171  "rgb_cmd_tpl": "rgb_command_template",
172  "rgb_cmd_t": "rgb_command_topic",
173  "rgb_stat_t": "rgb_state_topic",
174  "rgb_val_tpl": "rgb_value_template",
175  "rgbw_cmd_tpl": "rgbw_command_template",
176  "rgbw_cmd_t": "rgbw_command_topic",
177  "rgbw_stat_t": "rgbw_state_topic",
178  "rgbw_val_tpl": "rgbw_value_template",
179  "rgbww_cmd_tpl": "rgbww_command_template",
180  "rgbww_cmd_t": "rgbww_command_topic",
181  "rgbww_stat_t": "rgbww_state_topic",
182  "rgbww_val_tpl": "rgbww_value_template",
183  "send_cmd_t": "send_command_topic",
184  "send_if_off": "send_if_off",
185  "set_fan_spd_t": "set_fan_speed_topic",
186  "set_pos_tpl": "set_position_template",
187  "set_pos_t": "set_position_topic",
188  "pos_t": "position_topic",
189  "pos_tpl": "position_template",
190  "spd_rng_min": "speed_range_min",
191  "spd_rng_max": "speed_range_max",
192  "src_type": "source_type",
193  "stat_cla": "state_class",
194  "stat_clsd": "state_closed",
195  "stat_closing": "state_closing",
196  "stat_jam": "state_jammed",
197  "stat_off": "state_off",
198  "stat_on": "state_on",
199  "stat_open": "state_open",
200  "stat_opening": "state_opening",
201  "stat_stopped": "state_stopped",
202  "stat_locked": "state_locked",
203  "stat_locking": "state_locking",
204  "stat_unlocked": "state_unlocked",
205  "stat_unlocking": "state_unlocking",
206  "stat_t": "state_topic",
207  "stat_tpl": "state_template",
208  "stat_val_tpl": "state_value_template",
209  "step": "step",
210  "strt_mw_cmd_t": "start_mowing_command_topic",
211  "strt_mw_cmd_tpl": "start_mowing_command_template",
212  "stype": "subtype",
213  "sug_dsp_prc": "suggested_display_precision",
214  "sup_dur": "support_duration",
215  "sup_vol": "support_volume_set",
216  "sup_feat": "supported_features",
217  "sup_clrm": "supported_color_modes",
218  "swing_mode_cmd_tpl": "swing_mode_command_template",
219  "swing_mode_cmd_t": "swing_mode_command_topic",
220  "swing_mode_stat_tpl": "swing_mode_state_template",
221  "swing_mode_stat_t": "swing_mode_state_topic",
222  "temp_cmd_tpl": "temperature_command_template",
223  "temp_cmd_t": "temperature_command_topic",
224  "temp_hi_cmd_tpl": "temperature_high_command_template",
225  "temp_hi_cmd_t": "temperature_high_command_topic",
226  "temp_hi_stat_tpl": "temperature_high_state_template",
227  "temp_hi_stat_t": "temperature_high_state_topic",
228  "temp_lo_cmd_tpl": "temperature_low_command_template",
229  "temp_lo_cmd_t": "temperature_low_command_topic",
230  "temp_lo_stat_tpl": "temperature_low_state_template",
231  "temp_lo_stat_t": "temperature_low_state_topic",
232  "temp_stat_tpl": "temperature_state_template",
233  "temp_stat_t": "temperature_state_topic",
234  "temp_unit": "temperature_unit",
235  "tilt_clsd_val": "tilt_closed_value",
236  "tilt_cmd_t": "tilt_command_topic",
237  "tilt_cmd_tpl": "tilt_command_template",
238  "tilt_max": "tilt_max",
239  "tilt_min": "tilt_min",
240  "tilt_opnd_val": "tilt_opened_value",
241  "tilt_opt": "tilt_optimistic",
242  "tilt_status_t": "tilt_status_topic",
243  "tilt_status_tpl": "tilt_status_template",
244  "tit": "title",
245  "t": "topic",
246  "uniq_id": "unique_id",
247  "unit_of_meas": "unit_of_measurement",
248  "url_t": "url_topic",
249  "url_tpl": "url_template",
250  "val_tpl": "value_template",
251  "whit_cmd_t": "white_command_topic",
252  "whit_scl": "white_scale",
253  "xy_cmd_t": "xy_command_topic",
254  "xy_cmd_tpl": "xy_command_template",
255  "xy_stat_t": "xy_state_topic",
256  "xy_val_tpl": "xy_value_template",
257  "l_ver_t": "latest_version_topic",
258  "l_ver_tpl": "latest_version_template",
259  "pl_inst": "payload_install",
260 }
261 
262 DEVICE_ABBREVIATIONS = {
263  "cns": "connections",
264  "cu": "configuration_url",
265  "ids": "identifiers",
266  "name": "name",
267  "mf": "manufacturer",
268  "mdl": "model",
269  "mdl_id": "model_id",
270  "hw": "hw_version",
271  "sw": "sw_version",
272  "sa": "suggested_area",
273  "sn": "serial_number",
274 }
275 
276 ORIGIN_ABBREVIATIONS = {
277  "name": "name",
278  "sw": "sw_version",
279  "url": "support_url",
280 }