Skip to content

Settings Management

The Simple Management Protocol (SMP) Settings Management group.

ReadSettingRequest

Bases: ReadRequest

Read setting.

Source code in smp/settings_management.py 
12
13
14
15
16
17
18
19
20
21
22
class ReadSettingRequest(smpmsg.ReadRequest):
    """Read setting."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.READ_WRITE_SETTING

    name: str
    """The name of the setting to read."""

    max_size: int | None = None
    """The maximum size of the data to read."""

name: str instance-attribute

The name of the setting to read.

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

The maximum size of the data to read.

ReadSettingResponse

Bases: ReadResponse

Read setting success response.

Source code in smp/settings_management.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class ReadSettingResponse(smpmsg.ReadResponse):
    """Read setting success response."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.READ_WRITE_SETTING

    val: bytes
    """Binary string of the returned data.

    Note that the underlying data type cannot be specified through this and must
    be known by the client.
    """

    max_size: int | None = None
    """The SMP server supports a smaller size than requested.

    Will be set if the maximum supported data size is smaller than the maximum
    requested data size, and contains the maximum data size which the device
    supports, equivalent to `CONFIG_MCUMGR_GRP_SETTINGS_NAME_LEN`.
    """

val: bytes instance-attribute

Binary string of the returned data.

Note that the underlying data type cannot be specified through this and must be known by the client.

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

The SMP server supports a smaller size than requested.

Will be set if the maximum supported data size is smaller than the maximum requested data size, and contains the maximum data size which the device supports, equivalent to CONFIG_MCUMGR_GRP_SETTINGS_NAME_LEN.

WriteSettingRequest

Bases: WriteRequest

Write setting.

Source code in smp/settings_management.py 
47
48
49
50
51
52
53
54
55
56
57
class WriteSettingRequest(smpmsg.WriteRequest):
    """Write setting."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.READ_WRITE_SETTING

    name: str
    """The name of the setting to write."""

    val: bytes
    """Binary data to write."""

name: str instance-attribute

The name of the setting to write.

val: bytes instance-attribute

Binary data to write.

WriteSettingResponse

Bases: WriteResponse

Write setting success response.

Source code in smp/settings_management.py 
60
61
62
63
64
class WriteSettingResponse(smpmsg.WriteResponse):
    """Write setting success response."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.READ_WRITE_SETTING

DeleteSettingRequest

Bases: WriteRequest

Delete setting.

Source code in smp/settings_management.py 
67
68
69
70
71
72
73
74
class DeleteSettingRequest(smpmsg.WriteRequest):
    """Delete setting."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.DELETE_SETTING

    name: str
    """The name of the setting to delete."""

name: str instance-attribute

The name of the setting to delete.

DeleteSettingResponse

Bases: WriteResponse

Delete setting success response.

Source code in smp/settings_management.py 
77
78
79
80
81
class DeleteSettingResponse(smpmsg.WriteResponse):
    """Delete setting success response."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.DELETE_SETTING

CommitSettingsRequest

Bases: WriteRequest

Commit pending settings.

Commit settings command allows committing all settings that have been set but not yet applied on a device.

Source code in smp/settings_management.py 
84
85
86
87
88
89
90
91
92
class CommitSettingsRequest(smpmsg.WriteRequest):
    """Commit pending settings.

    Commit settings command allows committing all settings that have been set
    but not yet applied on a device.
    """

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.COMMIT_SETTINGS

CommitSettingsResponse

Bases: WriteResponse

Commit pending settings success response.

Source code in smp/settings_management.py 
95
96
97
98
99
class CommitSettingsResponse(smpmsg.WriteResponse):
    """Commit pending settings success response."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.COMMIT_SETTINGS

LoadSettingsRequest

Bases: ReadRequest

Load settings from persistent storage.

Source code in smp/settings_management.py 
102
103
104
105
106
class LoadSettingsRequest(smpmsg.ReadRequest):
    """Load settings from persistent storage."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.LOAD_SAVE_SETTINGS

LoadSettingsResponse

Bases: ReadResponse

Load settings from persistent storage success response.

Source code in smp/settings_management.py 
109
110
111
112
113
class LoadSettingsResponse(smpmsg.ReadResponse):
    """Load settings from persistent storage success response."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.LOAD_SAVE_SETTINGS

SaveSettingsRequest

Bases: WriteRequest

Save settings to persistent storage.

Source code in smp/settings_management.py 
116
117
118
119
120
class SaveSettingsRequest(smpmsg.WriteRequest):
    """Save settings to persistent storage."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.LOAD_SAVE_SETTINGS

SaveSettingsResponse

Bases: WriteResponse

Save settings to persistent storage success response.

Source code in smp/settings_management.py 
123
124
125
126
127
class SaveSettingsResponse(smpmsg.WriteResponse):
    """Save settings to persistent storage success response."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT
    _COMMAND_ID = smphdr.CommandId.SettingsManagement.LOAD_SAVE_SETTINGS

SETTINGS_MGMT_ERR

Bases: IntEnum

Return codes for the settings management group.

Source code in smp/settings_management.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
@unique
class SETTINGS_MGMT_ERR(IntEnum):
    """Return codes for the settings management group."""

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

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

    KEY_TOO_LONG = 2
    """The provided key name is too long to be used."""

    KEY_NOT_FOUND = 3
    """The provided key name does not exist."""

    READ_NOT_SUPPORTED = 4
    """The provided key name does not support being read."""

    ROOT_KEY_NOT_FOUND = 5
    """The provided root key name does not exist."""

    WRITE_NOT_SUPPORTED = 6
    """The provided key name does not support being written."""

    DELETE_NOT_SUPPORTED = 7
    """The provided key name does not support being deleted."""

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.

KEY_TOO_LONG = 2 class-attribute instance-attribute

The provided key name is too long to be used.

KEY_NOT_FOUND = 3 class-attribute instance-attribute

The provided key name does not exist.

READ_NOT_SUPPORTED = 4 class-attribute instance-attribute

The provided key name does not support being read.

ROOT_KEY_NOT_FOUND = 5 class-attribute instance-attribute

The provided root key name does not exist.

WRITE_NOT_SUPPORTED = 6 class-attribute instance-attribute

The provided key name does not support being written.

DELETE_NOT_SUPPORTED = 7 class-attribute instance-attribute

The provided key name does not support being deleted.

SettingsManagementErrorV1

Bases: ErrorV1

Error response to a settings management command.

Source code in smp/settings_management.py 
159
160
161
162
class SettingsManagementErrorV1(smperr.ErrorV1):
    """Error response to a settings management command."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT

SettingsManagementErrorV2

Bases: ErrorV2[SETTINGS_MGMT_ERR]

Error response to a settings management command.

Source code in smp/settings_management.py 
165
166
167
168
class SettingsManagementErrorV2(smperr.ErrorV2[SETTINGS_MGMT_ERR]):
    """Error response to a settings management command."""

    _GROUP_ID = smphdr.GroupId.SETTINGS_MANAGEMENT