add examples

Author: ladyada

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,46 @@
+Thank you for opening an issue on an Adafruit Arduino library repository.  To
+improve the speed of resolution please review the following guidelines and
+common troubleshooting steps below before creating the issue:
+
+- **Do not use GitHub issues for troubleshooting projects and issues.**  Instead use
+  the forums at http://forums.adafruit.com to ask questions and troubleshoot why
+  something isn't working as expected.  In many cases the problem is a common issue
+  that you will more quickly receive help from the forum community.  GitHub issues
+  are meant for known defects in the code.  If you don't know if there is a defect
+  in the code then start with troubleshooting on the forum first.
+
+- **If following a tutorial or guide be sure you didn't miss a step.** Carefully
+  check all of the steps and commands to run have been followed.  Consult the
+  forum if you're unsure or have questions about steps in a guide/tutorial.
+
+- **For Arduino projects check these very common issues to ensure they don't apply**:
+
+  - For uploading sketches or communicating with the board make sure you're using
+    a **USB data cable** and **not** a **USB charge-only cable**.  It is sometimes
+    very hard to tell the difference between a data and charge cable!  Try using the
+    cable with other devices or swapping to another cable to confirm it is not
+    the problem.
+
+  - **Be sure you are supplying adequate power to the board.**  Check the specs of
+    your board and plug in an external power supply.  In many cases just
+    plugging a board into your computer is not enough to power it and other
+    peripherals.
+
+  - **Double check all soldering joints and connections.**  Flakey connections
+    cause many mysterious problems.  See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints.
+
+  - **Ensure you are using an official Arduino or Adafruit board.** We can't
+    guarantee a clone board will have the same functionality and work as expected
+    with this code and don't support them.
+
+If you're sure this issue is a defect in the code and checked the steps above
+please fill in the following fields to provide enough troubleshooting information.
+You may delete the guideline and text above to just leave the following details:
+
+- Arduino board:  **INSERT ARDUINO BOARD NAME/TYPE HERE**
+
+- Arduino IDE version (found in Arduino -> About Arduino menu):  **INSERT ARDUINO
+  VERSION HERE**
+
+- List the steps to reproduce the problem below (if possible attach a sketch or
+  copy the sketch code in too): **LIST REPRO STEPS BELOW**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+Thank you for creating a pull request to contribute to Adafruit's GitHub code!
+Before you open the request please review the following guidelines and tips to
+help it be more easily integrated:
+
+- **Describe the scope of your change--i.e. what the change does and what parts
+  of the code were modified.**  This will help us understand any risks of integrating
+  the code.
+
+- **Describe any known limitations with your change.**  For example if the change
+  doesn't apply to a supported platform of the library please mention it.
+
+- **Please run any tests or examples that can exercise your modified code.**  We
+  strive to not break users of the code and running tests/examples helps with this
+  process.
+
+Thank you again for contributing!  We will try to test and integrate the change
+as soon as we can, but be aware we have many GitHub repositories to manage and
+can't immediately respond to every request.  There is no need to bump or check in
+on a pull request (it will clutter the discussion of the request).
+
+Also don't be worried if the request is closed or not integrated--sometimes the
+priorities of Adafruit's GitHub code (education, ease of use) might not match the
+priorities of the pull request.  Don't fret, the open source community thrives on
+forks and GitHub makes it easy to keep your changes in a forked repo.
+
+After reviewing the guidelines above you can delete this text from the pull request.

.github/workflows/githubci.yml

