Update docs and version to 0.3.0

BjarneBitscrambler · Jan 2, 2021 · aed6c86 · aed6c86
1 parent 52c580b
commit aed6c86
Show file tree

Hide file tree

Showing 134 changed files with 2,329 additions and 2,097 deletions.
diff --git a/docs/html/build_8h.html b/docs/html/build_8h.html
@@ -137,8 +137,12 @@
 <tr class="memdesc:a200c1becfc3641688164c1b17c26a4f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">the coordinate system to be used <br /></td></tr>
 <tr class="separator:a200c1becfc3641688164c1b17c26a4f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr><td colspan="2"><div class="groupHeader">SensorBitFields</div></td></tr>
-<tr><td colspan="2"><div class="groupText"><p>These bit-field values are used to declare which sensor types are used in the application. Change bit-field values to 0x0000 for any features NOT USED. </p>
+<tr><td colspan="2"><div class="groupText"><p>These bit-field values are used to declare which sensor types are used in the application. Change bit-field values to 0x0000 for any features NOT USED. These bitmasks are also used to set the pSensor-&gt;isInitialized flag once a particular sensor is communicating successfully. F_USING_NONE indicates a problem with that sensor. </p>
 </div></td></tr>
+<tr class="memitem:ae11eb9325463d11da08cf75d5091d2d0"><td class="memItemLeft" align="right" valign="top"><a id="ae11eb9325463d11da08cf75d5091d2d0"></a>
+#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#ae11eb9325463d11da08cf75d5091d2d0">F_USING_NONE</a>&#160;&#160;&#160;0x0000</td></tr>
+<tr class="memdesc:ae11eb9325463d11da08cf75d5091d2d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">0x0000 indicates a sensor is unavailable / unconfigured. <br /></td></tr>
+<tr class="separator:ae11eb9325463d11da08cf75d5091d2d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a8f284d04ec459633d30dc85cf0a32a0d"><td class="memItemLeft" align="right" valign="top"><a id="a8f284d04ec459633d30dc85cf0a32a0d"></a>
 #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="build_8h.html#a8f284d04ec459633d30dc85cf0a32a0d">F_USING_ACCEL</a>&#160;&#160;&#160;0x0001</td></tr>
 <tr class="memdesc:a8f284d04ec459633d30dc85cf0a32a0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">nominally 0x0001 if an accelerometer is to be used, 0x0000 otherwise <br /></td></tr>

diff --git a/docs/html/build_8h_source.html b/docs/html/build_8h_source.html
diff --git a/docs/html/calibration__storage_8h_source.html b/docs/html/calibration__storage_8h_source.html
@@ -101,7 +101,7 @@
 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; </div>
 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#endif //CALIBRATION_STORAGE_H</span></div>
 </div><!-- fragment --></div><!-- contents -->
-<div class="ttc" id="astructSensorFusionGlobals_html"><div class="ttname"><a href="structSensorFusionGlobals.html">SensorFusionGlobals</a></div><div class="ttdoc">The top level fusion structure.</div><div class="ttdef"><b>Definition:</b> sensor_fusion.h:456</div></div>
+<div class="ttc" id="astructSensorFusionGlobals_html"><div class="ttname"><a href="structSensorFusionGlobals.html">SensorFusionGlobals</a></div><div class="ttdoc">The top level fusion structure.</div><div class="ttdef"><b>Definition:</b> sensor_fusion.h:458</div></div>
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by &#160;<a href="http://www.doxygen.org/index.html">

