remove doctest from lib
This commit is contained in:
parent
81005c1aab
commit
b261eb61a2
1 changed files with 0 additions and 76 deletions
76
src/lib.rs
76
src/lib.rs
|
@ -5,82 +5,6 @@
|
|||
//! In the examples you can find a demo how to use the library in Linux using the linux-embedded-hal crate (e.g. on a RPI).
|
||||
//! ```no_run
|
||||
|
||||
//! extern crate bme680;
|
||||
//! extern crate embedded_hal;
|
||||
//! // Note that you'll have to import your board crates types corresponding to
|
||||
//! // Delay and I2cdev.
|
||||
//!
|
||||
//! use bme680::*;
|
||||
//! use embedded_hal::blocking::i2c;
|
||||
//! use hal::*;
|
||||
//! use std::result;
|
||||
//! use std::time::Duration;
|
||||
//! use std::thread::sleep;
|
||||
//!
|
||||
//! # mod hal {
|
||||
//! # use super::*;
|
||||
//! # use embedded_hal::blocking::delay;
|
||||
//! #
|
||||
//! # #[derive(Debug)]
|
||||
//! # pub struct Delay {}
|
||||
//! #
|
||||
//! # impl delay::DelayMs<u8> for Delay {
|
||||
//! # fn delay_ms(&mut self, _ms: u8) {}
|
||||
//! # }
|
||||
//! #
|
||||
//! # #[derive(Debug)]
|
||||
//! # pub enum I2CError {}
|
||||
//! #
|
||||
//! # pub struct I2cdev {}
|
||||
//! #
|
||||
//! # impl i2c::Write for I2cdev {
|
||||
//! # type Error = I2CError;
|
||||
//! #
|
||||
//! # fn write<'w>(&mut self, addr: u8, bytes: &'w [u8]) -> result::Result<(), Self::Error> {
|
||||
//! # Ok(())
|
||||
//! # }
|
||||
//! # }
|
||||
//! #
|
||||
//! # impl i2c::Read for I2cdev {
|
||||
//! # type Error = I2CError;
|
||||
//! #
|
||||
//! # fn read<'w>(&mut self, addr: u8, bytes: &'w mut [u8]) -> result::Result<(), Self::Error> {
|
||||
//! # Ok(())
|
||||
//! # }
|
||||
//! # }
|
||||
//! # }
|
||||
//!
|
||||
//! fn main() -> result::Result<(), Error<<hal::I2cdev as i2c::Read>::Error, <hal::I2cdev as i2c::Write>::Error>>
|
||||
//! {
|
||||
//! // Initialize device
|
||||
//! let i2c = I2cdev {}; // Your I2C device construction will look different, perhaps using I2cdev::new(..)
|
||||
//! let mut delayer = Delay {}; // Your Delay construction will look different, perhaps using Delay::new(..)
|
||||
//! let mut dev = Bme680::init(i2c, &mut delayer, I2CAddress::Primary)?;
|
||||
//! let settings = SettingsBuilder::new()
|
||||
//! .with_humidity_oversampling(OversamplingSetting::OS2x)
|
||||
//! .with_pressure_oversampling(OversamplingSetting::OS4x)
|
||||
//! .with_temperature_oversampling(OversamplingSetting::OS8x)
|
||||
//! .with_temperature_filter(IIRFilterSize::Size3)
|
||||
//! .with_gas_measurement(Duration::from_millis(1500), 320, 25)
|
||||
//! .with_run_gas(true)
|
||||
//! .build();
|
||||
//! dev.set_sensor_settings(&mut delayer, settings)?;
|
||||
//! let profile_duration = dev.get_profile_dur(&settings.0)?;
|
||||
//!
|
||||
//! // Read sensor data
|
||||
//! dev.set_sensor_mode(&mut delayer, PowerMode::ForcedMode)?;
|
||||
//! sleep(profile_duration);
|
||||
//! let (data, _state) = dev.get_sensor_data(&mut delayer)?;
|
||||
//!
|
||||
//! println!("Temperature {}°C", data.temperature_celsius());
|
||||
//! println!("Pressure {}hPa", data.pressure_hpa());
|
||||
//! println!("Humidity {}%", data.humidity_percent());
|
||||
//! println!("Gas Resistence {}Ω", data.gas_resistance_ohm());
|
||||
//!
|
||||
//! Ok(())
|
||||
//! }
|
||||
//! ```
|
||||
|
||||
#![no_std]
|
||||
#![forbid(unsafe_code)]
|
||||
|
||||
|
|
Loading…
Reference in a new issue