lauchmelder/b15f-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

move documentation to docs folder

Browse source
This commit is contained in:
Robert 2022-12-19 14:23:57 +01:00
parent 3c8b790e7f
commit c3a9f96b10
67 changed files with 208 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/src/b15f/assert.rs.html Normal file
View file

@ -0,0 +1,19 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/assert.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>assert.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../b15f/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
</pre><pre class="rust"><code><span class="kw">struct </span>AssertInRange&lt;<span class="kw">const </span>VALUE: usize, <span class="kw">const </span>MIN: usize, <span class="kw">const </span>MAX: usize&gt;;
<span class="kw">impl</span>&lt;<span class="kw">const </span>VALUE: usize, <span class="kw">const </span>MIN: usize, <span class="kw">const </span>MAX: usize&gt; AssertInRange&lt;VALUE, MIN, MAX&gt; {
<span class="kw">const </span>OK: () = <span class="macro">assert!</span>(MIN &lt;= VALUE &amp;&amp; VALUE &lt;= MAX);
}
<span class="kw">pub fn </span>assert_in_range&lt;<span class="kw">const </span>VALUE: usize, <span class="kw">const </span>MIN: usize, <span class="kw">const </span>MAX: usize&gt; () {
<span class="kw">let </span>() = AssertInRange::&lt;VALUE, MIN, MAX&gt;::OK;
}</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="b15f" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html>

865
docs/src/b15f/b15f.rs.html Normal file
View file

