py-solar-assistant 0.1.0__tar.gz

py_solar_assistant-0.1.0/LICENSE

@@ -0,0 +1,173 @@
+This licence applies solely to the Python client library in this repository.
+It does not cover the SolarAssistant platform, including the downloadable
+device software and cloud infrastructure, which are proprietary and
+distributed under separate terms.
+
+---
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source form" shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object form" shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any Contribution
+      incorporated within the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this License
+      for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative Works
+          a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file, you must include a
+          readable copy of the attribution notices contained within such
+          NOTICE file, in at least one of the following places: within a
+          NOTICE text file distributed as part of the Derivative Works;
+          within the Source form or documentation, if provided along with
+          the Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices normally
+          appear. The contents of the NOTICE file are for informational
+          purposes only and do not modify the License. You may add Your own
+          attribution notices within Derivative Works that You distribute,
+          alongside or as an addendum to the NOTICE text from the Work,
+          provided that such additional attribution notices cannot be
+          construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Derivative Works, as separate terms and conditions for use,
+      reproduction, or distribution of Your modifications, or for such
+      Derivative Works as a whole.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   Copyright (c) SolarAssistant. All rights reserved.

py_solar_assistant-0.1.0/PKG-INFO

@@ -0,0 +1,437 @@
+Metadata-Version: 2.4
+Name: py_solar_assistant
+Version: 0.1.0
+Summary: Python client for SolarAssistant — cloud API and real-time WebSocket
+Author: Solar-Assistant
+License: This licence applies solely to the Python client library in this repository.
+        It does not cover the SolarAssistant platform, including the downloadable
+        device software and cloud infrastructure, which are proprietary and
+        distributed under separate terms.
+        
+        ---
+        
+                                         Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source form" shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object form" shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship made available under
+              the License, as indicated by a copyright notice that is included in
+              or attached to the work (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and derivative works thereof.
+        
+              "Contribution" shall mean, as submitted to the Licensor for inclusion
+              in the Work by the copyright owner or by an individual or Legal Entity
+              authorized to submit on behalf of the copyright owner. For the purposes
+              of this definition, "submitted" means any form of electronic, verbal,
+              or written communication sent to the Licensor or its representatives,
+              including but not limited to communication on electronic mailing lists,
+              source code control systems, and issue tracking systems that are managed
+              by, or on behalf of, the Licensor for the purpose of discussing and
+              improving the Work, but excluding communication that is conspicuously
+              marked or designated in writing by the copyright owner as "Not a
+              Contribution."
+        
+              "Contributor" shall mean Licensor and any Legal Entity on behalf of
+              whom a Contribution has been received by the Licensor and included
+              within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a cross-claim
+              or counterclaim in a lawsuit) alleging that the Work or any Contribution
+              incorporated within the Work constitutes direct or contributory patent
+              infringement, then any patent licenses granted to You under this License
+              for that Work shall terminate as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or Derivative Works
+                  a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file, you must include a
+                  readable copy of the attribution notices contained within such
+                  NOTICE file, in at least one of the following places: within a
+                  NOTICE text file distributed as part of the Derivative Works;
+                  within the Source form or documentation, if provided along with
+                  the Derivative Works; or, within a display generated by the
+                  Derivative Works, if and wherever such third-party notices normally
+                  appear. The contents of the NOTICE file are for informational
+                  purposes only and do not modify the License. You may add Your own
+                  attribution notices within Derivative Works that You distribute,
+                  alongside or as an addendum to the NOTICE text from the Work,
+                  provided that such additional attribution notices cannot be
+                  construed as modifying the License.
+        
+              You may add Your own license statement for Your modifications and
+              may provide additional grant of rights to use, copy, modify, merge,
+              publish, distribute, sublicense, and/or sell copies of the
+              Derivative Works, as separate terms and conditions for use,
+              reproduction, or distribution of Your modifications, or for such
+              Derivative Works as a whole.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or reproducing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or exemplary damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or all other
+              commercial damages or losses), even if such Contributor has been
+              advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           Copyright (c) SolarAssistant. All rights reserved.
+        
+Project-URL: Homepage, https://github.com/Solar-Assistant/py_solar_assistant
+Project-URL: Repository, https://github.com/Solar-Assistant/py_solar_assistant
+Project-URL: Issues, https://github.com/Solar-Assistant/py_solar_assistant/issues
+Keywords: solar-assistant,solar,inverter,battery,homeassistant
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9
+Dynamic: license-file
+
+# py_solar_assistant
+
+Python client for SolarAssistant.
+
+## Installation
+
+```bash
+pip install py_solar_assistant
+```
+
+Requires Python 3.12+.
+
+## Cloud API
+
+Interact with the SolarAssistant cloud API. All endpoints require an API key — generate one at [solar-assistant.io/user/edit#api](https://solar-assistant.io/user/edit#api).
+
+```python
+from py_solar_assistant import SolarAssistantClient, list_sites, authorize_site
+
+async with SolarAssistantClient("<api_key>") as client:
+    sites = await list_sites(client)
+```
+
+### List sites
+
+```python
+sites = await list_sites(client)
+```
+
+Filter by inverter, battery, name, and more:
+
+```python
+sites = await list_sites(client, inverter="srne", limit=50, offset=20)
+```
+
+Common filters:
+
+| Key | Example |
+|-----|---------|
+| `name` | `name="my-site"` |
+| `inverter` | `inverter="srne"` |
+| `battery` | `battery="daly"` |
+| `inverter_params_output_power` | `inverter_params_output_power="5000"` |
+| `last_seen_after` | `last_seen_after="2026-01-01"` |
+| `build_date_after` | `build_date_after="2026-02-26"` |
+| `limit` | `limit=50` |
+| `offset` | `offset=20` |
+
+### Authorize a site
+
+Returns a short-lived token and connection details for a site. The token works for both cloud and local connections.
+
+```python
+auth = await authorize_site(client, site_id)
+# auth.host, auth.site_id, auth.site_key, auth.token, auth.local_ip
+```
+
+---
+
+## Device — REST
+
+Read and write metrics directly on a SolarAssistant unit via REST.
+
+### Local connection
+
+```python
+from py_solar_assistant import DeviceClient
+
+async with DeviceClient("192.168.1.100", password="<web-password>") as c:
+    ...
+```
+
+### Cloud-proxied connection
+
+First obtain connection details via [authorize_site](#authorize-a-site):
+
+```python
+async with DeviceClient(
+    auth.host,
+    token=auth.token,
+    site_id=auth.site_id,
+    site_key=auth.site_key,
+    scheme="https",
+) as c:
+    ...
+```
+
+### Read metrics
+
+```python
+# All metrics
+metrics = await c.get_metrics()
+
+# Filtered by topic glob — multiple topics are fetched and deduplicated
+metrics = await c.get_metrics("battery_1/*", "total/pv_power")
+```
+
+### Write a metric
+
+```python
+await c.set_metric("inverter_1/charge_current_limit", "20")
+```
+
+### Standalone functions
+
+For one-off calls without connection reuse:
+
+```python
+from py_solar_assistant import get_device_metrics, set_metric
+
+metrics = await get_device_metrics("192.168.1.100", password="<web-password>")
+await set_metric("192.168.1.100", "inverter_1/charge_current_limit", "20", password="<web-password>")
+```
+
+---
+
+## Device — WebSocket
+
+Stream live metrics via WebSocket.
+
+### Cloud connection
+
+First obtain connection details via [authorize_site](#authorize-a-site):
+
+```python
+import asyncio
+from py_solar_assistant import SolarAssistantClient, authorize_site, connect, Options
+
+async def main():
+    async with SolarAssistantClient("<api_key>") as client:
+        auth = await authorize_site(client, site_id)
+
+    sock = await connect(Options(
+        host=auth.host,
+        token=auth.token,
+        site_id=auth.site_id,
+        site_key=auth.site_key,
+        local_ip=auth.local_ip,  # if set, tries local network first and falls back to cloud
+    ))
+
+    await sock.subscribe_metrics(
+        lambda m: print(f"{m.device}/{m.name} = {m.value} {m.unit}")
+    )
+    try:
+        await sock.listen()  # blocks until disconnected
+    finally:
+        await sock.close()
+
+asyncio.run(main())
+```
+
+### Direct local connection (no cloud)
+
+Connect using the unit's web password, no cloud account required:
+
+```python
+sock = await connect(Options(
+    local_ip="192.168.1.100",
+    password="<web-password>",
+))
+```
+
+### Topic filters
+
+Subscribe to specific topics with optional server-side throttling:
+
+```python
+from py_solar_assistant import TopicFilter
+
+await sock.subscribe_metrics(
+    handler,
+    TopicFilter(topic="total/*"),
+    TopicFilter(topic="inverter_*/load_power"),
+    TopicFilter(topic="battery_*/voltage", max_frequency_s=10),
+)
+```
+
+If no filters are passed the server applies a default set of common metrics:
+
+```
+total/*
+battery_*/voltage
+battery_*/state_of_charge
+battery_*/power
+battery_*/temperature
+inverter_*/pv_power
+inverter_*/load_power
+inverter_*/grid_power
+inverter_*/device_mode
+inverter_*/temperature
+```
+
+Only metrics in groups `Info`, `Status`, and `Settings` are sent.
+
+### Write a setting
+
+Send a setting change over the WebSocket and wait for the result:
+
+```python
+await sock.set_setting("inverter_1/power_mode", "Off grid with relay")
+```
+
+Raises `ValueError` if the device rejects the value.
+
+### Options
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `host` | `str` | Hostname or `host:port` of the cloud proxy. |
+| `token` | `str` | JWT from `authorize_site`. Required for cloud and local-fallback connections. |
+| `password` | `str` | Web password for direct local connections. |
+| `site_id` | `int` | Required for cloud connections. |
+| `site_key` | `str` | Required for cloud connections. |
+| `local_ip` | `str` | If set, tries local network first and falls back to `host`. |
+| `verbose` | `bool` | Log all WebSocket frames to stderr. |
+
+### Advanced: raw channel messages
+
+```python
+sock.subscribe("*", "*", lambda msg: print(msg.topic, msg.event, msg.payload))
+```
+
+## Examples
+
+Runnable scripts are in the [`examples/`](examples/) folder:
+
+| Script | Description |
+|--------|-------------|
+| [`rest_read.py`](examples/rest_read.py) | Fetch all metrics once via REST and print them grouped by device |
+| [`rest_set.py`](examples/rest_set.py) | Write a metric value via REST |
+| [`websocket_read.py`](examples/websocket_read.py) | Stream live metrics via WebSocket until Ctrl+C |
+| [`websocket_set.py`](examples/websocket_set.py) | Write a setting via WebSocket |
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).
+
+This licence covers the Python client library in this repository only. The SolarAssistant platform — including the downloadable device software and cloud infrastructure — is proprietary and distributed under separate terms.