Skip to content

File Management

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

FileDownload

Bases: FileDownloadRequest, _FileGroupBase

Download contents of an existing file from specified path.

Client applications must keep track of data they have already downloaded and where their position in the file is, and issue subsequent requests, with modified offset, to gather the entire file.

Request does not carry size of requested chunk, the size is specified by application itself. Note that file handles will remain open for consecutive requests (as long as an idle timeout has not been reached and another transport does not make use of uploading/downloading files using fs_mgmt), but files are not exclusively owned by SMP, for the time of download session, and may change between requests or even be removed.

Parameters:

Name Type Description Default
off int
required
name str
required
Source code in smpclient/requests/file_management.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class FileDownload(smpfs.FileDownloadRequest, _FileGroupBase):
    """Download contents of an existing file from specified path.


    Client applications must keep track of data they have already downloaded and
    where their position in the file is, and issue subsequent requests, with
    modified offset, to gather the entire file.

    Request does not carry size of requested chunk, the size is specified by
    application itself. Note that file handles will remain open for consecutive
    requests (as long as an idle timeout has not been reached and another
    transport does not make use of uploading/downloading files using fs_mgmt),
    but files are not exclusively owned by SMP, for the time of download
    session, and may change between requests or even be removed.

    Args:
        off (int): 
        name (str): 

    """
    _Response = smpfs.FileDownloadResponse
    _Response = smpfs.FileDownloadResponse

FileUpload

Bases: FileUploadRequest, _FileGroupBase

Upload a file to a specified location.

Command will automatically overwrite existing file or create a new one if it does not exist at specified path. The protocol supports stateless upload where each requests carries different chunk of a file and it is client side responsibility to track progress of upload.

Note that file handles will remain open for consecutive requests (as long as an idle timeout has not been reached, but files are not exclusively owned by SMP, for the time of download session, and may change between requests or even be removed. Note that file handles will remain open for consecutive requests (as long as an idle timeout has not been reached and another transport does not make use of uploading/downloading files using fs_mgmt), but files are not exclusively owned by MCUmgr, for the time of download session, and may change between requests or even be removed.

Parameters:

Name Type Description Default
off int
required
name str
required
len int | None
required
Source code in smpclient/requests/file_management.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class FileUpload(smpfs.FileUploadRequest, _FileGroupBase):
    """Upload a file to a specified location.


    Command will automatically overwrite existing file or create a new one if it
    does not exist at specified path. The protocol supports stateless upload
    where each requests carries different chunk of a file and it is client side
    responsibility to track progress of upload.

    Note that file handles will remain open for consecutive requests (as long as
    an idle timeout has not been reached, but files are not exclusively owned by
    SMP, for the time of download session, and may change between requests or
    even be removed. Note that file handles will remain open for consecutive
    requests (as long as an idle timeout has not been reached and another
    transport does not make use of uploading/downloading files using fs_mgmt),
    but files are not exclusively owned by MCUmgr, for the time of download
    session, and may change between requests or even be removed.

    Args:
        off (int): 
        name (str): 
        len (int | None): 

    """
    _Response = smpfs.FileUploadResponse
    _Response = smpfs.FileUploadResponse

FileStatus

Bases: FileStatusRequest, _FileGroupBase

Retrieve status of an existing file from specified path of a target device.

Parameters:

Name Type Description Default
name str
required
Source code in smpclient/requests/file_management.py 
70
71
72
73
74
75
76
77
78
class FileStatus(smpfs.FileStatusRequest, _FileGroupBase):
    """Retrieve status of an existing file from specified path of a target device.

    Args:
        name (str): 

    """
    _Response = smpfs.FileStatusResponse
    _Response = smpfs.FileStatusResponse

FileHashChecksum

Bases: FileHashChecksumRequest, _FileGroupBase

Generate a hash/checksum of an existing file at a specified path on a target device.

Note that kernel heap memory is required for buffers to be allocated for this to function, and large stack memory buffers are required for generation of the output hash/checksum. Requires CONFIG_MCUMGR_GRP_FS_CHECKSUM_HASH to be enabled for the base functionality, supported hash/checksum are opt-in with CONFIG_MCUMGR_GRP_FS_CHECKSUM_IEEE_CRC32 or CONFIG_MCUMGR_GRP_FS_HASH_SHA256.

Parameters:

Name Type Description Default
name str
required
type Optional[Literal[crc32]]
required
off int | None
required
len int | None
required
Source code in smpclient/requests/file_management.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
class FileHashChecksum(smpfs.FileHashChecksumRequest, _FileGroupBase):
    """Generate a hash/checksum of an existing file at a specified path on a target device.


    Note that kernel heap memory is required for buffers to be allocated for
    this to function, and large stack memory buffers are required for generation
    of the output hash/checksum. Requires `CONFIG_MCUMGR_GRP_FS_CHECKSUM_HASH` to
    be enabled for the base functionality, supported hash/checksum are opt-in
    with `CONFIG_MCUMGR_GRP_FS_CHECKSUM_IEEE_CRC32` or
    `CONFIG_MCUMGR_GRP_FS_HASH_SHA256`.

    Args:
        name (str): 
        type (Optional[Literal[crc32]]): 
        off (int | None): 
        len (int | None): 

    """
    _Response = smpfs.FileHashChecksumResponse
    _Response = smpfs.FileHashChecksumResponse

SupportedFileHashChecksumTypes

Bases: SupportedFileHashChecksumTypesRequest, _FileGroupBase

List the hash and checksum types are available on a device.

Requires Kconfig CONFIG_MCUMGR_GRP_FS_CHECKSUM_HASH_SUPPORTED_CMD to be enabled.

Source code in smpclient/requests/file_management.py 
103
104
105
106
107
108
109
110
111
class SupportedFileHashChecksumTypes(smpfs.SupportedFileHashChecksumTypesRequest, _FileGroupBase):
    """List the hash and checksum types are available on a device.


    Requires Kconfig `CONFIG_MCUMGR_GRP_FS_CHECKSUM_HASH_SUPPORTED_CMD` to be enabled.

    """
    _Response = smpfs.SupportedFileHashChecksumTypesResponse
    _Response = smpfs.SupportedFileHashChecksumTypesResponse

FileClose

Bases: FileCloseRequest, _FileGroupBase

Close all open file handles held by fs_mgmt upload/download requests.

Source code in smpclient/requests/file_management.py 
114
115
116
117
118
119
class FileClose(smpfs.FileCloseRequest, _FileGroupBase):
    """Close all open file handles held by fs_mgmt upload/download requests.

    """
    _Response = smpfs.FileCloseResponse
    _Response = smpfs.FileCloseResponse