simo 2.6.9__py3-none-any.whl → 2.7.1__py3-none-any.whl

simo/automation/controllers.py

@@ -133,6 +133,7 @@ class PresenceLighting(Script):
         self.last_presence = 0
         self.hold_time = 60
         self.conditions = []
+        self.expected_light_values = {}
 
     def _run(self):
         self.hold_time = self.component.config.get('hold_time', 0) * 10
@@ -166,6 +167,16 @@ class PresenceLighting(Script):
                 self.condition_comps[comp.id] = comp
 
         while True:
+            # Resend expected values if they have failed to reach
+            # corresponding light
+            for c_id, [timestamp, expected_val] in self.expected_light_values.items():
+                if time.time() - timestamp < 5:
+                    continue
+                comp = Component.objects.filter(id=c_id).first()
+                if not comp:
+                    continue
+                print(f"Resending [{expected_val}] to {comp}")
+                comp.send(expected_val)
             self._regulate()
             time.sleep(random.randint(5, 15))
 
@@ -182,8 +193,10 @@ class PresenceLighting(Script):
             self._regulate(on_condition_change=True)
 
     def _on_light_change(self, light):
+        # If we were expecting some value change from the light
+        # We have received something. So we stop demanding it!
+        self.expected_light_values.pop(light.id, None)
         # change original value if it has been changed to something different
-        # than this script does.
         if self.is_on and light.value != self.light_send_values[light.id]:
             self.light_send_values[light.id] = light.value
             self.light_org_values[light.id] = light.value
@@ -252,6 +265,8 @@ class PresenceLighting(Script):
                     on_val = bool(on_val)
                 print(f"Send {on_val} to {comp}!")
                 self.light_send_values[comp.id] = on_val
+                if comp.value != on_val:
+                    self.expected_light_values[comp.id] = [time.time(), on_val]
                 comp.controller.send(on_val)
             return
 
@@ -287,6 +302,8 @@ class PresenceLighting(Script):
             else:
                 off_val = self.light_org_values.get(comp.id, 0)
             print(f"Send {off_val} to {comp}!")
+            if comp.value != off_val:
+                self.expected_light_values[comp.id] = [time.time(), off_val]
             comp.send(off_val)
 
 

simo/automation/gateways.py

@@ -17,8 +17,11 @@ from simo.core.middleware import introduce_instance, drop_current_instance
 from simo.core.gateways import BaseObjectCommandsGatewayHandler
 from simo.core.forms import BaseGatewayForm
 from simo.core.utils.logs import StreamToLogger
+from simo.core.utils.converters import input_to_meters
 from simo.core.events import GatewayObjectCommand, get_event_obj
 from simo.core.loggers import get_gw_logger, get_component_logger
+from simo.users.models import InstanceUser
+from .helpers import haversine_distance
 
 
 class ScriptRunHandler(multiprocessing.Process):
@@ -77,7 +80,132 @@ class ScriptRunHandler(multiprocessing.Process):
             return
 
 
