Sync with branch 'dev_m'

Added nodes for alert system. So far only an alert switch can be
triggered. Email and Telegram aren't supported yet.

Fixed a startup crash when QuestDB is missing.

Renamed CalibrationAux to ScaleAux, this will break existing config
files!

Author: schwabix-1311

ToDo

@@ -34,7 +34,7 @@ aquaPi ToDo list
     controller: null (out=in), delay
     input: schedule analog?, random
     aux: min, limiter
-    misc: email, telegram (pyTelegramBotAPI), history, cloud telemetry, macro
+    misc: email, telegram, history, cloud telemetry, macro
 
 - macros!?! = scheduled/triggered sender of msgs on the bus? wait for msgs?
   This will require affected nodes to supended their listening to avoid conflicts.
@@ -78,7 +78,31 @@ aquaPi ToDo list
   adapter µUSB->USB A plus cable USB A -> USB B
 
 - Telegram bot in Python:
+  package pyTelegramBotAPI,
   https://thepythoncorner.com/posts/2021-01-16-how-create-telegram-bot-in-python/
+  in channel BotFather  /newbot:  name aquaPi, bot @UNIQUE_bot, remeber bot token,
+  find own "chat id": https://web.telegram.org/z/#?tgaddr=tg://resolve?domain=schwabix,
+    this redirects to a URL ending in your chat id
+    OR join and start @RawDataBot, it will reply with json showing your chat:id
+    OR join and start your bot, then https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates
+  send message - 8135... is bot token, 1261... is chat id - multiple subscribers??:
+    https://api.telegram.org/botXXXXXXXXX:AAEQ0ec6XT6i0BSvF3ldVrmepETMTjyxNiE/sendMessage?chat_id=XXXXXXXXX&text=bot6135_to_1261..
+  and modify/update it:
+    https://api.telegram.org/botXXXXXXXXX:AAEQ0ec6XT6i0BSvF3ldVrmepETMTjyxNiE/editMessageText?message_id=2983&chat_id=XXXXXXXXX&text=changed_Text
+  get message history (depth?), could be used to receive commands:
+    https://api.telegram.org/botYYYYYYYYYY:AAHH4nCC-vD8clvfiMryls_ZpdJi_HskctM/getUpdates
+      sample -> 
+    {"ok":true,"result":[{"update_id":23832511,
+"message":{"message_id":1,"from":{"id":126177523,"is_bot":false,"first_name":"Markus","username":"schwabix","language_code":"de"},"chat":{"id":126177523,"first_name":"Markus","username":"schwabix","type":"private"},"date":1691342697,"text":"/start","entities":[{"offset":0,"length":6,"type":"bot_command"}]}},{"update_id":23832512,
+...
+"message":{"message_id":7,"from":{"id":126177523,"is_bot":false,"first_name":"Markus","username":"schwabix","language_code":"de"},"chat":{"id":126177523,"first_name":"Markus","username":"schwabix","type":"private"},"date":1691343059,"text":"soso"}},{"update_id":23832516,
+"message":{"message_id":10,"from":{"id":126177523,"is_bot":false,"first_name":"Markus","username":"schwabix","language_code":"de"},"chat":{"id":126177523,"first_name":"Markus","username":"schwabix","type":"private"},"date":1691343182,"text":"silence"}}]}
+
+  or bot as group member allows multiple receivers, but only 1 bot??:
+    https://api.telegram.org/botYYYYYYYYYY:AAHH4nCC-vD8clvfiMryls_ZpdJi_HskctM/sendMessage?chat_id=-978207359&text=ph%20Alarm!
+
+  OR simple sample without dedicated package!!:
+    https://medium.com/codex/using-python-to-send-telegram-messages-in-3-simple-steps-419a8b5e5e2
 
 - packaging and deployment ... long way to there!
 

aquaPi/api.py

@@ -12,7 +12,7 @@
 )
 from http import HTTPStatus
 
-from .machineroom.misc_nodes import BusRole
+from .machineroom.msg_bus import BusRole
 from .pages.sse_util import send_sse_events
 
 

aquaPi/driver/DriverAlert.py

@@ -0,0 +1,31 @@
+"""
+Extract from medium.com "using-python-to-send-telegram-messages-in-3-simple-steps"
+
+2. Getting your chat ID
+
+In Telegram, every chat has a chat ID, and we need this chat ID to send Telegram messages using Python.
+
+    Send your Telegram bot a message (any random message)
+    Run this Python script to find your chat ID
+
+import requests
+TOKEN = "YOUR TELEGRAM BOT TOKEN"
+url = f"https://api.telegram.org/bot{TOKEN}/getUpdates"
+print(requests.get(url).json())
+
+This script calls the getUpdates function, which kinda checks for new messages. We can find our chat ID from the returned JSON (the one in red)
+
+Note: if you don’t send your Telegram bot a message, your results might be empty.
+
+3. Copy and paste the chat ID into our next step
+3. Sending your Telegram message using Python
+
+Copy and paste 1) your Telegram bot token and 2) your chat ID from the previous 2 steps into the following Python script. (And do customize your message too)
+
+import requests
+TOKEN = "YOUR TELEGRAM BOT TOKEN"
+chat_id = "YOUR CHAT ID"
+message = "hello from your telegram bot"
+url = f"https://api.telegram.org/bot{TOKEN}/sendMessage?chat_id={chat_id}&text={message}"
+print(requests.get(url).json()) # this sends the message
+"""

