smpclient 0.1.0__tar.gz

smpclient-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 2023 J.P. Hutchins <jphutchins@gmail.com>
+   Copyright 2023 Intercreate, Inc. <jp@intercreate.io>
+
+   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.

smpclient-0.1.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: smpclient
+Version: 0.1.0
+Summary: Simple Management Protocol (SMP) Client for remotely managing MCU firmware
+License: Apache-2.0
+Author: J.P. Hutchins
+Author-email: jphutchins@gmail.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pyserial (>=3.5,<4.0)
+Requires-Dist: smp (>=0.1.6,<0.2.0)
+Description-Content-Type: text/markdown
+
+# Simple Management Protocol (SMP) Client 
+

smpclient-0.1.0/README.md

@@ -0,0 +1 @@
+# Simple Management Protocol (SMP) Client 

smpclient-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[tool.poetry]
+name = "smpclient"
+version = "0"
+description = "Simple Management Protocol (SMP) Client for remotely managing MCU firmware"
+authors = [
+    "J.P. Hutchins <jphutchins@gmail.com>",
+    "J.P. Hutchins <jp@intercreate.io"
+]
+readme = "README.md"
+license = "Apache-2.0"
+packages = [
+    { include = "smpclient" },
+]
+
+[tool.poetry-version-plugin]
+source = "git-tag"
+
+[tool.poetry.dependencies]
+python = ">=3.10, <3.13"
+smp = "^0.1.6"
+pyserial = "^3.5"
+
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.3"
+pytest-cov = "^4.1.0"
+black = "^23.11.0"
+flake8 = "^6.1.0"
+isort = "^5.12.0"
+mypy = "^1.7.0"
+mypy-extensions = "^1.0.0"
+pytest-xdist = "^3.4.0"
+
+[tool.black]
+line-length = 100
+skip-string-normalization = 1
+
+[tool.isort]
+profile = "black"
+line_length = 100
+multi_line_output = 3
+
+[tool.mypy]
+disallow_untyped_defs = true
+exclude = ['.venv']
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore:The --rsyncdir:DeprecationWarning",
+]

smpclient-0.1.0/smpclient/__init__.py

@@ -0,0 +1,47 @@
+"""Simple Management Protocol (SMP) Client."""
+
+
+from pydantic import ValidationError
+from smp import header as smpheader
+from smp import packet as smppacket
+
+from smpclient.generics import SMPRequest, TEr0, TEr1, TErr, TRep, flatten_error
+from smpclient.transport import SMPTransport
+
+
+class SMPClient:
+    def __init__(self, transport: SMPTransport, address: str):
+        self._transport = transport
+        self._address = address
+
+    async def connect(self) -> None:
+        await self._transport.connect(self._address)
+
+    async def request(self, request: SMPRequest[TRep, TEr0, TEr1, TErr]) -> TRep | TErr:
+        for packet in smppacket.encode(request.BYTES):
+            await self._transport.send(packet)
+
+        decoder = smppacket.decode()
+        next(decoder)
+
+        while True:
+            try:
+                b = await self._transport.readuntil()
+                decoder.send(b)
+            except StopIteration as e:
+                frame = e.value
+                break
+
+        header = smpheader.Header.loads(frame[: smpheader.Header.SIZE])
+
+        if header.sequence != request.header.sequence:  # type: ignore
+            raise Exception("Bad sequence")
+
+        try:
+            return request.Response.loads(frame)  # type: ignore
+        except ValidationError:
+            return flatten_error(  # type: ignore
+                request.ErrorV0.loads(frame)
+                if header.version == smpheader.Version.V0
+                else request.ErrorV1.loads(frame)
+            )

smpclient-0.1.0/smpclient/generics.py

