Figaro TGS 2600

Sensors::Tgs2600 decodes data from Figaro TGS 2600 air contaminants sensors. More...

Collaboration diagram for Figaro TGS 2600:

Files
file	tgs2600.h
	Sensors::Tgs2600 decodes data from Figaro TGS 2600 air contaminants sensors.

Classes
class	Sensors::Tgs2600< TLoadResistance >
	Decodes data from Figaro TGS 2600 air contaminants sensors. More...

Detailed Description

Sensors::Tgs2600 decodes data from Figaro TGS 2600 air contaminants sensors.

---

Class Documentation

Sensors::Tgs2600

class Sensors::Tgs2600

template<uint32_t TLoadResistance>
class Sensors::Tgs2600< TLoadResistance >

Decodes data from Figaro TGS 2600 air contaminants sensors.

Template Parameters

TLoadResistance

Value of the load resistance Rl as specified in the datasheet.

See also

http://www.figarosensor.com/products/2600pdf.pdf

Public Member Functions
	Tgs2600 ()
	Initializes the TGS 2600 sensor decoder. More...
uint32_t	sensorResistance (uint16_t vout) const
	Retrieves the raw sensor resistance for a given vout. More...
uint32_t	sensorResistanceCalibrated (uint32_t vout) const
	Retrieves the calibrated sensor resistance for a given vout. More...
float	sensorResistanceRelative (uint32_t vout) const
	Retrieves the calibrated relative sensor resistance for a given vout. More...
void	setReferenceHumidity (float humidity)
	Sets reference humitidty for sensorResistanceCalibrated() and sensorResistanceRelative() More...
void	setReferenceTemperature (float temperature)
	Sets reference temperature for sensorResistanceCalibrated() and sensorResistanceRelative(). More...
void	setReferenceResistance (float resistance)
	Sets reference resistance for sensorResistanceRelative(). More...
float	calibration () const
	Returns the calculated calibration factor influenced by reference humidity and reference temperature. More...

Constructor & Destructor Documentation

Tgs2600()

template<uint32_t TLoadResistance>

Sensors::Tgs2600< TLoadResistance >::Tgs2600 ( )

inline

Initializes the TGS 2600 sensor decoder.

Member Function Documentation

sensorResistance()

template<uint32_t TLoadResistance>

uint32_t Sensors::Tgs2600< TLoadResistance >::sensorResistance ( uint16_t  vout ) const

inline

Retrieves the raw sensor resistance for a given vout.

Parameters

vout	Sensor voltage meassured using an Analog to Digital Convertor (ADC).

Returns

The sensor resistance or UINT32_MAX if vout is 0.

sensorResistanceCalibrated()

template<uint32_t TLoadResistance>

uint32_t Sensors::Tgs2600< TLoadResistance >::sensorResistanceCalibrated ( uint32_t  vout ) const

inline

Retrieves the calibrated sensor resistance for a given vout.

The calibration is based on reference humidity and temperature specified with setReferenceHumidity() and setReferenceTemperature(). See http://www.atmos-meas-tech.net/5/1925/2012/amt-5-1925-2012.pdf for a detailed explanation of the approximation.

Parameters

vout	Voltage meassured using an Analog to Digital Convertor (ADC).

Returns

The sensor resistance or UINT32_MAX if vout is 0.

sensorResistanceRelative()

template<uint32_t TLoadResistance>

float Sensors::Tgs2600< TLoadResistance >::sensorResistanceRelative ( uint32_t  vout ) const

inline

Retrieves the calibrated relative sensor resistance for a given vout.

The sensor resistance is calculated based on a reference resistance that can be specified with setReferenceResistance().

Parameters

vout	Voltage meassured using an Analog to Digital Convertor (ADC).

Returns

The sensor resistance.

See also

sensorResistanceCalibrated

setReferenceHumidity()

template<uint32_t TLoadResistance>

void Sensors::Tgs2600< TLoadResistance >::setReferenceHumidity ( float  humidity )

inline

Sets reference humitidty for sensorResistanceCalibrated() and sensorResistanceRelative()

Parameters

humidity

Reference humidity.

setReferenceTemperature()

template<uint32_t TLoadResistance>

void Sensors::Tgs2600< TLoadResistance >::setReferenceTemperature ( float  temperature )

inline

Sets reference temperature for sensorResistanceCalibrated() and sensorResistanceRelative().

Parameters

temperature

Reference temperature.

setReferenceResistance()

template<uint32_t TLoadResistance>

void Sensors::Tgs2600< TLoadResistance >::setReferenceResistance ( float  resistance )

inline

Sets reference resistance for sensorResistanceRelative().

Parameters

resistance

Reference resistance.

calibration()

template<uint32_t TLoadResistance>

float Sensors::Tgs2600< TLoadResistance >::calibration ( ) const

inline

Returns the calculated calibration factor influenced by reference humidity and reference temperature.

Returns

The calculated calibration factor.

See also

sensorResistanceCalibrated

setReferenceHumidity, setReferenceTemperature