Update docs for v1.1.4 (053c24c)

dmadison · Oct 21, 2023 · 25a70ca · 25a70ca
1 parent 1285e8f
commit 25a70ca
Show file tree

Hide file tree

Showing 27 changed files with 598 additions and 353 deletions.
diff --git a/docs/_handbrake_joystick_8ino-example.html b/docs/_handbrake_joystick_8ino-example.html
@@ -102,7 +102,6 @@
 </div><!--header-->
 <div class="contents">
 <p>Emulates the handbrake as a joystick over USB.</p>
-<p>Emulates the handbrake as a joystick over USB.</p>
 <div class="fragment"><div class="line"><span class="comment">/*</span></div>
 <div class="line"><span class="comment"> *  Project     Sim Racing Library for Arduino</span></div>
 <div class="line"><span class="comment"> *  @author     David Madison</span></div>
@@ -175,10 +174,10 @@
 <div class="line">}</div>
 <div class="ttc" id="a_sim_racing_8h_html"><div class="ttname"><a href="_sim_racing_8h.html">SimRacing.h</a></div><div class="ttdoc">Header file for the Sim Racing Library.</div></div>
 <div class="ttc" id="aclass_sim_racing_1_1_handbrake_html"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html">SimRacing::Handbrake</a></div><div class="ttdoc">Interface with analog handbrakes that use hall effect sensors.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8h_source.html#l00676">SimRacing.h:676</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a0b7f6916cd4ac88b32d73a671af458ac"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a0b7f6916cd4ac88b32d73a671af458ac">SimRacing::Handbrake::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l00997">SimRacing.cpp:997</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a1b3ca0a06837b95cb3961a96795fcedc"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a1b3ca0a06837b95cb3961a96795fcedc">SimRacing::Handbrake::getPosition</a></div><div class="ttdeci">long getPosition(long rMin=0, long rMax=100) const</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01016">SimRacing.cpp:1016</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a91a560fe530bb025eaa050802fc820e6"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a91a560fe530bb025eaa050802fc820e6">SimRacing::Handbrake::positionChanged</a></div><div class="ttdeci">bool positionChanged() const</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8h_source.html#l00724">SimRacing.h:724</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_aa1cfe2d01f1b1d66d08f304f076a314b"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#aa1cfe2d01f1b1d66d08f304f076a314b">SimRacing::Handbrake::update</a></div><div class="ttdeci">virtual bool update()</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01001">SimRacing.cpp:1001</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a0b7f6916cd4ac88b32d73a671af458ac"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a0b7f6916cd4ac88b32d73a671af458ac">SimRacing::Handbrake::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdoc">Initializes the pin for reading from the handbrake.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l00997">SimRacing.cpp:997</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a1b3ca0a06837b95cb3961a96795fcedc"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a1b3ca0a06837b95cb3961a96795fcedc">SimRacing::Handbrake::getPosition</a></div><div class="ttdeci">long getPosition(long rMin=0, long rMax=100) const</div><div class="ttdoc">Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01016">SimRacing.cpp:1016</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a91a560fe530bb025eaa050802fc820e6"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a91a560fe530bb025eaa050802fc820e6">SimRacing::Handbrake::positionChanged</a></div><div class="ttdeci">bool positionChanged() const</div><div class="ttdoc">Checks whether the handbrake's position has changed since the last update.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8h_source.html#l00724">SimRacing.h:724</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_aa1cfe2d01f1b1d66d08f304f076a314b"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#aa1cfe2d01f1b1d66d08f304f076a314b">SimRacing::Handbrake::update</a></div><div class="ttdeci">virtual bool update()</div><div class="ttdoc">Polls the handbrake to update its position.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01001">SimRacing.cpp:1001</a></div></div>
 </div><!-- fragment --> </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- HTML footer for doxygen 1.9.3-->

diff --git a/docs/_handbrake_joystick_8ino_source.html b/docs/_handbrake_joystick_8ino_source.html
@@ -178,10 +178,10 @@
 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>}</div>
 <div class="ttc" id="a_sim_racing_8h_html"><div class="ttname"><a href="_sim_racing_8h.html">SimRacing.h</a></div><div class="ttdoc">Header file for the Sim Racing Library.</div></div>
 <div class="ttc" id="aclass_sim_racing_1_1_handbrake_html"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html">SimRacing::Handbrake</a></div><div class="ttdoc">Interface with analog handbrakes that use hall effect sensors.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8h_source.html#l00676">SimRacing.h:676</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a0b7f6916cd4ac88b32d73a671af458ac"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a0b7f6916cd4ac88b32d73a671af458ac">SimRacing::Handbrake::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l00997">SimRacing.cpp:997</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a1b3ca0a06837b95cb3961a96795fcedc"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a1b3ca0a06837b95cb3961a96795fcedc">SimRacing::Handbrake::getPosition</a></div><div class="ttdeci">long getPosition(long rMin=0, long rMax=100) const</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01016">SimRacing.cpp:1016</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a91a560fe530bb025eaa050802fc820e6"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a91a560fe530bb025eaa050802fc820e6">SimRacing::Handbrake::positionChanged</a></div><div class="ttdeci">bool positionChanged() const</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8h_source.html#l00724">SimRacing.h:724</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_aa1cfe2d01f1b1d66d08f304f076a314b"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#aa1cfe2d01f1b1d66d08f304f076a314b">SimRacing::Handbrake::update</a></div><div class="ttdeci">virtual bool update()</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01001">SimRacing.cpp:1001</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a0b7f6916cd4ac88b32d73a671af458ac"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a0b7f6916cd4ac88b32d73a671af458ac">SimRacing::Handbrake::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdoc">Initializes the pin for reading from the handbrake.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l00997">SimRacing.cpp:997</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a1b3ca0a06837b95cb3961a96795fcedc"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a1b3ca0a06837b95cb3961a96795fcedc">SimRacing::Handbrake::getPosition</a></div><div class="ttdeci">long getPosition(long rMin=0, long rMax=100) const</div><div class="ttdoc">Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01016">SimRacing.cpp:1016</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a91a560fe530bb025eaa050802fc820e6"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a91a560fe530bb025eaa050802fc820e6">SimRacing::Handbrake::positionChanged</a></div><div class="ttdeci">bool positionChanged() const</div><div class="ttdoc">Checks whether the handbrake's position has changed since the last update.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8h_source.html#l00724">SimRacing.h:724</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_aa1cfe2d01f1b1d66d08f304f076a314b"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#aa1cfe2d01f1b1d66d08f304f076a314b">SimRacing::Handbrake::update</a></div><div class="ttdeci">virtual bool update()</div><div class="ttdoc">Polls the handbrake to update its position.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01001">SimRacing.cpp:1001</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- HTML footer for doxygen 1.9.3-->

diff --git a/docs/_handbrake_print_8ino-example.html b/docs/_handbrake_print_8ino-example.html
@@ -102,7 +102,6 @@
 </div><!--header-->
 <div class="contents">
 <p>Prints handbrake position percentage over Serial.</p>
-<p>Prints handbrake position percentage over Serial.</p>
 <div class="fragment"><div class="line"><span class="comment">/*</span></div>
 <div class="line"><span class="comment"> *  Project     Sim Racing Library for Arduino</span></div>
 <div class="line"><span class="comment"> *  @author     David Madison</span></div>
@@ -163,10 +162,10 @@
 <div class="line">}</div>
 <div class="ttc" id="a_sim_racing_8h_html"><div class="ttname"><a href="_sim_racing_8h.html">SimRacing.h</a></div><div class="ttdoc">Header file for the Sim Racing Library.</div></div>
 <div class="ttc" id="aclass_sim_racing_1_1_handbrake_html"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html">SimRacing::Handbrake</a></div><div class="ttdoc">Interface with analog handbrakes that use hall effect sensors.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8h_source.html#l00676">SimRacing.h:676</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a0b7f6916cd4ac88b32d73a671af458ac"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a0b7f6916cd4ac88b32d73a671af458ac">SimRacing::Handbrake::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l00997">SimRacing.cpp:997</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a1b3ca0a06837b95cb3961a96795fcedc"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a1b3ca0a06837b95cb3961a96795fcedc">SimRacing::Handbrake::getPosition</a></div><div class="ttdeci">long getPosition(long rMin=0, long rMax=100) const</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01016">SimRacing.cpp:1016</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_aa1cfe2d01f1b1d66d08f304f076a314b"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#aa1cfe2d01f1b1d66d08f304f076a314b">SimRacing::Handbrake::update</a></div><div class="ttdeci">virtual bool update()</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01001">SimRacing.cpp:1001</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_ad87d44871e346e72ce4ea34f978380bd"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#ad87d44871e346e72ce4ea34f978380bd">SimRacing::Handbrake::serialCalibration</a></div><div class="ttdeci">void serialCalibration(Stream &amp;iface=Serial)</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01029">SimRacing.cpp:1029</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a0b7f6916cd4ac88b32d73a671af458ac"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a0b7f6916cd4ac88b32d73a671af458ac">SimRacing::Handbrake::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdoc">Initializes the pin for reading from the handbrake.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l00997">SimRacing.cpp:997</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a1b3ca0a06837b95cb3961a96795fcedc"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a1b3ca0a06837b95cb3961a96795fcedc">SimRacing::Handbrake::getPosition</a></div><div class="ttdeci">long getPosition(long rMin=0, long rMax=100) const</div><div class="ttdoc">Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01016">SimRacing.cpp:1016</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_aa1cfe2d01f1b1d66d08f304f076a314b"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#aa1cfe2d01f1b1d66d08f304f076a314b">SimRacing::Handbrake::update</a></div><div class="ttdeci">virtual bool update()</div><div class="ttdoc">Polls the handbrake to update its position.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01001">SimRacing.cpp:1001</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_ad87d44871e346e72ce4ea34f978380bd"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#ad87d44871e346e72ce4ea34f978380bd">SimRacing::Handbrake::serialCalibration</a></div><div class="ttdeci">void serialCalibration(Stream &amp;iface=Serial)</div><div class="ttdoc">Runs an interactive calibration tool using the serial interface.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01029">SimRacing.cpp:1029</a></div></div>
 </div><!-- fragment --> </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- HTML footer for doxygen 1.9.3-->

diff --git a/docs/_handbrake_print_8ino_source.html b/docs/_handbrake_print_8ino_source.html
@@ -166,10 +166,10 @@
 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>}</div>
 <div class="ttc" id="a_sim_racing_8h_html"><div class="ttname"><a href="_sim_racing_8h.html">SimRacing.h</a></div><div class="ttdoc">Header file for the Sim Racing Library.</div></div>
 <div class="ttc" id="aclass_sim_racing_1_1_handbrake_html"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html">SimRacing::Handbrake</a></div><div class="ttdoc">Interface with analog handbrakes that use hall effect sensors.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8h_source.html#l00676">SimRacing.h:676</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a0b7f6916cd4ac88b32d73a671af458ac"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a0b7f6916cd4ac88b32d73a671af458ac">SimRacing::Handbrake::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l00997">SimRacing.cpp:997</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a1b3ca0a06837b95cb3961a96795fcedc"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a1b3ca0a06837b95cb3961a96795fcedc">SimRacing::Handbrake::getPosition</a></div><div class="ttdeci">long getPosition(long rMin=0, long rMax=100) const</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01016">SimRacing.cpp:1016</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_aa1cfe2d01f1b1d66d08f304f076a314b"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#aa1cfe2d01f1b1d66d08f304f076a314b">SimRacing::Handbrake::update</a></div><div class="ttdeci">virtual bool update()</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01001">SimRacing.cpp:1001</a></div></div>
-<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_ad87d44871e346e72ce4ea34f978380bd"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#ad87d44871e346e72ce4ea34f978380bd">SimRacing::Handbrake::serialCalibration</a></div><div class="ttdeci">void serialCalibration(Stream &amp;iface=Serial)</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01029">SimRacing.cpp:1029</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a0b7f6916cd4ac88b32d73a671af458ac"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a0b7f6916cd4ac88b32d73a671af458ac">SimRacing::Handbrake::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdoc">Initializes the pin for reading from the handbrake.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l00997">SimRacing.cpp:997</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_a1b3ca0a06837b95cb3961a96795fcedc"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#a1b3ca0a06837b95cb3961a96795fcedc">SimRacing::Handbrake::getPosition</a></div><div class="ttdeci">long getPosition(long rMin=0, long rMax=100) const</div><div class="ttdoc">Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01016">SimRacing.cpp:1016</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_aa1cfe2d01f1b1d66d08f304f076a314b"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#aa1cfe2d01f1b1d66d08f304f076a314b">SimRacing::Handbrake::update</a></div><div class="ttdeci">virtual bool update()</div><div class="ttdoc">Polls the handbrake to update its position.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01001">SimRacing.cpp:1001</a></div></div>
+<div class="ttc" id="aclass_sim_racing_1_1_handbrake_html_ad87d44871e346e72ce4ea34f978380bd"><div class="ttname"><a href="class_sim_racing_1_1_handbrake.html#ad87d44871e346e72ce4ea34f978380bd">SimRacing::Handbrake::serialCalibration</a></div><div class="ttdeci">void serialCalibration(Stream &amp;iface=Serial)</div><div class="ttdoc">Runs an interactive calibration tool using the serial interface.</div><div class="ttdef"><b>Definition</b> <a href="_sim_racing_8cpp_source.html#l01029">SimRacing.cpp:1029</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- HTML footer for doxygen 1.9.3-->