Merge pull request #11 from cparata/master

Add begin and end APIs

Author: cparata

README.md

@@ -5,22 +5,25 @@ Arduino library to support the HTS221 capacitive digital sensor for relative hum
 
 This sensor uses I2C to communicate. It is then required to create a TwoWire interface before accessing to the sensors:  
 
-  dev_i2c = new TwoWire(I2C2_SDA, I2C2_SCL);  
-  dev_i2c->begin();  
+    TwoWire dev_i2c(I2C_SDA, I2C_SCL);  
+    dev_i2c.begin();
 
-An instance can be created and enbaled following the procedure below:  
+An instance can be created and enabled following the procedure below:  
 
   For the humidity sensor:  
 
-    HumTemp = new HTS221Sensor (dev_i2c);  
-    HumTemp->Enable();  
+    HTS221Sensor HumTemp(&dev_i2c);
+    HumTemp.begin();
+    HumTemp.Enable();  
 
 The access to the sensor values is done as explained below:  
 
   Read humidity and temperature.  
 
-    HumTemp->GetHumidity(&humidity);  
-    HumTemp->GetTemperature(&temperature);  
+    float humidity;
+    float temperature;
+    HumTemp.GetHumidity(&humidity);  
+    HumTemp.GetTemperature(&temperature);  
 
 ## Documentation
 

examples/DISCO_IOT_HTS221_DataLog_Terminal/DISCO_IOT_HTS221_DataLog_Terminal.ino

@@ -45,9 +45,11 @@
 #define I2C2_SCL    PB10
 #define I2C2_SDA    PB11
 
+// I2C
+TwoWire dev_i2c(I2C2_SDA, I2C2_SCL);
+
 // Components.
-HTS221Sensor  *HumTemp;
-TwoWire *dev_i2c;
+HTS221Sensor  HumTemp(&dev_i2c);
 
 void setup() {
   // Led.
@@ -56,12 +58,11 @@ void setup() {
   Serial.begin(9600);
 
   // Initialize I2C bus.
-  dev_i2c = new TwoWire(I2C2_SDA, I2C2_SCL);
-  dev_i2c->begin();
+  dev_i2c.begin();
 
   // Initlialize components.
-  HumTemp = new HTS221Sensor (dev_i2c);
-  HumTemp->Enable();
+  HumTemp.begin();
+  HumTemp.Enable();
 }
 
 void loop() {
@@ -73,8 +74,8 @@ void loop() {
 
   // Read humidity and temperature.
   float humidity, temperature;
-  HumTemp->GetHumidity(&humidity);
-  HumTemp->GetTemperature(&temperature);
+  HumTemp.GetHumidity(&humidity);
+  HumTemp.GetTemperature(&temperature);
 
   // Output data.
   Serial.print("Hum[%]: ");

keywords.txt

@@ -12,18 +12,20 @@ HTS221Sensor	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
-Enable							KEYWORD2
-Disable							KEYWORD2
-ReadID							KEYWORD2
-Reset							KEYWORD2
-GetHumidity						KEYWORD2
-GetTemperature					KEYWORD2
-GetODR							KEYWORD2
-SetODR							KEYWORD2
-ReadReg							KEYWORD2
-WriteReg						KEYWORD2
-IO_Read							KEYWORD2
-IO_Write						KEYWORD2
+begin	KEYWORD2
+end	KEYWORD2
+Enable	KEYWORD2
+Disable	KEYWORD2
+ReadID	KEYWORD2
+Reset	KEYWORD2
+GetHumidity	KEYWORD2
+GetTemperature	KEYWORD2
+GetODR	KEYWORD2
+SetODR	KEYWORD2
+ReadReg	KEYWORD2
+WriteReg	KEYWORD2
+IO_Read	KEYWORD2
+IO_Write	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)

library.properties

@@ -1,9 +1,9 @@
 name=STM32duino HTS221
-version=1.0.4
+version=2.0.0
 author=AST, Wi6Labs
 maintainer=stm32duino
 sentence=Capacitive digital sensor for relative humidity and temperature.
 paragraph=This library provides Arduino support for the capacitive digital sensor for relative humidity and temperature HTS221 for STM32 boards.
 category=Sensors
 url=https://github.com/stm32duino/HTS221
-architectures=stm32
+architectures=stm32, avr, sam

src/HTS221Sensor.cpp

@@ -52,49 +52,48 @@
 HTS221Sensor::HTS221Sensor(TwoWire *i2c) : dev_i2c(i2c)
 {
   address = HTS221_I2C_ADDRESS;
+};
 
+/**
+ * @brief  Configure the sensor in order to be used
+ * @retval 0 in case of success, an error code otherwise
+ */
+HTS221StatusTypeDef HTS221Sensor::begin()
+{
   /* Power down the device */
   if ( HTS221_DeActivate( (void *)this ) == HTS221_ERROR )
   {
-    return;
+    return HTS221_STATUS_ERROR;
   }
 
   /* Enable BDU */
   if ( HTS221_Set_BduMode( (void *)this, HTS221_ENABLE ) == HTS221_ERROR )
   {
-    return;
+    return HTS221_STATUS_ERROR;
   }
 
   if(SetODR(1.0f) == HTS221_STATUS_ERROR)
   {
-    return;
+    return HTS221_STATUS_ERROR;
   }
-};
 
+  return HTS221_STATUS_OK;
+}
 
-/** Constructor
- * @param i2c object of an helper class which handles the I2C peripheral
- * @param address the address of the component's instance
+/**
+ * @brief  Disable the sensor and relative resources
+ * @retval 0 in case of success, an error code otherwise
  */
-HTS221Sensor::HTS221Sensor(TwoWire *i2c, uint8_t address) : dev_i2c(i2c), address(address)
+HTS221StatusTypeDef HTS221Sensor::end()
 {
-    /* Power down the device */
-  if ( HTS221_DeActivate( (void *)this ) == HTS221_ERROR )
+  /* Disable humidity and temperature sensor */
+  if ( Disable() != HTS221_STATUS_OK )
   {
-    return;
-  }
-
-  /* Enable BDU */
-  if ( HTS221_Set_BduMode( (void *)this, HTS221_ENABLE ) == HTS221_ERROR )
-  {
-    return;
+    return HTS221_STATUS_ERROR;
   }
 
-  if(SetODR(1.0f) == HTS221_STATUS_ERROR)
-  {
-    return;
-  }
-};
+  return HTS221_STATUS_OK;
+}
 
 /**
  * @brief  Enable HTS221
@@ -117,7 +116,7 @@ HTS221StatusTypeDef HTS221Sensor::Enable(void)
  */
 HTS221StatusTypeDef HTS221Sensor::Disable(void)
 {
-  /* Power up the device */
+  /* Power off the device */
   if ( HTS221_DeActivate( (void *)this ) == HTS221_ERROR )
   {
     return HTS221_STATUS_ERROR;

src/HTS221Sensor.h

@@ -66,7 +66,8 @@ class HTS221Sensor
 {
   public:
     HTS221Sensor                       (TwoWire *i2c);
-    HTS221Sensor                       (TwoWire *i2c, uint8_t address);
+    HTS221StatusTypeDef begin          (void);
+    HTS221StatusTypeDef end            (void);
     HTS221StatusTypeDef Enable         (void);
     HTS221StatusTypeDef Disable        (void);
     HTS221StatusTypeDef ReadID         (uint8_t *ht_id);