-class AutomationsGatewayHandler(BaseObjectCommandsGatewayHandler):
+class GatesHandler:
+    '''
+      Handles automatic gates openning
+    '''
+    # users are considered out of gate geofence, when they
+    # go out at least this amount of meters away from the gate
+    GEOFENCE_CROSS_ZONE = 200
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.gate_iusers = {}
+
+    def _is_out_of_geofence(self, gate, location):
+        '''
+        Returns True if given location is out of geofencing zone
+        '''
+
+        auto_open_distance = gate.config.get('auto_open_distance')
+        if not auto_open_distance:
+            return False
+        auto_open_distance = input_to_meters(auto_open_distance)
+
+        gate_location = gate.config.get('location')
+        try:
+            distance_meters = haversine_distance(
+                gate_location,
+                location, units_of_measure='metric'
+            )
+        except:
+            gate_location = gate.zone.instance.location
+            try:
+                distance_meters = haversine_distance(
+                    gate_location,
+                    location, units_of_measure='metric'
+                )
+            except:
+                print(f"Bad location of {gate}!")
+                return False
+        print(f"Distance from {gate} : {distance_meters}m")
+        return distance_meters > (
+            auto_open_distance + self.GEOFENCE_CROSS_ZONE
+        )
+
+    def _is_in_geofence(self, gate, location):
+        '''
+        Returns True if given location is within geofencing zone
+        '''
+        auto_open_distance = gate.config.get('auto_open_distance')
+        if not auto_open_distance:
+            return False
+        auto_open_distance = input_to_meters(auto_open_distance)
+        gate_location = gate.config.get('location')
+        try:
+            distance_meters = haversine_distance(
+                gate_location,
+                location, units_of_measure='metric'
+            )
+        except:
+            gate_location = gate.zone.instance.location
+            try:
+                distance_meters = haversine_distance(
+                    gate_location,
+                    location, units_of_measure='metric'
+                )
+            except:
+                print(f"Bad location of {gate}!")
+                return False
+
+        print(f"Distance from {gate} : {distance_meters}m")
+        return distance_meters <= auto_open_distance
+
+    def check_gates(self, iuser):
+        if not iuser.last_seen_location:
+            print("User's last seen location is unknown")
+            return
+        for gate_id, geofence_data in self.gate_iusers.items():
+            for iu_id, is_out in geofence_data.items():
+                if iu_id != iuser.id:
+                    continue
+                gate = Component.objects.get(id=gate_id)
+                if is_out:
+                    print(
+                        f"{iuser.user.name} is out, "
+                        f"let's see if we must open the gates for him"
+                    )
+                    # user was fully out, we must check if
+                    # he is now coming back and open the gate for him
+                    if self._is_in_geofence(gate, iuser.last_seen_location):
+                        print("Yes he is back in a geofence! Open THE GATEEE!!")
+                        self.gate_iusers[gate_id][iuser.id] = False
+                        gate.open()
+                    else:
+                        print("No he is not back yet.")
+                else:
+                    print(f"Check if {iuser.user.name} is out.")
+                    self.gate_iusers[gate_id][iuser.id] = self._is_out_of_geofence(
+                        gate, iuser.last_seen_location
+                    )
+                    if self.gate_iusers[gate_id][iuser.id]:
+                        print(f"YES {iuser.user.name} is out!")
+
+    def watch_gates(self):
+        drop_current_instance()
+        for gate in Component.objects.filter(base_type='gate').select_related(
+            'zone', 'zone__instance'
+        ):
+            if not gate.config.get('auto_open_distance'):
+                continue
+            # Track new users as they appear in the system
+            for iuser in InstanceUser.objects.filter(
+                is_active=True, instance=gate.zone.instance
+            ):
+                if gate.config.get('auto_open_for'):
+                    if iuser.role.id not in gate.config['auto_open_for']:
+                        continue
+                if gate.id not in self.gate_iusers:
+                    self.gate_iusers[gate.id] = {}
+                if iuser.id not in self.gate_iusers[gate.id]:
+                    if iuser.last_seen_location:
+                        self.gate_iusers[gate.id][iuser.id] = self._is_out_of_geofence(
+                            gate, iuser.last_seen_location
+                        )
+                    iuser.on_change(self.check_gates)
+
+
+class AutomationsGatewayHandler(GatesHandler, BaseObjectCommandsGatewayHandler):
     name = "Automation"
     config_form = BaseGatewayForm
     info = "Provides various types of automation capabilities"
@@ -85,6 +213,7 @@ class AutomationsGatewayHandler(BaseObjectCommandsGatewayHandler):
     running_scripts = {}
     periodic_tasks = (
         ('watch_scripts', 10),
+        ('watch_gates', 60)
     )
 
     terminating_scripts = set()

