Skip to main content

Simple Management Protocol (SMP) for remotely managing MCU firmware

Project description

Simple Management Protocol (SMP)

smp implements serialization and deserialization of the Simple Management Protocol.

The SMP specification can be found here.

If you'd like a library that implements the serial (UART or USB), Bluetooth (BLE), and UDP transport layers for SMP, take a look at smpclient.

If you need an SMP CLI application to interact with device firmware, then try smpmgr.

Install

smp is distributed by PyPI and can be installed with poetry, pip, and other dependency managers.

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. 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. add library dependencies with poetry:
    poetry add <my_new_dependency>
    
  6. add test or other development dependencies using poetry groups:
    poetry add -G dev <my_dev_dependency>
    
  7. run tests for all supported python versions:
tox

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

smp-3.3.1.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

smp-3.3.1-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

Details for the file smp-3.3.1.tar.gz.

File metadata

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

File hashes

Hashes for smp-3.3.1.tar.gz
Algorithm Hash digest
SHA256 c17a4cdfc5087f3f094360a93ed0cfa133f2ab4bbfe39c7c0e86ab39c0e6b07a
MD5 663ee8aba614cfcb4b417c24df4592b0
BLAKE2b-256 ebe8b8db6f8786774f0219bdf354aee675b89d2e0a717c2b8f490d33a0f1d7ec

See more details on using hashes here.

Provenance

The following attestation bundles were made for smp-3.3.1.tar.gz:

Publisher: release.yaml on JPHutchins/smp

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

File details

Details for the file smp-3.3.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for smp-3.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 74c946fc70600ce1d2b3924830dfe90464082535bbc88ef4cba814090f375864
MD5 705ece96057e3b645ccd93aae6b46689
BLAKE2b-256 8dbf382896b8c21b81deb0b9bcecab3395e5edb2e8f87df7cf0d02e9c4f999b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for smp-3.3.1-py3-none-any.whl:

Publisher: release.yaml on JPHutchins/smp

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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page