smpmgr 0.18.1

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

Simple Management Protocol (SMP) Manager

smpmgr is a CLI application for interacting with device firmware over a serial (UART or USB), Bluetooth (BLE), or UDP, connection. It can be used as a reference implementation of the smp and smpclient libraries when developing your own SMP application.

The SMP specification can be found here.

Install

You can download a portable executable for Windows, Linux, and macOS from the latest releases page.

smpmgr is also distributed by PyPI. If you already have a Python environment setup, then it is strongly recommended to install smpmgr with pipx instead of pip.

Custom SMP Groups

smpmgr supports user-provided plugins that implement proprietary SMP groups.

smpmgr --plugin-path=plugins --help

See /plugins for more information and examples.

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. run build to build a portable executable bundle at dist/smpmgr-<git tag>. Refer to portably.py for details.
6. add library dependencies with poetry:

   poetry add <my_new_dependency>
   

7. add test or other development dependencies using poetry groups:

   poetry add -G dev <my_dev_dependency>
   

Development Environment Setup

Install Dependencies

• poetry >= 2: 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