-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathconfig_flow.py
More file actions
1810 lines (1684 loc) · 80.8 KB
/
config_flow.py
File metadata and controls
1810 lines (1684 loc) · 80.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Config flow for Solar Energy Management integration."""
from __future__ import annotations
import logging
from typing import Any, Dict
import voluptuous as vol
from homeassistant.helpers import selector
from homeassistant.core import callback
from homeassistant import config_entries
from homeassistant.core import HomeAssistant
from homeassistant.data_entry_flow import FlowResult
from .const import (
DOMAIN,
DEFAULT_UPDATE_INTERVAL,
DEFAULT_POWER_DELTA,
DEFAULT_CURRENT_DELTA,
DEFAULT_SOC_DELTA,
DEFAULT_BATTERY_PRIORITY_SOC,
DEFAULT_BATTERY_MINIMUM_SOC,
DEFAULT_BATTERY_RESUME_SOC,
DEFAULT_BATTERY_BUFFER_SOC,
DEFAULT_BATTERY_AUTO_START_SOC,
DEFAULT_BATTERY_ASSIST_FLOOR_SOC,
DEFAULT_MIN_SOLAR_POWER,
DEFAULT_MAX_GRID_IMPORT,
DEFAULT_DAILY_EV_TARGET,
DEFAULT_BATTERY_ASSIST_MAX_POWER,
DEFAULT_BATTERY_CAPACITY_KWH,
DEFAULT_BATTERY_DISCHARGE_PROTECTION_ENABLED,
DEFAULT_BATTERY_MAX_DISCHARGE_POWER,
DEFAULT_BATTERY_DISCHARGE_CONTROL_ENTITY,
DEFAULT_EV_CHARGER_SERVICE,
DEFAULT_EV_CHARGER_SERVICE_ENTITY_ID,
DEFAULT_PREFER_HARDWARE_ENERGY,
DEFAULT_ENERGY_SOURCE_AUTO,
DEFAULT_TARGET_PEAK_LIMIT,
DEFAULT_WARNING_PEAK_LEVEL,
DEFAULT_EMERGENCY_PEAK_LEVEL,
DEFAULT_LOAD_MANAGEMENT_ENABLED,
DEFAULT_CRITICAL_DEVICE_PROTECTION,
DEFAULT_OBSERVER_MODE,
)
from .ha_energy_reader import read_energy_dashboard_config, EnergyDashboardConfig
from .hardware_detection import (
HardwareDetector,
discover_ev_charger_from_registry,
discover_inverter_from_registry,
)
_LOGGER = logging.getLogger(__name__)
def _detect_hardware_specs(hass: HomeAssistant) -> Dict[str, float]:
"""Auto-detect battery capacity, system size, and max discharge from hardware.
Searches the entity registry for known sensor patterns across inverter brands.
Returns a dict of detected values (only includes keys that were found).
"""
detected: Dict[str, float] = {}
# Battery capacity (Wh or kWh)
capacity_patterns = [
"sensor.*akkukapazitat*", # Huawei (Wh)
"sensor.*battery_capacity*", # Generic (kWh or Wh)
"sensor.*usable_capacity*", # SolarEdge, generic
"sensor.*rated_capacity*", # BYD, generic
]
for pattern in capacity_patterns:
import fnmatch
for state in hass.states.async_all("sensor"):
if fnmatch.fnmatch(state.entity_id, pattern):
try:
val = float(state.state)
unit = state.attributes.get("unit_of_measurement", "")
if val > 0:
# Convert Wh to kWh if needed
if unit.lower() == "wh" or val > 500:
val = val / 1000
detected["battery_capacity_kwh"] = round(val, 1)
break
except (ValueError, TypeError):
continue
if "battery_capacity_kwh" in detected:
break
# Inverter rated power (W → kWp)
power_patterns = [
"sensor.*nennleistung*", # Huawei (W)
"sensor.*rated_power*", # Generic (W)
"sensor.*nominal_power*", # SolarEdge (W)
"sensor.*max_power*", # Generic
]
for pattern in power_patterns:
import fnmatch
for state in hass.states.async_all("sensor"):
if fnmatch.fnmatch(state.entity_id, pattern) and "inverter" in state.entity_id.lower():
try:
val = float(state.state)
if val > 100: # Must be in W
detected["system_size_kwp"] = round(val / 1000, 1)
break
except (ValueError, TypeError):
continue
if "system_size_kwp" in detected:
break
# Battery max discharge power (W)
discharge_patterns = [
"number.*maximale_entladeleistung*", # Huawei
"number.*max_discharge*", # Generic
"sensor.*max_discharge_power*", # SolarEdge, generic
]
for pattern in discharge_patterns:
import fnmatch
for state in hass.states.async_all(["number", "sensor"]):
if fnmatch.fnmatch(state.entity_id, pattern):
try:
val = float(state.state)
if val > 0:
detected["battery_max_discharge_power"] = round(val, 0)
detected["battery_assist_max_power"] = round(val, 0)
break
except (ValueError, TypeError):
continue
if "battery_max_discharge_power" in detected:
break
if detected:
_LOGGER.info("Hardware auto-detected: %s", detected)
return detected
class SolarEnergyManagementConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
"""Handle a config flow for Solar Energy Management."""
# v4 (#255): per-charger settings seeded from globals (async_migrate_entry).
# v5 (#277 Phase A): per-charger charge_mode derived from legacy toggles.
# v6 (#277 Phase B): re-derive charge_mode for the pv+tariff combinations
# Phase A's derivation silently dropped.
# v7 (#277 Phase C): drop the dead ev_charging_mode key (charge_mode is
# authoritative now; the legacy select + 3 legacy switches are gone).
VERSION = 7
@staticmethod
@callback
def async_get_options_flow(config_entry: config_entries.ConfigEntry) -> config_entries.OptionsFlow:
"""Get the options flow for this handler."""
return OptionsFlowHandler(config_entry)
def __init__(self):
"""Initialize the config flow."""
self._data = {}
self._errors = {}
self._energy_dashboard_config: EnergyDashboardConfig | None = None
self._detector = None
async def async_step_integration_discovery(
self, discovery_info: dict[str, Any]
) -> FlowResult:
"""Handle integration discovery (#44).
Triggered when a supported inverter integration (huawei_solar,
solaredge, fronius, goodwe, enphase_envoy, sma, growatt_server,
solis, powerwall, kostal_plenticore, solax, victron) is loaded.
Suggests SEM setup if Energy Dashboard is configured.
"""
await self.async_set_unique_id(DOMAIN)
# Reload on rediscovery to pick up updated version/device info
# (quality scale: discovery-update-info)
self._abort_if_unique_id_configured(reload_on_update=True)
# Only proceed if Energy Dashboard is actually configured
dashboard = await read_energy_dashboard_config(self.hass)
if not dashboard or not dashboard.is_minimally_configured():
return self.async_abort(reason="energy_dashboard_not_configured")
return await self.async_step_user()
async def async_step_user(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle the initial step - check Energy Dashboard configuration."""
errors: dict[str, str] = {}
# Read Energy Dashboard configuration
self._energy_dashboard_config = await read_energy_dashboard_config(self.hass)
if self._energy_dashboard_config is None:
# Energy Dashboard not configured at all
return self.async_abort(
reason="energy_dashboard_not_configured",
description_placeholders={
"url": "/config/energy"
}
)
if not self._energy_dashboard_config.is_minimally_configured():
# Energy Dashboard missing required components
missing = self._energy_dashboard_config.get_missing_components()
return self.async_abort(
reason="energy_dashboard_incomplete",
description_placeholders={
"missing": ", ".join(missing),
"url": "/config/energy"
}
)
# Energy Dashboard is configured - show summary and continue
if user_input is not None:
# Store Energy Dashboard sensor config + the observer_mode toggle
self._data.update(self._energy_dashboard_config.to_dict())
self._data["observer_mode"] = user_input.get("observer_mode", False)
return await self.async_step_ev_charger()
# Show Energy Dashboard summary — list every sensor SEM picked up so the
# user can verify the auto-detection at a glance.
cfg = self._energy_dashboard_config
summary_lines: list[str] = []
def _add(category: str, fields: list[tuple[str, str | None]]) -> None:
present = [(label, eid) for label, eid in fields if eid]
if not present:
return
summary_lines.append(f"**{category}**")
for label, eid in present:
summary_lines.append(f" • {label}: `{eid}`")
summary_lines.append("")
if cfg.has_solar:
if len(cfg.solar_power_list) > 1:
fields = [(f"Power ({i+1})", p) for i, p in enumerate(cfg.solar_power_list)]
fields += [(f"Energy ({i+1})", e) for i, e in enumerate(cfg.solar_energy_list)]
_add(f"Solar ({len(cfg.solar_power_list)} inverters)", fields)
else:
_add("Solar", [
("Power", cfg.solar_power),
("Energy", cfg.solar_energy),
])
if cfg.has_grid:
if len(cfg.grid_import_energy_list) > 1:
fields = [(f"Import energy ({i+1})", e) for i, e in enumerate(cfg.grid_import_energy_list)]
fields += [(f"Export energy ({i+1})", e) for i, e in enumerate(cfg.grid_export_energy_list)]
fields.insert(0, ("Power", cfg.grid_import_power))
_add(f"Grid ({len(cfg.grid_import_energy_list)} tariffs)", fields)
else:
_add("Grid", [
("Power", cfg.grid_import_power),
("Import energy", cfg.grid_import_energy),
("Export energy", cfg.grid_export_energy),
])
if cfg.has_battery:
if len(cfg.battery_power_list) > 1:
fields = [(f"Power ({i+1})", p) for i, p in enumerate(cfg.battery_power_list)]
fields += [(f"Charge energy ({i+1})", e) for i, e in enumerate(cfg.battery_charge_energy_list)]
fields += [(f"Discharge energy ({i+1})", e) for i, e in enumerate(cfg.battery_discharge_energy_list)]
_add(f"Battery ({len(cfg.battery_power_list)} units)", fields)
else:
_add("Battery", [
("Power", cfg.battery_power),
("Charge energy", cfg.battery_charge_energy),
("Discharge energy", cfg.battery_discharge_energy),
])
if cfg.has_ev:
_add("EV", [
("Power", cfg.ev_power),
("Energy", cfg.ev_energy),
])
# Trim trailing blank line for tidy rendering
if summary_lines and summary_lines[-1] == "":
summary_lines.pop()
return self.async_show_form(
step_id="user",
data_schema=vol.Schema({
# Single safety toggle. Defaulted OFF so a real install
# actually controls hardware. Set to ON for test/staging
# instances that mirror a production HA — observer mode
# blocks every outbound service call from SEM.
vol.Optional(
"observer_mode",
default=False,
): selector.BooleanSelector(),
}),
description_placeholders={
"summary": "\n".join(summary_lines)
},
errors=errors
)
async def async_step_ev_charger(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle the EV charger control configuration step."""
errors: dict[str, str] = {}
# Initialize hardware detector for EV control entity detection
if self._detector is None:
self._detector = HardwareDetector(self.hass)
if user_input is not None:
# Validate EV charger entities
validation_errors = self._detector.validate_ev_configuration(user_input)
if validation_errors:
errors.update(validation_errors)
_LOGGER.error(f"EV validation failed: {validation_errors}")
# Validate optional entity IDs exist in HA and have usable state (#32)
for entity_key in (
"ev_charger_service_entity_id",
"ev_current_sensor",
"ev_total_energy_sensor",
):
entity_id = user_input.get(entity_key, "")
if entity_id:
state = self.hass.states.get(entity_id)
if not state:
errors[entity_key] = "entity_not_found"
elif state.state in ("unknown", "unavailable"):
_LOGGER.warning(
"Entity %s exists but has state '%s' — may cause issues",
entity_id, state.state,
)
if not errors:
# Store EV charger entities and continue to the hardware step
self._data.update(user_input)
return await self.async_step_hardware()
# Primary: integration-aware registry discovery (KEBA, Easee, go-eCharger, Wallbox).
# This filters by entity registry platform and device_class, so it never matches
# unrelated devices like generic smart plugs.
suggestions = discover_ev_charger_from_registry(self.hass)
# Fallback: pattern-based detection only fills keys the registry didn't already set,
# so a stray generic match can never override a confident registry match.
pattern_suggestions = self._detector.get_suggested_ev_defaults() if self._detector else {}
for key, value in pattern_suggestions.items():
if value and not suggestions.get(key):
suggestions[key] = value
# Pre-fill from Energy Dashboard if available
if self._energy_dashboard_config and self._energy_dashboard_config.has_ev:
if self._energy_dashboard_config.ev_power and not suggestions.get("ev_charging_power_sensor"):
suggestions["ev_charging_power_sensor"] = self._energy_dashboard_config.ev_power
if self._energy_dashboard_config.ev_energy and not suggestions.get("ev_total_energy_sensor"):
suggestions["ev_total_energy_sensor"] = self._energy_dashboard_config.ev_energy
# Helper for optional EntitySelector fields: HA rejects default="" because
# an empty string is neither a valid entity_id nor None. Use suggested_value
# via the field description so the prefill is shown without becoming a
# hard default.
def _opt_entity_default(key: str):
v = suggestions.get(key)
return v if v is not None else None
return self.async_show_form(
step_id="ev_charger",
data_schema=vol.Schema({
# EV Charger Control Entities (Required for solar optimization)
# Accept both binary_sensor and sensor for Easee/GoodWe (#68)
vol.Required(
"ev_connected_sensor",
default=suggestions.get("ev_connected_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor"])
),
vol.Required(
"ev_charging_sensor",
default=suggestions.get("ev_charging_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor"])
),
vol.Required(
"ev_charging_power_sensor",
default=suggestions.get("ev_charging_power_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(
domain="sensor",
device_class="power"
)
),
# EV Charger Control (Optional - for chargers without number entity)
vol.Optional(
"ev_charger_service",
default=suggestions.get("ev_charger_service", ""),
): selector.TextSelector(
selector.TextSelectorConfig(
type=selector.TextSelectorType.TEXT
)
),
vol.Optional(
"ev_charger_service_entity_id",
description={"suggested_value": _opt_entity_default("ev_charger_service_entity_id")},
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor", "switch"])
),
# Optional EV sensors
vol.Optional(
"ev_current_sensor",
description={"suggested_value": _opt_entity_default("ev_current_sensor")},
): selector.EntitySelector(
selector.EntitySelectorConfig(
domain="sensor",
device_class="current"
)
),
vol.Optional(
"ev_total_energy_sensor",
description={"suggested_value": _opt_entity_default("ev_total_energy_sensor")},
): selector.EntitySelector(
selector.EntitySelectorConfig(
domain="sensor",
device_class="energy"
)
),
# Vehicle SOC fields moved to OptionsFlow — they only matter
# when the user has a real vehicle SOC sensor, which most
# cars don't expose. Asking on install creates dead inputs.
}),
errors=errors
)
@staticmethod
def _install_defaults() -> dict[str, Any]:
"""Return the default values for fields the install flow no longer asks.
These keys are read by the coordinator (and various sub-modules) at
startup. Asking the user for every one of them is overwhelming, so the
slim install flow stores sensible defaults silently and lets advanced
users tune them later via the OptionsFlow or the runtime number
entities. Keep this in sync with the OptionsFlowHandler so the same
keys are editable post-install.
"""
return {
# Coordinator deltas / loop
"update_interval": DEFAULT_UPDATE_INTERVAL,
"power_delta": DEFAULT_POWER_DELTA,
"current_delta": DEFAULT_CURRENT_DELTA,
"soc_delta": DEFAULT_SOC_DELTA,
# 4-zone SOC strategy thresholds (see docs/ARCHITECTURE.md)
"battery_priority_soc": DEFAULT_BATTERY_PRIORITY_SOC,
"battery_buffer_soc": DEFAULT_BATTERY_BUFFER_SOC,
"battery_auto_start_soc": DEFAULT_BATTERY_AUTO_START_SOC,
"battery_assist_floor_soc": DEFAULT_BATTERY_ASSIST_FLOOR_SOC,
# Legacy 3-zone hard-stop / resume — kept for the safety gates
# in coordinator.py that haven't been migrated to the 4-zone
# strategy yet (battery_too_low check, hysteresis resume).
"battery_minimum_soc": DEFAULT_BATTERY_MINIMUM_SOC,
"battery_resume_soc": DEFAULT_BATTERY_RESUME_SOC,
# Solar / power gates
"min_solar_power": DEFAULT_MIN_SOLAR_POWER,
"max_grid_import": DEFAULT_MAX_GRID_IMPORT,
# Daily target & battery assist
"daily_ev_target": DEFAULT_DAILY_EV_TARGET,
"battery_assist_max_power": DEFAULT_BATTERY_ASSIST_MAX_POWER,
# Battery discharge protection (entity is auto-detected separately)
"battery_discharge_protection_enabled": DEFAULT_BATTERY_DISCHARGE_PROTECTION_ENABLED,
"battery_max_discharge_power": DEFAULT_BATTERY_MAX_DISCHARGE_POWER,
# Energy source selection
"prefer_hardware_energy": DEFAULT_PREFER_HARDWARE_ENERGY,
"energy_source_auto": DEFAULT_ENERGY_SOURCE_AUTO,
# ``smart_night_charging`` removed in #277 Phase C — the
# named ``charge_mode`` carries that intent now.
# Notifications — sensible defaults; tune in OptionsFlow
"enable_charger_notifications": True,
"enable_mobile_notifications": False,
"mobile_notification_service": "",
# Load management — only target_peak_limit is asked at install,
# everything else uses safe defaults that the user can tune later.
"load_management_enabled": DEFAULT_LOAD_MANAGEMENT_ENABLED,
"warning_peak_level": DEFAULT_WARNING_PEAK_LEVEL,
"emergency_peak_level": DEFAULT_EMERGENCY_PEAK_LEVEL,
"critical_device_protection": DEFAULT_CRITICAL_DEVICE_PROTECTION,
}
async def async_step_hardware(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Final install step: ask only the genuinely hardware-dependent values.
Asks the user for the home battery capacity and the grid peak limit
(both vary by install and have no universal default). Auto-detects
the inverter's battery discharge control entity from the entity
registry. All other tunables are filled from ``_install_defaults()``
so the coordinator boots with a complete config dict.
"""
errors: dict[str, str] = {}
if user_input is not None:
try:
await self.async_set_unique_id(DOMAIN)
self._abort_if_unique_id_configured()
# Apply silent defaults first, then layer hardware auto-detection,
# user's hardware answers, and discharge entity on top.
merged: dict[str, Any] = {}
merged.update(self._install_defaults())
merged.update(_detect_hardware_specs(self.hass))
merged.update(self._data)
merged.update(user_input)
discharge_entity = discover_inverter_from_registry(
self.hass, self._energy_dashboard_config
)
if discharge_entity:
merged["battery_discharge_control_entity"] = discharge_entity
else:
# Coordinator fallback expects the key to be present even
# if empty so config.get() returns "".
merged.setdefault("battery_discharge_control_entity", "")
# Wrap flat EV keys into ev_chargers list (#112 multi-charger)
if merged.get("ev_charging_power_sensor") and "ev_chargers" not in merged:
_EV_KEYS = [
"ev_connected_sensor", "ev_charging_sensor",
"ev_charging_power_sensor", "ev_charger_service",
"ev_charger_service_entity_id", "ev_current_sensor",
"ev_total_energy_sensor", "ev_session_energy_sensor",
"ev_service_param_name", "ev_service_device_id",
"ev_start_stop_entity", "ev_charge_mode_entity",
"ev_charge_mode_start", "ev_charge_mode_stop",
"ev_start_service", "ev_start_service_data",
"ev_stop_service", "ev_stop_service_data",
"ev_charger_needs_cycle", "ev_surplus_priority",
]
charger_0 = {"id": "ev_charger", "name": "EV Charger"}
for k in _EV_KEYS:
if merged.get(k) is not None:
charger_0[k] = merged[k]
merged["ev_chargers"] = [charger_0]
self._data = merged
return self.async_create_entry(
title="Solar Energy Management",
data=self._data,
)
except Exception:
_LOGGER.exception("Unexpected exception creating entry")
errors["base"] = "unknown"
# Best-effort preview of the auto-detected discharge entity for the
# description placeholder so the user can see what was found.
detected_discharge = discover_inverter_from_registry(
self.hass, self._energy_dashboard_config
)
discharge_summary = (
f"`{detected_discharge}`" if detected_discharge else "(not auto-detected)"
)
return self.async_show_form(
step_id="hardware",
data_schema=vol.Schema({
vol.Required(
"target_peak_limit",
default=DEFAULT_TARGET_PEAK_LIMIT,
): selector.NumberSelector(
selector.NumberSelectorConfig(
min=2.0, max=20.0, step=0.5, unit_of_measurement="kW", mode="slider"
)
),
# Opt-in: generate the SEM Lovelace dashboard right after the
# config entry is created. The post-setup hook in __init__.py
# consumes this flag exactly once and clears it from
# entry.data so the dashboard isn't regenerated on every
# restart.
vol.Optional(
"generate_dashboard_on_install",
default=True,
): selector.BooleanSelector(),
vol.Optional(
"diagram_style",
default="sem",
): selector.SelectSelector(
selector.SelectSelectorConfig(
options=[
{"value": "sem", "label": "SEM (built-in)"},
{"value": "kflow", "label": "K-Flow (HACS)"},
],
mode=selector.SelectSelectorMode.DROPDOWN,
)
),
}),
description_placeholders={
"discharge_entity": discharge_summary,
},
errors=errors,
)
async def async_step_reconfigure(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle reconfiguration of the integration."""
errors: dict[str, str] = {}
reconfigure_entry = self._get_reconfigure_entry()
current_config = {**reconfigure_entry.data, **reconfigure_entry.options}
if user_input is not None:
# Validate EV charger entities if provided
if self._detector is None:
self._detector = HardwareDetector(self.hass)
validation_errors = self._detector.validate_ev_configuration(user_input)
if validation_errors:
errors.update(validation_errors)
# Validate optional entity IDs exist in HA
for entity_key in (
"ev_charger_service_entity_id",
"ev_total_energy_sensor",
):
entity_id = user_input.get(entity_key, "")
if entity_id and not self.hass.states.get(entity_id):
errors[entity_key] = "entity_not_found"
# Validate notification service if provided
mobile_service = user_input.get("mobile_notification_service", "").strip()
if user_input.get("enable_mobile_notifications", False) and mobile_service:
svc_name = mobile_service.replace("notify.", "").split(".")[-1]
if not (self.hass.services.has_service("notify", svc_name)
or self.hass.services.has_service("rest_command", svc_name)):
errors["mobile_notification_service"] = "service_not_found"
if not errors:
return self.async_update_reload_and_abort(
reconfigure_entry,
data_updates=user_input,
)
# Get available notification services (notify.* and rest_command.*)
notify_services = [{"value": "", "label": "None"}]
try:
services_dict = self.hass.services.async_services()
if "notify" in services_dict:
for service in services_dict["notify"].keys():
notify_services.append({
"value": service,
"label": f"notify.{service}"
})
if "rest_command" in services_dict:
for service in services_dict["rest_command"].keys():
notify_services.append({
"value": service,
"label": f"rest_command.{service}"
})
notify_services[1:] = sorted(notify_services[1:], key=lambda x: x["label"])
except Exception:
pass
return self.async_show_form(
step_id="reconfigure",
data_schema=vol.Schema({
vol.Required(
"ev_connected_sensor",
default=current_config.get("ev_connected_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor"])
),
vol.Required(
"ev_charging_sensor",
default=current_config.get("ev_charging_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor"])
),
vol.Required(
"ev_charging_power_sensor",
default=current_config.get("ev_charging_power_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain="sensor", device_class="power")
),
vol.Optional(
"ev_charger_service",
default=current_config.get("ev_charger_service", ""),
): selector.TextSelector(
selector.TextSelectorConfig(type=selector.TextSelectorType.TEXT)
),
vol.Optional(
"ev_charger_service_entity_id",
default=current_config.get("ev_charger_service_entity_id", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor", "switch"])
),
vol.Optional(
"ev_total_energy_sensor",
default=current_config.get("ev_total_energy_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain="sensor", device_class="energy")
),
vol.Optional(
"enable_charger_notifications",
default=current_config.get("enable_charger_notifications", True),
): selector.BooleanSelector(),
vol.Optional(
"enable_mobile_notifications",
default=current_config.get("enable_mobile_notifications", False),
): selector.BooleanSelector(),
vol.Optional(
"mobile_notification_service",
default=current_config.get("mobile_notification_service", ""),
): selector.SelectSelector(
selector.SelectSelectorConfig(
options=notify_services,
mode=selector.SelectSelectorMode.DROPDOWN
)
),
}),
errors=errors,
)
class OptionsFlowHandler(config_entries.OptionsFlow):
"""Handle options flow for Solar Energy Management."""
def __init__(self, config_entry: config_entries.ConfigEntry) -> None:
"""Initialize options flow.
On HA 2024.12+ the framework auto-injects `self.config_entry` via
a property on the OptionsFlow base — explicitly assigning it raises
a deprecation warning. We just initialise our own state.
"""
self._data: dict[str, Any] = {}
async def async_step_init(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Manage the options."""
return await self.async_step_ev_charger()
@staticmethod
def _cfg(config: dict, key: str, fallback: Any) -> Any:
"""Null-safe config lookup.
``dict.get(key, fallback)`` returns ``None`` when the key exists
with value ``None``. Voluptuous rejects ``None`` as a default
for NumberSelector / BooleanSelector, causing the form to crash
with HTTP 400 (#73). This helper treats ``None`` the same as
missing.
"""
v = config.get(key)
return fallback if v is None else v
async def async_step_ev_charger(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle EV charger options (primary charger)."""
errors: dict[str, str] = {}
if user_input is not None:
# Update both flat keys and ev_chargers[0] (#112)
self._data.update(user_input)
ev_chargers = list(self._data.get("ev_chargers") or self.config_entry.options.get("ev_chargers") or [])
if ev_chargers:
ev_chargers[0].update(user_input)
else:
ev_chargers = [{"id": "ev_charger", "name": "EV Charger", **user_input}]
self._data["ev_chargers"] = ev_chargers
return await self.async_step_ev_charger_menu()
current_config = {**self.config_entry.data, **self.config_entry.options}
# Read from ev_chargers[0] if available (#112 multi-charger)
ev_chargers = current_config.get("ev_chargers", [])
if ev_chargers:
for k, v in ev_chargers[0].items():
if k not in ("id", "name") and v is not None:
current_config.setdefault(k, v)
_c = lambda key, fb: self._cfg(current_config, key, fb)
def _opt(key: str):
v = current_config.get(key)
return v if v is not None else None
return self.async_show_form(
step_id="ev_charger",
data_schema=vol.Schema({
vol.Required(
"ev_connected_sensor",
default=current_config.get("ev_connected_sensor", "")
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor"])
),
vol.Required(
"ev_charging_sensor",
default=current_config.get("ev_charging_sensor", "")
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor"])
),
vol.Required(
"ev_charging_power_sensor",
default=current_config.get("ev_charging_power_sensor", "")
): selector.EntitySelector(
selector.EntitySelectorConfig(domain="sensor")
),
vol.Optional(
"ev_charger_service",
default=current_config.get("ev_charger_service", ""),
): selector.TextSelector(
selector.TextSelectorConfig(type=selector.TextSelectorType.TEXT)
),
vol.Optional(
"ev_charger_service_entity_id",
description={"suggested_value": _opt("ev_charger_service_entity_id")},
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor", "switch"])
),
vol.Optional(
"ev_total_energy_sensor",
description={"suggested_value": _opt("ev_total_energy_sensor")},
): selector.EntitySelector(
selector.EntitySelectorConfig(domain="sensor")
),
# Vehicle SOC fields — moved here from the install flow.
# Only meaningful when a vehicle SOC sensor is exposed in HA;
# see issues #97 and #98.
vol.Optional(
"vehicle_soc_entity",
description={"suggested_value": _opt("vehicle_soc_entity")},
): selector.EntitySelector(
selector.EntitySelectorConfig(domain="sensor", device_class="battery")
),
vol.Optional(
"ev_battery_capacity_kwh",
default=_c("ev_battery_capacity_kwh", 40),
): selector.NumberSelector(
selector.NumberSelectorConfig(
min=10, max=120, step=5, unit_of_measurement="kWh", mode="box"
)
),
# Optional real range sensor; else range is derived from
# SOC × capacity ÷ consumption (kWh/100km) (#245).
vol.Optional(
"vehicle_range_entity",
description={"suggested_value": _opt("vehicle_range_entity")},
): selector.EntitySelector(
selector.EntitySelectorConfig(domain="sensor", device_class="distance")
),
vol.Optional(
"ev_kwh_per_100km",
default=_c("ev_kwh_per_100km", 18),
): selector.NumberSelector(
selector.NumberSelectorConfig(
min=8, max=50, step=0.5, unit_of_measurement="kWh/100km", mode="box"
)
),
vol.Optional(
"ev_target_soc",
default=_c("ev_target_soc", 80),
): selector.NumberSelector(
selector.NumberSelectorConfig(
min=50, max=100, step=5, unit_of_measurement="%", mode="slider"
)
),
# Optional solar ceiling (Max): surplus charges up to this, then
# stops. Defaults to full (100) = charge freely from sun (#245).
vol.Optional(
"daily_ev_target_max",
default=_c("daily_ev_target_max", 100),
): selector.NumberSelector(
selector.NumberSelectorConfig(
min=0, max=100, step=0.5, unit_of_measurement="kWh", mode="slider"
)
),
vol.Optional(
"ev_target_soc_max",
default=_c("ev_target_soc_max", 100),
): selector.NumberSelector(
selector.NumberSelectorConfig(
min=50, max=100, step=5, unit_of_measurement="%", mode="slider"
)
),
}),
errors=errors
)
async def async_step_ev_charger_menu(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Multi-charger menu: add another charger or continue (#112)."""
if user_input is not None:
action = user_input.get("action", "continue")
if action == "add_charger":
return await self.async_step_ev_charger_add()
if action == "remove_charger":
return await self.async_step_ev_charger_remove()
if action.startswith("edit_charger:"):
self._edit_charger_id = action.split(":", 1)[1]
return await self.async_step_ev_charger_edit()
return await self.async_step_settings()
ev_chargers = self._data.get("ev_chargers", [])
charger_count = len(ev_chargers)
# Show charger list + options
options = [
{"value": "continue", "label": f"Continue ({charger_count} charger{'s' if charger_count != 1 else ''} configured)"},
]
# Edit option per charger
for c in ev_chargers:
options.append(
{"value": f"edit_charger:{c['id']}", "label": f"Edit: {c.get('name', c['id'])}"},
)
options.append({"value": "add_charger", "label": "Add another EV charger"})
if charger_count > 1:
options.append(
{"value": "remove_charger", "label": "Remove a charger"},
)
return self.async_show_form(
step_id="ev_charger_menu",
data_schema=vol.Schema({
vol.Required("action", default="continue"): selector.SelectSelector(
selector.SelectSelectorConfig(
options=options,
mode=selector.SelectSelectorMode.LIST,
)
),
}),
)
async def async_step_ev_charger_add(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Add an additional EV charger (#112)."""
errors: dict[str, str] = {}
if user_input is not None:
ev_chargers = list(self._data.get("ev_chargers", []))
idx = len(ev_chargers)
charger_name = user_input.pop("charger_name", f"EV Charger {idx + 1}")
new_charger = {
"id": f"ev_charger_{idx}",
"name": charger_name,
**user_input,
}
ev_chargers.append(new_charger)
self._data["ev_chargers"] = ev_chargers
_LOGGER.info("Added EV charger '%s' (total: %d)", charger_name, len(ev_chargers))
return await self.async_step_ev_charger_menu()
# Auto-discover additional chargers
from .hardware_detection import discover_all_ev_chargers_from_registry
all_discovered = discover_all_ev_chargers_from_registry(self.hass)
existing_ids = {c.get("_device_id") for c in self._data.get("ev_chargers", []) if c.get("_device_id")}
# Filter to undiscovered chargers
new_discoveries = [c for c in all_discovered if c.get("_device_id") not in existing_ids]
suggestions = new_discoveries[0] if new_discoveries else {}
return self.async_show_form(
step_id="ev_charger_add",
data_schema=vol.Schema({
vol.Required(
"charger_name",
default=suggestions.get("name", f"EV Charger {len(self._data.get('ev_chargers', [])) + 1}"),
): selector.TextSelector(),
vol.Required(
"ev_connected_sensor",
default=suggestions.get("ev_connected_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor"])
),
vol.Required(
"ev_charging_sensor",
default=suggestions.get("ev_charging_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor"])
),
vol.Required(
"ev_charging_power_sensor",
default=suggestions.get("ev_charging_power_sensor", ""),
): selector.EntitySelector(
selector.EntitySelectorConfig(domain="sensor", device_class="power")
),
vol.Optional(
"ev_current_control_entity",
description={"suggested_value": suggestions.get("ev_current_control_entity")},
): selector.EntitySelector(
selector.EntitySelectorConfig(domain="number")
),
vol.Optional(
"ev_charger_service",
default=suggestions.get("ev_charger_service", ""),
): selector.TextSelector(),
vol.Optional(
"ev_charger_service_entity_id",
description={"suggested_value": suggestions.get("ev_charger_service_entity_id")},
): selector.EntitySelector(
selector.EntitySelectorConfig(domain=["binary_sensor", "sensor", "switch"])
),
vol.Optional(
"ev_surplus_priority",
default=5,