@digital-alchemy/hass 25.2.2 → 25.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/dist/dev/index.d.mts +3 -0
  2. package/dist/dev/index.mjs +4 -0
  3. package/dist/dev/index.mjs.map +1 -0
  4. package/dist/dev/mappings.d.mts +70 -0
  5. package/dist/dev/mappings.mjs +2 -0
  6. package/dist/dev/mappings.mjs.map +1 -0
  7. package/dist/dev/registry.d.mts +328 -0
  8. package/dist/dev/registry.mjs +2 -0
  9. package/dist/dev/registry.mjs.map +1 -0
  10. package/dist/dev/services.d.mts +2431 -0
  11. package/dist/dev/services.mjs +5 -0
  12. package/dist/dev/services.mjs.map +1 -0
  13. package/dist/helpers/device.d.mts +1 -1
  14. package/dist/helpers/entity-state.d.mts +2 -2
  15. package/dist/helpers/fetch/calendar.d.mts +1 -1
  16. package/dist/helpers/fetch/configuration.d.mts +1 -1
  17. package/dist/helpers/fetch/service-list.d.mts +28 -3
  18. package/dist/helpers/id-by.d.mts +2 -3
  19. package/dist/helpers/interfaces.d.mts +4 -5
  20. package/dist/helpers/interfaces.mjs.map +1 -1
  21. package/dist/helpers/registry.d.mts +1 -2
  22. package/dist/helpers/registry.mjs.map +1 -1
  23. package/dist/helpers/utility.d.mts +5 -21
  24. package/dist/helpers/utility.mjs +0 -5
  25. package/dist/helpers/utility.mjs.map +1 -1
  26. package/dist/helpers/websocket.d.mts +2 -1
  27. package/dist/index.d.mts +2 -1
  28. package/dist/index.mjs +2 -1
  29. package/dist/index.mjs.map +1 -1
  30. package/dist/mock_assistant/helpers/fixtures.d.mts +2 -1
  31. package/dist/mock_assistant/services/device.service.mjs.map +1 -1
  32. package/dist/mock_assistant/services/entity-registry.service.d.mts +1 -1
  33. package/dist/mock_assistant/services/entity.service.d.mts +2 -2
  34. package/dist/mock_assistant/services/events.service.d.mts +2 -1
  35. package/dist/mock_assistant/services/events.service.mjs.map +1 -1
  36. package/dist/mock_assistant/services/fixtures.service.d.mts +3 -2
  37. package/dist/mock_assistant/services/fixtures.service.mjs.map +1 -1
  38. package/dist/mock_assistant/services/zone.service.mjs +1 -1
  39. package/dist/mock_assistant/services/zone.service.mjs.map +1 -1
  40. package/dist/services/area.service.d.mts +1 -1
  41. package/dist/services/area.service.mjs +1 -1
  42. package/dist/services/area.service.mjs.map +1 -1
  43. package/dist/services/call-proxy.service.d.mts +1 -1
  44. package/dist/services/call-proxy.service.mjs.map +1 -1
  45. package/dist/services/config.service.mjs.map +1 -1
  46. package/dist/services/entity.service.d.mts +1 -1
  47. package/dist/services/entity.service.mjs +1 -1
  48. package/dist/services/entity.service.mjs.map +1 -1
  49. package/dist/services/fetch-api.service.d.mts +3 -2
  50. package/dist/services/fetch-api.service.mjs.map +1 -1
  51. package/dist/services/floor.service.mjs.map +1 -1
  52. package/dist/services/id-by.service.d.mts +1 -1
  53. package/dist/services/id-by.service.mjs +28 -3
  54. package/dist/services/id-by.service.mjs.map +1 -1
  55. package/dist/services/label.service.mjs.map +1 -1
  56. package/dist/services/reference.service.mjs +4 -3
  57. package/dist/services/reference.service.mjs.map +1 -1
  58. package/dist/services/websocket-api.service.mjs +2 -2
  59. package/dist/services/websocket-api.service.mjs.map +1 -1
  60. package/dist/testing/area.spec.mjs.map +1 -1
  61. package/dist/testing/entity.spec.mjs.map +1 -1
  62. package/dist/testing/floor.spec.mjs.map +1 -1
  63. package/dist/testing/id-by.spec.mjs.map +1 -1
  64. package/dist/testing/label.spec.mjs.map +1 -1
  65. package/dist/testing/ref-by.spec.mjs.map +1 -1
  66. package/dist/user.d.mts +43 -0
  67. package/dist/user.mjs +4 -0
  68. package/dist/user.mjs.map +1 -0
  69. package/package.json +18 -17
  70. package/src/dev/index.mts +3 -0
  71. package/src/dev/mappings.mts +121 -0
  72. package/src/dev/registry.mts +330 -0
  73. package/src/dev/services.mts +2759 -0
  74. package/src/helpers/device.mts +1 -1
  75. package/src/helpers/entity-state.mts +6 -9
  76. package/src/helpers/fetch/calendar.mts +1 -1
  77. package/src/helpers/fetch/configuration.mts +1 -1
  78. package/src/helpers/fetch/service-list.mts +23 -3
  79. package/src/helpers/id-by.mts +11 -13
  80. package/src/helpers/interfaces.mts +14 -18
  81. package/src/helpers/registry.mts +9 -2
  82. package/src/helpers/utility.mts +13 -67
  83. package/src/helpers/websocket.mts +2 -1
  84. package/src/index.mts +2 -1
  85. package/src/mock_assistant/helpers/fixtures.mts +1 -1
  86. package/src/mock_assistant/services/area.service.mts +1 -1
  87. package/src/mock_assistant/services/device.service.mts +1 -1
  88. package/src/mock_assistant/services/entity-registry.service.mts +1 -1
  89. package/src/mock_assistant/services/entity.service.mts +2 -2
  90. package/src/mock_assistant/services/events.service.mts +2 -1
  91. package/src/mock_assistant/services/fixtures.service.mts +2 -1
  92. package/src/mock_assistant/services/floor.service.mts +1 -1
  93. package/src/mock_assistant/services/label.service.mts +1 -1
  94. package/src/mock_assistant/services/zone.service.mts +13 -10
  95. package/src/services/area.service.mts +2 -3
  96. package/src/services/call-proxy.service.mts +2 -2
  97. package/src/services/config.service.mts +1 -1
  98. package/src/services/entity.service.mts +2 -4
  99. package/src/services/fetch-api.service.mts +1 -1
  100. package/src/services/floor.service.mts +1 -1
  101. package/src/services/id-by.service.mts +47 -19
  102. package/src/services/label.service.mts +1 -1
  103. package/src/services/reference.service.mts +19 -18
  104. package/src/services/websocket-api.service.mts +2 -2
  105. package/src/testing/area.spec.mts +1 -1
  106. package/src/testing/entity.spec.mts +2 -1
  107. package/src/testing/floor.spec.mts +1 -1
  108. package/src/testing/id-by.spec.mts +1 -1
  109. package/src/testing/label.spec.mts +1 -1
  110. package/src/testing/ref-by.spec.mts +2 -1
  111. package/src/user.mts +97 -0
  112. package/dist/dynamic.d.mts +0 -3764
  113. package/dist/dynamic.mjs +0 -7
  114. package/dist/dynamic.mjs.map +0 -1
  115. package/src/dynamic.mts +0 -4302
