Struct Ota

pub struct Ota<'a, F>
where
    F: Storage,
{ /* private fields */ }

This is used to manipulate the OTA-data partition.

This will ever only deal with OTA-0 and OTA-1 since these two slots are supported by the ESP-IDF bootloader.

Implementations

impl<'a, F> Ota<'a, F>

where F: Storage,

pub fn new(flash: &'a mut FlashRegion<'a, F>) -> Result<Ota<'a, F>, Error>

Create a Ota instance from the given FlashRegion

Errors

A crate::partitions::Error::InvalidPartition if the given flash region doesn’t represent a Data/Ota partition or the size is unexpected

pub fn current_slot(&mut self) -> Result<Slot, Error>

Returns the currently active OTA-slot.

pub fn set_current_slot(&mut self, slot: Slot) -> Result<(), Error>

Sets the currently active OTA-slot.

Passing Slot::None will reset the OTA-data

pub fn set_current_ota_state( &mut self, state: OtaImageState, ) -> Result<(), Error>

Set the OtaImageState of the currently selected slot.

Errors

A crate::partitions::Error::InvalidState if the currently selected slot is Slot::None

pub fn current_ota_state(&mut self) -> Result<OtaImageState, Error>

Get the OtaImageState of the currently selected slot.

Errors

A crate::partitions::Error::InvalidState if the currently selected slot is Slot::None

Trait Implementations

impl<'a, F> Debug for Ota<'a, F>

where F: Storage + Debug,

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

Formats the value using the given formatter.

impl<'a, F> Format for Ota<'a, F>

where F: Storage, &'a mut FlashRegion<'a, F>: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.