@@ -0,0 +1,83 @@
+"""Some Generic helpers for the SMP module."""
+
+from enum import IntEnum
+from typing import Protocol, Type, TypeGuard, TypeVar
+
+from smp import error as smperror
+from smp import header as smpheader
+from smp import message as smpmessage
+
+TErrEnum = TypeVar("TErrEnum", bound=IntEnum)
+TEr0 = TypeVar("TEr0", bound=smperror.ErrorV0)
+TEr1 = TypeVar("TEr1", bound=smperror.ErrorV1)
+TErr = TypeVar("TErr", bound='SMPError')
+TRep = TypeVar("TRep", bound=smpmessage.ReadResponse | smpmessage.WriteResponse)
+
+
+class SMPError(smperror.ErrorV0[TErrEnum]):
+    """An abstraction on top of SMP that joins and flattens V0 and V1 `Error`s"""
+
+    group: smpheader.GroupId | None = None
+
+
+def _is_ErrorV0(error: TEr0 | TEr1 | TRep) -> TypeGuard[TEr0]:
+    return error.RESPONSE_TYPE == smpmessage.ResponseType.ERROR_V0
+
+
+def _is_ErrorV1(error: TEr0 | TEr1 | TRep) -> TypeGuard[TEr1]:
+    return error.RESPONSE_TYPE == smpmessage.ResponseType.ERROR_V1
+
+
+def flatten_error(
+    error: smperror.ErrorV0[TErrEnum] | smperror.ErrorV1[TErrEnum],
+) -> SMPError[TErrEnum]:
+    """Flatten a `Generic` `ErrorV0` or `ErrorV1` into a `Generic` `SMPError`."""
+    if _is_ErrorV0(error):
+        return SMPError(rc=error.rc, rsn=error.rsn)
+    elif _is_ErrorV1(error):
+        return SMPError(rc=error.err.rc, group=error.err.group)
+    else:
+        raise Exception(f"{error} is not an Error?")
+
+
+class SMPRequest(Protocol[TRep, TEr0, TEr1, TErr]):
+    """A `Protocol` that groups the expected response and errors with a request.
+
+    To use, inherit from an SMP Read or Write `Request` and define its expected
+    `Response`, `ErrorV0`, `ErrorV1`, and `SMPError`.
+
+    Example:
+    ```python
+    class ImageManagementError(SMPError[smpimg.IMG_MGMT_ERR]):
+        _GROUP_ID = smpheader.GroupId.IMAGE_MANAGEMENT
+
+
+    class ImageStatesRead(smpimg.ImageStatesReadRequest):
+        Response = smpimg.ImageStatesReadResponse
+        ErrorV0 = smpimg.ImageManagementError1
+        ErrorV1 = smpimg.ImageManagementError2
+        Error = ImageManagementError
+    ```
+    """
+
+    Response: Type[TRep]
+    ErrorV0: Type[TEr0]
+    ErrorV1: Type[TEr1]
+    Error: Type[TErr]
+
+    @property
+    def BYTES(self) -> bytes:
+        ...
+
+
+def error(response: TErr | TRep) -> TypeGuard[TErr]:
+    """`TypeGuard` that returns `True` if the `response` is an `Error` (including `SMPError`)."""
+    return response.RESPONSE_TYPE in {
+        smpmessage.ResponseType.ERROR_V0,
+        smpmessage.ResponseType.ERROR_V1,
+    }
+
+
+def success(response: TRep | TErr) -> TypeGuard[TRep]:
+    """`TypeGuard` that returns `True` if the `response` is a successful `Response`."""
+    return response.RESPONSE_TYPE == smpmessage.ResponseType.SUCCESS

smpclient-0.1.0/smpclient/requests/image_management.py

