Skip to content

Commit

Permalink
deploy: 774eb56
Browse files Browse the repository at this point in the history
  • Loading branch information
joshua-8 committed Apr 30, 2024
1 parent c2b91e8 commit e18bacd
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions byte-sized-encoder-decoder_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00046" data-start="{" data-end="}">
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f"> 46</a></span> <a class="code hl_function" href="class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f">ByteSizedEncoderDecoder</a>(TwoWire* _wire, uint8_t _address = 0x0E)</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2"> 46</a></span> <a class="code hl_function" href="class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2">ByteSizedEncoderDecoder</a>(TwoWire* _wire, uint8_t _address = 14)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#a9f53f3b9b3726f333c94a122b70010c4">wire</a> = _wire;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_variable" href="class_byte_sized_encoder_decoder.html#a67f158ba45e9058deb13c0dd74f65d77">address</a> = _address;</div>
Expand Down Expand Up @@ -199,9 +199,9 @@
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a67c9ba4274ce78ba3ebbdddd3dcd5997"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a67c9ba4274ce78ba3ebbdddd3dcd5997">ByteSizedEncoderDecoder::whichEncodersMask</a></div><div class="ttdeci">uint8_t whichEncodersMask</div><div class="ttdoc">bit mask of which encoders to read from</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:22</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a67f158ba45e9058deb13c0dd74f65d77"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a67f158ba45e9058deb13c0dd74f65d77">ByteSizedEncoderDecoder::address</a></div><div class="ttdeci">uint8_t address</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:10</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a953eb0c40592ac84136ca855d93ceea2"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a953eb0c40592ac84136ca855d93ceea2">ByteSizedEncoderDecoder::encoderCount</a></div><div class="ttdeci">int16_t encoderCount[8]</div><div class="ttdoc">array of 8 numbers representing the number of steps each encoder has taken</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:14</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a9bd8c4d4ec208c21b8b242905acef65f"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f">ByteSizedEncoderDecoder::ByteSizedEncoderDecoder</a></div><div class="ttdeci">ByteSizedEncoderDecoder(TwoWire *_wire, uint8_t _address=0x0E)</div><div class="ttdoc">Constructor for the Byte Sized Encoder Decoder class.</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:46</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_a9f53f3b9b3726f333c94a122b70010c4"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#a9f53f3b9b3726f333c94a122b70010c4">ByteSizedEncoderDecoder::wire</a></div><div class="ttdeci">TwoWire * wire</div><div class="ttdoc">I2C bus to communicate over.</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:18</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:117</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_aac6513e044ae1c3ee1e63272cc788bb2"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2">ByteSizedEncoderDecoder::ByteSizedEncoderDecoder</a></div><div class="ttdeci">ByteSizedEncoderDecoder(TwoWire *_wire, uint8_t _address=14)</div><div class="ttdoc">Constructor for the Byte Sized Encoder Decoder class.</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:46</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_ac7d24b65ed8c985c9499a22eda839138"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#ac7d24b65ed8c985c9499a22eda839138">ByteSizedEncoderDecoder::resetEncoderPositions</a></div><div class="ttdeci">void resetEncoderPositions()</div><div class="ttdoc">resets all encoder positions to 0</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:108</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="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:23</div></div>
<div class="ttc" id="aclass_byte_sized_encoder_decoder_html_afaafc613073f19a83c58ca35a50412e1"><div class="ttname"><a href="class_byte_sized_encoder_decoder.html#afaafc613073f19a83c58ca35a50412e1">ByteSizedEncoderDecoder::begin</a></div><div class="ttdeci">void begin(boolean resetEncoders=true)</div><div class="ttdoc">sets up the Byte Sized Encoder Decoder board all it really does is tell the board to read from all en...</div><div class="ttdef"><b>Definition</b> byte-sized-encoder-decoder.h:58</div></div>
Expand Down
2 changes: 1 addition & 1 deletion class_byte_sized_encoder_decoder-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
<tr class="even"><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html#a67f158ba45e9058deb13c0dd74f65d77">address</a></td><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html#afaafc613073f19a83c58ca35a50412e1">begin</a>(boolean resetEncoders=true)</td><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html#afef9f4cf7f22319d4dd75a6580370aaa">bitCount</a>(uint8_t b)</td><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f">ByteSizedEncoderDecoder</a>(TwoWire *_wire, uint8_t _address=0x0E)</td><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2">ByteSizedEncoderDecoder</a>(TwoWire *_wire, uint8_t _address=14)</td><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html#a953eb0c40592ac84136ca855d93ceea2">encoderCount</a></td><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html#a5b18fe5295c0a4efd9597de5b6a487ba">getEncoderPosition</a>(uint8_t n, boolean read=false)</td><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052">isEncoderActive</a>(uint8_t n)</td><td class="entry"><a class="el" href="class_byte_sized_encoder_decoder.html">ByteSizedEncoderDecoder</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
Expand Down
14 changes: 7 additions & 7 deletions class_byte_sized_encoder_decoder.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9bd8c4d4ec208c21b8b242905acef65f" id="r_a9bd8c4d4ec208c21b8b242905acef65f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f">ByteSizedEncoderDecoder</a> (TwoWire *_wire, uint8_t _address=0x0E)</td></tr>
<tr class="memdesc:a9bd8c4d4ec208c21b8b242905acef65f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the Byte Sized Encoder Decoder class. <br /></td></tr>
<tr class="separator:a9bd8c4d4ec208c21b8b242905acef65f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac6513e044ae1c3ee1e63272cc788bb2" id="r_aac6513e044ae1c3ee1e63272cc788bb2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2">ByteSizedEncoderDecoder</a> (TwoWire *_wire, uint8_t _address=14)</td></tr>
<tr class="memdesc:aac6513e044ae1c3ee1e63272cc788bb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the Byte Sized Encoder Decoder class. <br /></td></tr>
<tr class="separator:aac6513e044ae1c3ee1e63272cc788bb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afaafc613073f19a83c58ca35a50412e1" id="r_afaafc613073f19a83c58ca35a50412e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_sized_encoder_decoder.html#afaafc613073f19a83c58ca35a50412e1">begin</a> (boolean resetEncoders=true)</td></tr>
<tr class="memdesc:afaafc613073f19a83c58ca35a50412e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets up the Byte Sized Encoder Decoder board all it really does is tell the board to read from all encoders <br /></td></tr>
<tr class="separator:afaafc613073f19a83c58ca35a50412e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -131,8 +131,8 @@
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>class for communicating with the firmware on a Byte Sized Encoder Decoder board </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9bd8c4d4ec208c21b8b242905acef65f" name="a9bd8c4d4ec208c21b8b242905acef65f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bd8c4d4ec208c21b8b242905acef65f">&#9670;&#160;</a></span>ByteSizedEncoderDecoder()</h2>
<a id="aac6513e044ae1c3ee1e63272cc788bb2" name="aac6513e044ae1c3ee1e63272cc788bb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac6513e044ae1c3ee1e63272cc788bb2">&#9670;&#160;</a></span>ByteSizedEncoderDecoder()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -150,7 +150,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9bd8c4d4ec208c21b8b24290
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>_address</em> = <code>0x0E</code>&#160;</td>
<td class="paramname"><em>_address</em> = <code>14</code>&#160;</td>
</tr>
<tr>
<td></td>
Expand All @@ -169,7 +169,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9bd8c4d4ec208c21b8b24290
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">_wire</td><td>I2C bus to communicate over. &amp;Wire or &amp;Wire1 </td></tr>
<tr><td class="paramname">_address</td><td>I2C address of the Byte Sized Encoder Decoder board (as selected by the jumpers), default is 0x0E </td></tr>
<tr><td class="paramname">_address</td><td>I2C address of the Byte Sized Encoder Decoder board (as selected by the jumpers), default is 14, (14-17 are options) </td></tr>
</table>
</dd>
</dl>
Expand Down
2 changes: 1 addition & 1 deletion functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<li>address&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#a67f158ba45e9058deb13c0dd74f65d77">ByteSizedEncoderDecoder</a></li>
<li>begin()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#afaafc613073f19a83c58ca35a50412e1">ByteSizedEncoderDecoder</a></li>
<li>bitCount()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#afef9f4cf7f22319d4dd75a6580370aaa">ByteSizedEncoderDecoder</a></li>
<li>ByteSizedEncoderDecoder()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f">ByteSizedEncoderDecoder</a></li>
<li>ByteSizedEncoderDecoder()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2">ByteSizedEncoderDecoder</a></li>
<li>encoderCount&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#a953eb0c40592ac84136ca855d93ceea2">ByteSizedEncoderDecoder</a></li>
<li>getEncoderPosition()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#a5b18fe5295c0a4efd9597de5b6a487ba">ByteSizedEncoderDecoder</a></li>
<li>isEncoderActive()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052">ByteSizedEncoderDecoder</a></li>
Expand Down
2 changes: 1 addition & 1 deletion functions_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
<div class="textblock">Here is a list of all functions with links to the classes they belong to:</div><ul>
<li>begin()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#afaafc613073f19a83c58ca35a50412e1">ByteSizedEncoderDecoder</a></li>
<li>bitCount()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#afef9f4cf7f22319d4dd75a6580370aaa">ByteSizedEncoderDecoder</a></li>
<li>ByteSizedEncoderDecoder()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f">ByteSizedEncoderDecoder</a></li>
<li>ByteSizedEncoderDecoder()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2">ByteSizedEncoderDecoder</a></li>
<li>getEncoderPosition()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#a5b18fe5295c0a4efd9597de5b6a487ba">ByteSizedEncoderDecoder</a></li>
<li>isEncoderActive()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#a63045fd8fa427538e7266c57fb8cd052">ByteSizedEncoderDecoder</a></li>
<li>resetEncoderPositions()&#160;:&#160;<a class="el" href="class_byte_sized_encoder_decoder.html#ac7d24b65ed8c985c9499a22eda839138">ByteSizedEncoderDecoder</a></li>
Expand Down
2 changes: 1 addition & 1 deletion search/all_1.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ var searchData=
['bitcount_1',['bitCount',['../class_byte_sized_encoder_decoder.html#afef9f4cf7f22319d4dd75a6580370aaa',1,'ByteSizedEncoderDecoder']]],
['byte_20sized_20encoder_20decoder_2',['Byte Sized Encoder Decoder',['../index.html',1,'']]],
['byte_2dsized_2dencoder_2ddecoder_2eh_3',['byte-sized-encoder-decoder.h',['../byte-sized-encoder-decoder_8h.html',1,'']]],
['bytesizedencoderdecoder_4',['bytesizedencoderdecoder',['../class_byte_sized_encoder_decoder.html',1,'ByteSizedEncoderDecoder'],['../class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f',1,'ByteSizedEncoderDecoder::ByteSizedEncoderDecoder()']]]
['bytesizedencoderdecoder_4',['bytesizedencoderdecoder',['../class_byte_sized_encoder_decoder.html',1,'ByteSizedEncoderDecoder'],['../class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2',1,'ByteSizedEncoderDecoder::ByteSizedEncoderDecoder()']]]
];
2 changes: 1 addition & 1 deletion search/functions_0.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ var searchData=
[
['begin_0',['begin',['../class_byte_sized_encoder_decoder.html#afaafc613073f19a83c58ca35a50412e1',1,'ByteSizedEncoderDecoder']]],
['bitcount_1',['bitCount',['../class_byte_sized_encoder_decoder.html#afef9f4cf7f22319d4dd75a6580370aaa',1,'ByteSizedEncoderDecoder']]],
['bytesizedencoderdecoder_2',['ByteSizedEncoderDecoder',['../class_byte_sized_encoder_decoder.html#a9bd8c4d4ec208c21b8b242905acef65f',1,'ByteSizedEncoderDecoder']]]
['bytesizedencoderdecoder_2',['ByteSizedEncoderDecoder',['../class_byte_sized_encoder_decoder.html#aac6513e044ae1c3ee1e63272cc788bb2',1,'ByteSizedEncoderDecoder']]]
];

0 comments on commit e18bacd

Please sign in to comment.