Deploy docs to GitHub Pages from commit 3e96bdd

Commit: 3e96bdd
GitHub Actions run: 11165755438

html/_adafruit___crickit_8h_source.html

@@ -64,7 +64,7 @@
 <div class="contents">
 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef _CRICKIT_TERSTER_H</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define _CRICKIT_TERSTER_H</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_adafruit__seesaw_8h.html">Adafruit_seesaw.h</a>&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#define CRICKIT_SIGNAL1 2</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#define CRICKIT_SIGNAL2 3</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#define CRICKIT_SIGNAL3 40</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define CRICKIT_SIGNAL4 41</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#define CRICKIT_SIGNAL5 11</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#define CRICKIT_SIGNAL6 10</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#define CRICKIT_SIGNAL7 9</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#define CRICKIT_SIGNAL8 8</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#define CRICKIT_SERVO4 14</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#define CRICKIT_SERVO3 15</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define CRICKIT_SERVO2 16</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define CRICKIT_SERVO1 17</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#define CRICKIT_MOTOR_A1 22</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#define CRICKIT_MOTOR_A2 23</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#define CRICKIT_MOTOR_B1 19</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#define CRICKIT_MOTOR_B2 18</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#define CRICKIT_DRIVE1 13</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#define CRICKIT_DRIVE2 12</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define CRICKIT_DRIVE3 43</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#define CRICKIT_DRIVE4 42</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#define CRICKIT_TOUCH1 0</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#define CRICKIT_TOUCH2 1</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#define CRICKIT_TOUCH3 2</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#define CRICKIT_TOUCH4 3</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#define CRICKIT_DUTY_CYCLE_OFF 0</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#define CRICKIT_DUTY_CYCLE_MAX 65535</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_adafruit___crickit.html">   43</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_adafruit___crickit.html">Adafruit_Crickit</a> : <span class="keyword">public</span> <a class="code" href="class_adafruit__seesaw.html">Adafruit_seesaw</a> {</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  <a class="code" href="class_adafruit___crickit.html">Adafruit_Crickit</a>(){};</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  ~<a class="code" href="class_adafruit___crickit.html">Adafruit_Crickit</a>(){};</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___crickit.html#a87bf616b4ecc2364ab2df63da59a4982">analogWrite</a>(uint8_t pin, uint16_t value, uint8_t width = 8);</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  uint16_t <a class="code" href="class_adafruit___crickit.html#a2045bf1544d021135b60dcc4b5335f6f">analogRead</a>(uint8_t pin);</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___crickit.html#a052da3d6217b8fce16b0a3136b532808">setPWMFreq</a>(uint8_t pin, uint16_t freq);</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;};</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="class_adafruit___crickit_html_a87bf616b4ecc2364ab2df63da59a4982"><div class="ttname"><a href="class_adafruit___crickit.html#a87bf616b4ecc2364ab2df63da59a4982">Adafruit_Crickit::analogWrite</a></div><div class="ttdeci">void analogWrite(uint8_t pin, uint16_t value, uint8_t width=8)</div><div class="ttdoc">write a PWM value to a PWM-enabled pin </div><div class="ttdef"><b>Definition:</b> Adafruit_Crickit.cpp:16</div></div>
 <div class="ttc" id="class_adafruit___crickit_html_a052da3d6217b8fce16b0a3136b532808"><div class="ttname"><a href="class_adafruit___crickit.html#a052da3d6217b8fce16b0a3136b532808">Adafruit_Crickit::setPWMFreq</a></div><div class="ttdeci">void setPWMFreq(uint8_t pin, uint16_t freq)</div><div class="ttdoc">set the PWM frequency of a PWM-enabled pin. Note that on SAMD09, SAMD11 boards the frequency will be ...</div><div class="ttdef"><b>Definition:</b> Adafruit_Crickit.cpp:52</div></div>
