Merge pull request #18 from cparata/master

Add begin and end APIs

Author: cparata

README.md

@@ -5,22 +5,26 @@ Arduino library to support the LSM303AGR 3D accelerometer and 3D magnetometer
 
 This sensor uses I2C to communicate. It is then required to create a TwoWire interface before accessing the sensors:  
 
-    dev_i2c = new TwoWire(I2C2_SDA, I2C2_SCL);  
-    dev_i2c->begin();  
+    TwoWire dev_i2c(I2C2_SDA, I2C2_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:  
 
-    Acc = new LSM303AGR_ACC_Sensor(dev_i2c);
-    Acc->Enable();
-    Mag = new LSM303AGR_MAG_Sensor(dev_i2c);  
-    Mag->Enable();  
+    LSM303AGR_ACC_Sensor Acc(&dev_i2c);
+    Acc.begin();
+    Acc.Enable();
+    LSM303AGR_MAG_Sensor Mag(&dev_i2c);
+    Mag.begin();
+    Mag.Enable();
 
 The access to the sensor values is done as explained below:  
 
   Read accelerometer and magnetometer.  
 
-    Acc->GetAxes(accelerometer);
-    Mag->GetAxes(magnetometer);  
+    int32_t accelerometer[3];
+    int32_t magnetometer[3];
+    Acc.GetAxes(accelerometer);
+    Mag.GetAxes(magnetometer);  
 
 ## Documentation
 

examples/X_NUCLEO_IKS01A2_LSM303AGR_DataLog_Terminal/X_NUCLEO_IKS01A2_LSM303AGR_DataLog_Terminal.ino

@@ -52,8 +52,8 @@
 #endif
 
 // Components.
-LSM303AGR_ACC_Sensor *Acc;
-LSM303AGR_MAG_Sensor *Mag;
+LSM303AGR_ACC_Sensor Acc(&DEV_I2C);
+LSM303AGR_MAG_Sensor Mag(&DEV_I2C);
 
 void setup() {
   // Led.
@@ -66,11 +66,11 @@ void setup() {
   DEV_I2C.begin();
 
   // Initlialize components.
-  Acc = new LSM303AGR_ACC_Sensor(&DEV_I2C);
-  Acc->Enable();
-  Acc->EnableTemperatureSensor();
-  Mag = new LSM303AGR_MAG_Sensor(&DEV_I2C);
-  Mag->Enable();
+  Acc.begin();
+  Acc.Enable();
+  Acc.EnableTemperatureSensor();
+  Mag.begin();
+  Mag.Enable();
 }
 
 void loop() {
@@ -82,15 +82,15 @@ void loop() {
 
   // Read accelerometer LSM303AGR.
   int32_t accelerometer[3];
-  Acc->GetAxes(accelerometer);
+  Acc.GetAxes(accelerometer);
 
   // Read temperature LSM303AGR.
   float temperature;
-  Acc->GetTemperature(&temperature);
+  Acc.GetTemperature(&temperature);
 
   // Read magnetometer LSM303AGR.
   int32_t magnetometer[3];
-  Mag->GetAxes(magnetometer);
+  Mag.GetAxes(magnetometer);
 
   // Output data.
   SerialPort.print("| Acc[mg]: ");

keywords.txt

@@ -13,6 +13,8 @@ LSM303AGR_MAG_Sensor	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
+begin	KEYWORD2
+end	KEYWORD2
 Enable	KEYWORD2
 Disable	KEYWORD2
 ReadID	KEYWORD2

library.properties

@@ -1,9 +1,9 @@
 name=STM32duino LSM303AGR
-version=1.1.0
+version=2.0.0
 author=AST
 maintainer=stm32duino
 sentence=3D accelerometer and 3D magnetometer.
 paragraph=This library provides Arduino support for the 3D accelerometer and 3D magnetometer LSM303AGR for STM32 boards.
 category=Sensors
 url=https://github.com/stm32duino/LSM303AGR
-architectures=stm32
+architectures=stm32, avr, sam

src/LSM303AGR_ACC_Sensor.cpp

@@ -51,104 +51,76 @@
 LSM303AGR_ACC_Sensor::LSM303AGR_ACC_Sensor(TwoWire *i2c) : dev_i2c(i2c)
 {
   address = LSM303AGR_ACC_I2C_ADDRESS;
-  
+  isEnabled = 0;
+}
+
+/**
+ * @brief  Configure the sensor in order to be used
+ * @retval 0 in case of success, an error code otherwise
+ */
+LSM303AGR_ACC_StatusTypeDef LSM303AGR_ACC_Sensor::begin(void)
+{
   /* Enable BDU */
   if ( LSM303AGR_ACC_W_BlockDataUpdate( (void *)this, LSM303AGR_ACC_BDU_ENABLED ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_ACC_STATUS_ERROR;
   }
 
   /* FIFO mode selection */
   if ( LSM303AGR_ACC_W_FifoMode( (void *)this, LSM303AGR_ACC_FM_BYPASS ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_ACC_STATUS_ERROR;
   }
 
   /* Output data rate selection - power down. */
   if ( LSM303AGR_ACC_W_ODR( (void *)this, LSM303AGR_ACC_ODR_DO_PWR_DOWN ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_ACC_STATUS_ERROR;
   }
 
   /* Full scale selection. */
   if ( SetFS( 2.0f ) == LSM303AGR_ACC_STATUS_ERROR )
   {
-    return;
+    return LSM303AGR_ACC_STATUS_ERROR;
   }
 
   /* Enable axes. */
   if ( LSM303AGR_ACC_W_XEN( (void *)this, LSM303AGR_ACC_XEN_ENABLED ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_ACC_STATUS_ERROR;
   }
 
   if ( LSM303AGR_ACC_W_YEN ( (void *)this, LSM303AGR_ACC_YEN_ENABLED ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_ACC_STATUS_ERROR;
   }
 
   if ( LSM303AGR_ACC_W_ZEN ( (void *)this, LSM303AGR_ACC_ZEN_ENABLED ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_ACC_STATUS_ERROR;
   }
 
   /* Select default output data rate. */
   Last_ODR = 100.0f;
 
   isEnabled = 0;
-};
 
-/** Constructor
- * @param i2c object of an helper class which handles the I2C peripheral
- * @param address the address of the component's instance
+  return LSM303AGR_ACC_STATUS_OK;
+}
+
+/**
+ * @brief  Disable the sensor and relative resources
+ * @retval 0 in case of success, an error code otherwise
  */
-LSM303AGR_ACC_Sensor::LSM303AGR_ACC_Sensor(TwoWire *i2c, uint8_t address) : dev_i2c(i2c), address(address)
+LSM303AGR_ACC_StatusTypeDef LSM303AGR_ACC_Sensor::end(void)
 {
-  /* Enable BDU */
-  if ( LSM303AGR_ACC_W_BlockDataUpdate( (void *)this, LSM303AGR_ACC_BDU_ENABLED ) == MEMS_ERROR )
-  {
-    return;
-  }
-  
-  /* FIFO mode selection */
-  if ( LSM303AGR_ACC_W_FifoMode( (void *)this, LSM303AGR_ACC_FM_BYPASS ) == MEMS_ERROR )
-  {
-    return;
-  }
-  
-  /* Output data rate selection - power down. */
-  if ( LSM303AGR_ACC_W_ODR( (void *)this, LSM303AGR_ACC_ODR_DO_PWR_DOWN ) == MEMS_ERROR )
-  {
-    return;
-  }
-  
-  /* Full scale selection. */
-  if ( SetFS( 2.0f ) == LSM303AGR_ACC_STATUS_ERROR )
-  {
-    return;
-  }
-  
-  /* Enable axes. */
-  if ( LSM303AGR_ACC_W_XEN( (void *)this, LSM303AGR_ACC_XEN_ENABLED ) == MEMS_ERROR )
-  {
-    return;
-  }
-  
-  if ( LSM303AGR_ACC_W_YEN ( (void *)this, LSM303AGR_ACC_YEN_ENABLED ) == MEMS_ERROR )
-  {
-    return;
-  }
-  
-  if ( LSM303AGR_ACC_W_ZEN ( (void *)this, LSM303AGR_ACC_ZEN_ENABLED ) == MEMS_ERROR )
+  if(Disable() != LSM303AGR_ACC_STATUS_OK)
   {
-    return;
+    return LSM303AGR_ACC_STATUS_ERROR;
   }
-  
-  /* Select default output data rate. */
-  Last_ODR = 100.0f;
-  
-  isEnabled = 0;
-};
+
+  return LSM303AGR_ACC_STATUS_OK;
+}
 
 /**
  * @brief  Enable LSM303AGR Accelerator

src/LSM303AGR_ACC_Sensor.h

@@ -82,7 +82,8 @@ class LSM303AGR_ACC_Sensor
 {
   public:
     LSM303AGR_ACC_Sensor                                 (TwoWire *i2c);
-    LSM303AGR_ACC_Sensor                                 (TwoWire *i2c, uint8_t address);
+    LSM303AGR_ACC_StatusTypeDef begin                    (void);
+    LSM303AGR_ACC_StatusTypeDef end                      (void);
     LSM303AGR_ACC_StatusTypeDef Enable                   (void);
     LSM303AGR_ACC_StatusTypeDef Disable                  (void);
     LSM303AGR_ACC_StatusTypeDef ReadID                   (uint8_t *p_id);

src/LSM303AGR_MAG_Sensor.cpp

@@ -52,68 +52,57 @@
 LSM303AGR_MAG_Sensor::LSM303AGR_MAG_Sensor(TwoWire *i2c) : dev_i2c(i2c)
 {
   address = LSM303AGR_MAG_I2C_ADDRESS;
+}
 
+/**
+ * @brief  Configure the sensor in order to be used
+ * @retval 0 in case of success, an error code otherwise
+ */
+LSM303AGR_MAG_StatusTypeDef LSM303AGR_MAG_Sensor::begin(void)
+{
   /* Operating mode selection - power down */
   if ( LSM303AGR_MAG_W_MD( (void *)this, LSM303AGR_MAG_MD_IDLE1_MODE ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_MAG_STATUS_ERROR;
   }
 
   /* Enable BDU */
   if ( LSM303AGR_MAG_W_BDU( (void *)this, LSM303AGR_MAG_BDU_ENABLED ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_MAG_STATUS_ERROR;
   }
 
   if ( SetODR( 100.0f ) == LSM303AGR_MAG_STATUS_ERROR )
   {
-    return;
+    return LSM303AGR_MAG_STATUS_ERROR;
   }
 
   if ( SetFS( 50.0f ) == LSM303AGR_MAG_STATUS_ERROR )
   {
-    return;
+    return LSM303AGR_MAG_STATUS_ERROR;
   }
 
   if ( LSM303AGR_MAG_W_ST( (void *)this, LSM303AGR_MAG_ST_DISABLED ) == MEMS_ERROR )
   {
-    return;
+    return LSM303AGR_MAG_STATUS_ERROR;
   }
-};
 
-/** Constructor
- * @param i2c object of an helper class which handles the I2C peripheral
- * @param address the address of the component's instance
+  return LSM303AGR_MAG_STATUS_OK;
+}
+
+/**
+ * @brief  Disable the sensor and relative resources
+ * @retval 0 in case of success, an error code otherwise
  */
-LSM303AGR_MAG_Sensor::LSM303AGR_MAG_Sensor(TwoWire *i2c, uint8_t address) : dev_i2c(i2c), address(address)
+LSM303AGR_MAG_StatusTypeDef LSM303AGR_MAG_Sensor::end(void)
 {
-  /* Operating mode selection - power down */
-  if ( LSM303AGR_MAG_W_MD( (void *)this, LSM303AGR_MAG_MD_IDLE1_MODE ) == MEMS_ERROR )
+  if(Disable() != LSM303AGR_MAG_STATUS_OK)
   {
-    return;
-  }
-  
-  /* Enable BDU */
-  if ( LSM303AGR_MAG_W_BDU( (void *)this, LSM303AGR_MAG_BDU_ENABLED ) == MEMS_ERROR )
-  {
-    return;
-  }
-  
-  if ( SetODR( 100.0f ) == LSM303AGR_MAG_STATUS_ERROR )
-  {
-    return;
-  }
-  
-  if ( SetFS( 50.0f ) == LSM303AGR_MAG_STATUS_ERROR )
-  {
-    return;
+    return LSM303AGR_MAG_STATUS_ERROR;
   }
 
-  if ( LSM303AGR_MAG_W_ST( (void *)this, LSM303AGR_MAG_ST_DISABLED ) == MEMS_ERROR )
-  {
-    return;
-  }
-};
+  return LSM303AGR_MAG_STATUS_OK;
+}
 
 /**
  * @brief  Enable LSM303AGR magnetometer

src/LSM303AGR_MAG_Sensor.h

@@ -67,7 +67,8 @@ class LSM303AGR_MAG_Sensor
 {
   public:
     LSM303AGR_MAG_Sensor                       (TwoWire *i2c);
-    LSM303AGR_MAG_Sensor                       (TwoWire *i2c, uint8_t address);
+    LSM303AGR_MAG_StatusTypeDef begin          (void);
+    LSM303AGR_MAG_StatusTypeDef end            (void);
     LSM303AGR_MAG_StatusTypeDef Enable         (void);
     LSM303AGR_MAG_StatusTypeDef Disable        (void);
     LSM303AGR_MAG_StatusTypeDef ReadID         (uint8_t *p_id);