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

update documentation

Browse source
This commit is contained in:
Robert 2022-12-17 19:22:10 +01:00
parent 5ef5787ded
commit 5e27c5f359
49 changed files with 694 additions and 259 deletions
Download patch file Download diff file Expand all files Collapse all files

432
doc/src/b15f/b15f.rs.html
View file

@ -1,9 +1,4 @@
<!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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../b15f/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../b15f/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../b15f/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<!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>
@ -133,135 +128,360 @@
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
</pre><pre class="rust"><code><span class="doccomment">//! This module contains all the structures and functions related to</span>
<span class="doccomment">//! interacting with the B15 on a high level. If you are writing code</span>
<span class="doccomment">//! for the B15, this is the module you want to use.</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>
</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 class="kw">use</span> <span class="ident">std::process::Command</span>;
</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 </span><span class="kw">crate</span>::error::Error;
<span class="doccomment">/// Hardcoded commit hash of the most recent firmware</span>
<span class="kw">static</span> <span class="ident">COMMIT_HASH</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;bc459c80cec755d7df2c11a807d74e085cbed332&quot;</span>;
<span class="kw">use crate</span>::{request::Request, build_request};
<span class="macro">macro_rules!</span> <span class="ident">log</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>: <span class="ident">literal</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<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">$</span><span class="macro-nonterminal">text</span>), $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>));
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>: <span class="ident">literal</span>) =&gt; (<span class="macro">println!</span>(<span class="macro">concat!</span>(<span class="string">&quot;[B15F] &quot;</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>)));
<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> <span class="ident">log_start</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>: <span class="ident">literal</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<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">$</span><span class="macro-nonterminal">text</span>, <span class="string">&quot;... &quot;</span>), $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>));
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>: <span class="ident">literal</span>) =&gt; (<span class="macro">print!</span>(<span class="macro">concat!</span>(<span class="string">&quot;[B15F] &quot;</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>, <span class="string">&quot;... &quot;</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> <span class="ident">log_end</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>: <span class="ident">literal</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) =&gt; (<span class="macro">println!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>));
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>: <span class="ident">literal</span>) =&gt; (<span class="macro">println!</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</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="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">B15F</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> <span class="ident">B15F</span> {
<span class="doccomment">/// Creates a new instance of the B15</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// This function will establish a connection to a connected B15 and return</span>
<span class="doccomment">/// a handle to interact with it. Only one such instance should exist per</span>
<span class="doccomment">/// program; calling `B15F::new()` more than once might lead to unexpected</span>
<span class="doccomment">/// behaviour.</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use b15f::B15F;</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// let drv = B15F::new().unwrap();</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() -&gt; <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">B15F</span>, <span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">drv</span> <span class="op">=</span> <span class="ident">B15F</span> {};
<span class="ident">drv</span>.<span class="ident">init</span>()
}
<span class="kw">impl </span>B15F {
<span class="kw">const </span>MSG_OK: u8 = <span class="number">0xFF</span>;
<span class="kw">fn</span> <span class="ident">init</span>(<span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">B15F</span>, <span class="kw-2">&amp;</span><span class="lifetime">&#39;static</span> <span class="ident">str</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">devices</span> <span class="op">=</span> <span class="ident">B15F::get_devices</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.
///
/// # 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="ident">device</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">devices</span>.<span class="ident">first</span>() {
<span class="prelude-val">Some</span>(<span class="ident">item</span>) =&gt; <span class="ident">item</span>,
<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>)
<span class="kw">let </span><span class="kw-2">mut </span>drv =B15F {
usart: port
};
<span class="macro">log!</span>(<span class="string">&quot;Using adapter: {}&quot;</span>, <span class="ident">device</span>);
<span class="macro">log_start!</span>(<span class="string">&quot;Establish connection with adapter&quot;</span>);
<span class="macro">todo!</span>(<span class="string">&quot;Implement USART&quot;</span>);
<span class="macro">log_end!</span>(<span class="string">&quot;Ok!&quot;</span>);
<span class="macro">log_start!</span>(<span class="string">&quot;Testing connection&quot;</span>);
<span class="macro">todo!</span>(<span class="string">&quot;Test connection&quot;</span>);
<span class="macro">log_end!</span>(<span class="string">&quot;Ok!&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">let</span> <span class="ident">info</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_board_info</span>();
<span class="macro">log!</span>(<span class="string">&quot;AVR firmware version: {} built at {} ({})&quot;</span>, <span class="ident">info</span>[<span class="number">0</span>], <span class="ident">info</span>[<span class="number">1</span>], <span class="ident">info</span>[<span class="number">2</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">let</span> <span class="ident">avr_commit_hash</span> <span class="op">=</span> <span class="ident">info</span>[<span class="number">3</span>];
<span class="kw">if</span> <span class="ident">avr_commit_hash</span> <span class="op">!</span><span class="op">=</span> <span class="ident">COMMIT_HASH</span> {
<span class="macro">log!</span>(<span class="string">&quot;Different commit hashes: {} vs {}&quot;</span>, <span class="ident">avr_commit_hash</span>, <span class="ident">COMMIT_HASH</span>);
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="string">&quot;Versions incompatible. Please update the software!&quot;</span>);
tries -= <span class="number">1</span>;
}
<span class="prelude-val">Ok</span>(<span class="self">self</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="doccomment">/// Yields information about the installed firmware on the B15</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// Returns an array of strings, where each string contains a piece</span>
<span class="doccomment">/// of information stored on the B15</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use b15f::B15F;</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// let drv = B15F::new().unwrap();</span>
<span class="doccomment">/// </span>
<span class="doccomment">/// // Print each bit of information on a new line</span>
<span class="doccomment">/// drv.get_board_info()</span>
<span class="doccomment">/// .iter()</span>
<span class="doccomment">/// .for_each(|info| println!(&quot;{info}&quot;));</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_board_info</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">Vec</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">str</span><span class="op">&gt;</span> {
<span class="macro">todo!</span>();
<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="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">&quot;arm&quot;</span>, <span class="ident">target_arch</span> <span class="op">=</span> <span class="string">&quot;aarch64&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">get_devices</span>() -&gt; <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">output</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;bash&quot;</span>)
.<span class="ident">args</span>([<span class="string">&quot;-c&quot;</span>, <span class="string">&quot;ls /dev/ttyAMA*&quot;</span>])
.<span class="ident">output</span>()
.<span class="ident">expect</span>(<span class="string">&quot;Failed to get serial interface&quot;</span>);
<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
///
/// # 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="ident">String::from_utf8</span>(<span class="ident">output</span>.<span class="ident">stdout</span>)
.<span class="ident">expect</span>(<span class="string">&quot;Failed to convert stdout to string&quot;</span>)
.<span class="ident">split_ascii_whitespace</span>()
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">item</span><span class="op">|</span> <span class="ident">item</span>.<span class="ident">into</span>())
.<span class="ident">collect</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><span class="kw-2">mut </span>aw: [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>aw)<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="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">&quot;arm&quot;</span>))]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">&quot;aarch64&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">get_devices</span>() -&gt; <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">String</span><span class="op">&gt;</span> {
<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">/// 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.
///
/// ## 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> <span class="ident">output</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">&quot;bash&quot;</span>)
.<span class="ident">args</span>([<span class="string">&quot;-c&quot;</span>, <span class="string">&quot;ls /dev/ttyUSB*&quot;</span>])
.<span class="ident">output</span>()
.<span class="ident">expect</span>(<span class="string">&quot;Failed to get serial interface&quot;</span>);
<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>);
<span class="ident">String::from_utf8</span>(<span class="ident">output</span>.<span class="ident">stdout</span>)
.<span class="ident">expect</span>(<span class="string">&quot;Failed to convert stdout to string&quot;</span>)
.<span class="ident">split_ascii_whitespace</span>()
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">item</span><span class="op">|</span> <span class="ident">item</span>.<span class="ident">into</span>())
.<span class="ident">collect</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><section id="search" class="content hidden"></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.61.0" ></div>
</body></html>
</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>

