Adafruit_HTU31D Class Reference

#include <Adafruit_HTU31D.h>

Public Member Functions
	Adafruit_HTU31D ()
	~Adafruit_HTU31D (void)
	HTU31D destructor.
bool	begin (uint8_t i2c_addr=HTU31D_DEFAULT_I2CADDR, TwoWire *theWire=&Wire)
bool	reset (void)
uint32_t	readSerial (void)
bool	enableHeater (bool en)
bool	getEvent (sensors_event_t *humidity, sensors_event_t *temp)
	Gets the humidity sensor and temperature values as sensor events. More...
Adafruit_Sensor *	getTemperatureSensor (void)
	Gets the Adafruit_Sensor object for the HTU31D's humidity sensor. More...
Adafruit_Sensor *	getHumiditySensor (void)
	Gets the Adafruit_Sensor object for the HTU31D's humidity sensor. More...

Protected Attributes
float	_temperature
	Last reading's temperature (C)
float	_humidity
	Last reading's humidity (percent)
uint16_t	_sensorid_humidity
	ID number for humidity.
uint16_t	_sensorid_temp
	ID number for temperature.
Adafruit_I2CDevice *	i2c_dev = NULL
	Pointer to I2C bus interface.
Adafruit_HTU31D_Temp *	temp_sensor = NULL
	Temp sensor data object.
Adafruit_HTU31D_Humidity *	humidity_sensor
	Humidity sensor data object. More...

Friends
class	Adafruit_HTU31D_Temp
class	Adafruit_HTU31D_Humidity

Detailed Description

Driver for the Adafruit HTU31D breakout board.

Constructor & Destructor Documentation

Adafruit_HTU31D()

Adafruit_HTU31D::Adafruit_HTU31D

(

)

Constructor for the HTU31D driver.

Member Function Documentation

begin()

bool Adafruit_HTU31D::begin	(	uint8_t	i2c_addr = HTU31D_DEFAULT_I2CADDR,
		TwoWire *	theWire = &Wire
	)

Initialises the I2C transport, and configures the IC for normal operation.

Parameters

theWire	Pointer to TwoWire I2C object, uses &Wire by default
i2c_addr	The sensor I2C address, default is 0x40 but can be 0x41

Returns

true if the device was successfully initialised

reset()

bool Adafruit_HTU31D::reset

(

void

)

Sends a 'reset' request to the HTU31D, followed by a 15ms delay.

Returns

True if was able to write the command successfully

readSerial()

uint32_t Adafruit_HTU31D::readSerial

(

void

)

Gets the ID register contents.

Returns

The 32-bit ID register.

enableHeater()

bool Adafruit_HTU31D::enableHeater

(

bool

en

)

Enable or disable the built in heater

Parameters

en	Enable or disable the heater

Returns

True or false on command write success

getEvent()

bool Adafruit_HTU31D::getEvent	(	sensors_event_t *	humevent,
		sensors_event_t *	tempevent
	)

Gets the humidity sensor and temperature values as sensor events.

Parameters

humevent	Sensor event object that will be populated with humidity data
tempevent	Sensor event object that will be populated with temp data

Returns

true if the event data was read successfully

getTemperatureSensor()

Adafruit_Sensor * Adafruit_HTU31D::getTemperatureSensor

(

void

)

Gets the Adafruit_Sensor object for the HTU31D's humidity sensor.

Returns

Adafruit_Sensor*

getHumiditySensor()

Adafruit_Sensor * Adafruit_HTU31D::getHumiditySensor

(

void

)

Gets the Adafruit_Sensor object for the HTU31D's humidity sensor.

Returns

Adafruit_Sensor*

Friends And Related Function Documentation

Adafruit_HTU31D_Temp

friend class Adafruit_HTU31D_Temp

friend

Gives access to private members to Temp data object

Adafruit_HTU31D_Humidity

friend class Adafruit_HTU31D_Humidity

friend

Gives access to private members to Humidity data object

Member Data Documentation

humidity_sensor

Adafruit_HTU31D_Humidity* Adafruit_HTU31D::humidity_sensor

protected

Initial value:

=
      NULL

Humidity sensor data object.

---

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

• Adafruit_HTU31D.h
• Adafruit_HTU31D.cpp