Skip to content

Commit b9fe090

Browse files
pschatzmannpschatzmann
committed
Deploying to doxygen from @ be4676e 🚀
1 parent 610bd98 commit b9fe090

File tree

2 files changed

+128
-126
lines changed

2 files changed

+128
-126
lines changed

‎_hardware_setup_r_p_i_8h_source.html‎

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -123,44 +123,45 @@
123123
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
124124
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// define the global hardware interfaces</span></div>
125125
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">if</span> (<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">asDefault</a>) {</div>
126-
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <a class="code hl_variable" href="namespacearduino.html#a67230408a4be8e454f3947313e30c0e1">GPIO</a>.<a class="code hl_function" href="classarduino_1_1_g_p_i_o_wrapper.html#a4fbb67aaa1e606e6eadf23f4723f01a2">setGPIO</a>(&amp;gpio);</div>
127-
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <a class="code hl_variable" href="namespacearduino.html#a5cdbe44f12b33daea39c70b62a63fc66">SPI</a>.<a class="code hl_function" href="classarduino_1_1_s_p_i_wrapper.html#aa32e071cd4ff470892e3f22ad41fd189">setSPI</a>(&amp;spi);</div>
128-
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_variable" href="namespacearduino.html#a438e0b6e21770efe4a3aba702b818c4d">Wire</a>.<a class="code hl_function" href="classarduino_1_1_i2_c_wrapper.html#af31b2f00dffd4f062d23fce42c1c2678">setI2C</a>(&amp;i2c);</div>
129-
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> }</div>
130-
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
131-
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> gpio &amp;&amp; i2c &amp;&amp; spi;</div>
132-
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> }</div>
126+
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> Logger.warning(<span class="stringliteral">&quot;GPIO, I2C, SPI set up for Raspberry Pi&quot;</span>);</div>
127+
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <a class="code hl_variable" href="namespacearduino.html#a67230408a4be8e454f3947313e30c0e1">GPIO</a>.<a class="code hl_function" href="classarduino_1_1_g_p_i_o_wrapper.html#a4fbb67aaa1e606e6eadf23f4723f01a2">setGPIO</a>(&amp;gpio);</div>
128+
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_variable" href="namespacearduino.html#a5cdbe44f12b33daea39c70b62a63fc66">SPI</a>.<a class="code hl_function" href="classarduino_1_1_s_p_i_wrapper.html#aa32e071cd4ff470892e3f22ad41fd189">setSPI</a>(&amp;spi);</div>
129+
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_variable" href="namespacearduino.html#a438e0b6e21770efe4a3aba702b818c4d">Wire</a>.<a class="code hl_function" href="classarduino_1_1_i2_c_wrapper.html#af31b2f00dffd4f062d23fce42c1c2678">setI2C</a>(&amp;i2c);</div>
130+
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</div>
131+
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
132+
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">return</span> gpio &amp;&amp; i2c &amp;&amp; spi;</div>
133+
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> }</div>
133134
</div>
134-
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
135-
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
136-
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classarduino_1_1_hardware_setup_r_p_i.html#abccd4a28c7fc70610529e0e84e3972eb"> 65</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classarduino_1_1_hardware_setup_r_p_i.html#abccd4a28c7fc70610529e0e84e3972eb">end</a>() {</div>
137-
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">if</span> (is_default_objects_active) {</div>
138-
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_variable" href="namespacearduino.html#a67230408a4be8e454f3947313e30c0e1">GPIO</a>.<a class="code hl_function" href="classarduino_1_1_g_p_i_o_wrapper.html#a4fbb67aaa1e606e6eadf23f4723f01a2">setGPIO</a>(<span class="keyword">nullptr</span>);</div>
139-
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_variable" href="namespacearduino.html#a5cdbe44f12b33daea39c70b62a63fc66">SPI</a>.<a class="code hl_function" href="classarduino_1_1_s_p_i_wrapper.html#aa32e071cd4ff470892e3f22ad41fd189">setSPI</a>(<span class="keyword">nullptr</span>);</div>
140-
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_variable" href="namespacearduino.html#a438e0b6e21770efe4a3aba702b818c4d">Wire</a>.<a class="code hl_function" href="classarduino_1_1_i2_c_wrapper.html#af31b2f00dffd4f062d23fce42c1c2678">setI2C</a>(<span class="keyword">nullptr</span>);</div>
141-
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
142-
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
135+
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
136+
<div class="foldopen" id="foldopen00066" data-start="{" data-end="}">
137+
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classarduino_1_1_hardware_setup_r_p_i.html#abccd4a28c7fc70610529e0e84e3972eb"> 66</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classarduino_1_1_hardware_setup_r_p_i.html#abccd4a28c7fc70610529e0e84e3972eb">end</a>() {</div>
138+
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">if</span> (is_default_objects_active) {</div>
139+
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <a class="code hl_variable" href="namespacearduino.html#a67230408a4be8e454f3947313e30c0e1">GPIO</a>.<a class="code hl_function" href="classarduino_1_1_g_p_i_o_wrapper.html#a4fbb67aaa1e606e6eadf23f4723f01a2">setGPIO</a>(<span class="keyword">nullptr</span>);</div>
140+
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_variable" href="namespacearduino.html#a5cdbe44f12b33daea39c70b62a63fc66">SPI</a>.<a class="code hl_function" href="classarduino_1_1_s_p_i_wrapper.html#aa32e071cd4ff470892e3f22ad41fd189">setSPI</a>(<span class="keyword">nullptr</span>);</div>
141+
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_variable" href="namespacearduino.html#a438e0b6e21770efe4a3aba702b818c4d">Wire</a>.<a class="code hl_function" href="classarduino_1_1_i2_c_wrapper.html#af31b2f00dffd4f062d23fce42c1c2678">setI2C</a>(<span class="keyword">nullptr</span>);</div>
142+
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
143+
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }</div>
143144
</div>
144-
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
145-
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_class" href="classarduino_1_1_hardware_g_p_i_o___r_p_i.html">HardwareGPIO_RPI</a>* getGPIO() { <span class="keywordflow">return</span> &amp;gpio; }</div>
146-
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> HardwareI2C_RPI* getI2C() { <span class="keywordflow">return</span> &amp;i2c; }</div>
147-
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> HardwareSPI_RPI* getSPI() { <span class="keywordflow">return</span> &amp;spi; }</div>
148-
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
149-
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">protected</span>:</div>
150-
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> HardwareGPIO_RPI gpio;</div>
151-
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> HardwareI2C_RPI i2c;</div>
152-
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> HardwareSPI_RPI spi;</div>
153-
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">bool</span> is_default_objects_active = <span class="keyword">false</span>;</div>
154-
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>};</div>
145+
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
146+
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <a class="code hl_class" href="classarduino_1_1_hardware_g_p_i_o___r_p_i.html">HardwareGPIO_RPI</a>* getGPIO() { <span class="keywordflow">return</span> &amp;gpio; }</div>
147+
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> HardwareI2C_RPI* getI2C() { <span class="keywordflow">return</span> &amp;i2c; }</div>
148+
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> HardwareSPI_RPI* getSPI() { <span class="keywordflow">return</span> &amp;spi; }</div>
149+
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
150+
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">protected</span>:</div>
151+
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> HardwareGPIO_RPI gpio;</div>
152+
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> HardwareI2C_RPI i2c;</div>
153+
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> HardwareSPI_RPI spi;</div>
154+
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">bool</span> is_default_objects_active = <span class="keyword">false</span>;</div>
155+
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>};</div>
155156
</div>
156-
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
157-
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="namespacearduino.html#aaf600ce0d5135956db45dd53f2d9cdab"> 90</a></span><span class="keyword">static</span> <a class="code hl_class" href="classarduino_1_1_hardware_setup_r_p_i.html">HardwareSetupRPI</a> <a class="code hl_variable" href="namespacearduino.html#aaf600ce0d5135956db45dd53f2d9cdab">RPI</a>;</div>
158-
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
159-
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="namespacearduino.html#aa9b5bb779e9660566ebec490609d5d04"> 101</a></span><span class="keyword">static</span> <a class="code hl_class" href="classarduino_1_1_file_stream.html">FileStream</a> <a class="code hl_function" href="namespacearduino.html#aa9b5bb779e9660566ebec490609d5d04">Serial2</a>(<span class="stringliteral">&quot;/dev/serial0&quot;</span>);</div>
160-
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
161-
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>} <span class="comment">// namespace arduino</span></div>
162-
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
163-
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="preprocessor">#endif</span></div>
157+
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
158+
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="namespacearduino.html#aaf600ce0d5135956db45dd53f2d9cdab"> 91</a></span><span class="keyword">static</span> <a class="code hl_class" href="classarduino_1_1_hardware_setup_r_p_i.html">HardwareSetupRPI</a> <a class="code hl_variable" href="namespacearduino.html#aaf600ce0d5135956db45dd53f2d9cdab">RPI</a>;</div>
159+
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
160+
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="namespacearduino.html#aa9b5bb779e9660566ebec490609d5d04"> 102</a></span><span class="keyword">static</span> <a class="code hl_class" href="classarduino_1_1_file_stream.html">FileStream</a> <a class="code hl_function" href="namespacearduino.html#aa9b5bb779e9660566ebec490609d5d04">Serial2</a>(<span class="stringliteral">&quot;/dev/serial0&quot;</span>);</div>
161+
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
162+
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span>} <span class="comment">// namespace arduino</span></div>
163+
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
164+
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="preprocessor">#endif</span></div>
164165
<div class="ttc" id="aclassarduino_1_1_d_m_a_buffer_html"><div class="ttname"><a href="classarduino_1_1_d_m_a_buffer.html">arduino::DMABuffer</a></div><div class="ttdef"><b>Definition</b> DMAPool.h:103</div></div>
165166
<div class="ttc" id="aclassarduino_1_1_file_stream_html"><div class="ttname"><a href="classarduino_1_1_file_stream.html">arduino::FileStream</a></div><div class="ttdoc">We use the FileStream class to be able to provide Serail, Serial1 and Serial2 outside of the Arduino ...</div><div class="ttdef"><b>Definition</b> FileStream.h:30</div></div>
166167
<div class="ttc" id="aclassarduino_1_1_g_p_i_o_source_html"><div class="ttname"><a href="classarduino_1_1_g_p_i_o_source.html">arduino::GPIOSource</a></div><div class="ttdoc">Abstract interface for providing GPIO hardware implementations.</div><div class="ttdef"><b>Definition</b> Sources.h:66</div></div>
@@ -171,7 +172,7 @@
171172
<div class="ttc" id="aclassarduino_1_1_hardware_setup_r_p_i_html_a3b162b1537ba1028d925a4d30a9f06e0"><div class="ttname"><a href="classarduino_1_1_hardware_setup_r_p_i.html#a3b162b1537ba1028d925a4d30a9f06e0">arduino::HardwareSetupRPI::~HardwareSetupRPI</a></div><div class="ttdeci">~HardwareSetupRPI()</div><div class="ttdoc">Destructor. Cleans up hardware interfaces.</div><div class="ttdef"><b>Definition</b> HardwareSetupRPI.h:42</div></div>
172173
<div class="ttc" id="aclassarduino_1_1_hardware_setup_r_p_i_html_a5307755b8fd46e0aaec33ca52c68576b"><div class="ttname"><a href="classarduino_1_1_hardware_setup_r_p_i.html#a5307755b8fd46e0aaec33ca52c68576b">arduino::HardwareSetupRPI::begin</a></div><div class="ttdeci">bool begin(bool asDefault=true)</div><div class="ttdoc">Initializes hardware pointers to Raspberry Pi interfaces.</div><div class="ttdef"><b>Definition</b> HardwareSetupRPI.h:47</div></div>
173174
<div class="ttc" id="aclassarduino_1_1_hardware_setup_r_p_i_html_a681480986b415e7610b539a9425faed1"><div class="ttname"><a href="classarduino_1_1_hardware_setup_r_p_i.html#a681480986b415e7610b539a9425faed1">arduino::HardwareSetupRPI::HardwareSetupRPI</a></div><div class="ttdeci">HardwareSetupRPI()=default</div><div class="ttdoc">Constructor. Initializes hardware interfaces.</div></div>
174-
<div class="ttc" id="aclassarduino_1_1_hardware_setup_r_p_i_html_abccd4a28c7fc70610529e0e84e3972eb"><div class="ttname"><a href="classarduino_1_1_hardware_setup_r_p_i.html#abccd4a28c7fc70610529e0e84e3972eb">arduino::HardwareSetupRPI::end</a></div><div class="ttdeci">void end()</div><div class="ttdoc">Resets hardware pointers to nullptr.</div><div class="ttdef"><b>Definition</b> HardwareSetupRPI.h:65</div></div>
175+
<div class="ttc" id="aclassarduino_1_1_hardware_setup_r_p_i_html_abccd4a28c7fc70610529e0e84e3972eb"><div class="ttname"><a href="classarduino_1_1_hardware_setup_r_p_i.html#abccd4a28c7fc70610529e0e84e3972eb">arduino::HardwareSetupRPI::end</a></div><div class="ttdeci">void end()</div><div class="ttdoc">Resets hardware pointers to nullptr.</div><div class="ttdef"><b>Definition</b> HardwareSetupRPI.h:66</div></div>
175176
<div class="ttc" id="aclassarduino_1_1_i2_c_source_html"><div class="ttname"><a href="classarduino_1_1_i2_c_source.html">arduino::I2CSource</a></div><div class="ttdoc">Abstract interface for providing I2C hardware implementations.</div><div class="ttdef"><b>Definition</b> Sources.h:36</div></div>
176177
<div class="ttc" id="aclassarduino_1_1_i2_c_wrapper_html_af31b2f00dffd4f062d23fce42c1c2678"><div class="ttname"><a href="classarduino_1_1_i2_c_wrapper.html#af31b2f00dffd4f062d23fce42c1c2678">arduino::I2CWrapper::setI2C</a></div><div class="ttdeci">void setI2C(HardwareI2C *i2c)</div><div class="ttdoc">defines the i2c implementation: use nullptr to reset.</div><div class="ttdef"><b>Definition</b> I2CWrapper.h:74</div></div>
177178
<div class="ttc" id="aclassarduino_1_1_s_p_i_source_html"><div class="ttname"><a href="classarduino_1_1_s_p_i_source.html">arduino::SPISource</a></div><div class="ttdoc">Abstract interface for providing SPI hardware implementations.</div><div class="ttdef"><b>Definition</b> Sources.h:51</div></div>
@@ -181,7 +182,7 @@
181182
<div class="ttc" id="anamespacearduino_html_a5cdbe44f12b33daea39c70b62a63fc66"><div class="ttname"><a href="namespacearduino.html#a5cdbe44f12b33daea39c70b62a63fc66">arduino::SPI</a></div><div class="ttdeci">SPIWrapper SPI</div><div class="ttdoc">Global SPI instance used by Arduino API and direct access.</div><div class="ttdef"><b>Definition</b> SPIWrapper.cpp:27</div></div>
182183
<div class="ttc" id="anamespacearduino_html_a67230408a4be8e454f3947313e30c0e1"><div class="ttname"><a href="namespacearduino.html#a67230408a4be8e454f3947313e30c0e1">arduino::GPIO</a></div><div class="ttdeci">GPIOWrapper GPIO</div><div class="ttdoc">Global GPIO instance used by Arduino API functions and direct access.</div><div class="ttdef"><b>Definition</b> GPIOWrapper.cpp:30</div></div>
183184
<div class="ttc" id="anamespacearduino_html_aa9b5bb779e9660566ebec490609d5d04"><div class="ttname"><a href="namespacearduino.html#aa9b5bb779e9660566ebec490609d5d04">arduino::Serial2</a></div><div class="ttdeci">static FileStream Serial2(&quot;/dev/serial0&quot;)</div><div class="ttdoc">Second hardware serial port for Raspberry Pi.</div></div>
184-
<div class="ttc" id="anamespacearduino_html_aaf600ce0d5135956db45dd53f2d9cdab"><div class="ttname"><a href="namespacearduino.html#aaf600ce0d5135956db45dd53f2d9cdab">arduino::RPI</a></div><div class="ttdeci">static HardwareSetupRPI RPI</div><div class="ttdoc">Global instance for Raspberry Pi hardware setup.</div><div class="ttdef"><b>Definition</b> HardwareSetupRPI.h:90</div></div>
185+
<div class="ttc" id="anamespacearduino_html_aaf600ce0d5135956db45dd53f2d9cdab"><div class="ttname"><a href="namespacearduino.html#aaf600ce0d5135956db45dd53f2d9cdab">arduino::RPI</a></div><div class="ttdeci">static HardwareSetupRPI RPI</div><div class="ttdoc">Global instance for Raspberry Pi hardware setup.</div><div class="ttdef"><b>Definition</b> HardwareSetupRPI.h:91</div></div>
185186
</div><!-- fragment --></div><!-- contents -->
186187
<!-- start footer part -->
187188
<hr class="footer"/><address class="footer"><small>

0 commit comments

Comments
 (0)