aquaPi/driver/DriverGPIO.py

@@ -99,7 +99,6 @@ def find_ports():
                 'GPIO 4 in': IoPort(PortFunc.Bin, DriverGPIO, {'pin': 4, 'fake': True}, []),     # 1-wire
                 'GPIO 4 out': IoPort(PortFunc.Bout, DriverGPIO, {'pin': 4, 'fake': True}, []),   # 1-wire
                 'GPIO 12 out': IoPort(PortFunc.Bout, DriverGPIO, {'pin': 12, 'fake': True}, []),  # Heater relay
-                'GPIO 13 out': IoPort(PortFunc.Bout, DriverGPIO, {'pin': 13, 'fake': True}, []),  # (Cooler relay)
                 'GPIO 18 in': IoPort(PortFunc.Bin, DriverGPIO, {'pin': 18, 'fake': True}, []),
                 'GPIO 18 out': IoPort(PortFunc.Bout, DriverGPIO, {'pin': 18, 'fake': True}, []),  # PWM 0
                 'GPIO 19 in': IoPort(PortFunc.Bin, DriverGPIO, {'pin': 19, 'fake': True}, []),

aquaPi/driver/base.py

@@ -76,7 +76,9 @@ def __init__(self, msg='Failed to write value to the output.'):
 
 
 class PortFunc(Enum):
-    Bin, Bout, Ain, Aout = range(1, 5)
+    """ Function of a port driver: Bool/Analog/String + In/Out
+    """
+    Bin, Bout, Ain, Aout, Sin, Sout = range(1, 7)
 
 
 class PinFunc(Enum):

aquaPi/machineroom/__init__.py

@@ -10,7 +10,8 @@
 from .in_nodes import AnalogInput, ScheduleInput
 from .out_nodes import SwitchDevice, AnalogDevice
 from .aux_nodes import ScaleAux, MinAux, MaxAux, AvgAux
-from .misc_nodes import History
+from .hist_nodes import History
+from .alert_nodes import Alert, AlertAbove, AlertBelow
 
 
 log = logging.getLogger('MachineRoom')
