Skip to main content

Simple Management Protocol (SMP) Client for remotely managing MCU firmware

Project description

Simple Management Protocol (SMP) Client

smpclient implements the transport layer of the Simple Management Protocol. This library can be used as a dependency in applications that use SMP over serial (UART or USB), Bluetooth (BLE), or UDP connections. Some abstractions are provided for common routines like upgrading device firmware.

If you don't need a library with the transport layer implemented, then you might prefer to use smp instead. The SMP specification can be found here.

If you'd like an SMP CLI application instead of a library, then you should try smpmgr.

Install

smpclient 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

smpclient-4.4.0.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

smpclient-4.4.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file smpclient-4.4.0.tar.gz.

File metadata

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

File hashes

Hashes for smpclient-4.4.0.tar.gz
Algorithm Hash digest
SHA256 4400c45cc7796a2c349000c3e2a9be5cca707e0dd439af8855fa82a28fa22a36
MD5 1269f1774ad191e6442d81c329a611fe
BLAKE2b-256 8644106551cadee39f2c46715b251f78dfb5cdd8e3c719eda3acc16ba33faff2

See more details on using hashes here.

File details

Details for the file smpclient-4.4.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for smpclient-4.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e05974a73391d306bf5abd14c8d31d54a71801b71a85eda9c1204e8c08806840
MD5 e2e5c2b0b9f787e52ca3983d299a8e65
BLAKE2b-256 3aa178aa292416ca2d512680d9645feb6f8a2bef140d5ff659fc2e8595029b4a

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