smpclient 7.2.0

Simple Management Protocol (SMP) Client for remotely managing MCU firmware

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 uv, pip, and other dependency managers.

Build with all transports:

smpclient[all]

Or none (UDP transport only):

smpclient

Or build with only the transports you need:

smpclient[serial] # Serial (UART, USB, CAN)
smpclient[ble] # Bluetooth Low Energy
smpclient[serial,ble] # Serial + BLE

The UDP transport has no additional dependencies and is always available.

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.

1. run uv sync when pulling in new changes
2. run uv run task fix after making changes (fast)
3. run uv run task all after making changes (thorough)
4. add library dependencies with uv:

   uv add <my_new_dependency>
   

5. add test or other development dependencies:

   uv add --group dev <my_dev_dependency>
   

6. run tests for all supported python versions:

   uv run task matrix
   

Development Environment Setup

Install Dependencies

• uv: https://docs.astral.sh/uv/getting-started/installation/

Create the venv

uv sync

Verify Your Setup

uv run task all

Enable the githooks

git config core.hooksPath .githooks