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

Uploaded Source

Built Distribution

smp-3.2.0-py3-none-any.whl (30.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smp-3.2.0.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for smp-3.2.0.tar.gz
Algorithm Hash digest
SHA256 f6999c4f0f0a2349cfc9df8eae600a209726c181bc1664e495036069535cb97e
MD5 1c100e67203649bfb4bedeb32684435c
BLAKE2b-256 98ecff04fde06ad2439f6f238f00d3b44ba293cc524b86da9f107455e144e542

See more details on using hashes here.

File details

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

File metadata

  • Download URL: smp-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 30.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for smp-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3711aede963d4cea6d3f88fbdd9c0830e64cc6dbe07ba2b083a031ae14dd5dd8
MD5 41a44be986496746db099ab095fa8dc6
BLAKE2b-256 091eea6dd26ff8a2a51bd6131987ab49ab5dc4ec998b7056ec463aaf646ccaf8

See more details on using hashes here.

Supported by

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