diff --git a/docs/html/classSensorFusion-members.html b/docs/html/classSensorFusion-members.html
@@ -97,23 +97,24 @@
   <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#acd59be40f801b6ce607101103c4e9bad">InitializeSensorFusionGlobals</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
   <tr><td class="entry"><a class="el" href="classSensorFusion.html#a90a3b268bdc22c23a07917de1866148c">InitializeStatusSubsystem</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a29962faed281bc60b78c3b4b4588cda3">InstallSensor</a>(uint8_t sensor_i2c_addr, SensorType sensor_type)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a1def9458ee27d8d6bff3381796c56550">kLoopsPerAccelRead</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#ab62b17efb7e67cdbaf78f5ba62b97d7d">kLoopsPerFusionCalc</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a83380e9ad84408827b9f24bb38e1fe6a">kLoopsPerGyroRead</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a4ced6fbf3966d9a5350d6d02fe68c71e">kLoopsPerMagRead</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a3799c22bb629cb1015947a89a633b73b">kLoopsPerThermRead</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a2e639e936fa40817d4d4ac1a6d7ce707">loops_per_fuse_counter_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a1b99adadae840e21ae2f7252a4750aff">num_sensors_installed_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#adb9854e0dc23586327c7cbf9377a7d72">ProcessCommands</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a639c646f972bb29bccd60ef1926735dc">ProduceToolboxOutput</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a7d7573317add4ffb98231ea3f478cb75">ReadSensors</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#aa1b6f69aee1de8b1514539765ef4b119">RunFusion</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a8bdd5942ef9cc5d3392fec0cbd3e51c9">SendArbitraryData</a>(const char *buffer, uint16_t data_length)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#ad193998535aeea57d9e2bd468e37ee12">SensorFusion</a>()</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a68577d10c18876769a39c9ae3a2366b6">sensors_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a4bfe578196cc3296f0428f1d633c70a5">sfg_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#afac11693f2631da7af888911dcf1a72b">status_subsystem_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a493cf7acac92d0e50be057e3f6492dd3">UpdateWiFiStream</a>(void *tcp_client)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a6d9724a1a32226b71add454076d26265">IsDataValid</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a1def9458ee27d8d6bff3381796c56550">kLoopsPerAccelRead</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#ab62b17efb7e67cdbaf78f5ba62b97d7d">kLoopsPerFusionCalc</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a83380e9ad84408827b9f24bb38e1fe6a">kLoopsPerGyroRead</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a4ced6fbf3966d9a5350d6d02fe68c71e">kLoopsPerMagRead</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a3799c22bb629cb1015947a89a633b73b">kLoopsPerThermRead</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a2e639e936fa40817d4d4ac1a6d7ce707">loops_per_fuse_counter_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a1b99adadae840e21ae2f7252a4750aff">num_sensors_installed_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#adb9854e0dc23586327c7cbf9377a7d72">ProcessCommands</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a639c646f972bb29bccd60ef1926735dc">ProduceToolboxOutput</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a7d7573317add4ffb98231ea3f478cb75">ReadSensors</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#aa1b6f69aee1de8b1514539765ef4b119">RunFusion</a>(void)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a8bdd5942ef9cc5d3392fec0cbd3e51c9">SendArbitraryData</a>(const char *buffer, uint16_t data_length)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#ad193998535aeea57d9e2bd468e37ee12">SensorFusion</a>()</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#a68577d10c18876769a39c9ae3a2366b6">sensors_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a4bfe578196cc3296f0428f1d633c70a5">sfg_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classSensorFusion.html#afac11693f2631da7af888911dcf1a72b">status_subsystem_</a></td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classSensorFusion.html#a493cf7acac92d0e50be057e3f6492dd3">UpdateWiFiStream</a>(void *tcp_client)</td><td class="entry"><a class="el" href="classSensorFusion.html">SensorFusion</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

diff --git a/docs/html/classSensorFusion.html b/docs/html/classSensorFusion.html
@@ -123,6 +123,8 @@
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSensorFusion.html#adb9854e0dc23586327c7cbf9377a7d72">ProcessCommands</a> (void)</td></tr>
 <tr class="memdesc:adb9854e0dc23586327c7cbf9377a7d72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process any incoming commands. Commands may arrive by serial or WiFi connection, depending on which of these is enabled (if any). It is not mandatory to call this routine, if command responses are not needed. <br /></td></tr>
 <tr class="separator:adb9854e0dc23586327c7cbf9377a7d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6d9724a1a32226b71add454076d26265"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSensorFusion.html#a6d9724a1a32226b71add454076d26265">IsDataValid</a> (void)</td></tr>
+<tr class="separator:a6d9724a1a32226b71add454076d26265"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aeacc830ce9871cb60ee4086068d5cec7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSensorFusion.html#aeacc830ce9871cb60ee4086068d5cec7">GetHeadingDegrees</a> (void)</td></tr>
 <tr class="separator:aeacc830ce9871cb60ee4086068d5cec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3b97277eb26e5cb28c4c8a12af1ed8b6"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSensorFusion.html#a3b97277eb26e5cb28c4c8a12af1ed8b6">GetPitchDegrees</a> (void)</td></tr>
@@ -747,6 +749,25 @@ <h2 class="memtitle"><span class="permalink"><a href="#a29962faed281bc60b78c3b4b
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>True if sensor installed successfully, else False </dd></dl>
 