@@ -0,0 +1,32 @@
+name: Arduino Library CI
+
+on: [pull_request, push, repository_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+    - uses: actions/checkout@v3
+    - uses: actions/checkout@v3
+      with:
+         repository: adafruit/ci-arduino
+         path: ci
+
+    - name: pre-install
+      run: bash ci/actions_install.sh
+
+    - name: test platforms
+      run: python3 ci/build_platform.py main_platforms
+
+    - name: clang
+      run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r . 
+
+    - name: doxygen
+      env:
+        GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
+        PRETTYNAME : "Adafruit LPS28 Barometric Pressure Sensor Library"
+      run: bash ci/doxy_gen_and_deploy.sh

Adafruit_LPS28.cpp

@@ -58,6 +58,12 @@ bool Adafruit_LPS28::setFullScaleMode(bool mode) {
   return fs_mode_bit.write(mode);
 }
 
+bool Adafruit_LPS28::getFullScaleMode() {
+  Adafruit_BusIO_Register ctrl_reg2(i2c_dev, LPS28_CTRL_REG2, 1);
+  Adafruit_BusIO_RegisterBits fs_mode_bit(&ctrl_reg2, 1, 6); // FS_MODE bit is bit 6
+  return fs_mode_bit.read();
+}
+
 bool Adafruit_LPS28::setLowPassODR9(bool enable) {
   Adafruit_BusIO_Register ctrl_reg2(i2c_dev, LPS28_CTRL_REG2, 1);
   Adafruit_BusIO_RegisterBits lpfp_cfg_bit(&ctrl_reg2, 1, 5);
@@ -138,3 +144,134 @@ bool Adafruit_LPS28::setPressureInterrupt(bool low, bool high, bool latching) {
   Adafruit_BusIO_RegisterBits lir_bit(&interrupt_cfg, 1, 3);
   return phe_bit.write(high) && ple_bit.write(low) && lir_bit.write(latching);
 }
+
+
+bool Adafruit_LPS28::setIntPinOutput(bool drdy, bool drdy_pulse, bool int_enable,
+                                     bool fifo_full, bool fifo_watermark, bool fifo_overrun) {
+  Adafruit_BusIO_Register ctrl_reg4(i2c_dev, LPS28_CTRL_REG4, 1);
+
+  Adafruit_BusIO_RegisterBits drdy_pulse_bit(&ctrl_reg4, 1, 6); // Bit 6: DRDY_PLS
+  Adafruit_BusIO_RegisterBits drdy_bit(&ctrl_reg4, 1, 5);       // Bit 5: DRDY
+  Adafruit_BusIO_RegisterBits int_enable_bit(&ctrl_reg4, 1, 4); // Bit 4: INT_EN
+  Adafruit_BusIO_RegisterBits fifo_full_bit(&ctrl_reg4, 1, 2);  // Bit 2: INT_F_FULL
+  Adafruit_BusIO_RegisterBits fifo_watermark_bit(&ctrl_reg4, 1, 1); // Bit 1: INT_F_WTM
+  Adafruit_BusIO_RegisterBits fifo_overrun_bit(&ctrl_reg4, 1, 0); // Bit 0: INT_F_OVR
+
+  bool drdy_pulse_ok = drdy_pulse_bit.write(drdy_pulse);
+  bool drdy_ok = drdy_bit.write(drdy);
+  bool int_enable_ok = int_enable_bit.write(int_enable);
+  bool fifo_full_ok = fifo_full_bit.write(fifo_full);
+  bool fifo_watermark_ok = fifo_watermark_bit.write(fifo_watermark);
+  bool fifo_overrun_ok = fifo_overrun_bit.write(fifo_overrun);
+
+  return drdy_pulse_ok && drdy_ok && int_enable_ok &&
+         fifo_full_ok && fifo_watermark_ok && fifo_overrun_ok;
+}
+
+
+bool Adafruit_LPS28::setFIFOmode(bool stop_on_watermark, lps28_fifo_mode_t mode) {
+  Adafruit_BusIO_Register fifo_ctrl(i2c_dev, LPS28_FIFO_CTRL, 1);
+
+  Adafruit_BusIO_RegisterBits stop_on_wtm_bit(&fifo_ctrl, 1, 3); // Bit 3: STOP_ON_WTM
+  Adafruit_BusIO_RegisterBits f_mode_bits(&fifo_ctrl, 3, 0);     // Bits 2:0 (F_MODE[2:0])
+
+  bool stop_ok = stop_on_wtm_bit.write(stop_on_watermark);
+  bool mode_ok = f_mode_bits.write(mode);
+
+  return stop_ok && mode_ok;
+}
+
+
+bool Adafruit_LPS28::setFIFOWatermark(uint8_t wtm) {
+  Adafruit_BusIO_Register fifo_wtm(i2c_dev, LPS28_FIFO_WTM, 1);
+  return fifo_wtm.write(wtm);
+}
+
+uint8_t Adafruit_LPS28::getFIFOWatermark() {
+  Adafruit_BusIO_Register fifo_wtm(i2c_dev, LPS28_FIFO_WTM, 1);
+  return fifo_wtm.read();
+}
+
+
+int16_t Adafruit_LPS28::getReferencePressure() {
+  Adafruit_BusIO_Register ref_p(i2c_dev, LPS28_REF_P, 2, LSBFIRST);
+  return ref_p.read();
+}
+
+bool Adafruit_LPS28::setPressureOffset(int16_t offset) {
+  Adafruit_BusIO_Register rpds(i2c_dev, LPS28_RPDS, 2, LSBFIRST);
+  return rpds.write(offset);
+}
+
+int16_t Adafruit_LPS28::getPressureOffset() {
+  Adafruit_BusIO_Register rpds(i2c_dev, LPS28_RPDS, 2, LSBFIRST);
+  return rpds.read();
+}
+
+
+uint8_t Adafruit_LPS28::getIntSource() {
+  Adafruit_BusIO_Register int_source(i2c_dev, LPS28_INT_SOURCE, 1);
+  return int_source.read();
+}
+
+uint8_t Adafruit_LPS28::getFIFOunreadSamples() {
+  Adafruit_BusIO_Register fifo_status1(i2c_dev, LPS28_FIFO_STATUS1, 1);
+  return fifo_status1.read();
+}
+
+uint8_t Adafruit_LPS28::getStatus() {
+  Adafruit_BusIO_Register status_reg(i2c_dev, LPS28_STATUS, 1);
+  return status_reg.read();
+}
+
+
+
+float Adafruit_LPS28::getPressure() {
+  // Read the 3-byte PRESS_OUT register
+  Adafruit_BusIO_Register pressure_out(i2c_dev, LPS28_PRESS_OUT, 3, LSBFIRST);
+  int32_t raw_pressure = pressure_out.read();
+
+  // Get full-scale mode using the getter
+  bool fs_mode = getFullScaleMode();
+
+  // Convert raw pressure value to hPa based on FS_MODE
+  float pressure_hpa;
+  if (fs_mode) {
+    pressure_hpa = raw_pressure / 2048.0; // FS_MODE = 1, 1 LSB = 1/2048 hPa
+  } else {
+    pressure_hpa = raw_pressure / 4096.0; // FS_MODE = 0, 1 LSB = 1/4096 hPa
+  }
+
+  return pressure_hpa;
+}
+
+
+float Adafruit_LPS28::getTemperature() {
+  // Read the 2-byte TEMP_OUT register (signed 16-bit, 2's complement)
+  Adafruit_BusIO_Register temp_out(i2c_dev, LPS28_TEMP_OUT, 2, LSBFIRST);
+  int16_t raw_temperature = (int16_t)temp_out.read();
+
+  // Convert raw temperature to degrees Celsius
+  float temperature_celsius = raw_temperature * 0.01; // 1 LSB = 0.01 °C
+
+  return temperature_celsius;
+}
+
+float Adafruit_LPS28::getFIFOpressure() {
+  // Read the 3-byte FIFO_DATA_OUT_PRESS_XL register
+  Adafruit_BusIO_Register fifo_pressure_out(i2c_dev, LPS28_FIFO_DATA_OUT_PRESS_XL, 3, LSBFIRST);
+  int32_t raw_pressure = fifo_pressure_out.read();
+
+  // Get full-scale mode using the getter
+  bool fs_mode = getFullScaleMode();
+
+  // Convert raw pressure value to hPa based on FS_MODE
+  float pressure_hpa;
+  if (fs_mode) {
+    pressure_hpa = raw_pressure / 2048.0; // FS_MODE = 1, 1 LSB = 1/2048 hPa
+  } else {
+    pressure_hpa = raw_pressure / 4096.0; // FS_MODE = 0, 1 LSB = 1/4096 hPa
+  }
+
+  return pressure_hpa;
+}

Adafruit_LPS28.h

@@ -6,16 +6,48 @@
 #include <Adafruit_BusIO_Register.h>
 
 // I2C Address and Register Definitions
-#define LPS28_DEFAULT_ADDRESS (0x5D) ///< Default I2C address
+#define LPS28_DEFAULT_ADDRESS (0x5C) ///< Default I2C address
 #define LPS28_WHOAMI_REG 0x0F        ///< WHO_AM_I register
 #define LPS28_WHOAMI_EXPECTED 0xB4   ///< Expected WHO_AM_I value
 
 #define LPS28_THS_P 0x0C             ///< Threshold Pressure (2 bytes)
 #define LPS28_CTRL_REG1 0x10         ///< Control Register 1 (ODR and AVG)
 #define LPS28_CTRL_REG2 0x11         ///< Control Register 2
 #define LPS28_CTRL_REG3 0x12         ///< Control Register 3 (Interrupt config)
+#define LPS28_CTRL_REG4 0x13 ///< Control Register 4
 #define LPS28_INTERRUPT_CFG 0x0B     ///< Interrupt Configuration Register
 #define LPS28_IF_CTRL 0x0E           ///< Interface Control Register
+#define LPS28_FIFO_CTRL 0x14 ///< FIFO Control Register
+#define LPS28_FIFO_WTM 0x15 ///< FIFO Watermark Register
+#define LPS28_REF_P 0x16 ///< Reference Pressure Register (2 bytes)
+#define LPS28_RPDS 0x18 ///< RPDS Register (Pressure Offset, 2 bytes)
+#define LPS28_INT_SOURCE 0x24 ///< INT_SOURCE Register
+#define LPS28_FIFO_STATUS1 0x25 ///< FIFO_STATUS1 Register
+#define LPS28_FIFO_STATUS2 0x26 ///< FIFO_STATUS2 Register
+#define LPS28_STATUS 0x27 ///< STATUS Register
+#define LPS28_PRESS_OUT 0x28 ///< PRESS_OUT Register (3 bytes)
+#define LPS28_TEMP_OUT 0x2B ///< TEMP_OUT Register (2 bytes)
+#define LPS28_FIFO_DATA_OUT_PRESS_XL 0x78 ///< FIFO_DATA_OUT_PRESS_XL Register (3 bytes)
+
+
+
+// STATUS flags
+#define LPS28_STATUS_TEMP_OVERRUN 0x20 ///< Temperature data overrun (bit 5)
+#define LPS28_STATUS_PRESS_OVERRUN 0x10 ///< Pressure data overrun (bit 4)
+#define LPS28_STATUS_TEMP_READY   0x02 ///< Temperature data available (bit 1)
+#define LPS28_STATUS_PRESS_READY  0x01 ///< Pressure data available (bit 0)
+
+// FIFO_STATUS2 flags
+#define LPS28_FIFO_STATUS_WTM_IA  0x80 ///< FIFO Watermark interrupt active (bit 7)
+#define LPS28_FIFO_STATUS_OVR_IA  0x40 ///< FIFO Overrun interrupt active (bit 6)
+#define LPS28_FIFO_STATUS_FULL_IA 0x20 ///< FIFO Full interrupt active (bit 5)
+
+// INT_SOURCE flags
+#define LPS28_INT_SOURCE_IA      0x20  ///< Interrupt Active flag (bit 5)
+#define LPS28_INT_SOURCE_PL      0x10  ///< Low pressure event flag (bit 4)
+#define LPS28_INT_SOURCE_PH      0x08  ///< High pressure event flag (bit 3)
+#define LPS28_INT_SOURCE_BOOT_ON 0x80  ///< Boot status flag (bit 7)
+
 
 // Output Data Rate (ODR) configuration (Table 19)
 typedef enum {
@@ -41,6 +73,19 @@ typedef enum {
   LPS28_AVG_512 = 0b111  ///< 512 samples
 } lps28_avg_t;
 
+
+// FIFO Mode Selection based on TRIG_MODE and F_MODE bits
+typedef enum {
+  LPS28_FIFO_BYPASS                   = 0b00, ///< Bypass mode (F_MODE[1:0] = 00)
+  LPS28_FIFO_FIFO                     = 0b01, ///< FIFO mode (TRIG = 0, F_MODE[1:0] = 01)
+  LPS28_FIFO_CONTINUOUS               = 0b10, ///< Continuous mode (TRIG = 0, F_MODE[1:0] = 1x)
+  LPS28_FIFO_BYPASS_TO_FIFO           = 0b101, ///< Bypass-to-FIFO mode (TRIG = 1, F_MODE[1:0] = 01)
+  LPS28_FIFO_BYPASS_TO_CONTINUOUS     = 0b110, ///< Bypass-to-Continuous mode (TRIG = 1, F_MODE[1:0] = 10)
+  LPS28_FIFO_CONTINUOUS_TO_FIFO       = 0b111  ///< Continuous-to-FIFO mode (TRIG = 1, F_MODE[1:0] = 11)
+} lps28_fifo_mode_t;
+
+
+
 class Adafruit_LPS28 {
 public:
   Adafruit_LPS28();
@@ -62,12 +107,15 @@ class Adafruit_LPS28 {
   // CTRL_REG2 functions
   bool rebootMemory();
   bool setFullScaleMode(bool mode);
+  bool getFullScaleMode();
   bool setLowPassODR9(bool enable);
   bool reset();
   bool triggerOneShot();
 
   // Interrupt Configuration (CTRL_REG3) functions
   bool setInterruptPin(bool polarity, bool openDrain);
+  bool setIntPinOutput(bool drdy, bool drdy_pulse, bool int_enable,
+                       bool fifo_full, bool fifo_watermark, bool fifo_overrun);
 
   // Interface Control Register (IF_CTRL) functions
   bool setSDAPullup(bool enable);
@@ -78,11 +126,28 @@ class Adafruit_LPS28 {
   bool getAutoReferencePressure();
   bool resetAutoReferencePressure();
 
+  int16_t getReferencePressure();
+  bool setPressureOffset(int16_t offset);
+  int16_t getPressureOffset();
+
   bool setAutoZero(bool enable);
   bool getAutoZero();
   bool resetAutoZero();
 
   bool setPressureInterrupt(bool low, bool high, bool latching);
+  uint8_t getIntSource();
+
+  // FIFO
+  bool setFIFOWatermark(uint8_t wtm);
+  uint8_t getFIFOWatermark(); 
+  uint8_t getFIFOunreadSamples();
+  uint8_t getFIFOstatus();
+  bool setFIFOmode(bool stop_on_watermark, lps28_fifo_mode_t mode);
+
+  uint8_t getStatus();
+  float getPressure();
+  float getTemperature();
+  float getFIFOpressure();
 
 private:
   Adafruit_I2CDevice *i2c_dev = nullptr; ///< Pointer to I2C device interface