move documentation to docs folder
This commit is contained in:
Robert
parent
3c8b790e7f
commit
c3a9f96b10
11
Makefile
11
Makefile
|
|
@ -8,11 +8,16 @@ bench:
|
|||
cargo bench
|
||||
|
||||
doc:
|
||||
rm -rf doc
|
||||
rm -rf docs
|
||||
rm -rf target/doc
|
||||
cargo doc --no-deps
|
||||
cp -r target/doc .
|
||||
mkdir -p docs
|
||||
cp -r target/doc/* docs
|
||||
echo "Adding index.html"
|
||||
@echo "<!DOCTYPE html>" > docs/index.html
|
||||
@echo "<meta http-equiv='refresh' content='0; URL=b15f/index.html'>" >> docs/index.html
|
||||
@echo "<link rel='canonical' href='b15f/index.html'>" >> docs/index.html
|
||||
|
||||
all: b15f test
|
||||
|
||||
.PHONY: all
|
||||
.PHONY: all
|
||||
|
|
|
|||
|
|
@ -1,5 +0,0 @@
|
|||
var searchIndex = JSON.parse('{\
|
||||
"b15f":{"doc":"Driver code for the board 15","t":[2,0,14,3,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11],"n":["B15F","b15f","build_request","B15F","borrow","borrow_mut","digital_read","digital_write","discard","fmt","from","get_board_info","into","new","test_connection","test_int_conv","try_from","try_into","type_id","vzip"],"q":["b15f","","","b15f::b15f","","","","","","","","","","","","","","","",""],"d":["","This module contains all the structures and functions …","Builds a new request buffer from the given data","Structure representing the driver for the board 15","","","Reads the value of the specified port","Sets the value of the specified port","Clears data in the USART buffers on this device and on the …","","Returns the argument unchanged.","Yields information about the installed firmware on the B15","Calls <code>U::from(self)</code>.","Creates a new instance of the B15","Tests the connetion to the B15","Test the integer conversion of the USART connection","","","",""],"i":[0,0,0,0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1],"f":[0,0,0,0,[[]],[[]],[1,[[3,[2,0]]]],[[1,2],[[3,[0]]]],[1,[[3,[0]]]],[[1,4],5],[[]],[1,[[3,[[7,[6]],0]]]],[[]],[[],[[3,[1,0]]]],[1,[[3,[0]]]],[1,[[3,[0]]]],[[],3],[[],3],[[],8],[[]]],"p":[[3,"B15F"],[15,"u8"],[4,"Result"],[3,"Formatter"],[6,"Result"],[3,"String"],[3,"Vec"],[3,"TypeId"]]}\
|
||||
}');
|
||||
if (typeof window !== 'undefined' && window.initSearch) {window.initSearch(searchIndex)};
|
||||
if (typeof exports !== 'undefined') {exports.searchIndex = searchIndex};
|
||||
|
|
@ -1,4 +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="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."><meta name="keywords" content="rust, rustlang, rust-lang, b15f"><title>b15f::b15f - Rust</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="../../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 mod"><!--[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></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><h2 class="location"><a href="#">Module b15f</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Module <a href="../index.html">b15f</a>::<wbr><a class="mod" href="#">b15f</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/b15f/b15f.rs.html#1-374">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This module contains all the structures and functions related to
|
||||
<!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="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."><meta name="keywords" content="rust, rustlang, rust-lang, b15f"><title>b15f::b15f - Rust</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="../../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 mod"><!--[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></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><h2 class="location"><a href="#">Module b15f</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Module <a href="../index.html">b15f</a>::<wbr><a class="mod" href="#">b15f</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/b15f/b15f.rs.html#1-432">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>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.</p>
|
||||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.B15F.html" title="b15f::b15f::B15F struct">B15F</a></div><div class="item-right docblock-short">Structure representing the driver for the board 15</div></div></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>
|
||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 576 B After Width: | Height: | Size: 576 B |
|
Before Width: | Height: | Size: 510 B After Width: | Height: | Size: 510 B |
|
Before Width: | Height: | Size: 715 B After Width: | Height: | Size: 715 B |
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 4.2 KiB |
3
docs/index.html
Normal file
3
docs/index.html
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
<!DOCTYPE html>
|
||||
<meta http-equiv='refresh' content='0; URL=b15f/index.html'>
|
||||
<link rel='canonical' href='b15f/index.html'>
|
||||
0
doc/normalize.css → docs/normalize.css
vendored
0
doc/normalize.css → docs/normalize.css
vendored
|
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 3.2 KiB |
5
docs/search-index.js
Normal file
5
docs/search-index.js
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
var searchIndex = JSON.parse('{\
|
||||
"b15f":{"doc":"Driver code for the board 15","t":[2,0,14,3,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11],"n":["B15F","b15f","build_request","B15F","borrow","borrow_mut","digital_read","digital_write","discard","fmt","from","get_board_info","into","new","read_dip_switch","reconnect","self_test","test_connection","test_int_conv","try_from","try_into","type_id","vzip"],"q":["b15f","","","b15f::b15f","","","","","","","","","","","","","","","","","","",""],"d":["","This module contains all the structures and functions …","Builds a new request buffer from the given data","Structure representing the driver for the board 15","","","Reads the value of the specified port","Sets the value of the specified port","Clears data in the USART buffers on this device and on the …","","Returns the argument unchanged.","Yields information about the installed firmware on the B15","Calls <code>U::from(self)</code>.","Creates a new instance of the B15","Reads the value of the DIP switch (S7)","Tries to reestablish a connection to the B15","Enables the self test mode of the B15","Tests the connetion to the B15","Test the integer conversion of the USART connection","","","",""],"i":[0,0,0,0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1],"f":[0,0,0,0,[[]],[[]],[1,[[3,[2,0]]]],[[1,2],[[3,[0]]]],[1,[[3,[0]]]],[[1,4],5],[[]],[1,[[3,[[7,[6]],0]]]],[[]],[[],[[3,[1,0]]]],[1,[[3,[2,0]]]],[1,[[3,[0]]]],[1,[[3,[0]]]],[1,[[3,[0]]]],[1,[[3,[0]]]],[[],3],[[],3],[[],8],[[]]],"p":[[3,"B15F"],[15,"u8"],[4,"Result"],[3,"Formatter"],[6,"Result"],[3,"String"],[3,"Vec"],[3,"TypeId"]]}\
|
||||
}');
|
||||
if (typeof window !== 'undefined' && window.initSearch) {window.initSearch(searchIndex)};
|
||||
if (typeof exports !== 'undefined') {exports.searchIndex = searchIndex};
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
var sourcesIndex = JSON.parse('{\
|
||||
"b15f":["",[],["assert.rs","b15f.rs","error.rs","lib.rs","request.rs"]]\
|
||||
"b15f":["",[],["assert.rs","b15f.rs","error.rs","lib.rs","request.rs","usart.rs"]]\
|
||||
}');
|
||||
createSourceSidebar();
|
||||
|
|
@ -372,6 +372,64 @@
|
|||
<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.
|
||||
|
|
@ -380,7 +438,7 @@
|
|||
<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, build_request};
|
||||
<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>) => (<span class="macro">println!</span>(<span class="macro">concat!</span>(<span class="string">"[B15F] "</span>, <span class="macro-nonterminal">$text</span>), $(<span class="macro-nonterminal">$arg</span>)<span class="kw-2">*</span>));
|
||||
|
|
@ -489,6 +547,42 @@
|
|||
<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">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><(), Error> {
|
||||
<span class="kw">let </span>tries = <span class="number">3</span>;
|
||||
<span class="kw">while </span>tries > <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>) => <span class="kw">return </span><span class="prelude-val">Ok</span>(()),
|
||||
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => { }
|
||||
};
|
||||
|
||||
}
|
||||
|
||||
<span class="prelude-val">Err</span>(<span class="string">"Connection could not be repaired"</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">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><(), Error> {
|
||||
<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::<<span class="number">1</span>>(<span class="kw-2">&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">"Self test failed"</span>.into())
|
||||
}
|
||||
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Sets the value of the specified port
|
||||
///
|
||||
/// # Errors
|
||||
|
|
@ -524,9 +618,7 @@
|
|||
|
||||
<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><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">&mut </span>aw)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let </span>aw = read_sized::<<span class="number">1</span>>(<span class="kw-2">&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">"Setting Port {} failed"</span>, PORT).into());
|
||||
}
|
||||
|
|
@ -569,12 +661,39 @@
|
|||
<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><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">&mut </span>aw)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let </span>aw = read_sized::<<span class="number">1</span>>(<span class="kw-2">&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() -> Result<(), String> {
|
||||
/// let mut drv = B15F::new()?;
|
||||
///
|
||||
/// println!("{}", drv.read_dip_switch()?);
|
||||
///
|
||||
/// Ok(())
|
||||
/// }
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>read_dip_switch(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><u8, Error> {
|
||||
<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::<<span class="number">1</span>>(<span class="kw-2">&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
|
||||
|
|
@ -625,9 +744,7 @@
|
|||
</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">&mut </span>aw)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let </span>aw = read_sized::<<span class="number">1</span>>(<span class="kw-2">&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">"Board info is faulty: code {}"</span>, aw[<span class="number">0</span>]).into());
|
||||
}
|
||||
|
|
@ -659,9 +776,8 @@
|
|||
|
||||
<span class="self">self</span>.usart.write(<span class="macro">build_request!</span>(Request::IntTest, dummy & <span class="number">0xFF</span>, dummy >> <span class="number">8</span>))<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>aw: [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">&mut </span>aw)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let </span>aw = read_sized::<<span class="number">2</span>>(<span class="kw-2">&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">"Int conversion failed"</span>.into());
|
||||
|
|
@ -22,7 +22,6 @@
|
|||
</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)]
|
||||
|
||||
|
|
@ -35,6 +34,7 @@
|
|||
//! [`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;
|
||||
|
|
@ -27,6 +27,7 @@
|
|||
<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.
|
||||
//!
|
||||
|
|
@ -50,10 +51,11 @@
|
|||
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
|
||||
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
19
docs/src/b15f/usart.rs.html
Normal 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<<span class="kw">const </span>N: usize> (usart: <span class="kw-2">&mut </span>Box<<span class="kw">dyn </span>SerialPort>) -> <span class="prelude-ty">Result</span><[u8; N], Error> {
|
||||
<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">&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>
|
||||
|
Before Width: | Height: | Size: 174 B After Width: | Height: | Size: 174 B |
|
Before Width: | Height: | Size: 191 B After Width: | Height: | Size: 191 B |
|
Before Width: | Height: | Size: 3.7 KiB After Width: | Height: | Size: 3.7 KiB |
Loading…
Reference in a new issue