ElektraInitiative · markus2330 · Oct 14, 2023 · Aug 23, 2023 · Aug 23, 2023 · Aug 28, 2023
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,8 +1,8 @@
 [package]
 name = "opensesame"
-version = "0.7.9"
+version = "0.8.0"
 authors = ["Opensesame Contributors"]
-edition = "2018"
+edition = "2021"
 readme = "README.md"
 license = "BSD"
 description  = "Awesome home automation"
@@ -44,25 +44,30 @@ i2cdev = "0.5.1"
 
 elektra = { version = "0.11.0", features = ["pkg-config"] }
 
-reqwest = "0.9.24"
+reqwest = { version = "0.11", features = ["json"] }
 
 bme280 = "0.3.0"
 mlx9061x = "0.2.1"
 linux-embedded-hal = { version = "0.3", features = ["gpio_cdev"] }
 
 systemstat = "0.1.11"
 
-ssh2 = "0.9.3"
+nix = "0.25"
+
 chrono = "0.4.19"
 
 signal-hook = "0.3.14"
 signal-hook-tokio = "0.3.1"
 
 tokio = { version = "1.15.0", features = ["full"] }
+tokio-util = "0.6.9"
+async-ssh2-tokio = "0.7.1"
 futures = "0.3.19"
-
 gettext-rs = "0.7.0"
 
+serde = "1.0.188"
+serde_json = "1.0.106"
+
 serial_test = "0.4.0" # TODO, remove when issues.libelektra.org/4466 is fixed
 
 sunrise = "1.0.0"

diff --git a/debian/service b/debian/service
@@ -1,7 +1,7 @@
 [Unit]
 Description=opensesame
-Wants=network-online.target
-After=network.target network-online.target
+Wants=network-online.target nss-lookup.target
+After=network.target network-online.target nss-lookup.target
 
 [Service]
 Type=simple

