Add method for passing commands to library interface

Updated version to 0.4.0 Update documentation.
BjarneBitscrambler · Jan 6, 2021 · 535588e · 535588e
1 parent 5ce6301
commit 535588e
Show file tree

Hide file tree

Showing 460 changed files with 1,522 additions and 1,461 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "Sensor Fusion Library"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         =0.2.0
+PROJECT_NUMBER         =0.4.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/docs/html/annotated.html b/docs/html/annotated.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Sensor Fusion Library
-   &#160;<span id="projectnumber">0.2.0</span>
+   &#160;<span id="projectnumber">0.4.0</span>
    </div>
    <div id="projectbrief">Orientation sensing for Espressif (ESP32, ESP8266) processors</div>
   </td>

diff --git a/docs/html/approximations_8c.html b/docs/html/approximations_8c.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Sensor Fusion Library
-   &#160;<span id="projectnumber">0.2.0</span>
+   &#160;<span id="projectnumber">0.4.0</span>
    </div>
    <div id="projectbrief">Orientation sensing for Espressif (ESP32, ESP8266) processors</div>
   </td>

diff --git a/docs/html/approximations_8h.html b/docs/html/approximations_8h.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Sensor Fusion Library
-   &#160;<span id="projectnumber">0.2.0</span>
+   &#160;<span id="projectnumber">0.4.0</span>
    </div>
    <div id="projectbrief">Orientation sensing for Espressif (ESP32, ESP8266) processors</div>
   </td>

diff --git a/docs/html/approximations_8h_source.html b/docs/html/approximations_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Sensor Fusion Library
-   &#160;<span id="projectnumber">0.2.0</span>
+   &#160;<span id="projectnumber">0.4.0</span>
    </div>
    <div id="projectbrief">Orientation sensing for Espressif (ESP32, ESP8266) processors</div>
   </td>

diff --git a/docs/html/board_8h.html b/docs/html/board_8h.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Sensor Fusion Library
-   &#160;<span id="projectnumber">0.2.0</span>
+   &#160;<span id="projectnumber">0.4.0</span>
    </div>
    <div id="projectbrief">Orientation sensing for Espressif (ESP32, ESP8266) processors</div>
   </td>

diff --git a/docs/html/board_8h_source.html b/docs/html/board_8h_source.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Sensor Fusion Library
-   &#160;<span id="projectnumber">0.2.0</span>
+   &#160;<span id="projectnumber">0.4.0</span>
    </div>
    <div id="projectbrief">Orientation sensing for Espressif (ESP32, ESP8266) processors</div>
   </td>

diff --git a/docs/html/build_8h.html b/docs/html/build_8h.html
@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Sensor Fusion Library
-   &#160;<span id="projectnumber">0.2.0</span>
+   &#160;<span id="projectnumber">0.4.0</span>
    </div>
    <div id="projectbrief">Orientation sensing for Espressif (ESP32, ESP8266) processors</div>
   </td>
@@ -81,28 +81,28 @@
 <div class="dyncontent">
 <div class="center"><img src="build_8h__dep__incl.png" border="0" usemap="#src_2build_8hdep" alt=""/></div>
 <map name="src_2build_8hdep" id="src_2build_8hdep">
