[][src]Crate veml6040

This is a platform agnostic Rust driver for the VEML6040 RGBW color light sensor, based on the embedded-hal traits.

This driver allows you to:

  • Enable/disable the sensor.
  • Set the integration time.
  • Set the measurement mode.
  • Trigger a measurement when on manual mode.
  • Read the red channel measurement.
  • Read the green channel measurement.
  • Read the blue channel measurement.
  • Read the white channel measurement.
  • Read measurement of all channels at once.

The device

VEML6040 color sensor senses red, green, blue, and white light and incorporates photodiodes, amplifiers, and analog / digital circuits into a single chip using CMOS process. With the color sensor applied, the brightness, and color temperature of backlight can be adjusted base on ambient light source that makes panel looks more comfortable for end user's eyes. VEML6040's adoption of Filtron TM technology achieves the closest ambient light spectral sensitivity to real human eye responses. VEML6040 provides excellent temperature compensation capability for keeping the output stable under changing temperature. VEML6040's function are easily operated via the simple command format of I2C (SMBus compatible) interface protocol. VEML6040's operating voltage ranges from 2.5 V to 3.6 V.

Datasheet: VEML6040

Application note: VEML6040 AN

Usage examples (see also examples folder)

To use this driver, import this crate and an embedded_hal implementation, then instantiate the device.

Please find additional examples using hardware in this repository: driver-examples

Enable and read the color measurement

use linux_embedded_hal::I2cdev;
use veml6040::Veml6040;

let dev = I2cdev::new("/dev/i2c-1").unwrap();
let mut sensor = Veml6040::new(dev);
sensor.enable().unwrap();

let red = sensor.read_red_channel().unwrap();
let green = sensor.read_green_channel().unwrap();
let blue = sensor.read_blue_channel().unwrap();
let white = sensor.read_white_channel().unwrap();

println!("Measurements: red = {}, green = {}, blue = {}, white = {}",
         red, green, blue, white);

Read all the channels at once

use linux_embedded_hal::I2cdev;
use veml6040::Veml6040;

let dev = I2cdev::new("/dev/i2c-1").unwrap();
let mut sensor = Veml6040::new(dev);
sensor.enable().unwrap();

let measurement = sensor.read_all_channels().unwrap();

println!("Measurements: red = {}, green = {}, blue = {}, white = {}",
         measurement.red, measurement.green, measurement.blue,
         measurement.white);

Set the integration time to 320ms

use linux_embedded_hal::I2cdev;
use veml6040::{ Veml6040, IntegrationTime };

let dev = I2cdev::new("/dev/i2c-1").unwrap();
let mut sensor = Veml6040::new(dev);
sensor.enable().unwrap();
sensor.set_integration_time(IntegrationTime::_320ms).unwrap();

Set the measurement mode to manual and trigger a measurement

use linux_embedded_hal::I2cdev;
use veml6040::{ Veml6040, MeasurementMode };

let dev = I2cdev::new("/dev/i2c-1").unwrap();
let mut sensor = Veml6040::new(dev);
sensor.enable().unwrap();
sensor.set_measurement_mode(MeasurementMode::Manual).unwrap();
sensor.trigger_measurement().unwrap();

Structs

AllChannelMeasurement

Result of measurement of all channels

Veml6040

VEML6040 device driver.

Enums

Error

All possible errors in this crate

IntegrationTime

Integration time

MeasurementMode

Possible measurement modes