Skip to content

Enumeration Management

The Simple Management Protocol (SMP) Enumeration Management group.

GroupCountRequest

Bases: ReadRequest

Read the number of SMP server groups.

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

Source code in smp/enumeration_management.py 
15
16
17
18
19
20
21
22
23
class GroupCountRequest(smpmsg.ReadRequest):
    """Read the number of SMP server groups.

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

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.EnumManagement.GROUP_COUNT

GroupCountResponse

Bases: ReadResponse

SMP group count response.

Source code in smp/enumeration_management.py 
26
27
28
29
30
31
32
33
class GroupCountResponse(smpmsg.ReadResponse):
    """SMP group count response."""

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.EnumManagement.GROUP_COUNT

    count: int
    """Contains the total number of supported SMP groups on the device."""

count: int instance-attribute

Contains the total number of supported SMP groups on the device.

ListOfGroupsRequest

Bases: ReadRequest

List the available SMP groups.

Source code in smp/enumeration_management.py 
36
37
38
39
40
class ListOfGroupsRequest(smpmsg.ReadRequest):
    """List the available SMP groups."""

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.EnumManagement.LIST_OF_GROUPS

ListOfGroupsResponse

Bases: ReadResponse

SMP group list response.

Source code in smp/enumeration_management.py 
43
44
45
46
47
48
49
50
class ListOfGroupsResponse(smpmsg.ReadResponse):
    """SMP group list response."""

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.EnumManagement.LIST_OF_GROUPS

    groups: Tuple[smphdr.GroupIdField, ...]
    """Contains a list of the supported SMP group IDs on the device."""

groups: Tuple[smphdr.GroupIdField, ...] instance-attribute

Contains a list of the supported SMP group IDs on the device.

GroupIdRequest

Bases: ReadRequest

List a SMP group by index.

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

Source code in smp/enumeration_management.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
class GroupIdRequest(smpmsg.ReadRequest):
    """List a SMP group by index.

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

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.EnumManagement.GROUP_ID

    index: int | None = None
    """Contains the (0-based) index of the group to return information on, can
    be omitted to return the first group's details.
"""

index: int | None = None class-attribute instance-attribute

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

GroupIdResponse

Bases: ReadResponse

SMP group at index response.

Source code in smp/enumeration_management.py 
69
70
71
72
73
74
75
76
77
78
79
80
class GroupIdResponse(smpmsg.ReadResponse):
    """SMP group at index response."""

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.EnumManagement.GROUP_ID

    group: smphdr.GroupIdField
    """The Group ID at the requested index."""
    end: bool | None = None
    """Will be set to true if the listed group is the final supported group on
    the device, otherwise will be omitted.
    """

group: smphdr.GroupIdField instance-attribute

The Group ID at the requested index.

end: bool | None = None class-attribute instance-attribute

Will be set to true if the listed group is the final supported group on the device, otherwise will be omitted.

GroupDetailsRequest

Bases: ReadRequest

Request the details of the supported SMP groups.

Details on supported groups command allows fetching details on each supported SMP 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.

Source code in smp/enumeration_management.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class GroupDetailsRequest(smpmsg.ReadRequest):
    """Request the details of the supported SMP groups.

    Details on supported groups command allows fetching details on each
    supported SMP 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`.
    """

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.EnumManagement.GROUP_DETAILS

    groups: Tuple[smphdr.GroupIdField, ...] | None = None
    """Contains a list of the SMP group IDs to fetch details on.

    If omitted, details on all supported groups will be returned.
    """

groups: Tuple[smphdr.GroupIdField, ...] | None = None class-attribute instance-attribute

Contains a list of the SMP group IDs to fetch details on.

If omitted, details on all supported groups will be returned.

GroupDetails

Bases: BaseModel

Group Details

Source code in smp/enumeration_management.py 
107
108
109
110
111
112
113
114
115
116
117
class GroupDetails(BaseModel):
    """Group Details"""

    model_config = ConfigDict(extra="forbid", frozen=True)

    id: smphdr.GroupIdField
    """The group ID of the SMP command group."""
    name: str | None = None
    """The name of the SMP command group."""
    handlers: int | None = None
    """The number of handlers that the SMP command group supports."""

model_config = ConfigDict(extra='forbid', frozen=True) class-attribute instance-attribute

id: smphdr.GroupIdField instance-attribute

The group ID of the SMP command group.

name: str | None = None class-attribute instance-attribute

The name of the SMP command group.

handlers: int | None = None class-attribute instance-attribute

The number of handlers that the SMP command group supports.

GroupDetailsResponse

Bases: ReadResponse

SMP group details response.

Source code in smp/enumeration_management.py 
120
121
122
123
124
125
126
127
class GroupDetailsResponse(smpmsg.ReadResponse):
    """SMP group details response."""

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.EnumManagement.GROUP_DETAILS

    groups: Tuple[GroupDetails, ...]
    """Contains a list of the requested SMP group details."""

groups: Tuple[GroupDetails, ...] instance-attribute

Contains a list of the requested SMP group details.

ENUM_MGMT_ERR

Bases: IntEnum

Return codes for the enumeration management group.

Source code in smp/enumeration_management.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
@unique
class ENUM_MGMT_ERR(IntEnum):
    """Return codes for the enumeration management group."""

    OK = 0
    """No error, this is implied if there is no ret value in the response."""

    UNKNOWN = 1
    """Unknown error occurred."""

    ERR_TOO_MANY_GROUP_ENTRIES = 2
    """Too many entries were provided."""

    ERR_INSUFFICIENT_HEAP_FOR_ENTRIES = 3
    """Insufficient heap memory to store entry data."""

    ENUM_MGMT_ERR_INDEX_TOO_LARGE = 4
    """Provided index is larger than the number of supported groups."""

OK = 0 class-attribute instance-attribute

No error, this is implied if there is no ret value in the response.

UNKNOWN = 1 class-attribute instance-attribute

Unknown error occurred.

ERR_TOO_MANY_GROUP_ENTRIES = 2 class-attribute instance-attribute

Too many entries were provided.

ERR_INSUFFICIENT_HEAP_FOR_ENTRIES = 3 class-attribute instance-attribute

Insufficient heap memory to store entry data.

ENUM_MGMT_ERR_INDEX_TOO_LARGE = 4 class-attribute instance-attribute

Provided index is larger than the number of supported groups.

EnumManagementErrorV1

Bases: ErrorV1

Error response to a enumeration management command.

Source code in smp/enumeration_management.py 
150
151
152
153
class EnumManagementErrorV1(smperr.ErrorV1):
    """Error response to a enumeration management command."""

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT

EnumManagementErrorV2

Bases: ErrorV2[ENUM_MGMT_ERR]

Error response to a enumeration management command.

Source code in smp/enumeration_management.py 
156
157
158
159
class EnumManagementErrorV2(smperr.ErrorV2[ENUM_MGMT_ERR]):
    """Error response to a enumeration management command."""

    _GROUP_ID = smphdr.GroupId.ENUM_MANAGEMENT