simo 2.5.3__py3-none-any.whl → 2.5.5__py3-none-any.whl

simo/core/app_widgets.py

@@ -104,4 +104,22 @@ class LockWidget(BaseAppWidget):
 class AirQualityWidget(BaseAppWidget):
     uid = 'air-quality'
     name = _("Air Quality")
-    size = [2, 2]
+    size = [2, 2]
+
+
+class GateWidget(BaseAppWidget):
+    uid = 'gate'
+    name = _('Gate')
+    size = [2, 1]
+
+
+class BlindsWidget(BaseAppWidget):
+    uid = 'blinds'
+    name = _('Blinds')
+    size = [4, 1]
+
+
+class SlidesWidget(BaseAppWidget):
+    uid = 'slides'
+    name = _('Slides')
+    size = [2, 1]

simo/core/base_types.py

@@ -18,4 +18,6 @@ BASE_TYPES = {
     'switch-quadruple': _("Switch Quadruple"),
     'switch-quintuple': _("Switch Quintuple"),
     'lock': _("Lock"),
+    'gate': _("Gate"),
+    'blinds': _("Blinds"),
 }

simo/core/controllers.py

@@ -777,10 +777,8 @@ class Switch(MultiSwitchBase, TimerMixin, OnOffPokerMixin):
         Gateway specific implementation is very welcome of this!
         '''
         self.turn_on()
-        def toggle_back():
-            time.sleep(0.5)
-            self.turn_off()
-        threading.Thread(target=toggle_back).start()
+        time.sleep(0.5)
+        self.turn_off()
 
 
 class DoubleSwitch(MultiSwitchBase):
@@ -899,3 +897,155 @@ class Lock(Switch):
             self.component.save(
                 update_fields=['change_init_by', 'change_init_date']
             )
+
+
+class Blinds(ControllerBase, TimerMixin):
+    name = _("Blind")
+    base_type = 'blinds'
+    admin_widget_template = 'admin/controller_widgets/blinds.html'
+    default_config = {}
+
+    @property
+    def app_widget(self):
+        if self.component.config.get('control_mode') == 'slide':
+            return SlidesWidget
+        else:
+            return BlindsWidget
+
+    @property
+    def default_value(self):
+        # target and current positions in milliseconds, angle in degrees (0 - 180)
+        return {'target': 0, 'position': 0, 'angle': 0}
+
+    def _validate_val(self, value, occasion=None):
+
+        if occasion == BEFORE_SEND:
+            if isinstance(value, int) or isinstance(value, float):
+                # legacy support
+                value = {'target': int(value)}
+            if 'target' not in value:
+                raise ValidationError("Target value is required!")
+            target = value.get('target')
+            if type(target) not in (float, int):
+                raise ValidationError(
+                    "Bad target position for blinds to go."
+                )
+            if target > self.component.config.get('open_duration') * 1000:
+                raise ValidationError(
+                    "Target value lower than %d expected, "
+                    "%d received instead" % (
+                        self.component.config['open_duration'] * 1000,
+                        target
+                    )
+                )
+            if 'angle' in value:
+                try:
+                    angle = int(value['angle'])
+                except:
+                    raise ValidationError(
+                        "Integer between 0 - 180 is required for blinds angle."
+                    )
+                if angle < 0 or angle > 180:
+                    raise ValidationError(
+                        "Integer between 0 - 180 is required for blinds angle."
+                    )
+            else:
+                value['angle'] = self.component.value.get('angle', 0)
+
+        elif occasion == BEFORE_SET:
+            if not isinstance(value, dict):
+                raise ValidationError("Dictionary is expected")
+            for key, val in value.items():
+                if key not in ('target', 'position', 'angle'):
+                    raise ValidationError(
+                        "'target', 'position' or 'angle' parameters are expected."
+                    )
+                if key == 'position':
+                    if val < 0:
+                        raise ValidationError(
+                            "Positive integer expected for blind position"
+                        )
+                    if val > self.component.config.get('open_duration') * 1000:
+                        raise ValidationError(
+                            "Positive value is to big. Must be lower than %d, "
+                            "but you have provided %d" % (
+                                self.component.config.get('open_duration') * 1000, val
+                            )
+                        )
+
+            self.component.refresh_from_db()
+            if 'target' not in value:
+                value['target'] = self.component.value.get('target')
+            if 'position' not in value:
+                value['position'] = self.component.value.get('position')
+            if 'angle' not in value:
+                value['angle'] = self.component.value.get('angle')
+
+        return value
+
+    def open(self):
+        send_val = {'target': 0}
+        angle = self.component.value.get('angle')
+        if angle is not None and 0 <= angle <= 180:
+            send_val['angle'] = angle
+        self.send(send_val)
+
+    def close(self):
+        send_val = {'target': self.component.config['open_duration'] * 1000}
+        angle = self.component.value.get('angle')
+        if angle is not None and 0 <= angle <= 180:
+            send_val['angle'] = angle
+        self.send(send_val)
+
+    def stop(self):
+        send_val = {'target': -1}
+        angle = self.component.value.get('angle')
+        if angle is not None and 0 <= angle <= 180:
+            send_val['angle'] = angle
+        self.send(send_val)
+
+
+class Gate(ControllerBase, TimerMixin):
+    name = _("Gate")
+    base_type = 'gate'
+    app_widget = GateWidget
+    admin_widget_template = 'admin/controller_widgets/gate.html'
+    default_config = {}
+
+    @property
+    def default_value(self):
+        return 'closed'
+
+    def _validate_val(self, value, occasion=None):
+        if occasion == BEFORE_SEND:
+            if self.component.config.get('action_method') == 'click':
+                if value != 'call':
+                    raise ValidationError(
+                        'Gate component understands only one command: '
+                        '"call". You have provided: "%s"' % (str(value))
+                    )
+            else:
+                if value not in ('call', 'open', 'close'):
+                    raise ValidationError(
+                        'This gate component understands only 3 commands: '
+                        '"open", "close" and "call". You have provided: "%s"' %
+                        (str(value))
+                    )
+        elif occasion == BEFORE_SET and value not in (
+            'closed', 'open', 'open_moving', 'closed_moving'
+        ):
+            raise ValidationError(
+                'Gate component can only be in 4 states:  '
+                '"closed", "closed", "open_moving", "closed_moving". '
+                'You have provided: "%s"' % (str(value))
+            )
+        return value
+
+    def open(self):
+        self.send('open')
+
+    def close(self):
+        self.send('close')
+
+    def call(self):
+        self.send('call')

simo/core/management/_hub_template/hub/supervisor.conf

@@ -27,6 +27,8 @@ stdout_logfile_backups=3
 redirect_stderr=true
 autostart=true
 autorestart=true
+stopasgroup=true
+killasgroup=true
 
 
 [program:simo-gateways]
@@ -41,6 +43,8 @@ stdout_logfile_backups=3
 redirect_stderr=true
 autostart=true
 autorestart=true
+stopasgroup=true
+killasgroup=true
 
 [program:simo-celery-beat]
 directory={{ project_dir }}/hub/

simo/core/middleware.py

@@ -37,11 +37,13 @@ def get_current_instance(request=None):
 
     instance = getattr(_thread_locals, 'instance', None)
 
-    if not instance:
-        from .models import Instance
-        instance = Instance.objects.filter(is_active=True).first()
-        if instance:
-            introduce_instance(instance)
+    # NEVER FORCE THIS! IT's A very BAD IDEA!
+    # For example gateways run on an instance neutral environment!
+    # if not instance:
+    #     from .models import Instance
+    #     instance = Instance.objects.filter(is_active=True).first()
+    #     if instance:
+    #         introduce_instance(instance)
     return instance
 
 
@@ -92,8 +94,13 @@ def instance_middleware(get_response):
 
         if instance:
             introduce_instance(instance, request)
-            tz = pytz.timezone(instance.timezone)
-            timezone.activate(tz)
+            try:
+                # should never, but just in case
+                tz = pytz.timezone(instance.timezone)
+                timezone.activate(tz)
+            except:
+                tz = pytz.timezone('UTC')
+                timezone.activate(tz)
 
         response = get_response(request)
 

simo/core/models.py

@@ -61,7 +61,7 @@ def post_icon_delete(sender, instance, *args, **kwargs):
             pass
 
 
-class Instance(models.Model, SimoAdminMixin):
+class Instance(DirtyFieldsMixin, models.Model, SimoAdminMixin):
     # Multiple home instances can be had on a single hub computer!
     # For example separate hotel apartments
     # or something of that kind.
@@ -101,7 +101,7 @@ class Instance(models.Model, SimoAdminMixin):
         User, null=True, blank=True, on_delete=models.SET_NULL
     )
 
-    objects = InstanceManager()
+    #objects = InstanceManager()
 
 
     def __str__(self):
@@ -118,7 +118,9 @@ class Instance(models.Model, SimoAdminMixin):
 
 
 class Zone(DirtyFieldsMixin, models.Model, SimoAdminMixin):
-    instance = models.ForeignKey(Instance, on_delete=models.CASCADE)
+    instance = models.ForeignKey(
+        Instance, on_delete=models.CASCADE, related_name='zones'
+    )
     name = models.CharField(_('name'), max_length=40)
     order = models.PositiveIntegerField(
         default=0, blank=False, null=False, db_index=True

simo/core/signal_receivers.py

@@ -5,6 +5,7 @@ from django.db.models.signals import post_save, post_delete
 from django.dispatch import receiver
 from django.utils import timezone
 from django.conf import settings
+from django.template.loader import render_to_string
 from actstream import action
 from simo.users.models import PermissionsRole
 from .models import Instance, Gateway, Component, Icon, Zone, Category
@@ -26,10 +27,12 @@ def create_instance_defaults(sender, instance, created, **kwargs):
     # Create default zones
 
     for zone_name in (
-        'Living Room', 'Kitchen', 'Bathroom', 'Porch', 'Garage', 'Yard', 'Other'
+        'Living Room', 'Kitchen', 'Bathroom', 'Porch', 'Garage', 'Yard',
     ):
         Zone.objects.create(instance=instance, name=zone_name)
 
+    other_zone = Zone.objects.create(instance=instance, name='Other')
+
     core_dir_path = os.path.dirname(os.path.realpath(__file__))
     imgs_folder = os.path.join(
         core_dir_path, 'static/defaults/category_headers'
@@ -40,7 +43,8 @@ def create_instance_defaults(sender, instance, created, **kwargs):
         os.makedirs(categories_media_dir)
 
     # Create default categories
-
+    climate_category = None
+    other_category = None
     for i, data in enumerate([
         ("All", 'star'), ("Climate", 'temperature-half'),
         ("Lights", 'lightbulb'), ("Security", 'eye'),
@@ -52,27 +56,28 @@ def create_instance_defaults(sender, instance, created, **kwargs):
                 settings.MEDIA_ROOT, 'categories', "%s.jpg" % data[0].lower()
             )
         )
-        Category.objects.create(
+        cat = Category.objects.create(
             instance=instance,
             name=data[0], icon=Icon.objects.get(slug=data[1]),
             all=i == 0, header_image=os.path.join(
                 'categories', "%s.jpg" % data[0].lower()
             ), order=i + 10
         )
+        if cat.name == 'Climate':
+            climate_category = cat
+        if cat.name == 'Other':
+            other_category = cat
 
     # Create generic gateway and components
 
     generic, new = Gateway.objects.get_or_create(
         type='simo.generic.gateways.GenericGatewayHandler'
     )
-    generic.start()
     dummy, new = Gateway.objects.get_or_create(
         type='simo.generic.gateways.DummyGatewayHandler'
     )
-    dummy.start()
     weather_icon = Icon.objects.get(slug='cloud-bolt-sun')
-    other_zone = Zone.objects.get(name='Other', instance=instance)
-    climate_category = Category.objects.get(name='Climate', instance=instance)
+
     Component.objects.create(
         name='Weather', icon=weather_icon,
         zone=other_zone,
@@ -82,6 +87,63 @@ def create_instance_defaults(sender, instance, created, **kwargs):
         config={'is_main': True}
     )
 
+    state_comp = Component.objects.create(
+        name='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',
+        value='day',
+        config={"states": [
+            {"icon": "house-day", "name": "Day", "slug": "day"},
+            {"icon": "house-night", "name": "Evening", "slug": "evening"},
+            {"icon": "moon-cloud", "name": "Night", "slug": "night"},
+            {"icon": "house-person-leave", "name": "Away", "slug": "away"},
+            {"icon": "island-tropical", "name": "Vacation", "slug": "vacation"}
+        ], "is_main": True}
+    )
+
+
+    auto_state_code = render_to_string(
+        'core/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,
+        gateway=generic, base_type='script',
+        controller_uid='simo.generic.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}) — 'day,' 'evening,' 'night,' 'away.'
+            The 'day' state is activated on weekdays from 10 a.m., and on weekends from 11 a.m. When the sun sets, the 'evening' state is activated, and at midnight, the 'night' state is activated.            
+            If no one is home, the 'away' state is activated.            
+            If a different state, such as 'vacation,' is selected, the script stops running and waits until the State is switched back to one of the controlled states.            
+            If one of the controlled states is manually selected, the script waits until that state is reached automatically and, once aligned with the manually set state, resumes its operation in normal mode.
+            """
+        }
+    )
+
+    code = render_to_string(
+        'core/auto_night_day_script.py', {'state_comp_id': state_comp.id}
+    )
+    Component.objects.create(
+        name='Auto night/day by owner phones on charge',
+        icon=Icon.objects.get(slug='bolt'), zone=other_zone,
+        category=other_category, show_in_app=False,
+        gateway=generic, base_type='script',
+        controller_uid='simo.generic.controllers.Script',
+        config={
+            "code": code, 'autostart': True, 'keep_alive': True,
+            "notes": f"""
+Automatically sets State component (ID: {state_comp.id}) to "night" if it is later than 10pm and all home owners phones who are at home are put on charge.
+Sets State component to "day" state as soon as none of the home owners phones are on charge and it is 6am or later. 
+
+"""
+        }
+    )
+
     # Create default User permission roles
 
     PermissionsRole.objects.create(
@@ -93,6 +155,8 @@ def create_instance_defaults(sender, instance, created, **kwargs):
     PermissionsRole.objects.create(
         instance=instance, name="Guest", is_owner=True
     )
+    generic.start()
+    dummy.start()
 
 
 @receiver(post_save, sender=Zone)

simo/core/tasks.py

@@ -143,7 +143,7 @@ def sync_with_remote():
 
         for user in User.objects.filter(
             Q(roles__instance=instance) | Q(is_master=True)
-        ).exclude(email__in=('system@simo.io', 'device@simo.io')):
+        ).exclude(email__in=('system@simo.io', 'device@simo.io')).distinct():
             is_superuser = False
             user_role = user.get_role(instance)
             if user_role and user_role.is_superuser:

simo/core/templates/core/auto_night_day_script.py

@@ -0,0 +1,62 @@
+import time
+import random
+from django.utils import timezone
+from simo.core.middleware import get_current_instance
+from simo.core.models import Component
+from simo.users.models import InstanceUser
+from simo.generic.scripting.helpers import LocalSun
+
+
+class Automation:
+    STATE_COMPONENT_ID = {{ state_comp_id }}
+
+    def __init__(self):
+        self.instance = get_current_instance()
+        self.state = Component.objects.get(id=self.STATE_COMPONENT_ID)
+        self.sun = LocalSun(self.instance.location)
+        self.night_is_on = False
+
+    def check_owner_phones(self, state, instance_users, datetime):
+        if not self.night_is_on:
+            if not (datetime.hour >= 22 or datetime.hour < 6):
+                return
+
+            for iuser in instance_users:
+                # skipping users that are not at home
+                if not iuser.at_home:
+                    continue
+                if not iuser.phone_on_charge:
+                    # at least one user's phone is not yet on charge
+                    return
+            self.night_is_on = True
+            return 'night'
+        else:
+            # return new_state diena only if there are still users
+            # at home, none of them have their phones on charge
+            # and current state is still night
+            for iuser in instance_users:
+                # skipping users that are not at home
+                if not iuser.at_home:
+                    continue
+                if iuser.phone_on_charge:
+                    # at least one user's phone is still on charge
+                    return
+                else:
+                    self.night_is_on = False
+            if not self.night_is_on and state.value == 'night':
+                return 'day'
+
+    def run(self):
+        while True:
+            instance_users = InstanceUser.objects.filter(
+                is_active=True, role__is_owner=True
+            )
+            self.state.refresh_from_db()
+            new_state = self.check_owner_phones(
+                self.state, instance_users, timezone.localtime()
+            )
+            if new_state:
+                self.state.send(new_state)
+
+            # randomize script load
+            time.sleep(random.randint(20, 40))

simo/core/templates/core/auto_state_script.py

@@ -0,0 +1,78 @@
+import time
+from django.utils import timezone
+from simo.core.middleware import get_current_instance
+from simo.core.models import Component
+from simo.users.models import InstanceUser
+from simo.generic.scripting.helpers import LocalSun
+
+
+class Automation:
+    STATE_COMPONENT_ID = {{ state_comp_id }}
+    last_state = None
+    weekdays_morning_hour = 10
+    weekends_morning_hour = 11
+
+    def __init__(self):
+        self.instance = get_current_instance()
+        self.state = Component.objects.get(id=self.STATE_COMPONENT_ID)
+        self.sun = LocalSun(self.instance.location)
+
+    def check_at_home(self):
+        return bool(InstanceUser.objects.filter(
+            is_active=True, at_home=True
+        ).count())
+
+    def calculate_appropriate_state(self, localtime, at_home):
+        if not at_home:
+            return 'away'
+        if self.sun.is_night(localtime) \
+        and self.sun.get_sunset_time(localtime) < localtime:
+            return 'evening'
+
+        if localtime.weekday() < 5 \
+        and localtime.hour < self.weekdays_morning_hour:
+            return 'night'
+
+        if localtime.weekday() >= 5 \
+        and localtime.hour < self.weekends_morning_hour:
+            return 'night'
+
+        return 'day'
+
+    def get_new_state(self, state, localtime, at_home):
+        # If state component on vacation or in some other state
+        # we do not interfere!
+        if state.value not in ('day', 'night', 'evening', 'away'):
+            return
+        should_be = self.calculate_appropriate_state(
+            localtime, at_home
+        )
+
+        if self.last_state != state.value:
+            # user changed something manually
+            # we must first wait for appropriate state to get in to
+            # manually selected one, only then we will transition to forward.
+            if should_be == state.value:
+                print("Consensus with system users reached!")
+                self.last_state = should_be
+        elif self.last_state != should_be:
+            print("New state: ", should_be)
+            self.last_state = should_be
+            return should_be
+
+    def run(self):
+        # do not interfere on script start, 
+        # only later when we absolutely must
+        self.last_state = self.get_new_state(
+            self.state, timezone.localtime(),
+            self.check_at_home()
+        )
+        while True:
+            self.state.refresh_from_db()
+            new_state_value = self.get_new_state(
+                self.state, timezone.localtime(),
+                self.check_at_home()
+            )
+            if new_state_value:
+                self.state.send(new_state_value)
+            time.sleep(10)