Skip to content

OS Management

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

EchoWrite

Bases: EchoWriteRequest, _OSGroupBase

Echo back the provided string.

Source code in smpclient/requests/os_management.py 
18
19
20
21
22
23
class EchoWrite(smpos.EchoWriteRequest, _OSGroupBase):
    """Echo back the provided string.

    """
    _Response = smpos.EchoWriteResponse
    _Response = smpos.EchoWriteResponse

ResetWrite

Bases: ResetWriteRequest, _OSGroupBase

Performs reset of system.

The device should issue response before resetting so that the SMP client could receive information that the command has been accepted. By default, this command is accepted in all conditions, however if the CONFIG_MCUMGR_GRP_OS_RESET_HOOK is enabled and an application registers a callback, the callback will be called when this command is issued and can be used to perform any necessary tidy operations prior to the module rebooting, or to reject the reset request outright altogether with an error response.

For details on this functionality, see callbacks. # noqa: E501

Parameters:

Name Type Description Default
force Optional[Literal[0]]
required
Source code in smpclient/requests/os_management.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class ResetWrite(smpos.ResetWriteRequest, _OSGroupBase):
    """Performs reset of system.


    The device should issue response before resetting so that the SMP client
    could receive information that the command has been accepted. By default,
    this command is accepted in all conditions, however if the
    `CONFIG_MCUMGR_GRP_OS_RESET_HOOK` is enabled and an application registers a
    callback, the callback will be called when this command is issued and can be
    used to perform any necessary tidy operations prior to the module rebooting,
    or to reject the reset request outright altogether with an error response.

    For details on this functionality, see [callbacks](https://docs.zephyrproject.org/latest/services/device_mgmt/mcumgr_callbacks.html#mcumgr-callbacks).  # noqa: E501

    Args:
        force (Optional[Literal[0]]): 

    """
    _Response = smpos.ResetWriteResponse
    _Response = smpos.ResetWriteResponse

TaskStatisticsRead

Bases: TaskStatisticsReadRequest, _OSGroupBase

Request task statistics.

Source code in smpclient/requests/os_management.py 
48
49
50
51
52
53
class TaskStatisticsRead(smpos.TaskStatisticsReadRequest, _OSGroupBase):
    """Request task statistics.

    """
    _Response = smpos.TaskStatisticsReadResponse
    _Response = smpos.TaskStatisticsReadResponse

MemoryPoolStatisticsRead

Bases: MemoryPoolStatisticsReadRequest, _OSGroupBase

Request memory pool statistics.

Source code in smpclient/requests/os_management.py 
56
57
58
59
60
61
class MemoryPoolStatisticsRead(smpos.MemoryPoolStatisticsReadRequest, _OSGroupBase):
    """Request memory pool statistics.

    """
    _Response = smpos.MemoryPoolStatisticsReadResponse
    _Response = smpos.MemoryPoolStatisticsReadResponse

DateTimeRead

Bases: DateTimeReadRequest, _OSGroupBase

Request the current date and time.

Source code in smpclient/requests/os_management.py 
64
65
66
67
68
69
class DateTimeRead(smpos.DateTimeReadRequest, _OSGroupBase):
    """Request the current date and time.

    """
    _Response = smpos.DateTimeReadResponse
    _Response = smpos.DateTimeReadResponse

DateTimeWrite

Bases: DateTimeWriteRequest, _OSGroupBase

Set the current date and time.

Parameters:

Name Type Description Default
datetime str
required
Source code in smpclient/requests/os_management.py 
72
73
74
75
76
77
78
79
80
class DateTimeWrite(smpos.DateTimeWriteRequest, _OSGroupBase):
    """Set the current date and time.

    Args:
        datetime (str): 

    """
    _Response = smpos.DateTimeWriteResponse
    _Response = smpos.DateTimeWriteResponse

MCUMgrParametersRead

Bases: MCUMgrParametersReadRequest, _OSGroupBase

Request MCU Manager parameters.

Source code in smpclient/requests/os_management.py 
83
84
85
86
87
88
class MCUMgrParametersRead(smpos.MCUMgrParametersReadRequest, _OSGroupBase):
    """Request MCU Manager parameters.

    """
    _Response = smpos.MCUMgrParametersReadResponse
    _Response = smpos.MCUMgrParametersReadResponse

OSApplicationInfoRead

Bases: OSApplicationInfoReadRequest, _OSGroupBase

Request information about the application running on the device.

Parameters:

Name Type Description Default
format str | None
required
Source code in smpclient/requests/os_management.py 
91
92
93
94
95
96
97
98
99
class OSApplicationInfoRead(smpos.OSApplicationInfoReadRequest, _OSGroupBase):
    """Request information about the application running on the device.

    Args:
        format (str | None): 

    """
    _Response = smpos.OSApplicationInfoReadResponse
    _Response = smpos.OSApplicationInfoReadResponse

BootloaderInformationRead

Bases: BootloaderInformationReadRequest, _OSGroupBase

Request bootloader information.

Parameters:

Name Type Description Default
query str | None
required
Source code in smpclient/requests/os_management.py 
102
103
104
105
106
107
108
109
110
class BootloaderInformationRead(smpos.BootloaderInformationReadRequest, _OSGroupBase):
    """Request bootloader information.

    Args:
        query (str | None): 

    """
    _Response = smpos.BootloaderInformationReadResponse
    _Response = smpos.BootloaderInformationReadResponse