Merge pull request #25 from thodob/wifi_gui_draft

Utlrasonic Ranging WiFi GUI draft with functional raw data plotting

Author: fanfare-ff

docs/Projects/UltraSound-WiFi-GUI.md

@@ -12,26 +12,38 @@ nav_order: 2
 ---
 
 {: .WARNING}
-This project is currently in its initial development phase and is subject to significant changes, updates, and improvements.
+This project is in an early draft state. The WiFi GUI currently supports only raw data streaming with the provided Arduino WiFi example. Many UI elements are placeholders and non-functional.
+
 
 - TOC
 {:toc}
 
 
 ## Introduction
 
-For the whole ultrasonic implementation info etc, refer to main [Ultrasonic Ranging page]({% link Projects/UltraSound.md %}). This page contains only difference showcase: WiFi implementation and GUI.
+For the whole ultrasonic implementation info etc, refer to main [Ultrasonic Ranging page]({% link Projects/UltraSound.md %}). This page focuses on differences: WiFi implementation and GUI.
+
+## Current status
+A draft GUI (WiFi_GUI.mlapp) is now included. In its current form, the GUI works with the **UltraSound-WiFi-GUI**, but displays only raw signals. The GUI application will need to be adapted to get the full detailed readings.
+
+Functional UI elements:
+  - IP Address text field (to target the device on the network)
+  - Start and Stop buttons (begin/end raw data streaming)
+  - Main Axes (live plot for incoming raw data)
+
+The other UI elements are non-functional dupes and will still have to be implemented.
+
+TO DO: 
+ - Filtered / XCORR / Distance buttons
+ - CLI for outputs
+ - simple / detailed data transmission
+ - save plots / data
+ - proper axis names
+ - if the data is not received due to poor connection, don't crash the app, just skip one iteration and clean the buffers
 
-## Ideas
-* For simplicity, use just one channel
-* Button to start/stop continuous measurement
-* Button to do x1 one shot measurement
-* Button to switch between detailed data transmission or only distances
-* Tabs to switch between views: distance only like real time running, then raw data, filtered, xcorr
-* If only distances selected, tabs related to raw data, filtered etc. are grayed out
+Current draft:
+![alt text]({{site.baseurl}}/assets/images/wifi_gui_draft.png)
 
-Rough sketch (you can change it a lot according to needs):
+Full planned sketch:
 ![alt text]({{site.baseurl}}/assets/images/gui_sketch.png)
 
-Old one as a reference:
-![alt text]({{site.baseurl}}/assets/images/gui_old.png)

docs/assets/images/wifi_gui_draft.png

@@ -6,7 +6,7 @@ const uint16_t dac_cycle_num = 10;
 const uint16_t sine_lut_size = 64;
 const SENSEDU_DAC_BUFFER(sine_lut, sine_lut_size) = {
     0x800, 0x831, 0x861, 0x890, 0x8BE, 0x8EA, 0x914, 0x93B, 0x95F, 0x980, 0x99D, 0x9B6, 0x9CB, 0x9DB, 0x9E7, 0x9EE, 
-0x9F0, 0x9EE, 0x9E7, 0x9DB, 0x9CB, 0x9B6, 0x99D, 0x980, 0x95F, 0x93B, 0x914, 0x8EA, 0x8BE, 0x890, 0x861, 0x831, 
-0x800, 0x7CF, 0x79F, 0x770, 0x742, 0x716, 0x6EC, 0x6C5, 0x6A1, 0x680, 0x663, 0x64A, 0x635, 0x625, 0x619, 0x612, 
-0x610, 0x612, 0x619, 0x625, 0x635, 0x64A, 0x663, 0x680, 0x6A1, 0x6C5, 0x6EC, 0x716, 0x742, 0x770, 0x79F, 0x7CF
+    0x9F0, 0x9EE, 0x9E7, 0x9DB, 0x9CB, 0x9B6, 0x99D, 0x980, 0x95F, 0x93B, 0x914, 0x8EA, 0x8BE, 0x890, 0x861, 0x831, 
+    0x800, 0x7CF, 0x79F, 0x770, 0x742, 0x716, 0x6EC, 0x6C5, 0x6A1, 0x680, 0x663, 0x64A, 0x635, 0x625, 0x619, 0x612, 
+    0x610, 0x612, 0x619, 0x625, 0x635, 0x64A, 0x663, 0x680, 0x6A1, 0x6C5, 0x6EC, 0x716, 0x742, 0x770, 0x79F, 0x7CF
 };

projects/UltraSound-WiFi-GUI/SineLUT.h

@@ -3,18 +3,23 @@
 #include "SineLUT.h"
 #include "FilterTaps.h"
 #include "DACWave.h" // contains wave and its size
