Merge pull request #4667 from springfall2008/feat/myenergi-component

feat(myenergi): Zappi and Eddi monitoring, auto-config and boost controls

Author: springfall2008

.cspell/custom-dictionary-workspace.txt

@@ -27,6 +27,7 @@ argname
 armhf
 armv
 ASHP
+asn
 asyncio
 atfork
 atleast
@@ -53,6 +54,7 @@ batteryb
 batusecap
 beforeunload
 bierner
+boostable
 brickatius
 byok
 cadata
@@ -235,6 +237,7 @@ hanchu
 hanchuess
 hanres
 HAOS
+harvi
 hasattr
 hass
 hassapi
@@ -272,7 +275,9 @@ isort
 itemsize
 itemtype
 ivtime
+jdayhour
 jedlix
+jstatus
 jsyaml
 kaiming
 keepalive
@@ -291,6 +296,7 @@ kwhb
 labelcolor
 labelnames
 larr
+libbi
 libc
 LIFEPO
 linebreak
@@ -352,6 +358,7 @@ mpxn
 mqtt
 mtok
 mult
+myaccount
 myenergi
 mypy
 nanmean
@@ -441,6 +448,7 @@ pvwatts
 pwindow
 pyjwt
 pylint
+pymyenergi
 pypi
 pyproject
 pytest
@@ -454,6 +462,7 @@ readbacks
 recp
 redownload
 Referer
+refetched
 refetches
 regionid
 regname
@@ -589,6 +598,7 @@ typecode
 typecodes
 tzfile
 tzpath
+unasserted
 unconfigured
 underivable
 undiscounted
@@ -636,4 +646,5 @@ ylabel
 YOURSERIAL
 yuanzhi
 zappi
+Zappis
 zigbee

apps/predbat/components.py

@@ -22,6 +22,7 @@
 from solcast import SolarAPI
 from gecloud import GECloudDirect, GECloudData
 from ohme import OhmeAPI
+from myenergi import MyEnergiAPI
 from octopus import OctopusAPI
 from carbon import CarbonAPI
 from temperature import TemperatureAPI
@@ -219,6 +220,33 @@
         },
         "phase": 1,
     },
+    "myenergi": {
+        "class": MyEnergiAPI,
+        "name": "myenergi Zappi/Eddi",
+        "event_filter": "predbat_myenergi_",
+        "args": {
+            "auth_method": {"required": False, "config": "myenergi_auth_method", "default": "direct"},
+            "hub_serial": {"required": False, "config": "myenergi_hub_serial"},
+            "api_key": {"required": False, "config": "myenergi_api_key"},
+            "key": {"required": False, "config": "myenergi_key"},
+            "token_expires_at": {"required": False, "config": "myenergi_token_expires_at"},
+            "token_hash": {"required": False, "config": "myenergi_token_hash"},
+            "automatic": {"required": False, "config": "myenergi_automatic", "default": True},
+            "enable_controls": {"required": False, "config": "myenergi_enable_controls", "default": True},
+            "poll_seconds": {"required": False, "config": "myenergi_poll_seconds", "default": 60},
+        },
+        # Gate activation on having at least one auth path — api_key is the direct
+        # transport's local hub credential, key is the cloud transport's access token.
+        # Without this the component would start for every instance since all
+        # individual args are optional to allow either auth mode.
+        # api_key is the direct transport's credential; key (the OAuth access token) and
+        # token_hash (which the refresh chain exchanges for one) are the cloud transport's.
+        # token_hash has to be listed too: a refresh-only OAuth setup carries no key, and
+        # initialize() accepts that, so gating on key alone would never construct it.
+        "required_or": ["api_key", "key", "token_hash"],
+        "phase": 1,
+        "can_restart": True,
+    },
     "fox": {
         "class": FoxAPI,
         "name": "Fox API",

apps/predbat/config.py

@@ -2581,6 +2581,15 @@
     "solis_access_token": {"type": "string", "empty": False},
     "solis_token_expires_at": {"type": "string", "empty": False},
     "solis_token_hash": {"type": "string", "empty": False},
+    "myenergi_auth_method": {"type": "string", "empty": False},
+    "myenergi_hub_serial": {"type": "string", "empty": False},
+    "myenergi_api_key": {"type": "string", "empty": False},
+    "myenergi_key": {"type": "string", "empty": False},
+    "myenergi_token_expires_at": {"type": "string", "empty": False},
+    "myenergi_token_hash": {"type": "string", "empty": False},
+    "myenergi_automatic": {"type": "boolean"},
+    "myenergi_enable_controls": {"type": "boolean"},
+    "myenergi_poll_seconds": {"type": "integer", "zero": False},
     "fox_key": {"type": "string", "empty": False},
     "fox_automatic": {"type": "boolean"},
     "fox_automatic_ignore_pv": {"type": "boolean"},