updated Readme's

pseudoincorrect · Apr 12, 2021 · 79be01b · 79be01b
1 parent b47a8f2
commit 79be01b
Show file tree

Hide file tree

Showing 4 changed files with 123 additions and 20 deletions.
diff --git a/Embedded_system/smart_mask/README.md b/Embedded_system/smart_mask/README.md
@@ -1,4 +1,31 @@
+<p align="center"><img width=12.5% src="../../Support/Readme_Assets/Images/smart_mask_logo.png"></p>
+
+<p align="center" style="font-size:10em"><b>SMART MASK</b></p>
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
 # SMART MASK (Embedded System Firmware)
+<br>
+<p align="center">
+<img align="center" width=60% src="../../Support/Readme_Assets/Images/SES.jpg">
+</p>
+<br>
+
+# Description
+
+<p align="justify">
+Embedded system firware written in C against Nordic's NRF SDK. This firmware allows for BLE central to connect. It enables to control and sample the 4 ADC (SAADC) connected to 4 printed sensors. Data are ring-buffered. The code has been developed on Segger Embedded Studio (successful compilations/programming have been made with GNU ARM on earlier versions).
+</p>
+
+# Features
+
+Bluetooth BLE <br>
+Controllable Gain (over BLE) <br>
+Controllable Sampling Frequency (over BLE) <br>
+Automatic Re-pairing <br>
+Watchdog reset <br>
+
+# Getting Started Instructions
 
 Embedded C project for the NRF52 of Nordic
 
@@ -13,13 +40,14 @@ Instructions:
 - Open " on any text editor
 - At the bottom of the file, add a configuration (before "</solution>") such as this one bellow
 
-+ `
+```xml
  <configuration
  Name="theNameYouWant"
  c_preprocessor_definitions="DEBUG; DEBUG_NRF"
  gcc_optimization_level="None"
  macros="NRF_SDK=C:/absolute/path/to/your/sdk;PROJ_ROOT=C:/absolute/path/to/your/the/ble_smart_mask/folder" />
-`
+```
+
 - Modify "Name" to your need
 
 - In "macros":
@@ -35,4 +63,13 @@ Instructions:
 
 - Build -> Build ble_mask
 
-- You can also delete the configurations you don't need
+- You can also delete the configurations you don't need
+
+<br>
+
+# Roadmap
+- Sleep mode
+- different sample frequency per sensor
+- Over the air firmware update
+- Data link encryption (bluetooth bonding)
+- Bluetooth reset
diff --git a/Mobile_app/smart_mask/README.md b/Mobile_app/smart_mask/README.md
@@ -1,16 +1,38 @@
-# smart_mask
+<p align="center"><img width=12.5% src="../../Support/Readme_Assets/Images/smart_mask_logo.png"></p>
 
-Smart mask
+<p align="center" style="font-size:10em"><b>SMART MASK</b></p>
 
-## Getting Started
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-This project is a starting point for a Flutter application.
+# SMART MASK (Mobile Application)
+<br>
+<p align="center">
+<img align="center" width=30% src="../../Support/Readme_Assets/Images/app_analytics.png">
+</p>
+<br>
 
-A few resources to get you started if this is your first Flutter project:
+# Description
 
-- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
+<p align="justify">
+Cross platform mobile application built with Flutter. Realtime control of the sensor and sampling. Data are stored in a local Database for navigation and digital signal processing operations.
+</p>
 
-For help getting started with Flutter, view our
-[online documentation](https://flutter.dev/docs), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+# Features
+- Bluetooth pairing 
+- Sensor control
+- Analytic view for applying basic DSP operation on data
+- Data Stored on Database
+- Sensor data display on semi realtime (bluetooth latency)
+
+# Requirements
+Flutter 2.0 is needed here
+
+# Architecture
+- Bloc state management 
+- Repositories for data access / management
+- Flutter_blue for bluetooth management
+
+# Roadmap
+- Improve bluetooth stability
+- Fill/hide holes in data (for better display)
+- Improve the theme
diff --git a/PCB/README.md b/PCB/README.md
@@ -0,0 +1,46 @@
+<p align="center"><img width=12.5% src="../Support/Readme_Assets/Images/smart_mask_logo.png"></p>
+
+<p align="center" style="font-size:10em"><b>SMART MASK</b></p>
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+# SMART MASK (PCB Cad files)
+<br>
+<p align="center">
+<img align="center" width=50% src="../Support/Readme_Assets/Images/smart_mask_altium.png">
+</p>
+<br>
+
+
+# Description
+
+<p align="justify">
+PCB board designed with Altium Designer for the SMART MASK project. All components used are from custom <a href="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/pseudoincorrect/Altium_Libraries">Altium_Libraries</a>. Latest version includes a 4 layers PCB.
+</p>
+
+
+
+# Features (Latest Version)
+
+Battery management and protection <br>
+Bluetooth Chip with chip antenna <br>
+Buck Regualator <br>
+FFC connectors for the sensors<br>
+USB C for charging<br>
+Pairing Button and LED <br>
+
+# Notes
+Altium version above (or equal) to 18.0 is prefered to work on this project.
+
+# PCB Properties (Latest Version)
+
+Dimensions (mm): 22 * 29
+
+4 layers:
+- (1) Signal/GND 
+- (2) GND 
+- (3) Power 
+- (4) Signal/GND
+<br>
+
+Clearance: 6 mils
diff --git a/README.md b/README.md
@@ -1,8 +1,6 @@
-<!-- <p align="center"><img width=12.5% src="/pseudoincorrect/smart_mask/Support/Readme_Assets/Images/smart_mask_logo_3.png"></p> -->
-
 <p align="center"><img width=12.5% src="Support/Readme_Assets/Images/smart_mask_logo.png"></p>
 
-<p align="center" style="font-size:4em"><b>SMART MASK</b></p>
+<p align="center" style="font-size:10em"><b>SMART MASK</b></p>
 
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 ![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg)
@@ -28,7 +26,7 @@ This System is divided into 3 parts:
 # Printed Circuit Board
 
 The PCB is developped with Altium (started initially with Cadsoft Eagle).<br>
-Sources and supportind documents are in the /PCB folder.
+Sources and supportind documents are in  <a href="https://github.com/pseudoincorrect/smart_mask/tree/master/PCB">PCB/</a>.
 
 <br>
 <p align="center">
@@ -43,7 +41,7 @@ Sources and supportind documents are in the /PCB folder.
 The Mobile app is developped with the Flutter SDK.<br>
 Gather data and control the embedded system through bluetooth. <br>
 Store on local Db and display. Filter and navigate data through analytic page <br>
-Sources and supportind documents are in the /Mobile_app folder.
+Sources and supportind documents are in <a href="https://github.com/pseudoincorrect/smart_mask/tree/master/Mobile_app/smart_mask">Mobile_app/</a>.
 
 <br>
 <p align="center">
@@ -53,8 +51,8 @@ Sources and supportind documents are in the /Mobile_app folder.
 
 # Embedded System Software
 
-The central chip is a nrf52810 from Nordic Semiconductors. The program is being developped with Nordic SDK on Segger Embedded Studio. <br>
-Sources and supportind documents are in the /Embedded_system folder.
+Firware for the central chip, a nrf52810 from Nordic Semiconductors.<br> The program is being developped with Nordic SDK on Segger Embedded Studio. <br>
+Sources and supportind documents are in <a href="https://github.com/pseudoincorrect/smart_mask/tree/master/Embedded_system/smart_mask">Embedded_system/</a>.
 
 <br>
 <p align="center">