fix typos

Author: junjunjd

Cargo.lock

@@ -1,14 +1,14 @@
 [package]
 name = "rustymind"
-version = "0.1.1"
+version = "0.1.2"
 authors = ["Junjun Dong <[email protected]>"]
 edition = "2018"
-description = "A driver, parser and real time plotter for NeuroSky MindWave EGG headset"
+description = "A driver, parser and real time plotter for NeuroSky MindWave EEG headset"
 license-file = "LICENSE.md"
 documentation = "https://docs.rs/rustymind"
 homepage = "https://github.com/junjunjd/rustymind"
 repository = "https://github.com/junjunjd/rustymind"
-keywords = ["brainwave", "neuroscience", "mindwave", "EGG", "NeuroSky"]
+keywords = ["brainwave", "neuroscience", "BCI", "EEG", "NeuroSky"]
 
 [lib]
 name = "rustymind"

Cargo.toml

@@ -3,7 +3,7 @@
 [![crates.io](https://img.shields.io/crates/v/rustymind.svg?style=flat-square)](https://crates.io/crates/rustymind)
 [![api_doc](https://img.shields.io/badge/doc-api-blue)](https://docs.rs/rustymind)
 
-Rustymind is a driver and parser for NeuroSky MindWave EGG headset written in pure Rust. You can use it to connect, interact, and plot real time data from the headset.
+Rustymind is a driver and parser for NeuroSky MindWave EEG headset written in pure Rust. You can use it to connect, interact, and plot real time data from the headset.
 
 The parser is based on the [mindwave mindset communication protocols](./docs) published by NeuroSky.
 
@@ -27,16 +27,16 @@ If you don't pass in the headset ID argument, the dongle will auto-connect to an
 To use `rustymind` as a library, you need to use `connect_headset` function and `Parser` struct. For example:
 
 ```rust
-use rustymind::{connect_headset, PacketType, Parser, HEADSETID_AUTOCONNECT};
+use rustymind::{connect_headset, PacketType, Parser};
 
 let mut port = connect_headset("/dev/tty.usbserial-10000", b"\xa0\x5f")?;
-let mut temp: Vec<u8> = vec![0; 2048];
+let mut buffer: Vec<u8> = vec![0; 2048];
 let mut parser = Parser::new();
 
 loop {
-    let byte_buf = port.read(temp.as_mut_slice()).unwrap();
-    for i in 0..byte_buf {
-        if let Some(x) = parser.parse(temp[i]) {
+    let bytes_read = port.read(buffer.as_mut_slice()).unwrap();
+    for i in 0..bytes_read {
+        if let Some(x) = parser.parse(buffer[i]) {
             for r in x {
                 match r {
                     PacketType::Attention(value) => {
@@ -45,8 +45,8 @@ loop {
                     PacketType::Meditation(value) => {
                         println!("Meditation value = {}", value);
                     }
-                    PacketType::AsicEgg(value) => {
-                        println!("EGG power values = {:?}", value);
+                    PacketType::AsicEeg(value) => {
+                        println!("EEG power values = {:?}", value);
                     }
                     _ => (),
                 }

README.md

@@ -21,7 +21,7 @@ pub enum PacketType {
     Meditation(u8),
     Blink(u8),
     RawValue(i16),
-    AsicEgg(AsicEgg),
+    AsicEeg(AsicEeg),
     PacketUndefined(u8),
 }
 
@@ -33,7 +33,7 @@ pub enum State {
 }
 
 #[derive(PartialEq, Eq, Debug)]
-pub struct AsicEgg {
+pub struct AsicEeg {
     pub delta: u32,
     pub theta: u32,
     pub low_alpha: u32,
@@ -250,27 +250,27 @@ impl Parser {
                 //ASIC_EEG_POWER: eight big-endian 3-byte unsigned integer values representing
                 //delta, theta, low-alpha high-alpha, low-beta, high-beta, low-gamma, and mid-gamma
                 //EEG band power values
-                let mut current_vec: Vec<u32> = vec![];
+                let mut eeg_vec: Vec<u32> = vec![];
 
                 for i in 0..8 {
                     let asic = ((self.payload[n + 2 + i * 3] as u32) << 16)
                         | ((self.payload[n + 3 + i * 3] as u32) << 8)
                         | (self.payload[n + 4 + i * 3] as u32);
-                    current_vec.push(asic);
+                    eeg_vec.push(asic);
                 }
 
-                let egg_power = AsicEgg {
-                    delta: current_vec[0],
-                    theta: current_vec[1],
-                    low_alpha: current_vec[2],
-                    high_alpha: current_vec[3],
-                    low_beta: current_vec[4],
-                    high_beta: current_vec[5],
-                    low_gamma: current_vec[6],
-                    mid_gamma: current_vec[7],
+                let eeg_power = AsicEeg {
+                    delta: eeg_vec[0],
+                    theta: eeg_vec[1],
+                    low_alpha: eeg_vec[2],
+                    high_alpha: eeg_vec[3],
+                    low_beta: eeg_vec[4],
+                    high_beta: eeg_vec[5],
+                    low_gamma: eeg_vec[6],
+                    mid_gamma: eeg_vec[7],
                 };
-                debug!("Delta {:#04x}, Theta {:#04x}, LowAlpha {:#04x}, HighAlpha {:#04x}, LowBeta {:#04x}, highBeta {:#04x}, LowGamma {:#04x}, MidGamma {:#04x}", egg_power.delta, egg_power.theta, egg_power.low_alpha, egg_power.high_alpha, egg_power.low_beta, egg_power.high_beta, egg_power.low_gamma, egg_power.mid_gamma);
-                result.push(PacketType::AsicEgg(egg_power));
+                debug!("EEG power values = {:?}", eeg_power);
+                result.push(PacketType::AsicEeg(eeg_power));
                 n += 26;
             } else {
                 warn!("packet code undefined {:#04x}", self.payload[n]);
@@ -362,7 +362,7 @@ mod tests {
             }
         }
 
-        let test_asic = AsicEgg {
+        let test_asic = AsicEeg {
             delta: 0x94,
             theta: 0x42,
             low_alpha: 0x0b,
@@ -377,7 +377,7 @@ mod tests {
             result,
             vec![
                 PacketType::PoorSignal(0x00),
-                PacketType::AsicEgg(test_asic),
+                PacketType::AsicEeg(test_asic),
                 PacketType::Attention(0x0d),
                 PacketType::Meditation(0x3d)
             ]

src/lib.rs

@@ -27,15 +27,15 @@ fn main() -> Result<(), Box<dyn Error>> {
         });
     let path = matches.value_of("dongle-path").unwrap();
     let mut port = connect_headset(path, &headset[..])?;
-    let mut temp: Vec<u8> = vec![0; 2048];
+    let mut read_buf: Vec<u8> = vec![0; 2048];
     let mut parser = Parser::new();
 
     loop {
-        let byte_buf = port.read(temp.as_mut_slice()).expect(
+        let bytes_read = port.read(read_buf.as_mut_slice()).expect(
             "Found no data when reading from dongle. Please make sure headset is connected.",
         );
-        for i in 0..byte_buf {
-            if let Some(x) = parser.parse(temp[i]) {
+        for i in 0..bytes_read {
+            if let Some(x) = parser.parse(read_buf[i]) {
                 for r in x {
                     match r {
                         PacketType::Attention(value) => {
@@ -44,8 +44,8 @@ fn main() -> Result<(), Box<dyn Error>> {
                         PacketType::Meditation(value) => {
                             println!("Meditation value = {}", value);
                         }
-                        PacketType::AsicEgg(value) => {
-                            println!("EGG power values = {:?}", value);
+                        PacketType::AsicEeg(value) => {
+                            println!("EEG power values = {:?}", value);
                         }
                         _ => (),
                     }

src/main.rs

@@ -15,7 +15,7 @@ use std::sync::Arc;
 const W: usize = 800;
 const H: usize = 1000;
 const LABEL: [&str; 2] = ["Attention", "Meditation"];
-const EGGLABEL: [&str; 8] = [
+const EEGLABEL: [&str; 8] = [
     "delta",
     "theta",
     "low-alpha",
@@ -80,15 +80,17 @@ fn main() -> Result<(), Box<dyn Error>> {
         });
     let path = matches.value_of("dongle-path").unwrap();
     let mut port = connect_headset(path, &headset[..])?;
-    let mut temp: Vec<u8> = vec![0; 2048];
+    let mut read_buf: Vec<u8> = vec![0; 2048];
     let mut parser = Parser::new();
     let mut esense = vec![VecDeque::new(); 2];
-    let mut egg = vec![VecDeque::new(); 8];
-    let mut buf = BufferWrapper(vec![0u32; W * H]);
+    let mut eeg = vec![VecDeque::new(); 8];
+    let mut draw_buf = BufferWrapper(vec![0u32; W * H]);
     let mut window = Window::new("mindwave plot", W, H, WindowOptions::default())?;
-    let root =
-        BitMapBackend::<BGRXPixel>::with_buffer_and_format(buf.borrow_mut(), (W as u32, H as u32))?
-            .into_drawing_area();
+    let root = BitMapBackend::<BGRXPixel>::with_buffer_and_format(
+        draw_buf.borrow_mut(),
+        (W as u32, H as u32),
+    )?
+    .into_drawing_area();
     root.fill(&BLACK)?;
     let (upper, lower) = root.split_vertically(400);
     let mut chart_up = ChartBuilder::on(&upper)
@@ -122,7 +124,7 @@ fn main() -> Result<(), Box<dyn Error>> {
         .label_style(("sans-serif", 15).into_font().color(&GREEN))
         .x_labels(1)
         .y_labels(8)
-        .y_desc("EGG power")
+        .y_desc("EEG power")
         .axis_style(&GREEN)
         .draw()?;
     let cs_up = chart_up.into_chart_state();
@@ -132,11 +134,11 @@ fn main() -> Result<(), Box<dyn Error>> {
     drop(lower);
 
     while window.is_open() && !window.is_key_down(Key::Escape) && running.load(Ordering::SeqCst) {
-        let byte_buf = port.read(temp.as_mut_slice()).expect(
+        let bytes_read = port.read(read_buf.as_mut_slice()).expect(
             "Found no data when reading from dongle. Please make sure headset is connected.",
         );
         let root = BitMapBackend::<BGRXPixel>::with_buffer_and_format(
-            buf.borrow_mut(),
+            draw_buf.borrow_mut(),
             (W as u32, H as u32),
         )?
         .into_drawing_area();
@@ -155,8 +157,8 @@ fn main() -> Result<(), Box<dyn Error>> {
             .bold_line_style(&GREEN.mix(0.2))
             .light_line_style(&TRANSPARENT)
             .draw()?;
-        for i in 0..byte_buf {
-            if let Some(x) = parser.parse(temp[i]) {
+        for i in 0..bytes_read {
+            if let Some(x) = parser.parse(read_buf[i]) {
                 for r in x {
                     match r {
                         PacketType::Attention(value) => {
@@ -165,15 +167,15 @@ fn main() -> Result<(), Box<dyn Error>> {
                         PacketType::Meditation(value) => {
                             esense[1].push_back(value as i32);
                         }
-                        PacketType::AsicEgg(value) => {
-                            egg[0].push_back((value.delta / 10_000) as f64);
-                            egg[1].push_back((value.theta / 10_000) as f64);
-                            egg[2].push_back((value.low_alpha / 10_000) as f64);
-                            egg[3].push_back((value.high_alpha / 10_000) as f64);
-                            egg[4].push_back((value.low_beta / 10_000) as f64);
-                            egg[5].push_back((value.high_beta / 10_000) as f64);
-                            egg[6].push_back((value.low_gamma / 10_000) as f64);
-                            egg[7].push_back((value.mid_gamma / 10_000) as f64);
+                        PacketType::AsicEeg(value) => {
+                            eeg[0].push_back((value.delta / 10_000) as f64);
+                            eeg[1].push_back((value.theta / 10_000) as f64);
+                            eeg[2].push_back((value.low_alpha / 10_000) as f64);
+                            eeg[3].push_back((value.high_alpha / 10_000) as f64);
+                            eeg[4].push_back((value.low_beta / 10_000) as f64);
+                            eeg[5].push_back((value.high_beta / 10_000) as f64);
+                            eeg[6].push_back((value.low_gamma / 10_000) as f64);
+                            eeg[7].push_back((value.mid_gamma / 10_000) as f64);
                         }
                         _ => (),
                     }
@@ -184,9 +186,9 @@ fn main() -> Result<(), Box<dyn Error>> {
             esense[0].pop_front();
             esense[1].pop_front();
         }
-        if egg[0].len() == 100 {
+        if eeg[0].len() == 100 {
             for n in 0..8 {
-                egg[n].pop_front();
+                eeg[n].pop_front();
             }
         }
         for (idx, esense) in (0..).zip(esense.iter()) {
@@ -207,13 +209,13 @@ fn main() -> Result<(), Box<dyn Error>> {
             .background_style(&WHITE.mix(0.5))
             .border_style(&BLACK)
             .draw()?;
-        for (idx, egg) in (0..).zip(egg.iter()) {
+        for (idx, eeg) in (0..).zip(eeg.iter()) {
             chart_low
                 .draw_series(LineSeries::new(
-                    (1..).zip(egg.iter()).map(|(a, b)| (a, *b)),
+                    (1..).zip(eeg.iter()).map(|(a, b)| (a, *b)),
                     &Palette99::pick(idx),
                 ))?
-                .label(EGGLABEL[idx])
+                .label(EEGLABEL[idx])
                 .legend(move |(x, y)| {
                     Rectangle::new([(x - 5, y - 5), (x + 5, y + 5)], &Palette99::pick(idx))
                 });
@@ -231,7 +233,7 @@ fn main() -> Result<(), Box<dyn Error>> {
         drop(upper);
         drop(lower);
         window.set_title("Mindwave real-time plot");
-        window.update_with_buffer(buf.borrow(), W, H)?;
+        window.update_with_buffer(draw_buf.borrow(), W, H)?;
     }
     Ok(())
 }