Skip to content

Intercreate

The Simple Management Protocol (SMP) Intercreate Management group.

ImageUploadWriteRequest

Bases: WriteRequest

Upload an image to an application-defined location like a secondary MCU.

Source code in smp/user/intercreate.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class ImageUploadWriteRequest(message.WriteRequest):
    """Upload an image to an application-defined location like a secondary MCU."""

    _GROUP_ID = header.UserGroupId.INTERCREATE
    _COMMAND_ID = header.CommandId.Intercreate.UPLOAD

    off: int
    """The offset in the image to write to."""

    data: bytes
    """The data to write to the image."""

    image: int | None = None
    """The image to write to; required when off == 0."""

    len: int | None = None
    """The length of the data to write; required when off == 0."""

    sha: bytes | None = None
    """The SHA-256 hash of the image; optional when off == 0, else ignored."""

off: int instance-attribute

The offset in the image to write to.

data: bytes instance-attribute

The data to write to the image.

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

The image to write to; required when off == 0.

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

The length of the data to write; required when off == 0.

sha: bytes | None = None class-attribute instance-attribute

The SHA-256 hash of the image; optional when off == 0, else ignored.

ImageUploadWriteResponse

Bases: WriteResponse

Success response to an image upload request.

Source code in smp/user/intercreate.py 
32
33
34
35
36
37
38
39
class ImageUploadWriteResponse(message.WriteResponse):
    """Success response to an image upload request."""

    _GROUP_ID = header.UserGroupId.INTERCREATE
    _COMMAND_ID = header.CommandId.Intercreate.UPLOAD

    off: int
    """The offset in the image after the request was written."""

off: int instance-attribute

The offset in the image after the request was written.

IC_MGMT_ERR

Bases: IntEnum

Intercreate Management error codes.

Source code in smp/user/intercreate.py 
42
43
44
45
46
47
48
49
50
@unique
class IC_MGMT_ERR(IntEnum):
    """Intercreate Management error codes."""

    OK = 0
    """No error."""

    INVALID_IMAGE = 1
    """No image matched the image provided."""

OK = 0 class-attribute instance-attribute

No error.

INVALID_IMAGE = 1 class-attribute instance-attribute

No image matched the image provided.

ErrorV1

Bases: ErrorV1

Intercreate Management error response.

Source code in smp/user/intercreate.py 
53
54
55
56
class ErrorV1(error.ErrorV1):
    """Intercreate Management error response."""

    _GROUP_ID = header.UserGroupId.INTERCREATE

ErrorV2

Bases: ErrorV2[IC_MGMT_ERR]

Intercreate Management error response.

Source code in smp/user/intercreate.py 
59
60
61
62
class ErrorV2(error.ErrorV2[IC_MGMT_ERR]):
    """Intercreate Management error response."""

    _GROUP_ID = header.UserGroupId.INTERCREATE