+#include <WiFi.h>
 
 uint32_t lib_error = 0;
 uint8_t error_led = D86;
 
 /* -------------------------------------------------------------------------- */
 /*                                  Settings                                  */
 /* -------------------------------------------------------------------------- */
+#define WIFI_SSID   "Holohouse"
+#define WIFI_PASS   "FubuKing2011"
+#define WIFI_PORT   80
+
 #define IS_TRANSMIT_DETAILED_DATA   true    // activate full raw, filtered, xcorr data transmission
 #define BAN_DISTANCE	            20	    // min distance [cm] - how many self reflections cancelled
 #define ACTUAL_SAMPLING_RATE        250000  // You need to measure this value using a wave generator with a fixed e.g. 1kHz Sine
 #define STORE_BUF_SIZE              32 * 32 // 2400 for 1 measurement per second. 
-                            	        // only multiples of 32!!!!!! (64 chunk size of bytes, so 32 for 16bit)
+                            	            // only multiples of 32!!!!!! (64 chunk size of bytes, so 32 for 16bit)
 
 /* --------------------------------- Filter --------------------------------- */
 #define FILTER_BLOCK_LENGTH     32      // how many samples we want to process every time we call the fir process function AT
@@ -52,13 +57,23 @@ SensEdu_ADC_Settings adc1_settings = {
 };
 
 /* ----------------------------------- DAC ---------------------------------- */
-DAC_Channel* dac_channel = DAC_CH1;
 // lut settings are in SineLUT.h
 #define DAC_SINE_FREQ     	32000                           // 32kHz
 #define DAC_SAMPLE_RATE     DAC_SINE_FREQ * sine_lut_size   // 64 samples per one sine cycle
 
-SensEdu_DAC_Settings dac_settings = {dac_channel, DAC_SAMPLE_RATE, (uint16_t*)sine_lut, sine_lut_size, 
-    SENSEDU_DAC_MODE_BURST_WAVE, dac_cycle_num}; // specifying burst mode 
+DAC_Channel* dac_ch = DAC_CH1;
+SensEdu_DAC_Settings dac_settings = {
+    .dac_channel = dac_ch, 
+    .sampling_freq = DAC_SAMPLE_RATE,
+    .mem_address = (uint16_t*)sine_lut,
+    .mem_size = sine_lut_size,
+    .wave_mode = SENSEDU_DAC_MODE_BURST_WAVE,
+    .burst_num = dac_cycle_num
+};
+
+/* ---------------------------------- WiFi ---------------------------------- */
+int status = WL_IDLE_STATUS;
+WiFiServer server(WIFI_PORT);
 
 /* -------------------------------------------------------------------------- */
 /*                                  Constants                                 */
