sbp.bootload module

Messages for the bootloading configuration of a Piksi 2.3.1. This message group does not apply to Piksi Multi.

Note that some of these messages share the same message type ID for both the host request and the device response.

class sbp.bootload.MsgBootloaderHandshakeDepA(sbp=None, **kwargs)[source]

Bases: sbp.msg.SBP

SBP class for message MSG_BOOTLOADER_HANDSHAKE_DEP_A (0x00B0).

You can have MSG_BOOTLOADER_HANDSHAKE_DEP_A inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

Deprecated.

sbp
: SBP
SBP parent object to inherit from.
handshake
: array
Version number string (not NULL terminated)
sender
: int
Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).
from_binary(d)[source]

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)[source]

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)[source]
handshake
to_binary()[source]

Produce a framed/packed SBP message.

to_json_dict()[source]
class sbp.bootload.MsgBootloaderHandshakeReq(sbp=None, **kwargs)[source]

Bases: sbp.msg.SBP

SBP class for message MSG_BOOTLOADER_HANDSHAKE_REQ (0x00B3).

You can have MSG_BOOTLOADER_HANDSHAKE_REQ inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The handshake message request from the host establishes a

handshake between the device bootloader and the host. The response from the device is MSG_BOOTLOADER_HANDSHAKE_RESP.

static from_json(s)[source]

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)[source]
class sbp.bootload.MsgBootloaderHandshakeResp(sbp=None, **kwargs)[source]

Bases: sbp.msg.SBP

SBP class for message MSG_BOOTLOADER_HANDSHAKE_RESP (0x00B4).

You can have MSG_BOOTLOADER_HANDSHAKE_RESP inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The handshake message response from the device establishes a

handshake between the device bootloader and the host. The request from the host is MSG_BOOTLOADER_HANDSHAKE_REQ. The payload contains the bootloader version number and the SBP protocol version number.

sbp
: SBP
SBP parent object to inherit from.
flags
: int
Bootloader flags
version
: string
Bootloader version number
sender
: int
Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).
flags
from_binary(d)[source]

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)[source]

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)[source]
to_binary()[source]

Produce a framed/packed SBP message.

to_json_dict()[source]
version
class sbp.bootload.MsgBootloaderJumpToApp(sbp=None, **kwargs)[source]

Bases: sbp.msg.SBP

SBP class for message MSG_BOOTLOADER_JUMP_TO_APP (0x00B1).

You can have MSG_BOOTLOADER_JUMP_TO_APP inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The host initiates the bootloader to jump to the application.

sbp
: SBP
SBP parent object to inherit from.
jump
: int
Ignored by the device
sender
: int
Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).
from_binary(d)[source]

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)[source]

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)[source]
jump
to_binary()[source]

Produce a framed/packed SBP message.

to_json_dict()[source]
class sbp.bootload.MsgNapDeviceDnaReq(sbp=None, **kwargs)[source]

Bases: sbp.msg.SBP

SBP class for message MSG_NAP_DEVICE_DNA_REQ (0x00DE).

You can have MSG_NAP_DEVICE_DNA_REQ inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The device message from the host reads a unique device

identifier from the SwiftNAP, an FPGA. The host requests the ID by sending a MSG_NAP_DEVICE_DNA_REQ message. The device responds with a MSG_NAP_DEVICE_DNA_RESP message with the device ID in the payload. Note that this ID is tied to the FPGA, and not related to the Piksi’s serial number.

static from_json(s)[source]

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)[source]
class sbp.bootload.MsgNapDeviceDnaResp(sbp=None, **kwargs)[source]

Bases: sbp.msg.SBP

SBP class for message MSG_NAP_DEVICE_DNA_RESP (0x00DD).

You can have MSG_NAP_DEVICE_DNA_RESP inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The device message from the host reads a unique device

identifier from the SwiftNAP, an FPGA. The host requests the ID by sending a MSG_NAP_DEVICE_DNA_REQ message. The device responds with a MSG_NAP_DEVICE_DNA_RESP messagage with the device ID in the payload. Note that this ID is tied to the FPGA, and not related to the Piksi’s serial number.

sbp
: SBP
SBP parent object to inherit from.
dna
: array
57-bit SwiftNAP FPGA Device ID. Remaining bits are padded

on the right.

sender
: int
Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).
dna
from_binary(d)[source]

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)[source]

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)[source]
to_binary()[source]

Produce a framed/packed SBP message.

to_json_dict()[source]