@@ -109,11 +110,13 @@ def create_default_nodes(self):
             Distraction: interesting fact on English:
               "fish" is plural, "fishes" is several species of fish
         """
-        REAL_CONFIG = True   #False  # this disables the other test configs
+        REAL_CONFIG = True   # False  # this disables the other test configs
+
+        TEST_ALERT = True
 
         TEST_PH = True
 
-        SIM_LIGHT = True
+        SIM_LIGHT = False  #True
         DAWN_LIGHT = SIM_LIGHT and False  # True
 
         SIM_TEMP = True
@@ -295,3 +298,13 @@ def create_default_nodes(self):
                                     [w1_temp.id, w2_temp.id, w_temp.id,
                                      w_heat.id, w_cool.id])
                 t_history.plugin(self.bus)
+
+        if TEST_ALERT:
+            led_alert = Alert('Alert LED',
+                              [AlertAbove(calib_ph.id, 7.2), AlertBelow(calib_ph.id, 6.8)],
+                              'GPIO 1 out')
+            led_alert.plugin(self.bus)
+            mail_alert = Alert('Alert Mail',
+                              [AlertAbove(w_temp.id, 26.0), AlertBelow(w_temp.id, 23.0)],
+                              'GPIO 0 out')  #TEMP, no drivers for email/Telegram yet
+            mail_alert.plugin(self.bus)

aquaPi/machineroom/alert_nodes.py

@@ -0,0 +1,171 @@
+#!/usr/bin/env python3
+
+from abc import ABC, abstractmethod
+import logging
+# from time import time
+
+from .msg_bus import (BusListener, BusRole, MsgData, MsgFilter)
+from ..driver import (PortFunc, io_registry, DriverReadError)
+
+
+log = logging.getLogger('AlertNodes')
+log.brief = log.warning  # alias, warning is used as brief info, level info is verbose
+
+log.setLevel(logging.WARNING)
+log.setLevel(logging.INFO)
+# log.setLevel(logging.DEBUG)
+
+
+# ========== alert conditions ==========
+
+
+class AlertCond(ABC):
+    """ Base class for all kind of alerting conditions
+
+        node_id   - id of node this condition applies to
+        threshold - the limit _check() will use
+    """
+    def __init__(self, node_id, threshold):
+        self.node_id = node_id
+        self.threshold = threshold
+        self._alerted = False
+
+    def check_change(self, msg):
+        alerted = self._check(msg)
+        if (alerted == self._alerted):
+            return None
+        self._alerted = alerted
+        return self._alerted
+
+    def is_alerted(self):
+        return self._alerted
+
+    @abstractmethod
+    def _check(self, msg):
+        pass
+
+    def alert_text(self, msg, bus):
+        name = bus.get_node(msg.sender).name or msg.sender
+        return self._text(msg, name)
+
+    @abstractmethod
+    def _text(self, msg, name):
+        pass
+
+
+class AlertAbove(AlertCond):
+    """ Alert when data above threshold
+    """
+    def _check(self, msg):
+        return msg.data > self.threshold
+
+    def _text(self, msg, name):
+        return 'Value of %s is %s: %.4f  [limit %.4f]\n' \
+               % (name, 'too high' if self._alerted else 'OK', msg.data, self.threshold)
+
+
+class AlertBelow(AlertCond):
+    """ Alert when data below threshold
+    """
+    def _check(self, msg):
+        return msg.data < self.threshold
+
+    def _text(self, msg, name):
+        return 'Value of %s is %s: %.4f  [limit %.4f]\n' \
+               % (name, 'too low' if self._alerted else 'OK', msg.data, self.threshold)
+
+
+#class AlertLongActive    _check = now - _last_off > threshold, _text = "Overload/High utilization"
+#class AlertLongInactive  _check = now - _last_on > threshold
+
+# ========== alert node ==========
+
+
+class Alert(BusListener):
+    """ A multi-input node, checking alert conditions with output
+        to email/telegram/etc.
+
+        Options:
+            name       - unique name of this output node in UI
+            conditions - collection of alert conditions
+            driver     - port name of driver of type S(tring)out or B(inary)out
+
+        Output:
+            - nothing -
+    """
+    ROLE = BusRole.ALERTS
+
+    def __init__(self, name, conditions, port, _cont=False):
+        super().__init__(name, _cont=_cont)
+        self.data = 0  # just anything for MsgBorn
+        self._driver = None
+        self._port = None
+        self.port = port
+        if isinstance(conditions, AlertCond):
+            conditions = [conditions]
+        self.conditions = conditions
+        self._inputs = MsgFilter({c.node_id for c in self.conditions})
+
+
+    def __getstate__(self):
+        state = super().__getstate__()
+        state.update(conditions=self.conditions)
+        state.update(port=self.port)
+        return state
+
+    def __setstate__(self, state):
+        self.__init__(state['name'], state['conditions'], state['port'],
+                      _cont=True)
+
+    @property
+    def port(self):
+        return self._port
+
+    @port.setter
+    def port(self, port):
+        if self._driver:
+            io_registry.driver_destruct(self._port, self._driver)
+        if port:
+            self._driver = io_registry.driver_factory(port)
+        self._port = port
+
+    def listen(self, msg):
+        if isinstance(msg, MsgData):
+            any_alert = False
+            any_change = False
+            all_msgs = ''
+            for cond in [c for c in self.conditions if c.node_id == msg.sender]:
+                log.debug('## (%s) check %f against %f - %s', type(cond), msg.data, cond.threshold, cond.node_id)
+                cond_change = cond.check_change(msg)
+
+                cond_txt = cond.alert_text(msg, self._bus)
+                if cond_change is not None:
+                    all_msgs += cond_txt
+                    any_alert |= cond_change
+                    any_change = True
+                    log.debug('## "%s" changed to "%s"', type(cond), cond_txt)
+                elif cond.is_alerted():
+                    all_msgs += cond_txt
+                    any_alert |= True
+                    log.debug('## "%s" still is "%s"', type(cond), cond_txt)
+
+            if any_alert or any_change:
+                log.warning(all_msgs)
+
+            # IDEA might add a repeat interval here
+            if any_change:
+                if self._driver.func == PortFunc.Bout:
+                    self._driver.write(100 if any_alert else 0)
+                    log.info('Alert device "%s" set to %d', self._driver.name, 100 if any_alert else 0)
+                elif self._driver.func == PortFunc.Sout:
+                    self._driver.write(all_msgs)
+                    log.info('Alert receiver "%s" will get msg:  "%s"', self._driver.name, all_msgs)
+                self.post(MsgData(self.id, all_msgs))   #TODO MsgAlert ??
+
+    def get_settings(self):
+        return []
+##        settings = super().get_settings()
+##        settings.append(('duration', 'max. Dauer', self.duration,
+##                         'type="number" min="0" max="%d"' % (24*60*60)))
+##        return settings
+