Skip to main content

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.

  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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smpmgr-0.17.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

smpmgr-0.17.0-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file smpmgr-0.17.0.tar.gz.

File metadata

  • Download URL: smpmgr-0.17.0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for smpmgr-0.17.0.tar.gz
Algorithm Hash digest
SHA256 764ea4555221fc01a4e2189481d63a40d461897423f43da2db66286e3ca9445a
MD5 c52ef1f7b8d65b2b715235062203c61d
BLAKE2b-256 1498ecc57a1a4a5f172db117b68a2007dfcf7f707a341fe2680f91727eb8e024

See more details on using hashes here.

Provenance

The following attestation bundles were made for smpmgr-0.17.0.tar.gz:

Publisher: release.yaml on intercreate/smpmgr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file smpmgr-0.17.0-py3-none-any.whl.

File metadata

  • Download URL: smpmgr-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for smpmgr-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fdce7736a6e86f79005babd75c1a809f7194d832f445e378cb20802e94d67d6e
MD5 27ed7e5928fd388dcfef8a689adf55bc
BLAKE2b-256 ddde6894ce7dea07ceb04152baa734ef146c833b69adc0c4eb99c56034aef28e

See more details on using hashes here.

Provenance

The following attestation bundles were made for smpmgr-0.17.0-py3-none-any.whl:

Publisher: release.yaml on intercreate/smpmgr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page