aiopowerwall 0.1.0__tar.gz

aiopowerwall-0.1.0/.gitignore

@@ -0,0 +1,222 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Local testing
+*.pem
+test.py

aiopowerwall-0.1.0/LICENSE

@@ -0,0 +1,26 @@
+MIT License
+
+Portions of this project are derived from pypowerwall by Jason Cox
+(https://github.com/jasonacox/pypowerwall), licensed under the MIT License:
+
+    Copyright (c) 2022 Jason A. Cox
+
+Copyright (c) 2026 Teslemetry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aiopowerwall-0.1.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: aiopowerwall
+Version: 0.1.0
+Summary: Async Tesla Powerwall 3 client over the TEDAPI v1r RSA-signed LAN protocol.
+Project-URL: Homepage, https://github.com/Teslemetry/aiopowerwall
+Project-URL: Repository, https://github.com/Teslemetry/aiopowerwall
+Project-URL: Issues, https://github.com/Teslemetry/aiopowerwall/issues
+Project-URL: Changelog, https://github.com/Teslemetry/aiopowerwall/releases
+Author-email: Teslemetry <hello@teslemetry.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: aiohttp,asyncio,home-assistant,powerwall,tedapi,tesla
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: cryptography>=41
+Requires-Dist: protobuf>=4.25
+Provides-Extra: dev
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Requires-Dist: types-protobuf; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# aiopowerwall
+
+An async Tesla Powerwall 3 client built on `aiohttp`, written for Home
+Assistant and any other asyncio code.
+
+## Status
+
+**Beta (0.x).** The wire protocol and the public Python API may change
+between minor versions until 1.0. Pin a tight version range if you depend
+on this library in production.
+
+This library speaks the Powerwall's **TEDAPI v1r** protocol — RSA-signed
+protobuf messages directly to your Powerwall. It is intentionally
+scoped to:
+
+- Powerwall 3, and updated Powerwall 2 (untested)
+- Local LAN access only (no cloud telemetry)
+- Read + control commands (status, config, firmware, components, max-backup)
+
+The RSA key pair used for v1r authentication must be **registered with the
+gateway out-of-band**, typically via the Tesla Fleet API. This library
+consumes an already-paired private key — it does not implement registration.
+
+## Install
+
+```bash
+pip install aiopowerwall
+```
+
+## Quick start
+
+```python
+import asyncio
+from pathlib import Path
+from aiopowerwall import PowerwallClient
+
+async def main() -> None:
+    pem = Path("tedapi_rsa_private.pem").read_bytes()
+    async with PowerwallClient(
+        host="192.168.91.1",
+        gateway_password="<gateway-password>",
+        rsa_private_key_pem=pem,
+    ) as pw:
+        await pw.connect()
+        print("DIN:", pw.din)
+        print("Battery SoC:", await pw.get_battery_soe(), "%")
+        print("Grid:", await pw.get_grid_status())
+        print("Power:", await pw.current_power())
+
+asyncio.run(main())
+```
+
+## API surface
+
+| Method | Returns |
+| --- | --- |
+| `connect()` | DIN string |
+| `get_din()` | DIN string |
+| `get_config()` | `config.json` (dict) |
+| `get_status()` | DeviceController query (narrow) |
+| `get_device_controller()` | DeviceController query (extended) |
+| `get_components()` | Powerwall 3 component data |
+| `get_firmware_version(details=...)` | Version string or details dict |
+| `get_meters_aggregates()` | `/api/meters/aggregates` |
+| `get_battery_soe()` | Battery SoC percentage |
+| `get_grid_status()` | Grid status string |
+| `battery_level()` | SoC computed from status payload |
+| `current_power(location=...)` | Real power per meter aggregate |
+| `backup_time_remaining()` | Hours of backup at current load |
+| `write_config(updates)` | Patch `config.json` (dotted paths) |
+| `schedule_max_backup(seconds)` | Schedule manual backup event |
+| `cancel_max_backup()` | Cancel manual backup event |
+| `get_backup_events()` | Active and scheduled backup events |
+
+All read methods cache responses with a configurable TTL
+(`cache_status_ttl`, `cache_config_ttl`); pass `force=True` to refresh.
+
+## Exceptions
+
+All errors are subclasses of `PowerwallError`:
+
+- `PowerwallConnectionError` — transport failure / timeout
+- `PowerwallAuthenticationError` — bad password or unregistered RSA key
+- `PowerwallRateLimitError` — gateway returned 429/503
+- `PowerwallFaultError` — signed-message fault (key inactive, expired, etc.)
+- `PowerwallProtocolError` — malformed response
+
+## Acknowledgements
+
+This project builds on the protocol research and reference implementation in
+[`pypowerwall`](https://github.com/jasonacox/pypowerwall) by
+[Jason Cox](https://github.com/jasonacox), distributed under the
+[MIT License](https://github.com/jasonacox/pypowerwall/blob/main/LICENSE).
+Huge thanks to Jason and the pypowerwall contributors for reverse-engineering
+and documenting the TEDAPI protocol.
+
+## License
+
+MIT (see `LICENSE`). Original pypowerwall copyright and license notice are
+retained in `LICENSE`.

aiopowerwall-0.1.0/README.md

@@ -0,0 +1,100 @@
+# aiopowerwall
+
+An async Tesla Powerwall 3 client built on `aiohttp`, written for Home
+Assistant and any other asyncio code.
+
+## Status
+
+**Beta (0.x).** The wire protocol and the public Python API may change
+between minor versions until 1.0. Pin a tight version range if you depend
+on this library in production.
+
+This library speaks the Powerwall's **TEDAPI v1r** protocol — RSA-signed
+protobuf messages directly to your Powerwall. It is intentionally
+scoped to:
+
+- Powerwall 3, and updated Powerwall 2 (untested)
+- Local LAN access only (no cloud telemetry)
+- Read + control commands (status, config, firmware, components, max-backup)
+
+The RSA key pair used for v1r authentication must be **registered with the
+gateway out-of-band**, typically via the Tesla Fleet API. This library
+consumes an already-paired private key — it does not implement registration.
+
+## Install
+
+```bash
+pip install aiopowerwall
+```
+
+## Quick start
+
+```python
+import asyncio
+from pathlib import Path
+from aiopowerwall import PowerwallClient
+
+async def main() -> None:
+    pem = Path("tedapi_rsa_private.pem").read_bytes()
+    async with PowerwallClient(
+        host="192.168.91.1",
+        gateway_password="<gateway-password>",
+        rsa_private_key_pem=pem,
+    ) as pw:
+        await pw.connect()
+        print("DIN:", pw.din)
+        print("Battery SoC:", await pw.get_battery_soe(), "%")
+        print("Grid:", await pw.get_grid_status())
+        print("Power:", await pw.current_power())
+
+asyncio.run(main())
+```
+
+## API surface
+
+| Method | Returns |
+| --- | --- |
+| `connect()` | DIN string |
+| `get_din()` | DIN string |
+| `get_config()` | `config.json` (dict) |
+| `get_status()` | DeviceController query (narrow) |
+| `get_device_controller()` | DeviceController query (extended) |
+| `get_components()` | Powerwall 3 component data |
+| `get_firmware_version(details=...)` | Version string or details dict |
+| `get_meters_aggregates()` | `/api/meters/aggregates` |
+| `get_battery_soe()` | Battery SoC percentage |
+| `get_grid_status()` | Grid status string |
+| `battery_level()` | SoC computed from status payload |
+| `current_power(location=...)` | Real power per meter aggregate |
+| `backup_time_remaining()` | Hours of backup at current load |
+| `write_config(updates)` | Patch `config.json` (dotted paths) |
+| `schedule_max_backup(seconds)` | Schedule manual backup event |
+| `cancel_max_backup()` | Cancel manual backup event |
+| `get_backup_events()` | Active and scheduled backup events |
+
+All read methods cache responses with a configurable TTL
+(`cache_status_ttl`, `cache_config_ttl`); pass `force=True` to refresh.
+
+## Exceptions
+
+All errors are subclasses of `PowerwallError`:
+
+- `PowerwallConnectionError` — transport failure / timeout
+- `PowerwallAuthenticationError` — bad password or unregistered RSA key
+- `PowerwallRateLimitError` — gateway returned 429/503
+- `PowerwallFaultError` — signed-message fault (key inactive, expired, etc.)
+- `PowerwallProtocolError` — malformed response
+
+## Acknowledgements
+
+This project builds on the protocol research and reference implementation in
+[`pypowerwall`](https://github.com/jasonacox/pypowerwall) by
+[Jason Cox](https://github.com/jasonacox), distributed under the
+[MIT License](https://github.com/jasonacox/pypowerwall/blob/main/LICENSE).
+Huge thanks to Jason and the pypowerwall contributors for reverse-engineering
+and documenting the TEDAPI protocol.
+
+## License
+
+MIT (see `LICENSE`). Original pypowerwall copyright and license notice are
+retained in `LICENSE`.

aiopowerwall-0.1.0/pyproject.toml

@@ -0,0 +1,78 @@
+[build-system]
+requires = ["hatchling>=1.18"]
+build-backend = "hatchling.build"
+
+[project]
+name = "aiopowerwall"
+version = "0.1.0"
+description = "Async Tesla Powerwall 3 client over the TEDAPI v1r RSA-signed LAN protocol."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+authors = [{ name = "Teslemetry", email = "hello@teslemetry.com" }]
+keywords = ["tesla", "powerwall", "tedapi", "asyncio", "aiohttp", "home-assistant"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Home Automation",
+    "Typing :: Typed",
+]
+dependencies = [
+    "aiohttp>=3.9",
+    "cryptography>=41",
+    "protobuf>=4.25",
+]
+
+[project.optional-dependencies]
+dev = [
+    "mypy>=1.8",
+    "pytest>=8",
+    "pytest-asyncio>=0.23",
+    "ruff>=0.5",
+    "types-protobuf",
+]
+
+[project.urls]
+Homepage = "https://github.com/Teslemetry/aiopowerwall"
+Repository = "https://github.com/Teslemetry/aiopowerwall"
+Issues = "https://github.com/Teslemetry/aiopowerwall/issues"
+Changelog = "https://github.com/Teslemetry/aiopowerwall/releases"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/aiopowerwall"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/aiopowerwall", "README.md", "LICENSE", "pyproject.toml"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+warn_unreachable = true
+files = ["src/aiopowerwall"]
+
+[[tool.mypy.overrides]]
+# Generated protobuf bindings ship without strict stubs; they're an
+# implementation detail of the transport.
+module = "aiopowerwall.proto.*"
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = ["google.protobuf.*"]
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+extend-exclude = ["src/aiopowerwall/proto/*_pb2.py"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "ASYNC", "SIM", "RUF"]
+ignore = ["E501"]  # long lines come from the verbatim GraphQL constants

aiopowerwall-0.1.0/src/aiopowerwall/__init__.py

@@ -0,0 +1,55 @@
+"""Async Tesla Powerwall 3 client (TEDAPI v1r over RSA-signed LAN).
+
+This package provides a single high-level entry point,
+:class:`PowerwallClient`, plus typed exceptions and TypedDict response models.
+
+The RSA key pair used for v1r signing must be registered with the gateway
+out-of-band (typically via the Tesla Fleet API). This library only consumes
+an already-paired private key.
+"""
+
+from __future__ import annotations
+
+from .client import DEFAULT_GATEWAY_HOST, PowerwallClient
+from .exceptions import (
+    PowerwallAuthenticationError,
+    PowerwallConnectionError,
+    PowerwallError,
+    PowerwallFaultError,
+    PowerwallProtocolError,
+    PowerwallRateLimitError,
+)
+from .models import (
+    BackupEvent,
+    BackupEventsPayload,
+    ComponentsPayload,
+    ConfigPayload,
+    ControllerPayload,
+    FirmwareDetails,
+    ManualBackupInfo,
+    PowerLocation,
+    StatusPayload,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "DEFAULT_GATEWAY_HOST",
+    "BackupEvent",
+    "BackupEventsPayload",
+    "ComponentsPayload",
+    "ConfigPayload",
+    "ControllerPayload",
+    "FirmwareDetails",
+    "ManualBackupInfo",
+    "PowerLocation",
+    "PowerwallAuthenticationError",
+    "PowerwallClient",
+    "PowerwallConnectionError",
+    "PowerwallError",
+    "PowerwallFaultError",
+    "PowerwallProtocolError",
+    "PowerwallRateLimitError",
+    "StatusPayload",
+    "__version__",
+]