net.happybrackets.device.sensors

Class HTS221

java.lang.Object

net.happybrackets.device.sensors.Sensor

net.happybrackets.device.sensors.HTS221

All Implemented Interfaces:

HumiditySensor, TemperatureSensor

public final class HTS221
extends Sensor
implements HumiditySensor, TemperatureSensor

The HTS221 is the humidity and temperature sensor on the Raspberry Pi Sensehat.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTS221.HTS221ControlRegistry1
static class	HTS221.HTS221HumidityResolutionMode
static class	HTS221.HTS221TemperatureResolutionMode
class	HTS221.I2CConstants

Field Summary

Fields

Modifier and Type	Field and Description
static byte	AV_CONF
static byte	CTRL_REG1
static byte	CTRL_REG2
static byte	CTRL_REG3
static byte	H0_rH_x2
static byte	H0_T0_OUT
static byte	H1_rH_x2
static byte	H1_T0_OUT
static byte	HTS221_ADDRESS
static byte	HUMI_DATA_AVAILABLE_MASK
static byte	HUMIDITY_OUT_H
static byte	HUMIDITY_OUT_L or H_OUT
static byte	STATUS_REG
static byte	T0_degC_x8
static byte	T0_OUT
static byte	T1_degC_x8
static byte	T1_OUT
static byte	T1_T0_msb
static byte	TEMP_DATA_AVAILABLE_MASK
static byte	TEMP_OUT_H
static byte	TEMP_OUT_L or T_OUT
static byte	WHO_AM_I

Fields inherited from class net.happybrackets.device.sensors.Sensor

simulatedOnly, validLoad

Constructor Summary

Constructors

Constructor and Description
HTS221()

Method Summary

Modifier and Type	Method and Description
void	doStart()
void	doStop()
HTS221.HTS221ControlRegistry1	getBdu()
double	getHumidityData() getHumidityData accesses the sensor to return the Humidity data.
HTS221.HTS221HumidityResolutionMode	getHumidityMode()
HTS221.HTS221ControlRegistry1	getOdr()
HTS221.HTS221ControlRegistry1	getPd()
java.lang.String	getSensorName() getSensorName() returns the name of the sensor
double	getTemperatureData() getTemperatureData accesses the sensor to find the latest temperatureData.
HTS221.HTS221TemperatureResolutionMode	getTemperatureMode()
void	humidityCalibration()
void	setBdu(HTS221.HTS221ControlRegistry1 bdu)
void	setHumidityMode(HTS221.HTS221HumidityResolutionMode humidityMode)
void	setOdr(HTS221.HTS221ControlRegistry1 odr)
void	setPd(HTS221.HTS221ControlRegistry1 pd)
void	setTemperatureMode(HTS221.HTS221TemperatureResolutionMode temperatureMode)
void	temperatureCalibration()
static java.lang.String	toHexToString(byte i)
static java.lang.String	toHexToString(short i)

Methods inherited from class net.happybrackets.device.sensors.Sensor

addListener, addNonResettableListener, addNonResettableValueChangedListener, addValueChangedListener, clearListeners, getSensor, isSimulatedOnly, isValidLoadedSensor, notifyListeners, reloadSimulation, removeListener, removeListener, resetToDefault, roundValue, scaleValue, setSimulatedOnly, setValidLoad, storeSensor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTS221_ADDRESS

public static byte HTS221_ADDRESS

AV_CONF

public static byte AV_CONF

CTRL_REG1

public static byte CTRL_REG1

CTRL_REG2

public static byte CTRL_REG2

CTRL_REG3

public static byte CTRL_REG3

STATUS_REG

public static byte STATUS_REG

HUMIDITY_OUT_L

public static byte HUMIDITY_OUT_L

or H_OUT

HUMIDITY_OUT_H

public static byte HUMIDITY_OUT_H

TEMP_OUT_L

public static byte TEMP_OUT_L

or T_OUT

TEMP_OUT_H

public static byte TEMP_OUT_H

H0_rH_x2

public static byte H0_rH_x2

H1_rH_x2

public static byte H1_rH_x2

T0_degC_x8

public static byte T0_degC_x8

T1_degC_x8

public static byte T1_degC_x8

T1_T0_msb

public static byte T1_T0_msb

T0_OUT

public static byte T0_OUT

T1_OUT

public static byte T1_OUT

H0_T0_OUT

public static byte H0_T0_OUT

H1_T0_OUT

public static byte H1_T0_OUT

TEMP_DATA_AVAILABLE_MASK

public static byte TEMP_DATA_AVAILABLE_MASK

HUMI_DATA_AVAILABLE_MASK

public static byte HUMI_DATA_AVAILABLE_MASK

WHO_AM_I

public static byte WHO_AM_I

Constructor Detail

HTS221

public HTS221()
       throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getSensorName

public java.lang.String getSensorName()

getSensorName() returns the name of the sensor

Specified by:

getSensorName in class Sensor

Returns:

a String representing the sensor's name.

doStart

public void doStart()
             throws java.lang.Exception

Throws:

java.lang.Exception

doStop

public void doStop()
            throws java.lang.Exception

Throws:

java.lang.Exception

getHumidityData

public double getHumidityData()

getHumidityData accesses the sensor to return the Humidity data.

Specified by:

getHumidityData in interface HumiditySensor

Returns:

Humidity data as double

getTemperatureData

public double getTemperatureData()

getTemperatureData accesses the sensor to find the latest temperatureData.

Specified by:

getTemperatureData in interface TemperatureSensor

Returns:

temperature data as double

humidityCalibration

public void humidityCalibration()
                         throws java.lang.Exception

Throws:

java.lang.Exception

temperatureCalibration

public void temperatureCalibration()
                            throws java.lang.Exception

Throws:

java.lang.Exception

toHexToString

public static java.lang.String toHexToString(byte i)

toHexToString

public static java.lang.String toHexToString(short i)

getTemperatureMode

public HTS221.HTS221TemperatureResolutionMode getTemperatureMode()

setTemperatureMode

public void setTemperatureMode(HTS221.HTS221TemperatureResolutionMode temperatureMode)

getHumidityMode

public HTS221.HTS221HumidityResolutionMode getHumidityMode()

setHumidityMode

public void setHumidityMode(HTS221.HTS221HumidityResolutionMode humidityMode)

getBdu

public HTS221.HTS221ControlRegistry1 getBdu()

setBdu

public void setBdu(HTS221.HTS221ControlRegistry1 bdu)

getOdr

public HTS221.HTS221ControlRegistry1 getOdr()

setOdr

public void setOdr(HTS221.HTS221ControlRegistry1 odr)

getPd

public HTS221.HTS221ControlRegistry1 getPd()

setPd

public void setPd(HTS221.HTS221ControlRegistry1 pd)