The latest development version of this page may be more current than this released 4.0.0 version.

Enumeration Management Group

Enumeration management group defines the following commands:

`Command ID`	Command description
`0`	Count of supported groups
`1`	List supported groups
`2`	Fetch single group ID
`3`	Details on supported groups

Count of supported groups command

Count of supported groups returns the total number of MCUmgr command groups that a device supports.

Count of supported groups request

Read setting request header fields:

`OP`	`Group ID`	`Command ID`
`0`	`10`	`0`

The command sends an empty CBOR map as data.

Count of supported groups response

Count of supported groups response header fields:

`OP`	`Group ID`	`Command ID`
`1`	`10`	`0`

CBOR data of successful response:

{
    (str)"count"        : (uint)
}

In case of error the CBOR data takes the form:

{
    (str)"err" : {
        (str)"group"    : (uint)
        (str)"rc"       : (uint)
    }
}

{
    (str)"rc"       : (int)
}

where:

“count”	contains the total number of supported MCUmgr groups on the device.
“err” -> “group”	`mcumgr_group_t` group of the group-based error code. Only appears if an error is returned when using SMP version 2.
“err” -> “rc”	contains the index of the group-based error code. Only appears if non-zero (error condition) when using SMP version 2.
“rc”	`mcumgr_err_t` only appears if non-zero (error condition) when using SMP version 1 or for SMP errors when using SMP version 2.

List supported groups command

List supported groups command allows listing the group IDs of supported MCUmgr groups on the device.

List supported groups request

List supported groups request header fields:

`OP`	`Group ID`	`Command ID`
`0`	`10`	`1`

The command sends an empty CBOR map as data.

List supported groups response

List supported groups response header fields:

`OP`	`Group ID`	`Command ID`
`1`	`10`	`1`

CBOR data of successful response:

{
    (str)"groups" : [
        (uint)
        ...
    ]
}

In case of error the CBOR data takes the form:

{
    (str)"err" : {
        (str)"group"    : (uint)
        (str)"rc"       : (uint)
    }
}

{
    (str)"rc"       : (int)
}

where:

“groups”	contains a list of the supported MCUmgr group IDs on the device.
“err” -> “group”	`mcumgr_group_t` group of the group-based error code. Only appears if an error is returned when using SMP version 2.
“err” -> “rc”	contains the index of the group-based error code. Only appears if non-zero (error condition) when using SMP version 2.
“rc”	`mcumgr_err_t` only appears if non-zero (error condition) when using SMP version 1 or for SMP errors when using SMP version 2.

Fetch single group ID command

Fetch single group ID command allows listing the group IDs of supported MCUmgr groups on the device, one by one.

Fetch single group ID request

Fetch single group ID request header fields:

`OP`	`Group ID`	`Command ID`
`0`	`10`	`2`

CBOR data of request:

{
    (str,opt)"index" : (uint)
}

where:

“index”

contains the (0-based) index of the group to return information on, can be omitted to return the first group’s details.

Fetch single group ID response

Fetch single group ID response header fields:

`OP`	`Group ID`	`Command ID`
`1`	`10`	`2`

CBOR data of successful response:

{
    (str)"group"    : (uint)
    (str,opt)"end"  : (bool)
}

In case of error the CBOR data takes the form:

{
    (str)"err" : {
        (str)"group"    : (uint)
        (str)"rc"       : (uint)
    }
}

{
    (str)"rc"       : (int)
}

where:

“group”	contains the list of the supported MCUmgr group IDs on the device.
“end”	will be set to true if the listed group is the final supported group on the device, otherwise will be omitted.
“err” -> “group”	`mcumgr_group_t` group of the group-based error code. Only appears if an error is returned when using SMP version 2.
“err” -> “rc”	contains the index of the group-based error code. Only appears if non-zero (error condition) when using SMP version 2.
“rc”	`mcumgr_err_t` only appears if non-zero (error condition) when using SMP version 1 or for SMP errors when using SMP version 2.

Details on supported groups command

Details on supported groups command allows fetching details on each supported MCUmgr group, such as the name and number of handlers. A device can specify an allow list of groups to return details on or details on all groups can be returned.

This command is optional, it can be enabled using CONFIG_MCUMGR_GRP_ENUM_DETAILS. The optional name and number of handlers can be enabled/disabled with CONFIG_MCUMGR_GRP_ENUM_DETAILS_NAME and CONFIG_MCUMGR_GRP_ENUM_DETAILS_HANDLERS.

Details on supported groups request

Details on supported groups request header fields:

`OP`	`Group ID`	`Command ID`
`0`	`10`	`3`

The command sends an empty CBOR map as data.

CBOR data of request:

{
    (str)"groups" : [
        (uint)
        ...
    ]
}

where:

“groups”

contains a list of the MCUmgr group IDs to fetch details on.

Details on supported groups response

Details on supported groups response header fields:

`OP`	`Group ID`	`Command ID`
`1`	`10`	`3`

CBOR data of successful response:

{
    (str)"groups" : [
        {
            (str)"group"          : (uint)
            (str,opt)"name"       : (str)
            (str,opt)"handlers"   : (uint)
        }
        ...
    ]
}

In case of error the CBOR data takes the form:

{
    (str)"err" : {
        (str)"group"    : (uint)
        (str)"rc"       : (uint)
    }
}

{
    (str)"rc"       : (int)
}

where:

“group”	the group ID of the MCUmgr command group.
“name”	the name of the MCUmgr command group.
“handlers”	the number of handlers that the MCUmgr command group supports.
“err” -> “group”	`mcumgr_group_t` group of the group-based error code. Only appears if an error is returned when using SMP version 2.
“err” -> “rc”	contains the index of the group-based error code. Only appears if non-zero (error condition) when using SMP version 2.
“rc”	`mcumgr_err_t` only appears if non-zero (error condition) when using SMP version 1 or for SMP errors when using SMP version 2.

Details on supported groups callback

There is a details on supported groups MCUmgr callback available (see MCUmgr Callbacks for details on callbacks) which allows for applications/modules to add additional fields to this response. This callback can be enabled with CONFIG_MCUMGR_GRP_ENUM_DETAILS_HOOK, registered with the event MGMT_EVT_OP_ENUM_MGMT_DETAILS, whereby the supplied callback data is enum_mgmt_detail_output. Note that CONFIG_MCUMGR_GRP_ENUM_DETAILS_STATES will need incrementing by the number of additional extra fields that are added.