-<div class="ttc" id="class_adafruit__seesaw_html"><div class="ttname"><a href="class_adafruit__seesaw.html">Adafruit_seesaw</a></div><div class="ttdoc">Class that stores state and functions for interacting with seesaw helper IC. </div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:251</div></div>
+<div class="ttc" id="class_adafruit__seesaw_html"><div class="ttname"><a href="class_adafruit__seesaw.html">Adafruit_seesaw</a></div><div class="ttdoc">Class that stores state and functions for interacting with seesaw helper IC. </div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:235</div></div>
 <div class="ttc" id="class_adafruit___crickit_html"><div class="ttname"><a href="class_adafruit___crickit.html">Adafruit_Crickit</a></div><div class="ttdoc">Class that stores state and functions for interacting with Crickit variant of seesaw helper IC...</div><div class="ttdef"><b>Definition:</b> Adafruit_Crickit.h:43</div></div>
 <div class="ttc" id="_adafruit__seesaw_8h_html"><div class="ttname"><a href="_adafruit__seesaw_8h.html">Adafruit_seesaw.h</a></div></div>
 <div class="ttc" id="class_adafruit___crickit_html_a2045bf1544d021135b60dcc4b5335f6f"><div class="ttname"><a href="class_adafruit___crickit.html#a2045bf1544d021135b60dcc4b5335f6f">Adafruit_Crickit::analogRead</a></div><div class="ttdeci">uint16_t analogRead(uint8_t pin)</div><div class="ttdoc">read the analog value on an ADC-enabled pin. </div><div class="ttdef"><b>Definition:</b> Adafruit_Crickit.cpp:33</div></div>

html/_adafruit___neo_key__1x4_8h_source.html

@@ -67,10 +67,10 @@
 <div class="ttc" id="class_adafruit___neo_key__1x4_html_ad659c32ce0051f88dfa9ff6fc6ed1a4f"><div class="ttname"><a href="class_adafruit___neo_key__1x4.html#ad659c32ce0051f88dfa9ff6fc6ed1a4f">Adafruit_NeoKey_1x4::last_buttons</a></div><div class="ttdeci">uint8_t last_buttons</div><div class="ttdoc">The last reading for the buttons. </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoKey_1x4.h:58</div></div>
 <div class="ttc" id="class_adafruit___neo_key__1x4_html"><div class="ttname"><a href="class_adafruit___neo_key__1x4.html">Adafruit_NeoKey_1x4</a></div><div class="ttdoc">Class that stores state and functions for interacting with the seesaw NeoKey module. </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoKey_1x4.h:40</div></div>
 <div class="ttc" id="class_adafruit___multi_neo_key1x4_html_a531e7452eebe91877f1d4d0db1b7d832"><div class="ttname"><a href="class_adafruit___multi_neo_key1x4.html#a531e7452eebe91877f1d4d0db1b7d832">Adafruit_MultiNeoKey1x4::_cols</a></div><div class="ttdeci">uint8_t _cols</div><div class="ttdoc">the number of trellis boards in the X direction </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoKey_1x4.h:92</div></div>
-<div class="ttc" id="class_adafruit__seesaw_html"><div class="ttname"><a href="class_adafruit__seesaw.html">Adafruit_seesaw</a></div><div class="ttdoc">Class that stores state and functions for interacting with seesaw helper IC. </div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:251</div></div>
+<div class="ttc" id="class_adafruit__seesaw_html"><div class="ttname"><a href="class_adafruit__seesaw.html">Adafruit_seesaw</a></div><div class="ttdoc">Class that stores state and functions for interacting with seesaw helper IC. </div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:235</div></div>
 <div class="ttc" id="class_adafruit___neo_key__1x4_html_a59d2911382736df023da7ba3e6068209"><div class="ttname"><a href="class_adafruit___neo_key__1x4.html#a59d2911382736df023da7ba3e6068209">Adafruit_NeoKey_1x4::_callbacks</a></div><div class="ttdeci">NeoKey1x4Callback(* _callbacks[NEOKEY_1X4_KEYS])(keyEvent)</div><div class="ttdoc">the array of callback functions </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoKey_1x4.h:60</div></div>
 <div class="ttc" id="class_adafruit___neo_key__1x4_html_ad2fbad1b00b751e88bc6a587b21e1a77"><div class="ttname"><a href="class_adafruit___neo_key__1x4.html#ad2fbad1b00b751e88bc6a587b21e1a77">Adafruit_NeoKey_1x4::unregisterCallback</a></div><div class="ttdeci">void unregisterCallback(uint8_t key)</div><div class="ttdoc">unregister a callback on a given key </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoKey_1x4.cpp:67</div></div>
