update general readme

LICENSE.txt

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2021 Maxime Clement
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Mobile_app/smart_mask/.flutter-plugins-dependencies

@@ -1 +1 @@
-{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"ext_storage","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\ext_storage-1.0.3\\\\","dependencies":[]},{"name":"flutter_blue","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\flutter_blue-0.7.2\\\\","dependencies":[]},{"name":"path_provider","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider-2.0.1\\\\","dependencies":[]},{"name":"permission_handler","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\permission_handler-6.1.1\\\\","dependencies":[]},{"name":"sqflite","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\sqflite-2.0.0+3\\\\","dependencies":[]}],"android":[{"name":"ext_storage","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\ext_storage-1.0.3\\\\","dependencies":[]},{"name":"flutter_blue","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\flutter_blue-0.7.2\\\\","dependencies":[]},{"name":"path_provider","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider-2.0.1\\\\","dependencies":[]},{"name":"permission_handler","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\permission_handler-6.1.1\\\\","dependencies":[]},{"name":"sqflite","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\sqflite-2.0.0+3\\\\","dependencies":[]}],"macos":[{"name":"path_provider_macos","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider_macos-2.0.0\\\\","dependencies":[]},{"name":"sqflite","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\sqflite-2.0.0+3\\\\","dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider_linux-2.0.0\\\\","dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider_windows-2.0.0\\\\","dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"ext_storage","dependencies":[]},{"name":"flutter_blue","dependencies":[]},{"name":"path_provider","dependencies":["path_provider_macos","path_provider_linux","path_provider_windows"]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_macos","dependencies":[]},{"name":"path_provider_windows","dependencies":[]},{"name":"permission_handler","dependencies":[]},{"name":"sqflite","dependencies":[]}],"date_created":"2021-04-08 16:20:51.207162","version":"2.0.4"}
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"ext_storage","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\ext_storage-1.0.3\\\\","dependencies":[]},{"name":"flutter_blue","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\flutter_blue-0.7.2\\\\","dependencies":[]},{"name":"path_provider","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider-2.0.1\\\\","dependencies":[]},{"name":"permission_handler","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\permission_handler-6.1.1\\\\","dependencies":[]},{"name":"sqflite","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\sqflite-2.0.0+3\\\\","dependencies":[]},{"name":"url_launcher","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\url_launcher-6.0.3\\\\","dependencies":[]}],"android":[{"name":"ext_storage","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\ext_storage-1.0.3\\\\","dependencies":[]},{"name":"flutter_blue","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\flutter_blue-0.7.2\\\\","dependencies":[]},{"name":"path_provider","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider-2.0.1\\\\","dependencies":[]},{"name":"permission_handler","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\permission_handler-6.1.1\\\\","dependencies":[]},{"name":"sqflite","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\sqflite-2.0.0+3\\\\","dependencies":[]},{"name":"url_launcher","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\url_launcher-6.0.3\\\\","dependencies":[]}],"macos":[{"name":"path_provider_macos","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider_macos-2.0.0\\\\","dependencies":[]},{"name":"sqflite","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\sqflite-2.0.0+3\\\\","dependencies":[]},{"name":"url_launcher_macos","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\url_launcher_macos-2.0.0\\\\","dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider_linux-2.0.0\\\\","dependencies":[]},{"name":"url_launcher_linux","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\url_launcher_linux-2.0.0\\\\","dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\path_provider_windows-2.0.0\\\\","dependencies":[]},{"name":"url_launcher_windows","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\url_launcher_windows-2.0.0\\\\","dependencies":[]}],"web":[{"name":"url_launcher_web","path":"C:\\\\Users\\\\maxim\\\\Programming\\\\SDKs\\\\Flutter\\\\flutter\\\\.pub-cache\\\\hosted\\\\pub.dartlang.org\\\\url_launcher_web-2.0.0\\\\","dependencies":[]}]},"dependencyGraph":[{"name":"ext_storage","dependencies":[]},{"name":"flutter_blue","dependencies":[]},{"name":"path_provider","dependencies":["path_provider_macos","path_provider_linux","path_provider_windows"]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_macos","dependencies":[]},{"name":"path_provider_windows","dependencies":[]},{"name":"permission_handler","dependencies":[]},{"name":"sqflite","dependencies":[]},{"name":"url_launcher","dependencies":["url_launcher_linux","url_launcher_macos","url_launcher_windows","url_launcher_web"]},{"name":"url_launcher_linux","dependencies":[]},{"name":"url_launcher_macos","dependencies":[]},{"name":"url_launcher_web","dependencies":[]},{"name":"url_launcher_windows","dependencies":[]}],"date_created":"2021-04-12 13:02:42.496318","version":"2.0.4"}

Mobile_app/smart_mask/lib/TODO

@@ -10,6 +10,7 @@ IN PROCESS
 -------------------------------------------------------------
 Add a home page with quick view of the sensor
 
+
 -------------------------------------------------------------
 DONE
 

Mobile_app/smart_mask/lib/src/ui/screens/home_screen.dart

@@ -1,8 +1,33 @@
 import 'package:flutter/material.dart';
+import 'package:url_launcher/url_launcher.dart';
 
 class HomeScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
- return Center(child: Text("Home"));
+ return Column(
+ mainAxisAlignment: MainAxisAlignment.spaceEvenly,
+ children: <Widget>[
+ sizedImage("assets/images/smart_mask_hardware.jpg", 250, 200),
+ sizedImage("assets/images/smart_mask_altium.png", 250, 200),
+ InkWell(
+ child: Text(
+ 'Get all sources on Github !',
+ style: TextStyle(fontSize: 20),
+ ),
+ onTap: () =>
+ launch('https://github.com/pseudoincorrect/smart_mask')),
+ ],
+ );
  }
 }
