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.
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 installwhen pulling in new changes - run
lintafter making changes - run
testafter 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
- python >=3.8, <3.13
- 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
.venvenvironment manually, usepoetry runandpoetry shell, and refer toenvr-defaultfor 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
1 maintainer
Metadata
1 maintainer
Release files for smpclient 4.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| smpclient-4.1.0.tar.gz | 22.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| smpclient-4.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 49.3 kB
Release files / smpclient-4.1.0.tar.gz
| Download URL | smpclient-4.1.0.tar.gz |
|---|---|
| Size | 22.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e413f985623ab442a482aeb774311bef0282987663d82f416b8c76cc8ce0a427
|
|
BLAKE2b-256 checksum How to use checksums |
605cd682c5e8be0ccb89efa327b4b10cc49ec759a3dcd8db54032d0b3aed68fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / smpclient-4.1.0-py3-none-any.whl
| Download URL | smpclient-4.1.0-py3-none-any.whl |
|---|---|
| Size | 27.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c6c8f62b7138447d9b6e220388bfd47f6861dfcabc18de5033c12ab7aff9d34e
|
|
BLAKE2b-256 checksum How to use checksums |
9941ac1b0ab648390811284d0986415b08b2f3b519c5cce31ce1dcec0d776cd4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
