Merge pull request #3 from cparata/master

Add begin and end APIs and fix issues on hardware events

Author: cparata

README.md

@@ -6,47 +6,36 @@ Arduino library to support the ISM330DHCX 3D accelerometer and 3D gyroscope
 This sensor uses I2C or SPI 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();
 
 For SPI it is then required to create a SPI interface before accessing to the sensors:  
 
-    dev_spi = new SPIClass(SPI_MOSI, SPI_MISO, SPI_SCK);  
-    dev_spi->begin();
+    SPIClass dev_spi(SPI_MOSI, SPI_MISO, SPI_SCK);  
+    dev_spi.begin();
 
-An instance can be create and enabled 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:  
 
-	AccGyro = new ISM330DHCXSensor(dev_i2c);
+    ISM330DHCXSensor AccGyr(&dev_i2c);
+    AccGyr.begin();
+    AccGyr.ACC_Enable();  
+    AccGyr.GYRO_Enable();
 
-Enable accelerometer.
+An instance can be created and enabled when the SPI bus is used following the procedure below:  
 
-	AccGyro->ACC_Enable();
-
-Enable gyroscope.
-
-	AccGyro->GYRO_Enable();
-
-An instance can be create and enabled when the SPI bus is used following the procedure below:
-
-	AccGyro = new ISM330DHCXSensor(dev_spi, CS_PIN);
-
-Enable accelerometer.
-
-	AccGyro->ACC_Enable();
-
-Enable gyroscope.
-
-	AccGyro->GYRO_Enable();
+    ISM330DHCXSensor AccGyr(&dev_spi, CS_PIN);
+    AccGyr.begin();	
+    AccGyr.ACC_Enable();  
+    AccGyr.GYRO_Enable();
 
 The access to the sensor value is done as explained below:
 
-  Read accelerometer.
-
-	AccGyro->ACC_GetAxes();
-
-  Read gyroscope.
+  Read accelerometer and gyroscope.
 
-	AccGyro->GYRO_GetAxes();
+    int32_t accelerometer[3];
+    int32_t gyroscope[3];
+    AccGyr.ACC_GetAxes(accelerometer);  
+    AccGyr.GYRO_GetAxes(gyroscope);
 
 ## Documentation 
 You can find the source files at  

keywords.txt

@@ -6,16 +6,17 @@
 # Datatypes (KEYWORD1)
 #######################################
 
-ISM330DHCXSensor			KEYWORD1
-ISM330DHCXStatusTypeDef		KEYWORD1
+ISM330DHCXSensor	KEYWORD1
+ISM330DHCXStatusTypeDef	KEYWORD1
 ISM330DHCX_Event_Status_t	KEYWORD1
 
 #######################################
 # Methods and Functions (KEYWORD2)
 #######################################
 
+begin	KEYWORD2
+end	KEYWORD2
 ReadID	KEYWORD2
-
 ACC_Enable	KEYWORD2
 ACC_Disable	KEYWORD2
 ACC_GetSensitivity	KEYWORD2
@@ -25,7 +26,6 @@ ACC_GetFullScale	KEYWORD2
 ACC_SetFullScale	KEYWORD2
 ACC_GetAxes	KEYWORD2
 ACC_GetAxesRaw	KEYWORD2
-
 GYRO_Enable	KEYWORD2
 GYRO_Disable	KEYWORD2
 GYRO_GetSensitivity	KEYWORD2
@@ -35,10 +35,8 @@ GYRO_GetFullScale	KEYWORD2
 GYRO_SetFullScale	KEYWORD2
 GYRO_GetAxes	KEYWORD2
 GYRO_GetAxesRaw	KEYWORD2
-
 ReadReg	KEYWORD2
 WriteReg	KEYWORD2
-
 ACC_SetSelfTest	KEYWORD2
 ACC_GetSelfTest KEYWORD2
 ACC_GetDRDYStatus	KEYWORD2
@@ -47,53 +45,46 @@ GYRO_SetSelfTest	KEYWORD2
 GYRO_GetSelfTest KEYWORD2
 GYRO_GetDRDYStatus	KEYWORD2
 GYRO_Enable_HP_Filter KEYWORD2
-
 ACC_GetEventStatus KEYWORD2
