Skip to content

Settings Management

Refer to the smp Settings Management documentation for a complete description of each Request and Response.

ReadSetting

Bases: ReadSettingRequest, _GroupBase

Read setting.

Parameters:

Name Type Description Default
name str
required
max_size int | None
required
Source code in smpclient\requests\settings_management.py 
18
19
20
21
22
23
24
25
26
27
class ReadSetting(smpset.ReadSettingRequest, _GroupBase):
    """Read setting.

    Args:
        name (str): 
        max_size (int | None): 

    """
    _Response = smpset.ReadSettingResponse
    _Response = smpset.ReadSettingResponse

WriteSetting

Bases: WriteSettingRequest, _GroupBase

Write setting.

Parameters:

Name Type Description Default
name str
required
val bytes
required
Source code in smpclient\requests\settings_management.py 
30
31
32
33
34
35
36
37
38
39
class WriteSetting(smpset.WriteSettingRequest, _GroupBase):
    """Write setting.

    Args:
        name (str): 
        val (bytes): 

    """
    _Response = smpset.WriteSettingResponse
    _Response = smpset.WriteSettingResponse

DeleteSetting

Bases: DeleteSettingRequest, _GroupBase

Delete setting.

Parameters:

Name Type Description Default
name str
required
Source code in smpclient\requests\settings_management.py 
42
43
44
45
46
47
48
49
50
class DeleteSetting(smpset.DeleteSettingRequest, _GroupBase):
    """Delete setting.

    Args:
        name (str): 

    """
    _Response = smpset.DeleteSettingResponse
    _Response = smpset.DeleteSettingResponse

CommitSettings

Bases: CommitSettingsRequest, _GroupBase

Commit pending settings.

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

Source code in smpclient\requests\settings_management.py 
53
54
55
56
57
58
59
60
61
62
class CommitSettings(smpset.CommitSettingsRequest, _GroupBase):
    """Commit pending settings.


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

    """
    _Response = smpset.CommitSettingsResponse
    _Response = smpset.CommitSettingsResponse

LoadSettings

Bases: LoadSettingsRequest, _GroupBase

Load settings from persistent storage.

Source code in smpclient\requests\settings_management.py 
65
66
67
68
69
70
class LoadSettings(smpset.LoadSettingsRequest, _GroupBase):
    """Load settings from persistent storage.

    """
    _Response = smpset.LoadSettingsResponse
    _Response = smpset.LoadSettingsResponse

SaveSettings

Bases: SaveSettingsRequest, _GroupBase

Save settings to persistent storage.

Source code in smpclient\requests\settings_management.py 
73
74
75
76
77
78
class SaveSettings(smpset.SaveSettingsRequest, _GroupBase):
    """Save settings to persistent storage.

    """
    _Response = smpset.SaveSettingsResponse
    _Response = smpset.SaveSettingsResponse