-<div class="ttc" id="unionkey_event_html"><div class="ttname"><a href="unionkey_event.html">keyEvent</a></div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:228</div></div>
+<div class="ttc" id="unionkey_event_html"><div class="ttname"><a href="unionkey_event.html">keyEvent</a></div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:212</div></div>
 <div class="ttc" id="class_adafruit___multi_neo_key1x4_html"><div class="ttname"><a href="class_adafruit___multi_neo_key1x4.html">Adafruit_MultiNeoKey1x4</a></div><div class="ttdoc">Class that stores state and functions for interacting with multiple neotrellis boards. </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoKey_1x4.h:70</div></div>
 <div class="ttc" id="_adafruit__seesaw_8h_html"><div class="ttname"><a href="_adafruit__seesaw_8h.html">Adafruit_seesaw.h</a></div></div>
 <div class="ttc" id="class_adafruit___multi_neo_key1x4_html_a8124e04d17c9a43b96217304df3d98c0"><div class="ttname"><a href="class_adafruit___multi_neo_key1x4.html#a8124e04d17c9a43b96217304df3d98c0">Adafruit_MultiNeoKey1x4::_neokeys</a></div><div class="ttdeci">Adafruit_NeoKey_1x4 * _neokeys</div><div class="ttdoc">a multidimensional array of neokey objects </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoKey_1x4.h:93</div></div>

html/_adafruit___neo_trellis_8h_source.html

@@ -67,13 +67,13 @@
 <div class="ttc" id="class_adafruit___multi_trellis_html_a44df91efc98c0cdcc16ac7d6a7fade1c"><div class="ttname"><a href="class_adafruit___multi_trellis.html#a44df91efc98c0cdcc16ac7d6a7fade1c">Adafruit_MultiTrellis::_rows</a></div><div class="ttdeci">uint8_t _rows</div><div class="ttdoc">the number of trellis boards in the Y direction </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.h:89</div></div>
 <div class="ttc" id="class_adafruit___multi_trellis_html"><div class="ttname"><a href="class_adafruit___multi_trellis.html">Adafruit_MultiTrellis</a></div><div class="ttdoc">Class that stores state and functions for interacting with multiple neotrellis boards. </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.h:66</div></div>
 <div class="ttc" id="class_adafruit___neo_trellis_html_a01565a0de17f406931a1c27f96b4f4ac"><div class="ttname"><a href="class_adafruit___neo_trellis.html#a01565a0de17f406931a1c27f96b4f4ac">Adafruit_NeoTrellis::unregisterCallback</a></div><div class="ttdeci">void unregisterCallback(uint8_t key)</div><div class="ttdoc">unregister a callback on a given key </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.cpp:62</div></div>
