Skip to content

Commit

Permalink
deploy: e5274b7
Browse files Browse the repository at this point in the history
  • Loading branch information
@joshua-8
joshua-8 committed Jun 2, 2024
1 parent ff2ee8b commit 4f35dff
Showing 1 changed file with 25 additions and 23 deletions.
48 changes: 25 additions & 23 deletions byte-sized-encoder-decoder_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -259,35 +259,37 @@
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> <span class="keywordflow">for</span> (<span class="keywordtype">byte</span> i = 0; i &lt; 8; i++) {</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> <a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#a953eb0c40592ac84136ca855d93ceea2">encoderCount</a>[i] = 0;</div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span> <a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#aaaedba3e69d158d0a1cfa0c32dbca7d1">encoderOverflows</a>[i] = 0;</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> }</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> }</div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> }</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> <a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#ae3d2c555633d22b41be5bc5d787b35d4">lastEncoderCount</a>[i] = 0;</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> <a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#a2cf74d103699e1094df891c8a64e65d5">encoderVelocity</a>[i] = 0;</div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> }</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> }</div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> }</div>
</div>
<div class="foldopen" id="foldopen00260" data-start="{" data-end="}">
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"><a class="line" href="class_byte_sized_encoder_decoder.html#aab6833c82200891fc1f5d52e1c5bbca8"> 260</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_byte_sized_encoder_decoder.html#aab6833c82200891fc1f5d52e1c5bbca8">setWhichEncoders</a>(uint8_t mask)</div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno"> 261</span> {</div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"> 262</span> <span class="keywordflow">if</span> (mask != 0) {</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> <a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#a67c9ba4274ce78ba3ebbdddd3dcd5997">whichEncodersMask</a> = mask;</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> <a class="code hl_function" href="class_byte_sized_encoder_decoder.html#ada95cb18bd4b4728f16f394977c46018">write</a>(mask);</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> }</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> }</div>
<div class="foldopen" id="foldopen00262" data-start="{" data-end="}">
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"><a class="line" href="class_byte_sized_encoder_decoder.html#aab6833c82200891fc1f5d52e1c5bbca8"> 262</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_byte_sized_encoder_decoder.html#aab6833c82200891fc1f5d52e1c5bbca8">setWhichEncoders</a>(uint8_t mask)</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> {</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> <span class="keywordflow">if</span> (mask != 0) {</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> <a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#a67c9ba4274ce78ba3ebbdddd3dcd5997">whichEncodersMask</a> = mask;</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> <a class="code hl_function" href="class_byte_sized_encoder_decoder.html#ada95cb18bd4b4728f16f394977c46018">write</a>(mask);</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> }</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> }</div>
</div>
<div class="foldopen" id="foldopen00272" data-start="{" data-end="}">
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"><a class="line" href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052"> 272</a></span> <span class="keywordtype">boolean</span> <a class="code hl_function" href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052">isEncoderActive</a>(uint8_t n)</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span> {</div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span> <span class="keywordflow">if</span> (n &gt; 8 || n &lt; 1) {</div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span> }</div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> <span class="keywordflow">return</span> bitRead(<a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#a67c9ba4274ce78ba3ebbdddd3dcd5997">whichEncodersMask</a>, 7 - (n - 1));</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> }</div>
<div class="foldopen" id="foldopen00274" data-start="{" data-end="}">
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"><a class="line" href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052"> 274</a></span> <span class="keywordtype">boolean</span> <a class="code hl_function" href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052">isEncoderActive</a>(uint8_t n)</div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span> {</div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span> <span class="keywordflow">if</span> (n &gt; 8 || n &lt; 1) {</div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> }</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> <span class="keywordflow">return</span> bitRead(<a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#a67c9ba4274ce78ba3ebbdddd3dcd5997">whichEncodersMask</a>, 7 - (n - 1));</div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span> }</div>
</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span>};</div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span>};</div>
</div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span><span class="preprocessor">#endif </span><span class="comment">// BYTE_SIZED_ENCODER_DECODER_H</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span><span class="preprocessor">#endif </span><span class="comment">// BYTE_SIZED_ENCODER_DECODER_H</span></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></div><div class="ttdoc">class for communicating with the firmware on a Byte Sized Encoder Decoder board</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:8</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a286a9e23a046d770d8bd45177df1a65c"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a286a9e23a046d770d8bd45177df1a65c">ByteSizedEncoderDecoder::resetEncoderPositions</a></div><div class="ttdeci">void resetEncoderPositions(boolean resetVariables=true)</div><div class="ttdoc">resets all encoder positions to 0</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:245</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a2cf74d103699e1094df891c8a64e65d5"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a2cf74d103699e1094df891c8a64e65d5">ByteSizedEncoderDecoder::encoderVelocity</a></div><div class="ttdeci">int16_t encoderVelocity[8]</div><div class="ttdoc">array of 8 numbers representing the velocity of each encoder (steps per second)</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:41</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a63045fd8fa427538e7266c57fb8cd052"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052">ByteSizedEncoderDecoder::isEncoderActive</a></div><div class="ttdeci">boolean isEncoderActive(uint8_t n)</div><div class="ttdoc">whether you have set to read data from a specific encoder</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:272</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a63045fd8fa427538e7266c57fb8cd052"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052">ByteSizedEncoderDecoder::isEncoderActive</a></div><div class="ttdeci">boolean isEncoderActive(uint8_t n)</div><div class="ttdoc">whether you have set to read data from a specific encoder</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:274</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a639c73fefb4c3ef8649a7707aa81edd8"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a639c73fefb4c3ef8649a7707aa81edd8">ByteSizedEncoderDecoder::getEncoderPositionWithoutOverflows</a></div><div class="ttdeci">int16_t getEncoderPositionWithoutOverflows(uint8_t n, boolean read=false)</div><div class="ttdoc">gets the position of an encoder as the 16 bit number that the board returns (it loops around and over...</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:215</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a65195beb5442f3950b334743f08e7cce"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a65195beb5442f3950b334743f08e7cce">ByteSizedEncoderDecoder::encoderEnoughCounts</a></div><div class="ttdeci">int16_t encoderEnoughCounts[8]</div><div class="ttdoc">enough counts to calculate velocity from</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:49</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a66211cb3263c7a7a4856f19d5976d927"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a66211cb3263c7a7a4856f19d5976d927">ByteSizedEncoderDecoder::run</a></div><div class="ttdeci">void run()</div><div class="ttdoc">reads the encoder positions from the board</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:155</div></div>
Expand All @@ -301,7 +303,7 @@
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a9f846c80742a4333e9107df3cc5c88dc"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a9f846c80742a4333e9107df3cc5c88dc">ByteSizedEncoderDecoder::getEncoderPosition</a></div><div class="ttdeci">int32_t getEncoderPosition(uint8_t n, boolean read=false)</div><div class="ttdoc">gets the position of an encoder as a 32 bit signed integer (it counts how many times the 16 bit numbe...</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:198</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_aa4ea68b1e2bb89a1a55b8f21816287ef"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#aa4ea68b1e2bb89a1a55b8f21816287ef">ByteSizedEncoderDecoder::encoderSlowestInterval</a></div><div class="ttdeci">int16_t encoderSlowestInterval[8]</div><div class="ttdoc">after this many milliseconds without an encoder tick velocity is set to zero.</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:45</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_aaaedba3e69d158d0a1cfa0c32dbca7d1"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#aaaedba3e69d158d0a1cfa0c32dbca7d1">ByteSizedEncoderDecoder::encoderOverflows</a></div><div class="ttdeci">int16_t encoderOverflows[8]</div><div class="ttdoc">array of 8 numbers representing the number of times each encoder's counter variable has overflowed</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:21</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_aab6833c82200891fc1f5d52e1c5bbca8"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#aab6833c82200891fc1f5d52e1c5bbca8">ByteSizedEncoderDecoder::setWhichEncoders</a></div><div class="ttdeci">void setWhichEncoders(uint8_t mask)</div><div class="ttdoc">set which encoders you want to receive data from</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:260</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_aab6833c82200891fc1f5d52e1c5bbca8"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#aab6833c82200891fc1f5d52e1c5bbca8">ByteSizedEncoderDecoder::setWhichEncoders</a></div><div class="ttdeci">void setWhichEncoders(uint8_t mask)</div><div class="ttdoc">set which encoders you want to receive data from</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:262</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_ad7801e217c3adac17bbccf3b6c474158"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#ad7801e217c3adac17bbccf3b6c474158">ByteSizedEncoderDecoder::isVelNew</a></div><div class="ttdeci">boolean isVelNew(uint8_t n)</div><div class="ttdoc">whether the velocity was just calculated</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:128</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_ada95cb18bd4b4728f16f394977c46018"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#ada95cb18bd4b4728f16f394977c46018">ByteSizedEncoderDecoder::write</a></div><div class="ttdeci">void write(uint8_t data)</div><div class="ttdoc">helper function to write a byte to the board</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:57</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_adcc356b5e6c7d0d64cd9252ab8764c42"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#adcc356b5e6c7d0d64cd9252ab8764c42">ByteSizedEncoderDecoder::setEncoderSlowestInterval</a></div><div class="ttdeci">void setEncoderSlowestInterval(uint8_t n, int16_t interval)</div><div class="ttdoc">set the value of encoderSlowestInterval</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:90</div></div>
Expand Down

0 comments on commit 4f35dff

Please sign in to comment.