@@ -101,66 +116,84 @@ void setup() {
     SensEdu_ADC_Init(&adc1_settings);
     SensEdu_ADC_Enable(adc1);
 
-    lib_error = SensEdu_GetError();
-    while (lib_error != 0) {
-        handle_error();
+    check_lib_errors();
+
+    // attempt connection to WiFi network
+    while (status != WL_CONNECTED) {
+        Serial.print("Attempting to connect to SSID: ");
+        Serial.println(WIFI_SSID);
+        // connect to WPA/WPA2 network (change this if youre using open / WEP network)
+        status = WiFi.begin(WIFI_SSID, WIFI_PASS);
+
+        // wait 10 seconds for connection:
+        delay(10000);
     }
+    server.begin();
+    // connection established; print out the status:
+    print_wifi_status();
 }
 
 /* -------------------------------------------------------------------------- */
 /*                                    Loop                                    */
 /* -------------------------------------------------------------------------- */
 
 void loop() {
+    check_lib_errors();
+
 	SenseduBoard* main_obj_ptr = &SenseduBoardObj;
+
+    WiFiClient client = server.available();
+    if (!client) {
+        return;
+    }
+    Serial.println("Client connected!");
+
     // Measurement is initiated by the signal from computing device (matlab script)
-    static char serial_buf = 0;
-    
-    // Measurement is initiated by signal from computing device
-    while (1) {
-        while (Serial.available() == 0); // Wait for a signal
-        serial_buf = Serial.read();
-        if (serial_buf == 't') {
-            break; 
+    static char buf = 0;
+
+    while(client.connected()) {
+        if (!client.available()) {
+            continue;
         }
-    }
-    
-    // Start dac->adc sequence
-    SensEdu_DAC_Enable(dac_channel);
-    while(!SensEdu_DAC_GetBurstCompleteFlag(dac_channel)); // wait for dac to finish sending the burst
-    SensEdu_DAC_ClearBurstCompleteFlag(dac_channel); 
-    
-    // Start ADCs
-    SensEdu_ADC_Start(adc1);
-
-    // Wait for the data from ADC1
-    while(!SensEdu_ADC_GetTransferStatus(adc1));
-    SensEdu_ADC_ClearTransferStatus(adc1);
-
-    // Calculating distance for each microphone
-    static uint32_t distance[adc1_mic_num];
-    for(uint8_t i = 0; i < adc1_mic_num; i++) {
-        process_and_transmit_data(main_obj_ptr->processing_buffer, STORE_BUF_SIZE, adc1_data, STORE_BUF_SIZE, main_obj_ptr->ban_flag, IS_TRANSMIT_DETAILED_DATA);
-        distance[i] = calculate_distance(main_obj_ptr->processing_buffer);
-    }
 
-    // Sending the distance measurements
-    for (uint8_t i = 0; i < (adc1_mic_num); i++) {
-        Serial.write((const uint8_t *) &distance[i], 4);
-    }
+        buf = client.read();
+        if (buf != 't') { // trigger not detected
+            continue;
+        }
 
-    // check errors
-    lib_error = SensEdu_GetError();
-    while (lib_error != 0) {
-        handle_error();
+        // Start dac->adc sequence
+        SensEdu_DAC_Enable(dac_ch);
+        while(!SensEdu_DAC_GetBurstCompleteFlag(dac_ch)); // wait for dac to finish sending the burst
+        SensEdu_DAC_ClearBurstCompleteFlag(dac_ch);
+
+        // Start ADC
+        SensEdu_ADC_Start(adc1);
+
+        // Wait for the data from ADC1
+        while(!SensEdu_ADC_GetTransferStatus(adc1));
+        SensEdu_ADC_ClearTransferStatus(adc1);
+
+        // Calculating distance for each microphone
+        static uint32_t distance[adc1_mic_num];
+        for(uint8_t i = 0; i < adc1_mic_num; i++) {
+            process_and_transmit_data(client, main_obj_ptr->processing_buffer, STORE_BUF_SIZE, adc1_data, STORE_BUF_SIZE, main_obj_ptr->ban_flag, IS_TRANSMIT_DETAILED_DATA);
+            distance[i] = calculate_distance(main_obj_ptr->processing_buffer);
+        }
+
+        // Sending the distance measurements
+        for (uint8_t i = 0; i < (adc1_mic_num); i++) {
+            client.write((const uint8_t *) &distance[i], 4);
+        }
+
+        check_lib_errors();
     }
 }
 
-void process_and_transmit_data(float* buf, const uint16_t buf_size, uint16_t* ch_array, const uint16_t ch_array_size, uint8_t ban_flag, uint8_t is_detailed_transmission) {
+void process_and_transmit_data(WiFiClient& client, float* buf, const uint16_t buf_size, uint16_t* ch_array, const uint16_t ch_array_size, uint8_t ban_flag, uint8_t is_detailed_transmission) {
 
     /* -------------------------------- RAW DATA -------------------------------- */
     if (is_detailed_transmission)
-        transfer_serial_data(ch_array, ch_array_size, 32);
+        transfer_wifi_data(client, ch_array, ch_array_size);
 
     /* --------------------- RESCALED, FILTERED, NO COUPLED --------------------- */
     // Rescale from [0, (2^16-1)] to [-1, 1] and filter around 32 kHz
@@ -171,30 +204,50 @@ void process_and_transmit_data(float* buf, const uint16_t buf_size, uint16_t* ch
         remove_coupling(buf, c_banned_sample_num);
     } 
     if (is_detailed_transmission)
-        transfer_serial_data_float(buf, buf_size, 32);
+        transfer_wifi_data_float(client, buf, buf_size);
 
     /* ---------------------------------- XCORR --------------------------------- */
 	custom_xcorr(buf, dac_wave, buf_size);
     if (is_detailed_transmission)
-	    transfer_serial_data_float(buf, buf_size, 32);
+	    transfer_wifi_data_float(client, buf, buf_size);
 
 }
 
-void transfer_serial_data(uint16_t* data, const uint16_t data_length, const uint16_t chunk_size_byte) {
-    for (uint16_t i = 0; i < (data_length*2); i += chunk_size_byte) {
-        uint16_t transfer_size = ((data_length*2) - i < chunk_size_byte) ? (data_length*2 - i) : chunk_size_byte;
-        Serial.write((const uint8_t *) data + i, transfer_size);
-    }
+void transfer_wifi_data(WiFiClient& client, uint16_t* data, const uint16_t data_length) {
+    client.write((const uint8_t*)data, data_length * sizeof(uint16_t));
 }
 
-void transfer_serial_data_float(float* data, const uint16_t data_length, const uint16_t chunk_size_byte) {
-    for (uint16_t i = 0; i < (data_length*4); i += chunk_size_byte) {
-        uint16_t transfer_size = ((data_length*4) - i < chunk_size_byte) ? (data_length*4 - i) : chunk_size_byte;
-        Serial.write((const uint8_t *) data + i, transfer_size);
+void transfer_wifi_data_float(WiFiClient& client, float* data, const uint16_t data_length) {
+    client.write((const uint8_t*)data, data_length * sizeof(float));
+}
+
+void check_lib_errors(void) {
+    lib_error = SensEdu_GetError();
+    while (lib_error != 0) {
+        handle_error();
     }
 }
 
-void handle_error() {
-    // serial is taken by matlab, use LED as indication
+void handle_error(void) {
     digitalWrite(error_led, LOW);
+    Serial.print("Error: 0x");
+    Serial.println(lib_error, HEX);
+    delay(1000);
+}
+
+void print_wifi_status(void) {
+    // print the SSID of the network youre connected to
+    Serial.print("SSID: ");
+    Serial.println(WiFi.SSID());
+
+    // print your boards local IP address
+    IPAddress ip = WiFi.localIP();
+    Serial.print("IP Address: ");
+    Serial.println(ip);
+
+    // print the received WiFi signal strength
+    long rssi = WiFi.RSSI();
+    Serial.print("signal strength (RSSI):");
+    Serial.print(rssi);
+    Serial.println(" dBm");
 }

projects/UltraSound-WiFi-GUI/UltraSound-WiFi-GUI.ino

@@ -1,7 +1,5 @@
-%% detailed_data_acquisition.m
-% triggers ultrasonic recording
-% receives the data
-% plots distances along with processing steps
+%% demo file to see what needs to be implemented via interface
+%% see actual code at matlab -> apps -> design app -> open -> WiFi_GUI.mlapp
 clear;
 close all;
 addpath("plot scripts\");
@@ -16,9 +14,10 @@
 
 %% Arduino Setup + Config
 % Serial port configuration 
-ARDUINO_PORT = 'COM18';
-ARDUINO_BAUDRATE = 115200;
-arduino = serialport(ARDUINO_PORT, ARDUINO_BAUDRATE); % select port and baudrate 
+ARDUINO_IP = "192.168.56.128"; % match to Arduino IP
+ARDUINO_PORT = 80; % match to port of Arduino server
+
+arduino = tcpclient(ARDUINO_IP, ARDUINO_PORT, "Timeout",30, "ConnectTimeout",30); % connect to Arduino
 
 %% Arrays
 dist_matrix = zeros(MIC_NUM, ITERATIONS); % distance matrix
@@ -63,7 +62,7 @@
 fprintf("Data acquisition completed in: %fsec\n", acquisition_time);
 
 % close serial connection
-arduino = [];
+%arduino = [];
 
 %% Plotting 1
 figure
@@ -156,35 +155,13 @@ function plot_detailed_data(mic, step, data)
 end
 
 function data = read_16bit_data(arduino, data_length)
-    chunk_size = 32; % in bytes
-    data_length_byte = data_length*2; % multiplied by sizeof(type)
-
-    raw_data_8bit = zeros(data_length_byte/chunk_size, chunk_size);
-    raw_data_16bit = zeros(data_length_byte/chunk_size, chunk_size/2);
-    
-    for i = 1:(data_length_byte/chunk_size)
-        raw_data_8bit(i, :) = read(arduino, chunk_size, 'uint8');
-        raw_data_16bit(i, :) = typecast_uint8_uint16(raw_data_8bit(i, :));
-    end
-    
-    % rearrange by mic
-    data = reshape(raw_data_16bit', 1, []);
+    raw_data = read(arduino, data_length * 2, 'uint8');
+    data = typecast_uint8_uint16(raw_data);
 end
 
 function data = read_float_data(arduino, data_length)
-    chunk_size = 32; % in bytes
-    data_length_byte = data_length*4; % multiplied by sizeof(type)
-
-    raw_data_8bit = zeros(data_length_byte/chunk_size, chunk_size);
-    raw_data_float = zeros(data_length_byte/chunk_size, chunk_size/4);
-    
-    for i = 1:(data_length_byte/chunk_size)
-        raw_data_8bit(i, :) = read(arduino, chunk_size, 'uint8');
-        raw_data_float(i, :) = typecast_uint8_float(raw_data_8bit(i, :));
-    end
-    
-    % rearrange by mic
-    data = reshape(raw_data_float', 1, []);
+    raw_data = read(arduino, data_length * 4, 'uint8');
+    data = typecast_uint8_float(raw_data);
 end
 
 function casted_data = typecast_uint8_uint16(data)