+</div>
+</div>
+<a id="a6d9724a1a32226b71add454076d26265"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a6d9724a1a32226b71add454076d26265">&#9670;&nbsp;</a></span>IsDataValid()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool SensorFusion::IsDataValid </td>
+          <td>(</td>
+          <td class="paramtype">void&#160;</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<dl class="section return"><dt>Returns</dt><dd>Boolean indicating whether orientation data are valid </dd></dl>
+
 </div>
 </div>
 <a id="aa1b6f69aee1de8b1514539765ef4b119"></a>

diff --git a/docs/html/control_8h_source.html b/docs/html/control_8h_source.html
@@ -133,7 +133,7 @@
 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _CONTROL_H_ */</span><span class="preprocessor"></span></div>
 </div><!-- fragment --></div><!-- contents -->
 <div class="ttc" id="acontrol_8h_html_a58ba7506d8affb446196806c39823c3a"><div class="ttname"><a href="control_8h.html#a58ba7506d8affb446196806c39823c3a">ControlSubsystem</a></div><div class="ttdeci">struct ControlSubsystem ControlSubsystem</div><div class="ttdoc">The ControlSubsystem encapsulates command and data streaming functions.</div></div>
-<div class="ttc" id="astructSensorFusionGlobals_html"><div class="ttname"><a href="structSensorFusionGlobals.html">SensorFusionGlobals</a></div><div class="ttdoc">The top level fusion structure.</div><div class="ttdef"><b>Definition:</b> sensor_fusion.h:456</div></div>
+<div class="ttc" id="astructSensorFusionGlobals_html"><div class="ttname"><a href="structSensorFusionGlobals.html">SensorFusionGlobals</a></div><div class="ttdoc">The top level fusion structure.</div><div class="ttdef"><b>Definition:</b> sensor_fusion.h:458</div></div>
 <div class="ttc" id="acontrol_8h_html_afc925ab9ed0cd96b9673a9c46d7218fc"><div class="ttname"><a href="control_8h.html#afc925ab9ed0cd96b9673a9c46d7218fc">DecodeCommandBytes</a></div><div class="ttdeci">void DecodeCommandBytes(SensorFusionGlobals *sfg, uint8_t input_buffer[], uint16_t nbytes)</div><div class="ttdef"><b>Definition:</b> control_input.c:70</div></div>
 <div class="ttc" id="asensor__fusion_8h_html_a365b73d4f615f8c348ddd79b1757d372"><div class="ttname"><a href="sensor__fusion_8h.html#a365b73d4f615f8c348ddd79b1757d372">quaternion_type</a></div><div class="ttdeci">enum quaternion quaternion_type</div><div class="ttdoc">the quaternion type to be transmitted</div></div>
 <div class="ttc" id="acontrol_8h_html_a4da1153dfe8ff9b0b610e7d55a92f3ca"><div class="ttname"><a href="control_8h.html#a4da1153dfe8ff9b0b610e7d55a92f3ca">CreateOutgoingPackets</a></div><div class="ttdeci">void CreateOutgoingPackets(SensorFusionGlobals *sfg)</div><div class="ttdef"><b>Definition:</b> control_output.c:118</div></div>

diff --git a/docs/html/driver__sensors_8h_source.html b/docs/html/driver__sensors_8h_source.html
@@ -112,8 +112,8 @@
 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160; </div>
 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="preprocessor">#endif // DRIVER_SENSORS_H</span></div>
 </div><!-- fragment --></div><!-- contents -->
-<div class="ttc" id="astructSensorFusionGlobals_html"><div class="ttname"><a href="structSensorFusionGlobals.html">SensorFusionGlobals</a></div><div class="ttdoc">The top level fusion structure.</div><div class="ttdef"><b>Definition:</b> sensor_fusion.h:456</div></div>
-<div class="ttc" id="astructPhysicalSensor_html"><div class="ttname"><a href="structPhysicalSensor.html">PhysicalSensor</a></div><div class="ttdoc">An instance of PhysicalSensor structure type should be allocated for each physical sensors (combo dev...</div><div class="ttdef"><b>Definition:</b> sensor_fusion.h:150</div></div>
+<div class="ttc" id="astructSensorFusionGlobals_html"><div class="ttname"><a href="structSensorFusionGlobals.html">SensorFusionGlobals</a></div><div class="ttdoc">The top level fusion structure.</div><div class="ttdef"><b>Definition:</b> sensor_fusion.h:458</div></div>
+<div class="ttc" id="astructPhysicalSensor_html"><div class="ttname"><a href="structPhysicalSensor.html">PhysicalSensor</a></div><div class="ttdoc">An instance of PhysicalSensor structure type should be allocated for each physical sensors (combo dev...</div><div class="ttdef"><b>Definition:</b> sensor_fusion.h:152</div></div>
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by &#160;<a href="http://www.doxygen.org/index.html">

diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
@@ -152,6 +152,9 @@ <h3><a id="index_i"></a>- i -</h3><ul>
 <li>InstallSensor()
 : <a class="el" href="classSensorFusion.html#a29962faed281bc60b78c3b4b4588cda3">SensorFusion</a>
 </li>
+<li>IsDataValid()
+: <a class="el" href="classSensorFusion.html#a6d9724a1a32226b71add454076d26265">SensorFusion</a>
+</li>
 </ul>