Fix script errors

Update to version 3.0.0

.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+build/
+dist/

.idea/.gitignore

@@ -1,3 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml

.idea/BiogasControllerApp.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="PYTHON_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-  <component name="PyDocumentationSettings">
-    <option name="format" value="PLAIN" />
-    <option name="myDocStringFormat" value="Plain" />
-  </component>
-</module>

.idea/inspectionProfiles/profiles_settings.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <settings>
-    <option name="USE_PROJECT_PROFILE" value="false" />
-    <version value="1.0" />
-  </settings>
-</component>

.idea/misc.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.10" project-jdk-type="Python SDK" />
-</project>

.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/BiogasControllerApp.iml" filepath="$PROJECT_DIR$/.idea/BiogasControllerApp.iml" />
-    </modules>
-  </component>
-</project>

.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

BiogasControllerApp-V2.3/.idea/.gitignore

@@ -1,3 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml

BiogasControllerApp-V2.3/.idea/.name

@@ -1 +0,0 @@
-biogascontrollerapp.py

BiogasControllerApp-V2.3/.idea/ENATECH.iml

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="PYTHON_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/venv" />
-    </content>
-    <orderEntry type="jdk" jdkName="Python 3.8" jdkType="Python SDK" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

BiogasControllerApp-V2.3/.idea/inspectionProfiles/profiles_settings.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <settings>
-    <option name="USE_PROJECT_PROFILE" value="false" />
-    <version value="1.0" />
-  </settings>
-</component>

BiogasControllerApp-V2.3/.idea/misc.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.8" project-jdk-type="Python SDK" />
-</project>

BiogasControllerApp-V2.3/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/ENATECH.iml" filepath="$PROJECT_DIR$/.idea/ENATECH.iml" />
-    </modules>
-  </component>
-</project>

BiogasControllerApp-V2.3/bin/gui/gui.kv

@@ -1,694 +0,0 @@
-RootScreen:
-    HomeScreen:
-    ReadoutScreen:
-    ReadData:
-    ProgramTemp:
-    Program:
-    Credits:
-    Modify:
-
-<InfoPU>:
-    title: "NOTICE"
-    size_hint: 0.7, 0.5
-    auto_dismiss: True
-    GridLayout:
-        cols:1
-        Label:
-            text: "THIS SOFTWARE IS FREE SOFTWARE LICENSED UNDER THE GNU GENERAL PUBLIC LICENSE V3 (GPL V3) AND AS SUCH COMES WITH ABSOLUTELY NO WARRANTY! \n\nmore info under Settings > Credits"
-            text_size: self.width, None
-        GridLayout:
-            cols: 2
-            Button:
-                text: "Don't show anymore"
-                on_release:
-                    root.notshowanymore()
-            Button:
-                text: "ok"
-                on_release:
-                    root.dismiss()
-<QuitPU>:
-    title: "BiogasControllerApp"
-    font_size: 50
-    size_hint: 0.5, 0.4
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "Are you sure you want to leave?"
-            font_size: 20
-        GridLayout:
-            cols:2
-            Button:
-                text: "Yes"
-                font_size: 15
-                on_release:
-                    root.quitapp()
-                    app.stop()
-            Button:
-                text: "No"
-                font_size: 15
-                on_press:
-                    root.dismiss()
-
-<NoConnection>:
-    title: "WARNING!"
-    font_size: 50
-    size_hint: 0.5, 0.4
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "Unable to open Serial Port"
-            font_size: 20
-        GridLayout:
-            cols:2
-            Button:
-                text: "Details"
-                on_release:
-                    root.details()
-            Button:
-                text:"Ok"
-                on_release:
-                    root.dismiss()
-
-<ConnectionFail>:
-    title: "WARNING!"
-    font_size: 50
-    size_hint: 0.7, 0.6
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "Unable to communicate"
-            font_size: 20
-        Label:
-            text: "Possible ways to resolve this problem:\n- Try again\n- Restart the PIC16F877 or reset the program\n- Check the cable / connect one"
-            font_size: 14
-        Button:
-            text:"Ok"
-            on_release:
-                root.dismiss()
-
-<DetailInfo>:
-    on_open: self.update_details = root.infos()
-    title: "DETAILS"
-    font_size: 50
-    size_hint: 1, 0.7
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "Unable to open Serial Port"
-            font_size: 20
-        Label:
-            id: errormessage
-            text: root.infos()
-            font_size: 13
-        Label:
-            text: root.error_tips()
-            font_size: 13
-        Button:
-            text:"Ok"
-            on_release:
-                root.dismiss()
-
-<Modeswitch>:
-    title: "NOTICE!"
-    font_size: 50
-    size_hint: 0.5, 0.4
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "Mode Switched!"
-            font_size: 30
-        Button:
-            text:"Ok"
-            on_release:
-                root.dismiss()
-
-<SaveConf>:
-    title: "NOTICE!"
-    font_size: 50
-    size_hint: 0.5, 0.4
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "SAVED!"
-            font_size: 30
-        Button:
-            text:"Ok"
-            on_release:
-                root.dismiss()
-
-<Connecting_PU>:
-    title: "NOTICE!"
-    font_size: 50
-    size_hint: 0.5, 0.4
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "Establishing connection with PIC16F877"
-            font_size: 18
-        Label:
-            text: "This Process may take a while..."
-            font_size: 15
-        Button:
-            text:"Ok"
-            on_release:
-                root.dismiss()
-
-<MissingFieldsError>:
-    title: "WARNING!"
-    font_size: 50
-    size_hint: 0.5, 0.4
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "Missing Information!"
-            font_size: 18
-        Label:
-            text: "Check your entry"
-            font_size: 15
-        Button:
-            text:"Ok"
-            on_release:
-                root.dismiss()
-
-<Disconnecting_PU>:
-    title: "NOTICE!"
-    font_size: 50
-    size_hint: 0.5, 0.4
-    auto_dismiss: False
-    GridLayout:
-        cols:1
-        Label:
-            text: "Connection with PIC16F877 terminated"
-            font_size: 18
-        Label:
-            text: "The connection to the Microcontroller\nhas been terminated successfully"
-            font_size: 15
-        Button:
-            text:"Ok"
-            on_release:
-                root.dismiss()
-
-######################################
-# SCREENS
-######################################
-<HomeScreen>:
-    name: "HomeS"
-    canvas.before:
-        Color:
-            rgba: (50,50,50,0.2)
-        Rectangle:
-            size: self.size
-            pos: self.pos
-    GridLayout:
-        cols:1
-        Label:
-            text: "BiogasanlageControllerApp"
-            font_size: 50
-            color: (0, 113, 0, 1)
-            bold:True
-            italic:True
-        FloatLayout:
-            GridLayout:
-                cols: 2
-                size_hint: 0.8, 0.8
-                pos_hint: {"x": 0.1, "y": 0.1}
-                Button:
-                    text: "Start"
-                    background_color: (255, 0, 0, 0.6)
-                    font_size: 30
-                    on_release:
-                        root.tryconnection()
-                Button:
-                    text: "Quit"
-                    background_color: (255, 0, 0, 0.6)
-                    font_size: 30
-                    on_release:
-                        root.exitapp()
-            Label:
-                text: root.reset()
-                id: app_version
-                font_size: 13
-                pos_hint: {"y": -0.45, "x":0.05}
-            Button:
-                text: "Settings"
-                font_size: 13
-                size_hint: 0.07, 0.06
-                pos_hint: {"x":0.01, "y":0.01}
-                background_color: (50, 0, 0, 0.2)
-                on_release:
-                    app.root.current = "Settings"
-                    root.manager.transition.direction = "down"
-
-<ReadoutScreen>:
-    on_pre_enter: self.reset_screen = root.resscreen()
-    name: "Readout"
-    canvas.before:
-        Color:
-            rgba: (50,50,50,0.2)
-        Rectangle:
-            size: self.size
-            pos: self.pos
-    GridLayout:
-    FloatLayout:
-        Label:
-            pos_hint: {"y":0.4}
-            text: "READOUT"
-            font_size: 40
-            color: (0, 113, 0, 1)
-            bold: True
-        GridLayout:
-            cols:4
-            size_hint: 0.8, 0.3
-            pos_hint: {"x":0.1, "y":0.4}
-            Label:
-                text: "SENSOR 1: "
-                font_size: 20
-            Label:
-                id: sonde1
-                text: ""
-            Label:
-                text: "SENSOR 2: "
-                font_size: 20
-            Label:
-                id: sonde2
-                text: ""
-            Label:
-                text: "SENSOR 3: "
-                font_size: 20
-            Label:
-                id: sonde3
-                text: ""
-            Label:
-                text: "SENSOR 4: "
-                font_size: 20
-            Label:
-                id: sonde4
-                text: ""
-        Button:
-            text: "Start communication"
-            size_hint: 0.2, 0.1
-            pos_hint: {"x": 0.5, "y": 0.05}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                root.start_com()
-        Button:
-            text: "End communication"
-            size_hint: 0.2, 0.1
-            pos_hint: {"x": 0.7, "y": 0.05}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                root.end_com()
-        Button:
-            text: "Back"
-            size_hint: 0.3, 0.1
-            pos_hint: {"x":0.05, "y":0.05}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                root.leave_screen()
-                app.root.current = "HomeS"
-                root.manager.transition.direction = "left"
-        ToggleButton:
-            id: mode_sel
-            size_hint: 0.15, 0.1
-            pos_hint: {"x":0.1, "y":0.2}
-            text: "Normal Mode" if self.state == "normal" else "Fast Mode"
-            on_text: root.switch_mode(mode_sel.text)
-            background_color: (255,0,0,0.6) if self.state == "normal" else (0,0,255,0.6)
-        Button:
-            text: "Read Data"
-            size_hint: 0.15, 0.1
-            pos_hint: {"x":0.3, "y":0.2}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                root.leave_screen()
-                app.root.current = "RD"
-                root.manager.transition.direction = "down"
-        Button:
-            text: "Temperature"
-            size_hint: 0.15, 0.1
-            pos_hint: {"x":0.5, "y":0.2}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                root.leave_screen()
-                app.root.current = "PT"
-                root.manager.transition.direction = "down"
-        Button:
-            text: "Change all Data"
-            size_hint: 0.15, 0.1
-            pos_hint: {"x":0.7, "y":0.2}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                root.leave_screen()
-                app.root.current = "PR"
-                root.manager.transition.direction = "down"
-        Label:
-            id: frequency
-            text: "Frequency will appear here"
-            font_size: 10
-            pos_hint: {"x":0.4, "y": 0.3}
-
-<ReadData>:
-    name: "RD"
-    canvas.before:
-        Color:
-            rgba: (50,50,50,0.2)
-        Rectangle:
-            size: self.size
-            pos: self.pos
-    GridLayout:
-    FloatLayout:
-        Label:
-            text: "Read Data"
-            font_size: 40
-            color: (0, 113, 0, 1)
-            bold: True
-            pos_hint: {"y":0.4}
-        Button:
-            text: "Start Readout"
-            size_hint: 0.2, 0.1
-            pos_hint: {"x":0.4, "y":0.1}
-            on_release:
-                root.read_data()
-        Button:
-            text: "Back"
-            size_hint: 0.2, 0.1
-            pos_hint: {"x":0.1, "y":0.1}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                app.root.current = "Readout"
-                root.manager.transition.direction = "up"
-        GridLayout:
-            cols:4
-            size_hint: 0.8, 0.4
-            pos_hint: {"x":0.1, "y":0.3}
-            Label:
-                text: "Sonde 1"
-                font_size: 20
-            Label:
-                id: inf_sonde1
-                text: ""
-            Label:
-                text: "Sonde 2"
-                font_size: 20
-            Label:
-                id: inf_sonde2
-                text: ""
-            Label:
-                text: "Sonde 3"
-                font_size: 20
-            Label:
-                id: inf_sonde3
-                text: ""
-            Label:
-                text: "Sonde 4"
-                font_size: 20
-            Label:
-                id: inf_sonde4
-                text: ""
-
-<ProgramTemp>:
-    on_pre_enter: self.check_config = root.read_config()
-    name: "PT"
-    canvas.before:
-        Color:
-            rgba: (50,50,50,0.2)
-        Rectangle:
-            size: self.size
-            pos: self.pos
-    FloatLayout:
-        Label:
-            text: "Change Temperature"
-            pos_hint: {"y":0.4}
-            font_size: 40
-            color: (0, 113, 0, 1)
-            bold: True
-        GridLayout:
-            size_hint: 0.8, 0.4
-            pos_hint: {"x": 0.1, "y":0.3}
-            cols:2
-            Label:
-                text: "Temperature Sensor 1: "
-            TextInput:
-                id: temp_s1
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Temperature Sensor 2: "
-            TextInput:
-                id: temp_s2
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Temperature Sensor 3: "
-            TextInput:
-                id: temp_s3
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Temperature Sensor 4: "
-            TextInput:
-                id: temp_s4
-                multiline: False
-                input_filter: "float"
-        Button:
-            text: "Back"
-            size_hint: 0.1, 0.1
-            pos_hint: {"x":0.1, "y":0.1}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                app.root.current = "Readout"
-                root.manager.transition.direction = "up"
-        ToggleButton:
-            id: prsel
-            size_hint: 0.2, 0.1
-            pos_hint: {"x":0.35, "y": 0.1}
-            text: "Full\nreprogramming" if self.state == "normal" else "Partial\nreprogramming"
-            on_release: root.change_mode()
-            background_color: (255,0,0,0.6) if self.state == "normal" else (0,0,255,0.6)
-        Button:
-            text: "Save"
-            size_hint: 0.2, 0.1
-            pos_hint: {"x":0.6, "y":0.1}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                root.send_data()
-
-<Program>:
-    name: "PR"
-    on_pre_enter: self.check_config = root.read_config()
-    canvas.before:
-        Color:
-            rgba: (50,50,50,0.2)
-        Rectangle:
-            size: self.size
-            pos: self.pos
-    FloatLayout:
-        Label:
-            text: "Change all Data"
-            font_size: 40
-            color: (0, 113, 0, 1)
-            bold: True
-            pos_hint: {"y":0.4}
-        GridLayout:
-            size_hint: 0.8, 0.5
-            pos_hint: {"x":0.1, "y":0.2}
-            cols: 4
-            Label:
-                text: "Sensor 1, a:"
-            TextInput:
-                id: s1_a
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 1, b:"
-            TextInput:
-                id: s1_b
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 1, c:"
-            TextInput:
-                id: s1_c
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 1, Temp:"
-            TextInput:
-                id: s1_t
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 2, a:"
-            TextInput:
-                id: s2_a
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 2, b:"
-            TextInput:
-                id: s2_b
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 2, c:"
-            TextInput:
-                id: s2_c
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 2, Temp:"
-            TextInput:
-                id: s2_t
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 3, a:"
-            TextInput:
-                id: s3_a
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 3, b:"
-            TextInput:
-                id: s3_b
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 3, c:"
-            TextInput:
-                id: s3_c
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 3, Temp:"
-            TextInput:
-                id: s3_t
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 4, a:"
-            TextInput:
-                id: s4_a
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 4, b:"
-            TextInput:
-                id: s4_b
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 4, c:"
-            TextInput:
-                id: s4_c
-                multiline: False
-                input_filter: "float"
-            Label:
-                text: "Sensor 4, Temp:"
-            TextInput:
-                id: s4_t
-                multiline: False
-                input_filter: "float"
-        Button:
-            text: "Back"
-            size_hint: 0.1, 0.1
-            pos_hint: {"x":0.1, "y":0.1}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                app.root.current = "Readout"
-                root.manager.transition.direction = "up"
-        ToggleButton:
-            id: prsel
-            size_hint: 0.2, 0.1
-            pos_hint: {"x":0.35, "y": 0.1}
-            text: "Full\nreprogramming" if self.state == "normal" else "Partial\nreprogramming"
-            on_release: root.change_mode()
-            background_color: (255,0,0,0.6) if self.state == "normal" else (0,0,255,0.6)
-        Button:
-            text: "Save"
-            size_hint: 0.2, 0.1
-            pos_hint: {"x":0.6, "y":0.1}
-            background_color: (255, 0, 0, 0.6)
-            on_release:
-                root.send_data()
-
-
-<Credits>:
-    name: "Credits"
-    canvas.before:
-        Color:
-            rgba: (50,50,50,0.2)
-        Rectangle:
-            size: self.size
-            pos: self.pos
-    FloatLayout:
-        Button:
-            text: "back"
-            size_hint: 0.4, 0.2
-            pos_hint: {"x":0.3, "y":0.1}
-            on_release:
-                app.root.current = "Settings"
-                root.manager.transition.direction = "right"
-        GridLayout:
-            cols:1
-            pos_hint:{"x":0.05, "y":0.35}
-            size_hint: 0.9, 0.5
-            Label:
-                text: "This is a rework of the BiogasControllerApp V1, that was originally programmed by S. Reichmuth."
-            Label:
-                text: "Written by:                   Janis Hutz\nDesigned by:                Janis Hutz\nDesign language:         Kivy"
-            Label:
-                text: "This software is free Software licensed under the GPL V3 (GNU General Public License) and as such comes with absolutely no warranty. In return, you can use, modify, distribute or use any of the code of this software in your own project, if you reuse the same license. For more infos, you can find a copy of this license in the project folder."
-                text_size: self.width, None
-
-<Modify>:
-    on_pre_enter: self.config = root.read_config()
-    name: "Settings"
-    canvas.before:
-        Color:
-            rgba: (50,50,50,0.2)
-        Rectangle:
-            size: self.size
-            pos: self.pos
-    GridLayout:
-        cols: 1
-        Label:
-            text: "Settings"
-            font_size: 40
-            color: (0, 113, 0, 1)
-            bold: True
-        FloatLayout:
-            GridLayout:
-                pos_hint: {"x":0.05, "y":0.05}
-                size_hint: 0.9, 0.9
-                cols: 4
-                Button:
-                    text: "Back"
-                    background_color: (255,0,0,0.6)
-                    on_release:
-                        app.root.current = "HomeS"
-                        root.manager.transition.direction = "up"
-                Button:
-                    text: "Report a\nBug"
-                    background_color: (255,0,0,0.6)
-                    on_release:
-                        root.issue_reporting()
-                ToggleButton:
-                    id: prsel
-                    text: "Full\nreprogramming" if self.state == "normal" else "Partial\nreprogramming"
-                    on_release: root.change_programming()
-                    background_color: (255,0,0,0.6) if self.state == "normal" else (0,0,255,0.6)
-                Button:
-                    text: "Credits"
-                    background_color: (255,0,0,0.6)
-                    on_release:
-                        app.root.current = "Credits"
-                        root.manager.transition.direction = "left"

