Merge pull request #1 from davideq/main

first release

Author: cparata

.github/workflows/Continuous-integration.yml

@@ -0,0 +1,69 @@
+name: ISM330IS 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,50 @@
 # ISM330IS
-Arduino library to support the ISM330IS 3D accelerometer and 3D gyroscope with ISPU
+Arduino library to support the ISM330IS 3D accelerometer and 3D gyroscope
+
+## 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:  
+
+    ISM330ISSensor AccGyr(&dev_i2c);
+    AccGyr.begin();
+    AccGyr.Enable_X();  
+    AccGyr.Enable_G();
+
+An instance can be created and enabled when the SPI bus is used following the procedure below:  
+
+    ISM330ISSensor AccGyr(&dev_spi, CS_PIN);
+    AccGyr.begin();	
+    AccGyr.Enable_X();  
+    AccGyr.Enable_G();
+
+The access to the sensor values is done as explained below:  
+
+  Read accelerometer and gyroscope.
+
+    ISM330IS_Axes_t accelerometer;
+    ISM330IS_Axes_t gyroscope;
+    AccGyr.Get_X_Axes(accelerometer);  
+    AccGyr.Get_G_Axes(gyroscope);
+
+## Examples
+
+* ISM330IS_DataLog_Terminal: This application shows how to get data from ISM330IS accelerometer and gyroscope and print them on terminal.
+
+## Documentation
+
+You can find the source files at  
+https://github.com/stm32duino/ISM330IS
+
+The ISM330IS datasheet is available at  
+https://www.st.com/en/mems-and-sensors/ism330is.html

examples/ISM330IS_DataLog_Terminal/ISM330IS_DataLog_Terminal.ino

@@ -0,0 +1,60 @@
+/*
+   @file    ISM330IS_DataLog_Terminal.ino
+   @author  STMicroelectronics
+   @brief   Example to use the ISM330IS inertial measurement sensor
+ *******************************************************************************
+   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
+ *******************************************************************************
+*/
+
+#include <ISM330ISSensor.h>
+
+ISM330ISSensor sensor(&Wire);
+
+
+void setup()
+{
+  pinMode(LED_BUILTIN, OUTPUT);
+  Serial.begin(115200);
+  Wire.begin();
+  sensor.begin();
+  sensor.Enable_X();
+  sensor.Enable_G();
+}
+
+void loop()
+{
+  ISM330IS_Axes_t accel;
+  ISM330IS_Axes_t angrate;
+  sensor.Get_X_Axes(&accel);
+  sensor.Get_G_Axes(&angrate);
+
+  Serial.print("Accel-X[mg]:");
+  Serial.print(accel.x);
+  Serial.print(",Accel-Y[mg]:");
+  Serial.print(accel.y);
+  Serial.print(",Accel-Z[mg]:");
+  Serial.println(accel.z);
+
+  Serial.print("AngRate-X[mdps]:");
+  Serial.print(angrate.x);
+  Serial.print(",AngRate-Y[mdps]:");
+  Serial.print(angrate.y);
+  Serial.print(",AngRate-Z[mdps]:");
+  Serial.println(angrate.z);
+
+  blink(LED_BUILTIN);
+}
+
+inline void blink(int pin)
+{
+  digitalWrite(pin, HIGH);
+  delay(25);
+  digitalWrite(pin, LOW);
+  delay(975);
+}

extras/codespell-ignore-words-list.txt

@@ -0,0 +1 @@
+DOUT

keywords.txt

@@ -0,0 +1,69 @@
+#######################################
+# Syntax Coloring Map For ISM330IS
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+ISM330ISSensor KEYWORD1
+ISM330IS_SensorIntPin_t KEYWORD1
+ISM330IS_AxesRaw_t KEYWORD1
+ISM330IS_Axes_t KEYWORD1
+ISM330IS_Event_Status_t KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+ReadID KEYWORD2
+Read_Reg KEYWORD2
+Write_Reg KEYWORD2
+Set_Interrupt_Latch KEYWORD2
+Enable_X KEYWORD2
+Disable_X KEYWORD2
+Get_X_Sensitivity KEYWORD2
+Get_X_OutputDataRate KEYWORD2
+Set_X_OutputDataRate KEYWORD2
+Get_X_FullScale KEYWORD2
+Set_X_FullScale KEYWORD2
+Get_X_AxesRaw KEYWORD2
+Get_X_Axes KEYWORD2
+Enable_G KEYWORD2
+Disable_G KEYWORD2
+Get_G_Sensitivity KEYWORD2
+Get_G_OutputDataRate KEYWORD2
+Set_G_OutputDataRate KEYWORD2
+Get_G_FullScale KEYWORD2
+Set_G_FullScale KEYWORD2
+Get_G_AxesRaw KEYWORD2
+Get_G_Axes KEYWORD2
+Get_X_Event_Status KEYWORD2
+Set_X_SelfTest KEYWORD2
+Get_X_DRDY_Status KEYWORD2
+Get_X_Init_Status KEYWORD2
+Set_X_INT1_DRDY KEYWORD2
+Set_G_SelfTest KEYWORD2
+Get_G_DRDY_Status KEYWORD2
+Get_G_Init_Status KEYWORD2
+Set_G_INT1_DRDY KEYWORD2
+Set_DRDY_Mode KEYWORD2
+Set_Mem_Bank KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+
+ISM330IS_OK LITERAL1
+ISM330IS_ERROR LITERAL1
+ISM330IS_ACC_SENSITIVITY_FS_2G LITERAL1
+ISM330IS_ACC_SENSITIVITY_FS_4G LITERAL1
+ISM330IS_ACC_SENSITIVITY_FS_8G LITERAL1
+ISM330IS_ACC_SENSITIVITY_FS_16G LITERAL1
+ISM330IS_GYRO_SENSITIVITY_FS_125DPS LITERAL1
+ISM330IS_GYRO_SENSITIVITY_FS_250DPS LITERAL1
+ISM330IS_GYRO_SENSITIVITY_FS_500DPS LITERAL1
+ISM330IS_GYRO_SENSITIVITY_FS_1000DPS LITERAL1
+ISM330IS_GYRO_SENSITIVITY_FS_2000DPS LITERAL1
+
+

library.properties

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