Migrate Triggers

Moved triggers to new extension
- `schedule` -> `cron`
- `control` -> `control`
- `sensor` -> `sensor`
- Added `state` trigger type
- TriggerGroup is now `GroupTrigger`
- Triggers can now be apart of multiple groups
- Added `toggle` trigger type

Author: olixr

README.md

@@ -1,7 +1,7 @@
 <p align="center"><img alt="MudPi Smart Automation for the Garden & Home" title="MudPi Smart Automation for the Garden & Home" src="https://mudpi.app/img/mudPI_LOGO_small_grad.png" width="200px"></p>
 
 # MudPi Smart Automation for the Garden & Home
-> A python library to gather sensor readings, trigger components, control solenoids and more in an event based system that can be run on a linux SBC, including Raspberry Pi.
+> A python package to gather sensor readings, trigger components, control devices and more in an event based system that can be run on a linux SBC, including Raspberry Pi.
 
 
 ## Documentation
@@ -36,7 +36,7 @@ Breaking.Major.Minor
 * Discord  - [Join](https://discord.gg/daWg2YH)
 * [Twitter.com/MudpiApp](https://twitter.com/mudpiapp)
 
-## Hardware Tested On
+<!-- ## Hardware Tested On
 These are the devices and sensors I tested and used with MudPi successfully. Many sensors are similar so it will work with a range more than what is listed below.
 
 **Devices**
@@ -71,9 +71,10 @@ These are the devices and sensors I tested and used with MudPi successfully. Man
 * [LCD 20 x 4 Display I2C](https://www.dfrobot.com/product-590.html)
 * [USB to TTL USB 2.0 Serial Module UART](https://www.amazon.com/gp/product/B07CWKHTLH/ref=oh_aui_detailpage_o04_s00?ie=UTF8&psc=1)
 
-Let me know if you are able to confirm tests on any other devices. Note: This is not a complete list.
+Let me know if you are able to confirm tests on any other devices. Note: This is not a complete list. -->
 
-Also check out my [custom circuit boards design around MudPi](https://mudpi.app/boards)
+## MudPi Hardware
+There are [custom circuit boards designed around MudPi available.](https://mudpi.app/boards)
 
 ## License
 This project is licensed under the BSD-4-Clause License - see the [LICENSE.md](LICENSE.md) file for details

mudpi/extensions/control/__init__.py

@@ -80,7 +80,7 @@ def invert_state(self):
     def fire(self):
         """ Fire a control event """
         event_data = {
-            'event': 'ControlUpdate',
+            'event': 'ControlUpdated',
             'component_id': self.id,
             'type': self.type,
             'name': self.name,

mudpi/extensions/control/trigger.py

@@ -0,0 +1,91 @@
+""" 
+    Control Trigger Interface
+    Monitors control state changes and 
+    checks new state against any 
+    thresholds if provided.
+"""
+from mudpi.utils import decode_event_data
+from mudpi.exceptions import ConfigError
+from mudpi.extensions import BaseInterface
+from mudpi.extensions.trigger import Trigger
+from mudpi.logger.Logger import Logger, LOG_LEVEL
+
+
+class Interface(BaseInterface):
+
+    def load(self, config):
+        """ Load control Trigger component from configs """
+        trigger = ControlTrigger(self.mudpi, config)
+        if trigger:
+            self.add_component(trigger)
+        return True
+
+    def validate(self, config):
+        """ Validate the trigger config """
+        if not isinstance(config, list):
+            config = [config]
+
+        for conf in config:
+            if not conf.get('source'):
+                raise ConfigError('Missing `source` key in Sensor Trigger config.')
+            
+        return config
+
+
+class ControlTrigger(Trigger):
+    """ A trigger that listens to states
+        and checks for new state that 
+        matches any thresholds.
+    """
+
+    # Used for onetime subscribe
+    _listening = False
+    
+    
+    def init(self):
+        """ Listen to the state for changes """
+        super().init()
+        if self.mudpi.is_prepared:
+            if not self._listening:
+                # TODO: Eventually get a handler returned to unsub just this listener
+                self.mudpi.events.subscribe('control', self.handle_event)
+                self._listening = True
+        return True
+
+    """ Methods """
+    def handle_event(self, event):
+        """ Handle the event data from the event system """
+        _event_data = decode_event_data(event)
+        if _event_data.get('event'):
+            try:
+                if _event_data['event'] == 'ControlUpdated':
+                    if _event_data['component_id'] == self.source:
+                        _value = self._parse_data(_event_data["state"])
+                        if self.evaluate_thresholds(_value):
+                            self.active = True
+                            if self._previous_state != self.active:
+                                # Trigger is reset, Fire
+                                self.trigger(_event_data)
+                            else:
+                                # Trigger not reset check if its multi fire
+                                if self.frequency == 'many':
+                                    self.trigger(_event_data)
+                    else:
+                        self.active = False
+            except Exception as error:
+                Logger.log(LOG_LEVEL["error"],
+                           f'Error evaluating thresholds for trigger {self.id}')
+                Logger.log(LOG_LEVEL["debug"], error)
+        self._previous_state = self.active
+
+    def unload(self):
+        # Unsubscribe once bus supports single handler unsubscribes
+        return
+
+    def _parse_data(self, data):
+        """ Get nested data if set otherwise return the data """
+        if isinstance(data, dict):
+            print('dict con')
+            return data if not self.nested_source else data.get(self.nested_source, None)
+        return data
+

mudpi/extensions/cron/__init__.py

@@ -0,0 +1,12 @@
+""" 
+    Cron Extension
+    Cron schedule support for triggers
+    to allow scheduling.
+"""
+from mudpi.extensions import BaseExtension
+
+
+class Extension(BaseExtension):
+    namespace = 'cron'
+    update_interval = 1
+ 

mudpi/extensions/cron/extension.json

@@ -0,0 +1,9 @@
+{
+	"name": "Cron",
+	"namespace": "cron",
+	"details": {
+		"description": "Cron job schedule support for components.",
+		"documentation": "https://mudpi.app/docs/triggers"
+	},
+	"requirements": ["pycron"]
+}

mudpi/extensions/cron/trigger.py

@@ -0,0 +1,72 @@
+""" 
+    Cron Trigger Interface
+    Cron schedule support for triggers
+    to allow scheduling.
+"""
+import time
+import pycron
+from mudpi.exceptions import ConfigError
+from mudpi.extensions import BaseInterface
+from mudpi.extensions.trigger import Trigger
+from mudpi.logger.Logger import Logger, LOG_LEVEL
+
+
+class Interface(BaseInterface):
+    
+    def load(self, config):
+        """ Load cron trigger component from configs """
+        trigger = CronTrigger(self.mudpi, config)
+        if trigger:
+            self.add_component(trigger)
+        return True
+
+    def validate(self, config):
+        """ Validate the trigger config """
+        if not isinstance(config, list):
+            config = [config]
+
+        for conf in config:
+            if not conf.get('schedule'):
+                Logger.log(
+                    LOG_LEVEL["debug"],
+                    'Trigger: No `schedule`, defaulting to every 5mins'
+                )
+                # raise ConfigError('Missing `schedule` in Trigger config.')
+            
+        return config
+
+
+class CronTrigger(Trigger):
+    """ A trigger that resoponds to time 
+        changes based on cron schedule string 
+    """
+
+    """ Properties """
+    @property
+    def schedule(self):
+        """ Cron schedule string to check time against """
+        return self.config.get('schedule', '*/5 * * * *')
+
+
+    """ Methods """
+    def init(self):
+        """ Pass call to parent """
+        super().init()
+
+    def check(self):
+        """ Check trigger schedule thresholds """
+        if self.mudpi.is_running:
+            try:
+                if pycron.is_now(self.schedule):
+                    if not self.active:
+                        self.trigger()
+                        self.active = True
+                else:
+                    self.active = False
+            except Exception as error:
+                Logger.log(
+                    LOG_LEVEL["error"],
+                    "Error evaluating time trigger schedule."
+                )
+        return
+

mudpi/extensions/group/__init__.py

@@ -0,0 +1,11 @@
+""" 
+    Group Extension
+    Allows grouping of components.
+"""
+from mudpi.extensions import BaseExtension
+
+
+class Extension(BaseExtension):
+    namespace = 'group'
+    update_interval = 0.2
+ 

mudpi/extensions/group/extension.json

@@ -0,0 +1,9 @@
+{
+	"name": "Groups",
+	"namespace": "group",
+	"details": {
+		"description": "Enables grouping for components (Triggers).",
+		"documentation": "https://mudpi.app/docs/triggers"
+	},
+	"requirements": []
+}

mudpi/extensions/group/trigger.py

@@ -0,0 +1,83 @@
+""" 
+    Group Trigger Interface
+    Allows triggers to be grouped
+    together for complex conditions.
+"""
+from mudpi.exceptions import ConfigError
+from mudpi.extensions import BaseInterface
+from mudpi.extensions.trigger import Trigger
+from mudpi.logger.Logger import Logger, LOG_LEVEL
+
+
+class Interface(BaseInterface):
+
+    def load(self, config):
+        """ Load group trigger component from configs """
+        trigger = GroupTrigger(self.mudpi, config)
+        if trigger:
+            self.add_component(trigger)
+        return True
+
+    def validate(self, config):
+        """ Validate the trigger config """
+        if not isinstance(config, list):
+            config = [config]
+
+        for conf in config:
+            if not conf.get('triggers'):
+                raise ConfigError('Missing `triggers` keys in Trigger Group')
+            
+        return config
+
+
+class GroupTrigger(Trigger):
+    """ A Group to allow complex combintations 
+        between multiple trigger types. 
+    """
+
+    # List of triggers to monitor
+    _triggers = []
+
+    """ Properties """
+    @property
+    def triggers(self):
+        """ Keys of triggers to group """
+        return self.config.get('triggers', [])
+
+    @property
+    def trigger_states(self):
+        """ Keys of triggers to group """
+        return [trigger.active for trigger in self._triggers]
+
+
+    """ Methods """
+    def init(self):
+        """ Load in the triggers for the group """
+        # Doesnt call super().init() because that is for non-groups
+        self.cache = self.mudpi.cache.get('trigger', {})
+        self.cache.setdefault('groups', {})[self.id] = self
+
+        for _trigger in self.triggers:
+            _trig = self.cache.get('triggers', {}).get(_trigger)
+            if _trig:
+                self.add_trigger(_trig)
+        return True
+
+    def add_trigger(self, trigger):
+        """ Add a trigger to monitor """
+        self._triggers.append(trigger)
+
+    def check(self):
+        """ Check if trigger should fire """
+        if all(self.trigger_states):
+            self.active = True
+            if self._previous_state != self.active:
+                # Trigger is reset, Fire
+                self.trigger()
+            else:
+                # Trigger not reset check if its multi fire
+                if self.frequency == 'many':
+                    self.trigger()
+        else:
+            self.active = False
+        self._previous_state = self.active