BiogasControllerApp-V2.3/bin/lib/communication.py

@@ -1,96 +0,0 @@
-import bin.lib.lib
-com = bin.lib.lib.Com()
-
-
-class Communication:
-    def __init__(self):
-        self.__x = 0
-        self.__data_recieve = 0
-        self.__output = ""
-
-    def change_temp(self, data, special_port):
-        com.connect(19200, special_port)
-        com.send("PT")
-        self.go = 0
-        while True:
-            self.__data_recieve = com.decode_ascii(com.receive(1))
-            if self.__data_recieve == "\n":
-                self.__data_recieve = com.decode_ascii(com.receive(1))
-                if self.__data_recieve == "P":
-                    self.__data_recieve = com.decode_ascii(com.receive(1))
-                    if self.__data_recieve == "T":
-                        self.__data_recieve = com.decode_ascii(com.receive(1))
-                        if self.__data_recieve == "\n":
-                            self.go = 1
-                            break
-                        else:
-                            pass
-                    else:
-                        pass
-                else:
-                    pass
-            else:
-                pass
-        if self.go == 1:
-            self.data = data
-            while len(self.data) > 0:
-                self.__data_recieve = com.receive(3)
-                if self.__data_recieve != "":
-                    com.send_float(float(self.data.pop(0)))
-                else:
-                    print("error")
-                    break
-        else:
-            print("Error")
-        com.quitcom()
-
-    def change_all(self, data, special_port):
-        com.connect(19200, special_port)
-        com.send("PR")
-        self.go = 0
-        while True:
-            self.__data_recieve = com.decode_ascii(com.receive(1))
-            if self.__data_recieve == "\n":
-                self.__data_recieve = com.decode_ascii(com.receive(1))
-                if self.__data_recieve == "P":
-                    self.__data_recieve = com.decode_ascii(com.receive(1))
-                    if self.__data_recieve == "R":
-                        self.__data_recieve = com.decode_ascii(com.receive(1))
-                        if self.__data_recieve == "\n":
-                            self.go = 1
-                            break
-                        else:
-                            pass
-                    else:
-                        pass
-                else:
-                    pass
-            else:
-                pass
-        if self.go == 1:
-            self.data = data
-            while len(self.data) > 0:
-                self.__data_recieve = com.receive(3)
-                if self.__data_recieve != "":
-                    com.send_float(float(self.data.pop(0)))
-                else:
-                    print("error")
-                    break
-        else:
-            print("Error")
-        com.quitcom()
-
-
-class SwitchMode:
-    def __init__(self):
-        pass
-
-    def enable_fastmode(self, special_port):
-        com.connect(19200, special_port)
-        com.send("FM")
-        com.quitcom()
-
-    def disable_fastmode(self, special_port):
-        com.connect(19200, special_port)
-        com.send("NM")
-        com.quitcom()

BiogasControllerApp-V2.3/bin/lib/comport_search.py

@@ -1,22 +0,0 @@
-import serial.tools.list_ports
-
-
-class ComportService:
-    def __init__(self):
-        self.__comport = []
-        self.__import = []
-        self.__working = []
-
-    def get_comport(self, special_port):
-        self.__comport = [comport.device for comport in serial.tools.list_ports.comports()]
-        self.__pos = 0
-        if special_port != "":
-            self.__working = special_port
-        else:
-            while self.__working == []:
-                self.__com_name = serial.tools.list_ports.comports()[self.__pos]
-                if "USB-Serial Controller" or "Prolific USB-Serial Controller" in self.__com_name:
-                    self.__working = self.__comport.pop(self.__pos)
-                else:
-                    self.__pos += 1
-        return self.__working

BiogasControllerApp-V2.3/bin/lib/csv_parsers.py

