Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Patrick-McGuire
Patrick-McGuire committed Nov 15, 2024
1 parent 70ab8b0 commit f67b772
Show file tree
Hide file tree
Showing 36 changed files with 106 additions and 80 deletions.
4 changes: 2 additions & 2 deletions docs/html/ICM20948Sensor_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;ICM_20948.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">/**</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="classICM20948.html"> 12</a></span><span class="comment"> * @class ICM20948</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * @class ICM20948Sensor</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * @brief Driver for ICM20948</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * @details Uses the sparkfun Arduino ICM20948 library, and abstracts it to our sensor formats</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> */</span></div>
Expand Down Expand Up @@ -158,7 +158,7 @@
<div class="ttc" id="aclassAccelerometer_html"><div class="ttname"><a href="classAccelerometer.html">Accelerometer</a></div><div class="ttdoc">Generic Accelerometer.</div><div class="ttdef"><b>Definition:</b> Accelerometer.h:12</div></div>
<div class="ttc" id="aclassGenericSensor_html"><div class="ttname"><a href="classGenericSensor.html">GenericSensor</a></div><div class="ttdoc">Underlying interface to all sensors.</div><div class="ttdef"><b>Definition:</b> GenericSensor.h:12</div></div>
<div class="ttc" id="aclassGyroscope_html"><div class="ttname"><a href="classGyroscope.html">Gyroscope</a></div><div class="ttdoc">Generic Gyroscope.</div><div class="ttdef"><b>Definition:</b> Gyroscope.h:12</div></div>
<div class="ttc" id="aclassICM20948Sensor_html"><div class="ttname"><a href="classICM20948Sensor.html">ICM20948Sensor</a></div><div class="ttdef"><b>Definition:</b> ICM20948Sensor.h:16</div></div>
<div class="ttc" id="aclassICM20948Sensor_html"><div class="ttname"><a href="classICM20948Sensor.html">ICM20948Sensor</a></div><div class="ttdoc">Driver for ICM20948.</div><div class="ttdef"><b>Definition:</b> ICM20948Sensor.h:16</div></div>
<div class="ttc" id="aclassICM20948Sensor_html_a0067a30feb6c7b3b637e39d52a648a2a"><div class="ttname"><a href="classICM20948Sensor.html#a0067a30feb6c7b3b637e39d52a648a2a">ICM20948Sensor::getGyroscope</a></div><div class="ttdeci">Gyroscope * getGyroscope()</div><div class="ttdoc">Gets the Gyroscope injector class.</div><div class="ttdef"><b>Definition:</b> ICM20948Sensor.cpp:86</div></div>
<div class="ttc" id="aclassICM20948Sensor_html_a21adda2cc94e08704e4c92bb4372c76e"><div class="ttname"><a href="classICM20948Sensor.html#a21adda2cc94e08704e4c92bb4372c76e">ICM20948Sensor::setup</a></div><div class="ttdeci">void setup() final</div><div class="ttdoc">Initializes the sensor.</div><div class="ttdef"><b>Definition:</b> ICM20948Sensor.cpp:9</div></div>
<div class="ttc" id="aclassICM20948Sensor_html_a7b362848bae3009c5aa5d2eae1e3fc57"><div class="ttname"><a href="classICM20948Sensor.html#a7b362848bae3009c5aa5d2eae1e3fc57">ICM20948Sensor::setSpiClass</a></div><div class="ttdeci">void setSpiClass(SPIClass *spiClass)</div><div class="ttdoc">Sets the SPI object to use.</div><div class="ttdef"><b>Definition:</b> ICM20948Sensor.cpp:5</div></div>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/MS8607Sensor_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;SparkFun_PHT_MS8607_Arduino_Library.h&gt;</span> <span class="comment">// library for MS8607</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"></span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">/**</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classMS8607driver.html"> 10</a></span><span class="comment"> * @class MS8607driver</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * @class MS8607Sensor</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * @brief An implementation of Barometer for the MS8607 barometer.</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * @details Uses the SparkFun PHT MS8607 Arduino library and implements an abstraction layer for our format.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * The datasheet can be found here: https://cdn.sparkfun.com/assets/b/a/f/b/f/MS8607_Datasheet.pdf</span></div>
Expand All @@ -112,7 +112,7 @@
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#endif </span><span class="comment">//PLATFORMIO_NULI_AVIONICS_FLIGHT_SOFTWARE_MS8607SENSOR_H</span></div>
<div class="ttc" id="aclassBarometer_html"><div class="ttname"><a href="classBarometer.html">Barometer</a></div><div class="ttdoc">Generic Barometer.</div><div class="ttdef"><b>Definition:</b> Barometer.h:12</div></div>
<div class="ttc" id="aclassMS8607Sensor_html"><div class="ttname"><a href="classMS8607Sensor.html">MS8607Sensor</a></div><div class="ttdef"><b>Definition:</b> MS8607Sensor.h:16</div></div>
<div class="ttc" id="aclassMS8607Sensor_html"><div class="ttname"><a href="classMS8607Sensor.html">MS8607Sensor</a></div><div class="ttdoc">An implementation of Barometer for the MS8607 barometer.</div><div class="ttdef"><b>Definition:</b> MS8607Sensor.h:16</div></div>
<div class="ttc" id="aclassMS8607Sensor_html_a762aec1b89a7b4388226bd2d6da73aac"><div class="ttname"><a href="classMS8607Sensor.html#a762aec1b89a7b4388226bd2d6da73aac">MS8607Sensor::read</a></div><div class="ttdeci">void read() override</div><div class="ttdoc">Read data from the sensor.</div><div class="ttdef"><b>Definition:</b> MS8607Sensor.cpp:21</div></div>
<div class="ttc" id="aclassMS8607Sensor_html_ab5de03749781ad4518116e36402c6f14"><div class="ttname"><a href="classMS8607Sensor.html#ab5de03749781ad4518116e36402c6f14">MS8607Sensor::setup</a></div><div class="ttdeci">void setup() override</div><div class="ttdoc">Initialize the sensor.</div><div class="ttdef"><b>Definition:</b> MS8607Sensor.cpp:7</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
18 changes: 8 additions & 10 deletions docs/html/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,16 +89,14 @@
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classGPS.html" target="_self">GPS</a></td><td class="desc"></td></tr>
<tr id="row_13_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classGyroscope.html" target="_self">Gyroscope</a></td><td class="desc">Generic <a class="el" href="classGyroscope.html" title="Generic Gyroscope.">Gyroscope</a> </td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classHardwareAbstraction.html" target="_self">HardwareAbstraction</a></td><td class="desc">Provide an abstraction to access all hardware </td></tr>
<tr id="row_15_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classICM20948.html" target="_self">ICM20948</a></td><td class="desc">Driver for <a class="el" href="classICM20948.html" title="Driver for ICM20948.">ICM20948</a> </td></tr>
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classICM20948Sensor.html" target="_self">ICM20948Sensor</a></td><td class="desc"></td></tr>
<tr id="row_17_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classLogger.html" target="_self">Logger</a></td><td class="desc"></td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMagnetometer.html" target="_self">Magnetometer</a></td><td class="desc">Generic <a class="el" href="classMagnetometer.html" title="Generic Magnetometer.">Magnetometer</a> </td></tr>
<tr id="row_19_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMS8607driver.html" target="_self">MS8607driver</a></td><td class="desc">An implementation of <a class="el" href="classBarometer.html" title="Generic Barometer.">Barometer</a> for the MS8607 barometer </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMS8607Sensor.html" target="_self">MS8607Sensor</a></td><td class="desc"></td></tr>
<tr id="row_21_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPyro.html" target="_self">Pyro</a></td><td class="desc">Represents a pyro channel </td></tr>
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classRadioTransmitterLink.html" target="_self">RadioTransmitterLink</a></td><td class="desc"></td></tr>
<tr id="row_23_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSerialConnectionLink.html" target="_self">SerialConnectionLink</a></td><td class="desc"></td></tr>
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVector3D__s.html" target="_self">Vector3D_s</a></td><td class="desc">Vector with 3 axis </td></tr>
<tr id="row_15_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classICM20948Sensor.html" target="_self">ICM20948Sensor</a></td><td class="desc">Driver for ICM20948 </td></tr>
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classLogger.html" target="_self">Logger</a></td><td class="desc"></td></tr>
<tr id="row_17_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMagnetometer.html" target="_self">Magnetometer</a></td><td class="desc">Generic <a class="el" href="classMagnetometer.html" title="Generic Magnetometer.">Magnetometer</a> </td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMS8607Sensor.html" target="_self">MS8607Sensor</a></td><td class="desc">An implementation of <a class="el" href="classBarometer.html" title="Generic Barometer.">Barometer</a> for the MS8607 barometer </td></tr>
<tr id="row_19_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPyro.html" target="_self">Pyro</a></td><td class="desc">Represents a pyro channel </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classRadioTransmitterLink.html" target="_self">RadioTransmitterLink</a></td><td class="desc"></td></tr>
<tr id="row_21_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSerialConnectionLink.html" target="_self">SerialConnectionLink</a></td><td class="desc"></td></tr>
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structVector3D__s.html" target="_self">Vector3D_s</a></td><td class="desc">Vector with 3 axis </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion docs/html/classBarometer__inherit__graph.dot
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ digraph "Barometer"
Node2 -> Node1 [dir="back",color="steelblue1",style="solid"];
Node2 [label="GenericSensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGenericSensor.html",tooltip="Underlying interface to all sensors."];
Node1 -> Node3 [dir="back",color="steelblue1",style="solid"];
Node3 [label="MS8607Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip=" "];
Node3 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip="An implementation of Barometer for the MS8607 barometer."];
}
4 changes: 2 additions & 2 deletions docs/html/classGenericSensor__inherit__graph.dot
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ digraph "GenericSensor"
Node1 -> Node3 [dir="back",color="steelblue1",style="solid"];
Node3 [label="Barometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classBarometer.html",tooltip="Generic Barometer."];
Node3 -> Node4 [dir="back",color="steelblue1",style="solid"];
Node4 [label="MS8607Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip=" "];
Node4 [label="MS8607Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMS8607Sensor.html",tooltip="An implementation of Barometer for the MS8607 barometer."];
Node1 -> Node5 [dir="back",color="steelblue1",style="solid"];
Node5 [label="GPS",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classGPS.html",tooltip=" "];
Node1 -> Node6 [dir="back",color="steelblue1",style="solid"];
Node6 [label="Gyroscope",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classGyroscope.html",tooltip="Generic Gyroscope."];
Node1 -> Node7 [dir="back",color="steelblue1",style="solid"];
Node7 [label="ICM20948Sensor",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled",URL="$classICM20948Sensor.html",tooltip=" "];
Node7 [label="ICM20948Sensor",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classICM20948Sensor.html",tooltip="Driver for ICM20948."];
Node1 -> Node8 [dir="back",color="steelblue1",style="solid"];
Node8 [label="Magnetometer",height=0.2,width=0.4,color="gray40", fillcolor="white", style="filled",URL="$classMagnetometer.html",tooltip="Generic Magnetometer."];
Node1 -> Node9 [dir="back",color="steelblue1",style="solid"];
Expand Down
Loading

0 comments on commit f67b772

Please sign in to comment.