py20305 0.1.0__tar.gz

py20305-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 a 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 as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   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 redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no 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 consequential 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 any and 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.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 DER Security Corp
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

py20305-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+py20305
+Copyright 2026 DER Security Corp
+
+This product includes software developed at DER Security Corp
+(https://dersec.io).

py20305-0.1.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: py20305
+Version: 0.1.0
+Summary: An open IEEE 2030.5 / CSIP client for distributed energy resources
+License-Expression: Apache-2.0
+Keywords: ieee2030.5,csip,csip-aus,der,sunspec,modbus,smart-grid
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: cryptography>=42.0
+Requires-Dist: pydantic>=2.6
+Requires-Dist: xsdata-pydantic>=24.0
+Requires-Dist: lxml>=5.0
+Provides-Extra: api
+Requires-Dist: fastapi>=0.110; extra == "api"
+Requires-Dist: uvicorn>=0.27; extra == "api"
+Provides-Extra: cli
+Requires-Dist: pyyaml>=6.0; extra == "cli"
+Provides-Extra: sunspec
+Requires-Dist: pysunspec2>=1.3.5; extra == "sunspec"
+Requires-Dist: pyserial>=3.5; extra == "sunspec"
+Provides-Extra: mqtt
+Requires-Dist: aiomqtt>=2.0; extra == "mqtt"
+Provides-Extra: all
+Requires-Dist: py20305[api,cli,mqtt,sunspec]; extra == "all"
+Provides-Extra: docs
+Requires-Dist: mkdocs<2.0,>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material<10,>=9.5; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.26; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: py20305[all,docs]; extra == "dev"
+Requires-Dist: ruff<0.16,>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.9; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: pytest-aiohttp>=1.1; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Requires-Dist: lxml-stubs>=0.5; extra == "dev"
+Requires-Dist: import-linter>=2.0; extra == "dev"
+Requires-Dist: pre-commit>=3.7; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/satori-dark.png">
+    <img src="docs/assets/satori.png" alt="Satori" height="88">
+  </picture>
+</p>
+
+<p align="center">
+  <a href="https://lfenergy.org/"><picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/lf-energy-white.png">
+    <img src="docs/assets/lf-energy-color.png" alt="LF Energy" height="32">
+  </picture></a>
+  &nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://sunspec.org/"><img src="docs/assets/sunspec.png" alt="SunSpec Alliance" height="44"></a>
+  &nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://dersec.io/"><picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/dersec-white.png">
+    <img src="docs/assets/dersec-dark.png" alt="DER Security" height="32">
+  </picture></a>
+</p>
+
+# py20305
+
+**The IEEE 2030.5 / CSIP client of [Project Satori](https://dersec.io/satori)** —
+an LF Energy open-source project led by the SunSpec Alliance, DER Security,
+and industry consortium members.
+
+[![CI](https://github.com/DERSecurity/py20305/actions/workflows/ci.yml/badge.svg)](https://github.com/DERSecurity/py20305/actions/workflows/ci.yml)
+[![Tests](.github/badges/tests.svg)](https://github.com/DERSecurity/py20305/actions/workflows/ci.yml)
+[![Coverage](.github/badges/coverage.svg)](https://github.com/DERSecurity/py20305/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/)
+[![License](https://img.shields.io/github/license/DERSecurity/py20305)](LICENSE)
+[![Project Satori](https://img.shields.io/badge/Project-Satori-b7410e)](https://dersec.io/satori)
+
+An open IEEE 2030.5 client for distributed energy resources, with CSIP-AUS
+support. It speaks the utility's protocol so your device doesn't have to.
+
+Point it at an IEEE 2030.5 server and it registers, discovers what the server
+exposes, runs the DERControl schedule it is given, applies the resulting
+setpoints to a device, and posts telemetry back.
+
+## Install
+
+```bash
+pip install py20305
+```
+
+The base install is the protocol client. Extras add what you may not need:
+`sunspec` for Modbus devices, `api` for the HTTP management API, `mqtt` for
+traffic forwarding, or `all`.
+
+## Running it as a service
+
+```bash
+pip install "py20305[cli,sunspec]"
+py20305 --config client.yaml --check   # validate, print your LFDI
+py20305 --config client.yaml           # run
+```
+
+One YAML or JSON file describes the server, the certificate and the devices. It
+retries the connection while the server is down, registers itself only if the
+server does not already know it, and stops cleanly on SIGTERM. See
+[Running a client](https://dersecurity.github.io/py20305/running/)
+and [`examples/client.example.yaml`](examples/client.example.yaml).
+
+## Running it in a container
+
+```bash
+docker build -t py20305 .
+docker run -d -v "$PWD/config:/etc/py20305:ro" py20305
+```
+
+The image carries the client and nothing else -- configuration and certificates
+are mounted, never baked in. It runs unprivileged and stops in order on
+`SIGTERM`. See [Running in a container](https://dersecurity.github.io/py20305/docker/)
+and [`examples/docker-compose.yml`](examples/docker-compose.yml).
+
+## Embedding it: talking to a server in five minutes
+
+IEEE 2030.5 is mutual TLS throughout, and the server identifies your client by
+its certificate. Your LFDI — the identifier the utility registers — is derived
+from it:
+
+```python
+from pathlib import Path
+from py20305.security import compute_lfdi
+
+print(compute_lfdi(Path("certs/client.pem").read_text()))
+```
+
+Give that to whoever runs the server, then:
+
+```bash
+python examples/quickstart.py \
+  --url https://server.example.com:8443 \
+  --cert certs/client.pem --key certs/client.key --ca certs/ca.pem
+```
+
+That drives the print connector, which needs no hardware — it logs the controls
+it would have applied. So you can exercise the whole discovery, event and
+telemetry path against a real server before an inverter is wired up.
+
+Swap in `SunSpecDeviceConfig` when you have one. Full walkthrough in the
+[quickstart](https://dersecurity.github.io/py20305/quickstart/).
+
+## What's in it
+
+| | |
+|---|---|
+| **Protocol client** | Discovery, registration, mTLS transport, retry with backoff, redirect probing, server timebase |
+| **Event engine** | DERControl five-state machine, supersession across programs, randomized start and duration, `Response` acknowledgments |
+| **Telemetry** | DERStatus, DERCapability, DERSettings, DERAvailability, metered readings as MirrorUsagePoints |
+| **Connectors** | SunSpec Modbus over TCP, RTU and TLS; a no-hardware print connector; your own by subclass or factory |
+| **Subscriptions** | Subscribe/notify as an alternative to polling, with a notification listener |
+| **Runner** | A CLI, config file, connection retry and signal-handled shutdown |
+| **Management API** | Optional HTTP API for observing and nudging a running client |
+| **Forwarding** | Optional MQTT publication of every captured exchange |
+
+## Standards
+
+**IEEE 2030.5-2018 and 2030.5-2023.** Both XSDs ship with the package and
+validation runs against them. The generated bindings track 2023; a
+`server_2018_compat` flag adjusts behavior for servers still on 2018.
+
+**CSIP-AUS**, including DOE (dynamic operating envelope) limits.
+
+The client maps one certificate identity to one end device. It registers and
+drives that device, and does not fan a server-side EndDevice out across several
+local ones.
+
+## Project Satori
+
+*Any certified DER. Any utility program.* Satori — “awakening” — is an
+open-source initiative to make any certified DER a compliant participant in
+utility DER programs: point it at the Modbus port of a UL 1741 SB device —
+inverter, battery, or EV — and it joins a program without a firmware rewrite.
+The bundle builds on SunSpec-certified implementations contributed by
+DER Security, and this repository is its IEEE 2030.5 half:
+
+| Project | Role |
+|---|---|
+| [PySunSpec2](https://github.com/sunspec/pysunspec2) | SunSpec Modbus reference library, used in more than 80% of inverter-based products shipped globally |
+| **py20305** (this repository) | IEEE 2030.5 client stack with CSIP and CSIP-AUS support, and a SunSpec Modbus bridge |
+| SunSpec DevKit CE | Discover, read and identify SunSpec devices on the wire |
+
+## Documentation
+
+<https://dersecurity.github.io/py20305/>
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest tests -q                 # unit tests, no network
+ruff check src tests examples scripts
+mypy
+mkdocs serve                    # docs at http://127.0.0.1:8000
+```
+
+There is also an end-to-end suite that runs this client against
+[envoy](https://github.com/bsgip/envoy), the open-source CSIP-AUS utility
+server from the Australian National University — the implementation ANU's
+certification program runs on. It needs Docker:
+
+```bash
+python scripts/e2e_server.py up
+pytest tests/e2e -v
+python scripts/e2e_server.py down
+```
+
+The unit suite proves this client does what we believe the standard requires.
+That one proves the belief survives contact with an implementation nobody here
+wrote. See [Testing](https://dersecurity.github.io/py20305/testing/).
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).

py20305-0.1.0/README.md

@@ -0,0 +1,179 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/satori-dark.png">
+    <img src="docs/assets/satori.png" alt="Satori" height="88">
+  </picture>
+</p>
+
+<p align="center">
+  <a href="https://lfenergy.org/"><picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/lf-energy-white.png">
+    <img src="docs/assets/lf-energy-color.png" alt="LF Energy" height="32">
+  </picture></a>
+  &nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://sunspec.org/"><img src="docs/assets/sunspec.png" alt="SunSpec Alliance" height="44"></a>
+  &nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://dersec.io/"><picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/dersec-white.png">
+    <img src="docs/assets/dersec-dark.png" alt="DER Security" height="32">
+  </picture></a>
+</p>
+
+# py20305
+
+**The IEEE 2030.5 / CSIP client of [Project Satori](https://dersec.io/satori)** —
+an LF Energy open-source project led by the SunSpec Alliance, DER Security,
+and industry consortium members.
+
+[![CI](https://github.com/DERSecurity/py20305/actions/workflows/ci.yml/badge.svg)](https://github.com/DERSecurity/py20305/actions/workflows/ci.yml)
+[![Tests](.github/badges/tests.svg)](https://github.com/DERSecurity/py20305/actions/workflows/ci.yml)
+[![Coverage](.github/badges/coverage.svg)](https://github.com/DERSecurity/py20305/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/)
+[![License](https://img.shields.io/github/license/DERSecurity/py20305)](LICENSE)
+[![Project Satori](https://img.shields.io/badge/Project-Satori-b7410e)](https://dersec.io/satori)
+
+An open IEEE 2030.5 client for distributed energy resources, with CSIP-AUS
+support. It speaks the utility's protocol so your device doesn't have to.
+
+Point it at an IEEE 2030.5 server and it registers, discovers what the server
+exposes, runs the DERControl schedule it is given, applies the resulting
+setpoints to a device, and posts telemetry back.
+
+## Install
+
+```bash
+pip install py20305
+```
+
+The base install is the protocol client. Extras add what you may not need:
+`sunspec` for Modbus devices, `api` for the HTTP management API, `mqtt` for
+traffic forwarding, or `all`.
+
+## Running it as a service
+
+```bash
+pip install "py20305[cli,sunspec]"
+py20305 --config client.yaml --check   # validate, print your LFDI
+py20305 --config client.yaml           # run
+```
+
+One YAML or JSON file describes the server, the certificate and the devices. It
+retries the connection while the server is down, registers itself only if the
+server does not already know it, and stops cleanly on SIGTERM. See
+[Running a client](https://dersecurity.github.io/py20305/running/)
+and [`examples/client.example.yaml`](examples/client.example.yaml).
+
+## Running it in a container
+
+```bash
+docker build -t py20305 .
+docker run -d -v "$PWD/config:/etc/py20305:ro" py20305
+```
+
+The image carries the client and nothing else -- configuration and certificates
+are mounted, never baked in. It runs unprivileged and stops in order on
+`SIGTERM`. See [Running in a container](https://dersecurity.github.io/py20305/docker/)
+and [`examples/docker-compose.yml`](examples/docker-compose.yml).
+
+## Embedding it: talking to a server in five minutes
+
+IEEE 2030.5 is mutual TLS throughout, and the server identifies your client by
+its certificate. Your LFDI — the identifier the utility registers — is derived
+from it:
+
+```python
+from pathlib import Path
+from py20305.security import compute_lfdi
+
+print(compute_lfdi(Path("certs/client.pem").read_text()))
+```
+
+Give that to whoever runs the server, then:
+
+```bash
+python examples/quickstart.py \
+  --url https://server.example.com:8443 \
+  --cert certs/client.pem --key certs/client.key --ca certs/ca.pem
+```
+
+That drives the print connector, which needs no hardware — it logs the controls
+it would have applied. So you can exercise the whole discovery, event and
+telemetry path against a real server before an inverter is wired up.
+
+Swap in `SunSpecDeviceConfig` when you have one. Full walkthrough in the
+[quickstart](https://dersecurity.github.io/py20305/quickstart/).
+
+## What's in it
+
+| | |
+|---|---|
+| **Protocol client** | Discovery, registration, mTLS transport, retry with backoff, redirect probing, server timebase |
+| **Event engine** | DERControl five-state machine, supersession across programs, randomized start and duration, `Response` acknowledgments |
+| **Telemetry** | DERStatus, DERCapability, DERSettings, DERAvailability, metered readings as MirrorUsagePoints |
+| **Connectors** | SunSpec Modbus over TCP, RTU and TLS; a no-hardware print connector; your own by subclass or factory |
+| **Subscriptions** | Subscribe/notify as an alternative to polling, with a notification listener |
+| **Runner** | A CLI, config file, connection retry and signal-handled shutdown |
+| **Management API** | Optional HTTP API for observing and nudging a running client |
+| **Forwarding** | Optional MQTT publication of every captured exchange |
+
+## Standards
+
+**IEEE 2030.5-2018 and 2030.5-2023.** Both XSDs ship with the package and
+validation runs against them. The generated bindings track 2023; a
+`server_2018_compat` flag adjusts behavior for servers still on 2018.
+
+**CSIP-AUS**, including DOE (dynamic operating envelope) limits.
+
+The client maps one certificate identity to one end device. It registers and
+drives that device, and does not fan a server-side EndDevice out across several
+local ones.
+
+## Project Satori
+
+*Any certified DER. Any utility program.* Satori — “awakening” — is an
+open-source initiative to make any certified DER a compliant participant in
+utility DER programs: point it at the Modbus port of a UL 1741 SB device —
+inverter, battery, or EV — and it joins a program without a firmware rewrite.
+The bundle builds on SunSpec-certified implementations contributed by
+DER Security, and this repository is its IEEE 2030.5 half:
+
+| Project | Role |
+|---|---|
+| [PySunSpec2](https://github.com/sunspec/pysunspec2) | SunSpec Modbus reference library, used in more than 80% of inverter-based products shipped globally |
+| **py20305** (this repository) | IEEE 2030.5 client stack with CSIP and CSIP-AUS support, and a SunSpec Modbus bridge |
+| SunSpec DevKit CE | Discover, read and identify SunSpec devices on the wire |
+
+## Documentation
+
+<https://dersecurity.github.io/py20305/>
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest tests -q                 # unit tests, no network
+ruff check src tests examples scripts
+mypy
+mkdocs serve                    # docs at http://127.0.0.1:8000
+```
+
+There is also an end-to-end suite that runs this client against
+[envoy](https://github.com/bsgip/envoy), the open-source CSIP-AUS utility
+server from the Australian National University — the implementation ANU's
+certification program runs on. It needs Docker:
+
+```bash
+python scripts/e2e_server.py up
+pytest tests/e2e -v
+python scripts/e2e_server.py down
+```
+
+The unit suite proves this client does what we believe the standard requires.
+That one proves the belief survives contact with an implementation nobody here
+wrote. See [Testing](https://dersecurity.github.io/py20305/testing/).
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).