@ -0,0 +1,865 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/b15f.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>b15f.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../b15f/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
</pre><pre class="rust"><code><span class="doccomment">//! This module contains all the structures and functions related to
//! interacting with the B15 on a high level. If you are writing code
//! for the B15, this is the module you want to use.
</span><span class="kw">use </span>std::{process::Command, time::Duration, fmt::Debug, thread::sleep};
<span class="kw">use </span>rand::Rng;
<span class="kw">use </span>serialport::SerialPort;
<span class="kw">use crate</span>::{assert::assert_in_range, error::Error, request::Request, usart::read_sized, build_request};
<span class="macro">macro_rules! </span>log {
(<span class="macro-nonterminal">$text</span>: literal, $(<span class="macro-nonterminal">$arg</span>:tt)<span class="kw-2">*</span>) =&gt; (<span class="macro">println!</span>(<span class="macro">concat!</span>(<span class="string">&quot;[B15F] &quot;</span>, <span class="macro-nonterminal">$text</span>), $(<span class="macro-nonterminal">$arg</span>)<span class="kw-2">*</span>));
(<span class="macro-nonterminal">$text</span>: literal) =&gt; (<span class="macro">println!</span>(<span class="macro">concat!</span>(<span class="string">&quot;[B15F] &quot;</span>, <span class="macro-nonterminal">$text</span>)));
}
<span class="macro">macro_rules! </span>log_start {
(<span class="macro-nonterminal">$text</span>: literal, $(<span class="macro-nonterminal">$arg</span>:tt)<span class="kw-2">*</span>) =&gt; (<span class="macro">print!</span>(<span class="macro">concat!</span>(<span class="string">&quot;[B15F] &quot;</span>, <span class="macro-nonterminal">$text</span>, <span class="string">&quot;... &quot;</span>), $(<span class="macro-nonterminal">$arg</span>)<span class="kw-2">*</span>));
(<span class="macro-nonterminal">$text</span>: literal) =&gt; (<span class="macro">print!</span>(<span class="macro">concat!</span>(<span class="string">&quot;[B15F] &quot;</span>, <span class="macro-nonterminal">$text</span>, <span class="string">&quot;... &quot;</span>)));
}
<span class="macro">macro_rules! </span>log_end {
(<span class="macro-nonterminal">$text</span>: literal, $(<span class="macro-nonterminal">$arg</span>:tt)<span class="kw-2">*</span>) =&gt; (<span class="macro">println!</span>(<span class="macro-nonterminal">$text</span>, $(<span class="macro-nonterminal">$arg</span>)<span class="kw-2">*</span>));
(<span class="macro-nonterminal">$text</span>: literal) =&gt; (<span class="macro">println!</span>(<span class="macro-nonterminal">$text</span>));
}
<span class="doccomment">/// Structure representing the driver for the board 15
</span><span class="kw">pub struct </span>B15F {
usart: Box&lt;<span class="kw">dyn </span>SerialPort&gt;
}
<span class="kw">impl </span>B15F {
<span class="kw">const </span>MSG_OK: u8 = <span class="number">0xFF</span>;
<span class="doccomment">/// Creates a new instance of the B15
///
/// This function will establish a connection to a connected B15 and return
/// a handle to interact with it. Only one such instance should exist per
/// program; calling `B15F::new()` more than once might lead to unexpected
/// behaviour.
///
/// # Returns
/// A new B15F object is returned. It contains an already active USART connection,
/// so calling this function multiple times will create an Error
///
/// # Errors
/// An `error::Error` is generated if the connection to the board cannot be
/// established, or if testing of that connection fails.
///
/// # Examples
/// ```
/// use b15f::B15F;
///
/// let drv = B15F::new().unwrap();
/// ```
</span><span class="kw">pub fn </span>new() -&gt; <span class="prelude-ty">Result</span>&lt;B15F, Error&gt; {
<span class="kw">let </span>port = B15F::init_connection()<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>drv =B15F {
usart: port
};
<span class="macro">log_start!</span>(<span class="string">&quot;Testing connection&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>tries = <span class="number">3</span>;
<span class="kw">while </span>tries &gt; <span class="number">0 </span>{
drv.discard()<span class="question-mark">?</span>;
<span class="kw">match </span>drv.test_connection() {
<span class="prelude-val">Ok</span>(()) =&gt; <span class="kw">break</span>,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; {} <span class="comment">// Do nothing
</span>};
<span class="kw">match </span>drv.test_int_conv() {
<span class="prelude-val">Ok</span>(()) =&gt; <span class="kw">break</span>,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; {}
}
tries -= <span class="number">1</span>;
}
<span class="kw">if </span>tries == <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="string">&quot;Connection test failed. Are you using the newest version?&quot;</span>.into());
}
<span class="macro">log_end!</span>(<span class="string">&quot;Ok!&quot;</span>);
<span class="kw">let </span>info = drv.get_board_info()<span class="question-mark">?</span>;
<span class="macro">log!</span>(<span class="string">&quot;AVR firmware version: {} built at {} ({})&quot;</span>, info[<span class="number">0</span>], info[<span class="number">1</span>], info[<span class="number">2</span>]);
<span class="comment">// let avr_commit_hash = info[3];
// if avr_commit_hash != COMMIT_HASH {
// log!(&quot;Different commit hashes: {} vs {}&quot;, avr_commit_hash, COMMIT_HASH);
// return Err(&quot;Versions incompatible. Please update the software!&quot;.into());
// }
</span><span class="prelude-val">Ok</span>(drv)
}
<span class="kw">fn </span>init_connection() -&gt; <span class="prelude-ty">Result</span>&lt;Box&lt;<span class="kw">dyn </span>SerialPort&gt;, Error&gt; {
<span class="kw">let </span>devices = B15F::get_devices();
<span class="kw">let </span>device = <span class="kw">match </span>devices.first() {
<span class="prelude-val">Some</span>(item) =&gt; item,
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="string">&quot;Failed to find adapter&quot;</span>.into())
};
<span class="macro">log!</span>(<span class="string">&quot;Using adapter: {}&quot;</span>, device);
<span class="macro">log_start!</span>(<span class="string">&quot;Establish connection with adapter&quot;</span>);
<span class="kw">let </span>port = serialport::new(device, <span class="number">57_600</span>)
.timeout(Duration::from_millis(<span class="number">1000</span>))
.open()<span class="question-mark">?</span>;
<span class="macro">log_end!</span>(<span class="string">&quot;Ok!&quot;</span>);
<span class="prelude-val">Ok</span>(port)
}
<span class="doccomment">/// Tries to reestablish a connection to the B15
</span><span class="kw">pub fn </span>reconnect(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">let </span>tries = <span class="number">3</span>;
<span class="kw">while </span>tries &gt; <span class="number">0 </span>{
sleep(Duration::from_millis(<span class="number">64</span>));
<span class="self">self</span>.discard()<span class="question-mark">?</span>;
<span class="kw">match </span><span class="self">self</span>.test_connection() {
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="kw">return </span><span class="prelude-val">Ok</span>(()),
<span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; { }
};
}
<span class="prelude-val">Err</span>(<span class="string">&quot;Connection could not be repaired&quot;</span>.into())
}
<span class="doccomment">/// Enables the self test mode of the B15
///
/// IMPORTANT: Nothing must be connected to the B15 during this self check
/// routine.
///
/// # Errors
/// This function returns an `error::Error` when communication with
/// the board or the self check fails.
</span><span class="kw">pub fn </span>self_test(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>(Request::SelfTest))<span class="question-mark">?</span>;
<span class="kw">let </span>aw = read_sized::&lt;<span class="number">1</span>&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>.usart)<span class="question-mark">?</span>;
<span class="kw">if </span>aw[<span class="number">0</span>] != B15F::MSG_OK {
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="string">&quot;Self test failed&quot;</span>.into())
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Sets the value of the specified port
///
/// # Errors
/// `PORT` can either be 0 or 1, other values will cause a compile-time
/// error. Otherwise an `error::Error` is generated if communication
/// with the B15 fails.
///
/// # Examples
/// ```
/// use b15f::B15F;
///
/// fn main() -&gt; Result&lt;(), String&gt; {
/// let mut drv = B15F::new()?;
///
/// drv.digital_write::&lt;0&gt;(0xFF)?; // Turn on all bits of port 0
/// drv.digital_write::&lt;1&gt;(0x0F)?; // Turn on bits 0-4 of port 1
///
/// // drv.digital_write::&lt;2&gt;(0xFF); // Compiler error
///
/// Ok(())
/// }
/// ```
///
</span><span class="kw">pub fn </span>digital_write&lt;<span class="kw">const </span>PORT: usize&gt; (<span class="kw-2">&amp;mut </span><span class="self">self</span>, value: u8) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
assert_in_range::&lt;PORT, <span class="number">0</span>, <span class="number">1</span>&gt;();
<span class="kw">let </span>reversed = value.reverse_bits();
<span class="kw">let </span>request = <span class="kw">match </span>PORT {
<span class="number">0 </span>=&gt; Request::DigitalWrite0,
<span class="number">1 </span>=&gt; Request::DigitalWrite1,
<span class="kw">_ </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;Report this issue to someone, this should not ever be visible.&quot;</span>)
};
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>[request, reversed])<span class="question-mark">?</span>;
<span class="kw">let </span>aw = read_sized::&lt;<span class="number">1</span>&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>.usart)<span class="question-mark">?</span>;
<span class="kw">if </span>aw[<span class="number">0</span>] != B15F::MSG_OK {
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">&quot;Setting Port {} failed&quot;</span>, PORT).into());
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Reads the value of the specified port
///
/// # Errors
/// `PORT` can either be 0 or 1, other values will cause a compile-time
/// error. Otherwise an `error::Error` is generated if communication
/// with the B15 fails.
///
/// # Examples
/// ```
/// use b15f::B15F;
///
/// fn main() -&gt; Result&lt;(), String&gt; {
/// let mut drv = B15F::new()?;
///
/// let _ = drv.digital_read::&lt;0&gt;()?; // Read inputs of port 0
/// let _ = drv.digital_read::&lt;1&gt;()?; // Read inputs of port 1
///
/// // drv.digital_read::&lt;2&gt;(); // Compiler error
///
/// Ok(())
/// }
/// ```
///
</span><span class="kw">pub fn </span>digital_read&lt;<span class="kw">const </span>PORT: usize&gt; (<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;u8, Error&gt; {
assert_in_range::&lt;PORT, <span class="number">0</span>, <span class="number">1</span>&gt;();
<span class="kw">let </span>request = <span class="kw">match </span>PORT {
<span class="number">0 </span>=&gt; Request::DigitalRead0,
<span class="number">1 </span>=&gt; Request::DigitalRead1,
<span class="kw">_ </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;Report this issue to someone, this should not ever be visible.&quot;</span>)
};
<span class="self">self</span>.usart.clear(serialport::ClearBuffer::Input)<span class="question-mark">?</span>;
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>[request])<span class="question-mark">?</span>;
<span class="kw">let </span>aw = read_sized::&lt;<span class="number">1</span>&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>.usart)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(u8::reverse_bits(aw[<span class="number">0</span>]))
}
<span class="doccomment">/// Reads the value of the DIP switch (S7)
///
/// # Returns
/// A bitfield representing the value of all 8 DIP switches. The least
/// significant bit represents switch 1.
///
/// # Errors
/// When communication with the board fails an `error::Error` is returned.
///
/// # Example
/// ```
/// use b15f::B15F;
///
/// fn main() -&gt; Result&lt;(), String&gt; {
/// let mut drv = B15F::new()?;
///
/// println!(&quot;{}&quot;, drv.read_dip_switch()?);
///
/// Ok(())
/// }
/// ```
</span><span class="kw">pub fn </span>read_dip_switch(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;u8, Error&gt; {
<span class="self">self</span>.usart.clear(serialport::ClearBuffer::Input)<span class="question-mark">?</span>;
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>(Request::ReadDipSwitch))<span class="question-mark">?</span>;
<span class="kw">let </span>aw = read_sized::&lt;<span class="number">1</span>&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>.usart)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(aw[<span class="number">0</span>].reverse_bits())
}
<span class="doccomment">/// Yields information about the installed firmware on the B15
///
/// Returns an array of strings, where each string contains a piece
/// of information stored on the B15
///
/// # Returns
/// A list of strings where each string contains a piece of information
/// about the board. What string contains what information is determined,
/// but not explicitly listed.
///
/// # Errors
/// An `error::Error` is generated if the communication with the board fails.
///
/// # Examples
/// ```
/// use b15f::B15F;
///
/// let mut drv = B15F::new().unwrap();
///
/// // Print each bit of information on a new line
/// drv.get_board_info()
/// .unwrap()
/// .iter()
/// .for_each(|info| println!(&quot;{info}&quot;));
/// ```
</span><span class="kw">pub fn </span>get_board_info(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;String&gt;, Error&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>info: Vec&lt;String&gt; = <span class="macro">vec!</span>[];
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>(Request::Info))<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>data_count: [u8; <span class="number">1</span>] = [<span class="number">0</span>;<span class="number">1</span>];
<span class="self">self</span>.usart.read(<span class="kw-2">&amp;mut </span>data_count)<span class="question-mark">?</span>;
<span class="kw">while </span>data_count[<span class="number">0</span>] &gt; <span class="number">0 </span>{
<span class="kw">let </span><span class="kw-2">mut </span>len: [u8; <span class="number">1</span>] = [<span class="number">0</span>;<span class="number">1</span>];
<span class="self">self</span>.usart.read(<span class="kw-2">&amp;mut </span>len)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>data: Vec&lt;u8&gt; = <span class="macro">vec!</span>[<span class="number">0</span>; len[<span class="number">0</span>] <span class="kw">as </span>usize];
<span class="self">self</span>.usart.read(data.as_mut_slice())<span class="question-mark">?</span>;
info.push(
data.into_iter()
.map(|c| char::from(c))
.collect::&lt;String&gt;()
);
sleep(Duration::from_millis(<span class="number">4</span>)); <span class="comment">// Add delay to give the board time to catch up with our requests
</span>data_count[<span class="number">0</span>] -= <span class="number">1</span>;
}
<span class="kw">let </span>aw = read_sized::&lt;<span class="number">1</span>&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>.usart)<span class="question-mark">?</span>;
<span class="kw">if </span>aw[<span class="number">0</span>] != B15F::MSG_OK {
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">&quot;Board info is faulty: code {}&quot;</span>, aw[<span class="number">0</span>]).into());
}
<span class="prelude-val">Ok</span>(info)
}
<span class="doccomment">/// Clears data in the USART buffers on this device and on the B15
</span><span class="kw">pub fn </span>discard(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="self">self</span>.usart.clear(serialport::ClearBuffer::Output)<span class="question-mark">?</span>;
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">16 </span>{
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>[Request::Discard])<span class="question-mark">?</span>;
sleep(Duration::from_millis(<span class="number">4</span>));
}
<span class="self">self</span>.usart.clear(serialport::ClearBuffer::Input)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Test the integer conversion of the USART connection
///
/// # Errors
/// If an error occurs in the conversion or the communication with the
/// board, an `error::Error` will be returned.
</span><span class="kw">pub fn </span>test_int_conv(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">let </span>dummy: u16 = rand::thread_rng().gen_range(<span class="number">0x0000</span>..=(<span class="number">0xFFFF </span>/ <span class="number">3</span>));
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>(Request::IntTest, dummy &amp; <span class="number">0xFF</span>, dummy &gt;&gt; <span class="number">8</span>))<span class="question-mark">?</span>;
<span class="kw">let </span>aw = read_sized::&lt;<span class="number">2</span>&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>.usart)<span class="question-mark">?</span>;
<span class="kw">let </span>result = u16::from_le_bytes(aw);
<span class="kw">if </span>result != dummy * <span class="number">3 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="string">&quot;Int conversion failed&quot;</span>.into());
}
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Tests the connetion to the B15
///
/// To test the connection a `Request::Test` request will be sent
/// to the board together with a randomly generated value. If the
/// board returns that value the connection is working correctly.
///
/// # Errors
/// An `error::Error` is returned if the test fails, or if the
/// communication itself fails.
///
/// # Examples
/// ```
/// use b15f::B15F;
///
/// fn main() {
/// let mut drv = B15F::new().unwrap();
///
/// if let Err(err) = drv.test_connection() {
/// panic!(&quot;Connection is not working: {err}&quot;);
/// }
/// }
/// ```
</span><span class="kw">pub fn </span>test_connection(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="kw">let </span>dummy: u8 = rand::thread_rng().gen_range(<span class="number">0x00</span>..=<span class="number">0xFF</span>);
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>[Request::Test, dummy])<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>buffer: [u8; <span class="number">2</span>]= [<span class="number">0</span>; <span class="number">2</span>];
<span class="self">self</span>.usart.read(<span class="kw-2">&amp;mut </span>buffer)<span class="question-mark">?</span>;
<span class="kw">if </span>buffer[<span class="number">0</span>] != B15F::MSG_OK || buffer[<span class="number">1</span>] != dummy {
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="string">&quot;Test request failed&quot;</span>.into());
}
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[cfg(any(target_arch = <span class="string">&quot;arm&quot;</span>, target_arch = <span class="string">&quot;aarch64&quot;</span>))]
</span><span class="kw">fn </span>get_devices() -&gt; Vec&lt;String&gt; {
<span class="kw">let </span>output = Command::new(<span class="string">&quot;bash&quot;</span>)
.args([<span class="string">&quot;-c&quot;</span>, <span class="string">&quot;ls /dev/ttyAMA*&quot;</span>])
.output()
.expect(<span class="string">&quot;Failed to get serial interface&quot;</span>);
String::from_utf8(output.stdout)
.expect(<span class="string">&quot;Failed to convert stdout to string&quot;</span>)
.split_ascii_whitespace()
.map(|item| item.into())
.collect()
}
<span class="attribute">#[cfg(not(target_arch = <span class="string">&quot;arm&quot;</span>))]
#[cfg(not(target_arch = <span class="string">&quot;aarch64&quot;</span>))]
</span><span class="kw">fn </span>get_devices() -&gt; Vec&lt;String&gt; {
<span class="kw">let </span>output = Command::new(<span class="string">&quot;bash&quot;</span>)
.args([<span class="string">&quot;-c&quot;</span>, <span class="string">&quot;ls /dev/ttyUSB*&quot;</span>])
.output()
.expect(<span class="string">&quot;Failed to get serial interface&quot;</span>);
String::from_utf8(output.stdout)
.expect(<span class="string">&quot;Failed to convert stdout to string&quot;</span>)
.split_ascii_whitespace()
.map(|item| item.into())
.collect()
}
}
<span class="kw">impl </span>Debug <span class="kw">for </span>B15F {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>std::fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; std::fmt::Result {
<span class="macro">writeln!</span>(f, <span class="string">&quot;Baudrate: {}&quot;</span>, <span class="self">self</span>.usart.baud_rate().unwrap())<span class="question-mark">?</span>;
<span class="macro">writeln!</span>(f, <span class="string">&quot;Data bits: {:?}&quot;</span>, <span class="self">self</span>.usart.data_bits().unwrap())<span class="question-mark">?</span>;
<span class="macro">writeln!</span>(f, <span class="string">&quot;Parity: {:?}&quot;</span>, <span class="self">self</span>.usart.parity().unwrap())
}
}</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="b15f" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html>

