Merge airmouse/lib/lsm6ds3tr-api from https://github.com/STMicroelectronics/lsm6ds3tr-c-pid

airmouse/lib/lsm6ds3tr-api/README.md

@@ -1,3 +1,5 @@
+![latest tag](https://img.shields.io/github/v/tag/STMicroelectronics/lsm6ds3tr-c-pid.svg?color=brightgreen)
+
 # 1 - Introduction
 
 Sensor driver for LSM6DS3TR-C sensor written in C programming language. This repository contains the sensor driver files (.h and .c) to be included, or linked directly as a git submodule, in your project. The driver is MISRA compliant and the documentation can be generated using the [Doxygen](http://www.doxygen.org/) tool.
@@ -16,8 +18,7 @@ Some examples of driver usage can be found [here](https://github.com/STMicroelec
 
 # 2 - Integration details
 
-The driver is platform-independent, you only need to define two  functions for read and write transactions from the sensor hardware bus  (ie. SPI or I²C). **A few devices integrate an extra bit in the  communication protocol in order to enable multi read/write access, this  bit must be managed in the read and write functions defined by the user.** Please refer to the read and write implementation in the [reference examples](https://github.com/STMicroelectronics/STMems_Standard_C_drivers/tree/master/lsm6ds3tr-c_STdC/examples).
-
+The driver is platform-independent, you only need to define two functions for read and write transactions from the sensor hardware bus (ie. SPI or I²C) and an optional one to implement a delay of millisecond granularity. **A few devices integrate an extra bit in the communication protocol in order to enable multi read/write access, this bit must be managed in the read and write functions defined by the user.** Please refer to the read and write implementation in the [reference examples](https://github.com/STMicroelectronics/STMems_Standard_C_drivers/tree/master/lsm6ds3tr-c_STdC/examples).
 
 
 ### 2.a Source code integration
@@ -27,8 +28,11 @@ The driver is platform-independent, you only need to define two  functions for r
 
 ```
 /** Please note that is MANDATORY: return 0 -> no Error.**/
-int32_t platform_write(void *handle, uint8_t Reg, const uint8_t *Bufp, uint16_t len)
-int32_t platform_read(void *handle, uint8_t Reg, uint8_t *Bufp, uint16_t len)
+int32_t platform_write(void *handle, uint8_t reg, const uint8_t *bufp, uint16_t len)
+int32_t platform_read(void *handle, uint8_t reg, uint8_t *bufp, uint16_t len)
+
+/** Optional (may be required by driver) **/
+void platform_delay(uint32_t millisec)
 ```
 
 - Declare and initialize the structure of the device interface:
@@ -37,6 +41,8 @@ int32_t platform_read(void *handle, uint8_t Reg, uint8_t *Bufp, uint16_t len)
 xxxxxxx_ctx_t dev_ctx; /** xxxxxxx is the used part number **/
 dev_ctx.write_reg = platform_write;
 dev_ctx.read_reg = platform_read;
+dev_ctx.mdelay = platform_delay;
+
 ```
 
 - If needed by the platform read and write functions, initialize the handle parameter:

airmouse/lib/lsm6ds3tr-api/Release_Notes.html

@@ -8,37 +8,49 @@
   <style>
     code{white-space: pre-wrap;}
     span.smallcaps{font-variant: small-caps;}
-    span.underline{text-decoration: underline;}
-    div.column{display: inline-block; vertical-align: top; width: 50%;}
+    div.columns{display: flex; gap: min(4vw, 1.5em);}
+    div.column{flex: auto; overflow-x: auto;}
     div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
-    ul.task-list{list-style: none;}
+    /* The extra [class] is a hack that increases specificity enough to
+       override a similar rule in reveal.js */
+    ul.task-list[class]{list-style: none;}
+    ul.task-list li input[type="checkbox"] {
+      font-size: inherit;
+      width: 0.8em;
+      margin: 0 0.8em 0.2em -1.6em;
+      vertical-align: middle;
+    }
     .display.math{display: block; text-align: center; margin: 0.5rem auto;}
   </style>
   <link rel="stylesheet" href="_htmresc/mini-st_2020.css" />
-  <!--[if lt IE 9]>
-    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
-  <![endif]-->
   <link rel="icon" type="image/x-icon" href="_htmresc/favicon.png" />
 </head>
 <body>
 <div class="row">
 <div class="col-sm-12 col-lg-4">
 <center>
-<h1 id="release-notes-for-lsm6ds3tr-c-component-driver">Release Notes for LSM6DS3TR-C Component Driver</h1>
+<h1 id="release-notes-for-lsm6ds3tr-c-component-driver">Release Notes
+for LSM6DS3TR-C Component Driver</h1>
 <p>Copyright © 2021 STMicroelectronics<br />
 </p>
-<a href="https://www.st.com" class="logo"><img src="_htmresc/st_logo_2020.png" alt="ST logo" /></a>
+<a href="https://www.st.com" class="logo"><img
+src="_htmresc/st_logo_2020.png" alt="ST logo" /></a>
 </center>
 <h1 id="license">License</h1>
-<p>This software component is licensed by ST under BSD 3-Clause license, the “License”. You may not use this component except in compliance with the License. You may obtain a copy of the License at:</p>
-<p><a href="https://opensource.org/licenses/BSD-3-Clause">BSD 3-Clause license</a></p>
+<p>This software component is licensed by ST under BSD 3-Clause license,
+the “License”. You may not use this component except in compliance with
+the License. You may obtain a copy of the License at:</p>
+<p><a href="https://opensource.org/licenses/BSD-3-Clause">BSD 3-Clause
+license</a></p>
 <h1 id="purpose">Purpose</h1>
 <p>This directory contains the LSM6DS3TR-C component drivers.</p>
 </div>
 <section id="update-history" class="col-sm-12 col-lg-8">
 <h1>Update history</h1>
 <div class="collapse">
-<input type="checkbox" id="collapse-section1" aria-hidden="true"> <label for="collapse-section1" aria-hidden="true">V1.0.0 / 18-June-2021</label>
+<input type="checkbox" id="collapse-section1" aria-hidden="true">
+<label for="collapse-section1" aria-hidden="true">V1.0.0 /
+18-June-2021</label>
 <div>
 <h2 id="main-changes">Main changes</h2>
 <h3 id="first-release">First release</h3>
@@ -47,7 +59,9 @@
 </ul>
 <h2 id="section"></h2>
 </div>
-<input type="checkbox" id="collapse-section2" aria-hidden="true"> <label for="collapse-section2" aria-hidden="true">V1.1.0 / 01-June-2023</label>
+<input type="checkbox" id="collapse-section2" aria-hidden="true">
+<label for="collapse-section2" aria-hidden="true">V1.1.0 /
+01-June-2023</label>
 <div>
 <h2 id="main-changes-1">Main changes</h2>
 <ul>
@@ -57,7 +71,9 @@
 </ul>
 <h2 id="section-1"></h2>
 </div>
-<input type="checkbox" id="collapse-section3" checked aria-hidden="true"> <label for="collapse-section3" aria-hidden="true">V2.0.0 / 20-Mar-2024</label>
+<input type="checkbox" id="collapse-section3" aria-hidden="true">
+<label for="collapse-section3" aria-hidden="true">V2.0.0 /
+20-Mar-2024</label>
 <div>
 <h2 id="main-changes-2">Main changes</h2>
 <ul>
@@ -66,13 +82,25 @@
 </ul>
 <h2 id="section-2"></h2>
 </div>
+<input type="checkbox" id="collapse-section4" checked aria-hidden="true">
+<label for="collapse-section4" aria-hidden="true">V2.0.1 /
+20-Jun-2024</label>
+<div>
+<h2 id="main-changes-3">Main changes</h2>
+<ul>
+<li>updated README.md file with tag reference and mdelay
+description</li>
+</ul>
+<h2 id="section-3"></h2>
+</div>
 </div>
 </section>
 </div>
 <footer class="sticky">
 <div class="columns">
 <div class="column" style="width:95%;">
-<p>For complete documentation on LSM6DS3TR-C, visit: <a href="https://www.st.com/content/st_com/en/products/mems-and-sensors/inemo-inertial-modules/lsm6ds3tr-c.html">LSM6DS3TR-C</a></p>
+<p>For complete documentation on LSM6DS3TR-C, visit: <a
+href="https://www.st.com/content/st_com/en/products/mems-and-sensors/inemo-inertial-modules/lsm6ds3tr-c.html">LSM6DS3TR-C</a></p>
 </div><div class="column" style="width:5%;">
 <p><abbr title="Based on template cx566953 version 2.0">Info</abbr></p>
 </div>

airmouse/lib/lsm6ds3tr-api/Release_Notes.md

@@ -58,7 +58,7 @@ This directory contains the LSM6DS3TR-C component drivers.
 
 </div>
 
-<input type="checkbox" id="collapse-section3" checked aria-hidden="true">
+<input type="checkbox" id="collapse-section3" aria-hidden="true">
 <label for="collapse-section3" aria-hidden="true">V2.0.0 / 20-Mar-2024</label>
 <div>
 
@@ -69,6 +69,18 @@ This directory contains the LSM6DS3TR-C component drivers.
 
 ##
 
+</div>
+
+<input type="checkbox" id="collapse-section4" checked aria-hidden="true">
+<label for="collapse-section4" aria-hidden="true">V2.0.1 / 20-Jun-2024</label>
+<div>
+
+## Main changes
+
+- updated README.md file with tag reference and mdelay description
+
+##
+
 </div>
 :::