-<area shape="rect" title="Build configuration file." alt="" coords="1161,5,1250,32"/>
-<area shape="rect" href="sensor__fusion__class_8h.html" title=" " alt="" coords="5,177,192,203"/>
-<area shape="rect" href="sensor__fusion_8h.html" title="The sensor_fusion.h file implements the top level programming interface." alt="" coords="1361,80,1543,121"/>
-<area shape="rect" href="control_8cc.html" title="Defines control sub&#45;system." alt="" coords="216,177,419,203"/>
-<area shape="rect" href="control__output_8c.html" title="Implements output streaming for the control &amp; status subsystem. Data is packaged up in format compati..." alt="" coords="443,169,627,211"/>
-<area shape="rect" href="fusion__testing_8c.html" title="ApplyPerturbation function used to analyze dynamic performance." alt="" coords="3025,169,3204,211"/>
-<area shape="rect" href="debug__print_8cc.html" title="defines function debug_print() that outputs to serial port Can disable these prints by compiling with..." alt="" coords="1619,80,1797,121"/>
-<area shape="rect" href="main_8cc.html" title="Example main program, demonstrating how to use SensorFusion class This file creates a SensorFusion ob..." alt="" coords="51,266,147,293"/>
-<area shape="rect" href="sensor__fusion__class_8cc.html" title="An easy&#45;to&#45;use interface to the NXP Sensor Fusion version 7 library algorithms." alt="" coords="625,266,818,293"/>
-<area shape="rect" href="calibration__storage_8cc.html" title="Provides functions to store calibration to NVM." alt="" coords="1140,169,1348,211"/>
-<area shape="rect" href="control__input_8c.html" title="Command interpreter which interfaces to the Sensor Fusion Toolbox. Commands sent from the Toolbox (e...." alt="" coords="1464,259,1648,300"/>
-<area shape="rect" href="fusion_8h.html" title="Lower level sensor fusion interface." alt="" coords="1423,177,1614,203"/>
-<area shape="rect" href="fusion_8c.html" title="Lower level sensor fusion interface." alt="" coords="1673,266,1863,293"/>
-<area shape="rect" href="sensor__fusion_8c.html" title="The sensor_fusion.c file implements the top level programming interface." alt="" coords="1257,259,1439,300"/>
-<area shape="rect" href="driver__fxas21002_8c.html" title="Provides init() and read() functions for the FXAS21002 gyroscope." alt="" coords="1741,169,1918,211"/>
-<area shape="rect" href="driver__fxos8700_8c.html" title="Defines commands to perform various tasks (e.g. read Device ID, Initialize, Read Data) for the FXOS87..." alt="" coords="1942,169,2119,211"/>
-<area shape="rect" href="hal__axis__remap_8c.html" title="Hardware Abstraction layer for the particular sensors used. Depending on the design of the sensor PCB..." alt="" coords="2143,169,2302,211"/>
-<area shape="rect" href="magnetic_8c.html" title="Lower level magnetic calibration interface." alt="" coords="2327,177,2537,203"/>
-<area shape="rect" href="matrix_8c.html" title="Matrix manipulation functions." alt="" coords="2562,177,2755,203"/>
-<area shape="rect" href="orientation_8c.html" title="Functions to convert between various orientation representations." alt="" coords="2780,177,3001,203"/>
-<area shape="rect" href="precisionAccelerometer_8c.html" title="Implements accelerometer calibration routines." alt="" coords="651,169,850,211"/>
-<area shape="rect" href="status_8c.html" title="Application&#45;specific status subsystem." alt="" coords="874,177,1065,203"/>
+<area shape="rect" title="Build configuration file." alt="" coords="510,5,599,32"/>
+<area shape="rect" href="sensor__fusion__class_8h.html" title=" " alt="" coords="25,177,212,203"/>
+<area shape="rect" href="main_8cc.html" title="Example main program, demonstrating how to use SensorFusion class This file creates a SensorFusion ob..." alt="" coords="5,266,101,293"/>
+<area shape="rect" href="sensor__fusion_8h.html" title="The sensor_fusion.h file implements the top level programming interface." alt="" coords="1566,80,1749,121"/>
+<area shape="rect" href="control_8cc.html" title="Defines control sub&#45;system." alt="" coords="236,177,439,203"/>
+<area shape="rect" href="control__output_8c.html" title="Implements output streaming for the control &amp; status subsystem. Data is packaged up in format compati..." alt="" coords="463,169,647,211"/>
+<area shape="rect" href="fusion__testing_8c.html" title="ApplyPerturbation function used to analyze dynamic performance." alt="" coords="3045,169,3224,211"/>
+<area shape="rect" href="debug__print_8cc.html" title="defines function debug_print() that outputs to serial port Can disable these prints by compiling with..." alt="" coords="1824,80,2003,121"/>
+<area shape="rect" href="sensor__fusion__class_8cc.html" title="An easy&#45;to&#45;use interface to the NXP Sensor Fusion version 7 library algorithms." alt="" coords="831,266,1025,293"/>
+<area shape="rect" href="calibration__storage_8cc.html" title="Provides functions to store calibration to NVM." alt="" coords="1624,169,1832,211"/>
+<area shape="rect" href="control__input_8c.html" title="Command interpreter which interfaces to the Sensor Fusion Toolbox. Commands sent from the Toolbox (e...." alt="" coords="1921,259,2105,300"/>
+<area shape="rect" href="fusion_8h.html" title="Lower level sensor fusion interface." alt="" coords="1958,177,2149,203"/>
+<area shape="rect" href="fusion_8c.html" title="Lower level sensor fusion interface." alt="" coords="2130,266,2321,293"/>
+<area shape="rect" href="sensor__fusion_8c.html" title="The sensor_fusion.c file implements the top level programming interface." alt="" coords="1714,259,1897,300"/>
+<area shape="rect" href="driver__fxas21002_8c.html" title="Provides init() and read() functions for the FXAS21002 gyroscope." alt="" coords="2225,169,2402,211"/>
+<area shape="rect" href="driver__fxos8700_8c.html" title="Defines commands to perform various tasks (e.g. read Device ID, Initialize, Read Data) for the FXOS87..." alt="" coords="2426,169,2603,211"/>
+<area shape="rect" href="hal__axis__remap_8c.html" title="Hardware Abstraction layer for the particular sensors used. Depending on the design of the sensor PCB..." alt="" coords="2627,169,2786,211"/>
+<area shape="rect" href="magnetic_8c.html" title="Lower level magnetic calibration interface." alt="" coords="2811,177,3021,203"/>
+<area shape="rect" href="matrix_8c.html" title="Matrix manipulation functions." alt="" coords="671,177,865,203"/>
+<area shape="rect" href="orientation_8c.html" title="Functions to convert between various orientation representations." alt="" coords="889,177,1111,203"/>
+<area shape="rect" href="precisionAccelerometer_8c.html" title="Implements accelerometer calibration routines." alt="" coords="1135,169,1334,211"/>
+<area shape="rect" href="status_8c.html" title="Application&#45;specific status subsystem." alt="" coords="1358,177,1549,203"/>
 </map>
 </div>
 </div>