+
+Widget sizedImage(String path, double width, double height) {
+ return Image(
+ image: new AssetImage(path),
+ width: width,
+ height: height,
+ color: null,
+ fit: BoxFit.scaleDown,
+ alignment: Alignment.center,
+ );
+}

Mobile_app/smart_mask/lib/src/ui/theme/theme.dart

@@ -5,26 +5,16 @@ const ACCENT_COLOR = Color.fromARGB(255, 200, 142, 0);
 const BUTTON_COLOR = Color.fromARGB(255, 0, 120, 120);
 
 ThemeData getTheme() {
- // https://paletton.com/#uid=54+0y0kOlp2rfRiO9GhQXg6YA2E
+ // https://paletton.com/#uid=34+170kOlp2rfRiO9GhQXg6YA2E
  return ThemeData(
  brightness: Brightness.dark,
  primaryColor: PRIMARY_COLOR,
  accentColor: ACCENT_COLOR,
  textButtonTheme: getTextButtonThemeData(),
  elevatedButtonTheme: getElevatedButtonThemeData(),
  outlinedButtonTheme: getOutlinedButtonThemeData(),
- // buttonTheme: getButtonThemeData(),
  );
 }
-//
-// ButtonThemeData getButtonThemeData() {
-// return ButtonThemeData(
-// buttonColor: BUTTON_COLOR,
-// shape: RoundedRectangleBorder(
-// borderRadius: BorderRadius.all(Radius.circular(5))),
-// textTheme: ButtonTextTheme.primary,
-// );
-// }
 
 TextButtonThemeData getTextButtonThemeData() {
  return TextButtonThemeData(

Mobile_app/smart_mask/pubspec.lock

@@ -186,6 +186,11 @@ packages:
  description: flutter
  source: sdk
  version: "0.0.0"
+ flutter_web_plugins:
+ dependency: transitive
+ description: flutter
+ source: sdk
+ version: "0.0.0"
  iirjdart:
  dependency: "direct main"
  description:
@@ -207,6 +212,13 @@ packages:
  url: "https://pub.dartlang.org"
  source: hosted
  version: "0.17.0"
+ js:
+ dependency: transitive
+ description:
+ name: js
+ url: "https://pub.dartlang.org"
+ source: hosted
+ version: "0.6.3"
  logging:
  dependency: transitive
  description:
@@ -415,6 +427,48 @@ packages:
  url: "https://pub.dartlang.org"
  source: hosted
  version: "1.3.0"
+ url_launcher:
+ dependency: "direct main"
+ description:
+ name: url_launcher
+ url: "https://pub.dartlang.org"
+ source: hosted
+ version: "6.0.3"
+ url_launcher_linux:
+ dependency: transitive
+ description:
+ name: url_launcher_linux
+ url: "https://pub.dartlang.org"
+ source: hosted
+ version: "2.0.0"
+ url_launcher_macos:
+ dependency: transitive
+ description:
+ name: url_launcher_macos
+ url: "https://pub.dartlang.org"
+ source: hosted
+ version: "2.0.0"
+ url_launcher_platform_interface:
+ dependency: transitive
+ description:
+ name: url_launcher_platform_interface
+ url: "https://pub.dartlang.org"
+ source: hosted
+ version: "2.0.2"
+ url_launcher_web:
+ dependency: transitive
+ description:
+ name: url_launcher_web
+ url: "https://pub.dartlang.org"
+ source: hosted
+ version: "2.0.0"
+ url_launcher_windows:
+ dependency: transitive
+ description:
+ name: url_launcher_windows
+ url: "https://pub.dartlang.org"
+ source: hosted
+ version: "2.0.0"
  vector_math:
  dependency: transitive
  description:

Mobile_app/smart_mask/pubspec.yaml

@@ -21,6 +21,7 @@ dependencies:
  ext_storage: ^1.0.3
  csv: ^5.0.0
  flutter_launcher_icons: ^0.9.0
+ url_launcher: ^6.0.3
 
 dev_dependencies:
  flutter_test:
@@ -29,8 +30,10 @@ dev_dependencies:
 flutter:
  uses-material-design: true
  assets:
- - assets/icon/smart_mask_logo_3.png
- - assets/icon/smart_mask_logo_3_75px.png
+ - assets/icons/smart_mask_logo_3.png
+ - assets/icons/smart_mask_logo_3_75px.png
+ - assets/images/smart_mask_altium.png
+ - assets/images/smart_mask_hardware.jpg
 
 analyzer:
  enable-experiment:
@@ -39,4 +42,4 @@ analyzer:
 flutter_icons:
  android: "launcher_icon"
  ios: true
- image_path: "assets/icon/smart_mask_logo_3.png"
+ image_path: "assets/icons/smart_mask_logo_3.png"

Overal_requirements.txt

@@ -0,0 +1,12 @@
+
+Printed Circuit Board (PCB)
+Altium >= 18.0
+Pseudoincorrect's Altium libraries : Latest (https://github.com/pseudoincorrect/Altium_Libraries)
+
+Embedded System Software
+Segger Embedded Studio (SES) >= 4.0
+(Stopped to use GNU ARM in favor to SES)
+
+Mobile App
+Flutter SDK >= 2.0
+VScode or Android Studio : Latest

README.md

@@ -1,9 +1,73 @@
-# SMART MASK
+<!-- <p align="center"><img width=12.5% src="/pseudoincorrect/smart_mask/Support/Readme_Assets/Images/smart_mask_logo_3.png"></p> -->
 
-Smart Mask is an embedded system connected to a mobile app to monitor health status with our custom printed sensors.
-> (project name will surely change)
+<p align="center"><img width=12.5% src="Support/Readme_Assets/Images/smart_mask_logo.png"></p>
 
-This System is divided into 3 parts (hence 3 folders here):
-- The Printed Circuit Board (PCB) for the embedded system, made with Altium Designer
-- The embedded system firmware, written in C (working with Nordic SDK)
-- A Flutter mobile application, for bluetooth connection and data storage/presentation
+<p align="center" style="font-size:4em"><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)
+
+<br>
+Smart Mask is an embedded system connected to a mobile app to monitor the outputs of our custom printed sensors.
+
+This System is divided into 3 parts:
+- A Printed Circuit Board (PCB) for the embedded system, made with Altium Designer
+- An embedded system firmware, written in C (Nordic SDK)
+- A Flutter mobile application, for bluetooth connection, data storage and presentation
+
+<br>
+<p align="center">
+<img align="center" width=30% src="Support/Readme_Assets/Images/mask_pcb_sensor.jpg">
+&nbsp;&nbsp;&nbsp;------&nbsp;&nbsp;&nbsp;
+<img align="center" width=10% src="Support/Readme_Assets/Images/bluetooth.png">
+&nbsp;&nbsp;&nbsp;------&nbsp;&nbsp;&nbsp;
+<img align="center" width=20% src="Support/Readme_Assets/Images/app_analytics.png">
+</p>
+<br>
+
+# Printed Circuit Board
+
+The PCB is developped with Altium (started initially with Cadsoft Eagle).<br>
+Sources and supportind documents are in the /PCB folder.
+
+<br>
+<p align="center">
+<img align="center" width=30% src="Support/Readme_Assets/Images/mask_pcb.jpg">
+&nbsp;&nbsp;&nbsp;------&nbsp;&nbsp;&nbsp;
+<img align="center" width=25% src="Support/Readme_Assets/Images/smart_mask_altium.png">
+</p>
+<br>
+
+# Mobile Application
+
+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.
+
+<br>
+<p align="center">
+<img align="center" width=20% src="Support/Readme_Assets/Images/app_graphs.png">
+</p>
+<br>
+
+# 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.
+
+<br>
+<p align="center">
+<img align="center" width=40% src="Support/Readme_Assets/Images/SES.jpg">
+</p>
+<br>
+<br>
+
+## Versatility
+This project is quite general in the use of the sensor and can be adapted to any bluetooth sensor combined with mobile app. In such case, forking this repository and adapting to a new solution would be a wise strategy.
+<br>
+
+## Remarks
+CAD files, embedded software and app are usually separated in different repositories. <br>
+Here as the project is still simple enough and self-contained, all parts are kepts together.
+<br>