diff --git a/doc/Testreport_Async_Refactor.md b/doc/Testreport_Async_Refactor.md
@@ -0,0 +1,122 @@
+# Testing Async
+This is the testreport of the async refector of opensesame. (`-`) means that the test failed, (`~`) something went wrong but it works and (`+`) means that everything went as expected. Here is a list of the modules which need to be tested.
+
+1. **Siganls** 
+2. **Buttons (+Bell)**
+3. **Buttons+Garage**
+4. **Sensors**
+5. **ModIR**
+6. **Environment**
+7. **Weatherstation**
+8. **Battery**
+9. **Watchdog**
+10. **Ping**
+
+
+## Signals
+### Configuration
+```toml
+nextcloud.chat = "<chat-token>"
+nextcloud.chat.licht = "<chat-token>"
+nextcloud.chat.ping = "<chat-token>"
+nextcloud.chat.commands = "<chat-token>"
+nextcloud.user = "<user>"
+nextcloud.pass = "<pass>"
+nextcloud.url = "<nextcloud-url>"
+nextcloud.format.datetime = "%d.%m.%Y %H:%M:%S"
+nextcloud.format.time = "%H:%M:%S"
+validator.test1 = "14, 15 ,13 ,15, 11, 15, 7, 15"
+validator.test2 = "14, 12, 14, 15, 11, 15"
+buttons.enable = 0
+bell.enable = 0 
+garage.enable = 0 
+sensors.enable = 0
+environment.enable = 0 
+ir.enable = 0
+weatherstation.enable = 0
+bat.enable = 0
+watchdog.enable = 0 
+ping.enable = 0
+```
+### (`-`): This module doesn't enter the async-loop, because of problems with `spawn_local`
+
+## Buttons
+### Configuration 
+```toml
+...
+buttons.enable = 1
+...
+```
+### (`+`): light button; light switch; light permanent; light time extended; pin validation
+### (`~`): First entering of pin caused time `sequence timeout`, the timeout was too fast. Besides this one failure it worked fine. Cloud be a startup issue.
+
+## Buttons + Bell
+### Configuration
+```toml
+...
+buttons.enable = 1
+bell.enable = 1
+...
+```
+### (`+`): bell and buttons worked
+
+## Buttons + Garage
+### Configuration
+```toml
+...
+buttons.enable = 1
+garage.enable = 1
+...
+```
+### (`+`): endposition garage door; TasterTorUnten (no NC message); TasterUnten (no NC message); TasterOben
+### (`~`): TasterTorOben switched only the light indoor at the first time, after a retry it switch both
+
+## Sensors
+### Configuration
+```toml
+...
+sensors.enable = 1
+sensors.device = "/dev/ttyACM0"
+sensors."#0".loc = "Wohnzimmer"
+sensors."#0".alarm = 50
+sensors."#0".chat = 20
+sensors."#1".loc = "Badezimmer"
+sensors."#1".alarm = 70
+sensors."#1".chat = 35
+sensors."#2".loc = "Küche"
+sensors."#2".alarm = 5
+sensors."#2".chat = 3
+...
+```
+For simulating the sensors we used the methode with is described in [DevelopmentSetup](./DevelopmentSetup.md). With the following script:
+```bash
+COUNTER=0;
+while true; do
+    let COUNTER=COUNTER+1
+    if [ $COUNTER -eq 20 ]; then
+        data="23 35 4 0 0 0 0 0 0 0 0 0"
+	elif [ $COUNTER -eq 100 ]; then
+		data="55 80 10 0 0 0 0 0 0 0 0 0"
+	elif [ $COUNTER -eq 130 ]; then 
+		data="1005 2015 1102 0 0 0 0 0 0 0 0 0"
+    else
+        data="0 0 0 0 0 0 0 0 0 0 0 0"
+    fi
+    echo "$data"
+    sleep 60
+done
+```
+### (`+`): Chat and Alarm trigger worked as expected
+### (`~`): **!!! implementation of state mutex is missing in async function of sensors !!!**
+
+## Weatherstation
+### Configuration
+```toml
+...
+weatherstation.enable = 1
+weatherstation.data.interval = 60
+weatherstation.opensensemap.id = "64cb602193c69500072a580f"
+weatherstation.opensensemap.token = "7bbb014ffbf974255caef2f88525b0512bd0817d9d222f70c7741a4a9cd56c6c"
+...
+```
+### (`+`): Works as expected, sends warning to Nextcloud and updates opensensemap.org
diff --git a/doc/modules.md b/doc/modules.md
@@ -0,0 +1,56 @@
+# OpenSesame
+
+## audio.rs
+This module handles audio output for playing fire alarms and bell sounds. This module can receive commands from the Module Buttons (Bell), Environment (FireAlarm), Nextcloud (FireAlarm, Bell), and Signals (FireAlarm, Bell).
+
+## bat.rs
+Checks the battery capacity every ten minutes and outputs to Nextcloud if it falls below 50%. If it goes below 50%, the threshold for the next Nextcloud message is set to 40%.
+
+## buttons.rs
+This module implements the `do_reset` if an error occurs on the MOD-IO2 modules. In the `async get_background_task`, we implemented how the buttons were handled in the old main, including the validator and command receiver. The command receiver receives commands like `opendoor` (used by Garage, Nextcloud), `ring_bell` (used by Environment, Signals), `switchlights` (used by Garage, Nextcloud), and `RingBellAlarm` (used by Signals).
+
+## clima_sensor_us.rs 
+This module works independently, sending warnings to Nextcloud and publishing to opensensemap. We needed to implement `Send` to use libmodbus with async functions.
+
+## config.rs
+No changes were made to this module.
+
+## environment.rs
+Changed the functions `rememberBaseline`, `restoreBaseline`, and added a `Muext` of state. We moved `handle_environment` from the main into the `get_background_task`. This module receives commands (RestoreBaseline, RememberBaseline) from Signals.
+
+## garage.rs
+This module is checked at intervals of 10 milliseconds, triggering Nextcloud Chat or Buttons commands if the button is pressed. Future changes will involve removing the interval and implementing trigger-oriented events because GPIO pins from the Olimex board are used, along with interrupts.
+
+## mod_ir_temp.rs
+This module is triggered at given intervals and warns by sending Nextcloud messages.
+
+## nextcloud.rs 
+Implements two loops: one for sending (`message_sender_loop`) messages and status to Nextcloud, and the other for receiving (`command_loop`) messages/commands from Nextcloud. Commands can be sent via Nextcloud chat by typing "\opensesame" to open the door, or other commands like "\ring_bell", "\fire_alarm", "\status", and "\switchlights true true".
+
+## ping.rs
+This module sends a ping message to Nextcloud if it receives the `SendPing` event. Other functions update `Env`, `EnvStatus`, `EnvError`, and `BatCapacity`, but these commands aren't used yet. They need to be triggered at the right spot in Environment and Battery to keep the ping up to date.
+
+## pwr.rs 
+No significant changes were made to this module.
+
+## sensors.rs 
+No major changes, only the `get_background_task` was added with a similar implementation as in the old version.
+
+## signals.rs 
+This module listens to system signals and executes the same events as in the old version.
+
+## ssh.rs 
+Changed to an async function.
+
+## types.rs
+This module contains the error types defined so far.
+
+## validator.rs
+No changes were made to this module.
+
+## watchdog.rs
+This background task is triggered every few seconds and writes to the specified file. The `test_get_background_task` function is used to simulate the watchdog stopping writing to the watchdog file.
+
+## main.rs
+In this loop, we initialize every module if it is enabled. Additionally, the MPSC (Multiple Producer, Single Consumer) channels are initialized here. To configure each module without encountering issues related to multiple access to one config object, we read the configuration in the main.
+
diff --git a/files/emu_dev/emulate.sh b/files/emu_dev/emulate.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+socat -d -d pty,raw,echo=0,link=../fakettyACM0 exec:./payload.sh
diff --git a/files/emu_dev/payload.sh b/files/emu_dev/payload.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+while true; do
+    data="12 23 45 66 554 34 23 54 12 32 32 43"
+    echo "$data"
+    sleep 10
+done
diff --git a/files/opensesame.spec b/files/opensesame.spec
@@ -54,6 +54,11 @@ description = which chat to use for sending ping messages. Note: this chat will
 required =
 check/length/max = 8
 