@@ -1,122 +0,0 @@
-"""@package docstring
-This is a simplification of the csv module"""
-
-import csv
-
-
-class CsvRead:
-    """This is a class that reads csv files and depending on the module selected does do different things with it"""
-    def __init__(self):
-        self.__imp = ""
-        self.__raw = ""
-        self.__raw_list = ""
-
-    def importing(self, path):
-        """Returns a list of the imported csv-file, requires path, either direct system path or relative path"""
-        self.__imp = open(path)
-        self.__raw = csv.reader(self.__imp, delimiter=',')
-        self.__raw_list = list(self.__raw)
-        self.__imp.close()
-        return self.__raw_list
-
-
-class CsvWrite:
-    """This is a class that modifies csv files"""
-    def __init__(self):
-        self.__impl = []
-        self.__strpop = []
-        self.__removed = []
-        self.__removing = 0
-        self.__change = 0
-        self.__appending = 0
-        self.__imp = []
-        self.__raw = []
-
-    def rem_str(self, path, row):
-        """Opens the csv-file in write mode which is specified as an argument either as direct or relative path"""
-        self.__imp = open(path)
-        self.__raw = csv.reader(self.__imp, delimiter=',')
-        self.__impl = list(self.__raw)
-        self.__removed = self.__impl.pop(row + 1)
-        with open(path, "w") as removedata:
-            self.__removing = csv.writer(removedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-            self.__removing.writerow(self.__impl.pop(0))
-        while len(self.__impl) > 0:
-            with open(path, "a") as removedata:
-                self.__removing = csv.writer(removedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-                self.__removing.writerow(self.__impl.pop(0))
-        self.__imp.close()
-        removedata.close()
-
-
-    def chg_str(self, path, row, pos, new_value):
-        """Opens the csv-file in write mode to change a value, e.g. if a recipes is changed."""
-        self.__imp = open(path)
-        self.__raw = csv.reader(self.__imp, delimiter=',')
-        self.__impl = list(self.__raw)
-        self.__strpop = self.__impl.pop(row)
-        self.__strpop.pop(pos)
-        self.__strpop.insert(pos, new_value)
-        self.__impl.insert(row, self.__strpop)
-        with open(path, "w") as changedata:
-            self.__change = csv.writer(changedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-            self.__change.writerow(self.__impl.pop(0))
-        while len(self.__impl) > 0:
-            with open(path, "a") as changedata:
-                self.__removing = csv.writer(changedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-                self.__removing.writerow(self.__impl.pop(0))
-        self.__imp.close()
-        changedata.close()
-
-    def chg_str_rem(self, path, row, pos):
-        """Opens the csv-file in write mode to change a value, e.g. if a recipes is changed."""
-        self.__imp = open(path)
-        self.__raw = csv.reader(self.__imp, delimiter=',')
-        self.__impl = list(self.__raw)
-        self.__strpop = self.__impl.pop(row)
-        self.__strpop.pop(pos)
-        self.__strpop.pop(pos)
-        self.__impl.insert(row, self.__strpop)
-        with open(path, "w") as changedata:
-            self.__change = csv.writer(changedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-            self.__change.writerow(self.__impl.pop(0))
-        while len(self.__impl) > 0:
-            with open(path, "a") as changedata:
-                self.__removing = csv.writer(changedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-                self.__removing.writerow(self.__impl.pop(0))
-        self.__imp.close()
-        changedata.close()
-
-    def chg_str_add(self, path, row, new_value1, new_value2):
-        """Opens the csv-file in write mode to change a value, e.g. if a recipes is changed."""
-        self.__imp = open(path)
-        self.__raw = csv.reader(self.__imp, delimiter=',')
-        self.__impl = list(self.__raw)
-        self.__strpop = self.__impl.pop(row)
-        self.__strpop.append(new_value1)
-        self.__strpop.append(new_value2)
-        self.__impl.insert(row, self.__strpop)
-        with open(path, "w") as changedata:
-            self.__change = csv.writer(changedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-            self.__change.writerow(self.__impl.pop(0))
-        while len(self.__impl) > 0:
-            with open(path, "a") as changedata:
-                self.__removing = csv.writer(changedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-                self.__removing.writerow(self.__impl.pop(0))
-        self.__imp.close()
-        changedata.close()
-
-    def app_str(self, path, value):
-        """Opens the csv-file in append mode and writes given input. CsvWrite.app_str(path, value).
-        Path can be specified both as direct or relative. value is a list. Will return an error if type of value is
-        not a list."""
-        with open(path, "a") as appenddata:
-            self.__appending = csv.writer(appenddata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-            self.__appending.writerow(value)
-        appenddata.close()
-
-    def write_str(self, path, value):
-        with open(path, "w") as writedata:
-            self.__change = csv.writer(writedata, delimiter=',', quoting=csv.QUOTE_MINIMAL)
-            self.__change.writerow(value)
-        writedata.close()

BiogasControllerApp-V2.3/bin/lib/lib.py

@@ -1,73 +0,0 @@
-import serial
-import struct
-import bin.lib.comport_search
-"""@package docstring
-This package can communicate with a microcontroller"""
-
-coms = bin.lib.comport_search.ComportService()
-
-
-class Com:
-    def __init__(self):
-        self.xr = ""
-        self.output = ""
-        self.str_input = ""
-        self.str_get_input = ""
-        self.xs = ""
-        self.__comport = '/dev/ttyUSB0'
-
-    def connect(self, baudrate, special_port):
-        try:
-            self.__comport = coms.get_comport(special_port)
-        except:
-            pass
-        self.ser = serial.Serial(self.__comport, baudrate=baudrate, timeout=5)
-
-    def quitcom(self):
-        try:
-            self.ser.close()
-        except:
-            pass
-
-    def receive(self, amount_bytes):
-        self.xr = self.ser.read(amount_bytes)
-        return self.xr
-
-    def decode_ascii(self, value):
-        try:
-            self.output = value.decode()
-        except:
-            self.output = "Error"
-        return self.output
-
-    def check_value(self, value_check, checked_value):
-        if value_check == checked_value:
-            return 1
-        else:
-            return 0
-
-    def decode_int(self, value):
-        self.i = int(value, base=16)
-        return self.i
-
-    def decode_float(self, value):
-        self.fs = str(value, 'ascii') + '00'
-        self.f = struct.unpack('>f', bytes.fromhex(self.fs))
-        return str(self.f[0])
-
-    def decode_float_2(self, value):
-        self.fs = str(value, 'ascii') + '0000'
-        self.f = struct.unpack('>f', bytes.fromhex(self.fs))
-        return str(self.f[0])
-
-    def get_input(self):
-        self.str_get_input = input("please enter a character to send: ")
-        return self.str_get_input
-
-    def send(self, str_input):
-        self.xs = str_input.encode()
-        self.ser.write(self.xs)
-
-    def send_float(self, float_input):
-        ba = bytearray(struct.pack('>f', float_input))
-        self.ser.write(ba[0:3])

BiogasControllerApp-V2.3/biogascontrollerapp.py

@@ -1,893 +0,0 @@
-import os
-import configparser
-import serial
-
-config = configparser.ConfigParser()
-config.read('./config/settings.ini')
-co = config['Dev Settings']['verbose']
-if co == "True":
-    pass
-else:
-    os.environ["KIVY_NO_CONSOLELOG"] = "1"
-
-import threading
-import platform
-import webbrowser
-from kivy.uix.screenmanager import Screen, ScreenManager
-from kivy.core.window import Window
-from kivy.uix.popup import Popup
-from kivy.app import App
-from kivy.lang import Builder
-from kivy.clock import mainthread, Clock
-import bin.lib.lib
-import bin.lib.communication
-import bin.lib.comport_search
-import bin.lib.csv_parsers
-import logging
-import datetime
-import time
-
-version_app = f"{config['Info']['version']}{config['Info']['subVersion']}"
-
-################################################################
-# LOGGER SETUP
-##################
-logging.basicConfig(level=logging.DEBUG, filename="./log/main_log.log", filemode="w")
-logs = f"./log/{datetime.datetime.now()}-log-main.log"
-logger = logging.getLogger(__name__)
-handler = logging.FileHandler(logs)
-formatter = logging.Formatter("%(levelname)s - %(asctime)s - %(name)s: %(message)s -- %(lineno)d")
-handler.setFormatter(formatter)
-logger.addHandler(handler)
-
-logger.setLevel(config['Dev Settings']['log_level'])
-logger.info(f"Logger initialized, app is running Version: {version_app}")
-#################################################################
-
-if config['Port Settings']['specificPort'] == "None" or "\"\"":
-    special_port = ""
-else:
-    special_port = config['Port Settings']['specificPort']
-cvr = bin.lib.csv_parsers.CsvRead()
-cvw = bin.lib.csv_parsers.CsvWrite()
-com = bin.lib.lib.Com()
-
-
-#################################################################
-# Settings Handler
-#########################
-class SettingsHandler:
-    def __init__(self):
-        self.ports = None
-        self.window_sizeh = 600
-        self.window_sizew = 800
-
-    def settingshandler(self):
-        self.ports = config['Port Settings']['specificPort']
-        self.window_sizeh = config['UI Config']['sizeH']
-        self.window_sizew = config['UI Config']['sizeW']
-        Window.size = (int(self.window_sizew), int(self.window_sizeh))
-
-
-#################################################################
-
-
-logger.info("Started modules")
-
-
-##################################################################
-# Popups
-##################################################################
-
-
-class QuitPU(Popup):
-    def quitapp(self):
-        com.quitcom()
-        logger.debug("App stopped")
-
-
-class NoConnection(Popup):
-    def details(self):
-        self.detailsinfo = DetailInfo()
-        self.detailsinfo.open()
-
-
-class DetailInfo(Popup):
-    update_details = ""
-    def infos(self):
-        self.err = ""
-        try:
-            com.connect(19200, special_port)
-            com.quitcom()
-        except Exception as err:
-            self.err += "Errormessage:\n"
-            self.err += str(err)
-            self.err += "\n-------------------------------------------------------------------------------------------------------------------------------------------------------------\n"
-        return str(self.err)
-
-    def error_tips(self):
-        self.err_tip = ""
-        try:
-            com.connect(19200, special_port)
-            com.quitcom()
-        except Exception as err:
-            self.err_tip += "Possible way to resolve the issue: \n\n"
-            if str(err)[0:10] == "[Errno 13]":
-                if platform.system() == "Linux":
-                    self.err_tip += f"Open a terminal and type in: sudo chmod 777 {bin.lib.comport_search.ComportService().get_comport(special_port)}"
-                elif platform.system() == "Macintosh":
-                    self.err_tip += "Give permission to access the cable"
-                elif platform.system() == "Windows":
-                    self.err_tip += "Try a different cable or install another driver"
-                else:
-                    self.err_tip += "Unknown OS"
-            elif str(err)[0:10] == "[Errno 2] ":
-                if platform.system() == "Linux":
-                    self.err_tip += "Connect a cable, open a terminal and type in: sudo chmod 777 /dev/ttyUSB0"
-                elif platform.system() == "Macintosh":
-                    self.err_tip += "Give permission to access the cable"
-                elif platform.system() == "Windows":
-                    self.err_tip += "Try a different cable or install another driver"
-                else:
-                    self.err_tip += "Unknown OS"
-            elif str(err)[0:34] == "could not open port '/dev/ttyUSB0'":
-                self.err_tip += "Please connect the PC with the microcontroller!"
-            elif str(err)[0:26] == f"could not open port '{bin.lib.comport_search.ComportService().get_comport(special_port)}'":
-                self.err_tip += "Try using a different cable or close all monitoring software (like MSI Afterburner)"
-            else:
-                self.err_tip += "Special Error, consult the manual of Serial"
-        return str(self.err_tip)
-
-
-class Modeswitch(Popup):
-    pass
-
-
-class Connecting_PU(Popup):
-    pass
-
-
-class Disconnecting_PU(Popup):
-    pass
-
-
-class MissingFieldsError(Popup):
-    pass
-
-
-class ConnectionFail(Popup):
-    pass
-
-
-class SaveConf(Popup):
-    pass
-
-
-class InfoPU(Popup):
-    def notshowanymore(self):
-        config.set("License", "show", "0")
-        with open("./config/settings.ini", "w") as configfile:
-            config.write(configfile)
-        self.dismiss()
-
-
-####################################################################
-# SCREENS
-####################################################################
-class HomeScreen(Screen):
-    def reset(self):
-        logger.info("HomeScreen initialised")
-        SettingsHandler().settingshandler()
-        self.connected = 1
-        self.info = f"You are currently running Version {version_app} - If you encounter a bug, please report it!"
-        try:
-            com.connect(19200, special_port)
-            com.quitcom()
-        except Exception as e:
-            self.connected = 0
-            logger.error(e)
-        return self.info
-
-    def openlicensepu(self):
-        self.licensepu = InfoPU()
-        self.licensepu.open()
-
-    def tryconnection(self):
-        if config["License"]["show"] == "1":
-            self.openlicensepu()
-            logger.info("Showing License info")
-        else:
-            pass
-        try:
-            com.connect(19200, special_port)
-            com.quitcom()
-            self.connected = 1
-            self.manager.current = "Readout"
-            self.manager.transition.direction = "right"
-        except Exception as ex:
-            if config['Dev Settings']['disableConnectionCheck'] == "True":
-                self.connected = 1
-                self.manager.current = "Readout"
-                self.manager.transition.direction = "right"
-            else:
-                self.connected = 0
-                logger.error(f"COM_error: {ex}")
-                self.open_popup()
-
-    def open_popup(self):
-        self.popups = NoConnection()
-        self.popups.open()
-
-    def exitapp(self):
-        self.pup = QuitPU()
-        self.pup.open()
-
-
-class ReadoutScreen(Screen):
-    go = 1
-
-    def start_com(self):
-        self.comstart(1)
-        logger.info("Trying to start COM")
-
-    def comstart(self, pu_on):
-        try:
-            com.connect(19200, special_port)
-            self.go = 1
-        except Exception as e:
-            self.go = 0
-            logger.error(f"COM_error: {e}")
-
-        if self.go == 1:
-            logger.debug("COM start success")
-            self.parent.current = "Readout"
-            if pu_on == 1:
-                self.openstartpu()
-            else:
-                pass
-            self.communication = threading.Thread(name="communication", target=self.start_coms)
-            self.communication.start()
-        else:
-            self.openconnectionfailpu()
-
-    def end_com(self):
-        self.stopcom(1)
-
-    def stopcom(self, pu_on):
-        self.go = 0
-        try:
-            self.communication.join()
-        except Exception as e:
-            logger.warning(f"COM_Close_Error: {e}")
-        if pu_on == 1:
-            self.openendpu()
-        else:
-            pass
-
-    def start_coms(self):
-        self.check = 1
-        self.__level = 0
-        self.__distance = 0
-        self.__x = ""
-        self.__begin = time.time()
-        self.go = 1
-        logger.info("Starting COM_Hook")
-        while self.__x != "\n":
-            if time.time() - self.__begin > 5:
-                self.go = 0
-                break
-            else:
-                self.__x = com.decode_ascii(com.receive(1))
-
-        if self.go == 1:
-            logger.info("COM_Hook 1 success")
-            while self.__level < 3:
-                self.__x = com.decode_ascii(com.receive(1))
-                if self.__x == " ":
-                    if self.__distance == 4:
-                        self.__level += 1
-                    else:
-                        pass
-                    self.__distance = 0
-                else:
-                    if self.__distance > 4:
-                        self.__level = 0
-                        self.__distance = 0
-                    else:
-                        self.__distance += 1
-            self.check = 1
-            logger.info("COM_Hook successful")
-            com.receive(5)
-        else:
-            self.check = 0
-
-        while self.go == 1:
-            self.__starttime = time.time()
-            self.__output = ""
-            self.__data_recieve = com.receive(68)
-            self.__output += "Tadc: "
-            self.__output += str(com.decode_int(self.__data_recieve[0:4]))
-            self.__output += "\nTemperatur: "
-            self.__output += com.decode_float(self.__data_recieve[5:11])
-            self.__output += f"\nDuty-Cycle: {(float(com.decode_float_2(self.__data_recieve[48:52])) / 65535) * 100}%"
-            self.change_screen(1, self.__output)
-            self.__output = "Tadc: "
-            self.__output += str(com.decode_int(self.__data_recieve[12:16]))
-            self.__output += "\nTemperatur: "
-            self.__output += com.decode_float(self.__data_recieve[17:23])
-            self.__output += f"\nDuty-Cycle: {(float(com.decode_float_2(self.__data_recieve[53:57])) / 65535) * 100}%"
-            self.change_screen(2, self.__output)
-            self.__output = "Tadc: "
-            self.__output += str(com.decode_int(self.__data_recieve[24:28]))
-            self.__output += "\nTemperatur: "
-            self.__output += com.decode_float(self.__data_recieve[29:35])
-            self.__output += f"\nDuty-Cycle: {(float(com.decode_float_2(self.__data_recieve[58:62])) / 65535) * 100}%"
-            self.change_screen(3, self.__output)
-            self.__output = "Tadc: "
-            self.__output += str(com.decode_int(self.__data_recieve[36:40]))
-            self.__output += "\nTemperatur: "
-            self.__output += com.decode_float(self.__data_recieve[41:47])
-            self.__output += "\nDuty-Cycle: "
-            self.__output += f"\nDuty-Cycle: {(float(com.decode_float_2(self.__data_recieve[63:67])) / 65535) * 100}%"
-            self.change_screen(4, self.__output)
-            self.change_screen(5, f"F={1 / (time.time() - self.__starttime)}")
-        self.change_screen(6, "")
-        com.quitcom()
-
-    def switch_mode(self, text):
-        self.go = 0
-        try:
-            self.communication.join()
-            com.quitcom()
-            self.com_ok = 1
-            logger.info("Mode_Switch successful")
-        except Exception as e:
-            if e == serial.SerialException:
-                logger.info("No running process found, continuing")
-            else:
-                logger.fatal(f"FATAL ERROR OCCURED, APP WILL LEAVE NOW: {e}")
-            self.com_ok = 0
-
-        if self.com_ok == 1:
-            if text == "Normal Mode":
-                bin.lib.communication.SwitchMode().disable_fastmode(special_port)
-            else:
-                bin.lib.communication.SwitchMode().enable_fastmode(special_port)
-            logger.info("Switched mode, restarting COM")
-            self.openpupups()
-            self.comstart(0)
-            logger.info("COM restarted successfully")
-        else:
-            self.check = 1
-            self.ids.mode_sel.state = "normal"
-            self.openconnectionfailpu()
-
-    @mainthread
-    def change_screen(self, pos, value):
-        if pos == 1:
-            self.ids.sonde1.text = value
-        elif pos == 2:
-            self.ids.sonde2.text = value
-        elif pos == 3:
-            self.ids.sonde3.text = value
-        elif pos == 4:
-            self.ids.sonde4.text = value
-        elif pos == 6:
-            logger.error("COM_fail")
-            self.openconnectionfailpu()
-        else:
-            self.ids.frequency.text = value
-
-    def openpupups(self):
-        self.popup = Modeswitch()
-        self.popup.open()
-
-    def openendpu(self):
-        self.pu = Disconnecting_PU()
-        self.pu.open()
-
-    def openstartpu(self):
-        self.pup = Connecting_PU()
-        self.pup.open()
-
-    def openconnectionfailpu(self):
-        if self.check == 0:
-            self.cfpu = ConnectionFail()
-            self.cfpu.open()
-        else:
-            pass
-
-    def leave_screen(self):
-        logger.info("Stopping COM")
-        self.stopcom(0)
-
-    def resscreen(self):
-        logger.info("Screen reset")
-        self.ids.sonde1.text = ""
-        self.ids.sonde2.text = ""
-        self.ids.sonde3.text = ""
-        self.ids.sonde4.text = ""
-        self.ids.frequency.text = ""
-
-
-class Program(Screen):
-    def read_config(self):
-        logger.debug("Reading config")
-        self.config_imp = []
-        self.__export = []
-        self.config_imp = cvr.importing("./config/config.csv")
-        self.__export = self.config_imp.pop(0)
-        self.__extracted = self.__export.pop(0)
-        logger.debug(f"config {self.__extracted}")
-        if self.__extracted == "1":
-            self.ids.prsel.state = "normal"
-            self.ids.s1_a.text = ""
-            self.ids.s1_b.text = ""
-            self.ids.s1_c.text = ""
-            self.ids.s1_t.text = ""
-            self.ids.s2_a.text = ""
-            self.ids.s2_b.text = ""
-            self.ids.s2_c.text = ""
-            self.ids.s2_t.text = ""
-            self.ids.s3_a.text = ""
-            self.ids.s3_b.text = ""
-            self.ids.s3_c.text = ""
-            self.ids.s3_t.text = ""
-            self.ids.s4_a.text = ""
-            self.ids.s4_b.text = ""
-            self.ids.s4_c.text = ""
-            self.ids.s4_t.text = ""
-            self.__mode = 1
-        else:
-            self.ids.prsel.state = "down"
-            Clock.schedule_once(self.read_data, 1)
-            self.__mode = 2
-
-    def change_mode(self):
-        logger.info("Changing mode")
-        logger.debug(f"mode was: {self.__mode}")
-        if self.__mode == 1:
-            logger.debug("Sending instruction to read info")
-            Clock.schedule_once(self.read_data, 1)
-            self.__mode = 2
-        else:
-            self.ids.s1_a.text = ""
-            self.ids.s1_b.text = ""
-            self.ids.s1_c.text = ""
-            self.ids.s1_t.text = ""
-            self.ids.s2_a.text = ""
-            self.ids.s2_b.text = ""
-            self.ids.s2_c.text = ""
-            self.ids.s2_t.text = ""
-            self.ids.s3_a.text = ""
-            self.ids.s3_b.text = ""
-            self.ids.s3_c.text = ""
-            self.ids.s3_t.text = ""
-            self.ids.s4_a.text = ""
-            self.ids.s4_b.text = ""
-            self.ids.s4_c.text = ""
-            self.ids.s4_t.text = ""
-            self.__mode = 1
-
-    def read_data(self, dt):
-        logger.debug("Starting to read data from the microcontroller")
-        try:
-            com.connect(19200, special_port)
-            self.go = 1
-        except Exception as e:
-            self.go = 0
-            logger.error(f"COM_error: {e}")
-
-        if self.go == 1:
-            logger.info("Sending instructions")
-            com.send("RD")
-            self.__pos = 1
-            self.__beginning = time.time()
-            logger.info("Awaiting confirmation from the microcontroller for hook")
-            while True:
-                if time.time() - self.__beginning < 5:
-                    self.__data_recieve = com.decode_ascii(com.receive(1))
-                    if self.__data_recieve == "\n":
-                        self.__data_recieve = com.decode_ascii(com.receive(1))
-                        if self.__data_recieve == "R":
-                            self.__data_recieve = com.decode_ascii(com.receive(1))
-                            if self.__data_recieve == "D":
-                                self.__data_recieve = com.decode_ascii(com.receive(1))
-                                if self.__data_recieve == "\n":
-                                    self.go = 1
-                                    logger.info("Hook successful")
-                                    break
-                                else:
-                                    pass
-                            else:
-                                pass
-                        else:
-                            pass
-                    else:
-                        pass
-                else:
-                    self.go = 0
-                    logger.error("Microcontroller not available, stopping connection")
-                    break
-            if self.go == 1:
-                for i in range(4):
-                    self.__x = com.receive(28)
-                    self.__a = str(com.decode_float(self.__x[0:6]))
-                    self.__b = str(com.decode_float(self.__x[7:13]))
-                    self.__c = str(com.decode_float(self.__x[14:20]))
-                    self.__temp = str(com.decode_float(self.__x[21:27]))
-                    if self.__pos == 1:
-                        self.ids.s1_a.text = self.__a
-                        self.ids.s1_b.text = self.__b
-                        self.ids.s1_c.text = self.__c
-                        self.ids.s1_t.text = self.__temp
-                    elif self.__pos == 2:
-                        self.ids.s2_a.text = self.__a
-                        self.ids.s2_b.text = self.__b
-                        self.ids.s2_c.text = self.__c
-                        self.ids.s2_t.text = self.__temp
-                    elif self.__pos == 3:
-                        self.ids.s3_a.text = self.__a
-                        self.ids.s3_b.text = self.__b
-                        self.ids.s3_c.text = self.__c
-                        self.ids.s3_t.text = self.__temp
-                    elif self.__pos == 4:
-                        self.ids.s4_a.text = self.__a
-                        self.ids.s4_b.text = self.__b
-                        self.ids.s4_c.text = self.__c
-                        self.ids.s4_t.text = self.__temp
-                    self.__pos += 1
-                logger.info("Recieved info from microcontroller")
-            else:
-                self.open_confail_pu()
-            com.quitcom()
-        else:
-            self.open_confail_pu()
-
-    def create_com(self):
-        self.coms = bin.lib.communication.Communication()
-
-    def send_data(self):
-        try:
-            self.create_com()
-            self.go = 1
-        except Exception as e:
-            self.go = 0
-            logger.critical(f"TRANSMISSION_Error: {e}")
-
-        if self.go == 1:
-            logger.info("Preparing data to be sent")
-            self.__transmit = []
-            if self.ids.s1_a.text != "" and self.ids.s1_b.text != "" and self.ids.s1_c.text != "" and self.ids.s1_t.text != "" and self.ids.s2_a.text != "" and self.ids.s2_b.text != "" and self.ids.s2_c.text != "" and self.ids.s2_t.text != "" and self.ids.s3_a.text != "" and self.ids.s3_b.text != "" and self.ids.s3_c.text != "" and self.ids.s3_t.text != "" and self.ids.s4_a.text != "" and self.ids.s4_b.text != "" and self.ids.s4_c.text != "" and self.ids.s4_t.text != "":
-                self.__transmit.append(self.ids.s1_a.text)
-                self.__transmit.append(self.ids.s1_b.text)
-                self.__transmit.append(self.ids.s1_c.text)
-                self.__transmit.append(self.ids.s1_t.text)
-                self.__transmit.append(self.ids.s2_a.text)
-                self.__transmit.append(self.ids.s2_b.text)
-                self.__transmit.append(self.ids.s2_c.text)
-                self.__transmit.append(self.ids.s2_t.text)
-                self.__transmit.append(self.ids.s3_a.text)
-                self.__transmit.append(self.ids.s3_b.text)
-                self.__transmit.append(self.ids.s3_c.text)
-                self.__transmit.append(self.ids.s3_t.text)
-                self.__transmit.append(self.ids.s4_a.text)
-                self.__transmit.append(self.ids.s4_b.text)
-                self.__transmit.append(self.ids.s4_c.text)
-                self.__transmit.append(self.ids.s4_t.text)
-                logger.debug("trying to send...")
-                try:
-                    self.coms.change_all(self.__transmit, special_port)
-                    logger.info("Transmission successful")
-                    logger.debug("purging fields...")
-                    self.ids.s1_a.text = ""
-                    self.ids.s1_b.text = ""
-                    self.ids.s1_c.text = ""
-                    self.ids.s1_t.text = ""
-                    self.ids.s2_a.text = ""
-                    self.ids.s2_b.text = ""
-                    self.ids.s2_c.text = ""
-                    self.ids.s2_t.text = ""
-                    self.ids.s3_a.text = ""
-                    self.ids.s3_b.text = ""
-                    self.ids.s3_c.text = ""
-                    self.ids.s3_t.text = ""
-                    self.ids.s4_a.text = ""
-                    self.ids.s4_b.text = ""
-                    self.ids.s4_c.text = ""
-                    self.ids.s4_t.text = ""
-                    self.openconfpu()
-                except Exception as e:
-                    self.open_confail_pu()
-                    logger.critical(f"TRANSMITION_Error: {e}")
-            else:
-                self.openerrorpu()
-        else:
-            self.open_confail_pu()
-
-    def openerrorpu(self):
-        self.pu = MissingFieldsError()
-        self.pu.open()
-
-    def open_confail_pu(self):
-        self.cfpu = ConnectionFail()
-        self.cfpu.open()
-
-    def openconfpu(self):
-        self.confpus = SaveConf()
-        self.confpus.open()
-
-
-class ProgramTemp(Screen):
-    def read_config(self):
-        logger.debug("Reading config")
-        self.config_imp = []
-        self.__export = []
-        self.config_imp = cvr.importing("./config/config.csv")
-        self.__export = self.config_imp.pop(0)
-        self.__extracted = self.__export.pop(0)
-        logger.debug(f"Mode set is: {self.__extracted}")
-        if self.__extracted == "1":
-            self.ids.prsel.state = "normal"
-            self.ids.temp_s1.text = ""
-            self.ids.temp_s2.text = ""
-            self.ids.temp_s3.text = ""
-            self.ids.temp_s4.text = ""
-            self.__mode = 1
-        else:
-            self.ids.prsel.state = "down"
-            Clock.schedule_once(self.read_data, 1)
-            self.__mode = 2
-
-    def change_mode(self):
-        logger.info("Changing mode")
-        logger.debug(f"Mode was: {self.__mode}")
-        if self.__mode == 1:
-            logger.info("starting sub-thread")
-            Clock.schedule_once(self.read_data, 1)
-            self.__mode = 2
-        else:
-            logger.info("clearing screen")
-            self.ids.temp_s1.text = ""
-            self.ids.temp_s2.text = ""
-            self.ids.temp_s3.text = ""
-            self.ids.temp_s4.text = ""
-            self.__mode = 1
-
-    def read_data(self, dt):
-        logger.info("Trying to establish connection...")
-        try:
-            com.connect(19200, special_port)
-            self.go = 1
-        except Exception as e:
-            self.go = 0
-            logger.error(f"COM_Error: {e}")
-
-        if self.go == 1:
-            logger.info("Sending instructions to microcontroller...")
-            com.send("RD")
-            self.__pos = 1
-            self.__beginning = time.time()
-            self.go = 1
-            logger.info("Awaiting confirmation from the microcontroller for hook")
-            while True:
-                if time.time() - self.__beginning < 5:
-                    self.__data_recieve = com.decode_ascii(com.receive(1))
-                    if self.__data_recieve == "\n":
-                        self.__data_recieve = com.decode_ascii(com.receive(1))
-                        if self.__data_recieve == "R":
-                            self.__data_recieve = com.decode_ascii(com.receive(1))
-                            if self.__data_recieve == "D":
-                                self.__data_recieve = com.decode_ascii(com.receive(1))
-                                if self.__data_recieve == "\n":
-                                    self.go = 1
-                                    logger.info("Hook successful")
-                                    break
-                                else:
-                                    pass
-                            else:
-                                pass
-                        else:
-                            pass
-                    else:
-                        pass
-                else:
-                    self.go = 0
-                    logger.error("Microcontroller not available, stopping connection")
-                    break
-            if self.go == 1:
-                logger.info("Receiving data...")
-                for i in range(4):
-                    self.__x = com.receive(28)
-                    self.__output = str(com.decode_float(self.__x[21:27]))
-                    if self.__pos == 1:
-                        self.ids.temp_s1.text = self.__output
-                    elif self.__pos == 2:
-                        self.ids.temp_s2.text = self.__output
-                    elif self.__pos == 3:
-                        self.ids.temp_s3.text = self.__output
-                    elif self.__pos == 4:
-                        self.ids.temp_s4.text = self.__output
-                    self.__pos += 1
-                logger.info("Recieved data")
-                com.quitcom()
-            else:
-                self.open_confail_pu()
-
-    def create_com(self):
-        self.coms = bin.lib.communication.Communication()
-
-    def send_data(self):
-        try:
-            self.create_com()
-            self.go = 1
-        except Exception as e:
-            self.go = 0
-            logger.critical(f"COM_Error: Microcontroller unavailable: {e}")
-
-        if self.go == 1:
-            logger.info("Preparing transmission...")
-            self.__transmit = []
-            if self.ids.temp_s1.text != "" and self.ids.temp_s2.text != "" and self.ids.temp_s3.text != "" and self.ids.temp_s4.text != "":
-                self.__transmit.append(self.ids.temp_s1.text)
-                self.__transmit.append(self.ids.temp_s2.text)
-                self.__transmit.append(self.ids.temp_s3.text)
-                self.__transmit.append(self.ids.temp_s4.text)
-                logger.debug("Transmitting...")
-                self.coms.change_temp(self.__transmit, special_port)
-                self.ids.temp_s1.text = ""
-                self.ids.temp_s2.text = ""
-                self.ids.temp_s3.text = ""
-                self.ids.temp_s4.text = ""
-                self.openconfpu()
-            else:
-                self.openerrorpu()
-                logger.debug("Missing fields")
-        else:
-            self.open_confail_pu()
-
-    def openerrorpu(self):
-        self.pu = MissingFieldsError()
-        self.pu.open()
-
-    def openconfpu(self):
-        self.confpu = SaveConf()
-        self.confpu.open()
-
-    def open_confail_pu(self):
-        self.cfpu = ConnectionFail()
-        self.cfpu.open()
-
-
-class ReadData(Screen):
-    def read_data(self):
-        logger.info("Trying to connect to the microcontroller")
-        try:
-            com.connect(19200, special_port)
-            self.go = 1
-        except Exception as e:
-            self.go = 0
-            logger.error(f"COM_Error: {e}")
-
-        if self.go == 1:
-            logger.info("Sending instructions to the microcontroller...")
-            com.send("RD")
-            self.__pos = 1
-            self.__beginning = time.time()
-            self.go = 1
-            logger.info("Awaiting confirmation from the microcontroller for hook")
-            while True:
-                if time.time() - self.__beginning < 5:
-                    self.__data_recieve = com.decode_ascii(com.receive(1))
-                    if self.__data_recieve == "\n":
-                        self.__data_recieve = com.decode_ascii(com.receive(1))
-                        if self.__data_recieve == "R":
-                            self.__data_recieve = com.decode_ascii(com.receive(1))
-                            if self.__data_recieve == "D":
-                                self.__data_recieve = com.decode_ascii(com.receive(1))
-                                if self.__data_recieve == "\n":
-                                    self.go = 1
-                                    logger.info("Hook successful")
-                                    break
-                                else:
-                                    pass
-                            else:
-                                pass
-                        else:
-                            pass
-                    else:
-                        pass
-                else:
-                    self.go = 0
-                    logger.error("Microcontroller not available, stopping connection")
-                    break
-            if self.go == 1:
-                logger.info("Receiving data")
-                for i in range(4):
-                    self.__x = com.receive(28)
-                    self.__output = "a: "
-                    self.__output += str(com.decode_float(self.__x[0:6]))
-                    self.__output += f"\nb: {str(com.decode_float(self.__x[7:13]))}"
-                    self.__output += f"\nc: {str(com.decode_float(self.__x[14:20]))}"
-                    self.__output += f"\nTemp: {str(com.decode_float(self.__x[21:27]))}"
-                    if self.__pos == 1:
-                        self.ids.inf_sonde1.text = self.__output
-                    elif self.__pos == 2:
-                        self.ids.inf_sonde2.text = self.__output
-                    elif self.__pos == 3:
-                        self.ids.inf_sonde3.text = self.__output
-                    elif self.__pos == 4:
-                        self.ids.inf_sonde4.text = self.__output
-                    self.__pos += 1
-                logger.info("Received data")
-            else:
-                self.open_confail_pu()
-            com.quitcom()
-        else:
-            self.open_confail_pu()
-
-    def open_confail_pu(self):
-        self.cfpu = ConnectionFail()
-        self.cfpu.open()
-
-
-class Credits(Screen):
-    pass
-
-
-class Modify(Screen):
-    def read_config(self):
-        logger.debug("Reading config")
-        self.config_imp = []
-        self.__export = []
-        self.config_imp = cvr.importing("./config/config.csv")
-        self.__export = self.config_imp.pop(0)
-        self.__extracted = self.__export.pop(0)
-        logger.debug(f"Mode at: {self.__extracted}")
-        if self.__extracted == "1":
-            self.ids.prsel.state = "normal"
-        else:
-            self.ids.prsel.state = "down"
-
-    def issue_reporting(self):
-        logger.info("Clicked error reporting button")
-        webbrowser.open("https://github.com/simplePCBuilding/BiogasControllerApp/issues", new=2)
-
-    def change_programming(self):
-        logger.info("Switching programming mode")
-        self.csv_import = []
-        self.csv_import = cvr.importing("./config/config.csv")
-        self.csv_import.pop(0)
-        if self.ids.prsel.text == "Full\nreprogramming":
-            self.csv_import.insert(0, 1)
-        else:
-            self.csv_import.insert(0, 2)
-        logger.debug(f"Mode now: {self.csv_import}")
-        cvw.write_str("./config/config.csv", self.csv_import)
-
-
-########################################################
-# Screenmanager
-########################################################
-
-
-class RootScreen(ScreenManager):
-    pass
-
-
-class BiogasControllerApp(App):
-    def build(self):
-        self.icon = "./BiogasControllerAppLogo.png"
-        self.title = "BiogasControllerApp"
-        return Builder.load_file("./bin/gui/gui.kv")
-
-
-logger.info("Init finished, starting UI")
-
-try:
-    if __name__ == "__main__":
-        bga = BiogasControllerApp()
-        bga.run()
-
-except Exception as e:
-    logger.critical(e, exc_info=True)

BiogasControllerApp-V2.3/config/config.csv

@@ -1 +0,0 @@
-2

BiogasControllerApp-V2.3/config/settings.ini

@@ -1,19 +0,0 @@
-[Port Settings]
-specificport = None
-
-[UI Config]
-sizeh = 600
-sizew = 800
-
-[Dev Settings]
-verbose = False
-log_level = DEBUG
-disableconnectioncheck = False
-
-[License]
-show = 1
-
-[Info]
-version = V2.3.0
-subversion =
-

BiogasControllerApp-V2.3/log/logging.md

@@ -1,5 +0,0 @@
-What is getting logged? 
-Generally this app logs how and when you interact with the app and sometimes, which values you enter. 
-No logs are being sent to anybody automatically, you can choose to attach the log file to the bug report.
-This helps the devs a lot, as they can better understand the state of the app as it crashed. The logs are 
-all found in this folder here. 

BiogasControllerApp.spec

@@ -19,6 +19,7 @@ a = Analysis(
     cipher=block_cipher,
     noarchive=False,
 )
+
 pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)
 
 exe = EXE(
@@ -28,7 +29,7 @@ exe = EXE(
     a.zipfiles,
     a.datas,
     [],
-    name='BiogasControllerApp-V2.3-stable',
+    name='BiogasControllerApp',
     debug=False,
     bootloader_ignore_signals=False,
     strip=False,
@@ -41,14 +42,17 @@ exe = EXE(
     target_arch=None,
     codesign_identity=None,
     entitlements_file=None,
-    icon='BiogasControllerAppLogo-V2.3.ico',
+    icon='BiogasControllerAppLogo.ico',
 )
 
-coll = COLLECT(exe, Tree('C:\\BiogasControllerApp-V2.3\\'),
+coll = COLLECT(
-               a.binaries,
+    exe, 
-               a.zipfiles,
+    Tree('.'),
-               a.datas,
+    a.binaries,
-               *[Tree(p) for p in (sdl2.dep_bins + glew.dep_bins)],
+    a.zipfiles,
-               strip=False,
+    a.datas,
-               upx=True,
+    *[Tree(p) for p in (sdl2.dep_bins + glew.dep_bins)],
-               name='touchtracer')
+    strip=False,
+    upx=True,
+    name='biogascontrollerapp'
+)

README.md

@@ -1,55 +1,76 @@
-		
+<div id="title" align="center">
-				
+    <img src="./BiogasControllerAppLogo.png" width="300">
-# **BiogasControllerApp V2.3.0**
+    <h1>BiogasControllerApp</h1>
-				
+</div>
-		THIS SOFWARE FALLS UNDER THE GPL V3 LICENSE AND AS SUCH COMES WITH
-		ABSOLUTELY NO WARRANTY!
-		
-***LOOKING FOR A MacOS BUILD MAINTAINER! You may follow the official build instructions on the kivy.org website. All other materials should already be included in this repository***
 
-Thank you for downloading the new Version of the BiogasControllerApp! You are greeted with 
+<div id="badges" align="center">
-lots of new features, including a new and redesigned Graphical User Interface (later "GUI")
+    <img src="https://img.shields.io/github/license/janishutz/BiogasControllerApp.svg">
-and an automatic assignment of the comport on all supported Operating systems (see supported OS section). 
+    <img src="https://img.shields.io/github/repo-size/janishutz/BiogasControllerApp.svg">
-	
+    <img src="https://img.shields.io/github/languages/top/janishutz/BiogasControllerApp">
-	
+    <img src="https://img.shields.io/github/directory-file-count/janishutz/BiogasControllerApp.svg">
-	
+    <br>
-## *FEATURE LIST*
+    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/janishutz/BiogasControllerApp">
-- Easily read out the data the Microcontroller used in ENATECH sends
+    <img alt="GitHub watchers" src="https://img.shields.io/github/watchers/janishutz/BiogasControllerApp">
-- Easily change the coefficients for the temperature sonds
+    <img src="https://img.shields.io/github/issues-pr-raw/janishutz/BiogasControllerApp">
-- Easily change the temperature that is set for the controller to heat to
+    <img alt="GitHub forks" src="https://img.shields.io/github/forks/janishutz/BiogasControllerApp">
-- Easy to navigate menus and submenus for better organisation
+    <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/janishutz/BiogasControllerApp">
-- (Almost) Bugfree
+    <br>
-- Detailed and still private logging (not sending any information to anybody except you do)
+    <img alt="GitHub downloads all releases" src="https://img.shields.io/github/downloads/janishutz/BiogasControllerApp/total?label=Downloads (total)">
+    <img alt="GitHub downloads release (latest release)" src="https://img.shields.io/github/downloads/janishutz/BiogasControllerApp/latest/total?label=Downloads (latest)">
+    <img src="https://img.shields.io/github/release/janishutz/BiogasControllerApp.svg">
+</div>
+
+<div id="donate" align="center">
+    <a href="https://store.janishutz.com/donate" target="_blank"><img src="https://store-cdn.janishutz.com/static/support-me.jpg" width="150px"></a>
+</div>
+
+BiogasControllerApp has just received a major rewrite, where I focused on code-readability, documentation and stability. The documentation in the code is aimed at beginners and does contain some unnecessary extra comments
+
+If you are here to read the code, the files you are most likely looking for can be found in the `lib` folder. If you want to understand and have a look at all of the application, start with the `biogascontrollerapp.py` file
+
+# Installation
+To install it, navigate to the releases tab on the right hand side. Click the current release, scroll down to assets and select the version appropriate for your operating system.
+
+That means:
+- on Windows, select BiogasControllerApp-Windows.zip
+- on Linux, you may download the tarball or you may also download the `install-linux.sh` script to automatically install it for you. Just note: You need to enable execute permissions for the file!
+
+Compared to older versions, the new BiogasControllerApp doesn't install itself as an app and only resides in a folder where you can launch it using the executable or the `launch.sh` script.
+
+# Features
+- Read data the microcontroller in ENATECH sends
+- Configure the microcontroller (Coefficients & Temperature). Old settings will be pre-loaded
+- Focus on code quality and readability as well as stability
+- Tips to resolve errors directly in the app
 - The app is still maintained and as such known issues will be resolved
-- Highly detailed error resolving instructions directly inside the app 
+- Clean UI focusing on ease of use
-- Easy to run: No extra Software required (e.g. Python or similar) (currently Windows only)
+- Documented code so you can more easily understand what is happening
-- Easy to install and uninstall as it has an installer and uninstaller
-- Some settings are available through the /config/settings.ini file
-	
-	
 
-*Officially Supported OS*
+# Issues
-- Microsoft Windows 10, 11 (through my installer, may though support older Versions but this is not verified. Open an issue if you have managed to run it on an older version of Windows)
+If you encounter any bugs or other weird behaviour, please open an issue on this GitHub repository. 
+
+# Documentation
+You may find documentation for this project in its wiki here on GitHub. The code is also documented with explanations what it does
+
+# Officially Supported OS
+- Microsoft Windows 10, 11 (through the provided compiled package, might work on older versions as well)
 - Microsoft Windows XP, Vista, 7, 8, 10, 11 (through running the package with Python yourself)
 - MacOS 10.9 (Mavericks) or later (required by Python)
-- GNU/Linux: All distros that support Python 3.8 or later
+- GNU/Linux: All distros that support Python 3.8 or later (use `install-linux.sh` to install and `launch.sh` to launch for convenience)
-- FreeBSD: Works with slight modification of the source code 
+- FreeBSD: If you have Pyhton 3.8 or later installed 
 
-
+## Dependencies
-*Required packages/programs to install the app yourself*
+Only needed if you run with python directly
-- Python 3.8 - 3.10 (only tested on these versions)
+- Python 3.10 - latest (only tested on this version, but should work down to at least 3.8)
-- kivy
+- kivy[base]
 - pyserial
 
+To install them, run `pip install -r requirements.txt`
 
-DEVELOPMENT:
+# Contributing
-	- BiogasControllerApp V2.x: simplePCBuilding
+If you wish to contribute to this project, please fork this repository, create a new branch in your fork, make your changes and open a pull request in this repo. 
-	
-
-	
- COPYRIGHT 2022 simplePCBuilding
 
 
-	
+<div id="donate" align="center">
-		
+    <a href="https://store.janishutz.com/donate" target="_blank"><img src="https://store-cdn.janishutz.com/static/support-me.jpg" width="150px"></a>
-
+</div>

SECURITY.md

@@ -4,13 +4,14 @@
 
 Currently only the newest versions get security updates as security updates are also part of a release.
 
-The support for Version 2.2.0 and below will end with the next Version (2.4.0)!
+Only Version 3 is supported due to the poor code quality of V2.3.0 and below.
 
 | Version | Supported          |
 | ------- | ------------------ |
-|2.3.0    | ✅                 |
+| 3.0.0   | ✅                 |
-| 2.2.0   | ✅                 |
+| 2.3.0   | ❎                 |
-| 2.1.0   | ✅                 |
+| 2.2.0   | ❎                 |
+| 2.1.0   | ❎                 |
 | 1.0.0   | ❎                 |
 
 ## Reporting a Vulnerability

biogascontrollerapp.py

@@ -0,0 +1,118 @@
+# ────────────────────────────────────────────────────────────────────
+#          ╭────────────────────────────────────────────────╮
+#          │              BiogasControllerApp               │
+#          ╰────────────────────────────────────────────────╯
+#
+# So you would like to read the source code? Nice!
+# Just be warned, this application uses Thread and a UI Toolkit called 
+# Kivy to run. If you are unsure of what functions do, consider 
+# checking out the kivy docs at https://kivy.org/doc. 
+# It also uses the pyserial library for communication with the micro-
+# controller with RS232
+#
+# ────────────────────────────────────────────────────────────────────
+
+# Load the config file
+import configparser
+import time
+config = configparser.ConfigParser()
+config.read("./config.ini")
+
+
+# Introducing tariffs to Python imports.
+# It was too funny of an idea to miss out on
+# You can enable or disable this in the config. 
+# It is disabled by default
+if config["Tariffs"]["impose_tariffs"] == "True":
+    try:
+        import tariff
+
+        tariff.set({
+            "kivy": int(config["Tariffs"]["kivy_rate"]),
+            "serial": int(config["Tariffs"]["pyserial_rate"]),
+            })
+    except Exception as e:
+        print(e)
+        print("You cannot evade the tariffs. I will impose impose a tariff of 1000000% on the launch of this app!")
+        time.sleep(2000000)
+
+import os
+from typing import override
+
+from lib.com import Com, ComSuperClass
+import lib.test.com
+
+
+
+# Load config and disable kivy log if necessary
+if config["Dev"]["verbose"] == "True":
+    pass
+else:
+    os.environ["KIVY_NO_CONSOLELOG"] = "1"
+
+
+# Load kivy modules. Kivy is the UI framework used. See https://kivy.org
+# from kivy.core.window import Window, Config
+from kivy.uix.screenmanager import ScreenManager
+from kivy.app import App
+
+
+# Store the current app version
+app_version = f"{config['Info']['version']}{config['Info']['subVersion']}"
+
+
+#          ╭────────────────────────────────────────────────╮
+#          │                    Screens                     │
+#          ╰────────────────────────────────────────────────╯
+# Import all the screens (= pages) used in the app 
+from gui.home.home import HomeScreen
+from gui.credits.credits import CreditsScreen
+from gui.program.program import ProgramScreen
+from gui.about.about import AboutScreen
+from gui.main.main import MainScreen
+
+
+
+#          ╭────────────────────────────────────────────────╮
+#          │                 Screen Manager                 │
+#          ╰────────────────────────────────────────────────╯
+# Kivy uses a screen manager to manage pages in the application
+class BiogasControllerApp(App):
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.screen_manager = ScreenManager()
+
+    @override
+    def build(self):
+        com: ComSuperClass = Com()
+        if config["Dev"]["use_test_library"] == "True":
+            com = lib.test.com.Com()
+
+        self.icon = "./BiogasControllerAppLogo.png"
+        self.title = "BiogasControllerApp-" + app_version
+        self.screen_manager.add_widget(HomeScreen(com, name="home"))
+        self.screen_manager.add_widget(MainScreen(com, name="main"))
+        self.screen_manager.add_widget(ProgramScreen(com, name="program"))
+        self.screen_manager.add_widget(CreditsScreen(name="credits"))
+        self.screen_manager.add_widget(AboutScreen(name="about"))
+        return self.screen_manager
+
+
+# Disallow this file to be imported
+if __name__ == "__main__":
+    print("""
+┏━━┓━━━━━━━━━━━━━━━━━━━━┏━━━┓━━━━━━━━━┏┓━━━━━━━━┏┓━┏┓━━━━━━━━┏━━━┓━━━━━━━━
+┃┏┓┃━━━━━━━━━━━━━━━━━━━━┃┏━┓┃━━━━━━━━┏┛┗┓━━━━━━━┃┃━┃┃━━━━━━━━┃┏━┓┃━━━━━━━━
+┃┗┛┗┓┏┓┏━━┓┏━━┓┏━━┓━┏━━┓┃┃━┗┛┏━━┓┏━┓━┗┓┏┛┏━┓┏━━┓┃┃━┃┃━┏━━┓┏━┓┃┃━┃┃┏━━┓┏━━┓
+┃┏━┓┃┣┫┃┏┓┃┃┏┓┃┗━┓┃━┃━━┫┃┃━┏┓┃┏┓┃┃┏┓┓━┃┃━┃┏┛┃┏┓┃┃┃━┃┃━┃┏┓┃┃┏┛┃┗━┛┃┃┏┓┃┃┏┓┃
+┃┗━┛┃┃┃┃┗┛┃┃┗┛┃┃┗┛┗┓┣━━┃┃┗━┛┃┃┗┛┃┃┃┃┃━┃┗┓┃┃━┃┗┛┃┃┗┓┃┗┓┃┃━┫┃┃━┃┏━┓┃┃┗┛┃┃┗┛┃
+┗━━━┛┗┛┗━━┛┗━┓┃┗━━━┛┗━━┛┗━━━┛┗━━┛┗┛┗┛━┗━┛┗┛━┗━━┛┗━┛┗━┛┗━━┛┗┛━┗┛━┗┛┃┏━┛┃┏━┛
+━━━━━━━━━━━┏━┛┃━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┃┃━━┃┃━━
+━━━━━━━━━━━┗━━┛━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┗┛━━┗┛━━
+
+                            Version 3.0.0
+
+ => Initializing....
+          """)
+    BiogasControllerApp().run()
+    print("\n => Exiting!")

changelog

@@ -1,5 +1,15 @@
 ***CHANGELOG***
 
+V3.0-beta
+- Redesigned GUI
+- Consolidated multiple previously separate screens
+- Completely rewritten backend
+- Improved stability
+- Cleaned, documented code
+
+OLD VERSIONS
+------------
+
 DEVELOPMENT VERSIONS
 	
 dev-V2rev1:
@@ -103,4 +113,5 @@ V2.3
 - ADDS logging (you can include the logs in a bugreport so the devs can pin-point the exact cause and replicate the error)
 - ADDS some settings through a config file
 - CHANGED License from NONE to GPL V3
-- BUGFIXES
+- BUGFIXES
+

config.ini

@@ -0,0 +1,21 @@
+[Ports]
+specificport = None
+
+[UI]
+sizeh = 600
+sizew = 800
+
+[Dev]
+verbose = True
+log_level = DEBUG
+use_test_library = False
+
+[Tariffs]
+impose_tariffs = False
+kivy_rate = 50
+pyserial_rate = 500
+
+[Info]
+version = V2.3.0
+subversion =
+

gui/PopupManager.py

@@ -0,0 +1,3 @@
+from gui.popups.popups import *
+
+

gui/about/about.kv

@@ -0,0 +1,37 @@
+<AboutScreen>:
+    name: "about"
+    canvas.before:
+        Color:
+            rgba: (10,10,10,0.1)
+        Rectangle:
+            size: self.size
+            pos: self.pos
+    GridLayout:
+        cols: 1
+        Label:
+            text: "About"
+            font_size: 40
+            color: (0, 113, 0, 1)
+            bold: True
+        FloatLayout:
+            GridLayout:
+                pos_hint: {"x":0.05, "y":0.05}
+                size_hint: 0.9, 0.9
+                cols: 3
+                Button:
+                    text: "Back"
+                    background_color: (255,0,0,0.6)
+                    on_release:
+                        app.root.current = "home"
+                        root.manager.transition.direction = "up"
+                Button:
+                    text: "Report a\nBug"
+                    background_color: (255,0,0,0.6)
+                    on_release:
+                        root.report_issue()
+                Button:
+                    text: "Credits"
+                    background_color: (255,0,0,0.6)
+                    on_release:
+                        app.root.current = "credits"
+                        root.manager.transition.direction = "left"

gui/about/about.py

@@ -0,0 +1,13 @@
+from kivy.uix.screenmanager import Screen
+from kivy.lang import Builder
+import webbrowser
+
+from gui.popups.popups import SingleRowPopup
+
+
+class AboutScreen(Screen):
+    def report_issue(self):
+        SingleRowPopup().open("Opened your web-browser")
+        webbrowser.open('https://github.com/janishutz/BiogasControllerApp/issues', new=2)
+
+Builder.load_file('./gui/about/about.kv')

gui/credits/credits.kv

@@ -0,0 +1,27 @@
+<CreditsScreen>:
+    name: "credits"
+    canvas.before:
+        Color:
+            rgba: (10,10,10,0.1)
+        Rectangle:
+            size: self.size
+            pos: self.pos
+    FloatLayout:
+        Button:
+            text: "back"
+            size_hint: 0.4, 0.2
+            pos_hint: {"x":0.3, "y":0.1}
+            on_release:
+                app.root.current = "about"
+                root.manager.transition.direction = "right"
+        GridLayout:
+            cols:1
+            pos_hint:{"x":0.05, "y":0.35}
+            size_hint: 0.9, 0.5
+            Label:
+                text: "This is a controller sofware that helps you reprogram and monitor the micro-controller used in ENATECH at KSWO"
+            Label:
+                text: "Written by:                   Janis Hutz\nDesigned by:                Janis Hutz\nDesign language:         Kivy"
+            Label:
+                text: "This software is free Software licensed under the GPL V3 (GNU General Public License) and as such comes with absolutely no warranty. In return, you can use, modify, distribute or use any of the code of this software in your own project, if you reuse the same license. For more infos, you can find a copy of this license in the project folder."
+                text_size: self.width, None

gui/credits/credits.py

@@ -0,0 +1,8 @@
+from kivy.uix.screenmanager import Screen
+from kivy.lang import Builder
+
+
+class CreditsScreen(Screen):
+    pass
+
+Builder.load_file('./gui/credits/credits.kv')

gui/home/home.kv

@@ -0,0 +1,45 @@
+<HomeScreen>:
+    name: "home"
+    canvas.before:
+        Color:
+            rgba: (10,10,10,0.1)
+        Rectangle:
+            size: self.size
+            pos: self.pos
+    GridLayout:
+        cols:1
+        Label:
+            text: "BiogasanlageControllerApp"
+            font_size: 50
+            color: (0, 113, 0, 1)
+            bold:True
+            italic:True
+        FloatLayout:
+            GridLayout:
+                cols: 2
+                size_hint: 0.8, 0.8
+                pos_hint: {"x": 0.1, "y": 0.1}
+                Button:
+                    text: "Start"
+                    background_color: (255, 0, 0, 0.6)
+                    font_size: 30
+                    on_release:
+                        root.start()
+                Button:
+                    text: "Quit"
+                    background_color: (255, 0, 0, 0.6)
+                    font_size: 30
+                    on_release:
+                        root.quit()
+            Label:
+                text: "You are running version V3.0.1"
+                font_size: 13
+                pos_hint: {"y": -0.45, "x":0.05}
+            Button:
+                text: "About"
+                font_size: 13
+                size_hint: 0.07, 0.06
+                pos_hint: {"x":0.01, "y":0.01}
+                background_color: (50, 0, 0, 0.2)
+                on_release:
+                    root.to_about()

gui/home/home.py

@@ -0,0 +1,71 @@
+from kivy.uix.screenmanager import Screen
+from kivy.lang import Builder
+from gui.popups.popups import DualRowPopup, QuitPopup, TwoActionPopup
+from lib.com import ComSuperClass
+import platform
+
+
+# Information for errors encountered when using pyserial
+information = {
+    "Windows": {
+        "2": "Un- and replug the cable and ensure you have the required driver(s) installed",
+        "13": "You are probably missing a required driver or your cable doesn't work. Consult the wiki for more information",
+        "NO_COM": "Could not find a microcontroller. Please ensure you have one connected and the required driver(s) installed"
+    },
+    "Linux": {
+        "2": "Un- and replug the cable, or if you haven't plugged a controller in yet, do that",
+        "13": "Incorrect permissions at /dev/ttyUSB0. Open a terminal and type: sudo chmod 777 /dev/ttyUSB0",
+        "NO_COM": "Could not find a microcontroller. Please ensure you have one connected"
+    }
+}
+
+
+# This is the launch screen, i.e. what you see when you start up the app
+class HomeScreen(Screen):
+    def __init__(self, com: ComSuperClass, **kw):
+        self._com = com;
+        super().__init__(**kw)
+
+    # Go to the main screen if we can establish connection or the check was disabled 
+    # in the configs
+    def start(self):
+        if self._com.connect():
+            self.manager.current = 'main'
+            self.manager.transition.direction = 'right'
+        else:
+            TwoActionPopup().open('Failed to connect', 'Details', self.open_details_popup)
+            print('ERROR connecting')
+
+    # Open popup for details as to why the connection failed
+    def open_details_popup(self):
+        DualRowPopup().open("Troubleshooting tips", self._generate_help())
+
+    def _generate_help(self) -> str:
+        operating_system = platform.system()
+        if operating_system == "Windows" or operating_system == "Linux":
+            port = self._com.get_comport();
+            information["Linux"]["13"] = f"Incorrect permissions at {port}. Resolve by running 'sudo chmod 777 {port}'"
+            if port == "":
+                return information[operating_system]["NO_COM"]
+            err = self._com.get_error()
+            if err != None:
+                return information[operating_system][str(err.errno)]
+            else:
+                return "No error message available"
+        else:
+            return "You are running on an unsupported Operating System. No help available"
+
+    # Helper to open a Popup to ask user whether to quit or not
+    def quit(self):
+        QuitPopup(self._com).open()
+
+    # Switch to about screen
+    def to_about(self):
+        self.manager.current = 'about'
+        self.manager.transition.direction = 'down'
+
+
+# Load the design file for this screen (.kv files)
+# The path has to be relative to root of the app, i.e. where the biogascontrollerapp.py 
+# file is located
+Builder.load_file('./gui/home/home.kv')

gui/main/main.kv

@@ -0,0 +1,89 @@
+<MainScreen>:
+    on_pre_enter: root.reset()
+    name: "main"
+    canvas.before:
+        Color:
+            rgba: (10,10,10,0.1)
+        Rectangle:
+            size: self.size
+            pos: self.pos
+    GridLayout:
+    FloatLayout:
+        Label:
+            pos_hint: {"y":0.4}
+            text: "READOUT"
+            font_size: 40
+            color: (0, 113, 0, 1)
+            bold: True
+        GridLayout:
+            cols:4
+            size_hint: 0.8, 0.3
+            pos_hint: {"x":0.1, "y":0.4}
+            Label:
+                text: "Sensor 1: "
+                font_size: 20
+            Label:
+                id: sensor1
+                text: ""
+            Label:
+                text: "Sensor 2: "
+                font_size: 20
+            Label:
+                id: sensor2
+                text: ""
+            Label:
+                text: "Sensor 3: "
+                font_size: 20
+            Label:
+                id: sensor3
+                text: ""
+            Label:
+                text: "Sensor 4: "
+                font_size: 20
+            Label:
+                id: sensor4
+                text: ""
+        Button:
+            text: "Connect"
+            size_hint: 0.2, 0.1
+            pos_hint: {"x": 0.5, "y": 0.05}
+            background_color: (255, 0, 0, 0.6)
+            on_release:
+                root.start()
+        Button:
+            text: "Disconnect"
+            size_hint: 0.2, 0.1
+            pos_hint: {"x": 0.7, "y": 0.05}
+            background_color: (255, 0, 0, 0.6)
+            on_release:
+                root.end()
+        Button:
+            text: "Back"
+            size_hint: 0.3, 0.1
+            pos_hint: {"x":0.05, "y":0.05}
+            background_color: (255, 0, 0, 0.6)
+            on_release:
+                root.end()
+                app.root.current = "home"
+                root.manager.transition.direction = "left"
+        ToggleButton:
+            id: mode_selector
+            size_hint: 0.15, 0.1
+            pos_hint: {"x":0.1, "y":0.2}
+            text: "Normal Mode" if self.state == "normal" else "Fast Mode"
+            on_text: root.switch_mode(mode_selector.text)
+            background_color: (255,0,0,0.6) if self.state == "normal" else (0,0,255,0.6)
+        Button:
+            text: "Configuration"
+            size_hint: 0.15, 0.1
+            pos_hint: {"x":0.7, "y":0.2}
+            background_color: (255, 0, 0, 0.6)
+            on_release:
+                root.end()
+                app.root.current = "program"
+                root.manager.transition.direction = "down"
+        Label:
+            id: status
+            text: "Status will appear here"
+            font_size: 10
+            pos_hint: {"x":0.4, "y": 0.3}

gui/main/main.py

@@ -0,0 +1,212 @@
+from ctypes import ArgumentError
+from time import time
+from typing import List, override
+from kivy.uix.screenmanager import Screen
+from kivy.lang import Builder
+from gui.popups.popups import SingleRowPopup, TwoActionPopup, empty_func
+from kivy.clock import Clock, ClockEvent
+import queue
+import threading
+
+# Load utilities
+from lib.instructions import Instructions
+from lib.com import ComSuperClass
+from lib.decoder import Decoder
+
+
+# TODO: Consider consolidating start and stop button
+
+
+# Queue with data that is used to synchronize
+synced_queue: queue.Queue[List[str]] = queue.Queue()
+
+
+#          ╭────────────────────────────────────────────────╮
+#          │           Data Reading Thread Helper           │
+#          ╰────────────────────────────────────────────────╯
+# Using a Thread to run this in parallel to the UI to improve responsiveness
+class ReaderThread(threading.Thread):
+    _com: ComSuperClass
+    _decoder: Decoder
+    _instructions: Instructions
+
+    # This method allows the user to set Com object to be used.
+    # The point of this is to allow for the use of a single Com object to not waste resources
+    def set_com(self, com: ComSuperClass):
+        """Set the Com object to be used in this
+
+        Args:
+            com: The com object to be used
+        """
+        self._com = com
+        self._run = True
+        self._decoder = Decoder()
+        self._instructions = Instructions(com)
+
+    # This method is given by the Thread class and has to be overriden to change
+    # what is executed when the thread starts
+    @override
+    def run(self) -> None:
+        self._run = True
+        if self._com == None:
+            raise ArgumentError("Com object not passed in (do using set_com)")
+        # Hook to output stream
+        if self._instructions.hook_main():
+            # We are now hooked to the stream (i.e. data is synced)
+            synced_queue.put(["HOOK"])
+
+            # making it exit using the stop function
+            while self._run:
+                # Take note of the time before reading the data to deduce frequency of updates
+                start_time = time()
+
+                # We need to read 68 bytes of data, given by the program running on the controller
+                received = self._com.receive(68)
+
+                # Store the data in a list of strings
+                data: List[str] = []
+
+                # For all sensors connected, execute the same thing
+                for i in range(4):
+                    # The slicing that happens here uses offsets automatically calculated from the sensor id
+                    # This allows for short code
+                    data.append(
+                        f"Tadc: {
+                            self._decoder.decode_int(received[12 * i:12 * i + 4])
+                        }\nTemperature: {
+                            self._decoder.decode_float(received[12 * i + 5:12 * i + 11])
+                        }\nDuty-Cycle: {
+                            self._decoder.decode_float_long(received[48 + 5 * i: 52 + 5 * i]) / 65535.0 * 100
+                        }%"
+                    )
+                # Calculate the frequency of updates
+                data.append(str(1 / (time() - start_time)))
+        else:
+            # Send error message to the UI updater
+            synced_queue.put(["ERR_HOOK"])
+            return
+
+    def stop(self) -> None:
+        self._run = False
+
+
+#          ╭────────────────────────────────────────────────╮
+#          │                Main App Screen                 │
+#          ╰────────────────────────────────────────────────╯
+# This is the main screen, where you can read out data
+class MainScreen(Screen):
+    _event: ClockEvent
+
+    # The constructor if this class takes a Com object to share one between all screens
+    # to preserve resources and make handling better
+    def __init__(self, com: ComSuperClass, **kw):
+        # Set some variables
+        self._com = com
+        self._event = None
+
+        # Prepare the reader thread
+        self._reader = ReaderThread()
+        self._reader.setDaemon(True)
+        self._reader.set_com(com)
+        self._has_connected = False
+
+        # Call the constructor for the Screen class
+        super().__init__(**kw)
+
+    # Start the connection to the micro-controller to read data from it.
+    # This also now starts the reader thread to continuously read out data
+    def start(self):
+        self.ids.status.text = "Connecting..."
+        if self._com.connect():
+            print("Acquired connection")
+            self._has_connected = True
+            # Start communication
+            self._reader.start()
+            print("Reader has started")
+            Clock.schedule_interval(self._update_screen, 0.5)
+        else:
+            self.ids.status.text = "Connection failed"
+            TwoActionPopup().open(
+                "Failed to connect. Do you want to retry?",
+                "Cancel",
+                empty_func,
+                "Retry",
+                self.start,
+            )
+
+    # End connection to micro-controller and set it back to normal mode
+    def end(self, set_msg: bool = True):
+        # Set micro-controller back to Normal Mode when ending communication
+        # to make sure temperature control will work
+        if self._has_connected:
+            if self._event != None:
+                self._event.cancel()
+            self._reader.stop()
+            try:
+                self._com.send("NM")
+            except:
+                pass
+            self._com.close()
+            if set_msg:
+                self.ids.status.text = "Connection terminated"
+            print("Connection terminated")
+
+    # A helper function to update the screen. Is called on an interval
+    def _update_screen(self, dt):
+        update = []
+        try:
+            update = synced_queue.get_nowait()
+        except:
+            pass
+        if len(update) == 0:
+            # There are no updates to process, don't block and simply try again next time
+            return
+        if len(update) == 1:
+            if update[0] == "ERR_HOOK":
+                self.ids.status.text = "Hook failed"
+                self.end(False)
+            elif update[0] == "HOOK":
+                self.ids.status.text = "Connected to controller"
+        else:
+            self.ids.sensor1.text = update[0]
+            self.ids.sensor2.text = update[1]
+            self.ids.sensor3.text = update[2]
+            self.ids.sensor4.text = update[3]
+            self.ids.status.text = "Connected, f = " + update[4]
+
+    # Reset the screen when the screen is entered
+    def reset(self):
+        self.ids.sensor1.text = ""
+        self.ids.sensor2.text = ""
+        self.ids.sensor3.text = ""
+        self.ids.sensor4.text = ""
+        self.ids.status.text = "Status will appear here"
+
+    # Switch the mode for the micro-controller
+    def switch_mode(self, new_mode: str):
+        # Store if we have been connected to the micro-controller before mode was switched
+        was_connected = self._reader.is_alive
+
+        # Disconnect from the micro-controller
+        self.end()
+        self.ids.status.text = "Setting mode..."
+
+        # Try to set the new mode
+        try:
+            if new_mode == "Normal Mode":
+                self._com.send("NM")
+            else:
+                self._com.send("FM")
+        except:
+            SingleRowPopup().open("Failed to switch modes")
+            return
+
+        # If we have been connected, reconnect
+        if was_connected:
+            self.start()
+
+
+# Load the design file for this screen (.kv files)
+# The path has to be relative to root of the app, i.e. where the biogascontrollerapp.py
+# file is located
+Builder.load_file("./gui/main/main.kv")

gui/popups/popups.kv

@@ -0,0 +1,111 @@
+<QuitPopup>:
+    title: "BiogasControllerApp"
+    font_size: 50
+    size_hint: 0.5, 0.4
+    auto_dismiss: False
+    GridLayout:
+        cols: 1
+        Label:
+            text: "Are you sure you want to leave?"
+            font_size: 20
+        GridLayout:
+            cols:2
+            Button:
+                text: "Yes"
+                font_size: 15
+                on_release:
+                    root.quit()
+                    app.stop()
+            Button:
+                text: "No"
+                font_size: 15
+                on_press:
+                    root.dismiss()
+
+<SingleRowPopup>:
+    title: "INFORMATION"
+    size_hint: 0.7, 0.5
+    auto_dismiss: True
+    GridLayout:
+        cols: 1
+        Label:
+            id: msg
+            text: "Message"
+            text_size: self.width, None
+            halign: 'center'
+        GridLayout:
+            cols: 1
+            Button:
+                text: "Ok"
+                on_release:
+                    root.dismiss()
+
+<TwoActionPopup>:
+    title: "WARNING!"
+    font_size: 50
+    size_hint: 0.5, 0.4
+    auto_dismiss: False
+    GridLayout:
+        cols:1
+        Label:
+            id: msg
+            text: "Message"
+            font_size: 20
+            halign: 'center'
+        GridLayout:
+            cols:2
+            Button:
+                id: btn1
+                text: "Details"
+                on_release:
+                    root.action_one()
+                    root.dismiss()
+            Button:
+                id: btn2
+                text:"Ok"
+                on_release:
+                    root.action_two()
+                    root.dismiss()
+
+<DualRowPopup>:
+    title: "Details"
+    font_size: 50
+    size_hint: 0.7, 0.6
+    auto_dismiss: False
+    GridLayout:
+        cols:1
+        Label:
+            id: msg_title
+            text: "Message title"
+            font_size: 20
+        Label:
+            id: msg_body
+            text: "Message body"
+            font_size: 14
+        Button:
+            text:"Ok"
+            on_release:
+                root.dismiss()
+
+<LargeTrippleRowPopUp>:
+    title: "DETAILS"
+    font_size: 50
+    size_hint: 1, 0.7
+    auto_dismiss: False
+    GridLayout:
+        cols: 1
+        Label:
+            id: msg_title
+            text: "title"
+            font_size: 20
+        Label:
+            id: msg_body
+            text: "Message"
+            font_size: 13
+        Label:
+            text: msg_extra
+            font_size: 13
+        Button:
+            text:"Ok"
+            on_release:
+                root.dismiss()

gui/popups/popups.py

@@ -0,0 +1,63 @@
+from typing import Callable
+from kivy.uix.popup import Popup
+from kivy.lang import Builder
+
+from lib.com import ComSuperClass
+
+
+# Just an empty function
+def empty_func():
+    pass
+
+#          ╭────────────────────────────────────────────────╮
+#          │                     Popups                     │
+#          ╰────────────────────────────────────────────────╯
+# Below, you can find various popups with various designs that can be used in the app
+class QuitPopup(Popup):
+    def __init__(self, com: ComSuperClass, **kw):
+        self._com = com;
+        super().__init__(**kw)
+
+    def quit(self):
+        self._com.close()
+
+class SingleRowPopup(Popup):
+    def open(self, message, *_args, **kwargs):
+        self.ids.msg.text = message
+        return super().open(*_args, **kwargs)
+
+class DualRowPopup(Popup):
+    def open(self, title: str, message: str, *_args, **kwargs):
+        self.ids.msg_title.text = title
+        self.ids.msg_body.text = message
+        return super().open(*_args, **kwargs)
+
+class LargeTrippleRowPopup(Popup):
+    def open(self, title: str, message: str, details: str, *_args, **kwargs):
+        self.ids.msg_title.text = title
+        self.ids.msg_body.text = message
+        self.ids.msg_extra.text = details
+        return super().open(*_args, **kwargs)
+
+class TwoActionPopup(Popup):
+    def open(self, 
+             message: str,
+             button_one: str,
+             action_one: Callable[[], None],
+             button_two: str = 'Ok',
+             action_two: Callable[[], None] = empty_func,
+             *_args,
+             **kwargs
+        ):
+        self.ids.msg.text = message
+        self.ids.btn1.text = button_one
+        self.ids.btn2.text = button_two
+        self.action_one = action_one
+        self.action_two = action_two
+        return super().open(*_args, **kwargs)
+
+
+# Load the design file for this screen (.kv files)
+# The path has to be relative to root of the app, i.e. where the biogascontrollerapp.py 
+# file is located
+Builder.load_file('./gui/popups/popups.kv')

gui/program/program.kv

@@ -0,0 +1,131 @@
+<ProgramScreen>:
+    name: "program"
+    on_enter: self.config_loader = root.load_config()
+    canvas.before:
+        Color:
+            rgba: (10,10,10,0.1)
+        Rectangle:
+            size: self.size
+            pos: self.pos
+    FloatLayout:
+        Label:
+            text: "Configuration"
+            font_size: 40
+            color: (0, 113, 0, 1)
+            bold: True
+            pos_hint: {"y":0.4}
+        GridLayout:
+            size_hint: 0.8, 0.5
+            pos_hint: {"x":0.1, "y":0.2}
+            cols: 4
+            Label:
+                text: "Sensor 1, a:"
+            TextInput:
+                id: s1_a
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 1, b:"
+            TextInput:
+                id: s1_b
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 1, c:"
+            TextInput:
+                id: s1_c
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 1, Temp:"
+            TextInput:
+                id: s1_t
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 2, a:"
+            TextInput:
+                id: s2_a
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 2, b:"
+            TextInput:
+                id: s2_b
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 2, c:"
+            TextInput:
+                id: s2_c
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 2, Temp:"
+            TextInput:
+                id: s2_t
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 3, a:"
+            TextInput:
+                id: s3_a
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 3, b:"
+            TextInput:
+                id: s3_b
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 3, c:"
+            TextInput:
+                id: s3_c
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 3, Temp:"
+            TextInput:
+                id: s3_t
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 4, a:"
+            TextInput:
+                id: s4_a
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 4, b:"
+            TextInput:
+                id: s4_b
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 4, c:"
+            TextInput:
+                id: s4_c
+                multiline: False
+                input_filter: "float"
+            Label:
+                text: "Sensor 4, Temp:"
+            TextInput:
+                id: s4_t
+                multiline: False
+                input_filter: "float"
+        Button:
+            text: "Back"
+            size_hint: 0.1, 0.1
+            pos_hint: {"x":0.1, "y":0.1}
+            background_color: (255, 0, 0, 0.6)
+            on_release:
+                app.root.current = "main"
+                root.manager.transition.direction = "up"
+        Button:
+            text: "Save"
+            size_hint: 0.2, 0.1
+            pos_hint: {"x":0.6, "y":0.1}
+            background_color: (255, 0, 0, 0.6)
+            on_release:
+                root.save()

gui/program/program.py

@@ -0,0 +1,111 @@
+from typing import List
+from kivy.uix.screenmanager import Screen
+from kivy.lang import Builder
+from lib.decoder import Decoder
+from lib.instructions import Instructions
+from gui.popups.popups import SingleRowPopup, TwoActionPopup, empty_func
+from lib.com import ComSuperClass
+from kivy.clock import Clock
+
+
+# The below list maps 0, 1, 2, 3 to a, b, c and t respectively
+# This is used to set and read values of the UI
+name_map = ["a", "b", "c", "t"]
+
+
+class ProgramScreen(Screen):
+    def __init__(self, com: ComSuperClass, **kw):
+        self._com = com
+        self._instructions = Instructions(com)
+        self._decoder = Decoder()
+        super().__init__(**kw)
+
+    def load_config(self):
+        Clock.schedule_once(self._load)
+
+    # Load the current configuration from the micro-controller
+    def _load(self, dt: float):
+        # Hook to the microcontroller's data stream (i.e. sync up with it)
+        if self._instructions.hook("RD", ["\n", "R", "D", "\n"]):
+            config: List[List[str]] = []
+
+            # Load config for all four sensors
+            for _ in range(4):
+                # Receive 28 bytes of data
+                received = bytes()
+                try:
+                    received = self._com.receive(28)
+                except:
+                    # Open error popup
+                    TwoActionPopup().open(
+                        "Failed to connect to micro-controller, retry?",
+                        "Cancel",
+                        empty_func,
+                        "Retry",
+                        lambda: self._load(0),
+                    )
+                    return
+
+                # Create a list of strings to store the config for the sensor
+                # This list has the following elements: a, b, c, temperature
+                config_sensor_i: List[str] = []
+
+                # Create the list
+                for j in range(4):
+                    config_sensor_i.append(
+                        str(self._decoder.decode_float(received[7 * j : 7 * j + 6]))
+                    )
+
+                # Add it to the config
+                config.append(config_sensor_i)
+        else:
+            TwoActionPopup().open(
+                "Failed to connect to micro-controller, retry?",
+                "Cancel",
+                empty_func,
+                "Retry",
+                lambda: self._load(0),
+            )
+
+    # Set the elements of the UI to the values of the config
+    def _set_ui(self, config: List[List[str]]):
+        for sensor_id in range(4):
+            for property in range(4):
+                self.ids[f"s{sensor_id + 1}_{name_map[property]}"].text = config[
+                    sensor_id
+                ][property]
+
+    # Read values from the UI. Returns the values as a list or None if the check was infringed
+    def _read_ui(self, enforce_none_empty: bool = True) -> List[float] | None:
+        data: List[float] = []
+
+        # Iterate over all sensor config input fields and collect the data
+        for sensor_id in range(4):
+            for property in range(4):
+                value = self.ids[f"s{sensor_id + 1}_{name_map[property]}"].text
+
+                # If requested (by setting enforce_none_empty to True, which is the default)
+                # test if the cells are not empty and if we find an empty cell return None
+                if enforce_none_empty and value == "":
+                    return
+                data.append(float(value))
+
+        return data
+
+    # Transmit the changed data to the micro-controller to reconfigure it
+    def save(self):
+        data = self._read_ui()
+        if data == None:
+            SingleRowPopup().open("Some fields are missing values!")
+        else:
+            try:
+                self._instructions.change_config(data)
+            except:
+                SingleRowPopup().open("Could not save data!")
+            SingleRowPopup().open("Data saved successfully")
+
+
+# Load the design file for this screen (.kv files)
+# The path has to be relative to root of the app, i.e. where the biogascontrollerapp.py
+# file is located
+Builder.load_file("./gui/program/program.kv")

install-linux.sh

@@ -0,0 +1,93 @@
+#!/bin/sh
+
+# Create virtual environment to not clutter up local python install
+echo "
+
+ ___                            ___               _              _   _              _____             
+(  _ \ _                       (  _ \            ( )_           (_ )(_ )           (  _  )            
+| (_) )_)  _     __    _ _  ___| ( (_)  _    ___ |  _)_ __   _   | | | |   __  _ __| (_) |_ _   _ _   
+|  _ (| |/ _ \ / _  \/ _  )  __) |  _ / _ \/  _  \ | (  __)/ _ \ | | | | / __ \  __)  _  )  _ \(  _ \ 
+| (_) ) | (_) ) (_) | (_| |__  \ (_( ) (_) ) ( ) | |_| |  ( (_) )| | | |(  ___/ |  | | | | (_) ) (_) )
+(____/(_)\___/ \__  |\__ _)____/____/ \___/(_) (_)\__)_)   \___/(___)___)\____)_)  (_) (_)  __/|  __/ 
+              ( )_) |                                                                    | |   | |    
+               \___/                                                                     (_)   (_)    
+
+
+        WELCOME! This script will automatically install BiogasControllerApp for you!
+
+        We first have to ask a few questions. If you are unsure what they mean,
+        simply press enter to use default options, which are designed to make 
+        uninstalling much easier. The default option is highlighted using capital
+        letters.
+
+        Please ensure you have wget installed. The script will verify and tell you
+        if you do not have it installed
+
+        If this script is not inside a full copy of the BiogasControllerApp repo,
+        the repo will be automatically downloaded for you.
+"
+
+use_venv=""
+read -p "Install dependencies in a virtual environment? (Y/n) " use_venv
+use_venv=$(echo "$use_venv" | tr '[:upper:]' '[:lower:]')
+
+echo "
+  => Checking for repo...
+"
+
+if [[ -f ./biogascontrollerapp.py ]]; then
+    echo "  -> Data found, not downloading"
+else
+    do_download=""
+    read -p "  -> Data not found, okay to download? (Y/n) " do_download
+    do_download=$(echo "$do_download" | tr '[:upper:]' '[:lower:]')
+    if [[ "$do_download" == "y" || "$do_download" == "" ]]; then
+        # Check if wget is installed
+        if !command -v wget >/dev/null 2>&1; then
+            echo "wget unavailable. Please install using your distribution's package manager or manually download the repo from GitHub releases"
+            echo 1
+        fi
+
+        # Download the latest release package
+        wget https://github.com/janishutz/BiogasControllerApp/releases/latest/download/biogascontrollerapp-linux.tar.gz
+
+        # Extract the tar (as tar is basically standard on all distros)
+        tar -xf ./biogascontrollerapp-linux.tar.gz
+
+        # Remove tarball (to keep it clean)
+        rm ./biogascontrollerapp-linux.tar.gz
+        mv dist biogascontrollerapp-linux
+
+        cd biogascontrollerapp-linux/
+    else
+        echo "Please download the repo manually and execute the script inside the downloaded repo from GitHub releases"
+        exit 1
+    fi
+fi
+
+# We are now guaranteed to be in the base directory of the repo
+# Set up venv if selected
+if [[ "$use_venv" == "y" || "$use_venv" == "" ]]; then
+    python -m venv .venv
+    if [[ "$SHELL" == "fish" ]]; then
+        source ./.venv/bin/activate.fish
+    elif [[ "$SHELL" == "csh" ]]; then
+        source ./.venv/bin/activate.csh
+    else
+        source ./.venv/bin/activate
+    fi
+        
+    if !command -v deactivate >/dev/null 2>&1; then
+        echo "Virtual environment could not be activated.
+        You may install the dependencies by changing to the biogascontrollerapp directory and running
+        pip install -r requirements.txt"
+        exit 1
+    fi
+fi
+
+pip install -r requirements.txt
+
+
+echo "
+  ==> Installation complete!
+"

