Issue: Añadir información de documentación en README

Authors: - @o-hgm Objetivo Algutinar en README la información sobre: - Colaboración - Licencia - Listado de material - Funcionamiento del software, firmware - Ensamblado y Hardware Changelog * Añadir secciones pendientes para firmwar y hardware * Añadir descripción del proyecto
makespacemadrid · Apr 2, 2020 · f3c9049 · f3c9049
1 parent e96c3cc
commit f3c9049
Show file tree

Hide file tree

Showing 6 changed files with 119 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -1,89 +1,70 @@
 # ApolloVentilator
 
-Information: Checkout our [wiki](https://github.com/makespacemadrid/ApolloVentilator/wiki)
 
-## Getting started
+ApolloVentillator es un proyecto colaborativo para la construcción de equipos de respiración asistida libres que surge a raíz de la crisis del COVID-19. Su misión es apoyar a los equipos sanitarios aportando respiradores en momentos de escasez de estos dispositivos.
 
-### Linux
+Los objetivos de este proyecto son:
+
+- Durabilidad. Debe permitir ser usado como apoyo a la respiración del paciente de manera continuada durante al menos 2 semanas.
+- Seguridad. Debe cumplir los requisitos de calidad necesarios para poder ser utilizado de forma segura.
+- Replicabilidad. Debe poder ser replicados con facilidad.Los materiales deben ser fáciles de conseguir y su montaje debe ser sencillo y rápido.
+
+Al ser un proyecto en desarrollo continuo gran parte de la información se puede encontrar en nuestra [wiki](https://github.com/makespacemadrid/ApolloVentilator/wiki).
+
+El código se libera bajo la GPL 3. [Ver [LICENSE](LICENSE)] 
+
+
+## ¿Como colaborar?
+
+Actualmente nos encontramos agregando información en la wiki y trabajando en un prototipo.
+
+Puedes encontrar las notas de colaboración en [COLLABORATION](man/COLLABORATION.md).  
+
+
+## Requerimientos
+
+### Software
+
+#### Linux
 
 ```
 $ apt-get install libcairo2-dev libgirepository1.0-dev python3-cairo-dev
 ```
 
-### Mac
+#### Mac
 
 ```
 $ brew install pygobject3 gtk+3 libnotify
 ```
 
-### App (Python 3)
+### Firmware
+> TO DO: Requerimientos para cargar firmware (Dispositivo usado, entorno, etc...) 
 
-From ```./gui```
+### Hardware
+> TO DO Kicad, FreeCAD
 
-Install system dependencies (Debian-based):
+## Puntos de entrada
 
-```
+#### Software
+
+La aplicación está escrita en python3 utilizando el framework Qt5.
+
+Para lanzar la aplicación es necesario contar con las dependencias indicadas en el fichero
+`gui/requirements.txt`.
+
+
+```shell script
+$ cd gui
 $ pip install -r requirements.txt
 $ ./main.py
 ```
 
-## Requirements:
-2 ventilators mode
-* Pressure Regulated Volume Controlled (PCV): set pressure delivered during period of inspiration. The voume measured is shown as data on display. 
-* Volume Regulated Pressure controlled (VCV): The tidal volume is set and it adapts the pressure to the lowest. Here the important data are: tidal volume, upper alarm and lower current volume. Useful parameters: tidal volume, respiratory rate. There is a limit pressure and during inspiration period.
-
-If patient stops breathing, there is a failsafe that set to mandatory breathing when it's detected.
-
-During inspiration:
-
-* Inspiration pressure: The plateau pressure is adjusted to volume hard limit (32 cmH2O by default, and could increate to 70cmH2O)
-* Peak pressure: 2cmH2O greater than plateau.
-* VCV pressure limit (15-40cm2 with increments of 5)
-* Failsafe valve that opens always at 80cmH20 (or lower)
-
-* PEEP: 5-10 with increments of 5. The circuit must be pressured.
-* IE ratio: 1:1, 1:2, 1:3
-* Respiratory rate: 10-30 bpm with increments of 2.
-* Tidal volume: 40ml +-10, 350 +-50, 250-600 +-50,up to 8000. 
-* Weight body and volume calculated based on 6ml/kg.
-
-
-## Alarms
-
-* Gas failure
-* Electricity failure
-* Machine switched off
-* Inspiration pressure exceeded
-* Inspiration pressure not achieved
-* PEEP pressure not achieved
-* Tidal volume not achieved
-* Tidal volume exceeded
-* Resistance: peak pressure - plateau pressure > 2cmH2O
-* Compliance
-* Volume Leakage
-
-## Monitoring
-### Settings
-* Tidal volume
-* Frequency
-* PEEP
-* FI02
-* Ventilation Mode
-
-### Current status
-* Tidal volume
-* Breathing rate
-* PEEP
-* Plateau pressure
-* FI02
-
-The normal healthy O2 consuption is 250mL/min, and could be increased until, for example 500 mL/min in a sepsis.
-
-### Parallel measures 
-
-* Presión arteria
-* Frecuencia cardiaca
-* ECG
-* Nivel de sedación
-* Posicion del tubo e inflado del neumotaponamiento
-* Intercambio gaseoso (pulsiometria SO2), capnografía y gasometrías arteriales periodicas para obtener los **índices de oxigenación** (clave para evaluar la desintubación del paciente).
+#### Firmware
+
+> TO DO: Carga del firmware en dispositivo y funcionamiento
+
+## Modos de funcionamiento
+
+- Firmware: [Ver man/firmware.md](man/firmware.md)
+
+- Software y Monitorización: [Ver man/software.md](man/software.md)
diff --git a/DiagramaDeFlujo.png → man/DiagramaDeFlujo.png b/DiagramaDeFlujo.png → man/DiagramaDeFlujo.png
diff --git a/COLLABORATION.md → man/collaboration.md b/COLLABORATION.md → man/collaboration.md
diff --git a/man/firmware.md b/man/firmware.md
@@ -0,0 +1,36 @@
+# Firmware ApolloVentilator
+
+## Requirements:
+2 ventilators mode
+* Pressure Regulated Volume Controlled (PCV): set pressure delivered during period of inspiration. The voume measured is shown as data on display. 
+* Volume Regulated Pressure controlled (VCV): The tidal volume is set and it adapts the pressure to the lowest. Here the important data are: tidal volume, upper alarm and lower current volume. Useful parameters: tidal volume, respiratory rate. There is a limit pressure and during inspiration period.
+
+If patient stops breathing, there is a failsafe that set to mandatory breathing when it's detected.
+
+During inspiration:
+
+* Inspiration pressure: The plateau pressure is adjusted to volume hard limit (32 cmH2O by default, and could increate to 70cmH2O)
+* Peak pressure: 2cmH2O greater than plateau.
+* VCV pressure limit (15-40cm2 with increments of 5)
+* Failsafe valve that opens always at 80cmH20 (or lower)
+
+* PEEP: 5-10 with increments of 5. The circuit must be pressured.
+* IE ratio: 1:1, 1:2, 1:3
+* Respiratory rate: 10-30 bpm with increments of 2.
+* Tidal volume: 40ml +-10, 350 +-50, 250-600 +-50,up to 8000. 
+* Weight body and volume calculated based on 6ml/kg.
+
+
+## Alarms
+
+* Gas failure
+* Electricity failure
+* Machine switched off
+* Inspiration pressure exceeded
+* Inspiration pressure not achieved
+* PEEP pressure not achieved
+* Tidal volume not achieved
+* Tidal volume exceeded
+* Resistance: peak pressure - plateau pressure > 2cmH2O
+* Compliance
+* Volume Leakage
diff --git a/pseudocode.cpp → man/resources/pseudocode.cpp b/pseudocode.cpp → man/resources/pseudocode.cpp
diff --git a/man/software.md b/man/software.md
@@ -0,0 +1,34 @@
+# Software Monitorización ApolloVentilator
+
+## Elementos
+
+- Clase + CLI: Conversión y tratamiento de mensajes desde puerto serie.  
+- Interfaz: Implementa la visualización de datos, la configuración del sistema y el control
+   de las alarmas.  
+
+## Monitoring
+
+### Settings
+* Tidal volume
+* Frequency
+* PEEP
+* FI02
+* Ventilation Mode
+
+### Current status
+* Tidal volume
+* Breathing rate
+* PEEP
+* Plateau pressure
+* FI02
+
+The normal healthy O2 consuption is 250mL/min, and could be increased until, for example 500 mL/min in a sepsis.
+
+### Parallel measures 
+
+* Presión arteria
+* Frecuencia cardiaca
+* ECG
+* Nivel de sedación
+* Posicion del tubo e inflado del neumotaponamiento
+* Intercambio gaseoso (pulsiometria SO2), capnografía y gasometrías arteriales periodicas para obtener los **índices de oxigenación** (clave para evaluar la desintubación del paciente).