Merge pull request #1 from cparata/master

Add code for LPS25HB and example for X-NUCLEO-IKS01A1

Author: cparata

README.md

@@ -1,2 +1,29 @@
 # LPS25HB
-Arduino library to support the LPS25HB 260-1260 hPa absolute digital ouput barometer
+Arduino library to support the LPS25HB 260-1260 hPa absolute digital output barometer
+
+## API
+
+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();  
+
+An instance can be created and enbaled following the procedure below:  
+
+    PressTemp = new LPS25HBSensor(dev_i2c);  
+    PressTemp->Enable();  
+
+The access to the sensor values is done as explained below:  
+
+  Read pressure and temperature.  
+
+    PressTemp->GetPressure(&pressure);  
+    PressTemp->GetTemperature(&temperature);  
+
+## Documentation
+
+You can find the source files at  
+https://github.com/stm32duino/LPS25HB
+
+The LPS25HB datasheet is available at  
+http://www.st.com/content/st_com/en/products/mems-and-sensors/pressure-sensors/lps25hb.html

examples/X_NUCLEO_IKS01A1_LPS25HB_DataLog_Terminal/X_NUCLEO_IKS01A1_LPS25HB_DataLog_Terminal.ino

@@ -0,0 +1,89 @@
+/**
+ ******************************************************************************
+ * @file    X_NUCLEO_IKS01A1_LPS25HB_DataLog_Terminal.ino
+ * @author  AST
+ * @version V1.0.0
+ * @date    7 September 2017
+ * @brief   Arduino test application for the STMicrolectronics X-NUCLEO-IKS01A2
+ *          MEMS Inertial and Environmental sensor expansion board.
+ *          This application makes use of C++ classes obtained from the C
+ *          components' drivers.
+ ******************************************************************************
+ * @attention
+ *
+ * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright notice,
+ *      this list of conditions and the following disclaimer in the documentation
+ *      and/or other materials provided with the distribution.
+ *   3. Neither the name of STMicroelectronics nor the names of its contributors
+ *      may be used to endorse or promote products derived from this software
+ *      without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ ******************************************************************************
+ */
+
+
+// Includes.
+#include <LPS25HBSensor.h>
+
+#if defined(ARDUINO_SAM_DUE)
+#define DEV_I2C Wire1   //Define which I2C bus is used. Wire1 for the Arduino Due
+#define SerialPort Serial
+#else
+#define DEV_I2C Wire    //Or Wire
+#define SerialPort Serial
+#endif
+
+// Components.
+LPS25HBSensor  *PressTemp;
+
+void setup() {
+  // Led.
+  pinMode(13, OUTPUT);
+
+  // Initialize serial for output.
+  SerialPort.begin(9600);
+  
+  // Initialize I2C bus.
+  DEV_I2C.begin();
+
+  // Initlialize components.
+  PressTemp = new LPS25HBSensor (&DEV_I2C);
+  PressTemp->Enable();
+}
+
+void loop() {
+  // Led blinking.
+  digitalWrite(13, HIGH);
+  delay(250);
+  digitalWrite(13, LOW);
+  delay(250);
+  
+  // Read pressure and temperature.
+  float pressure, temperature;
+  PressTemp->GetPressure(&pressure);
+  PressTemp->GetTemperature(&temperature);
+
+  // Output data.
+  SerialPort.print("| Pres[hPa]: ");
+  SerialPort.print(pressure, 2);
+  SerialPort.print(" | Temp[C]: ");
+  SerialPort.print(temperature, 2);
+  SerialPort.println(" |");
+}

keywords.txt

@@ -0,0 +1,31 @@
+#######################################
+# Syntax Coloring Map For LPS25HB
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+LPS25HBSensor	KEYWORD1	LPS25HBSensor
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+Enable							KEYWORD2
+Disable							KEYWORD2
+ReadID							KEYWORD2
+Reset							KEYWORD2
+GetTemperature					KEYWORD2
+GetODR							KEYWORD2
+SetODR							KEYWORD2
+ReadReg							KEYWORD2
+WriteReg						KEYWORD2
+IO_Read							KEYWORD2
+IO_Write						KEYWORD2
+GetPressure						KEYWORD2
+
+
+#######################################
+# Constants (LITERAL1)
+#######################################

library.properties

@@ -0,0 +1,9 @@
+name=LPS25HB
+version=1.0
+author=AST
+maintainer=stm32duino
+sentence=260-1260 hPa absolute digital output barometer.
+paragraph=This library provides Arduino support for the 260-1260 hPa absolute digital output barometer LPS25HB for STM32 boards.
+category=Sensors
+url=https://github.com/stm32duino/LPS25HB
+architectures=stm32