Enum FrameRate

pub enum FrameRate {
    Half,
    One,
    Two,
    Four,
    Eight,
    Sixteen,
    ThirtyTwo,
    SixtyFour,
}

The frame rates the cameras are able to run at.

Before using the higher refresh rates, ensure your I²C bus is fast enough. Because the image is smaller (and it has a more efficient access pattern) the MLX90641 can use the faster frame rates with slower I²C bus speeds. With the read patterns used by the included MelexisCamera implementations, here are the maximum frame rates for common different bus speeds.

Bus Speed	MLX90640 (Chess)	MLX 90640 (Interleaved)	MLX90641
100kHz	4Hz	8Hz	16Hz
400kHz	16Hz	32Hz	64Hz
1MHz	64Hz (barely, 32Hz is more realistic)	32Hz	64Hz

On top of the bus speed, your hardware also has to be able to process each frame before the next frame is ready. As a final warning, the EEPROM cannot be accessed above 400kHz so if you’re using a 1MHz bus speed you will need to read the calibration data at 400kHz then increase the bus speed afterwards.

Usage

Besides accessing the enum variants directly, standard conversion traits are provided for both f32, u8, and core::time::Duration.

use core::convert::TryInto;
use core::time::Duration;

assert_eq!(Duration::from_secs(2), FrameRate::Half.into());
assert_eq!(8.try_into(), Ok(FrameRate::Eight));
assert_eq!(0.5f32.try_into(), Ok(FrameRate::Half));
assert_eq!(0.5f32, FrameRate::Half.into());

Variants

Half

0.5 Hz, one frame every two seconds.

One

1Hz.

Two

2Hz, which is also the default for the MLX90640 and MLX90641.

Four

4Hz.

Eight

8Hz.

Sixteen

16 Hz.

ThirtyTwo

32Hz.

SixtyFour

64Hz.

Trait Implementations

impl Clone for FrameRate

fn clone(&self) -> FrameRate

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FrameRate

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

Formats the value using the given formatter.

impl Default for FrameRate

fn default() -> Self

Returns the “default value” for a type.

impl From<FrameRate> for Duration

fn from(frame_rate: FrameRate) -> Self

Convert a frame rate into the per-frame duration.

impl From<FrameRate> for f32

fn from(frame_rate: FrameRate) -> Self

Converts to this type from the input type.

impl Ord for FrameRate

fn cmp(&self, other: &FrameRate) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FrameRate

fn eq(&self, other: &FrameRate) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FrameRate

fn partial_cmp(&self, other: &FrameRate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<f32> for FrameRate

fn try_from(value: f32) -> Result<Self, Self::Error>

Attempt to create a FrameRate from a number.

This will only work if the source number exactly matches one of the values named as a variant.

assert_eq!(FrameRate::try_from(0.5), Ok(FrameRate::Half));
let almost_half = 0.50001;
assert!(FrameRate::try_from(almost_half).is_err());

type Error = LibraryError

The type returned in the event of a conversion error.

impl TryFrom<u8> for FrameRate

type Error = LibraryError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FrameRate

impl Eq for FrameRate

impl StructuralPartialEq for FrameRate