package/src/dynamic.mts DELETED
@@ -1,4302 +0,0 @@
1
- /* eslint-disable @typescript-eslint/no-magic-numbers */
2
- /* eslint-disable sonarjs/redundant-type-aliases */
3
- /* eslint-disable @cspell/spellchecker */
4
- /* eslint-disable @typescript-eslint/ban-ts-comment */
5
- /* eslint-disable @typescript-eslint/no-empty-object-type */
6
-
7
- // @ts-nocheck
8
- import { RequireAtLeastOne } from "type-fest";
9
-
10
- import {
11
- AndroidNotificationData,
12
- AppleNotificationData,
13
- NotificationData,
14
- PICK_ENTITY,
15
- } from "./helpers/index.mts";
16
- import { DynamicMergeAttributes } from "./merge.mts";
17
-
18
- type PICK_FROM_PLATFORM<ID extends TPlatformId, DOMAIN extends TRawDomains = TRawDomains> = Extract<
19
- REGISTRY_SETUP["platform"][`_${ID}`],
20
- PICK_ENTITY<DOMAIN>
21
- >;
22
-
23
- // #MARK: ENTITY_SETUP
24
- export type ENTITY_SETUP = {
25
- "button.example": {
26
- state: string;
27
- entity_id: "button.example";
28
- attributes: DynamicMergeAttributes<"button.example", { friendly_name: "Example button" }>;
29
- };
30
- "binary_sensor.hass_e2e_online": {
31
- attributes: DynamicMergeAttributes<
32
- "binary_sensor.hass_e2e_online",
33
- {
34
- friendly_name: "hass_e2e online";
35
- restored: true;
36
- supported_features: 0;
37
- }
38
- >;
39
- context: {
40
- id: "01HWXTSCSBGW129NV7WY8MMG1E";
41
- parent_id: null;
42
- user_id: null;
43
- };
44
- entity_id: "binary_sensor.hass_e2e_online";
45
-
46
- state: "unavailable";
47
- };
48
- "binary_sensor.toggles": {
49
- attributes: DynamicMergeAttributes<
50
- "binary_sensor.toggles",
51
- {
52
- friendly_name: "toggles";
53
- icon: "mdi:toggle-switch-variant-off";
54
- restored: true;
55
- supported_features: 0;
56
- }
57
- >;
58
- context: {
59
- id: "01HWXTSCSB43FF1R6FX0QEE4Z6";
60
- parent_id: null;
61
- user_id: null;
62
- };
63
- entity_id: "binary_sensor.toggles";
64
- state: "unavailable";
65
- };
66
- "calendar.united_states_tx": {
67
- attributes: DynamicMergeAttributes<
68
- "calendar.united_states_tx",
69
- {
70
- all_day: true;
71
- description: "";
72
- end_time: "2024-05-28 00:00:00";
73
- friendly_name: "United States, TX";
74
- location: "United States, TX";
75
- message: "Memorial Day";
76
- start_time: "2024-05-27 00:00:00";
77
- }
78
- >;
79
- context: {
80
- id: "01HWXTYEEFBB7QQC1CSM6PAR36";
81
- parent_id: null;
82
- user_id: null;
83
- };
84
- entity_id: "calendar.united_states_tx";
85
- state: "off";
86
- };
87
- "light.bedroom_ceiling_fan": {
88
- attributes: DynamicMergeAttributes<
89
- "light.bedroom_ceiling_fan",
90
- {
91
- brightness: null;
92
- color_mode: null;
93
- color_temp: null;
94
- color_temp_kelvin: null;
95
- friendly_name: "Bedroom Ceiling Fan";
96
- hs_color: null;
97
- icon: "mdi:lightbulb-group";
98
- max_color_temp_kelvin: 6535;
99
- max_mireds: 500;
100
- min_color_temp_kelvin: 2000;
101
- min_mireds: 153;
102
- rgb_color: null;
103
- supported_color_modes: ["color_temp", "xy"];
104
- supported_features: 40;
105
- xy_color: null;
106
- }
107
- >;
108
- context: {
109
- id: "01HX722Y1JFS6KN2MDERK0VJ2D";
110
- parent_id: null;
111
- user_id: null;
112
- };
113
- entity_id: "light.bedroom_ceiling_fan";
114
- state: "off";
115
- };
116
- "person.digital_alchemy": {
117
- attributes: DynamicMergeAttributes<
118
- "person.digital_alchemy",
119
- {
120
- device_trackers: [];
121
- editable: true;
122
- friendly_name: "digital-alchemy";
123
- id: "digital_alchemy";
124
- user_id: "4dd1cf7e93e94f3fbaf419501f9a3d59";
125
- }
126
- >;
127
- context: {
128
- id: "01HWXTSCSBRKJ9T2KV1JNER5KQ";
129
- parent_id: null;
130
- user_id: null;
131
- };
132
- entity_id: "person.digital_alchemy";
133
- state: "unknown";
134
- };
135
- "scene.games_room_auto": {
136
- attributes: DynamicMergeAttributes<
137
- "scene.games_room_auto",
138
- {
139
- "Managed By": "home_automation";
140
- friendly_name: "bedroom off";
141
- }
142
- >;
143
- context: {
144
- id: "01HWXW289S8HP5MSGNNTNB2CBG";
145
- parent_id: null;
146
- user_id: null;
147
- };
148
- entity_id: "scene.games_room_auto";
149
- state: "unknown";
150
- };
151
- "sensor.magic": {
152
- attributes: DynamicMergeAttributes<
153
- "sensor.magic",
154
- {
155
- friendly_name: "magic";
156
- icon: "mdi:satellite-uplink";
157
- restored: true;
158
- supported_features: 0;
159
- }
160
- >;
161
- context: {
162
- id: "01HWXTSCSBW34BP3R20RJ09CVZ";
163
- parent_id: null;
164
- user_id: null;
165
- };
166
- entity_id: "sensor.magic";
167
- state: string;
168
- };
169
- "sensor.sun_next_dawn": {
170
- attributes: DynamicMergeAttributes<
171
- "sensor.sun_next_dawn",
172
- {
173
- device_class: "timestamp";
174
- friendly_name: "Sun Next dawn";
175
- }
176
- >;
177
- context: {
178
- id: "01HWXTS8W1SRTPT5K1XM0G491X";
179
- parent_id: null;
180
- user_id: null;
181
- };
182
- entity_id: "sensor.sun_next_dawn";
183
-
184
- state: "2024-05-03T03:24:45+00:00";
185
- };
186
- "sensor.sun_next_dusk": {
187
- attributes: DynamicMergeAttributes<
188
- "sensor.sun_next_dusk",
189
- {
190
- device_class: "timestamp";
191
- friendly_name: "Sun Next dusk";
192
- }
193
- >;
194
- context: {
195
- id: "01HWXTS8W1S95P1MVHDGHSQEB2";
196
- parent_id: null;
197
- user_id: null;
198
- };
199
- entity_id: "sensor.sun_next_dusk";
200
- state: "2024-05-03T19:51:10+00:00";
201
- };
202
- "sensor.sun_next_midnight": {
203
- attributes: DynamicMergeAttributes<
204
- "sensor.sun_next_midnight",
205
- {
206
- device_class: "timestamp";
207
- friendly_name: "Sun Next midnight";
208
- }
209
- >;
210
- context: {
211
- id: "01HWXTS8W1YQCPA3WZ69Y9JSPD";
212
- parent_id: null;
213
- user_id: null;
214
- };
215
- entity_id: "sensor.sun_next_midnight";
216
- state: "2024-05-03T23:37:12+00:00";
217
- };
218
- "sensor.sun_next_noon": {
219
- attributes: DynamicMergeAttributes<
220
- "sensor.sun_next_noon",
221
- {
222
- device_class: "timestamp";
223
- friendly_name: "Sun Next noon";
224
- }
225
- >;
226
- context: {
227
- id: "01HWXTS8W28MVV48CQ31JB2WKC";
228
- parent_id: null;
229
- user_id: null;
230
- };
231
- entity_id: "sensor.sun_next_noon";
232
- state: "2024-05-03T11:37:19+00:00";
233
- };
234
- "sensor.sun_next_rising": {
235
- attributes: DynamicMergeAttributes<
236
- "sensor.sun_next_rising",
237
- {
238
- device_class: "timestamp";
239
- friendly_name: "Sun Next rising";
240
- }
241
- >;
242
- context: {
243
- id: "01HWXTS8W2MMADKGWE4A5BMH51";
244
- parent_id: null;
245
- user_id: null;
246
- };
247
- entity_id: "sensor.sun_next_rising";
248
- state: "2024-05-03T04:05:17+00:00";
249
- };
250
- "sensor.sun_next_setting": {
251
- attributes: DynamicMergeAttributes<
252
- "sensor.sun_next_setting",
253
- {
254
- device_class: "timestamp";
255
- friendly_name: "Sun Next setting";
256
- }
257
- >;
258
- context: {
259
- id: "01HWXTS8W24KWTHR2B6V32NCXG";
260
- parent_id: null;
261
- user_id: null;
262
- };
263
- entity_id: "sensor.sun_next_setting";
264
- state: "2024-05-03T19:10:21+00:00";
265
- };
266
- "sun.sun": {
267
- attributes: DynamicMergeAttributes<
268
- "sun.sun",
269
- {
270
- azimuth: 0.35;
271
- elevation: -21.86;
272
- friendly_name: "Sun";
273
- next_dawn: "2024-05-03T03:24:45.747945+00:00";
274
- next_dusk: "2024-05-03T19:51:10.358970+00:00";
275
- next_midnight: "2024-05-03T23:37:12+00:00";
276
- next_noon: "2024-05-03T11:37:19+00:00";
277
- next_rising: "2024-05-03T04:05:17.926549+00:00";
278
- next_setting: "2024-05-03T19:10:21.280558+00:00";
279
- rising: true;
280
- }
281
- >;
282
- context: {
283
- id: "01HWXTS8W1J2TDGMN7KKNWP8DV";
284
- parent_id: null;
285
- user_id: null;
286
- };
287
- entity_id: "sun.sun";
288
- state: "below_horizon";
289
- };
290
- "switch.bedroom_lamp": {
291
- attributes: DynamicMergeAttributes<
292
- "switch.bedroom_lamp",
293
- {
294
- friendly_name: "bedroom_lamp";
295
- restored: true;
296
- supported_features: 0;
297
- }
298
- >;
299
- context: {
300
- id: "01HWXTSCSB7BK003CH3AYYVXCB";
301
- parent_id: null;
302
- user_id: null;
303
- };
304
- entity_id: "switch.bedroom_lamp";
305
- state: "unavailable";
306
- };
307
- "switch.kitchen_cabinets": {
308
- attributes: DynamicMergeAttributes<
309
- "switch.kitchen_cabinets",
310
- {
311
- friendly_name: "kitchen_cabinets";
312
- restored: true;
313
- supported_features: 0;
314
- }
315
- >;
316
- context: {
317
- id: "01HWXTSCSBM9Y3SRQTFJ5CVK6H";
318
- parent_id: null;
319
- user_id: null;
320
- };
321
- entity_id: "switch.kitchen_cabinets";
322
- state: "unavailable";
323
- };
324
- "switch.living_room_mood_lights": {
325
- attributes: DynamicMergeAttributes<
326
- "switch.living_room_mood_lights",
327
- {
328
- friendly_name: "living_room_mood_lights";
329
- restored: true;
330
- supported_features: 0;
331
- }
332
- >;
333
- context: {
334
- id: "01HWXTSCSBS5B586JJ7VFH10SX";
335
- parent_id: null;
336
- user_id: null;
337
- };
338
- entity_id: "switch.living_room_mood_lights";
339
-
340
- state: "unavailable";
341
- };
342
- "switch.porch_light": {
343
- attributes: DynamicMergeAttributes<
344
- "switch.porch_light",
345
- {
346
- friendly_name: "porch_light";
347
- restored: true;
348
- supported_features: 0;
349
- }
350
- >;
351
- context: {
352
- id: "01HWXTSCSBFTSZR1M5XAK7XSR8";
353
- parent_id: null;
354
- user_id: null;
355
- };
356
- entity_id: "switch.porch_light";
357
- state: string;
358
- };
359
- "todo.shopping_list": {
360
- attributes: DynamicMergeAttributes<
361
- "todo.shopping_list",
362
- {
363
- friendly_name: "Shopping List";
364
- supported_features: 15;
365
- }
366
- >;
367
- context: {
368
- id: "01HWXTS8X3D417XC4YJTG8QJWB";
369
- parent_id: null;
370
- user_id: null;
371
- };
372
- entity_id: "todo.shopping_list";
373
- state: "0";
374
- };
375
- "tts.google_en_com": {
376
- attributes: DynamicMergeAttributes<
377
- "tts.google_en_com",
378
- {
379
- friendly_name: "Google en com";
380
- }
381
- >;
382
- context: {
383
- id: "01HWXTS8XMPQ236CDJ6X7C6E60";
384
- parent_id: null;
385
- user_id: null;
386
- };
387
- entity_id: "tts.google_en_com";
388
- state: "unknown";
389
- };
390
- "zone.home": {
391
- attributes: DynamicMergeAttributes<
392
- "zone.home",
393
- {
394
- editable: true;
395
- friendly_name: "Home";
396
- icon: "mdi:home";
397
- latitude: 52.373_133_9;
398
- longitude: 4.890_314_7;
399
- passive: false;
400
- persons: [];
401
- radius: 100;
402
- }
403
- >;
404
- context: {
405
- id: "01HWXTS8GMB4ZW20P8MGMX0QSN";
406
- parent_id: null;
407
- user_id: null;
408
- };
409
- entity_id: "zone.home";
410
- state: "0";
411
- };
412
- };
413
-
414
- // #MARK: iCallService
415
- export type iCallService = {
416
- // # MARK: automation
417
- automation: {
418
- /**
419
- * ### Reload
420
- *
421
- * > Reloads the automation configuration.
422
- */
423
- reload(service_data: {}): Promise<void>;
424
- /**
425
- * ### Toggle
426
- *
427
- * > Toggles (enable / disable) an automation.
428
- */
429
- toggle(service_data: {
430
- /**
431
- * Assisted definition
432
- * > ```yaml
433
- * > entity:
434
- * > - domain:
435
- * > - automation
436
- * > ```
437
- */
438
- entity_id: PICK_ENTITY<"automation"> | PICK_ENTITY<"automation">[];
439
- }): Promise<void>;
440
- /**
441
- * ### Trigger
442
- *
443
- * > Triggers the actions of an automation.
444
- */
445
- trigger(service_data?: {
446
- /**
447
- * ## Skip conditions
448
- *
449
- * > Defines whether or not the conditions will be skipped.
450
- *
451
- * ### Default
452
- *
453
- * > ```json
454
- * > true
455
- * > ```
456
- */
457
- skip_condition?: boolean;
458
- /**
459
- * Assisted definition
460
- * > ```yaml
461
- * > entity:
462
- * > - domain:
463
- * > - automation
464
- * > ```
465
- */
466
- entity_id: PICK_ENTITY<"automation"> | PICK_ENTITY<"automation">[];
467
- }): Promise<void>;
468
- /**
469
- * ### Turn off
470
- *
471
- * > Disables an automation.
472
- */
473
- turn_off(service_data?: {
474
- /**
475
- * ## Stop actions
476
- *
477
- * > Stops currently running actions.
478
- *
479
- * ### Default
480
- *
481
- * > ```json
482
- * > true
483
- * > ```
484
- */
485
- stop_actions?: boolean;
486
- /**
487
- * Assisted definition
488
- * > ```yaml
489
- * > entity:
490
- * > - domain:
491
- * > - automation
492
- * > ```
493
- */
494
- entity_id: PICK_ENTITY<"automation"> | PICK_ENTITY<"automation">[];
495
- }): Promise<void>;
496
- /**
497
- * ### Turn on
498
- *
499
- * > Enables an automation.
500
- */
501
- turn_on(service_data: {
502
- /**
503
- * Assisted definition
504
- * > ```yaml
505
- * > entity:
506
- * > - domain:
507
- * > - automation
508
- * > ```
509
- */
510
- entity_id: PICK_ENTITY<"automation"> | PICK_ENTITY<"automation">[];
511
- }): Promise<void>;
512
- };
513
- // # MARK: backup
514
- backup: {
515
- /**
516
- * ### Create backup
517
- *
518
- * > Creates a new backup.
519
- */
520
- create(service_data: {}): Promise<void>;
521
- };
522
- // # MARK: button
523
- button: {
524
- /**
525
- * ### Press
526
- *
527
- * > Press the button entity.
528
- */
529
- press(service_data: {
530
- /**
531
- * Assisted definition
532
- * > ```yaml
533
- * > entity:
534
- * > - domain:
535
- * > - button
536
- * > ```
537
- */
538
- entity_id: PICK_ENTITY<"button"> | PICK_ENTITY<"button">[];
539
- }): Promise<void>;
540
- };
541
- // # MARK: calendar
542
- calendar: {
543
- /**
544
- * ### Create event
545
- *
546
- * > Adds a new calendar event.
547
- */
548
- create_event(service_data?: {
549
- /**
550
- * ## Description
551
- *
552
- * > A more complete description of the event than the one provided by the summary.
553
- *
554
- * ### Example
555
- *
556
- * > ```json
557
- * > {
558
- * > "description": "Meeting to provide technical review for 'Phoenix' design."
559
- * > }
560
- * > ```
561
- */
562
- description?: string;
563
- /**
564
- * ## End date
565
- *
566
- * > The date the all-day event should end (exclusive).
567
- *
568
- * ### Example
569
- *
570
- * > ```json
571
- * > {
572
- * > "end_date": "2022-03-23"
573
- * > }
574
- * > ```
575
- *
576
- * ## Selector
577
- *
578
- * > ```yaml
579
- * > date: null
580
- * > ```
581
- */
582
- end_date?: unknown;
583
- /**
584
- * ## End time
585
- *
586
- * > The date and time the event should end.
587
- *
588
- * ### Example
589
- *
590
- * > ```json
591
- * > {
592
- * > "end_date_time": "2022-03-22 22:00:00"
593
- * > }
594
- * > ```
595
- *
596
- * ## Selector
597
- *
598
- * > ```yaml
599
- * > datetime: null
600
- * > ```
601
- */
602
- end_date_time?: unknown;
603
- /**
604
- * ## In
605
- *
606
- * > Days or weeks that you want to create the event in.
607
- *
608
- * ### Example
609
- *
610
- * > ```json
611
- * > {
612
- * > "in": "{\"days\": 2} or {\"weeks\": 2}"
613
- * > }
614
- * > ```
615
- *
616
- * ## Selector
617
- *
618
- * > ```yaml
619
- * >
620
- * > ```
621
- */
622
- in?: unknown;
623
- /**
624
- * ## Location
625
- *
626
- * > The location of the event.
627
- *
628
- * ### Example
629
- *
630
- * > ```json
631
- * > {
632
- * > "location": "Conference Room - F123, Bldg. 002"
633
- * > }
634
- * > ```
635
- */
636
- location?: string;
637
- /**
638
- * ## Start date
639
- *
640
- * > The date the all-day event should start.
641
- *
642
- * ### Example
643
- *
644
- * > ```json
645
- * > {
646
- * > "start_date": "2022-03-22"
647
- * > }
648
- * > ```
649
- *
650
- * ## Selector
651
- *
652
- * > ```yaml
653
- * > date: null
654
- * > ```
655
- */
656
- start_date?: unknown;
657
- /**
658
- * ## Start time
659
- *
660
- * > The date and time the event should start.
661
- *
662
- * ### Example
663
- *
664
- * > ```json
665
- * > {
666
- * > "start_date_time": "2022-03-22 20:00:00"
667
- * > }
668
- * > ```
669
- *
670
- * ## Selector
671
- *
672
- * > ```yaml
673
- * > datetime: null
674
- * > ```
675
- */
676
- start_date_time?: unknown;
677
- /**
678
- * ## Summary
679
- *
680
- * > Defines the short summary or subject for the event.
681
- *
682
- * ### Example
683
- *
684
- * > ```json
685
- * > {
686
- * > "summary": "Department Party"
687
- * > }
688
- * > ```
689
- */
690
- summary: string;
691
- /**
692
- * Assisted definition
693
- * > ```yaml
694
- * > entity:
695
- * > - domain:
696
- * > - calendar
697
- * > supported_features:
698
- * > - 1
699
- * > ```
700
- */
701
- entity_id: PICK_ENTITY<"calendar"> | PICK_ENTITY<"calendar">[];
702
- }): Promise<void>;
703
- /**
704
- * ### Get events
705
- *
706
- * > Get events on a calendar within a time range.
707
- */
708
- get_events(service_data?: {
709
- /**
710
- * ## Duration
711
- *
712
- * > Returns active events from start_date_time until the specified duration.
713
- *
714
- * ## Selector
715
- *
716
- * > ```yaml
717
- * > duration: null
718
- * > ```
719
- */
720
- duration?: unknown;
721
- /**
722
- * ## End time
723
- *
724
- * > Returns active events before this time (exclusive). Cannot be used with 'duration'.
725
- *
726
- * ### Example
727
- *
728
- * > ```json
729
- * > {
730
- * > "end_date_time": "2022-03-22 22:00:00"
731
- * > }
732
- * > ```
733
- *
734
- * ## Selector
735
- *
736
- * > ```yaml
737
- * > datetime: null
738
- * > ```
739
- */
740
- end_date_time?: unknown;
741
- /**
742
- * ## Start time
743
- *
744
- * > Returns active events after this time (exclusive). When not set, defaults to now.
745
- *
746
- * ### Example
747
- *
748
- * > ```json
749
- * > {
750
- * > "start_date_time": "2022-03-22 20:00:00"
751
- * > }
752
- * > ```
753
- *
754
- * ## Selector
755
- *
756
- * > ```yaml
757
- * > datetime: null
758
- * > ```
759
- */
760
- start_date_time?: unknown;
761
- /**
762
- * Assisted definition
763
- * > ```yaml
764
- * > entity:
765
- * > - domain:
766
- * > - calendar
767
- * > ```
768
- */
769
- entity_id: PICK_ENTITY<"calendar"> | PICK_ENTITY<"calendar">[];
770
- }): Promise<void>;
771
- /**
772
- * ### List event
773
- *
774
- * > Lists events on a calendar within a time range.
775
- */
776
- list_events(service_data?: {
777
- /**
778
- * ## Duration
779
- *
780
- * > Returns active events from start_date_time until the specified duration.
781
- *
782
- * ## Selector
783
- *
784
- * > ```yaml
785
- * > duration: null
786
- * > ```
787
- */
788
- duration?: unknown;
789
- /**
790
- * ## End time
791
- *
792
- * > Returns active events before this time (exclusive). Cannot be used with 'duration'.
793
- *
794
- * ### Example
795
- *
796
- * > ```json
797
- * > {
798
- * > "end_date_time": "2022-03-22 22:00:00"
799
- * > }
800
- * > ```
801
- *
802
- * ## Selector
803
- *
804
- * > ```yaml
805
- * > datetime: null
806
- * > ```
807
- */
808
- end_date_time?: unknown;
809
- /**
810
- * ## Start time
811
- *
812
- * > Returns active events after this time (exclusive). When not set, defaults to now.
813
- *
814
- * ### Example
815
- *
816
- * > ```json
817
- * > {
818
- * > "start_date_time": "2022-03-22 20:00:00"
819
- * > }
820
- * > ```
821
- *
822
- * ## Selector
823
- *
824
- * > ```yaml
825
- * > datetime: null
826
- * > ```
827
- */
828
- start_date_time?: unknown;
829
- /**
830
- * Assisted definition
831
- * > ```yaml
832
- * > entity:
833
- * > - domain:
834
- * > - calendar
835
- * > ```
836
- */
837
- entity_id: PICK_ENTITY<"calendar"> | PICK_ENTITY<"calendar">[];
838
- }): Promise<void>;
839
- };
840
- // # MARK: cloud
841
- cloud: {
842
- /**
843
- * ### Remote connect
844
- *
845
- * > Makes the instance UI accessible from outside of the local network by using Home Assistant Cloud.
846
- */
847
- remote_connect(service_data: {}): Promise<void>;
848
- /**
849
- * ### Remote disconnect
850
- *
851
- * > Disconnects the Home Assistant UI from the Home Assistant Cloud. You will no longer be able to access your Home Assistant instance from outside your local network.
852
- */
853
- remote_disconnect(service_data: {}): Promise<void>;
854
- };
855
- // # MARK: conversation
856
- conversation: {
857
- /**
858
- * ### Process
859
- *
860
- * > Launches a conversation from a transcribed text.
861
- */
862
- process(service_data?: {
863
- /**
864
- * ## Agent
865
- *
866
- * > Conversation agent to process your request. The conversation agent is the brains of your assistant. It processes the incoming text commands.
867
- *
868
- * ### Example
869
- *
870
- * > ```json
871
- * > {
872
- * > "agent_id": "homeassistant"
873
- * > }
874
- * > ```
875
- *
876
- * ## Selector
877
- *
878
- * > ```yaml
879
- * > conversation_agent: null
880
- * > ```
881
- */
882
- agent_id?: unknown;
883
- /**
884
- * ## Conversation ID
885
- *
886
- * > ID of the conversation, to be able to continue a previous conversation
887
- *
888
- * ### Example
889
- *
890
- * > ```json
891
- * > {
892
- * > "conversation_id": "my_conversation_1"
893
- * > }
894
- * > ```
895
- */
896
- conversation_id?: string;
897
- /**
898
- * ## Language
899
- *
900
- * > Language of text. Defaults to server language.
901
- *
902
- * ### Example
903
- *
904
- * > ```json
905
- * > {
906
- * > "language": "NL"
907
- * > }
908
- * > ```
909
- */
910
- language?: string;
911
- /**
912
- * ## Text
913
- *
914
- * > Transcribed text input.
915
- *
916
- * ### Example
917
- *
918
- * > ```json
919
- * > {
920
- * > "text": "Turn all lights on"
921
- * > }
922
- * > ```
923
- */
924
- text: string;
925
- }): Promise<void>;
926
- /**
927
- * ### Reload
928
- *
929
- * > Reloads the intent configuration.
930
- */
931
- reload(service_data?: {
932
- /**
933
- * ## Agent
934
- *
935
- * > Conversation agent to reload.
936
- *
937
- * ### Example
938
- *
939
- * > ```json
940
- * > {
941
- * > "agent_id": "homeassistant"
942
- * > }
943
- * > ```
944
- *
945
- * ## Selector
946
- *
947
- * > ```yaml
948
- * > conversation_agent: null
949
- * > ```
950
- */
951
- agent_id?: unknown;
952
- /**
953
- * ## Language
954
- *
955
- * > Language to clear cached intents for. Defaults to server language.
956
- *
957
- * ### Example
958
- *
959
- * > ```json
960
- * > {
961
- * > "language": "NL"
962
- * > }
963
- * > ```
964
- */
965
- language?: string;
966
- }): Promise<void>;
967
- };
968
- // # MARK: counter
969
- counter: {
970
- /**
971
- * ### Decrement
972
- *
973
- * > Decrements a counter.
974
- */
975
- decrement(service_data: {
976
- /**
977
- * Assisted definition
978
- * > ```yaml
979
- * > entity:
980
- * > - domain:
981
- * > - counter
982
- * > ```
983
- */
984
- entity_id: PICK_ENTITY<"counter"> | PICK_ENTITY<"counter">[];
985
- }): Promise<void>;
986
- /**
987
- * ### Increment
988
- *
989
- * > Increments a counter.
990
- */
991
- increment(service_data: {
992
- /**
993
- * Assisted definition
994
- * > ```yaml
995
- * > entity:
996
- * > - domain:
997
- * > - counter
998
- * > ```
999
- */
1000
- entity_id: PICK_ENTITY<"counter"> | PICK_ENTITY<"counter">[];
1001
- }): Promise<void>;
1002
- /**
1003
- * ### Reset
1004
- *
1005
- * > Resets a counter.
1006
- */
1007
- reset(service_data: {
1008
- /**
1009
- * Assisted definition
1010
- * > ```yaml
1011
- * > entity:
1012
- * > - domain:
1013
- * > - counter
1014
- * > ```
1015
- */
1016
- entity_id: PICK_ENTITY<"counter"> | PICK_ENTITY<"counter">[];
1017
- }): Promise<void>;
1018
- /**
1019
- * ### Set
1020
- *
1021
- * > Sets the counter value.
1022
- */
1023
- set_value(service_data: {
1024
- /**
1025
- * ## Value
1026
- *
1027
- * > The new counter value the entity should be set to.
1028
- *
1029
- * ## Selector
1030
- *
1031
- * > ```yaml
1032
- * > number:
1033
- * > min: 0
1034
- * > max: 9223372036854776000
1035
- * > mode: box
1036
- * > ```
1037
- */
1038
- value: number;
1039
- /**
1040
- * Assisted definition
1041
- * > ```yaml
1042
- * > entity:
1043
- * > - domain:
1044
- * > - counter
1045
- * > ```
1046
- */
1047
- entity_id: PICK_ENTITY<"counter"> | PICK_ENTITY<"counter">[];
1048
- }): Promise<void>;
1049
- };
1050
- // # MARK: ffmpeg
1051
- ffmpeg: {
1052
- /**
1053
- * ### Restart
1054
- *
1055
- * > Sends a restart command to a ffmpeg based sensor.
1056
- */
1057
- restart(service_data?: {
1058
- /**
1059
- * ## Entity
1060
- *
1061
- * > Name of entity that will restart. Platform dependent.
1062
- *
1063
- * ## Selector
1064
- *
1065
- * > ```yaml
1066
- * > entity:
1067
- * > integration: ffmpeg
1068
- * > domain: binary_sensor
1069
- * > ```
1070
- */
1071
- entity_id?:
1072
- | PICK_FROM_PLATFORM<"ffmpeg", "binary_sensor">
1073
- | PICK_FROM_PLATFORM<"ffmpeg", "binary_sensor">[];
1074
- }): Promise<void>;
1075
- /**
1076
- * ### Start
1077
- *
1078
- * > Sends a start command to a ffmpeg based sensor.
1079
- */
1080
- start(service_data?: {
1081
- /**
1082
- * ## Entity
1083
- *
1084
- * > Name of entity that will start. Platform dependent.
1085
- *
1086
- * ## Selector
1087
- *
1088
- * > ```yaml
1089
- * > entity:
1090
- * > integration: ffmpeg
1091
- * > domain: binary_sensor
1092
- * > ```
1093
- */
1094
- entity_id?:
1095
- | PICK_FROM_PLATFORM<"ffmpeg", "binary_sensor">
1096
- | PICK_FROM_PLATFORM<"ffmpeg", "binary_sensor">[];
1097
- }): Promise<void>;
1098
- /**
1099
- * ### Stop
1100
- *
1101
- * > Sends a stop command to a ffmpeg based sensor.
1102
- */
1103
- stop(service_data?: {
1104
- /**
1105
- * ## Entity
1106
- *
1107
- * > Name of entity that will stop. Platform dependent.
1108
- *
1109
- * ## Selector
1110
- *
1111
- * > ```yaml
1112
- * > entity:
1113
- * > integration: ffmpeg
1114
- * > domain: binary_sensor
1115
- * > ```
1116
- */
1117
- entity_id?:
1118
- | PICK_FROM_PLATFORM<"ffmpeg", "binary_sensor">
1119
- | PICK_FROM_PLATFORM<"ffmpeg", "binary_sensor">[];
1120
- }): Promise<void>;
1121
- };
1122
- // # MARK: frontend
1123
- frontend: {
1124
- /**
1125
- * ### Reload themes
1126
- *
1127
- * > Reloads themes from the YAML-configuration.
1128
- */
1129
- reload_themes(service_data: {}): Promise<void>;
1130
- /**
1131
- * ### Set the default theme
1132
- *
1133
- * > Sets the default theme Home Assistant uses. Can be overridden by a user.
1134
- */
1135
- set_theme(service_data?: {
1136
- /**
1137
- * ## Mode
1138
- *
1139
- * > Theme mode.
1140
- *
1141
- * ### Default
1142
- *
1143
- * > ```json
1144
- * > "light"
1145
- * > ```
1146
- */
1147
- mode?: "dark" | "light";
1148
- /**
1149
- * ## Theme
1150
- *
1151
- * > Name of a theme.
1152
- *
1153
- * ### Example
1154
- *
1155
- * > ```json
1156
- * > {
1157
- * > "name": "default"
1158
- * > }
1159
- * > ```
1160
- *
1161
- * ## Selector
1162
- *
1163
- * > ```yaml
1164
- * > theme:
1165
- * > include_default: true
1166
- * > ```
1167
- */
1168
- name: unknown;
1169
- }): Promise<void>;
1170
- };
1171
- // # MARK: homeassistant
1172
- homeassistant: {
1173
- /**
1174
- * ### Check configuration
1175
- *
1176
- * > Checks the Home Assistant YAML-configuration files for errors. Errors will be shown in the Home Assistant logs.
1177
- */
1178
- check_config(service_data: {}): Promise<void>;
1179
- /**
1180
- * ### Reload all
1181
- *
1182
- * > Reload all YAML configuration that can be reloaded without restarting Home Assistant.
1183
- */
1184
- reload_all(service_data: {}): Promise<void>;
1185
- /**
1186
- * ### Reload config entry
1187
- *
1188
- * > Reloads the specified config entry.
1189
- */
1190
- reload_config_entry(service_data?: {
1191
- /**
1192
- * ## Config entry ID
1193
- *
1194
- * > The configuration entry ID of the entry to be reloaded.
1195
- *
1196
- * ### Example
1197
- *
1198
- * > ```json
1199
- * > {
1200
- * > "entry_id": "8955375327824e14ba89e4b29cc3ec9a"
1201
- * > }
1202
- * > ```
1203
- */
1204
- entry_id?: string;
1205
- /**
1206
- * Assisted definition
1207
- * > ```yaml
1208
- * > entity:
1209
- * > - {}
1210
- * > device:
1211
- * > - {}
1212
- * > ```
1213
- */
1214
- entity_id: PICK_ENTITY | PICK_ENTITY[];
1215
- }): Promise<void>;
1216
- /**
1217
- * ### Reload core configuration
1218
- *
1219
- * > Reloads the core configuration from the YAML-configuration.
1220
- */
1221
- reload_core_config(service_data: {}): Promise<void>;
1222
- /**
1223
- * ### Reload custom Jinja2 templates
1224
- *
1225
- * > Reloads Jinja2 templates found in the `custom_templates` folder in your config. New values will be applied on the next render of the template.
1226
- */
1227
- reload_custom_templates(service_data: {}): Promise<void>;
1228
- /**
1229
- * ### Restart
1230
- *
1231
- * > Restarts Home Assistant.
1232
- */
1233
- restart(service_data: {}): Promise<void>;
1234
- /**
1235
- * ### Save persistent states
1236
- *
1237
- * > Saves the persistent states immediately. Maintains the normal periodic saving interval.
1238
- */
1239
- save_persistent_states(service_data: {}): Promise<void>;
1240
- /**
1241
- * ### Set location
1242
- *
1243
- * > Updates the Home Assistant location.
1244
- */
1245
- set_location(service_data?: {
1246
- /**
1247
- * ## Elevation
1248
- *
1249
- * > Elevation of your location.
1250
- *
1251
- * ### Example
1252
- *
1253
- * > ```json
1254
- * > {
1255
- * > "elevation": "120"
1256
- * > }
1257
- * > ```
1258
- *
1259
- * ## Selector
1260
- *
1261
- * > ```yaml
1262
- * > number:
1263
- * > mode: box
1264
- * > step: any
1265
- * > ```
1266
- */
1267
- elevation?: number;
1268
- /**
1269
- * ## Latitude
1270
- *
1271
- * > Latitude of your location.
1272
- *
1273
- * ### Example
1274
- *
1275
- * > ```json
1276
- * > {
1277
- * > "latitude": "32.87336"
1278
- * > }
1279
- * > ```
1280
- *
1281
- * ## Selector
1282
- *
1283
- * > ```yaml
1284
- * > number:
1285
- * > mode: box
1286
- * > min: -90
1287
- * > max: 90
1288
- * > step: any
1289
- * > ```
1290
- */
1291
- latitude: number;
1292
- /**
1293
- * ## Longitude
1294
- *
1295
- * > Longitude of your location.
1296
- *
1297
- * ### Example
1298
- *
1299
- * > ```json
1300
- * > {
1301
- * > "longitude": "117.22743"
1302
- * > }
1303
- * > ```
1304
- *
1305
- * ## Selector
1306
- *
1307
- * > ```yaml
1308
- * > number:
1309
- * > mode: box
1310
- * > min: -180
1311
- * > max: 180
1312
- * > step: any
1313
- * > ```
1314
- */
1315
- longitude: number;
1316
- }): Promise<void>;
1317
- /**
1318
- * ### Stop
1319
- *
1320
- * > Stops Home Assistant.
1321
- */
1322
- stop(service_data: {}): Promise<void>;
1323
- /**
1324
- * ### Generic toggle
1325
- *
1326
- * > Generic service to toggle devices on/off under any domain.
1327
- */
1328
- toggle(service_data: {
1329
- /**
1330
- * Assisted definition
1331
- * > ```yaml
1332
- * > entity:
1333
- * > - {}
1334
- * > ```
1335
- */
1336
- entity_id: PICK_ENTITY | PICK_ENTITY[];
1337
- }): Promise<void>;
1338
- /**
1339
- * ### Generic turn off
1340
- *
1341
- * > Generic service to turn devices off under any domain.
1342
- */
1343
- turn_off(service_data: {
1344
- /**
1345
- * Assisted definition
1346
- * > ```yaml
1347
- * > entity:
1348
- * > - {}
1349
- * > ```
1350
- */
1351
- entity_id: PICK_ENTITY | PICK_ENTITY[];
1352
- }): Promise<void>;
1353
- /**
1354
- * ### Generic turn on
1355
- *
1356
- * > Generic service to turn devices on under any domain.
1357
- */
1358
- turn_on(service_data: {
1359
- /**
1360
- * Assisted definition
1361
- * > ```yaml
1362
- * > entity:
1363
- * > - {}
1364
- * > ```
1365
- */
1366
- entity_id: PICK_ENTITY | PICK_ENTITY[];
1367
- }): Promise<void>;
1368
- /**
1369
- * ### Update entity
1370
- *
1371
- * > Forces one or more entities to update its data.
1372
- */
1373
- update_entity(service_data: {
1374
- /**
1375
- * Assisted definition
1376
- * > ```yaml
1377
- * > entity:
1378
- * > - {}
1379
- * > ```
1380
- */
1381
- entity_id: PICK_ENTITY | PICK_ENTITY[];
1382
- }): Promise<void>;
1383
- };
1384
- // # MARK: input_boolean
1385
- input_boolean: {
1386
- /**
1387
- * ### Reload
1388
- *
1389
- * > Reloads helpers from the YAML-configuration.
1390
- */
1391
- reload(service_data: {}): Promise<void>;
1392
- /**
1393
- * ### Toggle
1394
- *
1395
- * > Toggles the helper on/off.
1396
- */
1397
- toggle(service_data: {
1398
- /**
1399
- * Assisted definition
1400
- * > ```yaml
1401
- * > entity:
1402
- * > - domain:
1403
- * > - input_boolean
1404
- * > ```
1405
- */
1406
- entity_id: PICK_ENTITY<"input_boolean"> | PICK_ENTITY<"input_boolean">[];
1407
- }): Promise<void>;
1408
- /**
1409
- * ### Turn off
1410
- *
1411
- * > Turns off the helper.
1412
- */
1413
- turn_off(service_data: {
1414
- /**
1415
- * Assisted definition
1416
- * > ```yaml
1417
- * > entity:
1418
- * > - domain:
1419
- * > - input_boolean
1420
- * > ```
1421
- */
1422
- entity_id: PICK_ENTITY<"input_boolean"> | PICK_ENTITY<"input_boolean">[];
1423
- }): Promise<void>;
1424
- /**
1425
- * ### Turn on
1426
- *
1427
- * > Turns on the helper.
1428
- */
1429
- turn_on(service_data: {
1430
- /**
1431
- * Assisted definition
1432
- * > ```yaml
1433
- * > entity:
1434
- * > - domain:
1435
- * > - input_boolean
1436
- * > ```
1437
- */
1438
- entity_id: PICK_ENTITY<"input_boolean"> | PICK_ENTITY<"input_boolean">[];
1439
- }): Promise<void>;
1440
- };
1441
- // # MARK: input_button
1442
- input_button: {
1443
- /**
1444
- * ### Press
1445
- *
1446
- * > Mimics the physical button press on the device.
1447
- */
1448
- press(service_data: {
1449
- /**
1450
- * Assisted definition
1451
- * > ```yaml
1452
- * > entity:
1453
- * > - domain:
1454
- * > - input_button
1455
- * > ```
1456
- */
1457
- entity_id: PICK_ENTITY<"input_button"> | PICK_ENTITY<"input_button">[];
1458
- }): Promise<void>;
1459
- /**
1460
- * ### Reload
1461
- *
1462
- * > Reloads helpers from the YAML-configuration.
1463
- */
1464
- reload(service_data: {}): Promise<void>;
1465
- };
1466
- // # MARK: input_datetime
1467
- input_datetime: {
1468
- /**
1469
- * ### Reload
1470
- *
1471
- * > Reloads helpers from the YAML-configuration.
1472
- */
1473
- reload(service_data: {}): Promise<void>;
1474
- /**
1475
- * ### Set
1476
- *
1477
- * > Sets the date and/or time.
1478
- */
1479
- set_datetime(service_data?: {
1480
- /**
1481
- * ## Date
1482
- *
1483
- * > The target date.
1484
- *
1485
- * ### Example
1486
- *
1487
- * > ```json
1488
- * > {
1489
- * > "date": "\"2019-04-20\""
1490
- * > }
1491
- * > ```
1492
- */
1493
- date?: string;
1494
- /**
1495
- * ## Date & time
1496
- *
1497
- * > The target date & time.
1498
- *
1499
- * ### Example
1500
- *
1501
- * > ```json
1502
- * > {
1503
- * > "datetime": "\"2019-04-20 05:04:20\""
1504
- * > }
1505
- * > ```
1506
- */
1507
- datetime?: string;
1508
- /**
1509
- * ## Time
1510
- *
1511
- * > The target time.
1512
- *
1513
- * ### Example
1514
- *
1515
- * > ```json
1516
- * > {
1517
- * > "time": "\"05:04:20\""
1518
- * > }
1519
- * > ```
1520
- */
1521
- time?: string;
1522
- /**
1523
- * ## Timestamp
1524
- *
1525
- * > The target date & time, expressed by a UNIX timestamp.
1526
- *
1527
- * ## Selector
1528
- *
1529
- * > ```yaml
1530
- * > number:
1531
- * > min: 0
1532
- * > max: 9223372036854776000
1533
- * > mode: box
1534
- * > ```
1535
- */
1536
- timestamp?: number;
1537
- /**
1538
- * Assisted definition
1539
- * > ```yaml
1540
- * > entity:
1541
- * > - domain:
1542
- * > - input_datetime
1543
- * > ```
1544
- */
1545
- entity_id: PICK_ENTITY<"input_datetime"> | PICK_ENTITY<"input_datetime">[];
1546
- }): Promise<void>;
1547
- };
1548
- // # MARK: input_number
1549
- input_number: {
1550
- /**
1551
- * ### Decrement
1552
- *
1553
- * > Decrements the current value by 1 step.
1554
- */
1555
- decrement(service_data: {
1556
- /**
1557
- * Assisted definition
1558
- * > ```yaml
1559
- * > entity:
1560
- * > - domain:
1561
- * > - input_number
1562
- * > ```
1563
- */
1564
- entity_id: PICK_ENTITY<"input_number"> | PICK_ENTITY<"input_number">[];
1565
- }): Promise<void>;
1566
- /**
1567
- * ### Increment
1568
- *
1569
- * > Increments the value by 1 step.
1570
- */
1571
- increment(service_data: {
1572
- /**
1573
- * Assisted definition
1574
- * > ```yaml
1575
- * > entity:
1576
- * > - domain:
1577
- * > - input_number
1578
- * > ```
1579
- */
1580
- entity_id: PICK_ENTITY<"input_number"> | PICK_ENTITY<"input_number">[];
1581
- }): Promise<void>;
1582
- /**
1583
- * ### Reload
1584
- *
1585
- * > Reloads helpers from the YAML-configuration.
1586
- */
1587
- reload(service_data: {}): Promise<void>;
1588
- /**
1589
- * ### Set
1590
- *
1591
- * > Sets the value.
1592
- */
1593
- set_value(service_data: {
1594
- /**
1595
- * ## Value
1596
- *
1597
- * > The target value.
1598
- *
1599
- * ## Selector
1600
- *
1601
- * > ```yaml
1602
- * > number:
1603
- * > min: 0
1604
- * > max: 9223372036854776000
1605
- * > step: 0.001
1606
- * > mode: box
1607
- * > ```
1608
- */
1609
- value: number;
1610
- /**
1611
- * Assisted definition
1612
- * > ```yaml
1613
- * > entity:
1614
- * > - domain:
1615
- * > - input_number
1616
- * > ```
1617
- */
1618
- entity_id: PICK_ENTITY<"input_number"> | PICK_ENTITY<"input_number">[];
1619
- }): Promise<void>;
1620
- };
1621
- // # MARK: input_select
1622
- input_select: {
1623
- /**
1624
- * ### Reload
1625
- *
1626
- * > Reloads helpers from the YAML-configuration.
1627
- */
1628
- reload(service_data: {}): Promise<void>;
1629
- /**
1630
- * ### First
1631
- *
1632
- * > Selects the first option.
1633
- */
1634
- select_first(service_data: {
1635
- /**
1636
- * Assisted definition
1637
- * > ```yaml
1638
- * > entity:
1639
- * > - domain:
1640
- * > - input_select
1641
- * > ```
1642
- */
1643
- entity_id: PICK_ENTITY<"input_select"> | PICK_ENTITY<"input_select">[];
1644
- }): Promise<void>;
1645
- /**
1646
- * ### Last
1647
- *
1648
- * > Selects the last option.
1649
- */
1650
- select_last(service_data: {
1651
- /**
1652
- * Assisted definition
1653
- * > ```yaml
1654
- * > entity:
1655
- * > - domain:
1656
- * > - input_select
1657
- * > ```
1658
- */
1659
- entity_id: PICK_ENTITY<"input_select"> | PICK_ENTITY<"input_select">[];
1660
- }): Promise<void>;
1661
- /**
1662
- * ### Next
1663
- *
1664
- * > Select the next option.
1665
- */
1666
- select_next(service_data?: {
1667
- /**
1668
- * ## Cycle
1669
- *
1670
- * > If the option should cycle from the last to the first option on the list.
1671
- *
1672
- * ### Default
1673
- *
1674
- * > ```json
1675
- * > true
1676
- * > ```
1677
- */
1678
- cycle?: boolean;
1679
- /**
1680
- * Assisted definition
1681
- * > ```yaml
1682
- * > entity:
1683
- * > - domain:
1684
- * > - input_select
1685
- * > ```
1686
- */
1687
- entity_id: PICK_ENTITY<"input_select"> | PICK_ENTITY<"input_select">[];
1688
- }): Promise<void>;
1689
- /**
1690
- * ### Select
1691
- *
1692
- * > Selects an option.
1693
- */
1694
- select_option(service_data: {
1695
- /**
1696
- * ## Option
1697
- *
1698
- * > Option to be selected.
1699
- *
1700
- * ### Example
1701
- *
1702
- * > ```json
1703
- * > {
1704
- * > "option": "\"Item A\""
1705
- * > }
1706
- * > ```
1707
- */
1708
- option: string;
1709
- /**
1710
- * Assisted definition
1711
- * > ```yaml
1712
- * > entity:
1713
- * > - domain:
1714
- * > - input_select
1715
- * > ```
1716
- */
1717
- entity_id: PICK_ENTITY<"input_select"> | PICK_ENTITY<"input_select">[];
1718
- }): Promise<void>;
1719
- /**
1720
- * ### Previous
1721
- *
1722
- * > Selects the previous option.
1723
- */
1724
- select_previous(service_data?: {
1725
- /**
1726
- * ## Cycle
1727
- *
1728
- * > If the option should cycle from the last to the first option on the list.
1729
- *
1730
- * ### Default
1731
- *
1732
- * > ```json
1733
- * > true
1734
- * > ```
1735
- */
1736
- cycle?: boolean;
1737
- /**
1738
- * Assisted definition
1739
- * > ```yaml
1740
- * > entity:
1741
- * > - domain:
1742
- * > - input_select
1743
- * > ```
1744
- */
1745
- entity_id: PICK_ENTITY<"input_select"> | PICK_ENTITY<"input_select">[];
1746
- }): Promise<void>;
1747
- /**
1748
- * ### Set options
1749
- *
1750
- * > Sets the options.
1751
- */
1752
- set_options(service_data: {
1753
- /**
1754
- * ## Options
1755
- *
1756
- * > List of options.
1757
- *
1758
- * ### Example
1759
- *
1760
- * > ```json
1761
- * > {
1762
- * > "options": "[\"Item A\", \"Item B\", \"Item C\"]"
1763
- * > }
1764
- * > ```
1765
- *
1766
- * ## Selector
1767
- *
1768
- * > ```yaml
1769
- * > object: null
1770
- * > ```
1771
- */
1772
- options: unknown;
1773
- /**
1774
- * Assisted definition
1775
- * > ```yaml
1776
- * > entity:
1777
- * > - domain:
1778
- * > - input_select
1779
- * > ```
1780
- */
1781
- entity_id: PICK_ENTITY<"input_select"> | PICK_ENTITY<"input_select">[];
1782
- }): Promise<void>;
1783
- };
1784
- // # MARK: light
1785
- light: {
1786
- /**
1787
- * ### Toggle
1788
- *
1789
- * > Toggles one or more lights, from on to off, or, off to on, based on their current state.
1790
- */
1791
- toggle(service_data?: {
1792
- /**
1793
- * ## Brightness value
1794
- *
1795
- * > Number indicating brightness, where 0 turns the light off, 1 is the minimum brightness, and 255 is the maximum brightness.
1796
- *
1797
- * ## Selector
1798
- *
1799
- * > ```yaml
1800
- * > number:
1801
- * > min: 0
1802
- * > max: 255
1803
- * > ```
1804
- */
1805
- brightness?: number;
1806
- /**
1807
- * ## Brightness
1808
- *
1809
- * > Number indicating the percentage of full brightness, where 0 turns the light off, 1 is the minimum brightness, and 100 is the maximum brightness.
1810
- *
1811
- * ## Selector
1812
- *
1813
- * > ```yaml
1814
- * > number:
1815
- * > min: 0
1816
- * > max: 100
1817
- * > unit_of_measurement: '%'
1818
- * > ```
1819
- */
1820
- brightness_pct?: number;
1821
- /**
1822
- * ## Color name
1823
- *
1824
- * > A human-readable color name.
1825
- */
1826
- color_name?:
1827
- | "homeassistant"
1828
- | "aliceblue"
1829
- | "antiquewhite"
1830
- | "aqua"
1831
- | "aquamarine"
1832
- | "azure"
1833
- | "beige"
1834
- | "bisque"
1835
- | "blanchedalmond"
1836
- | "blue"
1837
- | "blueviolet"
1838
- | "brown"
1839
- | "burlywood"
1840
- | "cadetblue"
1841
- | "chartreuse"
1842
- | "chocolate"
1843
- | "coral"
1844
- | "cornflowerblue"
1845
- | "cornsilk"
1846
- | "crimson"
1847
- | "cyan"
1848
- | "darkblue"
1849
- | "darkcyan"
1850
- | "darkgoldenrod"
1851
- | "darkgray"
1852
- | "darkgreen"
1853
- | "darkgrey"
1854
- | "darkkhaki"
1855
- | "darkmagenta"
1856
- | "darkolivegreen"
1857
- | "darkorange"
1858
- | "darkorchid"
1859
- | "darkred"
1860
- | "darksalmon"
1861
- | "darkseagreen"
1862
- | "darkslateblue"
1863
- | "darkslategray"
1864
- | "darkslategrey"
1865
- | "darkturquoise"
1866
- | "darkviolet"
1867
- | "deeppink"
1868
- | "deepskyblue"
1869
- | "dimgray"
1870
- | "dimgrey"
1871
- | "dodgerblue"
1872
- | "firebrick"
1873
- | "floralwhite"
1874
- | "forestgreen"
1875
- | "fuchsia"
1876
- | "gainsboro"
1877
- | "ghostwhite"
1878
- | "gold"
1879
- | "goldenrod"
1880
- | "gray"
1881
- | "green"
1882
- | "greenyellow"
1883
- | "grey"
1884
- | "honeydew"
1885
- | "hotpink"
1886
- | "indianred"
1887
- | "indigo"
1888
- | "ivory"
1889
- | "khaki"
1890
- | "lavender"
1891
- | "lavenderblush"
1892
- | "lawngreen"
1893
- | "lemonchiffon"
1894
- | "lightblue"
1895
- | "lightcoral"
1896
- | "lightcyan"
1897
- | "lightgoldenrodyellow"
1898
- | "lightgray"
1899
- | "lightgreen"
1900
- | "lightgrey"
1901
- | "lightpink"
1902
- | "lightsalmon"
1903
- | "lightseagreen"
1904
- | "lightskyblue"
1905
- | "lightslategray"
1906
- | "lightslategrey"
1907
- | "lightsteelblue"
1908
- | "lightyellow"
1909
- | "lime"
1910
- | "limegreen"
1911
- | "linen"
1912
- | "magenta"
1913
- | "maroon"
1914
- | "mediumaquamarine"
1915
- | "mediumblue"
1916
- | "mediumorchid"
1917
- | "mediumpurple"
1918
- | "mediumseagreen"
1919
- | "mediumslateblue"
1920
- | "mediumspringgreen"
1921
- | "mediumturquoise"
1922
- | "mediumvioletred"
1923
- | "midnightblue"
1924
- | "mintcream"
1925
- | "mistyrose"
1926
- | "moccasin"
1927
- | "navajowhite"
1928
- | "navy"
1929
- | "navyblue"
1930
- | "oldlace"
1931
- | "olive"
1932
- | "olivedrab"
1933
- | "orange"
1934
- | "orangered"
1935
- | "orchid"
1936
- | "palegoldenrod"
1937
- | "palegreen"
1938
- | "paleturquoise"
1939
- | "palevioletred"
1940
- | "papayawhip"
1941
- | "peachpuff"
1942
- | "peru"
1943
- | "pink"
1944
- | "plum"
1945
- | "powderblue"
1946
- | "purple"
1947
- | "red"
1948
- | "rosybrown"
1949
- | "royalblue"
1950
- | "saddlebrown"
1951
- | "salmon"
1952
- | "sandybrown"
1953
- | "seagreen"
1954
- | "seashell"
1955
- | "sienna"
1956
- | "silver"
1957
- | "skyblue"
1958
- | "slateblue"
1959
- | "slategray"
1960
- | "slategrey"
1961
- | "snow"
1962
- | "springgreen"
1963
- | "steelblue"
1964
- | "tan"
1965
- | "teal"
1966
- | "thistle"
1967
- | "tomato"
1968
- | "turquoise"
1969
- | "violet"
1970
- | "wheat"
1971
- | "white"
1972
- | "whitesmoke"
1973
- | "yellow"
1974
- | "yellowgreen";
1975
- /**
1976
- * ## Color temperature
1977
- *
1978
- * > Color temperature in mireds.
1979
- *
1980
- * ## Selector
1981
- *
1982
- * > ```yaml
1983
- * > color_temp: null
1984
- * > ```
1985
- */
1986
- color_temp?: unknown;
1987
- /**
1988
- * ## Effect
1989
- *
1990
- * > Light effect.
1991
- */
1992
- effect?: string;
1993
- /**
1994
- * ## Flash
1995
- *
1996
- * > Tell light to flash, can be either value short or long.
1997
- */
1998
- flash?: "long" | "short";
1999
- /**
2000
- * ## Hue/Sat color
2001
- *
2002
- * > Color in hue/sat format. A list of two integers. Hue is 0-360 and Sat is 0-100.
2003
- *
2004
- * ### Example
2005
- *
2006
- * > ```json
2007
- * > {
2008
- * > "hs_color": "[300, 70]"
2009
- * > }
2010
- * > ```
2011
- *
2012
- * ## Selector
2013
- *
2014
- * > ```yaml
2015
- * > object: null
2016
- * > ```
2017
- */
2018
- hs_color?: unknown;
2019
- /**
2020
- * ## Color temperature
2021
- *
2022
- * > Color temperature in Kelvin.
2023
- *
2024
- * ## Selector
2025
- *
2026
- * > ```yaml
2027
- * > color_temp:
2028
- * > unit: kelvin
2029
- * > min: 2000
2030
- * > max: 6500
2031
- * > ```
2032
- */
2033
- kelvin?: unknown;
2034
- /**
2035
- * ## Profile
2036
- *
2037
- * > Name of a light profile to use.
2038
- *
2039
- * ### Example
2040
- *
2041
- * > ```json
2042
- * > {
2043
- * > "profile": "relax"
2044
- * > }
2045
- * > ```
2046
- */
2047
- profile?: string;
2048
- /**
2049
- * ## Color
2050
- *
2051
- * > The color in RGB format. A list of three integers between 0 and 255 representing the values of red, green, and blue.
2052
- *
2053
- * ### Example
2054
- *
2055
- * > ```json
2056
- * > {
2057
- * > "rgb_color": "[255, 100, 100]"
2058
- * > }
2059
- * > ```
2060
- *
2061
- * ## Selector
2062
- *
2063
- * > ```yaml
2064
- * > color_rgb: null
2065
- * > ```
2066
- */
2067
- rgb_color?: unknown;
2068
- /**
2069
- * ## Transition
2070
- *
2071
- * > Duration it takes to get to next state.
2072
- *
2073
- * ## Selector
2074
- *
2075
- * > ```yaml
2076
- * > number:
2077
- * > min: 0
2078
- * > max: 300
2079
- * > unit_of_measurement: seconds
2080
- * > ```
2081
- */
2082
- transition?: number;
2083
- /**
2084
- * ## White
2085
- *
2086
- * > Set the light to white mode.
2087
- *
2088
- * ## Selector
2089
- *
2090
- * > ```yaml
2091
- * > constant:
2092
- * > value: true
2093
- * > label: Enabled
2094
- * > ```
2095
- */
2096
- white?: unknown;
2097
- /**
2098
- * ## XY-color
2099
- *
2100
- * > Color in XY-format. A list of two decimal numbers between 0 and 1.
2101
- *
2102
- * ### Example
2103
- *
2104
- * > ```json
2105
- * > {
2106
- * > "xy_color": "[0.52, 0.43]"
2107
- * > }
2108
- * > ```
2109
- *
2110
- * ## Selector
2111
- *
2112
- * > ```yaml
2113
- * > object: null
2114
- * > ```
2115
- */
2116
- xy_color?: unknown;
2117
- /**
2118
- * Assisted definition
2119
- * > ```yaml
2120
- * > entity:
2121
- * > - domain:
2122
- * > - light
2123
- * > ```
2124
- */
2125
- entity_id: PICK_ENTITY<"light"> | PICK_ENTITY<"light">[];
2126
- }): Promise<void>;
2127
- /**
2128
- * ### Turn off
2129
- *
2130
- * > Turn off one or more lights.
2131
- */
2132
- turn_off(service_data?: {
2133
- /**
2134
- * ## Flash
2135
- *
2136
- * > Tell light to flash, can be either value short or long.
2137
- */
2138
- flash?: "long" | "short";
2139
- /**
2140
- * ## Transition
2141
- *
2142
- * > Duration it takes to get to next state.
2143
- *
2144
- * ## Selector
2145
- *
2146
- * > ```yaml
2147
- * > number:
2148
- * > min: 0
2149
- * > max: 300
2150
- * > unit_of_measurement: seconds
2151
- * > ```
2152
- */
2153
- transition?: number;
2154
- /**
2155
- * Assisted definition
2156
- * > ```yaml
2157
- * > entity:
2158
- * > - domain:
2159
- * > - light
2160
- * > ```
2161
- */
2162
- entity_id: PICK_ENTITY<"light"> | PICK_ENTITY<"light">[];
2163
- }): Promise<void>;
2164
- /**
2165
- * ### Turn on
2166
- *
2167
- * > Turn on one or more lights and adjust properties of the light, even when they are turned on already.
2168
- */
2169
- turn_on(service_data?: {
2170
- /**
2171
- * ## Brightness value
2172
- *
2173
- * > Number indicating brightness, where 0 turns the light off, 1 is the minimum brightness, and 255 is the maximum brightness.
2174
- *
2175
- * ## Selector
2176
- *
2177
- * > ```yaml
2178
- * > number:
2179
- * > min: 0
2180
- * > max: 255
2181
- * > ```
2182
- */
2183
- brightness?: number;
2184
- /**
2185
- * ## Brightness
2186
- *
2187
- * > Number indicating the percentage of full brightness, where 0 turns the light off, 1 is the minimum brightness, and 100 is the maximum brightness.
2188
- *
2189
- * ## Selector
2190
- *
2191
- * > ```yaml
2192
- * > number:
2193
- * > min: 0
2194
- * > max: 100
2195
- * > unit_of_measurement: '%'
2196
- * > ```
2197
- */
2198
- brightness_pct?: number;
2199
- /**
2200
- * ## Brightness step value
2201
- *
2202
- * > Change brightness by an amount.
2203
- *
2204
- * ## Selector
2205
- *
2206
- * > ```yaml
2207
- * > number:
2208
- * > min: -225
2209
- * > max: 255
2210
- * > ```
2211
- */
2212
- brightness_step?: number;
2213
- /**
2214
- * ## Brightness step
2215
- *
2216
- * > Change brightness by a percentage.
2217
- *
2218
- * ## Selector
2219
- *
2220
- * > ```yaml
2221
- * > number:
2222
- * > min: -100
2223
- * > max: 100
2224
- * > unit_of_measurement: '%'
2225
- * > ```
2226
- */
2227
- brightness_step_pct?: number;
2228
- /**
2229
- * ## Color name
2230
- *
2231
- * > A human-readable color name.
2232
- */
2233
- color_name?:
2234
- | "homeassistant"
2235
- | "aliceblue"
2236
- | "antiquewhite"
2237
- | "aqua"
2238
- | "aquamarine"
2239
- | "azure"
2240
- | "beige"
2241
- | "bisque"
2242
- | "blanchedalmond"
2243
- | "blue"
2244
- | "blueviolet"
2245
- | "brown"
2246
- | "burlywood"
2247
- | "cadetblue"
2248
- | "chartreuse"
2249
- | "chocolate"
2250
- | "coral"
2251
- | "cornflowerblue"
2252
- | "cornsilk"
2253
- | "crimson"
2254
- | "cyan"
2255
- | "darkblue"
2256
- | "darkcyan"
2257
- | "darkgoldenrod"
2258
- | "darkgray"
2259
- | "darkgreen"
2260
- | "darkgrey"
2261
- | "darkkhaki"
2262
- | "darkmagenta"
2263
- | "darkolivegreen"
2264
- | "darkorange"
2265
- | "darkorchid"
2266
- | "darkred"
2267
- | "darksalmon"
2268
- | "darkseagreen"
2269
- | "darkslateblue"
2270
- | "darkslategray"
2271
- | "darkslategrey"
2272
- | "darkturquoise"
2273
- | "darkviolet"
2274
- | "deeppink"
2275
- | "deepskyblue"
2276
- | "dimgray"
2277
- | "dimgrey"
2278
- | "dodgerblue"
2279
- | "firebrick"
2280
- | "floralwhite"
2281
- | "forestgreen"
2282
- | "fuchsia"
2283
- | "gainsboro"
2284
- | "ghostwhite"
2285
- | "gold"
2286
- | "goldenrod"
2287
- | "gray"
2288
- | "green"
2289
- | "greenyellow"
2290
- | "grey"
2291
- | "honeydew"
2292
- | "hotpink"
2293
- | "indianred"
2294
- | "indigo"
2295
- | "ivory"
2296
- | "khaki"
2297
- | "lavender"
2298
- | "lavenderblush"
2299
- | "lawngreen"
2300
- | "lemonchiffon"
2301
- | "lightblue"
2302
- | "lightcoral"
2303
- | "lightcyan"
2304
- | "lightgoldenrodyellow"
2305
- | "lightgray"
2306
- | "lightgreen"
2307
- | "lightgrey"
2308
- | "lightpink"
2309
- | "lightsalmon"
2310
- | "lightseagreen"
2311
- | "lightskyblue"
2312
- | "lightslategray"
2313
- | "lightslategrey"
2314
- | "lightsteelblue"
2315
- | "lightyellow"
2316
- | "lime"
2317
- | "limegreen"
2318
- | "linen"
2319
- | "magenta"
2320
- | "maroon"
2321
- | "mediumaquamarine"
2322
- | "mediumblue"
2323
- | "mediumorchid"
2324
- | "mediumpurple"
2325
- | "mediumseagreen"
2326
- | "mediumslateblue"
2327
- | "mediumspringgreen"
2328
- | "mediumturquoise"
2329
- | "mediumvioletred"
2330
- | "midnightblue"
2331
- | "mintcream"
2332
- | "mistyrose"
2333
- | "moccasin"
2334
- | "navajowhite"
2335
- | "navy"
2336
- | "navyblue"
2337
- | "oldlace"
2338
- | "olive"
2339
- | "olivedrab"
2340
- | "orange"
2341
- | "orangered"
2342
- | "orchid"
2343
- | "palegoldenrod"
2344
- | "palegreen"
2345
- | "paleturquoise"
2346
- | "palevioletred"
2347
- | "papayawhip"
2348
- | "peachpuff"
2349
- | "peru"
2350
- | "pink"
2351
- | "plum"
2352
- | "powderblue"
2353
- | "purple"
2354
- | "red"
2355
- | "rosybrown"
2356
- | "royalblue"
2357
- | "saddlebrown"
2358
- | "salmon"
2359
- | "sandybrown"
2360
- | "seagreen"
2361
- | "seashell"
2362
- | "sienna"
2363
- | "silver"
2364
- | "skyblue"
2365
- | "slateblue"
2366
- | "slategray"
2367
- | "slategrey"
2368
- | "snow"
2369
- | "springgreen"
2370
- | "steelblue"
2371
- | "tan"
2372
- | "teal"
2373
- | "thistle"
2374
- | "tomato"
2375
- | "turquoise"
2376
- | "violet"
2377
- | "wheat"
2378
- | "white"
2379
- | "whitesmoke"
2380
- | "yellow"
2381
- | "yellowgreen";
2382
- /**
2383
- * ## Color temperature
2384
- *
2385
- * > Color temperature in mireds.
2386
- *
2387
- * ## Selector
2388
- *
2389
- * > ```yaml
2390
- * > color_temp:
2391
- * > unit: mired
2392
- * > min: 153
2393
- * > max: 500
2394
- * > ```
2395
- */
2396
- color_temp?: unknown;
2397
- /**
2398
- * ## Effect
2399
- *
2400
- * > Light effect.
2401
- */
2402
- effect?: string;
2403
- /**
2404
- * ## Flash
2405
- *
2406
- * > Tell light to flash, can be either value short or long.
2407
- */
2408
- flash?: "long" | "short";
2409
- /**
2410
- * ## Hue/Sat color
2411
- *
2412
- * > Color in hue/sat format. A list of two integers. Hue is 0-360 and Sat is 0-100.
2413
- *
2414
- * ### Example
2415
- *
2416
- * > ```json
2417
- * > {
2418
- * > "hs_color": "[300, 70]"
2419
- * > }
2420
- * > ```
2421
- *
2422
- * ## Selector
2423
- *
2424
- * > ```yaml
2425
- * > object: null
2426
- * > ```
2427
- */
2428
- hs_color?: unknown;
2429
- /**
2430
- * ## Color temperature
2431
- *
2432
- * > Color temperature in Kelvin.
2433
- *
2434
- * ## Selector
2435
- *
2436
- * > ```yaml
2437
- * > color_temp:
2438
- * > unit: kelvin
2439
- * > min: 2000
2440
- * > max: 6500
2441
- * > ```
2442
- */
2443
- kelvin?: unknown;
2444
- /**
2445
- * ## Profile
2446
- *
2447
- * > Name of a light profile to use.
2448
- *
2449
- * ### Example
2450
- *
2451
- * > ```json
2452
- * > {
2453
- * > "profile": "relax"
2454
- * > }
2455
- * > ```
2456
- */
2457
- profile?: string;
2458
- /**
2459
- * ## Color
2460
- *
2461
- * > The color in RGB format. A list of three integers between 0 and 255 representing the values of red, green, and blue.
2462
- *
2463
- * ## Selector
2464
- *
2465
- * > ```yaml
2466
- * > color_rgb: null
2467
- * > ```
2468
- */
2469
- rgb_color?: unknown;
2470
- /**
2471
- * ## RGBW-color
2472
- *
2473
- * > The color in RGBW format. A list of four integers between 0 and 255 representing the values of red, green, blue, and white.
2474
- *
2475
- * ### Example
2476
- *
2477
- * > ```json
2478
- * > {
2479
- * > "rgbw_color": "[255, 100, 100, 50]"
2480
- * > }
2481
- * > ```
2482
- *
2483
- * ## Selector
2484
- *
2485
- * > ```yaml
2486
- * > object: null
2487
- * > ```
2488
- */
2489
- rgbw_color?: unknown;
2490
- /**
2491
- * ## RGBWW-color
2492
- *
2493
- * > The color in RGBWW format. A list of five integers between 0 and 255 representing the values of red, green, blue, cold white, and warm white.
2494
- *
2495
- * ### Example
2496
- *
2497
- * > ```json
2498
- * > {
2499
- * > "rgbww_color": "[255, 100, 100, 50, 70]"
2500
- * > }
2501
- * > ```
2502
- *
2503
- * ## Selector
2504
- *
2505
- * > ```yaml
2506
- * > object: null
2507
- * > ```
2508
- */
2509
- rgbww_color?: unknown;
2510
- /**
2511
- * ## Transition
2512
- *
2513
- * > Duration it takes to get to next state.
2514
- *
2515
- * ## Selector
2516
- *
2517
- * > ```yaml
2518
- * > number:
2519
- * > min: 0
2520
- * > max: 300
2521
- * > unit_of_measurement: seconds
2522
- * > ```
2523
- */
2524
- transition?: number;
2525
- /**
2526
- * ## White
2527
- *
2528
- * > Set the light to white mode.
2529
- *
2530
- * ## Selector
2531
- *
2532
- * > ```yaml
2533
- * > constant:
2534
- * > value: true
2535
- * > label: Enabled
2536
- * > ```
2537
- */
2538
- white?: unknown;
2539
- /**
2540
- * ## XY-color
2541
- *
2542
- * > Color in XY-format. A list of two decimal numbers between 0 and 1.
2543
- *
2544
- * ### Example
2545
- *
2546
- * > ```json
2547
- * > {
2548
- * > "xy_color": "[0.52, 0.43]"
2549
- * > }
2550
- * > ```
2551
- *
2552
- * ## Selector
2553
- *
2554
- * > ```yaml
2555
- * > object: null
2556
- * > ```
2557
- */
2558
- xy_color?: unknown;
2559
- /**
2560
- * Assisted definition
2561
- * > ```yaml
2562
- * > entity:
2563
- * > - domain:
2564
- * > - light
2565
- * > ```
2566
- */
2567
- entity_id: PICK_ENTITY<"light"> | PICK_ENTITY<"light">[];
2568
- }): Promise<void>;
2569
- };
2570
- // # MARK: input_text
2571
- input_text: {
2572
- /**
2573
- * ### Reload
2574
- *
2575
- * > Reloads helpers from the YAML-configuration.
2576
- */
2577
- reload(service_data: {}): Promise<void>;
2578
- /**
2579
- * ### Set
2580
- *
2581
- * > Sets the value.
2582
- */
2583
- set_value(service_data: {
2584
- /**
2585
- * ## Value
2586
- *
2587
- * > The target value.
2588
- *
2589
- * ### Example
2590
- *
2591
- * > ```json
2592
- * > {
2593
- * > "value": "This is an example text"
2594
- * > }
2595
- * > ```
2596
- */
2597
- value: string;
2598
- /**
2599
- * Assisted definition
2600
- * > ```yaml
2601
- * > entity:
2602
- * > - domain:
2603
- * > - input_text
2604
- * > ```
2605
- */
2606
- entity_id: PICK_ENTITY<"input_text"> | PICK_ENTITY<"input_text">[];
2607
- }): Promise<void>;
2608
- };
2609
- // # MARK: logbook
2610
- logbook: {
2611
- /**
2612
- * ### Log
2613
- *
2614
- * > Creates a custom entry in the logbook.
2615
- */
2616
- log(service_data?: {
2617
- /**
2618
- * ## Domain
2619
- *
2620
- * > Determines which icon is used in the logbook entry. The icon illustrates the integration domain related to this logbook entry.
2621
- *
2622
- * ### Example
2623
- *
2624
- * > ```json
2625
- * > {
2626
- * > "domain": "light"
2627
- * > }
2628
- * > ```
2629
- */
2630
- domain?: string;
2631
- /**
2632
- * ## Entity ID
2633
- *
2634
- * > Entity to reference in the logbook entry.
2635
- *
2636
- * ## Selector
2637
- *
2638
- * > ```yaml
2639
- * > entity: null
2640
- * > ```
2641
- */
2642
- entity_id?: PICK_ENTITY | PICK_ENTITY[];
2643
- /**
2644
- * ## Message
2645
- *
2646
- * > Message of the logbook entry.
2647
- *
2648
- * ### Example
2649
- *
2650
- * > ```json
2651
- * > {
2652
- * > "message": "is being used"
2653
- * > }
2654
- * > ```
2655
- */
2656
- message: string;
2657
- /**
2658
- * ## Name
2659
- *
2660
- * > Custom name for an entity, can be referenced using an `entity_id`.
2661
- *
2662
- * ### Example
2663
- *
2664
- * > ```json
2665
- * > {
2666
- * > "name": "Kitchen"
2667
- * > }
2668
- * > ```
2669
- */
2670
- name: string;
2671
- }): Promise<void>;
2672
- };
2673
- // # MARK: logger
2674
- logger: {
2675
- /**
2676
- * ### Set default level
2677
- *
2678
- * > Sets the default log level for integrations.
2679
- */
2680
- set_default_level(service_data?: {
2681
- /**
2682
- * ## Level
2683
- *
2684
- * > Default severity level for all integrations.
2685
- */
2686
- level?: "debug" | "info" | "warning" | "error" | "fatal" | "critical";
2687
- }): Promise<void>;
2688
- /**
2689
- * ### Set level
2690
- *
2691
- * > Sets the log level for one or more integrations.
2692
- */
2693
- set_level(service_data: {}): Promise<void>;
2694
- };
2695
- // # MARK: button
2696
- button: {
2697
- /**
2698
- * ### Press
2699
- *
2700
- * > Press the button entity.
2701
- */
2702
- press(service_data: {
2703
- /**
2704
- * Assisted definition
2705
- * > ```yaml
2706
- * > entity:
2707
- * > - domain:
2708
- * > - button
2709
- * > ```
2710
- */
2711
- entity_id: PICK_ENTITY<"button"> | PICK_ENTITY<"button">[];
2712
- }): Promise<void>;
2713
- };
2714
- // # MARK: notify
2715
- notify: {
2716
- /**
2717
- * ### Send a notification with notify
2718
- *
2719
- * > Sends a notification message using the notify service.
2720
- */
2721
- notify(service_data?: {
2722
- /**
2723
- * ## data
2724
- *
2725
- * ### Example
2726
- *
2727
- * > ```json
2728
- * > {
2729
- * > "data": "platform specific"
2730
- * > }
2731
- * > ```
2732
- *
2733
- * ## Selector
2734
- *
2735
- * > ```yaml
2736
- * > object: null
2737
- * > ```
2738
- */
2739
- data?: NotificationData & (AndroidNotificationData | AppleNotificationData);
2740
- /**
2741
- * ## message
2742
- *
2743
- * ### Example
2744
- *
2745
- * > ```json
2746
- * > {
2747
- * > "message": "The garage door has been open for 10 minutes."
2748
- * > }
2749
- * > ```
2750
- */
2751
- message: string;
2752
- /**
2753
- * ## target
2754
- *
2755
- * ### Example
2756
- *
2757
- * > ```json
2758
- * > {
2759
- * > "target": "platform specific"
2760
- * > }
2761
- * > ```
2762
- *
2763
- * ## Selector
2764
- *
2765
- * > ```yaml
2766
- * > object: null
2767
- * > ```
2768
- */
2769
- target?: unknown;
2770
- /**
2771
- * ## title
2772
- *
2773
- * ### Example
2774
- *
2775
- * > ```json
2776
- * > {
2777
- * > "title": "Your Garage Door Friend"
2778
- * > }
2779
- * > ```
2780
- */
2781
- title?: string;
2782
- }): Promise<void>;
2783
- /**
2784
- * ### Send a persistent notification
2785
- *
2786
- * > Sends a notification that is visible in the **Notifications** panel.
2787
- */
2788
- persistent_notification(service_data?: {
2789
- /**
2790
- * ## Data
2791
- *
2792
- * > Some integrations provide extended functionality. For information on how to use _data_, refer to the integration documentation..
2793
- *
2794
- * ### Example
2795
- *
2796
- * > ```json
2797
- * > {
2798
- * > "data": "platform specific"
2799
- * > }
2800
- * > ```
2801
- *
2802
- * ## Selector
2803
- *
2804
- * > ```yaml
2805
- * > object: null
2806
- * > ```
2807
- */
2808
- data?: NotificationData & (AndroidNotificationData | AppleNotificationData);
2809
- /**
2810
- * ## Message
2811
- *
2812
- * > Message body of the notification.
2813
- *
2814
- * ### Example
2815
- *
2816
- * > ```json
2817
- * > {
2818
- * > "message": "The garage door has been open for 10 minutes."
2819
- * > }
2820
- * > ```
2821
- */
2822
- message: string;
2823
- /**
2824
- * ## Title
2825
- *
2826
- * > Title of the notification.
2827
- *
2828
- * ### Example
2829
- *
2830
- * > ```json
2831
- * > {
2832
- * > "title": "Your Garage Door Friend"
2833
- * > }
2834
- * > ```
2835
- */
2836
- title?: string;
2837
- }): Promise<void>;
2838
- };
2839
- // # MARK: persistent_notification
2840
- persistent_notification: {
2841
- /**
2842
- * ### Create
2843
- *
2844
- * > Shows a notification on the **Notifications** panel.
2845
- */
2846
- create(service_data?: {
2847
- /**
2848
- * ## Message
2849
- *
2850
- * > Message body of the notification.
2851
- *
2852
- * ### Example
2853
- *
2854
- * > ```json
2855
- * > {
2856
- * > "message": "Please check your configuration.yaml."
2857
- * > }
2858
- * > ```
2859
- */
2860
- message: string;
2861
- /**
2862
- * ## Notification ID
2863
- *
2864
- * > ID of the notification. This new notification will overwrite an existing notification with the same ID.
2865
- *
2866
- * ### Example
2867
- *
2868
- * > ```json
2869
- * > {
2870
- * > "notification_id": "1234"
2871
- * > }
2872
- * > ```
2873
- */
2874
- notification_id?: string;
2875
- /**
2876
- * ## Title
2877
- *
2878
- * > Optional title of the notification.
2879
- *
2880
- * ### Example
2881
- *
2882
- * > ```json
2883
- * > {
2884
- * > "title": "Test notification"
2885
- * > }
2886
- * > ```
2887
- */
2888
- title?: string;
2889
- }): Promise<void>;
2890
- /**
2891
- * ### Dismiss
2892
- *
2893
- * > Removes a notification from the **Notifications** panel.
2894
- */
2895
- dismiss(service_data: {
2896
- /**
2897
- * ## Notification ID
2898
- *
2899
- * > ID of the notification to be removed.
2900
- *
2901
- * ### Example
2902
- *
2903
- * > ```json
2904
- * > {
2905
- * > "notification_id": "1234"
2906
- * > }
2907
- * > ```
2908
- */
2909
- notification_id: string;
2910
- }): Promise<void>;
2911
- /**
2912
- * ### Dismiss all
2913
- *
2914
- * > Removes all notifications from the **Notifications** panel.
2915
- */
2916
- dismiss_all(service_data: {}): Promise<void>;
2917
- };
2918
- // # MARK: person
2919
- person: {
2920
- /**
2921
- * ### Reload
2922
- *
2923
- * > Reloads persons from the YAML-configuration.
2924
- */
2925
- reload(service_data: {}): Promise<void>;
2926
- };
2927
- // # MARK: recorder
2928
- recorder: {
2929
- /**
2930
- * ### Disable
2931
- *
2932
- * > Stops the recording of events and state changes.
2933
- */
2934
- disable(service_data: {}): Promise<void>;
2935
- /**
2936
- * ### Enable
2937
- *
2938
- * > Starts the recording of events and state changes.
2939
- */
2940
- enable(service_data: {}): Promise<void>;
2941
- /**
2942
- * ### Purge
2943
- *
2944
- * > Starts purge task - to clean up old data from your database.
2945
- */
2946
- purge(service_data?: {
2947
- /**
2948
- * ## Apply filter
2949
- *
2950
- * > Apply `entity_id` and `event_type` filters in addition to time-based purge.
2951
- *
2952
- * ### Default
2953
- *
2954
- * > ```json
2955
- * > false
2956
- * > ```
2957
- */
2958
- apply_filter?: boolean;
2959
- /**
2960
- * ## Days to keep
2961
- *
2962
- * > Number of days to keep the data in the database. Starting today, counting backward. A value of `7` means that everything older than a week will be purged.
2963
- *
2964
- * ## Selector
2965
- *
2966
- * > ```yaml
2967
- * > number:
2968
- * > min: 0
2969
- * > max: 365
2970
- * > unit_of_measurement: days
2971
- * > ```
2972
- */
2973
- keep_days?: number;
2974
- /**
2975
- * ## Repack
2976
- *
2977
- * > Attempt to save disk space by rewriting the entire database file.
2978
- *
2979
- * ### Default
2980
- *
2981
- * > ```json
2982
- * > false
2983
- * > ```
2984
- */
2985
- repack?: boolean;
2986
- }): Promise<void>;
2987
- /**
2988
- * ### Purge entities
2989
- *
2990
- * > Starts a purge task to remove the data related to specific entities from your database.
2991
- */
2992
- purge_entities(service_data?: {
2993
- /**
2994
- * ## Domains to remove
2995
- *
2996
- * > List of domains for which the data needs to be removed from the recorder database.
2997
- *
2998
- * ### Example
2999
- *
3000
- * > ```json
3001
- * > {
3002
- * > "domains": "sun"
3003
- * > }
3004
- * > ```
3005
- *
3006
- * ### Default
3007
- *
3008
- * > ```json
3009
- * > []
3010
- * > ```
3011
- *
3012
- * ## Selector
3013
- *
3014
- * > ```yaml
3015
- * > object: null
3016
- * > ```
3017
- */
3018
- domains?: unknown;
3019
- /**
3020
- * ## Entity globs to remove
3021
- *
3022
- * > List of glob patterns used to select the entities for which the data is to be removed from the recorder database.
3023
- *
3024
- * ### Example
3025
- *
3026
- * > ```json
3027
- * > {
3028
- * > "entity_globs": "domain*.object_id*"
3029
- * > }
3030
- * > ```
3031
- *
3032
- * ### Default
3033
- *
3034
- * > ```json
3035
- * > []
3036
- * > ```
3037
- *
3038
- * ## Selector
3039
- *
3040
- * > ```yaml
3041
- * > object: null
3042
- * > ```
3043
- */
3044
- entity_globs?: unknown;
3045
- /**
3046
- * ## Days to keep
3047
- *
3048
- * > Number of days to keep the data for rows matching the filter. Starting today, counting backward. A value of `7` means that everything older than a week will be purged. The default of 0 days will remove all matching rows immediately.
3049
- *
3050
- * ### Default
3051
- *
3052
- * > ```json
3053
- * > 0
3054
- * > ```
3055
- *
3056
- * ## Selector
3057
- *
3058
- * > ```yaml
3059
- * > number:
3060
- * > min: 0
3061
- * > max: 365
3062
- * > unit_of_measurement: days
3063
- * > ```
3064
- */
3065
- keep_days?: number;
3066
- /**
3067
- * Assisted definition
3068
- * > ```yaml
3069
- * > entity:
3070
- * > - {}
3071
- * > ```
3072
- */
3073
- entity_id: PICK_ENTITY | PICK_ENTITY[];
3074
- }): Promise<void>;
3075
- };
3076
- // # MARK: scene
3077
- scene: {
3078
- /**
3079
- * ### Apply
3080
- *
3081
- * > Activates a scene with configuration.
3082
- */
3083
- apply(service_data?: {
3084
- /**
3085
- * ## Entities state
3086
- *
3087
- * > List of entities and their target state.
3088
- *
3089
- * ### Example
3090
- *
3091
- * > ```json
3092
- * > {
3093
- * > "entities": "light.kitchen: \"on\"\nlight.ceiling:\n state: \"on\"\n brightness: 80\n"
3094
- * > }
3095
- * > ```
3096
- *
3097
- * ## Selector
3098
- *
3099
- * > ```yaml
3100
- * > object: null
3101
- * > ```
3102
- */
3103
- entities: unknown;
3104
- /**
3105
- * ## Transition
3106
- *
3107
- * > Time it takes the devices to transition into the states defined in the scene.
3108
- *
3109
- * ## Selector
3110
- *
3111
- * > ```yaml
3112
- * > number:
3113
- * > min: 0
3114
- * > max: 300
3115
- * > unit_of_measurement: seconds
3116
- * > ```
3117
- */
3118
- transition?: number;
3119
- }): Promise<void>;
3120
- /**
3121
- * ### Create
3122
- *
3123
- * > Creates a new scene.
3124
- */
3125
- create(service_data?: {
3126
- /**
3127
- * ## Entities state
3128
- *
3129
- * > List of entities and their target state. If your entities are already in the target state right now, use `snapshot_entities` instead.
3130
- *
3131
- * ### Example
3132
- *
3133
- * > ```json
3134
- * > {
3135
- * > "entities": "light.tv_back_light: \"on\"\nlight.ceiling:\n state: \"on\"\n brightness: 200\n"
3136
- * > }
3137
- * > ```
3138
- *
3139
- * ## Selector
3140
- *
3141
- * > ```yaml
3142
- * > object: null
3143
- * > ```
3144
- */
3145
- entities?: unknown;
3146
- /**
3147
- * ## Scene entity ID
3148
- *
3149
- * > The entity ID of the new scene.
3150
- *
3151
- * ### Example
3152
- *
3153
- * > ```json
3154
- * > {
3155
- * > "scene_id": "all_lights"
3156
- * > }
3157
- * > ```
3158
- */
3159
- scene_id: string;
3160
- /**
3161
- * ## Snapshot entities
3162
- *
3163
- * > List of entities to be included in the snapshot. By taking a snapshot, you record the current state of those entities. If you do not want to use the current state of all your entities for this scene, you can combine the `snapshot_entities` with `entities`.
3164
- *
3165
- * ### Example
3166
- *
3167
- * > ```json
3168
- * > {
3169
- * > "snapshot_entities": "- light.ceiling\n- light.kitchen\n"
3170
- * > }
3171
- * > ```
3172
- */
3173
- snapshot_entities?: PICK_ENTITY | PICK_ENTITY[];
3174
- }): Promise<void>;
3175
- /**
3176
- * ### Delete
3177
- *
3178
- * > Deletes a dynamically created scene.
3179
- */
3180
- delete(service_data: {
3181
- /**
3182
- * Assisted definition
3183
- * > ```yaml
3184
- * > entity:
3185
- * > - integration: homeassistant
3186
- * > domain:
3187
- * > - scene
3188
- * > ```
3189
- */
3190
- entity_id:
3191
- | PICK_FROM_PLATFORM<"homeassistant", "scene">
3192
- | PICK_FROM_PLATFORM<"homeassistant", "scene">[];
3193
- }): Promise<void>;
3194
- /**
3195
- * ### Reload
3196
- *
3197
- * > Reloads the scenes from the YAML-configuration.
3198
- */
3199
- reload(service_data: {}): Promise<void>;
3200
- /**
3201
- * ### Activate
3202
- *
3203
- * > Activates a scene.
3204
- */
3205
- turn_on(service_data?: {
3206
- /**
3207
- * ## Transition
3208
- *
3209
- * > Time it takes the devices to transition into the states defined in the scene.
3210
- *
3211
- * ## Selector
3212
- *
3213
- * > ```yaml
3214
- * > number:
3215
- * > min: 0
3216
- * > max: 300
3217
- * > unit_of_measurement: seconds
3218
- * > ```
3219
- */
3220
- transition?: number;
3221
- /**
3222
- * Assisted definition
3223
- * > ```yaml
3224
- * > entity:
3225
- * > - domain:
3226
- * > - scene
3227
- * > ```
3228
- */
3229
- entity_id: PICK_ENTITY<"scene"> | PICK_ENTITY<"scene">[];
3230
- }): Promise<void>;
3231
- };
3232
- // # MARK: schedule
3233
- schedule: {
3234
- /**
3235
- * ### Reload
3236
- *
3237
- * > Reloads schedules from the YAML-configuration.
3238
- */
3239
- reload(service_data: {}): Promise<void>;
3240
- };
3241
- // # MARK: script
3242
- script: {
3243
- /**
3244
- * ### Reload
3245
- *
3246
- * > Reloads all the available scripts.
3247
- */
3248
- reload(service_data: {}): Promise<void>;
3249
- /**
3250
- * ### Toggle
3251
- *
3252
- * > Toggle a script. Starts it, if isn't running, stops it otherwise.
3253
- */
3254
- toggle(service_data: {
3255
- /**
3256
- * Assisted definition
3257
- * > ```yaml
3258
- * > entity:
3259
- * > - domain:
3260
- * > - script
3261
- * > ```
3262
- */
3263
- entity_id: PICK_ENTITY<"script"> | PICK_ENTITY<"script">[];
3264
- }): Promise<void>;
3265
- /**
3266
- * ### Turn off
3267
- *
3268
- * > Stops a running script.
3269
- */
3270
- turn_off(service_data: {
3271
- /**
3272
- * Assisted definition
3273
- * > ```yaml
3274
- * > entity:
3275
- * > - domain:
3276
- * > - script
3277
- * > ```
3278
- */
3279
- entity_id: PICK_ENTITY<"script"> | PICK_ENTITY<"script">[];
3280
- }): Promise<void>;
3281
- /**
3282
- * ### Turn on
3283
- *
3284
- * > Runs the sequence of actions defined in a script.
3285
- */
3286
- turn_on(service_data: {
3287
- /**
3288
- * Assisted definition
3289
- * > ```yaml
3290
- * > entity:
3291
- * > - domain:
3292
- * > - script
3293
- * > ```
3294
- */
3295
- entity_id: PICK_ENTITY<"script"> | PICK_ENTITY<"script">[];
3296
- }): Promise<void>;
3297
- };
3298
- // # MARK: shopping_list
3299
- shopping_list: {
3300
- /**
3301
- * ### Add item
3302
- *
3303
- * > Adds an item to the shopping list.
3304
- */
3305
- add_item(service_data: {
3306
- /**
3307
- * ## Name
3308
- *
3309
- * > The name of the item to add.
3310
- *
3311
- * ### Example
3312
- *
3313
- * > ```json
3314
- * > {
3315
- * > "name": "Beer"
3316
- * > }
3317
- * > ```
3318
- */
3319
- name: string;
3320
- }): Promise<void>;
3321
- /**
3322
- * ### Clear completed items
3323
- *
3324
- * > Clears completed items from the shopping list.
3325
- */
3326
- clear_completed_items(service_data: {}): Promise<void>;
3327
- /**
3328
- * ### Complete all
3329
- *
3330
- * > Marks all items as completed in the shopping list (without removing them from the list).
3331
- */
3332
- complete_all(service_data: {}): Promise<void>;
3333
- /**
3334
- * ### Complete item
3335
- *
3336
- * > Marks the first item with matching name as completed in the shopping list.
3337
- */
3338
- complete_item(service_data: {
3339
- /**
3340
- * ## Name
3341
- *
3342
- * > The name of the item to mark as completed (without removing).
3343
- *
3344
- * ### Example
3345
- *
3346
- * > ```json
3347
- * > {
3348
- * > "name": "Beer"
3349
- * > }
3350
- * > ```
3351
- */
3352
- name: string;
3353
- }): Promise<void>;
3354
- /**
3355
- * ### Incomplete all
3356
- *
3357
- * > Marks all items as incomplete in the shopping list.
3358
- */
3359
- incomplete_all(service_data: {}): Promise<void>;
3360
- /**
3361
- * ### Incomplete item
3362
- *
3363
- * > Marks the first item with matching name as incomplete in the shopping list.
3364
- */
3365
- incomplete_item(service_data: {
3366
- /**
3367
- * ## Name
3368
- *
3369
- * > The name of the item to mark as incomplete.
3370
- *
3371
- * ### Example
3372
- *
3373
- * > ```json
3374
- * > {
3375
- * > "name": "Beer"
3376
- * > }
3377
- * > ```
3378
- */
3379
- name: string;
3380
- }): Promise<void>;
3381
- /**
3382
- * ### Remove item
3383
- *
3384
- * > Removes the first item with matching name from the shopping list.
3385
- */
3386
- remove_item(service_data: {
3387
- /**
3388
- * ## Name
3389
- *
3390
- * > The name of the item to remove.
3391
- *
3392
- * ### Example
3393
- *
3394
- * > ```json
3395
- * > {
3396
- * > "name": "Beer"
3397
- * > }
3398
- * > ```
3399
- */
3400
- name: string;
3401
- }): Promise<void>;
3402
- /**
3403
- * ### Sort all items
3404
- *
3405
- * > Sorts all items by name in the shopping list.
3406
- */
3407
- sort(service_data?: {
3408
- /**
3409
- * ## Sort reverse
3410
- *
3411
- * > Whether to sort in reverse (descending) order.
3412
- *
3413
- * ### Default
3414
- *
3415
- * > ```json
3416
- * > false
3417
- * > ```
3418
- */
3419
- reverse?: boolean;
3420
- }): Promise<void>;
3421
- };
3422
- // # MARK: switch
3423
- switch: {
3424
- /**
3425
- * ### Toggle
3426
- *
3427
- * > Toggles a switch on/off.
3428
- */
3429
- toggle(service_data: {
3430
- /**
3431
- * Assisted definition
3432
- * > ```yaml
3433
- * > entity:
3434
- * > - domain:
3435
- * > - switch
3436
- * > ```
3437
- */
3438
- entity_id: PICK_ENTITY<"switch"> | PICK_ENTITY<"switch">[];
3439
- }): Promise<void>;
3440
- /**
3441
- * ### Turn off
3442
- *
3443
- * > Turns a switch off.
3444
- */
3445
- turn_off(service_data: {
3446
- /**
3447
- * Assisted definition
3448
- * > ```yaml
3449
- * > entity:
3450
- * > - domain:
3451
- * > - switch
3452
- * > ```
3453
- */
3454
- entity_id: PICK_ENTITY<"switch"> | PICK_ENTITY<"switch">[];
3455
- }): Promise<void>;
3456
- /**
3457
- * ### Turn on
3458
- *
3459
- * > Turns a switch on.
3460
- */
3461
- turn_on(service_data: {
3462
- /**
3463
- * Assisted definition
3464
- * > ```yaml
3465
- * > entity:
3466
- * > - domain:
3467
- * > - switch
3468
- * > ```
3469
- */
3470
- entity_id: PICK_ENTITY<"switch"> | PICK_ENTITY<"switch">[];
3471
- }): Promise<void>;
3472
- };
3473
- // # MARK: synapse
3474
- synapse: {
3475
- /**
3476
- * ### reload
3477
- *
3478
- * > Ask synapse application to re-send the entity list. Sent to all connected by default
3479
- */
3480
- reload(service_data?: {
3481
- /**
3482
- * ## app
3483
- *
3484
- * > The name of the app to target for the reload. If omitted, targets all apps.
3485
- *
3486
- * ### Example
3487
- *
3488
- * > ```json
3489
- * > {
3490
- * > "app": "home_automation"
3491
- * > }
3492
- * > ```
3493
- *
3494
- * ## Selector
3495
- *
3496
- * > ```yaml
3497
- * >
3498
- * > ```
3499
- */
3500
- app?: unknown;
3501
- }): Promise<void>;
3502
- };
3503
- // # MARK: system_log
3504
- system_log: {
3505
- /**
3506
- * ### Clear all
3507
- *
3508
- * > Clears all log entries.
3509
- */
3510
- clear(service_data: {}): Promise<void>;
3511
- /**
3512
- * ### Write
3513
- *
3514
- * > Write log entry.
3515
- */
3516
- write(service_data?: {
3517
- /**
3518
- * ## Level
3519
- *
3520
- * > Log level.
3521
- *
3522
- * ### Default
3523
- *
3524
- * > ```json
3525
- * > "error"
3526
- * > ```
3527
- */
3528
- level?: "debug" | "info" | "warning" | "error" | "critical";
3529
- /**
3530
- * ## Logger
3531
- *
3532
- * > Logger name under which to log the message. Defaults to `system_log.external`.
3533
- *
3534
- * ### Example
3535
- *
3536
- * > ```json
3537
- * > {
3538
- * > "logger": "mycomponent.myplatform"
3539
- * > }
3540
- * > ```
3541
- */
3542
- logger?: string;
3543
- /**
3544
- * ## Message
3545
- *
3546
- * > Message to log.
3547
- *
3548
- * ### Example
3549
- *
3550
- * > ```json
3551
- * > {
3552
- * > "message": "Something went wrong"
3553
- * > }
3554
- * > ```
3555
- */
3556
- message: string;
3557
- }): Promise<void>;
3558
- };
3559
- // # MARK: timer
3560
- timer: {
3561
- /**
3562
- * ### Cancel
3563
- *
3564
- * > Cancels a timer.
3565
- */
3566
- cancel(service_data: {
3567
- /**
3568
- * Assisted definition
3569
- * > ```yaml
3570
- * > entity:
3571
- * > - domain:
3572
- * > - timer
3573
- * > ```
3574
- */
3575
- entity_id: PICK_ENTITY<"timer"> | PICK_ENTITY<"timer">[];
3576
- }): Promise<void>;
3577
- /**
3578
- * ### Change
3579
- *
3580
- * > Changes a timer.
3581
- */
3582
- change(service_data: {
3583
- /**
3584
- * ## Duration
3585
- *
3586
- * > Duration to add or subtract to the running timer.
3587
- *
3588
- * ### Example
3589
- *
3590
- * > ```json
3591
- * > {
3592
- * > "duration": "00:01:00, 60 or -60"
3593
- * > }
3594
- * > ```
3595
- *
3596
- * ### Default
3597
- *
3598
- * > ```json
3599
- * > 0
3600
- * > ```
3601
- */
3602
- duration: string;
3603
- /**
3604
- * Assisted definition
3605
- * > ```yaml
3606
- * > entity:
3607
- * > - domain:
3608
- * > - timer
3609
- * > ```
3610
- */
3611
- entity_id: PICK_ENTITY<"timer"> | PICK_ENTITY<"timer">[];
3612
- }): Promise<void>;
3613
- /**
3614
- * ### Finish
3615
- *
3616
- * > Finishes a timer.
3617
- */
3618
- finish(service_data: {
3619
- /**
3620
- * Assisted definition
3621
- * > ```yaml
3622
- * > entity:
3623
- * > - domain:
3624
- * > - timer
3625
- * > ```
3626
- */
3627
- entity_id: PICK_ENTITY<"timer"> | PICK_ENTITY<"timer">[];
3628
- }): Promise<void>;
3629
- /**
3630
- * ### Pause
3631
- *
3632
- * > Pauses a timer.
3633
- */
3634
- pause(service_data: {
3635
- /**
3636
- * Assisted definition
3637
- * > ```yaml
3638
- * > entity:
3639
- * > - domain:
3640
- * > - timer
3641
- * > ```
3642
- */
3643
- entity_id: PICK_ENTITY<"timer"> | PICK_ENTITY<"timer">[];
3644
- }): Promise<void>;
3645
- /**
3646
- * ### Reload
3647
- *
3648
- * > Reloads timers from the YAML-configuration.
3649
- */
3650
- reload(service_data: {}): Promise<void>;
3651
- /**
3652
- * ### Start
3653
- *
3654
- * > Starts a timer.
3655
- */
3656
- start(service_data?: {
3657
- /**
3658
- * ## Duration
3659
- *
3660
- * > Duration the timer requires to finish. [optional].
3661
- *
3662
- * ### Example
3663
- *
3664
- * > ```json
3665
- * > {
3666
- * > "duration": "00:01:00 or 60"
3667
- * > }
3668
- * > ```
3669
- */
3670
- duration?: string;
3671
- /**
3672
- * Assisted definition
3673
- * > ```yaml
3674
- * > entity:
3675
- * > - domain:
3676
- * > - timer
3677
- * > ```
3678
- */
3679
- entity_id: PICK_ENTITY<"timer"> | PICK_ENTITY<"timer">[];
3680
- }): Promise<void>;
3681
- };
3682
- // # MARK: todo
3683
- todo: {
3684
- /**
3685
- * ### Add to-do list item
3686
- *
3687
- * > Add a new to-do list item.
3688
- */
3689
- add_item(service_data?: {
3690
- /**
3691
- * ## Description
3692
- *
3693
- * > A more complete description of the to-do item than provided by the item name.
3694
- *
3695
- * ### Example
3696
- *
3697
- * > ```json
3698
- * > {
3699
- * > "description": "A more complete description of the to-do item than that provided by the summary."
3700
- * > }
3701
- * > ```
3702
- */
3703
- description?: string;
3704
- /**
3705
- * ## Due date
3706
- *
3707
- * > The date the to-do item is expected to be completed.
3708
- *
3709
- * ### Example
3710
- *
3711
- * > ```json
3712
- * > {
3713
- * > "due_date": "2023-11-17"
3714
- * > }
3715
- * > ```
3716
- *
3717
- * ## Selector
3718
- *
3719
- * > ```yaml
3720
- * > date: null
3721
- * > ```
3722
- */
3723
- due_date?: unknown;
3724
- /**
3725
- * ## Due date and time
3726
- *
3727
- * > The date and time the to-do item is expected to be completed.
3728
- *
3729
- * ### Example
3730
- *
3731
- * > ```json
3732
- * > {
3733
- * > "due_datetime": "2023-11-17 13:30:00"
3734
- * > }
3735
- * > ```
3736
- *
3737
- * ## Selector
3738
- *
3739
- * > ```yaml
3740
- * > datetime: null
3741
- * > ```
3742
- */
3743
- due_datetime?: unknown;
3744
- /**
3745
- * ## Item name
3746
- *
3747
- * > The name that represents the to-do item.
3748
- *
3749
- * ### Example
3750
- *
3751
- * > ```json
3752
- * > {
3753
- * > "item": "Submit income tax return"
3754
- * > }
3755
- * > ```
3756
- */
3757
- item: string;
3758
- /**
3759
- * Assisted definition
3760
- * > ```yaml
3761
- * > entity:
3762
- * > - domain:
3763
- * > - todo
3764
- * > supported_features:
3765
- * > - 1
3766
- * > ```
3767
- */
3768
- entity_id: PICK_ENTITY<"todo"> | PICK_ENTITY<"todo">[];
3769
- }): Promise<void>;
3770
- /**
3771
- * ### Get to-do list items
3772
- *
3773
- * > Get items on a to-do list.
3774
- */
3775
- get_items(service_data?: {
3776
- /**
3777
- * ## Status
3778
- *
3779
- * > Only return to-do items with the specified statuses. Returns not completed actions by default.
3780
- *
3781
- * ### Example
3782
- *
3783
- * > ```json
3784
- * > {
3785
- * > "status": "needs_action"
3786
- * > }
3787
- * > ```
3788
- *
3789
- * ### Default
3790
- *
3791
- * > ```json
3792
- * > "needs_action"
3793
- * > ```
3794
- */
3795
- status?: "needs_action" | "completed";
3796
- /**
3797
- * Assisted definition
3798
- * > ```yaml
3799
- * > entity:
3800
- * > - domain:
3801
- * > - todo
3802
- * > ```
3803
- */
3804
- entity_id: PICK_ENTITY<"todo"> | PICK_ENTITY<"todo">[];
3805
- }): Promise<void>;
3806
- /**
3807
- * ### Remove all completed to-do list items
3808
- *
3809
- * > Remove all to-do list items that have been completed.
3810
- */
3811
- remove_completed_items(service_data: {
3812
- /**
3813
- * Assisted definition
3814
- * > ```yaml
3815
- * > entity:
3816
- * > - domain:
3817
- * > - todo
3818
- * > supported_features:
3819
- * > - 2
3820
- * > ```
3821
- */
3822
- entity_id: PICK_ENTITY<"todo"> | PICK_ENTITY<"todo">[];
3823
- }): Promise<void>;
3824
- /**
3825
- * ### Remove a to-do list item
3826
- *
3827
- * > Remove an existing to-do list item by its name.
3828
- */
3829
- remove_item(service_data: {
3830
- /**
3831
- * ## Item name
3832
- *
3833
- * > The name for the to-do list items.
3834
- */
3835
- item: string;
3836
- /**
3837
- * Assisted definition
3838
- * > ```yaml
3839
- * > entity:
3840
- * > - domain:
3841
- * > - todo
3842
- * > supported_features:
3843
- * > - 2
3844
- * > ```
3845
- */
3846
- entity_id: PICK_ENTITY<"todo"> | PICK_ENTITY<"todo">[];
3847
- }): Promise<void>;
3848
- /**
3849
- * ### Update to-do list item
3850
- *
3851
- * > Update an existing to-do list item based on its name.
3852
- */
3853
- update_item(service_data?: {
3854
- /**
3855
- * ## Description
3856
- *
3857
- * > A more complete description of the to-do item than provided by the item name.
3858
- *
3859
- * ### Example
3860
- *
3861
- * > ```json
3862
- * > {
3863
- * > "description": "A more complete description of the to-do item than that provided by the summary."
3864
- * > }
3865
- * > ```
3866
- */
3867
- description?: string;
3868
- /**
3869
- * ## Due date
3870
- *
3871
- * > The date the to-do item is expected to be completed.
3872
- *
3873
- * ### Example
3874
- *
3875
- * > ```json
3876
- * > {
3877
- * > "due_date": "2023-11-17"
3878
- * > }
3879
- * > ```
3880
- *
3881
- * ## Selector
3882
- *
3883
- * > ```yaml
3884
- * > date: null
3885
- * > ```
3886
- */
3887
- due_date?: unknown;
3888
- /**
3889
- * ## Due date and time
3890
- *
3891
- * > The date and time the to-do item is expected to be completed.
3892
- *
3893
- * ### Example
3894
- *
3895
- * > ```json
3896
- * > {
3897
- * > "due_datetime": "2023-11-17 13:30:00"
3898
- * > }
3899
- * > ```
3900
- *
3901
- * ## Selector
3902
- *
3903
- * > ```yaml
3904
- * > datetime: null
3905
- * > ```
3906
- */
3907
- due_datetime?: unknown;
3908
- /**
3909
- * ## Item name
3910
- *
3911
- * > The name for the to-do list item.
3912
- *
3913
- * ### Example
3914
- *
3915
- * > ```json
3916
- * > {
3917
- * > "item": "Submit income tax return"
3918
- * > }
3919
- * > ```
3920
- */
3921
- item: string;
3922
- /**
3923
- * ## Rename item
3924
- *
3925
- * > The new name of the to-do item
3926
- *
3927
- * ### Example
3928
- *
3929
- * > ```json
3930
- * > {
3931
- * > "rename": "Something else"
3932
- * > }
3933
- * > ```
3934
- */
3935
- rename?: string;
3936
- /**
3937
- * ## Set status
3938
- *
3939
- * > A status or confirmation of the to-do item.
3940
- *
3941
- * ### Example
3942
- *
3943
- * > ```json
3944
- * > {
3945
- * > "status": "needs_action"
3946
- * > }
3947
- * > ```
3948
- */
3949
- status?: "needs_action" | "completed";
3950
- /**
3951
- * Assisted definition
3952
- * > ```yaml
3953
- * > entity:
3954
- * > - domain:
3955
- * > - todo
3956
- * > supported_features:
3957
- * > - 4
3958
- * > ```
3959
- */
3960
- entity_id: PICK_ENTITY<"todo"> | PICK_ENTITY<"todo">[];
3961
- }): Promise<void>;
3962
- };
3963
- // # MARK: tts
3964
- tts: {
3965
- /**
3966
- * ### Clear TTS cache
3967
- *
3968
- * > Removes all cached text-to-speech files and purges the memory.
3969
- */
3970
- clear_cache(service_data: {}): Promise<void>;
3971
- /**
3972
- * ### Say a TTS message with cloud
3973
- *
3974
- * > Say something using text-to-speech on a media player with cloud.
3975
- */
3976
- cloud_say(service_data?: {
3977
- /**
3978
- * ## cache
3979
- *
3980
- * ### Default
3981
- *
3982
- * > ```json
3983
- * > false
3984
- * > ```
3985
- */
3986
- cache?: boolean;
3987
- /**
3988
- * ## entity_id
3989
- */
3990
- entity_id: PICK_ENTITY<"media_player"> | PICK_ENTITY<"media_player">[];
3991
- /**
3992
- * ## language
3993
- *
3994
- * ### Example
3995
- *
3996
- * > ```json
3997
- * > {
3998
- * > "language": "ru"
3999
- * > }
4000
- * > ```
4001
- */
4002
- language?: string;
4003
- /**
4004
- * ## message
4005
- *
4006
- * ### Example
4007
- *
4008
- * > ```json
4009
- * > {
4010
- * > "message": "My name is hanna"
4011
- * > }
4012
- * > ```
4013
- */
4014
- message: string;
4015
- /**
4016
- * ## options
4017
- *
4018
- * ### Example
4019
- *
4020
- * > ```json
4021
- * > {
4022
- * > "options": "platform specific"
4023
- * > }
4024
- * > ```
4025
- *
4026
- * ## Selector
4027
- *
4028
- * > ```yaml
4029
- * > object: null
4030
- * > ```
4031
- */
4032
- options?: unknown;
4033
- }): Promise<void>;
4034
- /**
4035
- * ### Speak
4036
- *
4037
- * > Speaks something using text-to-speech on a media player.
4038
- */
4039
- speak(
4040
- service_data?: {
4041
- /**
4042
- * ## Cache
4043
- *
4044
- * > Stores this message locally so that when the text is requested again, the output can be produced more quickly.
4045
- *
4046
- * ### Default
4047
- *
4048
- * > ```json
4049
- * > true
4050
- * > ```
4051
- */
4052
- cache?: boolean;
4053
- /**
4054
- * ## Language
4055
- *
4056
- * > Language to use for speech generation.
4057
- *
4058
- * ### Example
4059
- *
4060
- * > ```json
4061
- * > {
4062
- * > "language": "ru"
4063
- * > }
4064
- * > ```
4065
- */
4066
- language?: string;
4067
- /**
4068
- * ## Media player entity
4069
- *
4070
- * > Media players to play the message.
4071
- */
4072
- media_player_entity_id: PICK_ENTITY<"media_player"> | PICK_ENTITY<"media_player">[];
4073
- /**
4074
- * ## Message
4075
- *
4076
- * > The text you want to convert into speech so that you can listen to it on your device.
4077
- *
4078
- * ### Example
4079
- *
4080
- * > ```json
4081
- * > {
4082
- * > "message": "My name is hanna"
4083
- * > }
4084
- * > ```
4085
- */
4086
- message: string;
4087
- /**
4088
- * ## Options
4089
- *
4090
- * > A dictionary containing integration-specific options.
4091
- *
4092
- * ### Example
4093
- *
4094
- * > ```json
4095
- * > {
4096
- * > "options": "platform specific"
4097
- * > }
4098
- * > ```
4099
- *
4100
- * ## Selector
4101
- *
4102
- * > ```yaml
4103
- * > object: null
4104
- * > ```
4105
- */
4106
- options?: unknown;
4107
- } & RequireAtLeastOne<{
4108
- /**
4109
- * Assisted definition
4110
- * > ```yaml
4111
- * > entity:
4112
- * > - domain:
4113
- * > - tts
4114
- * > ```
4115
- */
4116
- entity_id: PICK_ENTITY<"tts"> | PICK_ENTITY<"tts">[];
4117
- }>,
4118
- ): Promise<void>;
4119
- };
4120
- // # MARK: zone
4121
- zone: {
4122
- /**
4123
- * ### Reload
4124
- *
4125
- * > Reloads zones from the YAML-configuration.
4126
- */
4127
- reload(service_data: {}): Promise<void>;
4128
- };
4129
- };
4130
-
4131
- // #MARK: REGISTRY_SETUP
4132
- export type REGISTRY_SETUP = {
4133
- area: {
4134
- _test: "switch.living_room_mood_lights";
4135
- _living_room: "switch.living_room_mood_lights";
4136
- _kitchen: "switch.kitchen_cabinets";
4137
- _bedroom: "switch.bedroom_lamp" | "light.bedroom_ceiling_fan";
4138
- };
4139
- platform: {
4140
- _sun:
4141
- | "sensor.sun_next_dawn"
4142
- | "sensor.sun_next_dusk"
4143
- | "sensor.sun_next_midnight"
4144
- | "sensor.sun_next_noon"
4145
- | "sensor.sun_next_rising"
4146
- | "sensor.sun_next_setting"
4147
- | "sensor.sun_solar_elevation"
4148
- | "sensor.sun_solar_azimuth"
4149
- | "sensor.sun_solar_rising";
4150
- _person: "person.digital_alchemy";
4151
- _shopping_list: "todo.shopping_list";
4152
- _google_translate: "tts.google_en_com";
4153
- _synapse:
4154
- | "binary_sensor.hass_e2e_online"
4155
- | "sensor.magic"
4156
- | "button.example"
4157
- | "binary_sensor.toggles"
4158
- | "switch.bedroom_lamp"
4159
- | "switch.kitchen_cabinets"
4160
- | "switch.living_room_mood_lights"
4161
- | "switch.porch_light";
4162
- _holiday: "calendar.united_states_tx";
4163
- };
4164
- label: {
4165
- _synapse:
4166
- | "binary_sensor.hass_e2e_online"
4167
- | "sensor.magic"
4168
- | "binary_sensor.toggles"
4169
- | "switch.bedroom_lamp"
4170
- | "switch.kitchen_cabinets"
4171
- | "switch.living_room_mood_lights"
4172
- | "switch.porch_light";
4173
- _test: never;
4174
- };
4175
- floor: {
4176
- _downstairs: "switch.kitchen_cabinets" | "switch.living_room_mood_lights";
4177
- _upstairs: "switch.bedroom_lamp";
4178
- };
4179
- device: {
4180
- _308e39cf50a9fc6c30b4110724ed1f2e:
4181
- | "sensor.sun_next_dawn"
4182
- | "sensor.sun_next_dusk"
4183
- | "sensor.sun_next_midnight"
4184
- | "sensor.sun_next_noon"
4185
- | "sensor.sun_next_rising"
4186
- | "sensor.sun_next_setting"
4187
- | "button.example"
4188
- | "sensor.sun_solar_elevation"
4189
- | "sensor.sun_solar_azimuth"
4190
- | "sensor.sun_solar_rising";
4191
- _e58841e47cf86097b310316e55d6bb12: "calendar.united_states_tx";
4192
- };
4193
- };
4194
-
4195
- // #MARK: TAreaId
4196
- export type TAreaId = "living_room" | "kitchen" | "bedroom" | "test";
4197
-
4198
- // #MARK: TDeviceId
4199
- export type TDeviceId = "308e39cf50a9fc6c30b4110724ed1f2e" | "e58841e47cf86097b310316e55d6bb12";
4200
-
4201
- // #MARK: TFloorId
4202
- export type TFloorId = "downstairs" | "upstairs";
4203
-
4204
- // #MARK: TLabelId
4205
- export type TLabelId = "synapse" | "test";
4206
-
4207
- // #MARK: TZoneId
4208
- export type TZoneId = string;
4209
-
4210
- // #MARK: TRawEntityIds
4211
- export type TRawEntityIds =
4212
- | "person.digital_alchemy"
4213
- | "zone.home"
4214
- | "sun.sun"
4215
- | "sensor.sun_next_dawn"
4216
- | "sensor.sun_next_dusk"
4217
- | "button.example"
4218
- | "sensor.sun_next_midnight"
4219
- | "sensor.sun_next_noon"
4220
- | "light.bedroom_ceiling_fan"
4221
- | "scene.games_room_auto"
4222
- | "sensor.sun_next_rising"
4223
- | "sensor.sun_next_setting"
4224
- | "todo.shopping_list"
4225
- | "tts.google_en_com"
4226
- | "binary_sensor.hass_e2e_online"
4227
- | "sensor.magic"
4228
- | "binary_sensor.toggles"
4229
- | "switch.bedroom_lamp"
4230
- | "switch.kitchen_cabinets"
4231
- | "switch.living_room_mood_lights"
4232
- | "switch.porch_light"
4233
- | "calendar.united_states_tx";
4234
-
4235
- // #MARK: TPlatformId
4236
- export type TPlatformId =
4237
- | "sun"
4238
- | "person"
4239
- | "shopping_list"
4240
- | "google_translate"
4241
- | "synapse"
4242
- | "holiday";
4243
-
4244
- // #MARK: TRawDomains
4245
- export type TRawDomains =
4246
- | "person"
4247
- | "zone"
4248
- | "sun"
4249
- | "light"
4250
- | "scene"
4251
- | "button"
4252
- | "sensor"
4253
- | "todo"
4254
- | "tts"
4255
- | "binary_sensor"
4256
- | "switch"
4257
- | "calendar";
4258
-
4259
- export type TUniqueIDMapping = {
4260
- "5622d76001a335e3ea893c4d60d31b3d-next_dawn": "sensor.sun_next_dawn";
4261
- "5622d76001a335e3ea893c4d60d31b3d-next_dusk": "sensor.sun_next_dusk";
4262
- "5622d76001a335e3ea893c4d60d31b3d-next_midnight": "sensor.sun_next_midnight";
4263
- "5622d76001a335e3ea893c4d60d31b3d-next_noon": "sensor.sun_next_noon";
4264
- "5622d76001a335e3ea893c4d60d31b3d-next_rising": "sensor.sun_next_rising";
4265
- "5622d76001a335e3ea893c4d60d31b3d-next_setting": "sensor.sun_next_setting";
4266
- "5622d76001a335e3ea893c4d60d31b3d-solar_elevation": "sensor.sun_solar_elevation";
4267
- "6d8acf36200c5ff8d2d9bb1b1f1dbe00c7eb5b7540103fd90c9a035f82967431": "button.start_white_noise";
4268
- "5622d76001a335e3ea893c4d60d31b3d-solar_azimuth": "sensor.sun_solar_azimuth";
4269
- "5622d76001a335e3ea893c4d60d31b3d-solar_rising": "sensor.sun_solar_rising";
4270
- digital_alchemy: "person.digital_alchemy";
4271
- "6acd101923c0460fc31bad82c4efa140": "todo.shopping_list";
4272
- "4a7fc2592d3a98e0eed8cbc73e839c1c": "tts.google_en_com";
4273
- hass_e2e_is_online: "binary_sensor.hass_e2e_online";
4274
- e1806fdc93296bbd5ab42967003cd38729ff9ba6cfeefc3e15a03ad01ac894fe: "sensor.magic";
4275
- a6e8373221727e197144ba689d7606d4be6f609f2fd0fd8e17516548780465ab: "binary_sensor.toggles";
4276
- "413eb6d69bbec134a07a6d32effd3c3763955e611f43256600cca40725276816": "switch.bedroom_lamp";
4277
- "06d5a22e681ee9c668f8563bd3108853fb053c43342131782afe989090c4ced9": "switch.kitchen_cabinets";
4278
- "27b4fc99f35bbdd1a07173caff5b52f86e3bc342db96f48427e47980b0fb6b49": "switch.living_room_mood_lights";
4279
- "8eb8c1f8c760e97cfa49a0a29cd6891313a1e9a45dd046a556a9f317778cf50a": "switch.porch_light";
4280
- "05ecbbc6111791b6baacbbb60397db14": "calendar.united_states_tx";
4281
- };
4282
- export type TUniqueId =
4283
- | "5622d76001a335e3ea893c4d60d31b3d-next_dawn"
4284
- | "5622d76001a335e3ea893c4d60d31b3d-next_dusk"
4285
- | "5622d76001a335e3ea893c4d60d31b3d-next_midnight"
4286
- | "5622d76001a335e3ea893c4d60d31b3d-next_noon"
4287
- | "5622d76001a335e3ea893c4d60d31b3d-next_rising"
4288
- | "5622d76001a335e3ea893c4d60d31b3d-next_setting"
4289
- | "5622d76001a335e3ea893c4d60d31b3d-solar_elevation"
4290
- | "5622d76001a335e3ea893c4d60d31b3d-solar_azimuth"
4291
- | "5622d76001a335e3ea893c4d60d31b3d-solar_rising"
4292
- | "digital_alchemy"
4293
- | "6acd101923c0460fc31bad82c4efa140"
4294
- | "4a7fc2592d3a98e0eed8cbc73e839c1c"
4295
- | "hass_e2e_is_online"
4296
- | "e1806fdc93296bbd5ab42967003cd38729ff9ba6cfeefc3e15a03ad01ac894fe"
4297
- | "a6e8373221727e197144ba689d7606d4be6f609f2fd0fd8e17516548780465ab"
4298
- | "413eb6d69bbec134a07a6d32effd3c3763955e611f43256600cca40725276816"
4299
- | "06d5a22e681ee9c668f8563bd3108853fb053c43342131782afe989090c4ced9"
4300
- | "27b4fc99f35bbdd1a07173caff5b52f86e3bc342db96f48427e47980b0fb6b49"
4301
- | "8eb8c1f8c760e97cfa49a0a29cd6891313a1e9a45dd046a556a9f317778cf50a"
4302
- | "05ecbbc6111791b6baacbbb60397db14";