@@ -115,7 +115,7 @@
 <tr class="memdesc:a37b68379c938c8404e8e8b0572e7a530"><td class="mdescLeft">&#160;</td><td class="mdescRight">define build number sent in debug packet for display purposes only <br /></td></tr>
 <tr class="separator:a37b68379c938c8404e8e8b0572e7a530"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4ea9dc8657ac2397e559593d3ad22dc8"><td class="memItemLeft" align="right" valign="top"><a id="a4ea9dc8657ac2397e559593d3ad22dc8"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><b>ENABLE_DEBUG_LOG</b>&#160;&#160;&#160;1</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>ENABLE_DEBUG_LOG</b>&#160;&#160;&#160;0</td></tr>
 <tr class="separator:a4ea9dc8657ac2397e559593d3ad22dc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr><td colspan="2"><div class="groupHeader">CoordinateSystemBitFields</div></td></tr>
 <tr><td colspan="2"><div class="groupText"><p>These defines determine the frame of reference (x, y, z axes and Euler angles) standard to be used for a particular build. Change THISCOORDSYSTEM to whichever of NED, ANDROID or WIN8 you prefer. </p>
@@ -175,23 +175,23 @@
 <tr class="memdesc:a69b745acfd24d1873d47c67aca06df26"><td class="mdescLeft">&#160;</td><td class="mdescRight">1DOF pressure (altitude) and temperature algorithm selector - 0x0100 to include, 0x0000 otherwise <br /></td></tr>
 <tr class="separator:a69b745acfd24d1873d47c67aca06df26"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:adb79fa7eb529c4cae2619ef22af3211e"><td class="memItemLeft" align="right" valign="top"><a id="adb79fa7eb529c4cae2619ef22af3211e"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#adb79fa7eb529c4cae2619ef22af3211e">F_3DOF_G_BASIC</a>&#160;&#160;&#160;0x0200</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#adb79fa7eb529c4cae2619ef22af3211e">F_3DOF_G_BASIC</a>&#160;&#160;&#160;0x0000</td></tr>
 <tr class="memdesc:adb79fa7eb529c4cae2619ef22af3211e"><td class="mdescLeft">&#160;</td><td class="mdescRight">3DOF accel tilt (accel) algorithm selector - 0x0200 to include, 0x0000 otherwise <br /></td></tr>
 <tr class="separator:adb79fa7eb529c4cae2619ef22af3211e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aed8da52c8d0d14325445b139876492b4"><td class="memItemLeft" align="right" valign="top"><a id="aed8da52c8d0d14325445b139876492b4"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#aed8da52c8d0d14325445b139876492b4">F_3DOF_B_BASIC</a>&#160;&#160;&#160;0x0400</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#aed8da52c8d0d14325445b139876492b4">F_3DOF_B_BASIC</a>&#160;&#160;&#160;0x0000</td></tr>
 <tr class="memdesc:aed8da52c8d0d14325445b139876492b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">3DOF mag eCompass (vehicle/mag) algorithm selector - 0x0400 to include, 0x0000 otherwise <br /></td></tr>
 <tr class="separator:aed8da52c8d0d14325445b139876492b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a990887d9ed9f03bcaffcd4abae429265"><td class="memItemLeft" align="right" valign="top"><a id="a990887d9ed9f03bcaffcd4abae429265"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a990887d9ed9f03bcaffcd4abae429265">F_3DOF_Y_BASIC</a>&#160;&#160;&#160;0x0800</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a990887d9ed9f03bcaffcd4abae429265">F_3DOF_Y_BASIC</a>&#160;&#160;&#160;0x0000</td></tr>
 <tr class="memdesc:a990887d9ed9f03bcaffcd4abae429265"><td class="mdescLeft">&#160;</td><td class="mdescRight">3DOF gyro integration algorithm selector - 0x0800 to include, 0x0000 otherwise <br /></td></tr>
 <tr class="separator:a990887d9ed9f03bcaffcd4abae429265"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a9b0aadad0b960783ff2ecd5174a57905"><td class="memItemLeft" align="right" valign="top"><a id="a9b0aadad0b960783ff2ecd5174a57905"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a9b0aadad0b960783ff2ecd5174a57905">F_6DOF_GB_BASIC</a>&#160;&#160;&#160;0x1000</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a9b0aadad0b960783ff2ecd5174a57905">F_6DOF_GB_BASIC</a>&#160;&#160;&#160;0x0000</td></tr>
 <tr class="memdesc:a9b0aadad0b960783ff2ecd5174a57905"><td class="mdescLeft">&#160;</td><td class="mdescRight">6DOF accel and mag eCompass algorithm selector - 0x1000 to include, 0x0000 otherwise <br /></td></tr>
 <tr class="separator:a9b0aadad0b960783ff2ecd5174a57905"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3aa2972ee6d1865b5bd7ab4e1914a4c5"><td class="memItemLeft" align="right" valign="top"><a id="a3aa2972ee6d1865b5bd7ab4e1914a4c5"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a3aa2972ee6d1865b5bd7ab4e1914a4c5">F_6DOF_GY_KALMAN</a>&#160;&#160;&#160;0x2000</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a3aa2972ee6d1865b5bd7ab4e1914a4c5">F_6DOF_GY_KALMAN</a>&#160;&#160;&#160;0x0000</td></tr>
 <tr class="memdesc:a3aa2972ee6d1865b5bd7ab4e1914a4c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">6DOF accel and gyro (Kalman) algorithm selector - 0x2000 to include, 0x0000 otherwise <br /></td></tr>
 <tr class="separator:a3aa2972ee6d1865b5bd7ab4e1914a4c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a067a973335873757f5ecfda300e9c082"><td class="memItemLeft" align="right" valign="top"><a id="a067a973335873757f5ecfda300e9c082"></a>
