Merge pull request #4 from cparata/master

cparata · web-flow · commit 1a7c749e8fa2 · 2021-01-25T11:45:22.000+01:00
Add begin and end APIs
diff --git a/README.md b/README.md
@@ -6,19 +6,24 @@ Arduino library to support the STTS751 digital temperature sensor
 This sensor uses I2C to communicate.
 For I2C it is then required to create a TwoWire interface before accessing to the sensors:  
 
-    dev_i2c = new TwoWire(I2C_SDA, I2C_SCL);  
-    dev_i2c->begin();
+    TwoWire dev_i2c(I2C_SDA, I2C_SCL);  
+    dev_i2c.begin();
 
-An instance can be created and enbaled when the I2C bus is used following the procedure below:  
+An instance can be created and enabled when the I2C bus is used following the procedure below:  
 
-    Temp = new STTS751Sensor(dev_i2c);  
-    Temp->Enable();
+    STTS751Sensor Temp(&dev_i2c, I2C_ADDRESS);
+    Temp.begin();
+    Temp.Enable();
+
+I2C_ADDRESS depends on the ID of the sensor and the pull-up resistor value connected to Addr/Therm pin.
+Please check the Datasheet for more information.
 
 The access to the sensor values is done as explained below:  
 
   Read temperature.  
 
-    Temp->GetTemperature(&temperature);
+    float temperature;
+    Temp.GetTemperature(&temperature);
 
 ## Documentation
 
diff --git a/keywords.txt b/keywords.txt
@@ -12,6 +12,8 @@ STTS751Sensor	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
+begin	KEYWORD2
+end	KEYWORD2
 ReadID	KEYWORD2
 Enable	KEYWORD2
 Disable	KEYWORD2
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=STM32duino STTS751
-version=1.0.2
+version=2.0.0
 author=SRA
 maintainer=stm32duino
 sentence=digital temperature sensor.
diff --git a/src/STTS751Sensor.cpp b/src/STTS751Sensor.cpp
@@ -52,28 +52,51 @@ STTS751Sensor::STTS751Sensor(TwoWire *i2c, uint8_t address) : dev_i2c(i2c), addr
   reg_ctx.write_reg = STTS751_io_write;
   reg_ctx.read_reg = STTS751_io_read;
   reg_ctx.handle = (void *)this;
-  
+  temp_is_enabled = 0U;
+}
+
+/**
+ * @brief  Configure the sensor in order to be used
+ * @retval 0 in case of success, an error code otherwise
+ */
+STTS751StatusTypeDef STTS751Sensor::begin()
+{
   /* Disable EVENT pin of SMBus. */
   if (stts751_pin_event_route_set(&reg_ctx,  PROPERTY_ENABLE) != STTS751_OK)
   {
-    return;
+    return STTS751_ERROR;
   }
   /* Set default ODR */
   temp_odr = 1.0f;
   /* Set the resolution to the maximum allowed value */
   if (stts751_resolution_set(&reg_ctx, STTS751_12bit) != STTS751_OK)
   {
-    return;
+    return STTS751_ERROR;
   }
   /* Put the component in standby mode. */
   if (stts751_temp_data_rate_set(&reg_ctx, STTS751_TEMP_ODR_OFF) != STTS751_OK)
   {
-    return;
+    return STTS751_ERROR;
   }
-  
-  temp_is_enabled = 0;
-  
-  return;
+
+  temp_is_enabled = 0U;
+
+  return STTS751_OK;
+}
+
+/**
+ * @brief  Disable the sensor and relative resources
+ * @retval 0 in case of success, an error code otherwise
+ */
+STTS751StatusTypeDef STTS751Sensor::end()
+{
+  /* Disable temperature sensor */
+  if (Disable() != STTS751_OK)
+  {
+    return STTS751_ERROR;
+  }
+
+  return STTS751_OK;
 }
 
 /**
diff --git a/src/STTS751Sensor.h b/src/STTS751Sensor.h
@@ -69,6 +69,8 @@ class STTS751Sensor
 {
   public:
     STTS751Sensor(TwoWire *i2c, uint8_t address=STTS751_1xxxx_ADD_7K5);
+    STTS751StatusTypeDef begin();
+    STTS751StatusTypeDef end();
     STTS751StatusTypeDef ReadID(uint8_t *Id);
     STTS751StatusTypeDef Enable();
     STTS751StatusTypeDef Disable();

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,8 @@ class STTS751Sensor`
`69`	`69`	`{`
`70`	`70`	`public:`
`71`	`71`	`STTS751Sensor(TwoWire *i2c, uint8_t address=STTS751_1xxxx_ADD_7K5);`
	`72`	`+ STTS751StatusTypeDef begin();`
	`73`	`+ STTS751StatusTypeDef end();`
`72`	`74`	`STTS751StatusTypeDef ReadID(uint8_t *Id);`
`73`	`75`	`STTS751StatusTypeDef Enable();`
`74`	`76`	`STTS751StatusTypeDef Disable();`