Merge pull request #1 from davideq/main

first release

Author: cparata

.github/workflows/Continuous-integration.yml

@@ -0,0 +1,69 @@
+name: ILPS22QS Continuous Integration
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '*'
+      - '**.md'
+      - '**.txt'
+  pull_request:
+    paths-ignore:
+      - '*'
+      - '**.md'
+      - '**.txt'
+jobs:
+  astyle_check:
+    runs-on: ubuntu-latest
+    name: AStyle check
+    steps:
+    # First of all, clone the repo using the checkout action.
+    - name: Checkout
+      uses: actions/checkout@main
+
+    - name: Astyle check
+      id: Astyle
+      uses: stm32duino/actions/astyle-check@main
+
+    # Use the output from the `Astyle` step
+    - name: Astyle Errors
+      if: failure()
+      run: |
+        cat ${{ steps.Astyle.outputs.astyle-result }}
+        exit 1
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@main
+
+    # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
+    - name: Spell check
+      uses: codespell-project/actions-codespell@master
+      with:
+        check_filenames: true
+        check_hidden: true
+        # In the event of a false positive, add the word in all lower case to this file:
+        ignore_words_file: ./extras/codespell-ignore-words-list.txt
+  lib_build:
+    runs-on: ubuntu-latest
+    name: Library compilation
+    steps:
+
+    # First of all, clone the repo using the checkout action.
+    - name: Checkout
+      uses: actions/checkout@main
+
+    - name: Compilation
+      id: compile
+      uses: stm32duino/actions/compile-examples@main
+      with:
+        board-pattern: "NUCLEO_L476RG"
+
+    # Use the output from the `Compilation` step
+    - name: Compilation Errors
+      if: failure()
+      run: |
+        cat ${{ steps.compile.outputs.compile-result }}
+        exit 1

README.md

@@ -1,2 +1,45 @@
-# ILPS22QS
-Arduino library to support the ILPS22QS 1260-4060 hPa absolute digital ouput barometer with embedded Qvar
+#ILPS22QS
+
+Arduino library to support the ILPS22QS absolute digital output barometer
+
+## API
+
+This sensor uses I2C or SPI to communicate.
+For I2C it is then required to create a TwoWire interface before accessing to the sensors:  
+
+    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:  
+
+    SPIClass dev_spi(SPI_MOSI, SPI_MISO, SPI_SCK);  
+    dev_spi.begin();
+
+An instance can be created and enabled when the I2C bus is used following the procedure below:  
+
+   ILPS22QSSensor sensor(&dev_i2c);
+    sensor.begin();
+    sensor.Enable();
+
+An instance can be created and enabled when the SPI bus is used following the procedure below:  
+
+   ILPS22QSSensor sensor(&dev_spi, CS_PIN);
+    sensor.begin();
+    sensor.Enable();
+
+The access to the sensor values is done as explained below:  
+
+  Read pressure and temperature.  
+
+    float pressure;
+    float temperature;
+    sensor.GetPressure(&pressure);  
+    sensor.GetTemperature(&temperature);
+
+## Documentation
+
+You can find the source files at  
+https://github.com/stm32duino/ILPS22QS
+
+TheILPS22QS datasheet is available at  
+https://www.st.com/content/st_com/en/products/mems-and-sensors/pressure-sensors/ilps22qs.html

examples/ILPS22QS_DataLogTerminal/ILPS22QS_DataLogTerminal.ino

@@ -0,0 +1,72 @@
+/*
+   @file    ILPS22QS_DataLogTerminal.ino
+   @author  STMicroelectronics
+   @brief   Example to use the ILPS22QS absolute digital output barometer
+ *******************************************************************************
+   Copyright (c) 2025, STMicroelectronics
+   All rights reserved.
+
+   This software component is licensed by ST under BSD 3-Clause license,
+   the "License"; You may not use this file except in compliance with the
+   License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause
+
+ *******************************************************************************
+*/
+
+// Includes
+#include <ILPS22QSSensor.h>
+
+// Create  an instance of the ILPS22QS sensor
+ILPS22QSSensor sensor(&Wire);
+
+void setup()
+{
+  // Initialize LED for status indication
+  pinMode(LED_BUILTIN, OUTPUT);
+
+  // Initialize serial for output
+  Serial.begin(115200);
+
+  // Initialize bus interface
+  Wire.begin();
+
+  // Initialize sensor component
+  if (sensor.begin() != ILPS22QS_OK) {
+    Serial.println("Failed to initialize ILPS22QS sensor.");
+    while (1);
+  }
+
+  // Enable the sensor
+  if (sensor.Enable() != ILPS22QS_OK) {
+    Serial.println("Failed to enable ILPS22QS sensor.");
+    while (1);
+  }
+  Serial.println("ILPS22QS sensor initialized and enabled.");
+}
+
+void loop()
+{
+  // Variables to store pressure and temperature
+  float pressure, temperature;
+
+  // Read pressure
+  if (sensor.GetPressure(&pressure) != ILPS22QS_OK) {
+    Serial.println("Failed to read pressure.");
+  }
+  // Read temperature
+  if (sensor.GetTemperature(&temperature) != ILPS22QS_OK) {
+    Serial.println("Failed to read temperature.");
+  }
+
+  // Print pressure and temperature values
+  Serial.print("Press[hPa]:");
+  Serial.print(pressure, 2);
+  Serial.print(", Temp[C]:");
+  Serial.println(temperature, 2);
+
+  // LED blinking for status indication
+  digitalWrite(LED_BUILTIN, HIGH);
+  delay(250);
+  digitalWrite(LED_BUILTIN, LOW);
+  delay(250);
+}

extras/codespell-ignore-words-list.txt

@@ -0,0 +1,2 @@
+ois
+ths

keywords.txt

@@ -0,0 +1,40 @@
+#######################################
+# Syntax Coloring Map For LPS22DF
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+ILPS22QSSensor	KEYWORD1
+ILPS22QSStatusTypeDef KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+begin KEYWORD2
+end KEYWORD2
+ReadID KEYWORD2
+Get_Init_Status KEYWORD2
+Enable KEYWORD2
+Disable KEYWORD2
+GetOutputDataRate KEYWORD2
+SetOutputDataRate KEYWORD2
+GetPressure KEYWORD2
+Get_Press_DRDY_Status KEYWORD2
+GetTemperature KEYWORD2
+Get_Temp_DRDY_Status KEYWORD2
+Read_Reg KEYWORD2
+Write_Reg KEYWORD2
+Set_One_Shot KEYWORD2
+Get_One_Shot_Status KEYWORD2
+Set_AVG KEYWORD2
+Set_LPF KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+
+ILPS22QS_OK	LITERAL1
+ILPS22QS_ERROR	LITERAL1

library.properties

@@ -0,0 +1,9 @@
+name=STM32duino ILPS22QS
+version=1.0.0
+author=STMicroelectronics
+maintainer=stm32duino
+sentence=Ultra Low Power inertial measurement unit.
+paragraph=This library provides Arduino support for the Ultra Low Power ILPS22QS for STM32 boards.
+category=Sensors
+url=https://github.com/stm32duino/ILPS22QS
+architectures=*