mirror of
https://github.com/janishutz/BiogasControllerApp.git
synced 2025-11-25 05:44:23 +00:00
Main, Program Screen basically done, UI Tweaks, backend fixes, start writing testing library
This commit is contained in:
@@ -1,30 +1,49 @@
|
||||
from kivy.uix.screenmanager import Screen
|
||||
from kivy.lang import Builder
|
||||
from gui.popups.popups import QuitPopup, SingleRowPopup, TwoActionPopup
|
||||
from gui.popups.popups import QuitPopup, TwoActionPopup
|
||||
from lib.com import Com
|
||||
|
||||
import configparser
|
||||
|
||||
config = configparser.ConfigParser()
|
||||
config.read('./config.ini')
|
||||
|
||||
# This is the launch screen, i.e. what you see when you start up the app
|
||||
class HomeScreen(Screen):
|
||||
def __init__(self, com: Com, **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(19200):
|
||||
if config[ 'Dev Settings' ][ 'disableconnectioncheck' ] != "True":
|
||||
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')
|
||||
else:
|
||||
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):
|
||||
# TODO: Finish
|
||||
print( 'Details' )
|
||||
|
||||
# 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')
|
||||
|
||||
@@ -74,25 +74,7 @@
|
||||
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: "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.end()
|
||||
app.root.current = "read"
|
||||
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.end()
|
||||
app.root.current = "temperature"
|
||||
root.manager.transition.direction = "down"
|
||||
Button:
|
||||
text: "Change all Data"
|
||||
text: "Configuration"
|
||||
size_hint: 0.15, 0.1
|
||||
pos_hint: {"x":0.7, "y":0.2}
|
||||
background_color: (255, 0, 0, 0.6)
|
||||
@@ -101,7 +83,7 @@
|
||||
app.root.current = "program"
|
||||
root.manager.transition.direction = "down"
|
||||
Label:
|
||||
id: frequency
|
||||
text: "Frequency will appear here"
|
||||
id: status
|
||||
text: "Status will appear here"
|
||||
font_size: 10
|
||||
pos_hint: {"x":0.4, "y": 0.3}
|
||||
|
||||
@@ -1,25 +1,200 @@
|
||||
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 Com
|
||||
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: Com
|
||||
_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: Com):
|
||||
"""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()
|
||||
|
||||
# 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("", ["\n", " ", " ", " "]):
|
||||
# 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_float(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: Com, **kw):
|
||||
self._com = com;
|
||||
# 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):
|
||||
pass
|
||||
self.ids.status.text = "Connecting..."
|
||||
if self._com.connect():
|
||||
self._has_connected = True
|
||||
# Start communication
|
||||
self._reader.start()
|
||||
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):
|
||||
pass
|
||||
# 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()
|
||||
self.ids.status.text = "Connection terminated"
|
||||
|
||||
# A helper function to update the screen. Is called on an interval
|
||||
def _update_screen(self):
|
||||
update = synced_queue.get()
|
||||
if len(update) == 1:
|
||||
if update[0] == "ERR_HOOK":
|
||||
self.ids.status.text = "Hook failed"
|
||||
self.end()
|
||||
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):
|
||||
pass
|
||||
self.ids.sensor1.text = ""
|
||||
self.ids.sensor2.text = ""
|
||||
self.ids.sensor3.text = ""
|
||||
self.ids.sensor4.text = ""
|
||||
self.ids.status.text = "Status will appear here"
|
||||
|
||||
def back(self):
|
||||
pass
|
||||
# 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()
|
||||
|
||||
|
||||
Builder.load_file('./gui/main/main.kv')
|
||||
# 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")
|
||||
|
||||
@@ -4,9 +4,15 @@ from kivy.lang import Builder
|
||||
|
||||
from lib.com import Com
|
||||
|
||||
|
||||
# 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: Com, **kw):
|
||||
self._com = com;
|
||||
@@ -50,4 +56,8 @@ class TwoActionPopup(Popup):
|
||||
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')
|
||||
|
||||
@@ -0,0 +1,131 @@
|
||||
<ProgramScreen>:
|
||||
name: "program"
|
||||
on_pre_enter: self.config_loader = root.load_config()
|
||||
canvas.before:
|
||||
Color:
|
||||
rgba: (50,50,50,0.2)
|
||||
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()
|
||||
|
||||
@@ -1,20 +1,94 @@
|
||||
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 Com
|
||||
from kivy.clock import Clock
|
||||
|
||||
|
||||
class HomeScreen(Screen):
|
||||
# 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: Com, **kw):
|
||||
self._com = com;
|
||||
self._com = com
|
||||
self._instructions = Instructions(com)
|
||||
self._decoder = Decoder()
|
||||
super().__init__(**kw)
|
||||
|
||||
def start(self):
|
||||
pass
|
||||
def load_config(self):
|
||||
Clock.schedule_once(self._load)
|
||||
|
||||
def quit(self):
|
||||
pass
|
||||
# Load the current configuration from the micro-controller
|
||||
def _load(self, dt: float):
|
||||
if self._instructions.hook("RD", ["\n", "R", "D", "\n"]):
|
||||
config: List[List[str]] = []
|
||||
|
||||
def to_settings(self):
|
||||
pass
|
||||
# Load config for all four sensors
|
||||
for _ in range(4):
|
||||
# Receive 28 bytes of data
|
||||
received = self._com.receive(28)
|
||||
|
||||
# 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")
|
||||
|
||||
|
||||
Builder.load_file('./gui/home/home.kv')
|
||||
# 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")
|
||||
|
||||
Reference in New Issue
Block a user