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 or Linux 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.

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.10.4.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

smpmgr-0.10.4-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for smpmgr-0.10.4.tar.gz
Algorithm Hash digest
SHA256 1ea2928d86ff0c67722e3cd46153930b12d4d7c568aba665e1914b817caa1c95
MD5 52ccd87bb500515af0ab8a1812592265
BLAKE2b-256 65f404bc14868ae1402d4098983946992b236c8a6768aafc402a0b1f04b7b5a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for smpmgr-0.10.4.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.10.4-py3-none-any.whl.

File metadata

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

File hashes

Hashes for smpmgr-0.10.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c6906f0ba3b55209bd97a88294aa7fcee33102f4d0c69a69f4f30b412ccb63ff
MD5 38b869ba8c6ebf110d77f8b7e3aff0ea
BLAKE2b-256 287e6b276d80db0f556f6ea82de852b9af66d09372c816d56c4fc7f6023da4a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for smpmgr-0.10.4-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 AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page