-<div class="ttc" id="class_adafruit__seesaw_html"><div class="ttname"><a href="class_adafruit__seesaw.html">Adafruit_seesaw</a></div><div class="ttdoc">Class that stores state and functions for interacting with seesaw helper IC. </div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:251</div></div>
+<div class="ttc" id="class_adafruit__seesaw_html"><div class="ttname"><a href="class_adafruit__seesaw.html">Adafruit_seesaw</a></div><div class="ttdoc">Class that stores state and functions for interacting with seesaw helper IC. </div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:235</div></div>
 <div class="ttc" id="class_adafruit___neo_trellis_html"><div class="ttname"><a href="class_adafruit___neo_trellis.html">Adafruit_NeoTrellis</a></div><div class="ttdoc">Class that stores state and functions for interacting with the seesaw keypad module. </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.h:34</div></div>
 <div class="ttc" id="class_adafruit___neo_trellis_html_a6824e7df55c874663d4e994c4f7e4dc3"><div class="ttname"><a href="class_adafruit___neo_trellis.html#a6824e7df55c874663d4e994c4f7e4dc3">Adafruit_NeoTrellis::_addr</a></div><div class="ttdeci">uint8_t _addr</div><div class="ttdoc">the I2C address of this board </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.h:55</div></div>
 <div class="ttc" id="class_adafruit___multi_trellis_html_a614833ca4351f5e5b82b21148d1ff8cc"><div class="ttname"><a href="class_adafruit___multi_trellis.html#a614833ca4351f5e5b82b21148d1ff8cc">Adafruit_MultiTrellis::_cols</a></div><div class="ttdeci">uint8_t _cols</div><div class="ttdoc">the number of trellis boards in the X direction </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.h:90</div></div>
 <div class="ttc" id="class_adafruit___neo_trellis_html_a6eb9cc3f68a794278670387b0deed2e2"><div class="ttname"><a href="class_adafruit___neo_trellis.html#a6eb9cc3f68a794278670387b0deed2e2">Adafruit_NeoTrellis::activateKey</a></div><div class="ttdeci">void activateKey(uint8_t key, uint8_t edge, bool enable=true)</div><div class="ttdoc">activate or deactivate a given key event </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.cpp:74</div></div>
 <div class="ttc" id="class_adafruit___neo_trellis_html_a58512ca86c0cb84a9f9869cb447d7ba4"><div class="ttname"><a href="class_adafruit___neo_trellis.html#a58512ca86c0cb84a9f9869cb447d7ba4">Adafruit_NeoTrellis::read</a></div><div class="ttdeci">void read(bool polling=true)</div><div class="ttdoc">read all events currently stored in the seesaw fifo and call any callbacks. </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.cpp:86</div></div>
-<div class="ttc" id="unionkey_event_html"><div class="ttname"><a href="unionkey_event.html">keyEvent</a></div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:228</div></div>
+<div class="ttc" id="unionkey_event_html"><div class="ttname"><a href="unionkey_event.html">keyEvent</a></div><div class="ttdef"><b>Definition:</b> Adafruit_seesaw.h:212</div></div>
 <div class="ttc" id="_adafruit__seesaw_8h_html"><div class="ttname"><a href="_adafruit__seesaw_8h.html">Adafruit_seesaw.h</a></div></div>
 <div class="ttc" id="class_adafruit___multi_trellis_html_af286425c8edc2dce010b67d73c39054e"><div class="ttname"><a href="class_adafruit___multi_trellis.html#af286425c8edc2dce010b67d73c39054e">Adafruit_MultiTrellis::_trelli</a></div><div class="ttdeci">Adafruit_NeoTrellis * _trelli</div><div class="ttdoc">a multidimensional array of neotrellis objects </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.h:92</div></div>
 <div class="ttc" id="class_adafruit___neo_trellis_html_a221b9b02e195641f518972bfe04d35a2"><div class="ttname"><a href="class_adafruit___neo_trellis.html#a221b9b02e195641f518972bfe04d35a2">Adafruit_NeoTrellis::_callbacks</a></div><div class="ttdeci">TrellisCallback(* _callbacks[NEO_TRELLIS_NUM_KEYS])(keyEvent)</div><div class="ttdoc">the array of callback functions </div><div class="ttdef"><b>Definition:</b> Adafruit_NeoTrellis.h:56</div></div>