OtaUpdater

Struct OtaUpdater 

Source
pub struct OtaUpdater<'a, F>
where F: Storage,
{ /* private fields */ }
Expand description

This can be used as more convenient - yet less flexible, way to do OTA updates.

If you need lower level access see crate::ota::Ota

Implementations§

Source§

impl<'a, F> OtaUpdater<'a, F>
where F: Storage,

Source

pub fn new(flash: &'a mut F, buffer: &'a mut [u8; 3072]) -> Result<Self, Error>

Create a new instance of OtaUpdater.

§Errors

Error::Invalid if no OTA data partition or less than two OTA app partition were found.

Source

pub fn selected_partition(&mut self) -> Result<AppPartitionSubType, Error>

Returns the currently selected app partition.

Source

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

Get the OtaImageState of the currently selected partition.

§Errors

A Error::InvalidState if no partition is currently selected.

Source

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

Set the OtaImageState of the currently selected slot.

§Errors

A Error::InvalidState if no partition is currently selected.

Source

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

Selects the next active OTA-slot as current.

After calling this other functions referencing the current partition will use the newly activated partition.

Passing AppPartitionSubType::Factory will reset the OTA-data

Source

pub fn with_next_partition<R>( &mut self, f: impl FnOnce(FlashRegion<'_, F>, AppPartitionSubType) -> R, ) -> Result<R, Error>

Executes the given closure with the partition which would be selected by Self::activate_next_partition.

FlashRegion and the AppPartitionSubType is passed into the closure.

Trait Implementations§

Source§

impl<'a, F> Debug for OtaUpdater<'a, F>
where F: Storage + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, F> Format for OtaUpdater<'a, F>
where F: Storage, &'a mut F: Format, PartitionTable<'a>: Format,

Source§

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

Writes the defmt representation of self to fmt.

Auto Trait Implementations§

§

impl<'a, F> Freeze for OtaUpdater<'a, F>

§

impl<'a, F> RefUnwindSafe for OtaUpdater<'a, F>
where F: RefUnwindSafe,

§

impl<'a, F> Send for OtaUpdater<'a, F>
where F: Send,

§

impl<'a, F> Sync for OtaUpdater<'a, F>
where F: Sync,

§

impl<'a, F> Unpin for OtaUpdater<'a, F>

§

impl<'a, F> !UnwindSafe for OtaUpdater<'a, F>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.