Simple Management Protocol (SMP) Manager for remotely managing MCU firmware
Project description
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.
- 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 - run
buildto build a portable executable bundle atdist/smpmgr-<git tag>. Refer toportably.pyfor details. - 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>
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
.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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file smpmgr-0.13.0.tar.gz.
File metadata
- Download URL: smpmgr-0.13.0.tar.gz
- Upload date:
- Size: 15.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
09bc33f2ac52e617de173693d2810fd0c2fd2b489c38842954d53e2583d3a3a3
|
|
| MD5 |
bf563f59136edc6f5e4b11119f940f41
|
|
| BLAKE2b-256 |
8ff74d414322cf480d54ebcfb41c243b43f2a701f5cbd8eae0a44ca8ed72e7e9
|
Provenance
The following attestation bundles were made for smpmgr-0.13.0.tar.gz:
Publisher:
release.yaml on intercreate/smpmgr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
smpmgr-0.13.0.tar.gz -
Subject digest:
09bc33f2ac52e617de173693d2810fd0c2fd2b489c38842954d53e2583d3a3a3 - Sigstore transparency entry: 242394505
- Sigstore integration time:
-
Permalink:
intercreate/smpmgr@0c426f10ef76c624a2c88a4cb4215d9ae86ff05a -
Branch / Tag:
refs/tags/0.13.0 - Owner: https://github.com/intercreate
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@0c426f10ef76c624a2c88a4cb4215d9ae86ff05a -
Trigger Event:
release
-
Statement type:
File details
Details for the file smpmgr-0.13.0-py3-none-any.whl.
File metadata
- Download URL: smpmgr-0.13.0-py3-none-any.whl
- Upload date:
- Size: 21.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ead91f8461dfadd63e64de66d37798f28393172bc274f5e59c2bc855cab7e35f
|
|
| MD5 |
ce282acc35308c65203ec53550dd9535
|
|
| BLAKE2b-256 |
ef1ccb0284bc4b91080a45c2a62f072288641aeebd2a95ea0a06c9d9f69562b7
|
Provenance
The following attestation bundles were made for smpmgr-0.13.0-py3-none-any.whl:
Publisher:
release.yaml on intercreate/smpmgr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
smpmgr-0.13.0-py3-none-any.whl -
Subject digest:
ead91f8461dfadd63e64de66d37798f28393172bc274f5e59c2bc855cab7e35f - Sigstore transparency entry: 242394512
- Sigstore integration time:
-
Permalink:
intercreate/smpmgr@0c426f10ef76c624a2c88a4cb4215d9ae86ff05a -
Branch / Tag:
refs/tags/0.13.0 - Owner: https://github.com/intercreate
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@0c426f10ef76c624a2c88a4cb4215d9ae86ff05a -
Trigger Event:
release
-
Statement type:
