Struct mlx9064x::register::ControlRegister

pub struct ControlRegister(_);

Expose the fields of the control register (0x800D).

Implementations

impl ControlRegister

pub fn default_mlx90640() -> Self

The default settings (as documented in the datasheet) for the MLX90640.

pub fn default_mlx90641() -> Self

The default settings (as documented in the datasheet) for the MLX90641.

pub fn use_subpages(&self) -> bool

Check if subpages are enabled.

If subpages are disabled, only one page will be updated.

The default is to use subpages.

pub fn set_use_subpages(&mut self, use_subpages: bool)

Enable or disable the use of subpages.

pub fn step_mode(&self) -> bool

Check if step mode is enabled.

Melexis no longer includes step mode in the documentation as the cameras are not calibrated to be run in step mode.

In step mode the camera is idle until signalled with StatusRegister::start_measurement, which then starts a single measurement. The default is continuous mode (i.e. step mode disabled).

pub fn set_step_mode(&mut self, step_mode: bool)

Enable or disable step mode.

It is not recommended to enable step mode, see step_mode for more details.

pub fn data_hold(&self) -> bool

Check if data holding is enabled.

By default data is transferred into RAM for each frame, but if this flag is enabled data will only be written into RAM when the StatusRegister::overwrite_enabled flag is set.

pub fn set_data_hold(&mut self, data_hold: bool)

Enable or disable data holding.

pub fn subpage_repeat(&self) -> bool

Check to see if the camera automatically alternates between subpages.

This value only has an effect when use_subpages is enabled. The default is disabled, meaning the camera automatically alternates between subpages.

pub fn set_subpage_repeat(&mut self, subpage_repeat: bool)

Enable or disable subpage repetition.

pub fn subpage(&self) -> Subpage

Check which subpage will be written to.

This value only has an effect if both use_subpages and subpage_repeat are enabled. The default is 0.

pub fn set_subpage(&mut self, subpage: Subpage)

Set the subpage to update.

pub fn frame_rate(&self) -> FrameRate

The frame rate the camera runs at.

See the note on FrameRate for I²C bus clock rate requirements. The default is 2Hz.

pub fn set_frame_rate(&mut self, frame_rate: FrameRate)

Set the camera’s frame rate.

pub fn resolution(&self) -> Resolution

The resolution to run the internal ADC at.

The default is 18 bits.

pub fn set_resolution(&mut self, resolution: Resolution)

Set the camera’s resolution.

pub fn access_pattern(&self) -> AccessPattern

The access pattern used by the camera.

The default for the MLX90640 is the chess pattern mode, while the default for the MLX90641 is interleaved.

pub fn set_access_pattern(&mut self, access_pattern: AccessPattern)

Set the access pattern to use.

Trait Implementations

impl Clone for ControlRegister

fn clone(&self) -> ControlRegister

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ControlRegister

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for ControlRegister

fn from(buf: &'a [u8]) -> Self

Performs the conversion.

impl From<ControlRegister> for [u8; 2]

fn from(register: ControlRegister) -> Self

Performs the conversion.

impl PartialEq<ControlRegister> for ControlRegister

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for ControlRegister