include option to save raw traffic

Author: hacknus

README.md

@@ -25,8 +25,8 @@ Features:
 - [X] Allow to put in labels for the different data columns (instead of column 1, 2, ...)
 - [X] Allow to choose Data-bits, Flow-Control, Parity and Stop-Bits for Serial Connection
 - [X] Saves the configuration for the serial port after closing and reloads them automatically upon selection
+- [X] Option to save raw data to file
 - [ ] Allow to select (and copy) more than just the displayed raw traffic (also implement ctrl + A)
-- [ ] Save raw data to file (at least as an option)
 - [ ] Smarter data parser
 - [ ] make serial print selectable and show corresponding datapoint in plot
 - [ ] COM-Port names on Windows (display manufacturer, name, pid or vid of device?)

src/gui.rs

@@ -19,7 +19,7 @@ use serialport::{DataBits, FlowControl, Parity, StopBits};
 use crate::data::{DataContainer, SerialDirection};
 use crate::serial::{save_serial_settings, Device, SerialDevices};
 use crate::toggle::toggle;
-use crate::CsvOptions;
+use crate::FileOptions;
 use crate::{vec2, APP_INFO, PREFS_KEY};
 
 const MAX_FPS: f64 = 60.0;
@@ -185,7 +185,7 @@ pub struct MyApp {
     connected_lock: Arc<RwLock<bool>>,
     data_lock: Arc<RwLock<DataContainer>>,
     names_tx: Sender<Vec<String>>,
-    save_tx: Sender<CsvOptions>,
+    save_tx: Sender<FileOptions>,
     send_tx: Sender<String>,
     clear_tx: Sender<bool>,
     history: Vec<String>,
@@ -210,7 +210,7 @@ impl MyApp {
         connected_lock: Arc<RwLock<bool>>,
         gui_conf: GuiSettingsContainer,
         names_tx: Sender<Vec<String>>,
-        save_tx: Sender<CsvOptions>,
+        save_tx: Sender<FileOptions>,
         send_tx: Sender<String>,
         clear_tx: Sender<bool>,
     ) -> Self {
@@ -653,9 +653,10 @@ impl MyApp {
                                 if let Some(path) = rfd::FileDialog::new().save_file() {
                                     self.picked_path = path;
                                     self.picked_path.set_extension("csv");
-                                    if let Err(e) = self.save_tx.send(CsvOptions {
+                                    if let Err(e) = self.save_tx.send(FileOptions {
                                         file_path: self.picked_path.clone(),
                                         save_absolute_time: self.gui_conf.save_absolute_time,
+                                        save_raw_traffic: self.save_raw,
                                     }) {
                                         print_to_console(
                                             &self.print_lock,
@@ -699,15 +700,11 @@ impl MyApp {
                             }
                             ui.end_row();
                             ui.label("Save Raw Traffic");
-                            ui.horizontal(|ui| {
-                                ui.set_enabled(false);
-                                if ui.add(toggle(&mut self.save_raw))
-                                    .on_hover_text("Save raw traffic to CSV. - not implemented yet!")
-                                    .changed() {
-                                    // gui_states.push(GuiState::Run(self.show_timestamps));
-                                }
-                                ui.label("Not implemented yet.");
-                            });
+                            if ui.add(toggle(&mut self.save_raw))
+                                .on_hover_text("Save second CSV containing raw traffic.")
+                                .changed() {
+                                // gui_states.push(GuiState::Run(self.show_timestamps));
+                            }
                             ui.end_row();
                             ui.label("");
                             ui.end_row();

src/io.rs

@@ -1,10 +1,21 @@
 use std::error::Error;
+use std::fs::File;
+use std::io::Write;
+use std::path::PathBuf;
 
 use csv::WriterBuilder;
 
-use crate::{CsvOptions, DataContainer};
+use crate::DataContainer;
 
-pub fn save_to_csv(data: &DataContainer, csv_options: &CsvOptions) -> Result<(), Box<dyn Error>> {
+/// A set of options for saving data to a CSV file.
+#[derive(Debug)]
+pub struct FileOptions {
+    pub file_path: PathBuf,
+    pub save_absolute_time: bool,
+    pub save_raw_traffic: bool,
+}
+
+pub fn save_to_csv(data: &DataContainer, csv_options: &FileOptions) -> Result<(), Box<dyn Error>> {
     let mut wtr = WriterBuilder::new()
         .has_headers(false)
         .from_path(&csv_options.file_path)?;
@@ -25,5 +36,31 @@ pub fn save_to_csv(data: &DataContainer, csv_options: &CsvOptions) -> Result<(),
         wtr.write_record(&data_to_write)?;
     }
     wtr.flush()?;
+    if csv_options.save_raw_traffic {
+        let mut path = csv_options.file_path.clone();
+        let mut file_name = path.file_name().unwrap().to_str().unwrap().to_string();
+        file_name.replace(".csv", "");
+        file_name += "raw.csv";
+        path.set_file_name(file_name);
+        save_raw(data, &path)?
+    }
+    Ok(())
+}
+
+pub fn save_raw(data: &DataContainer, path: &PathBuf) -> Result<(), Box<dyn Error>> {
+    let mut wtr = WriterBuilder::new().has_headers(false).from_path(path)?;
+    let header = vec![
+        "Time [ms]".to_string(),
+        "Abs Time [ms]".to_string(),
+        "Raw Traffic".to_string(),
+    ];
+    wtr.write_record(header)?;
+
+    for j in 0..data.dataset[0].len() {
+        let mut data_to_write = vec![data.time[j].to_string(), data.absolute_time[j].to_string()];
+        data_to_write.push(data.raw_traffic[j].payload.clone());
+        wtr.write_record(&data_to_write)?;
+    }
+    wtr.flush()?;
     Ok(())
 }

src/main.rs

@@ -6,7 +6,6 @@ extern crate preferences;
 extern crate serde;
 
 use std::cmp::max;
-use std::path::PathBuf;
 use std::sync::mpsc::{Receiver, Sender};
 use std::sync::{mpsc, Arc, RwLock};
 use std::thread;
@@ -17,7 +16,7 @@ use preferences::AppInfo;
 
 use crate::data::{DataContainer, Packet};
 use crate::gui::{load_gui_settings, print_to_console, MyApp, Print, RIGHT_PANEL_WIDTH};
-use crate::io::save_to_csv;
+use crate::io::{save_to_csv, FileOptions};
 use crate::serial::{load_serial_settings, serial_thread, Device};
 
 mod data;
@@ -33,13 +32,6 @@ const APP_INFO: AppInfo = AppInfo {
 const PREFS_KEY: &str = "config/gui";
 const PREFS_KEY_SERIAL: &str = "config/serial_devices";
 
-/// A set of options for saving data to a CSV file.
-#[derive(Debug)]
-pub struct CsvOptions {
-    file_path: PathBuf,
-    save_absolute_time: bool,
-}
-
 fn split(payload: &str) -> Vec<f32> {
     let mut split_data: Vec<&str> = vec![];
     for s in payload.split(':') {
@@ -57,7 +49,7 @@ fn main_thread(
     print_lock: Arc<RwLock<Vec<Print>>>,
     raw_data_rx: Receiver<Packet>,
     names_rx: Receiver<Vec<String>>,
-    save_rx: Receiver<CsvOptions>,
+    save_rx: Receiver<FileOptions>,
     clear_rx: Receiver<bool>,
 ) {
     // reads data from mutex, samples and saves if needed
@@ -152,7 +144,7 @@ fn main() {
     let print_lock = Arc::new(RwLock::new(vec![Print::Empty]));
     let connected_lock = Arc::new(RwLock::new(false));
 
-    let (save_tx, save_rx): (Sender<CsvOptions>, Receiver<CsvOptions>) = mpsc::channel();
+    let (save_tx, save_rx): (Sender<FileOptions>, Receiver<FileOptions>) = mpsc::channel();
     let (send_tx, send_rx): (Sender<String>, Receiver<String>) = mpsc::channel();
     let (clear_tx, clear_rx): (Sender<bool>, Receiver<bool>) = mpsc::channel();
     let (names_tx, names_rx): (Sender<Vec<String>>, Receiver<Vec<String>>) = mpsc::channel();