Struct EspOta

pub struct EspOta(/* private fields */);

Implementations

impl EspOta

pub fn new() -> Result<Self, EspError>

Obtains an instance of EspOta. Only one instance can exist at a time.

Errors

Returns an error if EspOta already exists.

pub fn get_boot_slot(&self) -> Result<Slot, EspError>

Returns the currently configured boot slot.

Errors

Returns an error if partition table is invalid or a flash read operation failed.

pub fn get_running_slot(&self) -> Result<Slot, EspError>

Returns the currently running app slot.

Errors

Returns an error if no partition is found or flash read operation failed.

pub fn get_update_slot(&self) -> Result<Slot, EspError>

Returns the slot of the next OTA app partition to be used for the new firmware.

Errors

Returns an error if OTA data partition is invalid, or no eligible OTA app slot partition was found.

pub fn get_last_invalid_slot(&self) -> Result<Option<Slot>, EspError>

Returns the last slot with invalid state (invalid or aborted image).

pub fn is_factory_reset_supported(&self) -> Result<bool, EspError>

Returns true if a factory partition is present.

pub fn factory_reset(&mut self) -> Result<(), EspError>

Sets the boot partition to factory partition.

Errors

Returns an error if factory partition is not present or boot partition could not be set.

pub fn initiate_update(&mut self) -> Result<EspOtaUpdate<'_>, EspError>

Initiates the OTA process and returns an instance of EspOtaUpdate to be used for performing the OTA operations.

Errors

Returns an error if OTA could not be initiated (OTA partition not found, flash error).

pub fn mark_running_slot_valid(&mut self) -> Result<(), EspError>

Marks the current application as valid.

If rollback is enabled, the application must confirm its operability by calling mark_running_slot_valid() function, otherwise the application will be rolled back upon reboot.

pub fn mark_running_slot_invalid_and_reboot(&mut self) -> EspError

Rolls back to the previously workable app with reboot.

If rollback is successful then device will reset, otherwise the function will return Err. If the flash does not have at least one app (except the running app) then rollback is not possible.

Errors

Returns an error if the rollback was not possible.

Trait Implementations

impl Debug for EspOta

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for EspOta

fn drop(&mut self)

Executes the destructor for this type.

impl ErrorType for EspOta

type Error = EspIOError

Error type of all the IO operations on this type.

impl Ota for EspOta

type Update<'a> = EspOtaUpdate<'a> where Self: 'a

fn get_boot_slot(&self) -> Result<Slot, Self::Error>

fn get_running_slot(&self) -> Result<Slot, Self::Error>

fn get_update_slot(&self) -> Result<Slot, Self::Error>

fn is_factory_reset_supported(&self) -> Result<bool, Self::Error>

fn factory_reset(&mut self) -> Result<(), Self::Error>

fn initiate_update(&mut self) -> Result<Self::Update<'_>, Self::Error>

fn mark_running_slot_valid(&mut self) -> Result<(), Self::Error>

fn mark_running_slot_invalid_and_reboot(&mut self) -> Self::Error