Struct co2mon::OpenOptions

pub struct OpenOptions { /* fields omitted */ }

Sensor open options.

Opens the first available device with the USB Vendor ID 0x04d9 and Product ID 0xa052, a 0 encryption key and a 5 seconds timeout.

Normally there’s no need to change the encryption key.

Example

let sensor = OpenOptions::new()
    .timeout(Some(Duration::from_secs(10)))
    .open()?;

Implementations

impl OpenOptions

pub fn new() -> Self

Creates a new set of options to be configured.

The defaults are opening the first connected sensor and a timeout of 5 seconds.

Example

let sensor = OpenOptions::new()
    .timeout(Some(Duration::from_secs(10)))
    .open()?;

pub fn with_serial_number<S: Into<String>>(&mut self, sn: S) -> &mut Self

Sets the serial number of the sensor device to open.

The serial number appears to be the firmware version.

Example

let sensor = OpenOptions::new()
    .with_serial_number("1.40")
    .open()?;

pub fn with_path(&mut self, path: CString) -> &mut Self

Sets the path to the sensor device to open.

Example

let sensor = OpenOptions::new()
    .with_path(CString::new("/dev/bus/usb/001/004")?)
    .open()?;

pub fn with_key(&mut self, key: [u8; 8]) -> &mut Self

Sets the encryption key.

The key is used to encrypt the communication with the sensor, but changing it is probably not very useful.

Example

let sensor = OpenOptions::new()
    .with_key([0x62, 0xea, 0x1d, 0x4f, 0x14, 0xfa, 0xe5, 0x6c])
    .open()?;

pub fn timeout(&mut self, timeout: Option<Duration>) -> &mut Self

Sets the read timeout.

Example

let sensor = OpenOptions::new()
    .timeout(Some(Duration::from_secs(10)))
    .open()?;

pub fn open(&self) -> Result<Sensor>

Opens the sensor.

Example

let sensor = OpenOptions::new()
    .timeout(Some(Duration::from_secs(10)))
    .open()?;

Trait Implementations

impl Clone for OpenOptions

fn clone(&self) -> OpenOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Default for OpenOptions

fn default() -> Self

Returns the “default value” for a type.