launch.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+use_venv="y"
+if [[ -f ./.venv/bin/activate ]]; then
+    if [[ "$SHELL" == "fish" ]]; then
+        source ./.venv/bin/activate.fish
+    elif [[ "$SHELL" == "csh" ]]; then
+        source ./.venv/bin/activate.csh
+    else
+        source ./.venv/bin/activate
+    fi
+        
+    if !command -v deactivate >/dev/null 2>&1; then
+        echo "Virtual environment could not be activated. Trying to run anyway"
+    fi
+fi
+
+python biogascontrollerapp.py

lib/com.py

@@ -0,0 +1,127 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+import serial
+import struct
+import serial.tools.list_ports
+
+
+class ComSuperClass(ABC):
+    def __init__(self, baudrate: Optional[int] = 19200, filters: Optional[list[str]] = None) -> None:
+        self._serial: Optional[serial.Serial] = None
+        self._filters = filters if filters != None else [ 'USB-Serial Controller', 'Prolific USB-Serial Controller' ]
+        self._port_override = ''
+        self._baudrate = baudrate if baudrate != None else 19200
+        self._err = None
+
+    def set_port_override(self, override: str) -> None:
+        """Set the port override, to disable port search"""
+        self._port_override = override
+
+    def get_error(self) -> serial.SerialException | None:
+        return self._err
+
+    @abstractmethod
+    def get_comport(self) -> str:
+        pass
+
+    @abstractmethod
+    def connect(self) -> bool:
+        pass
+
+    @abstractmethod
+    def close(self) -> None:
+        pass
+
+    @abstractmethod
+    def receive(self, byte_count: int) -> bytes:
+        pass
+
+    @abstractmethod
+    def send(self, msg: str) -> None:
+        pass
+
+    @abstractmethod
+    def send_float(self, msg: float) -> None:
+        pass
+
+
+class Com(ComSuperClass):
+    def _connection_check(self) -> bool:
+        if self._serial == None:
+            return self._open()
+        if self._serial != None:
+            if not self._serial.is_open:
+                self._serial.open()
+            return True
+        else:
+            return False
+
+    def get_comport(self) -> str:
+        """Find the comport the microcontroller has attached to"""
+        if self._port_override != '':
+            return self._port_override
+
+        # Catch all errors and simply return an empty string if search unsuccessful
+        try:
+            # Get an array of all used comports
+            ports = [comport.device for comport in serial.tools.list_ports.comports()]
+
+            # Filter for specific controller
+            for comport in ports:
+                for filter in self._filters:
+                    if filter in comport:
+                        return comport
+        except Exception as e:
+            self._err = e
+
+        return ""
+
+    def _open(self) -> bool:
+        comport = self.get_comport()
+
+        # Comport search returns empty string if search unsuccessful
+        if comport == '':
+            try:
+                self._serial = serial.Serial(comport, self._baudrate, timeout=5)
+            except serial.SerialException as e:
+                self._err = e
+                return False
+            return True
+        else:
+            return False
+
+    def connect(self) -> bool:
+        """Try to find a comport and connect to the microcontroller. Returns the success as a boolean"""
+        return self._connection_check()
+
+    def close(self) -> None:
+        """Close the serial connection, if possible"""
+        if self._serial != None:
+            try:
+                self._serial.close()
+            except:
+                pass
+
+    def receive(self, byte_count: int) -> bytes:
+        """Recieve bytes from microcontroller over serial. Returns bytes. Might want to decode using functions from lib.tools"""
+        self._connection_check()
+        if self._serial != None:
+            return self._serial.read(byte_count)
+        else:
+            raise Exception('ERR_CONNECTING')
+
+    def send(self, msg: str) -> None:
+        """Send a string over serial connection. Will open a connection if none is available"""
+        self._connection_check()
+        if self._serial != None:
+            self._serial.write(msg.encode())
+        else:
+            raise Exception('ERR_CONNECTING')
+
+    def send_float(self, msg: float) -> None:
+        """Send a float number over serial connection"""
+        self._connection_check()
+        if self._serial != None:
+            self._serial.write(bytearray(struct.pack('>f', msg))[0:3])
+        else:
+            raise Exception('ERR_CONNECTING')

