makers-for-life · dsferruzza · Nov 24, 2021 · Nov 24, 2021 · Nov 24, 2021 · Nov 24, 2021
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,12 +1,12 @@
 [package]
-name = "makair-control"
+name = "makair-control-ui"
 version = "2.4.0"
 description = "Control UI for the MakAir open source ventilator."
 readme = "README.md"
 license-file = "LICENSE.md"
-edition = "2018"
+edition = "2021"
 homepage = "https://github.com/makers-for-life/makair"
-repository = "https://github.com/makers-for-life/makair.git"
+repository = "https://github.com/makers-for-life/makair-control-ui"
 keywords = ["covid-19", "fusion-360", "cad", "covid", "coronavirus", "sars-cov-2", "nucleo-board", "covid-respirator", "makair-respirators", "medical", "ards"]
 categories = ["gui", "hardware-support"]
 authors = ["Valerian Saliou <[email protected]>", "Quentin Adam <[email protected]>", "David Sferruzza <[email protected]>"]
@@ -23,41 +23,40 @@ confy = "0.4"
 lazy_static = "1.4"
 serde = { version = "1.0", features = ["derive"] }
 paste = "1.0"
-rust-embed = { version = "5.6", default-features = false, features = ["compression"] }
+rust-embed = { version = "6.2", default-features = false, features = ["compression", "debug-embed"] }
 chrono = { version = "0.4", default-features = false }
-fluent = "0.15"
+fluent = "0.16"
 intl-memoizer = "0.5"
 unic-langid = "0.9"
 inflate = "0.4"
-winit = "0.19"
+winit = "0.25"
 image = { version = "0.23", default-features = false, features = ["png"] }
-glium = "0.24"
+glium = "0.30"
 plotters = { version = "0.3", default_features = false, features = ["chrono", "area_series"] }
-plotters-conrod = "0.3"
-conrod_glium = "0.70"
-conrod_winit = "0.70"
-conrod_core = "0.70"
-sysfs_gpio = { version = "0.5", optional = true }
+plotters-conrod = { git = "https://github.com/dsferruzza/plotters-conrod", branch = "conrod0.71-glium0.28-winit0.23" }
+conrod_glium = { git = "https://github.com/dsferruzza/conrod", branch = "update-glium-winit" }
+conrod_winit = { git = "https://github.com/dsferruzza/conrod", branch = "update-glium-winit" }
+conrod_core = { git = "https://github.com/dsferruzza/conrod", branch = "update-glium-winit" }
+sysfs_gpio = { version = "0.6", optional = true }
 rn2903 = { git = "https://github.com/waxzce/lora-rust-rn2903-rn2483.git", rev = "b086057ba096920abef3870ad0cefa2c80a343e2", optional = true }
-makair-telemetry = { git = "https://github.com/makers-for-life/makair-telemetry", tag = "v2.1.0", default-features = false, features = ["serial"] }
+makair-telemetry = { git = "https://github.com/makers-for-life/makair-telemetry", rev = "72e9bf31a9baa5f2ef143bdc313bf5124a5223e2", default-features = false }
+makair-simulator = { git = "https://github.com/makers-for-life/makair-simulator", rev = "0b91e1b6fd5740ea3cb379cc16f71d701ce66166", optional = true }
+
+[build-dependencies]
+winres = { git = "https://github.com/Skirmisher/winres", rev = "7333e0ff201d25eaaa70352682cd1a37614f93f4" } # https://github.com/mxre/winres/pull/36 is required
+
+[package.metadata.winres]
+ProductName = "MakAir Control UI"
+CompanyName = "Makers For Life"
+LegalCopyright = "Copyright © 2020, Makers For Life"
 
 [features]
-default = []
+default = ["serial"]
 fonts-cjk = []
 lora = ["rn2903", "sysfs_gpio"]
-
-[profile.dev]
-opt-level = 0
-debug = true
-debug-assertions = true
+serial = ["makair-telemetry/serial"]
+simulator = ["makair-simulator"]
 
 [profile.release]
