lorawan-connection 0.1.0__tar.gz

lorawan_connection-0.1.0/.gitignore

@@ -0,0 +1,21 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Environments
+.venv/
+.env
+
+# Tooling
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+
+# uv
+uv.lock

lorawan_connection-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

lorawan_connection-0.1.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.5
+Name: lorawan-connection
+Version: 0.1.0
+Summary: Backend-neutral LoRaWAN events and device collections for Python.
+Project-URL: Homepage, https://github.com/home-assistant-libs/lorawan-connection
+Project-URL: Documentation, https://home-assistant-libs.github.io/lorawan-connection/
+Project-URL: Issues, https://github.com/home-assistant-libs/lorawan-connection/issues
+Author: home-assistant-libs
+License: Apache-2.0
+License-File: LICENSE
+Keywords: home-assistant,iot,lorawan
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Hardware
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# lorawan-connection
+
+[Documentation](https://home-assistant-libs.github.io/lorawan-connection/) ·
+[Building a device library](https://home-assistant-libs.github.io/lorawan-connection/patterns/library/) ·
+[Home Assistant integration](https://home-assistant-libs.github.io/lorawan-connection/home-assistant/integration/)
+
+Backend-neutral LoRaWAN events and device collections for Python 3.12+.
+No runtime dependencies.
+
+Feed inventory and live events into a vendor `DeviceCollection`. It creates
+supported models and reports them through device-added callbacks. Consumers then
+observe model state. The caller owns the network connection.
+
+```python
+from lorawan_connection import DeviceCollection, DeviceDescriptor, DeviceEvent
+
+
+class Sensor:
+    def __init__(self, descriptor: DeviceDescriptor) -> None:
+        self.descriptor = descriptor
+
+    def handle_event(self, event: DeviceEvent) -> None:
+        # Interpret events and update typed state here.
+        pass
+
+    def close(self) -> None:
+        # Release model listeners and other model resources here.
+        pass
+
+
+class Sensors(DeviceCollection[Sensor]):
+    def _create_device(self, descriptor: DeviceDescriptor) -> Sensor | None:
+        if descriptor.vendor_id == 123 and descriptor.catalog_model_id == "known-model":
+            return Sensor(descriptor)
+        return None
+
+
+sensors = Sensors("my-network")
+stop = sensors.subscribe_device_added(lambda device: print(device.descriptor.name))
+# Feed all matching events into sensors.handle_event(event).
+# Supported devices appear automatically when their inventory events arrive.
+```
+
+## Install
+
+```sh
+pip install lorawan-connection
+```
+
+For development before the first PyPI publication:
+
+```sh
+git clone https://github.com/home-assistant-libs/lorawan-connection.git
+cd lorawan-connection
+uv sync --group compatibility
+uv run python examples/replay.py
+```
+
+The replay creates a SenseCAP S2101 model and prints 21.4 °C and 31.4% humidity.
+It uses captured bytes and needs no server or Home Assistant installation.
+
+## What ships in 0.1
+
+- Read-only event and payload `Protocol`s. Generated payloads can pass by reference.
+- Immutable descriptors and fixture dataclasses for every supported event payload.
+- A generic `DeviceCollection` with inventory replay, model replacement, and retirement.
+- Synchronous callback helpers with independent, idempotent unsubscribe functions.
+- Typed exports (`py.typed`), a tested SenseCAP example, and Astro/Starlight documentation.
+
+ChirpStack API helpers belong to the Home Assistant LoRaWAN integration. This
+package has no ChirpStack, protobuf, MQTT, or Home Assistant dependency. It does
+not open connections, provision devices, parse QR codes, or provide vendor decoders.
+The SenseCAP implementation under `examples/` illustrates a separate device library.
+
+Events are live notifications. The package does not persist history, reconnect a
+transport, or request replay after a gap. Providers report inventory before activity.
+Collections select models from catalog identity, never from names or payload guesses.
+
+## Library authors and Home Assistant authors
+
+The Building a library guide covers catalog matching, decoding, partial state,
+and model subscriptions. It uses no Home Assistant APIs.
+
+The Home Assistant guide covers provider subscriptions, discovery, config-entry
+lifecycle, and entities that observe library models. The provider API described
+there exists on the linked Core POC branch; it is not yet an upstream HA API.
+
+## Development
+
+```sh
+uv sync --group compatibility
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy
+uv run pytest --cov --cov-report=term-missing
+uv run python examples/replay.py
+cd docs
+npm ci
+npm run build
+```
+
+CI tests Python 3.12, 3.13, and 3.14. Compatibility tests check the payload contracts
+against `chirpstack-api==4.19.0`. This is a development dependency only.
+The documentation build validates internal links and produces `llms.txt`.
+
+The repository follows the packaging, documentation, and release approach of
+[modbus-connection](https://github.com/home-assistant-libs/modbus-connection).
+The source version stays `0.0.0`; the publish workflow sets the version from the
+release tag. See [releasing](RELEASING.md) for the first PyPI release setup.

lorawan_connection-0.1.0/README.md

@@ -0,0 +1,109 @@
+# lorawan-connection
+
+[Documentation](https://home-assistant-libs.github.io/lorawan-connection/) ·
+[Building a device library](https://home-assistant-libs.github.io/lorawan-connection/patterns/library/) ·
+[Home Assistant integration](https://home-assistant-libs.github.io/lorawan-connection/home-assistant/integration/)
+
+Backend-neutral LoRaWAN events and device collections for Python 3.12+.
+No runtime dependencies.
+
+Feed inventory and live events into a vendor `DeviceCollection`. It creates
+supported models and reports them through device-added callbacks. Consumers then
+observe model state. The caller owns the network connection.
+
+```python
+from lorawan_connection import DeviceCollection, DeviceDescriptor, DeviceEvent
+
+
+class Sensor:
+    def __init__(self, descriptor: DeviceDescriptor) -> None:
+        self.descriptor = descriptor
+
+    def handle_event(self, event: DeviceEvent) -> None:
+        # Interpret events and update typed state here.
+        pass
+
+    def close(self) -> None:
+        # Release model listeners and other model resources here.
+        pass
+
+
+class Sensors(DeviceCollection[Sensor]):
+    def _create_device(self, descriptor: DeviceDescriptor) -> Sensor | None:
+        if descriptor.vendor_id == 123 and descriptor.catalog_model_id == "known-model":
+            return Sensor(descriptor)
+        return None
+
+
+sensors = Sensors("my-network")
+stop = sensors.subscribe_device_added(lambda device: print(device.descriptor.name))
+# Feed all matching events into sensors.handle_event(event).
+# Supported devices appear automatically when their inventory events arrive.
+```
+
+## Install
+
+```sh
+pip install lorawan-connection
+```
+
+For development before the first PyPI publication:
+
+```sh
+git clone https://github.com/home-assistant-libs/lorawan-connection.git
+cd lorawan-connection
+uv sync --group compatibility
+uv run python examples/replay.py
+```
+
+The replay creates a SenseCAP S2101 model and prints 21.4 °C and 31.4% humidity.
+It uses captured bytes and needs no server or Home Assistant installation.
+
+## What ships in 0.1
+
+- Read-only event and payload `Protocol`s. Generated payloads can pass by reference.
+- Immutable descriptors and fixture dataclasses for every supported event payload.
+- A generic `DeviceCollection` with inventory replay, model replacement, and retirement.
+- Synchronous callback helpers with independent, idempotent unsubscribe functions.
+- Typed exports (`py.typed`), a tested SenseCAP example, and Astro/Starlight documentation.
+
+ChirpStack API helpers belong to the Home Assistant LoRaWAN integration. This
+package has no ChirpStack, protobuf, MQTT, or Home Assistant dependency. It does
+not open connections, provision devices, parse QR codes, or provide vendor decoders.
+The SenseCAP implementation under `examples/` illustrates a separate device library.
+
+Events are live notifications. The package does not persist history, reconnect a
+transport, or request replay after a gap. Providers report inventory before activity.
+Collections select models from catalog identity, never from names or payload guesses.
+
+## Library authors and Home Assistant authors
+
+The Building a library guide covers catalog matching, decoding, partial state,
+and model subscriptions. It uses no Home Assistant APIs.
+
+The Home Assistant guide covers provider subscriptions, discovery, config-entry
+lifecycle, and entities that observe library models. The provider API described
+there exists on the linked Core POC branch; it is not yet an upstream HA API.
+
+## Development
+
+```sh
+uv sync --group compatibility
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy
+uv run pytest --cov --cov-report=term-missing
+uv run python examples/replay.py
+cd docs
+npm ci
+npm run build
+```
+
+CI tests Python 3.12, 3.13, and 3.14. Compatibility tests check the payload contracts
+against `chirpstack-api==4.19.0`. This is a development dependency only.
+The documentation build validates internal links and produces `llms.txt`.
+
+The repository follows the packaging, documentation, and release approach of
+[modbus-connection](https://github.com/home-assistant-libs/modbus-connection).
+The source version stays `0.0.0`; the publish workflow sets the version from the
+release tag. See [releasing](RELEASING.md) for the first PyPI release setup.

lorawan_connection-0.1.0/RELEASING.md

@@ -0,0 +1,42 @@
+# Releasing
+
+This repository uses the same release-tag versioning and PyPI Trusted Publishing
+workflow as `modbus-connection`. No PyPI token belongs in this repository.
+
+## First release setup
+
+Create a pending publisher in PyPI with these exact values:
+
+| Setting | Value |
+| --- | --- |
+| PyPI project name | `lorawan-connection` |
+| GitHub owner | `home-assistant-libs` |
+| GitHub repository | `lorawan-connection` |
+| Workflow filename | `publish.yml` |
+| Environment | `pypi` |
+
+GitHub Pages uses the `github-pages` environment and the Actions build source.
+Its site is <https://home-assistant-libs.github.io/lorawan-connection/>.
+
+## Publish 0.1.0
+
+1. Check CI and the documentation build for the release commit.
+2. Configure the pending publisher above before publishing the draft release.
+3. Publish the GitHub release with tag `0.1.0`. Use a numeric tag without a `v` prefix.
+4. The workflow replaces source version `0.0.0` with the tag and builds a wheel and sdist.
+5. The `pypi` job publishes those artifacts with GitHub's OIDC identity.
+6. Verify installation with `uv run --with lorawan-connection==0.1.0 --no-project python -c 'import lorawan_connection'`.
+
+A draft release does not trigger publication. If publisher setup is incomplete,
+keep the release as a draft. The workflow also supports manual dispatch with an
+existing tag to retry a release that failed before uploading artifacts to PyPI.
+
+## Build release artifacts locally
+
+```sh
+uv run python script/build_release.py 0.1.0
+```
+
+The script builds from an isolated copy and leaves `pyproject.toml` unchanged.
+It validates a numeric three-part release version. Artifacts appear in `dist/`.
+The release workflow uses the same script.

lorawan_connection-0.1.0/docs/README.md

@@ -0,0 +1,20 @@
+# lorawan-connection documentation
+
+Astro/Starlight documentation, following the modbus-connection site structure.
+
+```sh
+cd docs
+npm ci
+npm run dev
+npm run build
+```
+
+The development site is at `http://localhost:4321/lorawan-connection/`.
+The build checks internal links and heading anchors. It also produces `llms.txt`
+and `llms-full.txt`. GitHub Actions builds every branch and deploys `main` to
+<https://home-assistant-libs.github.io/lorawan-connection/>.
+
+Guides explain design and usage. Reference pages define signatures and behavior.
+**Building a library** contains no HA code. **Home Assistant** explains the
+consumer integration separately and identifies the provider API as a POC.
+The quickstart and device-library pages embed tested source from `examples/`.

lorawan_connection-0.1.0/docs/src/content/docs/connection/events.md

@@ -0,0 +1,79 @@
+---
+title: Ownership and event delivery
+description: How providers deliver descriptors and live events to device libraries.
+---
+
+The application owns the network connection and forwards events to the vendor
+library. Keep endpoints, credentials, and Home Assistant objects in the application.
+
+One collection contains the device models for a logical network. It can span
+several server applications.
+
+## Inventory before activity
+
+A provider sends an `ADDED` event with a descriptor for each existing device when
+a consumer subscribes. The consumer can create models before the first uplink.
+Later, the same feed carries inventory changes and live activity.
+
+| Event | Meaning |
+| --- | --- |
+| `ADDED` | This device is in the subscribed inventory. |
+| `UPDATED` | Its current descriptor replaces the previous descriptor. |
+| `REMOVED` | This device has left the subscribed inventory. |
+| Other event types | Activity for a device already in the inventory. |
+
+Collections ignore activity for an unknown device. A provider that discovers an
+unknown device through activity first refreshes inventory. It sends the descriptor
+before forwarding that activity. It does not guess a model from bytes.
+
+The provider only reports removals after a complete successful inventory refresh.
+A failed page or partial response must not make devices disappear.
+
+## Identity and model selection
+
+Use `(network_id, dev_eui)` as device identity. `network_id` is a stable identifier
+owned by the application. Changing credentials or reconnecting does not change it.
+Descriptors normalize the DevEUI to 16 lowercase hexadecimal characters.
+
+`profile_id` identifies the server profile. Use `catalog_model_id` and `vendor_id`
+to select a supported model. A profile name alone cannot establish model identity.
+
+## Borrowed payloads
+
+`DeviceEvent` and payload types are read-only `Protocol`s. A backend can supply its
+own objects when their fields and meanings match the contract.
+
+A generated ChirpStack uplink satisfies `Uplink`. It does not satisfy the complete
+`DeviceEvent`: the shared envelope also needs a network ID, event kind, and Python
+timestamp. Wrap the payload in `DeviceEventData`; the payload object is not copied.
+
+```python
+from lorawan_connection import DeviceEventData, EventType
+
+# message is an existing generated UplinkEvent from the provider.
+event = DeviceEventData(
+    network_id=network_id,
+    dev_eui=message.device_info.dev_eui,
+    type=EventType.UPLINK,
+    received_at=received_at,
+    data=message,
+)
+assert event.data is message
+```
+
+Protocols do not freeze generated messages. Providers and consumers must not mutate
+a payload after delivery while a consumer can still hold it. Use `EventType` to
+select the payload contract. Overlapping fields cannot identify an event type.
+
+## Live delivery and connection loss
+
+The package does not promise historical replay, durable delivery, or recovery of
+missed events. `received_at` is a timezone-aware receipt timestamp. It is not a
+deduplication key; two updates can have the same timestamp.
+
+Connection loss belongs to the provider subscription. It is not a `REMOVED` event
+for every device. In the HA POC, loss reloads the consumer entry and closes the
+old collection. New setup receives inventory again.
+
+Callbacks run synchronously on the caller's thread or event loop. Do not block,
+perform network I/O, or pass an async callback. The package is not thread-safe.