85
doc/src/b15f/error.rs.html Normal file
View file

@ -0,0 +1,85 @@
<!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>
</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>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>

46
doc/src/b15f/lib.rs.html
View file

@ -1,9 +1,4 @@
<!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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../b15f/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../b15f/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../b15f/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<!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>
@ -20,22 +15,27 @@
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
</pre><pre class="rust"><code><span class="attribute">#![<span class="ident">deny</span>(<span class="ident">missing_docs</span>,
<span class="ident">missing_debug_implementations</span>,
<span class="ident">trivial_casts</span>, <span class="ident">trivial_numeric_casts</span>,
<span class="ident">unsafe_code</span>,
<span class="ident">unstable_features</span>,
<span class="ident">unused_import_braces</span>, <span class="ident">unused_qualifications</span>)]</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
</pre><pre class="rust"><code><span class="attribute">#![deny(missing_docs,
missing_debug_implementations,
trivial_casts,
unsafe_code,
unstable_features,
unused_import_braces, unused_qualifications)]
<span class="doccomment">//! Driver code for the board 15</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! It aims to be syntactically similar to the [`original`] implementation.</span>
<span class="doccomment">//! The original repository is no longer maintained, and this library doesn&#39;t maintain it either,</span>
<span class="doccomment">//! it simply provides the same functionality in another language.</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! [`original`]: https://github.com/devfix/b15f</span>
</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 class="kw">pub</span> <span class="kw">mod</span> <span class="ident">b15f</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::b15f::B15F</span>;</code></pre></div>
</section><section id="search" class="content hidden"></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.61.0" ></div>
</body></html>
</span><span class="kw">pub mod </span>b15f;
<span class="kw">mod </span>request;
<span class="kw">mod </span>error;
<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>

47
doc/src/b15f/request.rs.html Normal file
View file

@ -0,0 +1,47 @@
<!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>
</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>}</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>