search

JPHutchins / smp

Simple Management Protocol (SMP) for remotely managing MCU firmware
Apache License 2.0
8 stars 6 forks source link

Add shell management #4

Closed petrovichkr closed 9 months ago

petrovichkr commented 9 months ago

Add shell management group based on Zephyr Docs.

JPHutchins commented 9 months ago

@petrovichkr Hi, thanks so much for this contribution!

I have been slow to add docs here and now it is slowing you down 😢

To lint:

. ./envr.ps1
lint

Or run without the envr alias:

black --check . && isort --check-only . && flake8 . && mypy .
petrovichkr commented 9 months ago

@petrovichkr Hi, thanks so much for this contribution!

I have been slow to add docs here and now it is slowing you down 😢

To lint:

. ./envr.ps1
lint

Or run without the envr alias:

black --check . && isort --check-only . && flake8 . && mypy .

Done fixing lint issues. This is my first contribution to the Python project, so sorry too :)

petrovichkr commented 9 months ago

Great! I will create a ticket to improve the _do_test function. Now that I'm looking at my own _do_test code again it looks too "magic" to me and I want it to be easier for contributors. I'd love your advice!

My test writing skills are about zero, so I'm a bad advisor :) I created these tests based on your test_os_management.

In order to test these with a device, I'll bump smpclient and smpmgr to implement the shell management group that you've added. Very useful (and dangerous), especially over BLE!

Overall these tools will be a good replacement for the existing newtmgr/mcumgr. BLE transport is much more stable and doesn't require root rights. I'm going to use the smpclient package to develop automation utilities for testing Zephyr based hardware over BLE.

By the way, I've already implemented the shell group in smpclient. I can do PR to smpclient after the release of this project.

JPHutchins commented 9 months ago

Overall these tools will be a good replacement for the existing newtmgr/mcumgr.

That's the goal, but there's a lot of work and testing to be done! While there are still only a few people using these tools, breaking changes may be frequent to arrive at a consensus API. You can trust the semantic versioning and release notes to indicate these breaking changes.