-opt-level = 3
 lto = true
-debug = false
-debug-assertions = false
-
-[profile.bench]
-opt-level = 3
-debug = false
-debug-assertions = false
+codegen-units = 1
diff --git a/README.md b/README.md
@@ -81,6 +81,7 @@ The following options can be passed to the Control UI upon running it:
 * `--input={file}`: path to a telemetry record to play in the UI, where `{file}` is a record file (all UI controls will be inactive);
 * `--output={directory}`: path to directory in which telemetry records should be stored, where `{directory}` is a path (disabled by default);
 * `--fullscreen`: enables fullscreen mode (used on the final ventilator display only);
+* `--simulator`: use a [MakAir Simulator](https://github.com/makers-for-life/makair-simulator) instance as source of data (`simulator` build feature);
 * `--translation={locale}`: locale to use in the UI, where `{locale}` is a [supported locale code](#supported-translations) (defaults to `en`; overrides user settings);
 * `--disable-lora`: disables LoRa telemetry broadcasts (`lora` build feature);
 * `--lora-device={device}`: LoRa device path, where `{device}` is a path eg. `/dev/ttyAMA0` (`lora` build feature; defaults to `/dev/ttyAMA0`);
@@ -121,20 +122,38 @@ _Make sure to replace the `version` script argument with the current release ver
 
 **⚠️ Important note: this is still a work in progress. We are near cross-compiling capabilities, though some work still needs to be done due to non-MUSL C-based dependencies. See issue [#38](https://github.com/makers-for-life/makair-control-ui/issues/38).**
 
-## Optional Features
+## Compilation Features
+
+### Default Features
+
+By default, the Control UI comes with the following features:
+
+* **Support for telemetry/control over serial:**
+  * Feature name: `serial`
+  * Purpose: allow to open a serial device (using `-p [device]` or `--port [device]`) in order to get telemetry data from it and send control messages to it.
+
+It is possible to disable all default features at once by using the `--no-default-features` when building with Cargo.
+If some default features need to stay enabled, it is possible to add `--features [feature1],[feature2],...` to re-enable them.
+
+### Optional Features
 
 The Control UI behavior can be tuned at compile time, by enabling some optional features while building the binary:
 
 * **Support for CJK languages (eg. Chinese):**
   * Feature name: `fonts-cjk`
-  * Build command: `cargo build --features=fonts-cjk`
+  * Build command: `cargo build --features fonts-cjk`
   * Purpose: enables font support for CJK languages. As the CJK font weights 10MB+, and given that all assets get bundled in the final release binary, this feature is disabled by default as an optimization on binary size. If you need to use CJK languages in your MakAir ventilator, please build the Control UI with this feature enabled. Note that with this feature disabled, you will still be able to run with a CJK font, though all its glyphs will render as squares.
 
 * **Radio broadcasting of metrics over [LoRa / LoRaWAN](https://en.wikipedia.org/wiki/LoRa):**
   * Feature name: `lora`
-  * Build command: `cargo build --features=lora`
+  * Build command: `cargo build --features lora`
   * Purpose: enables periodic radio broadcasts of metrics, using an attached LoRa transmitter chip. This is an experimental feature, that is turned off by default. It aims at helping us build a central monitoring dashboard for hospitals, nesting all running MakAir metrics together.
 
+* **Embed [MakAir Simulator](https://github.com/makers-for-life/makair-simulator):**
+  * Feature name: `simulator`
+  * Build command: `cargo build --features simulator`
+  * Purpose: embed the MakAir Simulator projet, which means that using `-s` or `--simulator` will run the [MakAir Firmware](https://github.com/makers-for-life/makair-firmware) attached to a mathematical model that simulates sensors and actuators in a realistic way and allow to visualize/control it using Control UI.
+
 ## Prepared System Images
 
 Prepared system images that run on a Raspberry Pi and pack the Control UI are available in the [makair-files](https://github.com/makers-for-life/makair-files) repository (over Git LFS). They can be flashed to a microSD card and ran in a MakAir in a matter of minutes.

diff --git a/build.rs b/build.rs
@@ -0,0 +1,38 @@
+// MakAir Control UI
+//
+// Copyright: 2020, Makers For Life
+// License: Public Domain License
+
+fn main() {
+    // This is only useful when compiling to a Windows target
+    if std::env::var("CARGO_CFG_TARGET_FAMILY").unwrap_or_else(|_| "".to_owned()) == "windows"
+        && std::env::var("DISABLE_WINRES").is_err()
+    {
+        const ICON_PATH: &str = "res/images/app-icon.ico";
+        println!("cargo:rerun-if-changed={}", ICON_PATH);
+
+        let features = std::env::vars_os()
+            .flat_map(|(k, v)| {
+                let var_name = k.to_string_lossy();
+                match var_name.strip_prefix("CARGO_FEATURE_") {
+                    Some(name) if v == "1" => Some(name.to_lowercase()),
+                    _ => None,
+                }
+            })
+            .collect::<Vec<_>>()
+            .join(", ");
+
+        let mut res = winres::WindowsResource::new();
+        res.set_icon(ICON_PATH);
+        res.set(
+            "FileDescription",
+            &format!(
+                "{} Compiled with features: {}.",
+                env!("CARGO_PKG_DESCRIPTION"),
+                &features
+            ),
+        );
+        res.compile()
+            .expect("could not compile with Windows icon and metadata");
+    }
+}
diff --git a/res/images/app-icon.ico b/res/images/app-icon.ico
diff --git a/res/locales/de.ftl b/res/locales/de.ftl
@@ -54,6 +54,7 @@ mode-group-alarms = Alarm
 
 advanced-group-statistics = Statistiken
 advanced-group-settings = Optionen
+advanced-group-simulator = Simulator
 
 modal-close = Schließen
 modal-apply = Anwenden
@@ -105,6 +106,20 @@ modal-advanced-date = Datum
 modal-advanced-time = Zeit
 modal-advanced-timezone = Zeitzone
 
+modal-advanced-simulator-airway-resistance = Resistance
+modal-advanced-simulator-airway-compliance = Compliance
+modal-advanced-simulator-spontaneous-breath-rate = Breath rate
+modal-advanced-simulator-spontaneous-breath-effort = Breath effort
+modal-advanced-simulator-spontaneous-breath-duration = Breath duration
+modal-advanced-simulator-acceleration-factor = Acceleration percent
+
+modal-advanced-simulator-airway-resistance-unit = cmH2O/L/s
+modal-advanced-simulator-airway-compliance-unit = mL/cmH2O
+modal-advanced-simulator-spontaneous-breath-rate-unit = cycle/min
+modal-advanced-simulator-spontaneous-breath-effort-unit = cmH2O
+modal-advanced-simulator-spontaneous-breath-duration-unit = ms
+modal-advanced-simulator-acceleration-factor-unit = %
+
 initializing-connecting = Inbetriebnahme...
 initializing-connected = Initialisierung...
 

diff --git a/res/locales/en.ftl b/res/locales/en.ftl
@@ -54,6 +54,7 @@ mode-group-alarms = Alarms
 
 advanced-group-statistics = Statistics
 advanced-group-settings = Settings
+advanced-group-simulator = Simulator
 
 modal-close = Close
 modal-apply = Apply
@@ -105,6 +106,21 @@ modal-advanced-date = Date
 modal-advanced-time = Time
 modal-advanced-timezone = Timezone
 
+modal-advanced-simulator-airway-resistance = Resistance
+modal-advanced-simulator-airway-compliance = Compliance
+modal-advanced-simulator-spontaneous-breath-rate = Breath rate
+modal-advanced-simulator-spontaneous-breath-effort = Breath effort
+modal-advanced-simulator-spontaneous-breath-duration = Breath duration
+modal-advanced-simulator-acceleration-factor = Acceleration
+
+modal-advanced-simulator-airway-resistance-unit = cmH2O/L/s
+modal-advanced-simulator-airway-compliance-unit = mL/cmH2O
+modal-advanced-simulator-spontaneous-breath-rate-unit = cycle/min
+modal-advanced-simulator-spontaneous-breath-effort-unit = cmH2O
+modal-advanced-simulator-spontaneous-breath-duration-unit = ms
+modal-advanced-simulator-acceleration-factor-unit = %
+
+
 initializing-connecting = Starting up...
 initializing-connected = Initializing...
 

diff --git a/res/locales/es.ftl b/res/locales/es.ftl
@@ -54,6 +54,8 @@ mode-group-alarms = Alarmas
 
 advanced-group-statistics = Estadísticas
 advanced-group-settings = Configuraciones
+advanced-group-simulator = Simulator
+
 
 modal-close = Cerca
 modal-apply = Aplicar
@@ -105,6 +107,20 @@ modal-advanced-date = Fecha
 modal-advanced-time = Hora
 modal-advanced-timezone = Zona horaria
 
+modal-advanced-simulator-airway-resistance = Resistance
+modal-advanced-simulator-airway-compliance = Compliance
+modal-advanced-simulator-spontaneous-breath-rate = Breath rate
+modal-advanced-simulator-spontaneous-breath-effort = Breath effort
+modal-advanced-simulator-spontaneous-breath-duration = Breath duration
+modal-advanced-simulator-acceleration-factor = Acceleration percent
+
+modal-advanced-simulator-airway-resistance-unit = cmH2O/L/s
+modal-advanced-simulator-airway-compliance-unit = mL/cmH2O
+modal-advanced-simulator-spontaneous-breath-rate-unit = cycle/min
+modal-advanced-simulator-spontaneous-breath-effort-unit = cmH2O
+modal-advanced-simulator-spontaneous-breath-duration-unit = ms
+modal-advanced-simulator-acceleration-factor-unit = %
+
 initializing-connecting = Empezando...
 initializing-connected = Inicializando...
 

diff --git a/res/locales/fr.ftl b/res/locales/fr.ftl
@@ -54,6 +54,8 @@ mode-group-alarms = Alarmes
 
 advanced-group-statistics = Statistiques
 advanced-group-settings = Paramètres
+advanced-group-simulator = Simulateur
+
 
 modal-close = Fermer
 modal-apply = Valider
@@ -105,6 +107,20 @@ modal-advanced-date = Date
 modal-advanced-time = Heure
 modal-advanced-timezone = Fuseau horaire
 
+modal-advanced-simulator-airway-resistance = Résistance
+modal-advanced-simulator-airway-compliance = Compliance
+modal-advanced-simulator-spontaneous-breath-rate = Fréquence respiratoire
+modal-advanced-simulator-spontaneous-breath-effort = Effort spontané
+modal-advanced-simulator-spontaneous-breath-duration = Durée d'effort
+modal-advanced-simulator-acceleration-factor = Accélération du temps
+
+modal-advanced-simulator-airway-resistance-unit = cmH2O/L/s
+modal-advanced-simulator-airway-compliance-unit = mL/cmH2O
+modal-advanced-simulator-spontaneous-breath-rate-unit = /min
+modal-advanced-simulator-spontaneous-breath-effort-unit = cmH2O
+modal-advanced-simulator-spontaneous-breath-duration-unit = ms
+modal-advanced-simulator-acceleration-factor-unit = %
+
 initializing-connecting = Démarrage en cours...
 initializing-connected = Préparation en cours...
 

diff --git a/res/locales/it.ftl b/res/locales/it.ftl
@@ -54,6 +54,8 @@ mode-group-alarms = Allarmi
 
 advanced-group-statistics = Statistiche
 advanced-group-settings = Impostazioni
+advanced-group-simulator = Simulator
+
 
 modal-close = Cerca
 modal-apply = Aplicar
@@ -105,6 +107,20 @@ modal-advanced-date = Data
 modal-advanced-time = Tempo
 modal-advanced-timezone = Fuso orario
 
+modal-advanced-simulator-airway-resistance = Resistance
+modal-advanced-simulator-airway-compliance = Compliance
+modal-advanced-simulator-spontaneous-breath-rate = Breath rate
+modal-advanced-simulator-spontaneous-breath-effort = Breath effort
+modal-advanced-simulator-spontaneous-breath-duration = Breath duration
+modal-advanced-simulator-acceleration-factor = Acceleration percent
+
+modal-advanced-simulator-airway-resistance-unit = cmH2O/L/s
+modal-advanced-simulator-airway-compliance-unit = mL/cmH2O
+modal-advanced-simulator-spontaneous-breath-rate-unit = cycle/min
+modal-advanced-simulator-spontaneous-breath-effort-unit = cmH2O
+modal-advanced-simulator-spontaneous-breath-duration-unit = ms
+modal-advanced-simulator-acceleration-factor-unit = %
+
 initializing-connecting = Cominciando...
 initializing-connected = Inizializzazione in corso...
 

diff --git a/res/locales/lv.ftl b/res/locales/lv.ftl
@@ -54,6 +54,8 @@ mode-group-alarms = Signāli
 
 advanced-group-statistics = Statistika
 advanced-group-settings = Iestatījumi
+advanced-group-simulator = Simulator
+
 
 modal-close = Aizvērt
 modal-apply = Piesakies
@@ -105,6 +107,20 @@ modal-advanced-date = Datums
 modal-advanced-time = Laiks
 modal-advanced-timezone = Laika zona
 
+modal-advanced-simulator-airway-resistance = Resistance
+modal-advanced-simulator-airway-compliance = Compliance
+modal-advanced-simulator-spontaneous-breath-rate = Breath rate
+modal-advanced-simulator-spontaneous-breath-effort = Breath effort
+modal-advanced-simulator-spontaneous-breath-duration = Breath duration
+modal-advanced-simulator-acceleration-factor = Acceleration percent
+
+modal-advanced-simulator-airway-resistance-unit = cmH2O/L/s
+modal-advanced-simulator-airway-compliance-unit = mL/cmH2O
+modal-advanced-simulator-spontaneous-breath-rate-unit = cycle/min
+modal-advanced-simulator-spontaneous-breath-effort-unit = cmH2O
+modal-advanced-simulator-spontaneous-breath-duration-unit = ms
+modal-advanced-simulator-acceleration-factor-unit = %
+
 initializing-connecting = Notiek palaišana...
 initializing-connected = Notiek inicializēšana...
 

diff --git a/res/locales/pt.ftl b/res/locales/pt.ftl
@@ -54,6 +54,7 @@ mode-group-alarms = Alarmes
 
 advanced-group-statistics = Estatisticas
 advanced-group-settings = Configurações
+advanced-group-simulator = Simulator
 
 modal-close = Fechar
 modal-apply = Aplique
@@ -105,6 +106,20 @@ modal-advanced-date = Encontro
 modal-advanced-time = Tempo
 modal-advanced-timezone = Fuso horário
 
+modal-advanced-simulator-airway-resistance = Resistance
+modal-advanced-simulator-airway-compliance = Compliance
+modal-advanced-simulator-spontaneous-breath-rate = Breath rate
+modal-advanced-simulator-spontaneous-breath-effort = Breath effort
+modal-advanced-simulator-spontaneous-breath-duration = Breath duration
+modal-advanced-simulator-acceleration-factor = Acceleration percent
+
+modal-advanced-simulator-airway-resistance-unit = cmH2O/L/s
+modal-advanced-simulator-airway-compliance-unit = mL/cmH2O
+modal-advanced-simulator-spontaneous-breath-rate-unit = cycle/min
+modal-advanced-simulator-spontaneous-breath-effort-unit = cmH2O
+modal-advanced-simulator-spontaneous-breath-duration-unit = ms
+modal-advanced-simulator-acceleration-factor-unit = %
+
 initializing-connecting = Começando...
 initializing-connected = Inicializando...