lib/decoder.py

@@ -0,0 +1,18 @@
+import struct
+
+class Decoder:
+    def decode_ascii(self, value: bytes) -> str:
+        try:
+            return value.decode()
+        except:
+            return 'Error'
+
+    def decode_float(self, value: bytes) -> float:
+        return struct.unpack('>f', bytes.fromhex(str(value, 'ascii') + '00'))[0]
+
+    def decode_float_long(self, value: bytes) -> float:
+        return struct.unpack('>f', bytes.fromhex(str(value, 'ascii') + '0000'))[0]
+
+    def decode_int(self, value: bytes) -> int:
+        # return int.from_bytes(value, 'big')
+        return int(value, base=16)

lib/instructions.py

@@ -0,0 +1,130 @@
+from lib.com import ComSuperClass
+import lib.decoder
+import time
+
+# TODO: Load filters (for comport search)
+decoder = lib.decoder.Decoder()
+
+
+# Class that supports sending instructions to the microcontroller,
+# as well as hooking to data stream according to protocol
+class Instructions:
+    def __init__(self, com: ComSuperClass) -> None:
+        self._com = com
+
+    # Set a port override (to use a specific COM port)
+    def set_port_override(self, override: str) -> None:
+        self._com.set_port_override(override)
+
+    # Helper method to hook to the data stream according to protocol.
+    # You can specify the sequence that the program listens to to sync up,
+    # as an array of strings, that should each be of length one and only contain
+    # ascii characters
+    def hook(self, instruction: str, sequence: list[str]) -> bool:
+        # Add protection: If we cannot establish connection, refuse to run
+        if not self._com.connect():
+            return False
+
+        # Send instruction to microcontroller to start hooking process
+        self._com.send(instruction)
+
+        # Record start time to respond to timeout
+        start = time.time()
+
+        # The pointer below points to the element in the array which is the next expected character to be received
+        pointer = 0
+
+        # Simply the length of the sequence, since it is both cheaper and cleaner to calculate it once
+        sequence_max = len(sequence)
+
+        # Only run for a limited amount of time
+        while time.time() - start < 5:
+            # If the decoded ascii character is equal to the next expected character, move pointer right by one
+            # If not, jump back to start
+            if decoder.decode_ascii(self._com.receive(1)) == sequence[pointer]:
+                pointer += 1
+            else:
+                pointer = 0
+
+            # If the pointer has reached the end of the sequence, return True, as now the hook was successful
+            if pointer == sequence_max:
+                return True
+
+        # If we time out, which is the only way in which this code can be reached, return False
+        return False
+
+    # Used to hook to the main data stream, as that hooking mechanism is differen
+    def hook_main(self) -> bool:
+        # Record start time to respond to timeout
+        start = time.time()
+
+        # Wait to find a CR character (enter)
+        char = decoder.decode_ascii(self._com.receive(1))
+        while char != "\n":
+            if time.time() - start > 3:
+                return False
+            char = decoder.decode_ascii(self._com.receive(1))
+
+        # Store the position in the hooking process
+        state = 0
+        distance = 0
+
+        while time.time() - start < 5 and state < 3:
+            char = decoder.decode_ascii(self._com.receive(1))
+            if char == " ":
+                if distance == 4:
+                    state += 1
+                distance = 0
+            else:
+                if distance > 4:
+                    state = 0
+                    distance = 0
+                else:
+                    distance += 1
+
+        self._com.receive(5)
+
+        return state == 3
+
+    # Private helper method to transmit data using the necessary protocols
+    def _change_data(
+        self,
+        instruction: str,
+        readback: list[str],
+        data: list[float],
+        readback_length: int,
+    ) -> None:
+        # Hook to stream
+        if self.hook(instruction, readback):
+            # Transmit data
+            while len(data) > 0:
+                # If we received data back, we can send more data, i.e. from this we know
+                # the controller has received the data
+                # If not, we close the connection and create an exception
+                if self._com.receive(readback_length) != "":
+                    self._com.send_float(data.pop(0))
+                else:
+                    self._com.close()
+                    raise Exception(
+                        "Failed to transmit data. No response from controller"
+                    )
+            self._com.close()
+        else:
+            self._com.close()
+            raise ConnectionError(
+                "Failed to hook to controller data stream. No fitting response received"
+            )
+
+    # Abstraction of the _change_data method specifically designed to change the entire config
+    def change_config(self, new_config: list[float]) -> None:
+        try:
+            self._change_data("PR", ["\n", "P", "R", "\n"], new_config, 3)
+        except Exception as e:
+            raise e
+
+    # Abstraction of the _change_data method specifically designed to change only the configured temperature
+    def change_temperature(self, temperatures: list[float]) -> None:
+        try:
+            self._change_data("PT", ["\n", "P", "T", "\n"], temperatures, 3)
+        except Exception as e:
+            raise e

lib/test/com.py

@@ -0,0 +1,148 @@
+"""
+Library to be used in standalone mode (without microcontroller, for testing functionality)
+It simulates the behviour of an actual microcontroller being connected
+"""
+
+from typing import Optional
+import queue
+import random
+import time
+import struct
+
+from lib.com import ComSuperClass
+
+# This file contains a Com class that can be used to test the functionality
+# even without a microcontroller. It is not documented in a particularly
+# beginner-friendly way, nor is the code written with beginner-friendliness
+# in mind. It is the most complicated piece of code of the entire application
+
+# All double __ prefixed properties and methods are not available in the actual one
+
+instruction_lut: dict[str, list[str]] = {
+    "PR": ["\n", "P", "R", "\n"],
+    "PT": ["\n", "P", "T", "\n"],
+    "RD": ["\n", "R", "D", "\n"],
+    "NM": ["\n", "N", "M", "\n"],
+    "FM": ["\n", "F", "M", "\n"],
+}
+
+
+class SimulationError(Exception):
+    pass
+
+
+class Com(ComSuperClass):
+    def __init__(
+        self, baudrate: int = 19200, filters: Optional[list[str]] = None
+    ) -> None:
+        # Calling the constructor of the super class to assign defaults
+        print("\n\nWARNING: Using testing library for communication!\n\n")
+        super().__init__(baudrate, filters)
+
+        # Initialize queue with values to be sent on call of recieve
+        self.__simulated_data: queue.Queue[bytes] = queue.Queue()
+        self.__simulated_data_remaining = 0
+
+        # Initially, we are in normal mode (which leads to slower data intervals)
+        self.__mode = "NM"
+
+    def set_port_override(self, override: str) -> None:
+        """Set the port override, to disable port search"""
+        self._port_override = override
+
+    def get_comport(self) -> str:
+        return "test" if self._port_override != "" else self._port_override
+
+    def connect(self) -> bool:
+        # Randomly return false in 1 in 20 ish cases
+        if random.randint(0, 20) == 1:
+            print("Simulating error to connect")
+            return False
+        return True
+
+    def close(self) -> None:
+        pass
+
+    def receive(self, byte_count: int) -> bytes:
+        data = []
+        # If queue is too short, refill it
+        if self.__simulated_data_remaining < byte_count:
+            self.__fill_queue()
+
+        for _ in range(byte_count):
+            if self.__mode == "NM":
+                time.sleep(0.001)
+            try:
+                data.append(self.__simulated_data.get_nowait())
+                self.__simulated_data_remaining -= 1
+            except Exception as e:
+                print("ERROR: Simulation could not continue")
+                raise SimulationError(
+                    "Simulation encountered an error with the simulation queue. The error encountered: \n"
+                    + str(e)
+                )
+        return b''.join(data)
+
+    def send(self, msg: str) -> None:
+        # Using LUT to reference
+        readback = instruction_lut.get(msg)
+        if readback != None:
+            for i in range(len(readback)):
+                self.__simulated_data.put(bytes(readback[i], "ascii"))
+        if msg == "RD":
+            # Handle ReadData readback
+            # self.__simulated_data.put(ord(""))
+            pass
+
+    def send_float(self, msg: float) -> None:
+        # Encode float as 8 bytes (64 bit)
+        ba = struct.pack("d", msg)
+        for byte in ba:
+            self.__simulated_data.put(byte.to_bytes())
+
+    def __fill_queue_alternative(self):
+        for _ in range(4):
+            for _ in range(4):
+                self.__simulated_data.put(random.randbytes(1))
+            self.__simulated_data.put(bytes(" ", "ascii"))
+            for _ in range(6):
+                self.__simulated_data.put(random.randbytes(1))
+            self.__simulated_data.put(bytes(" ", "ascii"))
+        for _ in range(3):
+            for _ in range(4):
+                self.__simulated_data.put(random.randbytes(1))
+            self.__simulated_data.put(bytes(" ", "ascii"))
+        for _ in range(4):
+            self.__simulated_data.put(random.randbytes(1))
+        self.__simulated_data.put(bytes("\n", "ascii"))
+        self.__simulated_data_remaining = 68
+
+    def __fill_queue(self):
+        for _ in range(4):
+            self.__add_integer_as_hex(self.__generate_random_int(200))
+            self.__simulated_data.put(bytes(" ", "ascii"))
+            self.__add_float_as_hex(self.__generate_random_float(50))
+            self.__simulated_data.put(bytes(" ", "ascii"))
+            self.__simulated_data_remaining += 2
+        for _ in range(3):
+            self.__add_integer_as_hex(self.__generate_random_int(65535))
+            self.__simulated_data.put(bytes(" ", "ascii"))
+        self.__add_integer_as_hex(self.__generate_random_int(65535))
+        self.__simulated_data.put(bytes("\n", "ascii"))
+        self.__simulated_data_remaining += 4
+        print("Length:", self.__simulated_data_remaining)
+
+    def __generate_random_int(self, max: int) -> int:
+        return random.randint(0, max)
+
+    def __generate_random_float(self, max: int) -> float:
+        return random.random() * max
+
+    def __add_character_as_hex(self, data: str):
+        pass
+
+    def __add_integer_as_hex(self, data: int):
+        pass
+
+    def __add_float_as_hex(self, data: float):
+        pass