+[nextcloud/chat/commands]
+description = which chat is used to send commands to Opensesame.
+required =
+check/length/max = 8
+
 [nextcloud/format/time]
 description=Format to be used for formatting time within Nextcloud messages, e.g. when entry gets prohibited because of time. By default ISO 8601 (Hour-minute-second format). Example is locales time.
 see/#0 = nextcloud/format/date
@@ -116,16 +121,29 @@ type = boolean
 example = 1
 default = 0
 
+[watchdog/interval]
+description=Trigger interval in seconds for Watchdog
+default = 10
+
+[watchdog/path]
+description=Device path of Watchdog
+default = "/dev/watchdog"
+
 [environment/device]
 description=Which device to use for the environment sensor. /dev/null means that no environment sensor is connected.
 example = "/dev/i2c"
 default = "/dev/null"
 
 [environment/data/interval]
 description=How often to get new data (default: every 60 seconds, which is the highest interval)
-default = 6000
+default = 60
 type = unsigned_short
 
+[sensors/enable]
+description = If the sensors module is enabled
+type = boolean
+default = 0
+
 [sensors]
 description = a list of up to 12 MQ135 sensors
 
@@ -161,6 +179,9 @@ type = unsigned_short
 description = maximum value measured during calibration
 type = unsigned_short
 
+[sensors/device]
+description = path of the sensor device
+default = "/dev/ttyACM0"
 
 [weatherstation/enable]
 description = enables/disables weatherstation
@@ -173,6 +194,7 @@ description = Which Opensensemap senseBoxes should be connected to the weather s
 
 [weatherstation/opensensemap/token]
 description = Access-Token for Opensensemap senseBoxes, see doc/Opensensemap.md
+
 [ir/enable]
 description=enables/disables MOD-IR-TEMP sensor
 example=1
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#!/bin/bash

		socat -d -d pty,raw,echo=0,link=../fakettyACM0 exec:./payload.sh