@@ -0,0 +1,26 @@
+from smp import header as smpheader
+from smp import image_management as smpimg
+
+from smpclient.generics import SMPError
+
+
+class ImageManagementError(SMPError[smpimg.IMG_MGMT_ERR]):
+    _GROUP_ID = smpheader.GroupId.IMAGE_MANAGEMENT
+
+
+class _ImageGroupBase:
+    ErrorV0 = smpimg.ImageManagementError1
+    ErrorV1 = smpimg.ImageManagementError2
+    Error = ImageManagementError
+
+
+class ImageStatesRead(smpimg.ImageStatesReadRequest, _ImageGroupBase):
+    Response = smpimg.ImageStatesReadResponse
+
+
+class ImageStatesWrite(smpimg.ImageStatesWriteRequest, _ImageGroupBase):
+    Response = smpimg.ImageStatesWriteResponse
+
+
+class ImageUploadWrite(smpimg.ImageUploadWriteRequest, _ImageGroupBase):
+    Response = smpimg.ImageUploadProgressWriteResponse

smpclient-0.1.0/smpclient/requests/os_management.py

@@ -0,0 +1,22 @@
+from smp import header as smpheader
+from smp import os_management as smpos
+
+from smpclient.generics import SMPError
+
+
+class OSManagementError(SMPError):
+    _GROUP_ID = smpheader.GroupId.IMAGE_MANAGEMENT
+
+
+class _OSGroupBase:
+    ErrorV0 = OSManagementError  # TODO: need defs in dependency
+    ErrorV1 = OSManagementError
+    Error = OSManagementError
+
+
+class EchoWrite(smpos.EchoWriteRequest, _OSGroupBase):
+    Response = smpos.EchoWriteResponse
+
+
+class ResetWrite(smpos.ResetWriteRequest, _OSGroupBase):
+    Response = smpos.ResetWriteResponse

smpclient-0.1.0/smpclient/transport/__init__.py

@@ -0,0 +1,17 @@
+"""Simple Management Protocol (SMP) Client Transport Protocol."""
+
+from typing import Protocol
+
+
+class SMPTransport(Protocol):
+    async def connect(self, address: str) -> None:
+        ...
+
+    async def send(self, data: bytes) -> None:
+        ...
+
+    def write(self, data: bytes) -> None:
+        ...
+
+    async def readuntil(self, delimiter: bytes = b"\n") -> bytes:
+        ...

smpclient-0.1.0/smpclient/transport/serial.py

@@ -0,0 +1,49 @@
+"""A serial SMPTransport."""
+
+import asyncio
+
+from serial import Serial  # type: ignore
+
+
+class SMPSerialTransport:
+    _POLLING_INTERVAL_S = 0.005
+
+    def __init__(self) -> None:
+        self._conn = Serial()
+        self._buffer = bytearray([])
+
+    async def connect(self, address: str) -> None:
+        self._conn.port = address
+        self._conn.open()
+
+    def write(self, data: bytes) -> None:
+        self._conn.write(data)
+
+    async def send(self, data: bytes) -> None:
+        self.write(data)
+
+        # fake async until I get around to replacing pyserial
+        while self._conn.out_waiting > 0:
+            await asyncio.sleep(SMPSerialTransport._POLLING_INTERVAL_S)
+
+    async def readuntil(self, delimiter: bytes = b"\n") -> bytes:
+        # fake async until I get around to replacing pyserial
+        while True:
+            # read the entire OS buffer
+            os_buffer = self._conn.read_all()
+
+            # iterate the whole buffer to check for the delimiter
+            for i in range(0, len(os_buffer) - (len(delimiter) - 1)):
+                if os_buffer[i : i + len(delimiter)] == delimiter:
+                    # out is whatever was previously in the buffer plus the
+                    # just read OS buffer including the delimiter
+                    out = self._buffer + os_buffer[: i + len(delimiter)]
+
+                    # there may be some leftover to save for the next read
+                    self._buffer = os_buffer[i + len(delimiter) :]
+
+                    return out
+
+            # delimiter was not reached, save the buffer and wait
+            self._buffer.extend(os_buffer)
+            await asyncio.sleep(SMPSerialTransport._POLLING_INTERVAL_S)