plot_generator/fit.py

@@ -1,36 +1,29 @@
 import csv
 import numpy as np
 import matplotlib.pyplot as plt
-go = 0
 
-n = int(input("Aktuelle Sondennummer: "))
+n = int(input("Sensor number to be printed: "))
 
-try:
+file = ""
-    imp = open("Sonden2021.csv", "r")
-    go = 1
-except FileNotFoundError:
-    print("Failed to open file (non-existent or corrupted?)")
-    go = 0
 
-if go == 1:
+def generate_plot():
-    reader = csv.reader(imp, delimiter=',')
+    reader = csv.reader(file, delimiter=',')
-    rohdaten = list(reader)
+    data = list(reader)
-    rohdaten.sort(key=lambda imp: float(imp[2]))
+    data.sort(key=lambda imp: float(imp[2]))
-    lenght = len(rohdaten)
+    lenght = len(data)
     x = []
     y = []
 
-    for i in range(lenght):
+    for _ in range(lenght):
-        extract = rohdaten.pop(0)
+        extract = data.pop(0)
-        sondennummer = int(extract.pop(0))
+        sensor = int(extract.pop(0))
-        if sondennummer == n:
+        if sensor == n:
             ye = extract.pop(0)
             xe = extract.pop(0)
             y.append(float(ye))
             x.append(float(xe))
 
     fit = np.polyfit(x, y, 2)
