#include <UpgraderBase.h>
◆ Partition
◆ ~UpgraderBase()
virtual Ota::UpgraderBase::~UpgraderBase |
( |
| ) |
|
|
inlinevirtual |
◆ abort()
virtual bool Ota::UpgraderBase::abort |
( |
| ) |
|
|
inlinevirtual |
◆ begin()
virtual bool Ota::UpgraderBase::begin |
( |
Partition |
partition, |
|
|
size_t |
size = 0 |
|
) |
| |
|
pure virtual |
Prepares a partition for an upgrade. The preparation is bootloader and architecture dependent.
- Parameters
-
- Return values
-
Implemented in Ota::RbootUpgrader, and Ota::IdfUpgrader.
◆ end()
virtual bool Ota::UpgraderBase::end |
( |
| ) |
|
|
pure virtual |
◆ getBootPartition()
virtual Partition Ota::UpgraderBase::getBootPartition |
( |
| ) |
|
|
pure virtual |
Gets information about the partition that is set as the default one to boot.
- Note
- The returned partition can be different than the current running partition.
- Return values
-
Implemented in Ota::RbootUpgrader, and Ota::IdfUpgrader.
◆ getBootPartitions()
Gets information about all bootable partitions.
- Return values
-
◆ getNextBootPartition()
◆ getRunningPartition()
virtual Partition Ota::UpgraderBase::getRunningPartition |
( |
| ) |
|
|
pure virtual |
Gets information about the partition from which the current application is running.
- Note
- The returned partition can be different than the default boot partition.
- Return values
-
Implemented in Ota::RbootUpgrader, and Ota::IdfUpgrader.
◆ getSlot()
uint8_t Ota::UpgraderBase::getSlot |
( |
Partition |
partition | ) |
|
|
inline |
Gets slot number for a partition.
- Parameters
-
- Return values
-
◆ setBootPartition()
virtual bool Ota::UpgraderBase::setBootPartition |
( |
Partition |
partition, |
|
|
bool |
save = true |
|
) |
| |
|
pure virtual |
Sets the default partition from where the application will be booted on next restart.
- Parameters
-
partition | |
save | if true the change is persisted on the flash, otherwise it will be valid only for the next boot |
- Return values
-
Implemented in Ota::RbootUpgrader, and Ota::IdfUpgrader.
◆ write()
virtual size_t Ota::UpgraderBase::write |
( |
const uint8_t * |
buffer, |
|
|
size_t |
size |
|
) |
| |
|
pure virtual |
◆ SLOT_NONE
constexpr uint8_t Ota::UpgraderBase::SLOT_NONE {255} |
|
staticconstexpr |
The documentation for this class was generated from the following file: