Temperature sensor. More...

#include <sg_101020015_TemperatureSensor.hpp>

Inheritance diagram for SG::TemperatureSensor:

Collaboration diagram for SG::TemperatureSensor:

[legend]

Public Types
enum	EType { EType::vInvalid = 0, EType::v10_3975 = 3975, EType::v11_4250 = 4250, EType::v12_4250 = 4250, EType::v12_4275 = 4275 }

Public Member Functions
virtual	~TemperatureSensor (void)
	Destructor. More...

	TemperatureSensor (I2CADC &adc, const std::string &n="", const EType etype=EType::v12_4250)
	Constructor. This analog twig must be connected to an I2CADC. More...

	TemperatureSensor (const TemperatureSensor &rhs)
	Copy constructor. More...

TemperatureSensor &	operator= (const TemperatureSensor &rhs)
	Assignment. More...

virtual bool	is_analog (void) const
	This is always `true` for GroveI2CDigital. More...

virtual bool	is_digital (void) const
	This is always `false` for GroveI2CDigital. More...

virtual bool	is_grove_uart (void) const
	This is always `false` for GroveI2C. More...

virtual bool	is_grove_i2c (void) const
	This is always `true` for GroveI2C. More...

virtual bool	is_grove_gpio (void) const
	This is always `false` for GroveI2C. More...

virtual uint32_t	get_sku (void) const
	Return a guess as to the Seeed SKU number based on the grove type. More...

virtual std::string	get_type_name (void) const
	Return a short text string representing the grove type. More...

virtual EGroveType	get_type (void) const
	Return the grove type. More...

virtual std::string	get_name (void) const
	Return the user-supplied name. More...

virtual std::string	get_description (void) const
	Return a multi-word 1-line description of this object. More...


bool	operator== (const TemperatureSensor &rhs) const
	Test object equality. More...

bool	operator!= (const TemperatureSensor &rhs) const
	Test object equality. More...


double	get_celsius (void)
	Get the current temperature. More...

double	get_fahrenheit (void)
	Get the current temperature. More...


bool	operator== (const GroveBase &rhs) const
	Test object equality. More...

bool	operator!= (const GroveBase &rhs) const
	Test object equality. More...

Public Attributes
I2CADC &	i2cadc

EType	type

EGroveType	grove_type
	Grove type. More...

std::string	grove_name
	User-supplied name. More...

Detailed Description

Temperature sensor.

This is an analog sensor which needs to be connected to the I2CADC.

There are several revisions of this sensor, each with different thermistors. The correct value must be provided for the readings to be interpreted correctly.

Revision	Thermistor	Nominal B Constant
v1.0	TTC3A103*39H	3975
v1.1	NCP18WF104F03RC	4250
v1.2	NCP18WF104F03RC	4250

Description	Image
I2C ADC with a temperature sensor. `J1` connects to the BeagleBone Green, and `J2` connects to the temperature sensor.

See also: http://www.seeedstudio.com/wiki/Grove_-_Temperature_Sensor_V1.2; http://www.seeedstudio.com/depot/Grove-Temperature-Sensor-p-774.html

Member Enumeration Documentation

◆ EType

enum SG::TemperatureSensor::EType

strong

Enumerator
vInvalid
v10_3975	temperature sensor v1.0
v11_4250	temperature sensor v1.1
v12_4250	temperature sensor v1.2 (default)
v12_4275	temperature sensor v1.2 (according to Seeed's wiki example code)

Constructor & Destructor Documentation

◆ ~TemperatureSensor()

SG::TemperatureSensor::~TemperatureSensor ( void )

virtual

Destructor.

◆ TemperatureSensor() [1/2]

SG::TemperatureSensor::TemperatureSensor	(	SG::I2CADC &	adc,
		const std::string &	n = `""`,
		const EType	etype = `EType::v12_4250`
	)

Constructor. This analog twig must be connected to an I2CADC.

◆ TemperatureSensor() [2/2]

SG::TemperatureSensor::TemperatureSensor ( const TemperatureSensor & rhs )

Copy constructor.

Member Function Documentation

◆ get_celsius()

double SG::TemperatureSensor::get_celsius ( void )

Get the current temperature.

Todo:: This needs to be removed once get_celsius boooooo

References SG::I2CADC::get_result(), i2cadc, and type.

Referenced by get_fahrenheit(), operator!=(), and temperature().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_description()

std::string SG::GroveBase::get_description ( void ) const

virtualinherited

Return a multi-word 1-line description of this object.

References SG::demangle(), SG::GroveBase::get_name(), SG::GroveBase::get_sku(), SG::GroveBase::get_type_name(), SG::GroveBase::is_grove_gpio(), SG::GroveBase::is_grove_i2c(), SG::GroveBase::is_grove_uart(), and SG::BeagleBone::Detect::to_string().

Referenced by buzzer(), chainable_rgb_led(), common_oled(), SG::GroveBase::get_name(), SG::GroveI2CDigital::GroveI2CDigital(), SG::CommonOLED::set_display_bitmap(), SG::CommonOLED::set_orientation(), temperature(), variable_led(), and SG::GroveI2CDigital::write_block().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_fahrenheit()

double SG::TemperatureSensor::get_fahrenheit ( void )

Get the current temperature.

Todo:: This needs to be removed once get_celsius boooooo

References get_celsius().

Referenced by operator!=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_name()

virtual std::string SG::GroveBase::get_name ( void ) const

inlinevirtualinherited

Return the user-supplied name.

References SG::GroveBase::get_description(), SG::GroveBase::grove_name, SG::GroveBase::is_grove_gpio(), SG::GroveBase::is_grove_i2c(), and SG::GroveBase::is_grove_uart().

Referenced by SG::GroveBase::get_description(), SG::GroveBase::operator=(), and SG::GroveBase::operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_sku()

virtual uint32_t SG::GroveBase::get_sku ( void ) const

inlinevirtualinherited

Return a guess as to the Seeed SKU number based on the grove type.

References SG::get_sku_from_grove_type(), and SG::GroveBase::grove_type.

Referenced by SG::GroveBase::get_description().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_type()

virtual EGroveType SG::GroveBase::get_type ( void ) const

inlinevirtualinherited

Return the grove type.

References SG::GroveBase::grove_type.

Referenced by SG::GroveI2CDigital::get_address_from_type(), SG::GroveBase::operator=(), and SG::GroveBase::operator==().

Here is the caller graph for this function:

◆ get_type_name()

virtual std::string SG::GroveBase::get_type_name ( void ) const

inlinevirtualinherited

Return a short text string representing the grove type.

References SG::GroveBase::grove_type, and SG::to_string().

Referenced by SG::GroveBase::get_description().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_analog()

virtual bool SG::GroveI2CAnalog::is_analog ( void ) const

inlinevirtualinherited

This is always true for GroveI2CDigital.

Implements SG::GroveI2C.

◆ is_digital()

virtual bool SG::GroveI2CAnalog::is_digital ( void ) const

inlinevirtualinherited

This is always false for GroveI2CDigital.

Implements SG::GroveI2C.

◆ is_grove_gpio()

virtual bool SG::GroveI2C::is_grove_gpio ( void ) const

inlinevirtualinherited

This is always false for GroveI2C.

Implements SG::GroveBase.

References SG::GroveI2C::is_analog(), and SG::GroveI2C::is_digital().

Here is the call graph for this function:

◆ is_grove_i2c()

virtual bool SG::GroveI2C::is_grove_i2c ( void ) const

inlinevirtualinherited

This is always true for GroveI2C.

Implements SG::GroveBase.

◆ is_grove_uart()

virtual bool SG::GroveI2C::is_grove_uart ( void ) const

inlinevirtualinherited

This is always false for GroveI2C.

Implements SG::GroveBase.

◆ operator!=() [1/2]

bool SG::GroveBase::operator!= ( const GroveBase & rhs ) const

inlineinherited

Test object equality.

References SG::GroveBase::operator==().

Here is the call graph for this function:

◆ operator!=() [2/2]

bool SG::TemperatureSensor::operator!= ( const TemperatureSensor & rhs ) const

inline

Test object equality.

References get_celsius(), get_fahrenheit(), and operator==().

Here is the call graph for this function:

◆ operator=()

SG::TemperatureSensor & SG::TemperatureSensor::operator= ( const TemperatureSensor & rhs )

Assignment.

References SG::GroveBase::operator=().

Here is the call graph for this function:

◆ operator==() [1/2]

bool SG::GroveBase::operator== ( const GroveBase & rhs ) const

inherited

Test object equality.

References SG::GroveBase::get_name(), and SG::GroveBase::get_type().

Referenced by SG::GroveBase::operator!=(), SG::Buzzer::operator==(), SG::TemperatureAndHumiditySensor::operator==(), operator==(), and SG::I2CADC::operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator==() [2/2]

bool SG::TemperatureSensor::operator== ( const TemperatureSensor & rhs ) const

Test object equality.

References SG::GroveBase::operator==().

Referenced by operator!=().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ grove_name

std::string SG::GroveBase::grove_name

inherited

User-supplied name.

Referenced by SG::GroveBase::get_name(), and SG::GroveBase::operator=().

◆ grove_type

EGroveType SG::GroveBase::grove_type

inherited

Grove type.

Referenced by SG::GroveBase::get_sku(), SG::GroveBase::get_type(), SG::GroveBase::get_type_name(), and SG::GroveBase::operator=().

◆ i2cadc

I2CADC& SG::TemperatureSensor::i2cadc

Referenced by get_celsius().

◆ type

EType SG::TemperatureSensor::type

Referenced by get_celsius().

The documentation for this class was generated from the following files:

src-groves/sg_101020015_TemperatureSensor.hpp
src-groves/sg_101020015_TemperatureSensor.cpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ EType

Constructor & Destructor Documentation

◆ ~TemperatureSensor()

◆ TemperatureSensor() [1/2]

◆ TemperatureSensor() [2/2]

Member Function Documentation

◆ get_celsius()

◆ get_description()

◆ get_fahrenheit()

◆ get_name()

◆ get_sku()

◆ get_type()

◆ get_type_name()

◆ is_analog()

◆ is_digital()

◆ is_grove_gpio()

◆ is_grove_i2c()

◆ is_grove_uart()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

Member Data Documentation

◆ grove_name

◆ grove_type

◆ i2cadc

◆ type