-
-ACC_EnableFreeFallDetection		KEYWORD2
-ACC_DisableFreeFallDetection		KEYWORD2
-ACC_SetFreeFallThreshold		KEYWORD2
-ACC_SetFreeFallDuration		KEYWORD2
-
-ACC_EnableWakeUpDetection		KEYWORD2
-ACC_DisableWakeUpDetection		KEYWORD2
-ACC_SetWakeUpThreshold		KEYWORD2
-ACC_SetWakeUpDuration		KEYWORD2
-
-ACC_EnableSingleTapDetection		KEYWORD2
-ACC_DisableSingleTapDetection		KEYWORD2
-ACC_EnableDoubleTapDetection		KEYWORD2
-ACC_DisableDoubleTapDetection		KEYWORD2
-ACC_SetTapThreshold		KEYWORD2
-ACC_SetTapShockTime		KEYWORD2
-ACC_SetTapQuietTime		KEYWORD2
-ACC_SetTapDurationTime		KEYWORD2
-
-ACC_Enable6DOrientation		KEYWORD2
-ACC_Disable6DOrientation		KEYWORD2
-ACC_Set6DOrientationThreshold		KEYWORD2
-ACC_Get6DOrientationXL		KEYWORD2
-ACC_Get6DOrientationXH		KEYWORD2
-ACC_Get6DOrientationYL		KEYWORD2
-ACC_Get6DOrientationYH		KEYWORD2
-ACC_Get6DOrientationZL		KEYWORD2
-ACC_Get6DOrientationZH		KEYWORD2
+ACC_EnableFreeFallDetection	KEYWORD2
+ACC_DisableFreeFallDetection	KEYWORD2
+ACC_SetFreeFallThreshold	KEYWORD2
+ACC_SetFreeFallDuration	KEYWORD2
+ACC_EnableWakeUpDetection	KEYWORD2
+ACC_DisableWakeUpDetection	KEYWORD2
+ACC_SetWakeUpThreshold	KEYWORD2
+ACC_SetWakeUpDuration	KEYWORD2
+ACC_EnableSingleTapDetection	KEYWORD2
+ACC_DisableSingleTapDetection	KEYWORD2
+ACC_EnableDoubleTapDetection	KEYWORD2
+ACC_DisableDoubleTapDetection	KEYWORD2
+ACC_SetTapThreshold	KEYWORD2
+ACC_SetTapShockTime	KEYWORD2
+ACC_SetTapQuietTime	KEYWORD2
+ACC_SetTapDurationTime	KEYWORD2
+ACC_Enable6DOrientation	KEYWORD2
+ACC_Disable6DOrientation	KEYWORD2
+ACC_Set6DOrientationThreshold	KEYWORD2
+ACC_Get6DOrientationXL	KEYWORD2
+ACC_Get6DOrientationXH	KEYWORD2
+ACC_Get6DOrientationYL	KEYWORD2
+ACC_Get6DOrientationYH	KEYWORD2
+ACC_Get6DOrientationZL	KEYWORD2
+ACC_Get6DOrientationZH	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)
 #######################################
 
 IIS2DLPC_OK	LITERAL1
 IIS2DLPC_ERROR	LITERAL1
-
 ISM330DHCX_ACC_SENSITIVITY_FS_2G	LITERAL1
 ISM330DHCX_ACC_SENSITIVITY_FS_4G	LITERAL1
 ISM330DHCX_ACC_SENSITIVITY_FS_8G	LITERAL1
 ISM330DHCX_ACC_SENSITIVITY_FS_16G	LITERAL1
-
 ISM330DHCX_GYRO_SENSITIVITY_FS_125DPS	LITERAL1
 ISM330DHCX_GYRO_SENSITIVITY_FS_250DPS	LITERAL1
 ISM330DHCX_GYRO_SENSITIVITY_FS_500DPS	LITERAL1
 ISM330DHCX_GYRO_SENSITIVITY_FS_1000DPS	LITERAL1
 ISM330DHCX_GYRO_SENSITIVITY_FS_2000DPS	LITERAL1
-ISM330DHCX_GYRO_SENSITIVITY_FS_4000DPS	LITERAL1
+ISM330DHCX_GYRO_SENSITIVITY_FS_4000DPS	LITERAL1

library.properties

@@ -1,5 +1,5 @@
 name=STM32duino ISM330DHCX
-version=1.0.0
+version=2.0.0
 author=SRA
 maintainer=stm32duino
 sentence=High-Performance 3D digital accelerometer and 3D digital gyroscope.