Struct Config

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

Config register.

This register sets the rate, filter, and interface options of the device. Writes to the config register in normal mode may be ignored. In sleep mode writes are not ignored.

All methods on this struct are constant so that you can create a configuration value at compile time.

Example

use bme280_multibus::{Config, Filter, Standby};

const CONFIG: Config = Config::RESET
    .set_standby_time(Standby::Millis1000)
    .set_filter(Filter::X16)
    .set_spi3w_en(false);

Implementations

impl Config

pub const RESET: Self

Get the reset value of the config register.

Example

use bme280_multibus::Config;

assert_eq!(Config::RESET, Config::default());

pub const fn set_standby_time(self, s: Standby) -> Config

Set the inactive duration t_standby in normal mode.

See Standby for settings, and chapter 3.3.4 in the datasheet for details.

Example

use bme280_multibus::{Config, Standby};

let mut cfg: Config = Config::default();
assert_eq!(cfg.standby_time(), Standby::default());
cfg = cfg.set_standby_time(Standby::Micros500);
assert_eq!(cfg.standby_time(), Standby::Micros500);
cfg = cfg.set_standby_time(Standby::Micros62500);
assert_eq!(cfg.standby_time(), Standby::Micros62500);
cfg = cfg.set_standby_time(Standby::Millis125);
assert_eq!(cfg.standby_time(), Standby::Millis125);
cfg = cfg.set_standby_time(Standby::Millis250);
assert_eq!(cfg.standby_time(), Standby::Millis250);
cfg = cfg.set_standby_time(Standby::Millis500);
assert_eq!(cfg.standby_time(), Standby::Millis500);
cfg = cfg.set_standby_time(Standby::Millis1000);
assert_eq!(cfg.standby_time(), Standby::Millis1000);
cfg = cfg.set_standby_time(Standby::Millis10);
assert_eq!(cfg.standby_time(), Standby::Millis10);
cfg = cfg.set_standby_time(Standby::Millis20);
assert_eq!(cfg.standby_time(), Standby::Millis20);

pub const fn standby_time(&self) -> Standby

Get the standby time.

pub const fn set_filter(self, f: Filter) -> Config

Set the time constant of the IIR filter.

See Filter for settings, and chapter 3.4.4 in the datasheet for details.

Example

use bme280_multibus::{Config, Filter};

let mut cfg: Config = Config::default();
assert_eq!(cfg.filter(), Filter::default());
cfg = cfg.set_filter(Filter::Off);
assert_eq!(cfg.filter(), Filter::Off);
cfg = cfg.set_filter(Filter::X2);
assert_eq!(cfg.filter(), Filter::X2);
cfg = cfg.set_filter(Filter::X4);
assert_eq!(cfg.filter(), Filter::X4);
cfg = cfg.set_filter(Filter::X8);
assert_eq!(cfg.filter(), Filter::X8);
cfg = cfg.set_filter(Filter::X16);
assert_eq!(cfg.filter(), Filter::X16);

pub const fn filter(&self) -> Filter

Get the filter coefficient.

pub const fn set_spi3w_en(self, en: bool) -> Config

Enables the 3-wire SPI itnerface when enabled.

See chapter 6.3 in the datasheet for details.

Example

use bme280_multibus::Config;

let mut cfg: Config = Config::default();
assert_eq!(cfg.spi3w_en(), false);
cfg = cfg.set_spi3w_en(true);
assert_eq!(cfg.spi3w_en(), true);
cfg = cfg.set_spi3w_en(false);
assert_eq!(cfg.spi3w_en(), false);

pub const fn spi3w_en(&self) -> bool

Returns true if 3-wire SPI is enabled.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Config

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Config

fn eq(&self, other: &Config) -> 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 Copy for Config

impl Eq for Config

impl StructuralPartialEq for Config