pub struct B15F {}Structure representing the driver for the board 15
+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.
use b15f::B15F;
+
+let drv = B15F::new().unwrap();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
+use b15f::B15F;
+
+let drv = B15F::new().unwrap();
+
+// Print each bit of information on a new line
+drv.get_board_info()
+ .iter()
+ .for_each(|info| println!("{info}"));Mutably borrows from an owned value. Read more
+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’t maintain it either,
+it simply provides the same functionality in another language.
pub use crate::b15f::B15F;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.
+fn:) to \
+ restrict the search to a given item kind.","Accepted kinds are: fn, mod, struct, \
+ enum, trait, type, macro, \
+ and const.","Search functions by type signature (e.g., vec -> usize or \
+ * -> vec)","Search multiple things at once by splitting your query with comma (e.g., \
+ str,u8 or String,struct:Vec,test)","You can look for items with an exact name by putting double quotes around \
+ your request: \"string\"","Look for items inside another one by searching for a path: vec::Vec",].map(function(x){return""+x+"
"}).join("");var div_infos=document.createElement("div");addClass(div_infos,"infos");div_infos.innerHTML="U::from(self).","Creates a new instance of the B15","","",""],"i":[0,0,1,1,1,1,1,1,1,1,1,1],"f":[null,null,[[["",0]],["",0]],[[["",0]],["",0]],[[["",0],["formatter",3]],["result",6]],[[]],[[["",0]],["vec",3,[["str",0]]]],[[]],[[],["result",4,[["b15f",3],["str",0]]]],[[],["result",4]],[[],["result",4]],[[["",0]],["typeid",3]]],"p":[[3,"B15F"]]}\
+}');
+if (window.initSearch) {window.initSearch(searchIndex)};
\ No newline at end of file
diff --git a/doc/search.js b/doc/search.js
new file mode 100644
index 0000000..a8026db
--- /dev/null
+++ b/doc/search.js
@@ -0,0 +1,2 @@
+(function(){var itemTypes=["mod","externcrate","import","struct","enum","fn","type","static","trait","impl","tymethod","method","structfield","variant","macro","primitive","associatedtype","constant","associatedconstant","union","foreigntype","keyword","existential","attr","derive","traitalias",];var TY_PRIMITIVE=itemTypes.indexOf("primitive");var TY_KEYWORD=itemTypes.indexOf("keyword");function printTab(nb){if(nb===0||nb===1||nb===2){searchState.currentTab=nb}var nb_copy=nb;onEachLazy(document.getElementById("titles").childNodes,function(elem){if(nb_copy===0){addClass(elem,"selected")}else{removeClass(elem,"selected")}nb_copy-=1});onEachLazy(document.getElementById("results").childNodes,function(elem){if(nb===0){addClass(elem,"active")}else{removeClass(elem,"active")}nb-=1})}function removeEmptyStringsFromArray(x){for(var i=0,len=x.length;i
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +
//! 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.
+
+use std::process::Command;
+
+/// Hardcoded commit hash of the most recent firmware
+static COMMIT_HASH: &'static str = "bc459c80cec755d7df2c11a807d74e085cbed332";
+
+macro_rules! log {
+ ($text: literal, $($arg:tt)*) => (println!(concat!("[B15F] ", $text), $($arg)*));
+ ($text: literal) => (println!(concat!("[B15F] ", $text)));
+}
+
+macro_rules! log_start {
+ ($text: literal, $($arg:tt)*) => (print!(concat!("[B15F] ", $text, "... "), $($arg)*));
+ ($text: literal) => (print!(concat!("[B15F] ", $text, "... ")));
+}
+
+macro_rules! log_end {
+ ($text: literal, $($arg:tt)*) => (println!($text, $($arg)*));
+ ($text: literal) => (println!($text));
+}
+
+/// Structure representing the driver for the board 15
+#[derive(Debug)]
+pub struct B15F {
+
+}
+
+impl B15F {
+ /// 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();
+ /// ```
+ pub fn new() -> Result<B15F, &'static str> {
+ let drv = B15F {};
+ drv.init()
+ }
+
+ fn init(self) -> Result<B15F, &'static str> {
+ let devices = B15F::get_devices();
+
+ let device = match devices.first() {
+ Some(item) => item,
+ None => return Err("Failed to find adapter")
+ };
+
+ log!("Using adapter: {}", device);
+
+ log_start!("Establish connection with adapter");
+ todo!("Implement USART");
+ log_end!("Ok!");
+
+ log_start!("Testing connection");
+ todo!("Test connection");
+ log_end!("Ok!");
+
+ let info = self.get_board_info();
+ log!("AVR firmware version: {} built at {} ({})", info[0], info[1], info[2]);
+
+ let avr_commit_hash = info[3];
+ if avr_commit_hash != COMMIT_HASH {
+ log!("Different commit hashes: {} vs {}", avr_commit_hash, COMMIT_HASH);
+ return Err("Versions incompatible. Please update the software!");
+ }
+
+ Ok(self)
+ }
+
+ /// 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 drv = B15F::new().unwrap();
+ ///
+ /// // Print each bit of information on a new line
+ /// drv.get_board_info()
+ /// .iter()
+ /// .for_each(|info| println!("{info}"));
+ /// ```
+ pub fn get_board_info(&self) -> Vec<&str> {
+ todo!();
+ }
+
+ #[cfg(any(target_arch = "arm", target_arch = "aarch64"))]
+ fn get_devices() -> Vec<String> {
+ let output = Command::new("bash")
+ .args(["-c", "ls /dev/ttyAMA*"])
+ .output()
+ .expect("Failed to get serial interface");
+
+ String::from_utf8(output.stdout)
+ .expect("Failed to convert stdout to string")
+ .split_ascii_whitespace()
+ .map(|item| item.into())
+ .collect()
+ }
+
+ #[cfg(not(target_arch = "arm"))]
+ #[cfg(not(target_arch = "aarch64"))]
+ fn get_devices() -> Vec<String> {
+
+
+ let output = Command::new("bash")
+ .args(["-c", "ls /dev/ttyUSB*"])
+ .output()
+ .expect("Failed to get serial interface");
+
+ String::from_utf8(output.stdout)
+ .expect("Failed to convert stdout to string")
+ .split_ascii_whitespace()
+ .map(|item| item.into())
+ .collect()
+ }
+}1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +
#![deny(missing_docs,
+ missing_debug_implementations,
+ trivial_casts, trivial_numeric_casts,
+ unsafe_code,
+ unstable_features,
+ unused_import_braces, unused_qualifications)]
+
+//! 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't maintain it either,
+//! it simply provides the same functionality in another language.
+//!
+//! [`original`]: https://github.com/devfix/b15f
+
+pub mod b15f;
+pub use crate::b15f::B15F;