Simple Management Protocol (SMP) Client

smpclient implements the transport layer of the Simple Management Protocol. This library can be used as a dependency in applications that use SMP over serial (UART or USB), Bluetooth (BLE), or UDP connections. Some abstractions are provided for common routines like upgrading device firmware.

If you don't need a library with the transport layer implemented, then you might prefer to use smp instead. The SMP specification can be found here.

If you'd like an SMP CLI application instead of a library, then you should try smpmgr.

Install

smpclient is distributed by PyPI and can be installed with poetry, pip, and other dependency managers.

User Documentation

Documentation is in the source code so that it is available to your editor. An online version is generated and available here.

Development Quickstart

Assumes that you've already setup your development environment.

activate envr, the environment manager for bash, zsh, and PS:
```
. ./envr.ps1
```
run poetry install when pulling in new changes
run lint after making changes
run test after making changes
add library dependencies with poetry:
```
poetry add <my_new_dependency>
```
add test or other development dependencies using poetry groups:
```
poetry add -G dev <my_dev_dependency>
```
run tests for all supported python versions:
```
tox
```

Development Environment Setup

Install Dependencies

poetry: https://python-poetry.org/docs/#installation

Create the venv

poetry install

The venv should be installed to .venv.

Activate envr

envr supports bash, zsh, and PS in Linux, MacOS, and Windows. If you are using an unsupported shell, you can activate the .venv environment manually, use poetry run and poetry shell, and refer to envr-default for useful aliases.

. ./envr.ps1

Verify Your Setup

To verify the installation, make sure that all of the tests are passing using these envr aliases:

lint
test

Enable the githooks

The pre-commit hook will run the linters but not the unit tests.

git config core.hooksPath .githooks

Metadata

Release files for smpclient 4.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for smpclient 4.4.0
File	Size	Uploaded
smpclient-4.4.0.tar.gz	24.4 kB	Oct 13, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for smpclient 4.4.0
File	Interpreter	ABI	Platform	Reset
smpclient-4.4.0-py3-none-any.whl 30.2 kB Oct 13, 2024	Python 3	none	any	Details

Total release size: 54.6 kB

Release files / smpclient-4.4.0.tar.gz

Download URL	smpclient-4.4.0.tar.gz
Size	24.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`4400c45cc7796a2c349000c3e2a9be5cca707e0dd439af8855fa82a28fa22a36`
BLAKE2b-256 checksum How to use checksums	`8644106551cadee39f2c46715b251f78dfb5cdd8e3c719eda3acc16ba33faff2`
Upload date	Oct 13, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.1 CPython/3.12.7`

Release files / smpclient-4.4.0-py3-none-any.whl

Download URL	smpclient-4.4.0-py3-none-any.whl
Size	30.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e05974a73391d306bf5abd14c8d31d54a71801b71a85eda9c1204e8c08806840`
BLAKE2b-256 checksum How to use checksums	`3aa178aa292416ca2d512680d9645feb6f8a2bef140d5ff659fc2e8595029b4a`
Upload date	Oct 13, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.1 CPython/3.12.7`