97
docs/src/b15f/error.rs.html Normal file
View file

@ -0,0 +1,97 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../b15f/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt::Display;
<span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Error {
message: String
}
<span class="kw">impl </span>Error {
<span class="kw">pub fn </span>new(what: <span class="kw-2">&amp;</span>str) -&gt; Error {
Error { message: String::from(what) }
}
}
<span class="kw">impl </span>From&lt;std::io::Error&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: std::io::Error) -&gt; <span class="self">Self </span>{
Error { message: err.to_string() }
}
}
<span class="kw">impl </span>From&lt;serialport::Error&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(err: serialport::Error) -&gt; <span class="self">Self </span>{
Error { message: err.to_string() }
}
}
<span class="kw">impl </span>From&lt;<span class="kw-2">&amp;</span>str&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(msg: <span class="kw-2">&amp;</span>str) -&gt; <span class="self">Self </span>{
Error::new(msg)
}
}
<span class="kw">impl </span>From&lt;String&gt; <span class="kw">for </span>Error {
<span class="kw">fn </span>from(msg: String) -&gt; <span class="self">Self </span>{
Error { message: msg }
}
}
<span class="kw">impl </span>From&lt;Error&gt; <span class="kw">for </span>String {
<span class="kw">fn </span>from(err: Error) -&gt; <span class="self">Self </span>{
err.message
}
}
<span class="kw">impl </span>Display <span class="kw">for </span>Error {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>std::fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; std::fmt::Result {
<span class="macro">write!</span>(f, <span class="string">&quot;{}&quot;</span>, <span class="self">self</span>.message)
}
}</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="b15f" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html>

