267 lines
19 KiB
HTML
267 lines
19 KiB
HTML
<!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">☰</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>
|
||
<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>
|
||
</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 class="kw">use</span> <span class="ident">std::process::Command</span>;
|
||
|
||
<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">&</span><span class="lifetime">'static</span> <span class="ident">str</span> <span class="op">=</span> <span class="string">"bc459c80cec755d7df2c11a807d74e085cbed332"</span>;
|
||
|
||
<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>) => (<span class="macro">println!</span>(<span class="macro">concat!</span>(<span class="string">"[B15F] "</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>) => (<span class="macro">println!</span>(<span class="macro">concat!</span>(<span class="string">"[B15F] "</span>, <span class="macro-nonterminal">$</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>) => (<span class="macro">print!</span>(<span class="macro">concat!</span>(<span class="string">"[B15F] "</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>, <span class="string">"... "</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>) => (<span class="macro">print!</span>(<span class="macro">concat!</span>(<span class="string">"[B15F] "</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">text</span>, <span class="string">"... "</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>) => (<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>) => (<span class="macro">println!</span>(<span class="macro-nonterminal">$</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="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>() -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">B15F</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></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">fn</span> <span class="ident">init</span>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">B15F</span>, <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">devices</span> <span class="op">=</span> <span class="ident">B15F::get_devices</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>) => <span class="ident">item</span>,
|
||
<span class="prelude-val">None</span> => <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="string">"Failed to find adapter"</span>)
|
||
};
|
||
|
||
<span class="macro">log!</span>(<span class="string">"Using adapter: {}"</span>, <span class="ident">device</span>);
|
||
|
||
<span class="macro">log_start!</span>(<span class="string">"Establish connection with adapter"</span>);
|
||
<span class="macro">todo!</span>(<span class="string">"Implement USART"</span>);
|
||
<span class="macro">log_end!</span>(<span class="string">"Ok!"</span>);
|
||
|
||
<span class="macro">log_start!</span>(<span class="string">"Testing connection"</span>);
|
||
<span class="macro">todo!</span>(<span class="string">"Test connection"</span>);
|
||
<span class="macro">log_end!</span>(<span class="string">"Ok!"</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">"AVR firmware version: {} built at {} ({})"</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">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">"Different commit hashes: {} vs {}"</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">"Versions incompatible. Please update the software!"</span>);
|
||
}
|
||
|
||
<span class="prelude-val">Ok</span>(<span class="self">self</span>)
|
||
}
|
||
|
||
<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!("{info}"));</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">&</span><span class="self">self</span>) -> <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||
<span class="macro">todo!</span>();
|
||
}
|
||
|
||
<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">"arm"</span>, <span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"aarch64"</span>))]</span>
|
||
<span class="kw">fn</span> <span class="ident">get_devices</span>() -> <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">output</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"bash"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"-c"</span>, <span class="string">"ls /dev/ttyAMA*"</span>])
|
||
.<span class="ident">output</span>()
|
||
.<span class="ident">expect</span>(<span class="string">"Failed to get serial interface"</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">"Failed to convert stdout to string"</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="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"arm"</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">"aarch64"</span>))]</span>
|
||
<span class="kw">fn</span> <span class="ident">get_devices</span>() -> <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
|
||
|
||
|
||
<span class="kw">let</span> <span class="ident">output</span> <span class="op">=</span> <span class="ident">Command::new</span>(<span class="string">"bash"</span>)
|
||
.<span class="ident">args</span>([<span class="string">"-c"</span>, <span class="string">"ls /dev/ttyUSB*"</span>])
|
||
.<span class="ident">output</span>()
|
||
.<span class="ident">expect</span>(<span class="string">"Failed to get serial interface"</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">"Failed to convert stdout to string"</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>()
|
||
}
|
||
}</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> |