Skip to main content

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.

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

Development Environment Setup

Install Dependencies

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.2.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.2.0
File Size Uploaded Provenance Actions
smpclient-4.2.0.tar.gz 22.6 kB Without provenance Details for smpclient-4.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for smpclient 4.2.0
File Interpreter ABI Platform Actions
smpclient-4.2.0-py3-none-any.whl Python 3 none any Details for smpclient-4.2.0-py3-none-any.whl

Total release size: 51.0 kB

Release files / smpclient-4.2.0.tar.gz

Download URL smpclient-4.2.0.tar.gz
Size 22.6 kB
Tags Source
SHA-256 checksum
How to use checksums
6945077ecff3b7540ef4c3de9a110d07b6ec9bb465fb96f0ce88f0ca973b62f1
BLAKE2b-256 checksum
How to use checksums
b8840541a0469da05dc681832eeebb128ca3421bf12354cb92f912f4ab71e213
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.6

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

Download URL smpclient-4.2.0-py3-none-any.whl
Size 28.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7fe9036860db5ce605f953d16079427a3712150ad7cc2a1ddc424c3cdc5ca9db
BLAKE2b-256 checksum
How to use checksums
db5b64f56d2bfa34f250bb644df55221b7dcb043c122392fc2a9add96f58b25b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.6

Security for smpclient 4.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

4.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page