43
docs/src/b15f/lib.rs.html Normal file
View file

@ -0,0 +1,43 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../b15f/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
</pre><pre class="rust"><code><span class="attribute">#![deny(missing_docs,
missing_debug_implementations,
trivial_casts,
unstable_features,
unused_import_braces, unused_qualifications)]
</span><span class="doccomment">//! Driver code for the board 15
//!
//! It aims to be syntactically similar to the [`original`] implementation.
//! The original repository is no longer maintained, and this library doesn&#39;t maintain it either,
//! it simply provides the same functionality in another language.
//!
//! [`original`]: https://github.com/devfix/b15f
</span><span class="kw">pub mod </span>b15f;
<span class="kw">mod </span>usart;
<span class="kw">mod </span>request;
<span class="kw">mod </span>error;
<span class="kw">mod </span>assert;
<span class="kw">pub use </span><span class="kw">crate</span>::b15f::B15F;</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="b15f" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html>

61
docs/src/b15f/request.rs.html Normal file
View file

@ -0,0 +1,61 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/request.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>request.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../b15f/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
</pre><pre class="rust"><code><span class="doccomment">//! This module contains the request data used to communicate
//! with the B15 via USART.
//!
//! Using a direct USART connection to the B15 is discouraged,
//! if you are trying to interact with the B15 consider using
//! the `b15f::B15F` structure instead.
</span><span class="comment">// TODO: There should be a more elegant way to do this
</span><span class="attribute">#[macro_export]
</span><span class="doccomment">/// Builds a new request buffer from the given data
</span><span class="macro">macro_rules! </span>build_request {
[$(<span class="macro-nonterminal">$x</span>:expr),<span class="kw-2">*</span>] =&gt; (
<span class="kw-2">&amp;</span>[$(<span class="macro-nonterminal">$x </span><span class="kw">as </span>u8),<span class="kw-2">*</span>]
);
}
<span class="attribute">#[repr(u8)]
</span><span class="kw">pub enum </span>Request {
Discard = <span class="number">0</span>,
Test = <span class="number">1</span>,
Info = <span class="number">2</span>,
IntTest = <span class="number">3</span>,
SelfTest = <span class="number">4</span>,
DigitalWrite0 = <span class="number">5</span>,
DigitalWrite1 = <span class="number">6</span>,
DigitalRead0 = <span class="number">7</span>,
DigitalRead1 = <span class="number">8</span>,
ReadDipSwitch = <span class="number">9
</span>}</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="b15f" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html>

19
docs/src/b15f/usart.rs.html Normal file
View file

@ -0,0 +1,19 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/usart.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>usart.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../b15f/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
</pre><pre class="rust"><code><span class="kw">use </span>serialport::SerialPort;
<span class="kw">use </span><span class="kw">crate</span>::error::Error;
<span class="kw">pub fn </span>read_sized&lt;<span class="kw">const </span>N: usize&gt; (usart: <span class="kw-2">&amp;mut </span>Box&lt;<span class="kw">dyn </span>SerialPort&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;[u8; N], Error&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>buf: [u8; N] = [<span class="number">0</span>; N];
usart.read(<span class="kw-2">&amp;mut </span>buf)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(buf)
}</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="b15f" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0 (69f9c33d7 2022-12-12)" ></div></body></html>