-    print(fit)
 
     formula = f"F(U) = {round(float(fit[0]), 4)}U^2+{round(float(fit[1]), 4)}U+{round(float(fit[2]), 4)}"
 
@@ -38,24 +31,30 @@ if go == 1:
 
     plt.plot(x, fit_fn(x), color="BLUE", label="T(U)")
 
-    plt.scatter(x, y, color="MAGENTA", marker="o", label="Messsdaten")
+    plt.scatter(x, y, color="MAGENTA", marker="o", label="Data")
-    plt.ylabel("Temperatur")
+    plt.ylabel("Temperature")
-    plt.xlabel("Spannung")
+    plt.xlabel("Voltage")
-    titel = 'Temperatursonde MCP9701A Nummer: {}'.format(n)
+    title = 'Sensor MCP9701A #{}'.format(n)
-    plt.title(titel)
+    plt.title(title)
-    plt.axis([0.6, 2, 15, 70])
+    plt.axis((0.6, 2.0, 15.0, 70.0))
     plt.legend(loc="lower right")
     plt.annotate(formula, xy=(0.85, 60))
     plt.grid(True)
     plt.show()
 
-    saveit = input("Soll der Graph gespeichert werden? (y/n) ").lower()
+    saveit = input("Do you wish to save the plot? (y/N) ").lower()
 
     if saveit == "y":
-        plt.savefig("Sonde"+str(n)+".png")
+        plt.savefig("Sensor"+str(n)+".png")
-        plt.savefig("Sonde"+str(n)+".pdf", format="pdf")
+        plt.savefig("Sensor"+str(n)+".pdf", format="pdf")
-        plt.savefig("Sonde"+str(n)+".svg", format="svg")
+        plt.savefig("Sensor"+str(n)+".svg", format="svg")
-        print("saved images")
+        print("==> Images saved")
     else:
-        print("discarded images")
+        print("==> Images discarded")
-        
+
+filename = input("Please enter a file path to the csv file to be plotted: ")
+try:
+    file = open(filename, "r")
+    generate_plot()
+except FileNotFoundError:
+    print("Failed to open file (non-existent or corrupted?)")

requirements.txt

@@ -0,0 +1,2 @@
+kivy[base]
+pyserial