@@ -225,11 +225,11 @@
 #define&#160;</td><td class="memItemRight" valign="bottom"><b>RATERESOLUTION</b>&#160;&#160;&#160;1000</td></tr>
 <tr class="separator:a9badfcf686c8cfb2afabc3c9e3ba11d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5edcc1013705da68fcd261f70fd76680"><td class="memItemLeft" align="right" valign="top"><a id="a5edcc1013705da68fcd261f70fd76680"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a5edcc1013705da68fcd261f70fd76680">F_USE_WIRELESS_UART</a>&#160;&#160;&#160;0x0001</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a5edcc1013705da68fcd261f70fd76680">F_USE_WIRELESS_UART</a>&#160;&#160;&#160;0x0000</td></tr>
 <tr class="memdesc:a5edcc1013705da68fcd261f70fd76680"><td class="mdescLeft">&#160;</td><td class="mdescRight">0x0001 to include, 0x0000 otherwise <br /></td></tr>
 <tr class="separator:a5edcc1013705da68fcd261f70fd76680"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a91b255d8f29c5ee627e8471373377bd0"><td class="memItemLeft" align="right" valign="top"><a id="a91b255d8f29c5ee627e8471373377bd0"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a91b255d8f29c5ee627e8471373377bd0">F_USE_WIRED_UART</a>&#160;&#160;&#160;0x0002</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a91b255d8f29c5ee627e8471373377bd0">F_USE_WIRED_UART</a>&#160;&#160;&#160;0x0000</td></tr>
 <tr class="memdesc:a91b255d8f29c5ee627e8471373377bd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">0x0002 to include, 0x0000 otherwise <br /></td></tr>
 <tr class="separator:a91b255d8f29c5ee627e8471373377bd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>