Référence de la classe STS21

La classe STS21 permetant de dialoguer avec le STS21. Plus de détails...

#include <STS21.h>

Graphe d'héritage de STS21:

Types publics
enum	STS_RES { RES_11 = 3, RES_12 = 1, RES_13 = 2, RES_14 = 0 }
	Enumération de sélection de la précision de la capture de la température. Plus la précision est haute, plus temps d'acquisition est long. Plus de détails...

Fonctions membres publiques
	STS21 (uint8_t addr=0x4A)
	~STS21 ()
virtual boolean	begin ()
double	getTemperature (boolean noHold=true)
boolean	setResolution (STS_RES res)
boolean	enableOnChipHeater (boolean enabled)
boolean	reset ()
boolean	lowBattery ()
Fonctions membres publiques hérités de I2CDevice
	I2CDevice (const uint8_t address, TwoWire *twi=&Wire)

Membres hérités additionnels
Attributs protégés hérités de I2CDevice
const uint8_t	address
TwoWire *	twi
boolean	isPresent

Description détaillée

La classe STS21 permetant de dialoguer avec le STS21.

Documentation des énumérations membres

STS_RES

enum STS21::STS_RES

Enumération de sélection de la précision de la capture de la température. Plus la précision est haute, plus temps d'acquisition est long.

Valeurs énumérées
RES_11	RES_11 pour une résolution sur 11 bits, la plus basse
RES_12	RES_12 pour une résolution sur 12 bits
RES_13	RES_13 pour une résolution sur 13 bits
RES_14	RES_14 pour une résolution sur 14 bits, la plus haute et la résolution par défaut

Documentation des constructeurs et destructeur

STS21()

STS21::STS21 ( uint8_t  addr = 0x4A )

inline

Le constructeur de la classe prend en paramètres :

Paramètres

addr	: l'adresse I2C du périphérique

~STS21()

STS21::~STS21 ( )

inline

Le destructeur :

Documentation des fonctions membres

begin()

virtual boolean STS21::begin ( )

inlinevirtual

Initialise le périphérique

Renvoie

boolean : true si l'initialisation a fonctionnée, false sinon. Dans le cas où l'initialisation échoue, vérifier les branchements et/ou l'adresse du périphérique.

Implémente I2CDevice.

enableOnChipHeater()

boolean STS21::enableOnChipHeater

(

boolean

enabled

)

Active ou désactive le module de chauffe interne.

Paramètres

enabled

: true pour l'activer, false sinon.

Renvoie

boolean : true si succès, false sinon.

getTemperature()

double STS21::getTemperature

(

boolean

noHold = true

)

Demande l'acquisition d'une température d'une résolution définit via setResolution().

Paramètres

noHold

: si true, le périphérique met la ligne SCL au niveau bas pour bloquer le bus I2C durant la mesure de température, sinon le périphérique ne bloque pas le bus durant la mesure.

Renvoie

double : la température en °C.

lowBattery()

boolean STS21::lowBattery

(

)

Permet de connaître l'état de la tension d'alimentation du capteur. Si la tension est inférieure à 2.25V ou non. Permet de détecter un niveau de batterie faible si le module est alimenté par batterie.

Renvoie

boolean : true si la tension est inférieure à 2.25V, false sinon.

reset()

boolean STS21::reset

(

)

Permet de faire un reset du périphérique.

Renvoie

boolean : true si succès, false sinon.

setResolution()

boolean STS21::setResolution

(

STS_RES

res

)

Définit la résolution des mesures de température à l'aide des valeurs STS_RES

Paramètres

res	: la résolution du type STS_RES

Renvoie

boolean : true si succès, false sinon.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• STS21.h
• STS21.cpp