RUI3 (RAK Unified Interface 3) - RAK4631
rak1901

Public Member Functions

 rak1901 ()
 
bool sendCommand (SHTC3_Commands_TypeDef cmd)
 
bool sendCommand (SHTC3_MeasurementModes_TypeDef cmd)
 
bool init (void)
 
bool wakeup (void)
 
void sleep (void)
 
bool update (void)
 
float temperature (void)
 
float humidity (void)
 

Constructor & Destructor Documentation

◆ rak1901()

rak1901 ( )

Member Function Documentation

◆ sendCommand() [1/2]

bool sendCommand ( SHTC3_Commands_TypeDef  cmd)

◆ sendCommand() [2/2]

bool sendCommand ( SHTC3_MeasurementModes_TypeDef  cmd)

◆ init()

bool init ( void  )
Description
This function enabled the RAK1901 sensor and puts the device into standby mode / sleep mode for lowest power consumption
Syntax
sensor.shtc3.init()
Returns
bool True if successfully query and identify RAK1901 module. FALSE if RAK1901 init failed

◆ wakeup()

bool wakeup ( void  )
Description
wake up the RAK1901 sensor from sleep mode
Syntax
sensor.shtc3.wakeup()
Returns
bool true if successfully wake-up.false is wake up fail

◆ sleep()

void sleep ( void  )
Description
make the Rak1901 sensor enter sleep mode
Syntax
sensor.shtc3.sleep()
Returns
void

◆ update()

bool update ( void  )
Description
This function will trigger the RAK1901 to update the Temperature and humidity values, after the values are updated theRAK1901 will go back to power saving mode
Syntax
sensor.shtc3.update()
Returns
bool True if values updated successfully. FALSE if update failed

◆ temperature()

float temperature ( void  )
Description
This function will trigger the RAK1901 to return the Temperature value
Note
The sensor can read from -40°C to +125°C
Syntax
sensor.shtc3.temperature()
Returns
float the temperature that detected from RAK1901 sensor
(unit: Celsius)

◆ humidity()

float humidity ( void  )
Description
This function will trigger the RAK1901 to return the Humidity value
Note
The sensor can read from 0% to 100%
Syntax
sensor.shtc3.humidity()
Returns
float the humidity that detected from RAK1901 sensor
(unit: percentage)