simo 2.5.42__py3-none-any.whl → 2.6.3__py3-none-any.whl

simo/generic/forms.py

@@ -1,17 +1,13 @@
-import time
 from django import forms
 from django.forms import formset_factory
 from django.db.models import Q
 from django.utils.translation import gettext_lazy as _
-from django.urls.base import get_script_prefix
-from django.contrib.contenttypes.models import ContentType
 from simo.core.forms import HiddenField, BaseComponentForm
 from simo.core.models import Icon, Component
 from simo.core.controllers import (
-    BEFORE_SET, BinarySensor, NumericSensor, MultiSensor, Switch, Dimmer
+    NumericSensor, MultiSensor, Switch, Dimmer
 )
-from simo.core.widgets import PythonCode, LogOutputWidget
-from dal import autocomplete, forward
+from dal import forward
 from simo.core.utils.config_values import config_to_dict
 from simo.core.utils.formsets import FormsetField
 from simo.core.utils.helpers import get_random_string
@@ -30,280 +26,6 @@ ACTION_METHODS = (
 )
 
 
-class ScriptConfigForm(BaseComponentForm):
-    autostart = forms.BooleanField(
-        initial=True, required=False,
-        help_text="Start automatically on system boot."
-    )
-    keep_alive = forms.BooleanField(
-        initial=True, required=False,
-        help_text="Restart the script if it fails. "
-    )
-    assistant_request = forms.CharField(
-        label="Request for AI assistant", required=False, max_length=1000,
-        widget=forms.Textarea(
-            attrs={'placeholder':
-                    "Close the blind and turn on the main light "
-                    "in my living room when it get's dark."
-            }
-        ),
-        help_text="Clearly describe in your own words what kind of automation "
-                  "you want to happen with this scenario script. <br>"
-                  "The more defined, exact and clear is your description the more "
-                  "accurate automation script SIMO.io AI assistanw will generate.<br>"
-                  "Use component, zone and category id's for best accuracy. <br>"
-                  "SIMO.io AI will re-generate your automation code and update it's description in Notes field "                  
-                  "every time this field is changed and it might take up to 60s to do it. <br>"
-                  "Actual script code can only be edited via SIMO.io Admin.",
-    )
-    code = forms.CharField(widget=PythonCode, required=False)
-    log = forms.CharField(
-        widget=forms.HiddenInput, required=False
-    )
-
-    app_exclude_fields = ('alarm_category', 'code', 'log')
-
-    _ai_resp = None
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.basic_fields.extend(['autostart', 'keep_alive'])
-        if self.instance.pk:
-            prefix = get_script_prefix()
-            if prefix == '/':
-                prefix = ''
-            if 'log' in self.fields:
-                self.fields['log'].widget = LogOutputWidget(
-                    prefix + '/ws/log/%d/%d/' % (
-                        ContentType.objects.get_for_model(Component).id,
-                        self.instance.id
-                    )
-                )
-
-    @classmethod
-    def get_admin_fieldsets(cls, request, obj=None):
-        base_fields = (
-            'id', 'gateway', 'base_type', 'name', 'icon', 'zone', 'category',
-            'show_in_app', 'autostart', 'keep_alive',
-            'assistant_request', 'notes', 'code', 'control', 'log'
-        )
-
-        fieldsets = [
-            (_("Base settings"), {'fields': base_fields}),
-            (_("History"), {
-                'fields': ('history',),
-                'classes': ('collapse',),
-            }),
-        ]
-        return fieldsets
-
-
-    def clean(self):
-        if self.cleaned_data.get('assistant_request'):
-            if self.instance.pk:
-                org = Component.objects.get(pk=self.instance.pk)
-                call_assistant = org.config.get('assistant_request') \
-                                 != self.cleaned_data['assistant_request']
-            else:
-                call_assistant = True
-            call_assistant = False
-            if call_assistant:
-                resp = self.instance.ai_assistant(
-                    self.cleaned_data['assistant_request'],
-                )
-                if resp['status'] == 'success':
-                    self._ai_resp = resp
-                elif resp['status'] == 'error':
-                    self.add_error('assistant_request', resp['result'])
-
-        return self.cleaned_data
-
-    def save(self, commit=True):
-        if commit and self._ai_resp:
-            self.instance.config['code'] = self._ai_resp['result']
-            self.instance.notes = self._ai_resp['description']
-            if 'code' in self.cleaned_data:
-                self.cleaned_data['code'] = self._ai_resp['result']
-            if 'notes' in self.cleaned_data:
-                self.cleaned_data['notes'] = self._ai_resp['description']
-        obj = super().save(commit)
-        if commit:
-            obj.controller.stop()
-            if self.cleaned_data.get('keep_alive') \
-            or self.cleaned_data.get('autostart'):
-                time.sleep(2)
-                obj.controller.start()
-        return obj
-
-
-class ConditionForm(forms.Form):
-    component = Select2ModelChoiceField(
-        queryset=Component.objects.all(),
-        url='autocomplete-component',
-    )
-    op = forms.ChoiceField(
-        initial="==", choices=(
-            ('==', "is equal to"),
-            ('>', "is greather than"), ('>=', "Is greather or equal to"),
-            ('<', "is lower than"), ('<=', "is lower or equal to"),
-            ('in', "is one of")
-        )
-    )
-    value = forms.CharField()
-    prefix = 'breach_events'
-
-    def clean(self):
-        if not self.cleaned_data.get('component'):
-            return self.cleaned_data
-        if not self.cleaned_data.get('op'):
-            return self.cleaned_data
-        component = self.cleaned_data.get('component')
-
-        if self.cleaned_data['op'] == 'in':
-            self.cleaned_data['value'] = self.cleaned_data['value']\
-                .strip('(').strip('[').rstrip(')').rstrip(']').strip()
-            values = self.cleaned_data['value'].split(',')
-        else:
-            values = [self.cleaned_data['value']]
-
-        final_values = []
-        controller_val_type = type(component.controller.default_value)
-        for val in values:
-            val = val.strip()
-            if controller_val_type == 'bool':
-                if val.lower() in ('0', 'false', 'none', 'null'):
-                    final_val = False
-                else:
-                    final_val = True
-            else:
-                try:
-                    final_val = controller_val_type(val)
-                except:
-                    self.add_error(
-                        'value', f"{val} bad value type for selected component."
-                    )
-                    continue
-            try:
-                component.controller._validate_val(final_val, BEFORE_SET)
-            except Exception as e:
-                self.add_error(
-                    'value', f"{val} is not compatible with selected component."
-                )
-                continue
-            final_values.append(final_val)
-
-        if self.cleaned_data['op'] == 'in':
-            self.cleaned_data['value'] = ', '.join(str(v) for v in final_values)
-        elif final_values:
-            self.cleaned_data['value'] = final_values[0]
-
-        return self.cleaned_data
-
-
-class LightTurnOnForm(forms.Form):
-    light = Select2ModelChoiceField(
-        queryset=Component.objects.filter(
-            base_type__in=('switch', 'dimmer', 'rgbw-light', 'rgb-light')
-        ),
-        required=True,
-        url='autocomplete-component',
-        forward=(
-            forward.Const(['switch', 'dimmer', 'rgbw-light', 'rgb-light'],
-                          'base_type'),
-        )
-    )
-    on_value = forms.IntegerField(
-        min_value=0, initial=100,
-        help_text="Value applicable for dimmers. "
-                  "Switches will receive turn on command."
-    )
-    off_value = forms.TypedChoiceField(
-        coerce=int, initial=1, choices=(
-            (0, "0"), (1, "Original value before turning the light on.")
-        )
-    )
-
-
-class PresenceLightingConfigForm(BaseComponentForm):
-    presence_sensors = Select2ModelMultipleChoiceField(
-        queryset=Component.objects.filter(
-            base_type__in=('binary-sensor', 'switch')
-        ),
-        required=True,
-        url='autocomplete-component',
-        forward=(forward.Const(['binary-sensor', 'switch'], 'base_type'),)
-    )
-    act_on = forms.TypedChoiceField(
-        coerce=int, initial=0, choices=(
-            (0, "At least one sensor detects presence"),
-            (1, "All sensors detect presence"),
-        )
-    )
-    hold_time = forms.TypedChoiceField(
-        initial=3, coerce=int, required=False, choices=(
-            (0, '----'),
-            (1, "10 s"), (2, "20 s"), (3, "30 s"), (4, "40 s"), (5, "50 s"),
-            (6, "1 min"), (9, "1.5 min"), (12, "2 min"), (18, "3 min"),
-            (30, "5 min"), (60, "10 min"), (120, "20 min"), (180, "30 min"),
-            (3600, "1 h")
-        ),
-        help_text="Hold off time after last presence detector is deactivated."
-    )
-    conditions = FormsetField(
-        formset_factory(
-            ConditionForm, can_delete=True, can_order=True, extra=0
-        ), label='Additional conditions'
-    )
-
-    lights = FormsetField(
-        formset_factory(
-            LightTurnOnForm, can_delete=True, can_order=True, extra=0
-        ), label='Lights'
-    )
-
-
-    autostart = forms.BooleanField(
-        initial=True, required=False,
-        help_text="Start automatically on system boot."
-    )
-    keep_alive = forms.BooleanField(
-        initial=True, required=False,
-        help_text="Restart the script if it fails. "
-    )
-    log = forms.CharField(
-        widget=forms.HiddenInput, required=False
-    )
-
-    app_exclude_fields = ('alarm_category', 'code', 'log')
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.basic_fields.extend(
-            ['lights', 'on_value', 'off_value', 'presence_sensors',
-             'act_on', 'hold_time', 'conditions', 'autostart', 'keep_alive']
-        )
-        if self.instance.pk and 'log' in self.fields:
-            prefix = get_script_prefix()
-            if prefix == '/':
-                prefix = ''
-            self.fields['log'].widget = LogOutputWidget(
-                prefix + '/ws/log/%d/%d/' % (
-                    ContentType.objects.get_for_model(Component).id,
-                    self.instance.id
-                )
-            )
-
-    def save(self, commit=True):
-        obj = super().save(commit)
-        if commit:
-            obj.controller.stop()
-            if self.cleaned_data.get('keep_alive') \
-                    or self.cleaned_data.get('autostart'):
-                time.sleep(2)
-                obj.controller.start()
-        return obj
-
-
 class ThermostatConfigForm(BaseComponentForm):
     temperature_sensor = Select2ModelChoiceField(
         queryset=Component.objects.filter(

simo/generic/gateways.py

@@ -58,63 +58,6 @@ class CameraWatcher(threading.Thread):
         #     self.run()
 
 
-class ScriptRunHandler(multiprocessing.Process):
-    '''
-      Threading offers better overall stability, but we use
-      multiprocessing for Scripts so that they are better isolated and
-      we are able to kill them whenever we need.
-    '''
-    component = None
-    logger = None
-
-    def __init__(self, component_id, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.component_id = component_id
-
-    def run(self):
-        db_connection.connect()
-        self.component = Component.objects.get(id=self.component_id)
-        try:
-            tz = pytz.timezone(self.component.zone.instance.timezone)
-        except:
-            tz = pytz.timezone('UTC')
-        timezone.activate(tz)
-        introduce_instance(self.component.zone.instance)
-        self.logger = get_component_logger(self.component)
-        sys.stdout = StreamToLogger(self.logger, logging.INFO)
-        sys.stderr = StreamToLogger(self.logger, logging.ERROR)
-        self.component.value = 'running'
-        self.component.save(update_fields=['value'])
-
-        if hasattr(self.component.controller, '_run'):
-            def run_code():
-                self.component.controller._run()
-        else:
-            code = self.component.config.get('code')
-            def run_code():
-                start = time.time()
-                exec(code, globals())
-                if 'class Automation:' in code and time.time() - start < 1:
-                    Automation().run()
-
-            if not code:
-                self.component.value = 'finished'
-                self.component.save(update_fields=['value'])
-                return
-        print("------START-------")
-        try:
-            run_code()
-        except:
-            print("------ERROR------")
-            self.component.value = 'error'
-            self.component.save(update_fields=['value'])
-            raise
-        else:
-            print("------FINISH-----")
-            self.component.value = 'finished'
-            self.component.save(update_fields=['value'])
-            return
-
 
 class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
     name = "Generic"
@@ -124,7 +67,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
     periodic_tasks = (
         ('watch_thermostats', 60),
         ('watch_alarm_clocks', 30),
-        ('watch_scripts', 10),
         ('watch_watering', 60),
         ('watch_alarm_events', 1),
         ('watch_timers', 1)
@@ -153,35 +95,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
             timezone.activate(tz)
             alarm_clock.tick()
 
-    def watch_scripts(self):
-        drop_current_instance()
-        # observe running scripts and drop the ones that are no longer alive
-        dead_scripts = False
-        for id, process in list(self.running_scripts.items()):
-            comp = Component.objects.filter(id=id).first()
-            if process.is_alive():
-                if not comp and id not in self.terminating_scripts:
-                    # script is deleted, or instance deactivated
-                    process.kill()
-                continue
-            else:
-                if id not in self.terminating_scripts:
-                    dead_scripts = True
-                    logger = get_component_logger(comp)
-                    logger.log(logging.INFO, "-------DEAD!-------")
-                    self.stop_script(comp, 'error')
-
-        if dead_scripts:
-            # give 10s air before we wake these dead scripts up!
-            return
-
-        from simo.generic.controllers import Script
-        for script in Component.objects.filter(
-            controller_uid=Script.uid,
-            config__keep_alive=True
-        ).exclude(value__in=('running', 'stopped', 'finished')):
-            self.start_script(script)
-
     def watch_watering(self):
         drop_current_instance()
         from .controllers import Watering
@@ -205,7 +118,7 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
                 target=self._run_periodic_task, args=(exit, task, period), daemon=True
             ).start()
 
-        from simo.generic.controllers import Script, IPCamera
+        from simo.generic.controllers import IPCamera
 
         mqtt_client = mqtt.Client()
         mqtt_client.username_pw_set('root', settings.SECRET_KEY)
@@ -213,25 +126,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
         mqtt_client.on_message = self.on_mqtt_message
         mqtt_client.connect(host=settings.MQTT_HOST, port=settings.MQTT_PORT)
 
-        # We presume that this is the only running gateway, therefore
-        # if there are any running scripts, that is not true.
-        for component in Component.objects.filter(
-            controller_uid=Script.uid, value='running'
-        ):
-            component.value = 'error'
-            component.save()
-
-        # Start scripts that are designed to be autostarted
-        # as well as those that are designed to be kept alive, but
-        # got terminated unexpectedly
-        for script in Component.objects.filter(
-            base_type='script',
-        ).filter(
-            Q(config__autostart=True) |
-            Q(value='error', config__keep_alive=True)
-        ).distinct():
-            self.start_script(script)
-
         for cam in Component.objects.filter(
             controller_uid=IPCamera.uid
         ):
@@ -243,16 +137,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
             mqtt_client.loop()
         mqtt_client.disconnect()
 
-        script_ids = [id for id in self.running_scripts.keys()]
-        for id in script_ids:
-            self.stop_script(
-                Component.objects.get(id=id), 'error'
-            )
-
-        time.sleep(0.5)
-        while len(self.running_scripts.keys()):
-            print("Still running scripts: ", self.running_scripts.keys())
-            time.sleep(0.5)
 
     def on_mqtt_connect(self, mqtt_client, userdata, flags, rc):
         command = GatewayObjectCommand(self.gateway_instance)
@@ -260,9 +144,8 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
 
     def on_mqtt_message(self, client, userdata, msg):
         print("Mqtt message: ", msg.payload)
-        from simo.generic.controllers import (
-            Script, AlarmGroup
-        )
+        from simo.generic.controllers import AlarmGroup
+
         payload = json.loads(msg.payload)
         drop_current_instance()
         component = get_event_obj(payload, Component)
@@ -270,13 +153,7 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
             return
         introduce_instance(component.zone.instance)
         try:
-            if isinstance(component.controller, Script):
-                if payload.get('set_val') == 'start':
-                    self.start_script(component)
-                elif payload.get('set_val') == 'stop':
-                    self.stop_script(component)
-                return
-            elif component.controller_uid == AlarmGroup.uid:
+            if component.controller_uid == AlarmGroup.uid:
                 self.control_alarm_group(component, payload.get('set_val'))
             else:
                 component.controller.set(payload.get('set_val'))
@@ -284,72 +161,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
             print(traceback.format_exc(), file=sys.stderr)
 
 
-    def start_script(self, component):
-        print("START SCRIPT %s" % str(component))
-        if component.id in self.running_scripts:
-            if component.id not in self.terminating_scripts:
-                if component.value != 'running':
-                    component.value = 'running'
-                    component.save()
-                    return
-            else:
-                good_to_go = False
-                for i in range(12): # wait for 3s
-                    time.sleep(0.2)
-                    component.refresh_from_db()
-                    if component.id not in self.running_scripts:
-                        good_to_go = True
-                        break
-                if not good_to_go:
-                    return self.stop_script(component, 'error')
-
-        self.running_scripts[component.id] = ScriptRunHandler(
-            component.id, daemon=True
-        )
-        self.running_scripts[component.id].start()
-
-    def stop_script(self, component, stop_status='stopped'):
-        self.terminating_scripts.add(component.id)
-        if component.id not in self.running_scripts:
-            if component.value == 'running':
-                component.value = stop_status
-                component.save(update_fields=['value'])
-            return
-
-        tz = pytz.timezone(component.zone.instance.timezone)
-        timezone.activate(tz)
-        logger = get_component_logger(component)
-        if stop_status == 'error':
-            logger.log(logging.INFO, "-------GATEWAY STOP-------")
-        else:
-            logger.log(logging.INFO, "-------STOP-------")
-        self.running_scripts[component.id].terminate()
-
-        def kill():
-            start = time.time()
-            terminated = False
-            while start > time.time() - 2:
-                if not self.running_scripts[component.id].is_alive():
-                    terminated = True
-                    break
-                time.sleep(0.1)
-            if not terminated:
-                if stop_status == 'error':
-                    logger.log(logging.INFO, "-------GATEWAY KILL-------")
-                else:
-                    logger.log(logging.INFO, "-------KILL!-------")
-                self.running_scripts[component.id].kill()
-
-            component.value = stop_status
-            component.save(update_fields=['value'])
-            self.terminating_scripts.remove(component.id)
-            # making sure it's fully killed along with it's child processes
-            self.running_scripts[component.id].kill()
-            self.running_scripts.pop(component.id, None)
-            logger.handlers = []
-
-        threading.Thread(target=kill, daemon=True).start()
-
     def control_alarm_group(self, alarm_group, value):
         from simo.generic.controllers import AlarmGroup
 

simo/settings.py

@@ -71,6 +71,7 @@ INSTALLED_APPS = [
     'simo.users',
     'simo.notifications',
     'simo.generic',
+    'simo.automation',
     'simo.multimedia',
     'simo.fleet',
     'simo.backups',

simo/users/api.py

@@ -173,7 +173,7 @@ class UserDeviceReport(InstanceMixin, viewsets.GenericViewSet):
 
     @action(url_path='device-report', detail=False, methods=['post'])
     def report(self, request, *args, **kwargs):
-        from simo.generic.scripting.helpers import haversine_distance
+        from simo.automation.helpers import haversine_distance
         if not request.data.get('device_token'):
             return RESTResponse(
                 {'status': 'error', 'msg': 'device_token - not provided'},
@@ -220,7 +220,6 @@ class UserDeviceReport(InstanceMixin, viewsets.GenericViewSet):
                 at_home=False, location__isnull=False
             ).last()
             if prev_log:
-                from simo.generic.scripting.helpers import haversine_distance
                 meters_traveled = haversine_distance(location, prev_log.location)
                 seconds_passed = (log_datetime - prev_log.datetime).total_seconds()
                 avg_speed_kmh = round(meters_traveled / seconds_passed * 3.6, 0)

{simo-2.5.42.dist-info → simo-2.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: simo
-Version: 2.5.42
+Version: 2.6.3
 Summary: Smart Home on Steroids!
 Author-email: Simanas Venčkauskas <simanas@simo.io>
 Project-URL: Homepage, https://simo.io