Send a structure of this type to the BootloaderClient state flow to perform the bootloading process on one target node. More...

#include <BootloaderClient.hxx>

Public Attributes
NodeHandle	dst
	Node to send the bootload request to.

uint8_t	memory_space {MemoryConfigDefs::SPACE_FIRMWARE}
	Memory space ID to write into.

uint8_t	request_reboot {1}

uint8_t	request_reboot_after {1}

uint8_t	skip_pip {0}

uint32_t	offset {0}
	Offset at which to start writing.

string	data
	Payload to write.

std::function< void(float)>	progress_callback
	If set, will be called with floats [0.0, 1.0] as the download is progressing.

BootloaderResponse *	response {nullptr}
	This structure will be filled with the returning error code, or zero if the bootloading was successful.

Detailed Description

Send a structure of this type to the BootloaderClient state flow to perform the bootloading process on one target node.

Definition at line 62 of file BootloaderClient.hxx.

Member Data Documentation

◆ data

string openlcb::BootloaderRequest::data

Payload to write.

Definition at line 78 of file BootloaderClient.hxx.

◆ dst

NodeHandle openlcb::BootloaderRequest::dst

Node to send the bootload request to.

Definition at line 65 of file BootloaderClient.hxx.

◆ memory_space

uint8_t openlcb::BootloaderRequest::memory_space {MemoryConfigDefs::SPACE_FIRMWARE}

Memory space ID to write into.

Definition at line 67 of file BootloaderClient.hxx.

◆ offset

uint32_t openlcb::BootloaderRequest::offset {0}

Offset at which to start writing.

Definition at line 76 of file BootloaderClient.hxx.

◆ progress_callback

std::function<void(float)> openlcb::BootloaderRequest::progress_callback

If set, will be called with floats [0.0, 1.0] as the download is progressing.

Definition at line 81 of file BootloaderClient.hxx.

◆ request_reboot

uint8_t openlcb::BootloaderRequest::request_reboot {1}

Definition at line 70 of file BootloaderClient.hxx.

◆ request_reboot_after

uint8_t openlcb::BootloaderRequest::request_reboot_after {1}

Definition at line 72 of file BootloaderClient.hxx.

◆ response

BootloaderResponse* openlcb::BootloaderRequest::response {nullptr}

This structure will be filled with the returning error code, or zero if the bootloading was successful.

Definition at line 84 of file BootloaderClient.hxx.

◆ skip_pip

uint8_t openlcb::BootloaderRequest::skip_pip {0}

Definition at line 74 of file BootloaderClient.hxx.

The documentation for this struct was generated from the following file:

BootloaderClient.hxx

Public Attributes