Fix issue in the reg file and some typos

cparata · cparata · commit c49026a868b0 · 2025-10-14T18:15:03.000+02:00
diff --git a/examples/ISM6HG256X_6D_Orientation/ISM6HG256X_6D_Orientation.ino b/examples/ISM6HG256X_6D_Orientation/ISM6HG256X_6D_Orientation.ino
@@ -1,7 +1,7 @@
 /*
-   @file    ISM6HG256X_HelloWorld.ino
+   @file    ISM6HG256X_6D_Orientation.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256X6D Orientation
+   @brief   Example to use the ISM6HG256X 6D Orientation.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_DataLog_Terminal/ISM6HG256X_DataLog_Terminal.ino b/examples/ISM6HG256X_DataLog_Terminal/ISM6HG256X_DataLog_Terminal.ino
@@ -1,7 +1,7 @@
 /*
    @file    ISM6HG256X_DataLog_Terminal.ino
    @author  STMicroelectornics
-   @brief   Example to use the ISM6HG256X inertial measurement sensor
+   @brief   Example to use the ISM6HG256X inertial measurement sensor.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_Double_Tap_Detection/ISM6HG256X_Double_Tap_Detection.ino b/examples/ISM6HG256X_Double_Tap_Detection/ISM6HG256X_Double_Tap_Detection.ino
@@ -1,7 +1,7 @@
 /*
    @file    ISM6HG256X_Double_Tap_Detection.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256XDouble Tap Detection
+   @brief   Example to use the ISM6HG256X Double Tap Detection.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_FIFO_Interrupt/ISM6HG256X_FIFO_Interrupt.ino b/examples/ISM6HG256X_FIFO_Interrupt/ISM6HG256X_FIFO_Interrupt.ino
@@ -1,7 +1,7 @@
 /*
-   @file    STEVAL_MEMS_FIFO_Interrupt.ino
+   @file    ISM6HG256X_FIFO_Interrupt.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256Xlibrary with FIFO status interrupts.
+   @brief   Example to use the ISM6HG256X library with FIFO in interrupt mode.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_FIFO_Polling/ISM6HG256X_FIFO_Polling.ino b/examples/ISM6HG256X_FIFO_Polling/ISM6HG256X_FIFO_Polling.ino
@@ -1,7 +1,7 @@
 /*
-   @file    STEVAL_MEMS_FIFO_Interrupt.ino
+   @file    ISM6HG256X_FIFO_Interrupt.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256Xlibrary with FIFO status interrupts.
+   @brief   Example to use the ISM6HG256X library with FIFO in polling mode.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_Free_Fall_Detection/ISM6HG256X_Free_Fall_Detection.ino b/examples/ISM6HG256X_Free_Fall_Detection/ISM6HG256X_Free_Fall_Detection.ino
@@ -1,7 +1,7 @@
 /*
    @file    ISM6HG256X_Free_Fall_Detection.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256XFree Fall Detection
+   @brief   Example to use the ISM6HG256X Free Fall Detection.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_Pedometer/ISM6HG256X_Pedometer.ino b/examples/ISM6HG256X_Pedometer/ISM6HG256X_Pedometer.ino
@@ -1,7 +1,7 @@
 /*
    @file    ISM6HG256X_Pedometer.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256XPedometer
+   @brief   Example to use the ISM6HG256X Pedometer.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_Single_Tap_Detection/ISM6HG256X_Single_Tap_Detection.ino b/examples/ISM6HG256X_Single_Tap_Detection/ISM6HG256X_Single_Tap_Detection.ino
@@ -1,7 +1,7 @@
 /*
    @file    ISM6HG256X_Single_Tap_Detection.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256XSingle Tap Detection
+   @brief   Example to use the ISM6HG256X Single Tap Detection.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_Tilt_Detection/ISM6HG256X_Tilt_Detection.ino b/examples/ISM6HG256X_Tilt_Detection/ISM6HG256X_Tilt_Detection.ino
@@ -1,7 +1,7 @@
 /*
    @file    ISM6HG256X_Tilt_Detection.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256XTilt Detection
+   @brief   Example to use the ISM6HG256X Tilt Detection.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/examples/ISM6HG256X_Wake_Up_Detection/ISM6HG256X_Wake_Up_Detection.ino b/examples/ISM6HG256X_Wake_Up_Detection/ISM6HG256X_Wake_Up_Detection.ino
@@ -1,7 +1,7 @@
 /*
    @file    ISM6HG256X_Wake_Up_Detection.ino
    @author  STMicroelectronics
-   @brief   Example to use the ISM6HG256XWake Up Detection
+   @brief   Example to use the ISM6HG256X Wake Up Detection.
  *******************************************************************************
    Copyright (c) 2025, STMicroelectronics
    All rights reserved.
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=STM32duino ISM6HG256X
-version=1.0.0
+version=1.0.1
 author=STMicroelectronics
 maintainer=stm32duino
 sentence= Intelligent IMU with simultaneous low-g and high-g acceleration detection.
diff --git a/src/ism6hg256x_reg.h b/src/ism6hg256x_reg.h
@@ -99,33 +99,6 @@ typedef struct {
 #define PROPERTY_DISABLE                (0U)
 #define PROPERTY_ENABLE                 (1U)
 
-/** @addtogroup  Interfaces_Functions
-  * @brief       This section provide a set of functions used to read and
-  *              write a generic register of the device.
-  *              MANDATORY: return 0 -> no Error.
-  * @{
-  *
-  */
-
-typedef int32_t (*ism6hg256x_write_ptr)(void *, uint8_t, uint8_t *, uint16_t);
-typedef int32_t (*ism6hg256x_read_ptr)(void *, uint8_t, uint8_t *, uint16_t);
-typedef void (*ism6hg256x_mdelay_ptr)(uint32_t millisec);
-
-typedef struct {
-  /** Component mandatory fields **/
-  ism6hg256x_write_ptr  write_reg;
-  ism6hg256x_read_ptr   read_reg;
-  /** Component optional fields **/
-  ism6hg256x_mdelay_ptr   mdelay;
-  /** Customizable optional pointer **/
-  void *handle;
-} ism6hg256x_ctx_t;
-
-/**
-  * @}
-  *
-  */
-
 #endif /* MEMS_SHARED_TYPES */
 
 #ifndef MEMS_UCF_SHARED_TYPES
@@ -154,6 +127,33 @@ typedef struct {
 
 #endif /* MEMS_UCF_SHARED_TYPES */
 
+/**
+  * @}
+  *
+  */
+
+/** @addtogroup  Interfaces_Functions
+  * @brief       This section provide a set of functions used to read and
+  *              write a generic register of the device.
+  *              MANDATORY: return 0 -> no Error.
+  * @{
+  *
+  */
+
+typedef int32_t (*ism6hg256x_write_ptr)(void *, uint8_t, uint8_t *, uint16_t);
+typedef int32_t (*ism6hg256x_read_ptr)(void *, uint8_t, uint8_t *, uint16_t);
+typedef void (*ism6hg256x_mdelay_ptr)(uint32_t millisec);
+
+typedef struct {
+  /** Component mandatory fields **/
+  ism6hg256x_write_ptr  write_reg;
+  ism6hg256x_read_ptr   read_reg;
+  /** Component optional fields **/
+  ism6hg256x_mdelay_ptr   mdelay;
+  /** Customizable optional pointer **/
+  void *handle;
+} ism6hg256x_ctx_t;
+
 /**
   * @}
   *
