From 79be01b7ebe2ac8de760b804fa762b2eaa5ab493 Mon Sep 17 00:00:00 2001 From: Maxime Date: Mon, 12 Apr 2021 16:53:32 +0300 Subject: [PATCH] updated Readme's --- Embedded_system/smart_mask/README.md | 43 ++++++++++++++++++++++++-- Mobile_app/smart_mask/README.md | 42 +++++++++++++++++++------ PCB/README.md | 46 ++++++++++++++++++++++++++++ README.md | 12 +++----- 4 files changed, 123 insertions(+), 20 deletions(-) diff --git a/Embedded_system/smart_mask/README.md b/Embedded_system/smart_mask/README.md index 9161cea..658c333 100644 --- a/Embedded_system/smart_mask/README.md +++ b/Embedded_system/smart_mask/README.md @@ -1,4 +1,31 @@ +

+ +

SMART MASK

+ +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) + # SMART MASK (Embedded System Firmware) +
+

+ +

+
+ +# Description + +

+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). +

+ +# Features + +Bluetooth BLE
+Controllable Gain (over BLE)
+Controllable Sampling Frequency (over BLE)
+Automatic Re-pairing
+Watchdog reset
+ +# 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 "") such as this one bellow -+ ` +```xml -` +``` + - 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 \ No newline at end of file +- You can also delete the configurations you don't need + +
+ +# Roadmap +- Sleep mode +- different sample frequency per sensor +- Over the air firmware update +- Data link encryption (bluetooth bonding) +- Bluetooth reset \ No newline at end of file diff --git a/Mobile_app/smart_mask/README.md b/Mobile_app/smart_mask/README.md index 74fc1ce..4c1b484 100644 --- a/Mobile_app/smart_mask/README.md +++ b/Mobile_app/smart_mask/README.md @@ -1,16 +1,38 @@ -# smart_mask +

-Smart mask +

SMART MASK

-## 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) +
+

+ +

+
-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) +

+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. +

-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 \ No newline at end of file diff --git a/PCB/README.md b/PCB/README.md index e69de29..2fba9d6 100644 --- a/PCB/README.md +++ b/PCB/README.md @@ -0,0 +1,46 @@ +

+ +

SMART MASK

+ +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) + +# SMART MASK (PCB Cad files) +
+

+ +

+
+ + +# Description + +

+PCB board designed with Altium Designer for the SMART MASK project. All components used are from custom Altium_Libraries. Latest version includes a 4 layers PCB. +

+ + + +# Features (Latest Version) + +Battery management and protection
+Bluetooth Chip with chip antenna
+Buck Regualator
+FFC connectors for the sensors
+USB C for charging
+Pairing Button and LED
+ +# 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 +
+ +Clearance: 6 mils diff --git a/README.md b/README.md index a3016f6..6e10e34 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ - -

-

SMART MASK

+

SMART MASK

[![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).
-Sources and supportind documents are in the /PCB folder. +Sources and supportind documents are in PCB/.

@@ -43,7 +41,7 @@ Sources and supportind documents are in the /PCB folder. The Mobile app is developped with the Flutter SDK.
Gather data and control the embedded system through bluetooth.
Store on local Db and display. Filter and navigate data through analytic page
-Sources and supportind documents are in the /Mobile_app folder. +Sources and supportind documents are in Mobile_app/.

@@ -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.
-Sources and supportind documents are in the /Embedded_system folder. +Firware for the central chip, a nrf52810 from Nordic Semiconductors.
The program is being developped with Nordic SDK on Segger Embedded Studio.
+Sources and supportind documents are in Embedded_system/.