patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

doc/guides/device_mgmt: Add MCUMGR parameters command to OS grp

Browse source 
The commit add description of a new OS group command for MCUMGR
parameters retrieval.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
This commit is contained in:
Dominik Ermel 2022-04-07 13:22:09 +00:00 committed by Carles Cufí
parent da6a5590e8
commit aa53dfab02
1 changed files with 62 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
doc/services/device_mgmt/smp_groups/smp_group_0.rst
View file

@ -24,6 +24,8 @@ OS management group defines following commands:
+-------------------+-----------------------------------------------+
| ``5`` | System reset |
+-------------------+-----------------------------------------------+
| ``6`` | MCUMGR parameters |
+-------------------+-----------------------------------------------+
Echo command
************
@ -456,3 +458,63 @@ where:
| "rc" | :ref:`mcumgr_smp_protocol_status_codes`; |
| | may not appear if 0 |
+-----------------------+---------------------------------------------------+
MCUMGR Parameters
*****************
Used to obtain parameters of mcumgr library.
MCUMGR Parameters Request
=========================
MCUMGR parameters request header fields:
.. table::
:align: center
+--------+--------------+----------------+
| ``OP`` | ``Group ID`` | ``Command ID`` |
+========+==============+================+
| ``0`` | ``0`` | ``6`` |
+--------+--------------+----------------+
The command sends empty CBOR map as data.
MCUMGR Parameters Response
==========================
MCUMGR parameters response header fields
.. table::
:align: center
+--------+--------------+----------------+
| ``OP`` | ``Group ID`` | ``Command ID`` |
+========+==============+================+
| ``2`` | ``0`` | ``6`` |
+--------+--------------+----------------+
CBOR data of response:
.. code-block:: none
{
(str)"buf_size" : (uint)
(str)"buf_count" : (uint)
(opt,str)"rc" : (int)
}
where:
.. table::
:align: center
+-----------------------+---------------------------------------------------+
| "buf_size" | Single SMP buffer size, this includes SMP header |
| | and CBOR payload |
+-----------------------+---------------------------------------------------+
| "buf_count" | Number of SMP buffers supported |
+-----------------------+---------------------------------------------------+
| "rc" | :ref:`mcumgr_smp_protocol_status_codes`; |
| | may not appear if 0 |
+-----------------------+---------------------------------------------------+