lorawan-connection 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lorawan_connection/__init__.py +53 -0
- lorawan_connection/callbacks.py +36 -0
- lorawan_connection/collection.py +106 -0
- lorawan_connection/events.py +79 -0
- lorawan_connection/payloads.py +165 -0
- lorawan_connection/py.typed +0 -0
- lorawan_connection-0.1.0.dist-info/METADATA +127 -0
- lorawan_connection-0.1.0.dist-info/RECORD +10 -0
- lorawan_connection-0.1.0.dist-info/WHEEL +4 -0
- lorawan_connection-0.1.0.dist-info/licenses/LICENSE +202 -0
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"""Backend-neutral LoRaWAN events and device collections."""
|
|
2
|
+
|
|
3
|
+
from .callbacks import Unsubscribe, notify, subscribe
|
|
4
|
+
from .collection import Device, DeviceCollection
|
|
5
|
+
from .events import DeviceDescriptor, DeviceEvent, DeviceEventData, EventType
|
|
6
|
+
from .payloads import (
|
|
7
|
+
Ack,
|
|
8
|
+
AckData,
|
|
9
|
+
Coordinates,
|
|
10
|
+
CoordinatesData,
|
|
11
|
+
Join,
|
|
12
|
+
JoinData,
|
|
13
|
+
Location,
|
|
14
|
+
LocationData,
|
|
15
|
+
Log,
|
|
16
|
+
LogData,
|
|
17
|
+
Payload,
|
|
18
|
+
Status,
|
|
19
|
+
StatusData,
|
|
20
|
+
TxAck,
|
|
21
|
+
TxAckData,
|
|
22
|
+
Uplink,
|
|
23
|
+
UplinkData,
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
__all__ = [
|
|
27
|
+
"Ack",
|
|
28
|
+
"AckData",
|
|
29
|
+
"Coordinates",
|
|
30
|
+
"CoordinatesData",
|
|
31
|
+
"Device",
|
|
32
|
+
"DeviceCollection",
|
|
33
|
+
"DeviceDescriptor",
|
|
34
|
+
"DeviceEvent",
|
|
35
|
+
"DeviceEventData",
|
|
36
|
+
"EventType",
|
|
37
|
+
"Join",
|
|
38
|
+
"JoinData",
|
|
39
|
+
"Location",
|
|
40
|
+
"LocationData",
|
|
41
|
+
"Log",
|
|
42
|
+
"LogData",
|
|
43
|
+
"Payload",
|
|
44
|
+
"Status",
|
|
45
|
+
"StatusData",
|
|
46
|
+
"TxAck",
|
|
47
|
+
"TxAckData",
|
|
48
|
+
"Unsubscribe",
|
|
49
|
+
"Uplink",
|
|
50
|
+
"UplinkData",
|
|
51
|
+
"notify",
|
|
52
|
+
"subscribe",
|
|
53
|
+
]
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"""Synchronous subscriptions for collections and model state."""
|
|
2
|
+
|
|
3
|
+
import logging
|
|
4
|
+
from collections.abc import Callable
|
|
5
|
+
|
|
6
|
+
type Unsubscribe = Callable[[], None]
|
|
7
|
+
|
|
8
|
+
_LOGGER = logging.getLogger(__name__)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def notify[T](listeners: list[Callable[[T], None]], value: T) -> None:
|
|
12
|
+
"""Call current listeners, isolating failures and allowing unsubscribe."""
|
|
13
|
+
for listener in tuple(listeners):
|
|
14
|
+
if listener not in listeners:
|
|
15
|
+
continue
|
|
16
|
+
try:
|
|
17
|
+
listener(value)
|
|
18
|
+
except Exception:
|
|
19
|
+
_LOGGER.exception("LoRaWAN listener failed")
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
def subscribe[T](
|
|
23
|
+
listeners: list[Callable[[T], None]], callback: Callable[[T], None]
|
|
24
|
+
) -> Unsubscribe:
|
|
25
|
+
"""Register one subscription and return its idempotent cleanup function."""
|
|
26
|
+
|
|
27
|
+
def listener(value: T) -> None:
|
|
28
|
+
callback(value)
|
|
29
|
+
|
|
30
|
+
listeners.append(listener)
|
|
31
|
+
|
|
32
|
+
def unsubscribe() -> None:
|
|
33
|
+
if listener in listeners:
|
|
34
|
+
listeners.remove(listener)
|
|
35
|
+
|
|
36
|
+
return unsubscribe
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
"""Create and retire device models from an inventory and live event feed."""
|
|
2
|
+
|
|
3
|
+
import logging
|
|
4
|
+
from collections.abc import Callable
|
|
5
|
+
from typing import Protocol
|
|
6
|
+
|
|
7
|
+
from .callbacks import Unsubscribe, notify, subscribe
|
|
8
|
+
from .events import DeviceDescriptor, DeviceEvent, EventType
|
|
9
|
+
|
|
10
|
+
_LOGGER = logging.getLogger(__name__)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class Device(Protocol):
|
|
14
|
+
"""Minimal model lifecycle required by a collection."""
|
|
15
|
+
|
|
16
|
+
descriptor: DeviceDescriptor
|
|
17
|
+
|
|
18
|
+
def handle_event(self, event: DeviceEvent) -> None: ...
|
|
19
|
+
|
|
20
|
+
def close(self) -> None: ...
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class DeviceCollection[DeviceT: Device]:
|
|
24
|
+
"""Create vendor models from inventory, then route their live events."""
|
|
25
|
+
|
|
26
|
+
def __init__(self, network_id: str) -> None:
|
|
27
|
+
"""Own models for exactly one logical network."""
|
|
28
|
+
self.network_id = network_id
|
|
29
|
+
self.devices: dict[str, DeviceT] = {}
|
|
30
|
+
self._added: list[Callable[[DeviceT], None]] = []
|
|
31
|
+
self._removed: list[Callable[[DeviceT], None]] = []
|
|
32
|
+
self._closed = False
|
|
33
|
+
|
|
34
|
+
def _create_device(self, descriptor: DeviceDescriptor) -> DeviceT | None:
|
|
35
|
+
raise NotImplementedError
|
|
36
|
+
|
|
37
|
+
def subscribe_device_added(
|
|
38
|
+
self, callback: Callable[[DeviceT], None]
|
|
39
|
+
) -> Unsubscribe:
|
|
40
|
+
"""Report existing models immediately, then future additions."""
|
|
41
|
+
if self._closed:
|
|
42
|
+
raise RuntimeError("Device collection is closed")
|
|
43
|
+
stop = subscribe(self._added, callback)
|
|
44
|
+
for device in tuple(self.devices.values()):
|
|
45
|
+
if self.devices.get(device.descriptor.dev_eui) is device:
|
|
46
|
+
notify([callback], device)
|
|
47
|
+
return stop
|
|
48
|
+
|
|
49
|
+
def subscribe_device_removed(
|
|
50
|
+
self, callback: Callable[[DeviceT], None]
|
|
51
|
+
) -> Unsubscribe:
|
|
52
|
+
"""Listen for model retirement."""
|
|
53
|
+
if self._closed:
|
|
54
|
+
raise RuntimeError("Device collection is closed")
|
|
55
|
+
return subscribe(self._removed, callback)
|
|
56
|
+
|
|
57
|
+
def _remove(self, dev_eui: str) -> None:
|
|
58
|
+
if (device := self.devices.pop(dev_eui, None)) is not None:
|
|
59
|
+
try:
|
|
60
|
+
device.close()
|
|
61
|
+
except Exception:
|
|
62
|
+
_LOGGER.exception("LoRaWAN device cleanup failed")
|
|
63
|
+
notify(self._removed, device)
|
|
64
|
+
|
|
65
|
+
def handle_event(self, event: DeviceEvent) -> None:
|
|
66
|
+
"""Consume descriptors before activity, never infer a model from data."""
|
|
67
|
+
if self._closed or event.network_id != self.network_id:
|
|
68
|
+
return
|
|
69
|
+
eui = event.dev_eui.replace(":", "").lower()
|
|
70
|
+
if event.type == EventType.REMOVED:
|
|
71
|
+
self._remove(eui)
|
|
72
|
+
return
|
|
73
|
+
device = self.devices.get(eui)
|
|
74
|
+
if event.type in (EventType.ADDED, EventType.UPDATED):
|
|
75
|
+
descriptor = event.descriptor
|
|
76
|
+
if (
|
|
77
|
+
descriptor is None
|
|
78
|
+
or descriptor.network_id != self.network_id
|
|
79
|
+
or descriptor.dev_eui != eui
|
|
80
|
+
):
|
|
81
|
+
return
|
|
82
|
+
if device is not None and (
|
|
83
|
+
device.descriptor.catalog_model_id,
|
|
84
|
+
device.descriptor.vendor_id,
|
|
85
|
+
) != (descriptor.catalog_model_id, descriptor.vendor_id):
|
|
86
|
+
self._remove(eui)
|
|
87
|
+
if self._closed:
|
|
88
|
+
return
|
|
89
|
+
device = None
|
|
90
|
+
if device is None:
|
|
91
|
+
if (device := self._create_device(descriptor)) is None:
|
|
92
|
+
return
|
|
93
|
+
self.devices[eui] = device
|
|
94
|
+
notify(self._added, device)
|
|
95
|
+
else:
|
|
96
|
+
device.descriptor = descriptor
|
|
97
|
+
if device is not None and self.devices.get(eui) is device:
|
|
98
|
+
device.handle_event(event)
|
|
99
|
+
|
|
100
|
+
def close(self) -> None:
|
|
101
|
+
"""Retire all models and listeners; repeated calls are harmless."""
|
|
102
|
+
self._closed = True
|
|
103
|
+
for eui in tuple(self.devices):
|
|
104
|
+
self._remove(eui)
|
|
105
|
+
self._added.clear()
|
|
106
|
+
self._removed.clear()
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
"""Read-only event contracts and concrete inventory fixtures."""
|
|
2
|
+
|
|
3
|
+
from dataclasses import dataclass
|
|
4
|
+
from datetime import datetime
|
|
5
|
+
from enum import StrEnum
|
|
6
|
+
from typing import Protocol
|
|
7
|
+
|
|
8
|
+
from .payloads import Payload
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class EventType(StrEnum):
|
|
12
|
+
"""Inventory and live activity types."""
|
|
13
|
+
|
|
14
|
+
ADDED = "added"
|
|
15
|
+
UPDATED = "updated"
|
|
16
|
+
REMOVED = "removed"
|
|
17
|
+
UPLINK = "up"
|
|
18
|
+
JOIN = "join"
|
|
19
|
+
STATUS = "status"
|
|
20
|
+
ACK = "ack"
|
|
21
|
+
TX_ACK = "txack"
|
|
22
|
+
LOG = "log"
|
|
23
|
+
LOCATION = "location"
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
@dataclass(frozen=True, slots=True)
|
|
27
|
+
class DeviceDescriptor:
|
|
28
|
+
"""Catalog identity and current inventory metadata."""
|
|
29
|
+
|
|
30
|
+
network_id: str
|
|
31
|
+
dev_eui: str
|
|
32
|
+
name: str
|
|
33
|
+
application_id: str
|
|
34
|
+
profile_id: str
|
|
35
|
+
catalog_model_id: str = ""
|
|
36
|
+
vendor_id: int | None = None
|
|
37
|
+
model: str = ""
|
|
38
|
+
manufacturer: str = ""
|
|
39
|
+
|
|
40
|
+
def __post_init__(self) -> None:
|
|
41
|
+
"""Normalize and validate device identity."""
|
|
42
|
+
eui = self.dev_eui.replace(":", "").lower()
|
|
43
|
+
if len(eui) != 16 or any(c not in "0123456789abcdef" for c in eui):
|
|
44
|
+
raise ValueError("DevEUI must contain exactly eight hexadecimal bytes")
|
|
45
|
+
object.__setattr__(self, "dev_eui", eui)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
class DeviceEvent(Protocol):
|
|
49
|
+
"""Borrowed read-only event; payload remains owned by the producer."""
|
|
50
|
+
|
|
51
|
+
@property
|
|
52
|
+
def network_id(self) -> str: ...
|
|
53
|
+
|
|
54
|
+
@property
|
|
55
|
+
def dev_eui(self) -> str: ...
|
|
56
|
+
|
|
57
|
+
@property
|
|
58
|
+
def type(self) -> EventType: ...
|
|
59
|
+
|
|
60
|
+
@property
|
|
61
|
+
def received_at(self) -> datetime: ...
|
|
62
|
+
|
|
63
|
+
@property
|
|
64
|
+
def descriptor(self) -> DeviceDescriptor | None: ...
|
|
65
|
+
|
|
66
|
+
@property
|
|
67
|
+
def data(self) -> Payload | None: ...
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
@dataclass(frozen=True, slots=True)
|
|
71
|
+
class DeviceEventData:
|
|
72
|
+
"""Lightweight envelope for generated payloads and test fixtures."""
|
|
73
|
+
|
|
74
|
+
network_id: str
|
|
75
|
+
dev_eui: str
|
|
76
|
+
type: EventType
|
|
77
|
+
received_at: datetime
|
|
78
|
+
descriptor: DeviceDescriptor | None = None
|
|
79
|
+
data: Payload | None = None
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
"""Read-only structural payload contracts, with no protobuf dependency.
|
|
2
|
+
|
|
3
|
+
EventType is the discriminator. Protocols are deliberately not runtime-checkable:
|
|
4
|
+
several payloads share fields. A backend owns values and must not mutate them
|
|
5
|
+
while consumers hold references. Proto3 scalar defaults remain scalar defaults;
|
|
6
|
+
for example battery_level_unavailable determines whether a battery value exists.
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
from dataclasses import dataclass
|
|
10
|
+
from typing import Protocol
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class Uplink(Protocol):
|
|
14
|
+
"""Raw application payload, independent of backend codecs."""
|
|
15
|
+
|
|
16
|
+
@property
|
|
17
|
+
def data(self) -> bytes: ...
|
|
18
|
+
|
|
19
|
+
@property
|
|
20
|
+
def f_port(self) -> int: ...
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class Join(Protocol):
|
|
24
|
+
"""Device joined the network."""
|
|
25
|
+
|
|
26
|
+
@property
|
|
27
|
+
def dev_addr(self) -> str: ...
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
class Status(Protocol):
|
|
31
|
+
"""LoRaWAN status with explicit battery presence semantics."""
|
|
32
|
+
|
|
33
|
+
@property
|
|
34
|
+
def margin(self) -> int: ...
|
|
35
|
+
|
|
36
|
+
@property
|
|
37
|
+
def external_power_source(self) -> bool: ...
|
|
38
|
+
|
|
39
|
+
@property
|
|
40
|
+
def battery_level_unavailable(self) -> bool: ...
|
|
41
|
+
|
|
42
|
+
@property
|
|
43
|
+
def battery_level(self) -> float: ...
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
class Ack(Protocol):
|
|
47
|
+
"""Device acknowledgement of a queued downlink."""
|
|
48
|
+
|
|
49
|
+
@property
|
|
50
|
+
def queue_item_id(self) -> str: ...
|
|
51
|
+
|
|
52
|
+
@property
|
|
53
|
+
def acknowledged(self) -> bool: ...
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
class TxAck(Protocol):
|
|
57
|
+
"""Gateway acknowledgement of transmission."""
|
|
58
|
+
|
|
59
|
+
@property
|
|
60
|
+
def gateway_id(self) -> str: ...
|
|
61
|
+
|
|
62
|
+
@property
|
|
63
|
+
def downlink_id(self) -> int: ...
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
class Log(Protocol):
|
|
67
|
+
"""Device log message with numeric level and code."""
|
|
68
|
+
|
|
69
|
+
@property
|
|
70
|
+
def description(self) -> str: ...
|
|
71
|
+
|
|
72
|
+
@property
|
|
73
|
+
def level(self) -> int: ...
|
|
74
|
+
|
|
75
|
+
@property
|
|
76
|
+
def code(self) -> int: ...
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
class Coordinates(Protocol):
|
|
80
|
+
"""Location estimate."""
|
|
81
|
+
|
|
82
|
+
@property
|
|
83
|
+
def latitude(self) -> float: ...
|
|
84
|
+
|
|
85
|
+
@property
|
|
86
|
+
def longitude(self) -> float: ...
|
|
87
|
+
|
|
88
|
+
@property
|
|
89
|
+
def altitude(self) -> float: ...
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
class Location(Protocol):
|
|
93
|
+
"""Location event with a nested read-only view."""
|
|
94
|
+
|
|
95
|
+
@property
|
|
96
|
+
def location(self) -> Coordinates: ...
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
type Payload = Uplink | Join | Status | Ack | TxAck | Log | Location
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
@dataclass(frozen=True, slots=True)
|
|
103
|
+
class UplinkData:
|
|
104
|
+
"""Uplink fixture without a backend dependency."""
|
|
105
|
+
|
|
106
|
+
data: bytes
|
|
107
|
+
f_port: int = 1
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
@dataclass(frozen=True, slots=True)
|
|
111
|
+
class StatusData:
|
|
112
|
+
"""Status fixture preserving the battery-unavailable flag."""
|
|
113
|
+
|
|
114
|
+
margin: int = 0
|
|
115
|
+
external_power_source: bool = False
|
|
116
|
+
battery_level_unavailable: bool = True
|
|
117
|
+
battery_level: float = 0
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
@dataclass(frozen=True, slots=True)
|
|
121
|
+
class JoinData:
|
|
122
|
+
"""Join fixture."""
|
|
123
|
+
|
|
124
|
+
dev_addr: str
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
@dataclass(frozen=True, slots=True)
|
|
128
|
+
class AckData:
|
|
129
|
+
"""Downlink acknowledgement fixture."""
|
|
130
|
+
|
|
131
|
+
queue_item_id: str
|
|
132
|
+
acknowledged: bool
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
@dataclass(frozen=True, slots=True)
|
|
136
|
+
class TxAckData:
|
|
137
|
+
"""Gateway transmission acknowledgement fixture."""
|
|
138
|
+
|
|
139
|
+
gateway_id: str
|
|
140
|
+
downlink_id: int
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
@dataclass(frozen=True, slots=True)
|
|
144
|
+
class LogData:
|
|
145
|
+
"""Device log fixture; level and code retain backend numeric values."""
|
|
146
|
+
|
|
147
|
+
description: str
|
|
148
|
+
level: int
|
|
149
|
+
code: int
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
@dataclass(frozen=True, slots=True)
|
|
153
|
+
class CoordinatesData:
|
|
154
|
+
"""Location coordinates fixture."""
|
|
155
|
+
|
|
156
|
+
latitude: float
|
|
157
|
+
longitude: float
|
|
158
|
+
altitude: float
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
@dataclass(frozen=True, slots=True)
|
|
162
|
+
class LocationData:
|
|
163
|
+
"""Location fixture containing a borrowed coordinates object."""
|
|
164
|
+
|
|
165
|
+
location: Coordinates
|
|
File without changes
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: lorawan-connection
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Backend-neutral LoRaWAN events and device collections for Python.
|
|
5
|
+
Project-URL: Homepage, https://github.com/home-assistant-libs/lorawan-connection
|
|
6
|
+
Project-URL: Documentation, https://home-assistant-libs.github.io/lorawan-connection/
|
|
7
|
+
Project-URL: Issues, https://github.com/home-assistant-libs/lorawan-connection/issues
|
|
8
|
+
Author: home-assistant-libs
|
|
9
|
+
License: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: home-assistant,iot,lorawan
|
|
12
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Topic :: System :: Hardware
|
|
15
|
+
Classifier: Typing :: Typed
|
|
16
|
+
Requires-Python: >=3.12
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
|
|
19
|
+
# lorawan-connection
|
|
20
|
+
|
|
21
|
+
[Documentation](https://home-assistant-libs.github.io/lorawan-connection/) ·
|
|
22
|
+
[Building a device library](https://home-assistant-libs.github.io/lorawan-connection/patterns/library/) ·
|
|
23
|
+
[Home Assistant integration](https://home-assistant-libs.github.io/lorawan-connection/home-assistant/integration/)
|
|
24
|
+
|
|
25
|
+
Backend-neutral LoRaWAN events and device collections for Python 3.12+.
|
|
26
|
+
No runtime dependencies.
|
|
27
|
+
|
|
28
|
+
Feed inventory and live events into a vendor `DeviceCollection`. It creates
|
|
29
|
+
supported models and reports them through device-added callbacks. Consumers then
|
|
30
|
+
observe model state. The caller owns the network connection.
|
|
31
|
+
|
|
32
|
+
```python
|
|
33
|
+
from lorawan_connection import DeviceCollection, DeviceDescriptor, DeviceEvent
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class Sensor:
|
|
37
|
+
def __init__(self, descriptor: DeviceDescriptor) -> None:
|
|
38
|
+
self.descriptor = descriptor
|
|
39
|
+
|
|
40
|
+
def handle_event(self, event: DeviceEvent) -> None:
|
|
41
|
+
# Interpret events and update typed state here.
|
|
42
|
+
pass
|
|
43
|
+
|
|
44
|
+
def close(self) -> None:
|
|
45
|
+
# Release model listeners and other model resources here.
|
|
46
|
+
pass
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
class Sensors(DeviceCollection[Sensor]):
|
|
50
|
+
def _create_device(self, descriptor: DeviceDescriptor) -> Sensor | None:
|
|
51
|
+
if descriptor.vendor_id == 123 and descriptor.catalog_model_id == "known-model":
|
|
52
|
+
return Sensor(descriptor)
|
|
53
|
+
return None
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
sensors = Sensors("my-network")
|
|
57
|
+
stop = sensors.subscribe_device_added(lambda device: print(device.descriptor.name))
|
|
58
|
+
# Feed all matching events into sensors.handle_event(event).
|
|
59
|
+
# Supported devices appear automatically when their inventory events arrive.
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Install
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
pip install lorawan-connection
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
For development before the first PyPI publication:
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
git clone https://github.com/home-assistant-libs/lorawan-connection.git
|
|
72
|
+
cd lorawan-connection
|
|
73
|
+
uv sync --group compatibility
|
|
74
|
+
uv run python examples/replay.py
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
The replay creates a SenseCAP S2101 model and prints 21.4 °C and 31.4% humidity.
|
|
78
|
+
It uses captured bytes and needs no server or Home Assistant installation.
|
|
79
|
+
|
|
80
|
+
## What ships in 0.1
|
|
81
|
+
|
|
82
|
+
- Read-only event and payload `Protocol`s. Generated payloads can pass by reference.
|
|
83
|
+
- Immutable descriptors and fixture dataclasses for every supported event payload.
|
|
84
|
+
- A generic `DeviceCollection` with inventory replay, model replacement, and retirement.
|
|
85
|
+
- Synchronous callback helpers with independent, idempotent unsubscribe functions.
|
|
86
|
+
- Typed exports (`py.typed`), a tested SenseCAP example, and Astro/Starlight documentation.
|
|
87
|
+
|
|
88
|
+
ChirpStack API helpers belong to the Home Assistant LoRaWAN integration. This
|
|
89
|
+
package has no ChirpStack, protobuf, MQTT, or Home Assistant dependency. It does
|
|
90
|
+
not open connections, provision devices, parse QR codes, or provide vendor decoders.
|
|
91
|
+
The SenseCAP implementation under `examples/` illustrates a separate device library.
|
|
92
|
+
|
|
93
|
+
Events are live notifications. The package does not persist history, reconnect a
|
|
94
|
+
transport, or request replay after a gap. Providers report inventory before activity.
|
|
95
|
+
Collections select models from catalog identity, never from names or payload guesses.
|
|
96
|
+
|
|
97
|
+
## Library authors and Home Assistant authors
|
|
98
|
+
|
|
99
|
+
The Building a library guide covers catalog matching, decoding, partial state,
|
|
100
|
+
and model subscriptions. It uses no Home Assistant APIs.
|
|
101
|
+
|
|
102
|
+
The Home Assistant guide covers provider subscriptions, discovery, config-entry
|
|
103
|
+
lifecycle, and entities that observe library models. The provider API described
|
|
104
|
+
there exists on the linked Core POC branch; it is not yet an upstream HA API.
|
|
105
|
+
|
|
106
|
+
## Development
|
|
107
|
+
|
|
108
|
+
```sh
|
|
109
|
+
uv sync --group compatibility
|
|
110
|
+
uv run ruff check .
|
|
111
|
+
uv run ruff format --check .
|
|
112
|
+
uv run mypy
|
|
113
|
+
uv run pytest --cov --cov-report=term-missing
|
|
114
|
+
uv run python examples/replay.py
|
|
115
|
+
cd docs
|
|
116
|
+
npm ci
|
|
117
|
+
npm run build
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
CI tests Python 3.12, 3.13, and 3.14. Compatibility tests check the payload contracts
|
|
121
|
+
against `chirpstack-api==4.19.0`. This is a development dependency only.
|
|
122
|
+
The documentation build validates internal links and produces `llms.txt`.
|
|
123
|
+
|
|
124
|
+
The repository follows the packaging, documentation, and release approach of
|
|
125
|
+
[modbus-connection](https://github.com/home-assistant-libs/modbus-connection).
|
|
126
|
+
The source version stays `0.0.0`; the publish workflow sets the version from the
|
|
127
|
+
release tag. See [releasing](RELEASING.md) for the first PyPI release setup.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
lorawan_connection/__init__.py,sha256=IaqvzVY8mrvRZgB2pdfauMKBFuaRnSv2BLMIsBOeIaU,955
|
|
2
|
+
lorawan_connection/callbacks.py,sha256=0O0upOGDjMCqMQ2rw8mqxcP_cm9EAluEoQNe0EwmuRE,981
|
|
3
|
+
lorawan_connection/collection.py,sha256=C_eMBI2HbE3TAomku3lMkf78a9I1hEKtkeQgu3w2m1Q,3873
|
|
4
|
+
lorawan_connection/events.py,sha256=6aLw67LfuF2LrBYZHp9iFkPKxxPckY2ynp7TnayuLeM,1917
|
|
5
|
+
lorawan_connection/payloads.py,sha256=GPns7qWtw8ESd18oxj44pfudVh4zBmLnzJbkQITCmWw,3409
|
|
6
|
+
lorawan_connection/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
7
|
+
lorawan_connection-0.1.0.dist-info/METADATA,sha256=4S1eHnnkWQnmahzQll0u8TbdwxyjqfJ6U8vOkWu-I4c,5016
|
|
8
|
+
lorawan_connection-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
|
|
9
|
+
lorawan_connection-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
|
|
10
|
+
lorawan_connection-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|