MetaWear C++ API  0.18.0
C++ implementation of the MetaWear protocol
Enumerations | Functions
colordetector_tcs34725.h File Reference

Communicates with the TCS34725 color detector. More...

#include "sensor_common.h"

Go to the source code of this file.

Enumerations

enum  MblMwColorDetectorTcs34725Gain { MBL_MW_CD_TCS34725_GAIN_1X = 0, MBL_MW_CD_TCS34725_GAIN_4X, MBL_MW_CD_TCS34725_GAIN_16X, MBL_MW_CD_TCS34725_GAIN_60X }
 Available analog gain scale values.
 

Functions

METAWEAR_API MblMwDataSignalmbl_mw_cd_tcs34725_get_adc_data_signal (const MblMwMetaWearBoard *board)
 Retrieves the data signal representing detected ADC values for clear, red, green, and blue. More...
 
METAWEAR_API void mbl_mw_cd_tcs34725_set_integration_time (MblMwMetaWearBoard *board, float time)
 Sets the integration time. More...
 
METAWEAR_API void mbl_mw_cd_tcs34725_set_gain (MblMwMetaWearBoard *board, MblMwColorDetectorTcs34725Gain gain)
 Sets the analog gain scale. More...
 
METAWEAR_API void mbl_mw_cd_tcs34725_enable_illuminator_led (MblMwMetaWearBoard *board)
 Enable the illuminator LED. More...
 
METAWEAR_API void mbl_mw_cd_tcs34725_disable_illuminator_led (MblMwMetaWearBoard *board)
 Disable the illuminator LED. More...
 
METAWEAR_API void mbl_mw_cd_tcs34725_write_config (const MblMwMetaWearBoard *board)
 Writes the configuration to the sensor. More...
 

Variables

const uint8_t MBL_MW_CD_TCS34725_ADC_CLEAR_INDEX = 0
 Indices for component values of the color adc data signal, used with mbl_mw_datasignal_get_component.
 
const uint8_t MBL_MW_CD_TCS34725_ADC_RED_INDEX = 1
 Indices for component values of the color adc data signal, used with mbl_mw_datasignal_get_component.
 
const uint8_t MBL_MW_CD_TCS34725_ADC_GREEN_INDEX = 2
 Indices for component values of the color adc data signal, used with mbl_mw_datasignal_get_component.
 
const uint8_t MBL_MW_CD_TCS34725_ADC_BLUE_INDEX = 3
 Indices for component values of the color adc data signal, used with mbl_mw_datasignal_get_component.
 

Detailed Description

Communicates with the TCS34725 color detector.

Function Documentation

◆ mbl_mw_cd_tcs34725_disable_illuminator_led()

METAWEAR_API void mbl_mw_cd_tcs34725_disable_illuminator_led ( MblMwMetaWearBoard board)

Disable the illuminator LED.

Parameters
boardBoard to modify

◆ mbl_mw_cd_tcs34725_enable_illuminator_led()

METAWEAR_API void mbl_mw_cd_tcs34725_enable_illuminator_led ( MblMwMetaWearBoard board)

Enable the illuminator LED.

Parameters
boardBoard to modify

◆ mbl_mw_cd_tcs34725_get_adc_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_cd_tcs34725_get_adc_data_signal ( const MblMwMetaWearBoard board)

Retrieves the data signal representing detected ADC values for clear, red, green, and blue.

Parameters
boardBoard the sensor resides on

◆ mbl_mw_cd_tcs34725_set_gain()

METAWEAR_API void mbl_mw_cd_tcs34725_set_gain ( MblMwMetaWearBoard board,
MblMwColorDetectorTcs34725Gain  gain 
)

Sets the analog gain scale.

Parameters
boardBoard to modify
gainNew gain scale to use

◆ mbl_mw_cd_tcs34725_set_integration_time()

METAWEAR_API void mbl_mw_cd_tcs34725_set_integration_time ( MblMwMetaWearBoard board,
float  time 
)

Sets the integration time.

Parameters
boardBoard to modify
timeNew integration time to use, between [2.4, 614.4] milliseconds

◆ mbl_mw_cd_tcs34725_write_config()

METAWEAR_API void mbl_mw_cd_tcs34725_write_config ( const MblMwMetaWearBoard board)

Writes the configuration to the sensor.

Parameters
boardBoard the sensor resides on