Compare commits

...

5 commits
v0.1.4 ... main

Author SHA1 Message Date
c9a0f7dcb3 fix typo 2022-02-22 08:27:28 +01:00
9eef6418a9 fix docstrings #2 2022-02-22 00:15:16 +01:00
1f24d7486b fix docstrings 2022-02-22 00:12:38 +01:00
ce1b61b952 Bump version: 0.1.4 → 0.1.5 2022-02-09 15:52:21 +01:00
4ea79271e7 fix inverted queuing mode for add_task 2022-02-09 15:51:21 +01:00
9 changed files with 83 additions and 17 deletions

View file

@ -1,5 +1,5 @@
[bumpversion] [bumpversion]
current_version = 0.1.4 current_version = 0.1.5
commit = True commit = True
tag = True tag = True

View file

@ -6,7 +6,7 @@ with open('README.rst') as f:
setuptools.setup( setuptools.setup(
name='TSGRain Controller', name='TSGRain Controller',
version='0.1.4', version='0.1.5',
author='ThetaDev', author='ThetaDev',
description='TSGRain irrigation controller', description='TSGRain irrigation controller',
long_description=README, long_description=README,

View file

@ -45,7 +45,7 @@ def app(mocker):
assert not app.is_running() assert not app.is_running()
def test_start_task(app): def test_request_task(app):
# Manually start a task (like via button press) # Manually start a task (like via button press)
res = app.request_task( res = app.request_task(
models.TaskRequest(source=models.Source.MANUAL, models.TaskRequest(source=models.Source.MANUAL,
@ -80,13 +80,13 @@ def test_start_task(app):
assert res.stopped assert res.stopped
def test_start_task_queue(app): def test_request_task_queue(app):
# Manually start a task (like via button press) # Enqueue and start a new task
res = app.request_task( res = app.request_task(
models.TaskRequest(source=models.Source.MANUAL, models.TaskRequest(source=models.Source.MANUAL,
zone_id=2, zone_id=2,
duration=30, duration=30,
queuing=False, queuing=True,
cancelling=True)) cancelling=True))
assert res.started assert res.started
assert not res.stopped assert not res.stopped
@ -135,6 +135,51 @@ def test_start_task_queue(app):
assert res.stopped assert res.stopped
def test_start_task(app):
# Manually start a task (like via button press)
assert app.start_task(models.Source.MANUAL, 2, 30, False)
# Queue processing time
time.sleep(0.1)
# Try to start the same task again -> nothing happens
assert not app.start_task(models.Source.MANUAL, 2, 30, False)
def test_start_task_queue(app):
# Enqueue and start a new task
assert app.start_task(models.Source.MANUAL, 2, 30, True)
# Queue processing time
time.sleep(0.1)
assert app.queue.running_task.zone_id == 2
# Duplicate task should not be enqueued
assert not app.start_task(models.Source.MANUAL, 2, 30, True)
# Enqueue new tasks
assert app.start_task(models.Source.MANUAL, 3, 30, True)
assert app.start_task(models.Source.SCHEDULE, 2, 30, True)
def test_stop_task(app):
# Enqueue and start a new task
assert app.start_task(models.Source.MANUAL, 2, 30, True)
# Queue processing time
time.sleep(0.1)
assert app.queue.running_task.zone_id == 2
# Stop task
assert not app.stop_task(models.Source.MANUAL, 3)
assert app.stop_task(models.Source.MANUAL, 2)
# Queue processing time
time.sleep(0.1)
assert app.queue.running_task is None
def test_crud_job(app): def test_crud_job(app):
# Insert jobs # Insert jobs
job1 = models.Job.deserialize(JOB1_DATA) job1 = models.Job.deserialize(JOB1_DATA)

View file

@ -1 +1 @@
__version__ = '0.1.4' __version__ = '0.1.5'

View file

@ -121,7 +121,7 @@ class Application(models.AppInterface):
task = models.Task(source, zone_id, duration) task = models.Task(source, zone_id, duration)
task.validate(self) task.validate(self)
return self.queue.enqueue(task, not queuing) return self.queue.enqueue(task, queuing)
def stop_task(self, source: models.Source, zone_id: int) -> bool: def stop_task(self, source: models.Source, zone_id: int) -> bool:
for task in self.queue.tasks: for task in self.queue.tasks:
@ -176,6 +176,7 @@ class Application(models.AppInterface):
systimecfg.set_system_timezone(tz, self.cfg.cmd_set_timezone) systimecfg.set_system_timezone(tz, self.cfg.cmd_set_timezone)
def start(self): def start(self):
"""Starte die Anwendung"""
logging.info('Starting application') logging.info('Starting application')
self._running = True self._running = True
self.io.start() self.io.start()
@ -185,6 +186,7 @@ class Application(models.AppInterface):
self.grpc_server.start() self.grpc_server.start()
def stop(self): def stop(self):
"""Stoppe die Anwendung"""
logging.info('Stopping application') logging.info('Stopping application')
self._running = False self._running = False
self.grpc_server.stop(None) self.grpc_server.stop(None)

View file

@ -238,7 +238,7 @@ class _MCP23017Device:
Beispiel: ``0x27/B0`` (MCP23017 mit I2C-Adresse 0x27, Pin B0) Beispiel: ``0x27/B0`` (MCP23017 mit I2C-Adresse 0x27, Pin B0)
Um den Zustand eines Geräts zu invertieren, einfach ``/!`` Um den Zustand eines Geräts zu invertieren, einfach ``/!``
an den Konfiguraionsstring anfügen: ``0x27/B0/!`` an den Konfigurationsstring anfügen: ``0x27/B0/!``
:param cfg_str: Konfigurationsstring :param cfg_str: Konfigurationsstring
:return: Neues ``_MCP23017Device``-Objekt :return: Neues ``_MCP23017Device``-Objekt

View file

@ -51,10 +51,10 @@ class Job:
and date_now.minute == self.date.minute and date_now.minute == self.date.minute
return date_now.year == self.date.year \ return date_now.year == self.date.year \
and date_now.month == self.date.month \ and date_now.month == self.date.month \
and date_now.day == self.date.day \ and date_now.day == self.date.day \
and date_now.hour == self.date.hour \ and date_now.hour == self.date.hour \
and date_now.minute == self.date.minute and date_now.minute == self.date.minute
def serialize(self) -> Dict[str, Any]: def serialize(self) -> Dict[str, Any]:
return { return {
@ -96,6 +96,10 @@ class Job:
) )
def validate(self, app: 'AppInterface'): def validate(self, app: 'AppInterface'):
"""
Prüfe, ob der Task gültige Daten enthält
(Zonen existieren, Bewässerungszeit > 0)
"""
if not self.zones: if not self.zones:
raise util.InvalidInputException('No zones set') raise util.InvalidInputException('No zones set')
if self.duration < 1: if self.duration < 1:
@ -309,7 +313,7 @@ class AppInterface:
:param request: Objekt, dass die Parameter der neuen Aufgabe enthält. :param request: Objekt, dass die Parameter der neuen Aufgabe enthält.
:return: Statusobjekt (Information, ob eine Aufgabe gestartet oder gestoppt :return: Statusobjekt (Information, ob eine Aufgabe gestartet oder gestoppt
wurde). wurde).
""" """
def start_task(self, source: Source, zone_id: int, duration: int, def start_task(self, source: Source, zone_id: int, duration: int,
@ -321,7 +325,7 @@ class AppInterface:
:param zone_id: ID der Bewässerungszone :param zone_id: ID der Bewässerungszone
:param duration: Bewässerungsdauer in Sekunden (0 für Standarddauer) :param duration: Bewässerungsdauer in Sekunden (0 für Standarddauer)
:param queuing: Neue Aufgabe in die Warteschlange einreihen, wenn momentan :param queuing: Neue Aufgabe in die Warteschlange einreihen, wenn momentan
eine andere Zone bewässert wird. eine andere Zone bewässert wird.
:return: True wenn die Aufgabe erfolgreich gestartet wurde :return: True wenn die Aufgabe erfolgreich gestartet wurde
""" """

View file

@ -28,7 +28,7 @@ class TaskQueue(util.StoppableThread, TaskHolder):
:param task: Neuer Task :param task: Neuer Task
:param queuing: Füge Task der Warteschlange hinzu, wenn bereits :param queuing: Füge Task der Warteschlange hinzu, wenn bereits
ein anderer Task läuft ein anderer Task läuft
:return: True wenn Task erfolgreich hinzugefügt :return: True wenn Task erfolgreich hinzugefügt
""" """
if not queuing and self.running_task is not None: if not queuing and self.running_task is not None:

View file

@ -129,9 +129,20 @@ class StoppableThread(threading.Thread):
pass pass
def run_cycle(self): def run_cycle(self):
pass """
Führe einen Durchlauf des Threads aus.
Diese Funktion darf nicht blockieren, sonst kann der
Thread nicht gestoppt werden.
"""
def run(self): def run(self):
"""
Führe die ``run_cycle()``-Funktion in
Endlosschleife aus, mit einer durch das
``interval``-Attribut bestimmten Verzögerung zwischen
den Durchläufen.
"""
try: try:
self.setup() self.setup()
@ -146,6 +157,10 @@ class StoppableThread(threading.Thread):
sys.excepthook(*sys.exc_info()) sys.excepthook(*sys.exc_info())
def stop(self): def stop(self):
"""
Stoppe den Thread und warte bis er beendet. Dies dauert
maximal ``interval`` + Durchlaufzeit von ``run_cycle()``.
"""
self._stop_signal.set() self._stop_signal.set()
try: try:
self.join() self.join()