cobs-proto 0.1.0__tar.gz

cobs_proto-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 [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.

cobs_proto-0.1.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: cobs-proto
+Version: 0.1.0
+Summary: Shared COBS+CRC framed protobuf transport for asyncio serial protocols
+Author-email: Richard Lin <richardlin@enphaseenergy.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/enphase/cobs-proto
+Project-URL: Issues, https://github.com/enphase/cobs-proto/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf~=7.0
+Requires-Dist: cobs
+Requires-Dist: mypy
+Provides-Extra: dev
+Requires-Dist: black~=26.0; extra == "dev"
+Requires-Dist: pytest~=9.0; extra == "dev"
+Requires-Dist: pytest-asyncio~=1.0; extra == "dev"
+Requires-Dist: types-protobuf~=7.0; extra == "dev"
+Dynamic: license-file
+
+# cobs-proto
+
+Host-side COBS + CRC framed protobuf transport for asyncio serial protocols.
+
+Provides an `asyncio.Protocol` implementation with request-response structure and optional
+(unrequested) streaming readings.
+
+See the [Rust README](https://github.com/enphase/cobs-proto/blob/main/rust/README.md) for details on the matching device-side implementation.
+See the [top-level README](https://github.com/enphase/cobs-proto) for details on the wire format.
+
+This is a pre-v1 release and API stability is not guaranteed.
+
+
+## Usage
+
+```console
+pip install cobs-proto
+```
+
+```python
+import asyncio
+from cobs_proto import CobsProtoProtocol
+from your_proto import packet_pb2
+
+# Subclass to specify the decoded packet type
+# Request-response only, see CobsProtoStreamingProtocol which adds device streaming data
+class MyProtocol(CobsProtoProtocol[packet_pb2.HostPacket, packet_pb2.DevicePacket]):
+    @staticmethod
+    def _device_packet_type():
+        return packet_pb2.DevicePacket
+
+# Connect (via pyserial-asyncio or similar)
+transport, protocol = await serial_asyncio.create_serial_connection(
+    asyncio.get_running_loop(), lambda: MyProtocol(), port, baudrate=115200,
+)
+
+# Send a request and await the response
+response = await protocol.send_request(packet_pb2.HostPacket(ping=packet_pb2.Ping()))
+```

cobs_proto-0.1.0/README.md

@@ -0,0 +1,39 @@
+# cobs-proto
+
+Host-side COBS + CRC framed protobuf transport for asyncio serial protocols.
+
+Provides an `asyncio.Protocol` implementation with request-response structure and optional
+(unrequested) streaming readings.
+
+See the [Rust README](https://github.com/enphase/cobs-proto/blob/main/rust/README.md) for details on the matching device-side implementation.
+See the [top-level README](https://github.com/enphase/cobs-proto) for details on the wire format.
+
+This is a pre-v1 release and API stability is not guaranteed.
+
+
+## Usage
+
+```console
+pip install cobs-proto
+```
+
+```python
+import asyncio
+from cobs_proto import CobsProtoProtocol
+from your_proto import packet_pb2
+
+# Subclass to specify the decoded packet type
+# Request-response only, see CobsProtoStreamingProtocol which adds device streaming data
+class MyProtocol(CobsProtoProtocol[packet_pb2.HostPacket, packet_pb2.DevicePacket]):
+    @staticmethod
+    def _device_packet_type():
+        return packet_pb2.DevicePacket
+
+# Connect (via pyserial-asyncio or similar)
+transport, protocol = await serial_asyncio.create_serial_connection(
+    asyncio.get_running_loop(), lambda: MyProtocol(), port, baudrate=115200,
+)
+
+# Send a request and await the response
+response = await protocol.send_request(packet_pb2.HostPacket(ping=packet_pb2.Ping()))
+```

cobs_proto-0.1.0/cobs_proto/__init__.py

@@ -0,0 +1,24 @@
+# Copyright 2026 Enphase Energy, Inc.
+#
+#    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.
+
+from .transport import CobsProtoProtocol, CobsProtoStreamingProtocol
+from .testing import encode_device_frame, make_connected_protocol, respond
+
+__all__ = [
+    "CobsProtoProtocol",
+    "CobsProtoStreamingProtocol",
+    "encode_device_frame",
+    "make_connected_protocol",
+    "respond",
+]

cobs_proto-0.1.0/cobs_proto/testing.py

@@ -0,0 +1,55 @@
+# Copyright 2026 Enphase Energy, Inc.
+#
+#    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.
+
+"""Test helpers for COBS+CRC framed asyncio protocols."""
+
+import asyncio
+import binascii
+import struct
+from typing import cast, TypeVar
+from unittest.mock import MagicMock
+
+import cobs.cobs
+from google.protobuf import message as pb_message
+
+TProtocol = TypeVar("TProtocol", bound=asyncio.Protocol)
+
+
+def make_connected_protocol(protocol: TProtocol) -> tuple[TProtocol, MagicMock]:
+    """Wire a mock serial transport to an asyncio Protocol and call connection_made.
+
+    Returns ``(protocol, transport)`` so the caller can inspect writes if needed.
+    """
+    transport = MagicMock(spec=asyncio.Transport)
+    transport.serial = MagicMock()
+    transport.serial.reset_input_buffer = MagicMock()
+    protocol.connection_made(transport)
+    return protocol, transport
+
+
+def encode_device_frame(packet: pb_message.Message) -> bytes:
+    """Encode a protobuf message into a COBS+CRC framed wire packet."""
+    message_bytes = packet.SerializeToString()
+    crc = binascii.crc_hqx(message_bytes, 0)
+    message_with_crc = message_bytes + struct.pack(">H", crc)
+    return cast(bytes, b"\x00" + cobs.cobs.encode(message_with_crc) + b"\x00")
+
+
+async def respond(
+    protocol: asyncio.Protocol,
+    wire_packet: pb_message.Message,
+) -> None:
+    """Wait one event loop turn then feed wire_packet into the protocol."""
+    await asyncio.sleep(0)
+    protocol.data_received(encode_device_frame(wire_packet))

cobs_proto-0.1.0/cobs_proto/transport.py

@@ -0,0 +1,206 @@
+# Copyright 2026 Enphase Energy, Inc.
+#
+#    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.
+
+"""COBS+CRC framed protobuf transport over asyncio serial.
+
+Provides a base class for request/response protocols that use:
+- Protobuf serialization
+- CRC-16/XMODEM integrity
+- COBS byte stuffing with 0x00 frame delimiter
+
+Subclasses specify the concrete protobuf message types and (for streaming
+devices) implement packet classification to route between the response
+future and the streaming queue.
+"""
+
+import abc
+import asyncio
+import binascii
+import logging
+import struct
+from typing import (
+    AsyncIterator,
+    Generic,
+    Optional,
+    Type,
+    TypeVar,
+)
+
+import cobs.cobs
+from google.protobuf import message as pb_message
+
+TWireHostPacket = TypeVar("TWireHostPacket", bound=pb_message.Message)
+TWireDevicePacket = TypeVar("TWireDevicePacket", bound=pb_message.Message)
+
+
+class CobsProtoProtocol(
+    asyncio.Protocol,
+    abc.ABC,
+    Generic[TWireHostPacket, TWireDevicePacket],
+):
+    """Base asyncio.Protocol for COBS+CRC framed protobuf serial communication.
+
+    Only one request may be in flight at a time.
+
+    Type parameters:
+        TWireHostPacket: The protobuf message serialized on the wire to the device.
+        TWireDevicePacket: The protobuf message deserialized from the wire.
+    """
+
+    REQUEST_TIMEOUT = 1.0  # seconds before a pending request is discarded
+
+    # --- Subclass must set these ---
+
+    @staticmethod
+    @abc.abstractmethod
+    def _device_packet_type() -> Type[TWireDevicePacket]:
+        """Return the protobuf class used to deserialize incoming device packets."""
+        ...
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._buffer = bytearray()
+        self._transport: Optional[asyncio.Transport] = None
+        self._pending_response: Optional[asyncio.Future[TWireDevicePacket]] = None
+        self._connected = asyncio.Event()
+
+    def connection_made(self, transport: asyncio.BaseTransport) -> None:
+        assert isinstance(transport, asyncio.Transport)
+        serial = transport.serial  # type: ignore[attr-defined]
+        serial.reset_input_buffer()  # clear any stale pending data in the buffer
+        self._transport = transport
+        self._connected.set()
+
+    def connection_lost(self, exc: Optional[Exception]) -> None:
+        logging.error(f"connection lost: {exc}")
+        self._transport = None
+
+    async def wait_connected(self) -> None:
+        """Block until the serial connection is established."""
+        await self._connected.wait()
+
+    # --- Send side ---
+
+    def _write_message(self, message: pb_message.Message) -> None:
+        if self._transport is None:
+            raise ConnectionError("no connection")
+        message_bytes = message.SerializeToString()
+        crc = binascii.crc_hqx(message_bytes, 0)
+        message_with_crc = message_bytes + struct.pack(">H", crc)
+        cobs_bytes = cobs.cobs.encode(message_with_crc)
+        self._transport.write(b"\x00" + cobs_bytes + b"\x00")
+
+    async def send_request(self, packet: TWireHostPacket) -> TWireDevicePacket:
+        """Send a command and await the response.
+
+        Raises ``asyncio.TimeoutError`` if no response arrives in time.
+        """
+        assert self._pending_response is None, "only one request may be in flight"
+
+        fut: asyncio.Future[TWireDevicePacket] = (
+            asyncio.get_running_loop().create_future()
+        )
+        self._pending_response = fut
+        self._write_message(packet)
+        try:
+            return await asyncio.wait_for(asyncio.shield(fut), self.REQUEST_TIMEOUT)
+        except asyncio.TimeoutError:
+            self._pending_response = None
+            raise
+
+    # --- Receive side ---
+
+    def _dispatch_device_packet(self, packet: TWireDevicePacket) -> None:
+        """Route a decoded device packet to the pending response future.
+
+        Subclasses (e.g. streaming) may override to intercept other
+        messages before delegating to super.
+        """
+        if self._pending_response is not None:
+            fut = self._pending_response
+            self._pending_response = None
+            fut.set_result(packet)
+        else:
+            logging.warning(
+                f"discarding received packet with no pending request: {packet}"
+            )
+
+    def data_received(self, data: bytes) -> None:
+        self._buffer += data
+        split = self._buffer.split(b"\x00")
+        self._buffer = bytearray(split[-1])
+        for serial_bytes in split[:-1]:
+            if not serial_bytes:
+                continue  # skip empty frames
+            try:
+                decoded_bytes = cobs.cobs.decode(serial_bytes)
+                if len(decoded_bytes) < 2:
+                    raise ValueError("Frame too short for CRC")
+                message_bytes = decoded_bytes[:-2]
+                received_crc = struct.unpack(">H", decoded_bytes[-2:])[0]
+                computed_crc = binascii.crc_hqx(message_bytes, 0)
+                if received_crc != computed_crc:
+                    raise ValueError(
+                        f"CRC mismatch: received {received_crc:04x}, computed {computed_crc:04x}"
+                    )
+                packet = self._device_packet_type().FromString(message_bytes)
+            except Exception as e:
+                logging.warning(
+                    f"discarding bad packet: {len(serial_bytes)} bytes, {serial_bytes!r} - {e}"
+                )
+                continue
+            logging.debug(f"received message {packet}")
+
+            self._dispatch_device_packet(packet)
+
+
+class CobsProtoStreamingProtocol(
+    CobsProtoProtocol[TWireHostPacket, TWireDevicePacket],
+    Generic[TWireHostPacket, TWireDevicePacket],
+):
+    """Extension of ``CobsProtoProtocol`` for devices that also send
+    unsolicited streaming packets alongside request/response traffic.
+
+    Subclasses implement ``_is_streaming_packet`` to determine routing:
+    return ``True`` for streaming packets (enqueued for ``iter_readings``),
+    ``False`` for request-response packets (resolved against the pending future).
+
+    The streaming queue holds the full ``TWireDevicePacket``; unpacking
+    is the caller's responsibility.
+    """
+
+    @abc.abstractmethod
+    def _is_streaming_packet(self, packet: TWireDevicePacket) -> bool:
+        """Return ``True`` if the packet is an unsolicited streaming packet,
+        ``False`` if it is a response to a request."""
+        ...
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._reading_queue: asyncio.Queue[TWireDevicePacket] = asyncio.Queue()
+
+    def _dispatch_device_packet(self, packet: TWireDevicePacket) -> None:
+        if self._is_streaming_packet(packet):
+            self._reading_queue.put_nowait(packet)
+        else:
+            super()._dispatch_device_packet(packet)
+
+    async def next_reading(self) -> TWireDevicePacket:
+        """Return the next streaming packet, blocking if none is available."""
+        return await self._reading_queue.get()
+
+    async def iter_readings(self) -> AsyncIterator[TWireDevicePacket]:
+        """Yield streaming packets as they arrive."""
+        while True:
+            yield await self._reading_queue.get()

cobs_proto-0.1.0/cobs_proto.egg-info/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: cobs-proto
+Version: 0.1.0
+Summary: Shared COBS+CRC framed protobuf transport for asyncio serial protocols
+Author-email: Richard Lin <richardlin@enphaseenergy.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/enphase/cobs-proto
+Project-URL: Issues, https://github.com/enphase/cobs-proto/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: protobuf~=7.0
+Requires-Dist: cobs
+Requires-Dist: mypy
+Provides-Extra: dev
+Requires-Dist: black~=26.0; extra == "dev"
+Requires-Dist: pytest~=9.0; extra == "dev"
+Requires-Dist: pytest-asyncio~=1.0; extra == "dev"
+Requires-Dist: types-protobuf~=7.0; extra == "dev"
+Dynamic: license-file
+
+# cobs-proto
+
+Host-side COBS + CRC framed protobuf transport for asyncio serial protocols.
+
+Provides an `asyncio.Protocol` implementation with request-response structure and optional
+(unrequested) streaming readings.
+
+See the [Rust README](https://github.com/enphase/cobs-proto/blob/main/rust/README.md) for details on the matching device-side implementation.
+See the [top-level README](https://github.com/enphase/cobs-proto) for details on the wire format.
+
+This is a pre-v1 release and API stability is not guaranteed.
+
+
+## Usage
+
+```console
+pip install cobs-proto
+```
+
+```python
+import asyncio
+from cobs_proto import CobsProtoProtocol
+from your_proto import packet_pb2
+
+# Subclass to specify the decoded packet type
+# Request-response only, see CobsProtoStreamingProtocol which adds device streaming data
+class MyProtocol(CobsProtoProtocol[packet_pb2.HostPacket, packet_pb2.DevicePacket]):
+    @staticmethod
+    def _device_packet_type():
+        return packet_pb2.DevicePacket
+
+# Connect (via pyserial-asyncio or similar)
+transport, protocol = await serial_asyncio.create_serial_connection(
+    asyncio.get_running_loop(), lambda: MyProtocol(), port, baudrate=115200,
+)
+
+# Send a request and await the response
+response = await protocol.send_request(packet_pb2.HostPacket(ping=packet_pb2.Ping()))
+```

cobs_proto-0.1.0/cobs_proto.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+cobs_proto/__init__.py
+cobs_proto/py.typed
+cobs_proto/testing.py
+cobs_proto/transport.py
+cobs_proto.egg-info/PKG-INFO
+cobs_proto.egg-info/SOURCES.txt
+cobs_proto.egg-info/dependency_links.txt
+cobs_proto.egg-info/requires.txt
+cobs_proto.egg-info/top_level.txt
+tests/test_transport.py

cobs_proto-0.1.0/cobs_proto.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cobs_proto-0.1.0/cobs_proto.egg-info/requires.txt

@@ -0,0 +1,9 @@
+protobuf~=7.0
+cobs
+mypy
+
+[dev]
+black~=26.0
+pytest~=9.0
+pytest-asyncio~=1.0
+types-protobuf~=7.0

cobs_proto-0.1.0/cobs_proto.egg-info/top_level.txt

@@ -0,0 +1 @@
+cobs_proto

cobs_proto-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cobs-proto"
+description = "Shared COBS+CRC framed protobuf transport for asyncio serial protocols"
+version = "0.1.0"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Richard Lin", email = "richardlin@enphaseenergy.com" }
+]
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "protobuf~=7.0",
+    "cobs",
+    "mypy",
+]
+
+[project.urls]
+Homepage = "https://github.com/enphase/cobs-proto"
+Issues = "https://github.com/enphase/cobs-proto/issues"
+
+
+[project.optional-dependencies]
+dev = [
+    "black~=26.0",
+    "pytest~=9.0",
+    "pytest-asyncio~=1.0",
+    "types-protobuf~=7.0",
+]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+strict = true
+
+[[tool.mypy.overrides]]
+module = ["cobs.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["tests.proto.*"]
+ignore_errors = true

cobs_proto-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cobs_proto-0.1.0/tests/test_transport.py

@@ -0,0 +1,204 @@
+# Copyright 2026 Enphase Energy, Inc.
+#
+#    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.
+
+"""Tests for cobs_proto transport using the shared test_packet proto."""
+
+import asyncio
+from pathlib import Path
+from typing import cast
+from unittest.mock import MagicMock
+
+import pytest
+
+from cobs_proto import CobsProtoProtocol, CobsProtoStreamingProtocol
+from cobs_proto import encode_device_frame, make_connected_protocol, respond
+from .proto import test_packet_pb2 as pb
+
+# --- Concrete test protocol subclasses ---
+
+
+class _ExampleProtocol(
+    CobsProtoProtocol[pb.HostPacket, pb.DevicePacket],
+):
+    @staticmethod
+    def _device_packet_type() -> type[pb.DevicePacket]:
+        return pb.DevicePacket
+
+
+class _ExampleStreamingProtocol(
+    CobsProtoStreamingProtocol[pb.HostPacket, pb.DevicePacket],
+):
+    @staticmethod
+    def _device_packet_type() -> type[pb.DevicePacket]:
+        return pb.DevicePacket
+
+    def _is_streaming_packet(self, packet: pb.DevicePacket) -> bool:
+        return packet.HasField("reading")
+
+
+# --- Cross-language golden vectors ---
+# The .bin files are raw golden wire frames shared with the Rust tests.
+
+_VECTORS_DIR = Path(__file__).resolve().parents[2] / "test_proto"
+
+GOLDEN_DEVICE_PACKET = pb.DevicePacket(value_status=pb.ValueStatus(current_value=42))
+GOLDEN_DEVICE_FRAME = (_VECTORS_DIR / "device_value_status_42.bin").read_bytes()
+
+# HostPacket { ping: Ping {} }
+GOLDEN_HOST_FRAME = (_VECTORS_DIR / "host_ping.bin").read_bytes()
+
+
+# --- Wire encoding tests ---
+
+
+class TestWireEncoding:
+    def test_encode_device_frame_matches_golden(self) -> None:
+        """encode_device_frame produces bytes matching the Rust encoder."""
+        assert encode_device_frame(GOLDEN_DEVICE_PACKET) == GOLDEN_DEVICE_FRAME
+
+    def test_encode_host_frame_matches_golden(self) -> None:
+        """_write_message produces bytes matching the Rust encoder."""
+        protocol, transport = make_connected_protocol(_ExampleProtocol())
+        protocol._write_message(pb.HostPacket(ping=pb.Ping()))
+        written = transport.write.call_args[0][0]
+        assert written == GOLDEN_HOST_FRAME
+
+
+# --- Wire decoding tests ---
+
+
+class TestWireDecoding:
+    def test_decode_golden_frame(self) -> None:
+        """data_received correctly decodes the golden device frame."""
+        protocol, _ = make_connected_protocol(_ExampleProtocol())
+        fut = asyncio.get_event_loop().create_future()
+        protocol._pending_response = fut
+        protocol.data_received(GOLDEN_DEVICE_FRAME)
+        assert fut.done()
+        assert fut.result() == GOLDEN_DEVICE_PACKET
+
+    def test_crc_mismatch_discards_packet(self) -> None:
+        """A corrupted frame is silently discarded."""
+        protocol, _ = make_connected_protocol(_ExampleProtocol())
+        fut = asyncio.get_event_loop().create_future()
+        protocol._pending_response = fut
+        corrupted = bytearray(GOLDEN_DEVICE_FRAME)
+        corrupted[3] ^= 0xFF
+        protocol.data_received(bytes(corrupted))
+        assert not fut.done()
+
+    def test_partial_frame_delivery(self) -> None:
+        """A frame split across two data_received calls still decodes."""
+        protocol, _ = make_connected_protocol(_ExampleProtocol())
+        fut = asyncio.get_event_loop().create_future()
+        protocol._pending_response = fut
+        mid = len(GOLDEN_DEVICE_FRAME) // 2
+        protocol.data_received(GOLDEN_DEVICE_FRAME[:mid])
+        assert not fut.done()
+        protocol.data_received(GOLDEN_DEVICE_FRAME[mid:])
+        assert fut.done()
+        assert fut.result() == GOLDEN_DEVICE_PACKET
+
+
+# --- Request-response lifecycle ---
+
+
+class TestRequestResponse:
+    @pytest.mark.asyncio
+    async def test_send_request_and_respond(self) -> None:
+        protocol, _ = make_connected_protocol(_ExampleProtocol())
+
+        result, _ = await asyncio.gather(
+            protocol.send_request(pb.HostPacket(ping=pb.Ping())),
+            respond(protocol, GOLDEN_DEVICE_PACKET),
+        )
+        assert result == GOLDEN_DEVICE_PACKET
+
+    @pytest.mark.asyncio
+    async def test_timeout_on_no_response(self) -> None:
+        protocol, _ = make_connected_protocol(_ExampleProtocol())
+        protocol.REQUEST_TIMEOUT = 0.01
+        with pytest.raises(asyncio.TimeoutError):
+            await protocol.send_request(pb.HostPacket(ping=pb.Ping()))
+        assert protocol._pending_response is None
+
+    @pytest.mark.asyncio
+    async def test_one_in_flight_enforcement(self) -> None:
+        protocol, _ = make_connected_protocol(_ExampleProtocol())
+        asyncio.ensure_future(protocol.send_request(pb.HostPacket(ping=pb.Ping())))
+        await asyncio.sleep(0)
+        with pytest.raises(AssertionError, match="only one request"):
+            await protocol.send_request(pb.HostPacket(ping=pb.Ping()))
+
+    @pytest.mark.asyncio
+    async def test_unrequested_packet_discarded(self) -> None:
+        """A packet with no pending request is discarded (not raised)."""
+        protocol, _ = make_connected_protocol(_ExampleProtocol())
+        protocol.data_received(encode_device_frame(GOLDEN_DEVICE_PACKET))
+
+
+# --- Streaming protocol tests ---
+
+
+class TestStreaming:
+    @pytest.mark.asyncio
+    async def test_streaming_packet_goes_to_queue(self) -> None:
+        protocol, _ = make_connected_protocol(_ExampleStreamingProtocol())
+        reading = pb.DeviceReading(value=42)
+        protocol.data_received(encode_device_frame(pb.DevicePacket(reading=reading)))
+
+        pkt = await asyncio.wait_for(protocol.next_reading(), timeout=0.1)
+        assert pkt.reading == reading
+
+    @pytest.mark.asyncio
+    async def test_response_packet_resolves_future(self) -> None:
+        protocol, _ = make_connected_protocol(_ExampleStreamingProtocol())
+
+        result, _ = await asyncio.gather(
+            protocol.send_request(pb.HostPacket(ping=pb.Ping())),
+            respond(protocol, GOLDEN_DEVICE_PACKET),
+        )
+        assert result == GOLDEN_DEVICE_PACKET
+
+    @pytest.mark.asyncio
+    async def test_interleaved_streaming_and_response(self) -> None:
+        protocol, _ = make_connected_protocol(_ExampleStreamingProtocol())
+        reading = pb.DeviceReading(value=7)
+
+        async def simulate() -> None:
+            await respond(protocol, pb.DevicePacket(reading=reading))
+            await respond(protocol, GOLDEN_DEVICE_PACKET)
+
+        result, _ = await asyncio.gather(
+            protocol.send_request(pb.HostPacket(ping=pb.Ping())),
+            simulate(),
+        )
+        assert result == GOLDEN_DEVICE_PACKET
+
+        pkt = await asyncio.wait_for(protocol.next_reading(), timeout=0.1)
+        assert pkt.reading == reading
+
+    @pytest.mark.asyncio
+    async def test_iter_readings(self) -> None:
+        protocol, _ = make_connected_protocol(_ExampleStreamingProtocol())
+        readings = [pb.DeviceReading(value=i) for i in range(3)]
+        for r in readings:
+            protocol.data_received(encode_device_frame(pb.DevicePacket(reading=r)))
+
+        collected = []
+        async for pkt in protocol.iter_readings():
+            collected.append(pkt.reading)
+            if len(collected) == 3:
+                break
+        assert collected == readings