simo/core/api_meta.py

@@ -8,7 +8,7 @@ from simo.core.models import Icon, Instance, Category, Zone
 from simo.core.middleware import introduce_instance
 from .serializers import (
     HiddenSerializerField, ComponentManyToManyRelatedField,
-    TextAreaSerializerField, Component
+    TextAreaSerializerField, Component, LocationSerializer
 )
 
 
@@ -41,6 +41,7 @@ class SIMOAPIMetadata(SimpleMetadata):
         ComponentManyToManyRelatedField: 'many related objects',
         HiddenSerializerField: 'hidden',
         TextAreaSerializerField: 'textarea',
+        LocationSerializer: 'location',
     })
 
     def determine_metadata(self, request, view):
@@ -84,7 +85,7 @@ class SIMOAPIMetadata(SimpleMetadata):
             'read_only', 'label', 'help_text',
             'min_length', 'max_length',
             'min_value', 'max_value',
-            'initial'
+            'initial',
         ]
 
         for attr in attrs:
@@ -115,6 +116,9 @@ class SIMOAPIMetadata(SimpleMetadata):
                         zone__instance=self.instance
                     )
 
+        if form_field and hasattr(form_field, 'zoom'):
+            field_info['zoom'] = form_field.zoom
+
         if not field_info.get('read_only') and hasattr(field, 'choices'):# and not hasattr(form_field, 'forward'):
             field_info['choices'] = [
                 {

simo/core/autocomplete_views.py

@@ -3,6 +3,7 @@ from dal.views import BaseQuerySetView
 from django.db.models import Q
 from django.template.loader import render_to_string
 from simo.core.utils.helpers import search_queryset
+from simo.core.middleware import get_current_instance
 from .models import Icon, Category, Zone, Component
 
 
@@ -53,7 +54,7 @@ class IconModelAutocomplete(autocomplete.Select2QuerySetView):
 class CategoryAutocomplete(autocomplete.Select2QuerySetView):
 
     def get_queryset(self):
-        qs = Category.objects.all()
+        qs = Category.objects.filter(instance=get_current_instance(self.request))
 
         if self.forwarded.get("id"):
             return qs.filter(pk=self.forwarded.get("id"))
@@ -79,7 +80,7 @@ class CategoryAutocomplete(autocomplete.Select2QuerySetView):
 class ZoneAutocomplete(autocomplete.Select2QuerySetView):
 
     def get_queryset(self):
-        qs = Zone.objects.all()
+        qs = Zone.objects.filter(instance=get_current_instance(self.request))
 
         if self.forwarded.get("id"):
             return qs.filter(pk=self.forwarded.get("id"))
@@ -104,7 +105,7 @@ class ZoneAutocomplete(autocomplete.Select2QuerySetView):
 class ComponentAutocomplete(autocomplete.Select2QuerySetView):
 
     def get_queryset(self):
-        qs = Component.objects.all()
+        qs = Component.objects.filter(zone__instance=get_current_instance(self.request))
 
         if self.forwarded.get("id"):
             if isinstance(self.forwarded['id'], list):

simo/core/controllers.py

@@ -233,7 +233,12 @@ class ControllerBase(ABC):
         return vals
 
     def send(self, value):
-        self.component.refresh_from_db()
+        from .models import Component
+        try:
+            self.component.refresh_from_db()
+        except Component.DoesNotExist:
+            return
+
 
         # Bulk send if it is a switch or dimmer and has slaves
         if self.component.base_type in ('switch', 'dimmer') \
@@ -241,7 +246,7 @@ class ControllerBase(ABC):
             bulk_send_map = {self.component: value}
             for slave in self.component.slaves.all():
                 bulk_send_map[slave] = value
-            from .models import Component
+
             Component.objects.bulk_send(bulk_send_map)
             return
 
@@ -1027,7 +1032,10 @@ class Gate(ControllerBase, TimerMixin):
     base_type = 'gate'
     app_widget = GateWidget
     admin_widget_template = 'admin/controller_widgets/gate.html'
-    default_config = {}
+    default_config = {
+        'auto_open_distance': '150 m',
+        'auto_open_for': [],
+    }
 
     @property
     def default_value(self):
@@ -1065,4 +1073,5 @@ class Gate(ControllerBase, TimerMixin):
         self.send('close')
 
     def call(self):
-        self.send('call')
+        self.send('call')
+

simo/core/form_fields.py

@@ -1,5 +1,10 @@
 import copy
+import json
+import six
+from django.template.loader import render_to_string
+from django.utils.safestring import mark_safe
 from django import forms
+from django.conf import settings
 from dal import autocomplete
 
 
@@ -91,4 +96,90 @@ class Select2ModelMultipleChoiceField(
 class Select2ListMultipleChoiceField(
     Select2MultipleMixin, forms.MultipleChoiceField
 ):
-    pass
+    pass
+
+
+class LocationWidget(forms.widgets.TextInput):
+    def __init__(self, **kwargs):
+        attrs = kwargs.pop('attrs', None)
+
+        self.options = dict(settings.LOCATION_FIELD)
+        self.options['map.zoom'] = kwargs.get('zoom')
+        self.options['field_options'] = {
+            'based_fields': kwargs.pop('based_fields')
+        }
+
+        super(LocationWidget, self).__init__(attrs)
+
+    def render(self, name, value, attrs=None, renderer=None):
+        if value is not None:
+            try:
+                if isinstance(value, six.string_types):
+                    lat, lng = value.split(',')
+                else:
+                    lng = value.x
+                    lat = value.y
+
+                value = '%s,%s' % (
+                    float(lat),
+                    float(lng),
+                )
+            except ValueError:
+                value = ''
+        else:
+            value = ''
+
+        if '-' not in name:
+            prefix = ''
+        else:
+            prefix = name[:name.rindex('-') + 1]
+
+        self.options['field_options']['prefix'] = prefix
+
+        attrs = attrs or {}
+        attrs['data-location-field-options'] = json.dumps(self.options)
+
+        # Django added renderer parameter in 1.11, made it mandatory in 2.1
+        kwargs = {}
+        if renderer is not None:
+            kwargs['renderer'] = renderer
+        text_input = super(LocationWidget, self).render(name, value, attrs=attrs, **kwargs)
+
+        return render_to_string('location_field/map_widget.html', {
+            'field_name': name,
+            'field_input': mark_safe(text_input)
+        })
+
+    @property
+    def media(self):
+        return forms.Media(**settings.LOCATION_FIELD['resources.media'])
+
+
+
+class PlainLocationField(forms.fields.CharField):
+
+    zoom = 13
+
+    def __init__(self, based_fields=None, zoom=None, suffix='', *args, **kwargs):
+        self.zoom = zoom
+        if not based_fields:
+            based_fields = []
+        if not self.zoom:
+            self.zoom = settings.LOCATION_FIELD['map.zoom']
+        self.widget = LocationWidget(based_fields=based_fields, zoom=self.zoom,
+                                     suffix=suffix, **kwargs)
+
+        dwargs = {
+            'required': True,
+            'label': None,
+            'initial': None,
+            'help_text': None,
+            'error_messages': None,
+            'show_hidden_initial': False,
+        }
+
+        for attr in dwargs:
+            if attr in kwargs:
+                dwargs[attr] = kwargs[attr]
+
+        super(PlainLocationField, self).__init__(*args, **dwargs)

simo/core/forms.py

@@ -79,10 +79,11 @@ class ConfigFieldsMixin:
             if field_name in self.model_fields:
                 continue
             self.config_fields.append(field_name)
-        if self.instance.pk:
-            for field_name in self.config_fields:
-                if field_name not in self.instance.config:
-                    continue
+
+        for field_name in self.config_fields:
+            if field_name not in self.instance.config:
+                continue
+            if self.instance.pk:
                 if hasattr(self.fields[field_name], 'queryset'):
                     if isinstance(self.instance.config.get(field_name), list):
                         self.fields[field_name].initial = \
@@ -97,6 +98,11 @@ class ConfigFieldsMixin:
                 else:
                     self.fields[field_name].initial = \
                         self.instance.config.get(field_name)
+            else:
+                if self.instance.config.get(field_name):
+                    self.fields[field_name].initial = self.instance.config.get(field_name)
+
+
 
     def save(self, commit=True):
         for field_name in self.config_fields:

simo/core/gateways.py

@@ -1,6 +1,7 @@
 import threading
 import time
 import json
+import random
 import paho.mqtt.client as mqtt
 from django.conf import settings
 from django.template.loader import render_to_string
@@ -78,13 +79,22 @@ class BaseObjectCommandsGatewayHandler(BaseGatewayHandler):
         self.mqtt_client.loop_stop()
 
     def _run_periodic_task(self, exit, task, period):
+        first_run = True
         while not exit.is_set():
             try:
                 #print(f"Run periodic task {task}!")
                 getattr(self, task)()
             except Exception as e:
                 self.logger.error(e, exc_info=True)
-            time.sleep(period)
+            # spread tasks around so that they do not happen all
+            # at once all the time
+            if first_run:
+                first_run = False
+                randomized_sleep = random.randint(0, period) + random.random()
+                time.sleep(randomized_sleep)
+            else:
+                time.sleep(period)
+
 
     def _on_mqtt_connect(self, mqtt_client, userdata, flags, rc):
         print("MQTT Connected!")

simo/core/serializers.py

@@ -15,7 +15,8 @@ from actstream.models import Action
 from simo.core.forms import HiddenField, FormsetField
 from simo.core.form_fields import (
     Select2ListChoiceField, Select2ModelChoiceField,
-    Select2ListMultipleChoiceField, Select2ModelMultipleChoiceField
+    Select2ListMultipleChoiceField, Select2ModelMultipleChoiceField,
+    PlainLocationField
 )
 from simo.core.models import Component
 from rest_framework.relations import PrimaryKeyRelatedField, ManyRelatedField
@@ -28,6 +29,10 @@ from .forms import ComponentAdminForm
 from .models import Category, Zone, Icon, ComponentHistory
 
 
+class LocationSerializer(serializers.CharField):
+    pass
+
+
 
 class TimestampField(serializers.Field):
 
@@ -139,6 +144,7 @@ class ComponentFormsetField(FormSerializer):
         form = forms.Form
         field_mapping = {
             HiddenField: HiddenSerializerField,
+            PlainLocationField: LocationSerializer,
             Select2ListChoiceField: serializers.ChoiceField,
             forms.ModelChoiceField: FormsetPrimaryKeyRelatedField,
             Select2ModelChoiceField: FormsetPrimaryKeyRelatedField,
@@ -293,6 +299,7 @@ class ComponentSerializer(FormSerializer):
             forms.TypedChoiceField: serializers.ChoiceField,
             forms.FloatField: serializers.FloatField,
             forms.SlugField: serializers.CharField,
+            PlainLocationField: LocationSerializer,
             forms.ModelChoiceField: ComponentPrimaryKeyRelatedField,
             Select2ModelChoiceField: ComponentPrimaryKeyRelatedField,
             forms.ModelMultipleChoiceField: ComponentManyToManyRelatedField,

simo/core/signal_receivers.py

@@ -81,100 +81,24 @@ def create_instance_defaults(sender, instance, created, **kwargs):
     )
     weather_icon = Icon.objects.get(slug='cloud-bolt-sun')
 
+    from simo.generic.controllers import Weather, MainState
     Component.objects.create(
         name='Weather', icon=weather_icon,
         zone=other_zone,
         category=climate_category,
         gateway=generic, base_type='weather',
-        controller_uid='simo.generic.controllers.Weather',
+        controller_uid=Weather.uid,
         config={'is_main': True}
     )
 
-    state_comp = Component.objects.create(
-        name='State', icon=Icon.objects.get(slug='home'),
+    Component.objects.create(
+        name='Main State', icon=Icon.objects.get(slug='home'),
         zone=other_zone,
         category=other_category,
-        gateway=generic, base_type='state-select',
-        controller_uid='simo.generic.controllers.StateSelect',
+        gateway=generic, base_type=MainState.base_type,
+        controller_uid=MainState.uid,
         value='day',
-        config={"states": [
-            {
-                "icon": "sunrise", "name": "Morning", "slug": "morning",
-                'help_text': "6:00 AM to sunrise. Activates only in dark time of a year."
-            },
-            {
-                "icon": "house-day", "name": "Day", "slug": "day",
-                'help_text': "From sunrise to sunset."
-            },
-            {
-                "icon": "house-night", "name": "Evening", "slug": "evening",
-                'help_text': "From sunrise to midnight"
-            },
-            {
-                "icon": "moon-cloud", "name": "Night", "slug": "night",
-                'help_text': "From midnight to sunrise or 6:00 AM."
-            },
-            {"icon": "snooze", "name": "Sleep time", "slug": "sleep"},
-            {"icon": "house-person-leave", "name": "Away", "slug": "away"},
-            {"icon": "island-tropical", "name": "Vacation", "slug": "vacation"}
-        ], "is_main": True}
-    )
-
-
-    auto_state_code = render_to_string(
-        'automations/auto_state_script.py', {'state_comp_id': state_comp.id}
-    )
-    Component.objects.create(
-        name='Auto state', icon=Icon.objects.get(slug='bolt'),
-        zone=other_zone,
-        category=other_category, show_in_app=False,
-        gateway=automation, base_type='script',
-        controller_uid='simo.automation.controllers.Script',
-        config={
-            "code": auto_state_code, 'autostart': True, 'keep_alive': True,
-            "notes": f"""
-            The script automatically controls the states of the "State" component (ID:{state_comp.id}) — 'morning', 'day', 'evening', 'night'. 
-            
-            """
-        }
-    )
-
-    code = render_to_string(
-        'automations/phones_sleep_script.py', {'state_comp_id': state_comp.id}
-    )
-    Component.objects.create(
-        name='Sleep mode when owner phones are charge',
-        icon=Icon.objects.get(slug='bolt'), zone=other_zone,
-        category=other_category, show_in_app=False,
-        gateway=automation, base_type='script',
-        controller_uid='simo.automation.controllers.Script',
-        config={
-            "code": code, 'autostart': True, 'keep_alive': True,
-            "notes": f"""
-Automatically sets State component (ID: {state_comp.id}) to "Sleep" if it is later than 10pm and all home owners phones who are at home are put on charge.
-Sets State component back to regular state as soon as none of the home owners phones are on charge and it is 6am or later. 
-
-"""
-        }
-    )
-
-    code = render_to_string(
-        'automations/auto_away.py', {'state_comp_id': state_comp.id}
-    )
-    Component.objects.create(
-        name='Auto Away State',
-        icon=Icon.objects.get(slug='bolt'), zone=other_zone,
-        category=other_category, show_in_app=False,
-        gateway=automation, base_type='script',
-        controller_uid='simo.automation.controllers.Script',
-        config={
-            "code": code, 'autostart': True, 'keep_alive': True,
-            "notes": f"""
-    Automatically set mode to "Away" there are no users at home and there was no motion for more than 30 seconds.
-    Set it back to a regular mode as soon as somebody comes back home or motion is detected.
-
-    """
-        }
+        config=MainState.default_config
     )
 
     # Create default User permission roles