simo 2.0.32__py3-none-any.whl → 2.0.34__py3-none-any.whl

simo/core/models.py

@@ -1,35 +1,25 @@
-import os
-import sys
 import inspect
 import time
 from collections.abc import Iterable
 from django.utils.text import slugify
-from django.core.cache import cache
 from django.utils.functional import cached_property
 from django.urls import reverse_lazy
 from django.utils.translation import gettext_lazy as _
 from django.db import models
-from django.contrib.auth import get_user_model
-from django.conf import settings
 from django.db.models.signals import post_delete
 from django.dispatch import receiver
-from django.utils import timezone
 from timezone_utils.choices import ALL_TIMEZONES_CHOICES
 from location_field.models.plain import PlainLocationField
 from model_utils import FieldTracker
 from dirtyfields import DirtyFieldsMixin
-from easy_thumbnails.fields import ThumbnailerImageField
-from taggit.managers import TaggableManager
 from simo.core.utils.mixins import SimoAdminMixin
 from simo.core.storage import OverwriteStorage
 from simo.core.utils.validators import validate_svg
+from simo.users.models import User
 from .managers import ZonesManager, CategoriesManager, ComponentsManager
 from .events import GatewayObjectCommand, OnChangeMixin
 
 
-User = get_user_model()
-
-
 class Icon(DirtyFieldsMixin, models.Model, SimoAdminMixin):
     slug = models.SlugField(unique=True, db_index=True, primary_key=True)
     keywords = models.CharField(max_length=500, blank=True, null=True)
@@ -93,12 +83,6 @@ class Instance(models.Model, SimoAdminMixin):
         max_length=100, default='metric',
         choices=(('metric', "Metric"), ('imperial', "Imperial"))
     )
-    share_location = models.BooleanField(
-        default=True,
-        help_text="Share exact instance location with SIMO.io remote or not?"
-                  "Sharing it helps better identify if user is at home or not."
-
-    )
     indoor_climate_sensor = models.ForeignKey(
         'Component', null=True, blank=True, on_delete=models.SET_NULL,
         limit_choices_to={'base_type__in': ['numeric-sensor', 'multi-sensor']}
@@ -157,13 +141,11 @@ class Category(DirtyFieldsMixin, models.Model, SimoAdminMixin):
         upload_to='categories', null=True, blank=True,
         help_text="Will be cropped down to: 830x430"
     )
-    header_image_last_change = models.DateTimeField(
-        auto_now_add=True, editable=False
-    )
     all = models.BooleanField(
         default=False,
         help_text=_("All components automatically belongs to this category")
     )
+    last_modified = models.DateTimeField(auto_now=True, editable=False)
     order = models.PositiveIntegerField(
         blank=False, null=False, db_index=True
     )
@@ -298,14 +280,19 @@ class Gateway(DirtyFieldsMixin, models.Model, SimoAdminMixin):
             if not isinstance(result, dict) and isinstance(result, Iterable):
                 for res in result:
                     if isinstance(res, models.Model):
-                        self.discovery['result'].append(res.pk)
+                        if res.pk not in self.discovery['result']:
+                            self.discovery['result'].append(res.pk)
                     else:
-                        self.discovery['result'].append(res)
+                        if res not in self.discovery['result']:
+                            self.discovery['result'].append(res)
             else:
                 if isinstance(result, models.Model):
-                    self.discovery['result'].append(result.pk)
+                    if result.pk not in self.discovery['result']:
+                        self.discovery['result'].append(result.pk)
                 else:
-                    self.discovery['result'].append(result)
+                    if result not in self.discovery['result']:
+                        self.discovery['result'].append(result)
+
 
         self.save(update_fields=['discovery'])
 
@@ -359,11 +346,17 @@ class Component(DirtyFieldsMixin, models.Model, SimoAdminMixin, OnChangeMixin):
         on_delete=models.SET_NULL
     )
     last_change = models.DateTimeField(
-        null=True, editable=False, auto_now_add=True
+        null=True, editable=False, auto_now_add=True,
+        help_text="Last time component state was changed."
+    )
+    last_modified = models.DateTimeField(
+        auto_now_add=True, db_index=True, editable=False,
+        help_text="Last time component was modified."
     )
 
     last_update = models.DateTimeField(auto_now=True)
     alive = models.BooleanField(default=True)
+    error_msg = models.TextField(null=True, blank=True, editable=False)
     battery_level = models.PositiveIntegerField(null=True, editable=False)
 
     show_in_app = models.BooleanField(default=True, db_index=True)
@@ -480,7 +473,7 @@ def is_in_alarm(self):
         else:
             self.arm_status = 'disarmed'
 
-        dirty_fields = self.get_dirty_fields()
+        dirty_fields = self.get_dirty_fields(check_relationship=True)
 
         if self.pk:
             actor = get_current_user()
@@ -503,6 +496,13 @@ def is_in_alarm(self):
                 actor.last_action = timezone.now()
                 actor.save()
 
+            modifying_fields = (
+                'name', 'icon', 'zone', 'category', 'config', 'meta',
+                'value_units', 'slaves', 'show_in_app', 'alarm_category'
+            )
+            if any(f in dirty_fields for f in modifying_fields):
+                self.last_modified = timezone.now()
+
         obj = super().save(*args, **kwargs)
 
         return obj

simo/core/serializers.py

@@ -34,7 +34,7 @@ class TimestampField(serializers.Field):
 
 
 class IconSerializer(serializers.ModelSerializer):
-    last_modified = TimestampField()
+    last_modified = TimestampField(read_only=True)
 
     class Meta:
         model = Icon
@@ -43,13 +43,17 @@ class IconSerializer(serializers.ModelSerializer):
 
 class CategorySerializer(serializers.ModelSerializer):
     header_image_thumb = serializers.SerializerMethodField()
+    last_modified = TimestampField(read_only=True)
 
     class Meta:
         model = Category
         fields = (
-            'id', 'name', 'all', 'icon', 'header_image', 'header_image_thumb'
+            'id', 'name', 'all', 'icon',
+            'header_image', 'header_image_thumb',
+            'last_modified'
         )
 
+
     def get_header_image_thumb(self, obj):
         if obj.header_image:
             thumbnailer = get_thumbnailer(obj.header_image.path)
@@ -60,10 +64,7 @@ class CategorySerializer(serializers.ModelSerializer):
             request = get_current_request()
             if request:
                 url = request.build_absolute_uri(url)
-            return {
-                'url': url,
-                'last_change': obj.header_image_last_change.timestamp()
-            }
+            return url
         return
 
 
@@ -232,6 +233,7 @@ class ComponentManyToManyRelatedField(serializers.Field):
 class ComponentSerializer(FormSerializer):
     id = ObjectSerializerMethodField()
     last_change = TimestampField(read_only=True)
+    last_modified = TimestampField(read_only=True)
     read_only = serializers.SerializerMethodField()
     app_widget = serializers.SerializerMethodField()
     slaves = serializers.SerializerMethodField()
@@ -239,9 +241,11 @@ class ComponentSerializer(FormSerializer):
     show_in_app = ObjectSerializerMethodField()
     controller_uid = ObjectSerializerMethodField()
     alive = ObjectSerializerMethodField()
+    error_msg = ObjectSerializerMethodField()
     value = ObjectSerializerMethodField()
     config = ObjectSerializerMethodField()
     meta = ObjectSerializerMethodField()
+    alarm_category = ObjectSerializerMethodField()
     arm_status = ObjectSerializerMethodField()
     battery_level = ObjectSerializerMethodField()
     controller_methods = serializers.SerializerMethodField()
@@ -435,9 +439,8 @@ class ComponentSerializer(FormSerializer):
         if form.is_valid():
             if form.controller.is_discoverable:
                 form.controller.init_discovery(form.cleaned_data)
-                return {'discovery': 'started'}
-            instance = form.save(commit=True)
-            return instance
+                return form.save(commit=False)
+            return form.save(commit=True)
         raise serializers.ValidationError(form.errors)
 
     def get_controller_methods(self, obj):

simo/core/signal_receivers.py

@@ -1,8 +1,89 @@
+import os
+import shutil
 from django.db import transaction
 from django.db.models.signals import post_save, post_delete
 from django.dispatch import receiver
 from django.utils import timezone
-from .models import Instance, Gateway, Component
+from django.conf import settings
+from simo.users.models import PermissionsRole
+from .models import Instance, Gateway, Component, Icon, Zone, Category
+
+
+@receiver(post_save, sender=Instance)
+def create_instance_defaults(sender, instance, created, **kwargs):
+    if not created:
+        return
+
+    # Create default zones
+
+    for zone_name in (
+        'Living Room', 'Kitchen', 'Bathroom', 'Porch', 'Garage', 'Yard', 'Other'
+    ):
+        Zone.objects.create(instance=instance, name=zone_name)
+
+    core_dir_path = os.path.dirname(os.path.realpath(__file__))
+    imgs_folder = os.path.join(
+        core_dir_path, 'static/defaults/category_headers'
+    )
+
+    categories_media_dir = os.path.join(settings.MEDIA_ROOT, 'categories')
+    if not os.path.exists(categories_media_dir):
+        os.makedirs(categories_media_dir)
+
+    # Create default categories
+
+    for i, data in enumerate([
+        ("All", 'star'), ("Climate", 'temperature-half'),
+        ("Lights", 'lightbulb'), ("Security", 'eye'),
+        ("Watering", 'faucet'), ("Other", 'flag-pennant')
+    ]):
+        shutil.copy(
+            os.path.join(imgs_folder, "%s.jpg" % data[0].lower()),
+            os.path.join(
+                settings.MEDIA_ROOT, 'categories', "%s.jpg" % data[0].lower()
+            )
+        )
+        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
+        )
+
+    # 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')
+    climate_category = Category.objects.get(name='Climate')
+    Component.objects.create(
+        name='Weather', icon=weather_icon,
+        zone=other_zone,
+        category=climate_category,
+        gateway=generic, base_type='weather-forecast',
+        controller_uid='simo.generic.controllers.WeatherForecast',
+        config={'is_main': True}
+    )
+
+    # Create default User permission roles
+
+    PermissionsRole.objects.create(
+        instance=instance, name="Admin", is_superuser=True
+    )
+    PermissionsRole.objects.create(
+        instance=instance, name="Owner", is_owner=True, is_default=True
+    )
+    PermissionsRole.objects.create(
+        instance=instance, name="Guest", is_owner=True
+    )
 
 
 @receiver(post_save, sender=Component)

simo/core/tasks.py

@@ -143,8 +143,7 @@ def sync_with_remote():
         ).order_by('-date').first()
         if last_event:
             instance_data['last_event'] = last_event.date.timestamp()
-        if instance.share_location:
-            instance_data['location'] = instance.location
+
         if instance.cover_image and not instance.cover_image_synced:
             thumbnailer = get_thumbnailer(instance.cover_image.path)
             cover_imb_path = thumbnailer.get_thumbnail(
@@ -163,13 +162,17 @@ def sync_with_remote():
         print("Faled! Response code: ", response.status_code)
         return
 
-    print("Responded with: ", json.dumps(response.json()))
+    r_json = response.json()
+
+    print("Responded with: ", json.dumps(r_json))
+
+    if 'hub_uid' in r_json:
+        dynamic_settings['core__hub_uid'] = r_json['hub_uid']
 
     for instance in instances:
         instance.cover_image_synced = True
         instance.save()
 
-    r_json = response.json()
     dynamic_settings['core__remote_http'] = r_json.get('hub_remote_http')
     if 'new_secret' in r_json:
         dynamic_settings['core__hub_secret'] = r_json['new_secret']

simo/fleet/admin.py

@@ -168,10 +168,29 @@ class ColonelAdmin(admin.ModelAdmin):
         return mark_safe('<img src="%s" alt="False">' % static('admin/img/icon-no.svg'))
 
 
+@admin.register(Interface)
+class InterfaceAdmin(admin.ModelAdmin):
+    list_filter = 'colonel', 'type'
+    actions = 'broadcast_reset'
+
+    def broadcast_reset(self, request, queryset):
+        broadcasted = 0
+        for interface in queryset.filter(
+            colonel__socket_connected=True
+        ):
+            interface.broadcast_reset()
+            broadcasted += 1
+
+        if broadcasted:
+            self.message_user(
+                request,
+                f"Reset command was broadcased to {broadcasted} interfaces."
+            )
+        else:
+            self.message_user(
+                request,
+                f"No reset command was broadcasted, "
+                f"probably because they are out of reach at the moment."
+            )
 
-
-# @admin.register(BLEDevice)
-# class BLEDeviceAdmin(admin.ModelAdmin):
-#     list_display = ['name', 'mac', 'type', 'last_seen']
-#     readonly_fields = list_display + ['addr']
-#     fields = readonly_fields
+    broadcast_reset.short_description = "Broadcast RESET command"

simo/fleet/controllers.py

@@ -1,3 +1,4 @@
+import json
 from django.utils.translation import gettext_lazy as _
 from simo.core.events import GatewayObjectCommand
 from simo.core.controllers import (
@@ -24,7 +25,8 @@ from .forms import (
     ColonelDHTSensorConfigForm, DS18B20SensorConfigForm,
     BME680SensorConfigForm, MPC9808SensorConfigForm,
     DualMotorValveForm, BlindsConfigForm, BurglarSmokeDetectorConfigForm,
-    TTLockConfigForm, DALIDeviceConfigForm, DaliSwitchForm
+    TTLockConfigForm, DALIDeviceConfigForm, DaliLampForm, DaliGearGroupForm,
+    DaliOccupancySensorConfigForm, DALILightSensorConfigForm
 )
 
 
@@ -182,14 +184,6 @@ class BasicOutputMixin:
             pins.append(control_unit['pin_no'])
         return pins
 
-    def _send_to_device(self, value):
-        GatewayObjectCommand(
-            self.component.gateway,
-            Colonel(id=self.component.config['colonel']),
-            set_val=value,
-            component_id=self.component.id,
-        ).publish()
-
 
 class Switch(FleeDeviceMixin, BasicOutputMixin, BaseSwitch):
     config_form = ColonelSwitchConfigForm
@@ -240,7 +234,6 @@ class PWMOutput(FleeDeviceMixin, BasicOutputMixin, BaseDimmer):
             else:
                 pwm_value = 0
         else:
-
             val_amplitude = conf.get('max', 100) - conf.get('min', 0)
             val_relative = value / val_amplitude
             pwm_amplitude = conf.get('duty_max', 1023) - conf.get('duty_min', 0.0)
@@ -306,14 +299,6 @@ class TTLock(FleeDeviceMixin, Lock):
     name = 'TTLock'
     discovery_msg = _("Please activate your TTLock so it can be discovered.")
 
-    def _send_to_device(self, value):
-        GatewayObjectCommand(
-            self.component.gateway,
-            Colonel(id=self.component.config['colonel']),
-            set_val=value,
-            component_id=self.component.id,
-        ).publish()
-
     @classmethod
     def init_discovery(self, form_cleaned_data):
         from simo.core.models import Gateway
@@ -508,7 +493,7 @@ class DALIDevice(FleeDeviceMixin, ControllerBase):
     app_widget = SingleSwitchWidget
 
     def _validate_val(self, value, occasion=None):
-        pass
+        return value
 
     @classmethod
     def init_discovery(self, form_cleaned_data):
@@ -529,63 +514,139 @@ class DALIDevice(FleeDeviceMixin, ControllerBase):
         if data['discovery-result'] == 'fail':
             if data['result'] == 1:
                 return {'error': 'DALI interface is unavailable!'}
+            elif data['result'] == 2:
+                return {'error': 'No new DALI devices were found!'}
+            elif data['result'] == 2:
+                return {'error': 'DALI line is fully occupied, no more devices can be included!'}
             else:
                 return {'error': 'Unknown error!'}
 
-        controller_cls = globals().get(data['result']['type'])
+        from simo.core.models import Component
+        from simo.core.utils.type_constants import CONTROLLER_TYPES_MAP
+        controller_uid = 'simo.fleet.controllers.' + data['result']['type']
+        if controller_uid not in CONTROLLER_TYPES_MAP:
+            return {'error': f"Unknown controller type: {controller_uid}"}
+
+        comp = Component.objects.filter(
+            controller_uid=controller_uid,
+            meta__finalization_data__temp_id=data['result']['id']
+        ).first()
+        if comp:
+            print(f"{comp} is already created.")
+            GatewayObjectCommand(
+                comp.gateway, Colonel(
+                    id=comp.config['colonel']
+                ), command='finalize',
+                data=comp.meta['finalization_data']
+            ).publish()
+            return [comp]
+
+        controller_cls = CONTROLLER_TYPES_MAP[controller_uid]
 
         started_with = deserialize_form_data(started_with)
         started_with['name'] += f" {data['result']['config']['da']}"
+        started_with['controller_uid'] = controller_uid
+        started_with['base_type'] = controller_cls.base_type
         form = controller_cls.config_form(
             controller_uid=controller_cls.uid, data=started_with
         )
 
         if form.is_valid():
             new_component = form.save()
+            new_component = Component.objects.get(id=new_component.id)
             new_component.config.update(data.get('result', {}).get('config'))
+
+            # saving it to meta, for repeated delivery
             new_component.meta['finalization_data'] = {
                 'temp_id': data['result']['id'],
                 'permanent_id': new_component.id,
-                'config': {
-                    'type': cls.uid.split('.')[-1],
-                    'config': new_component.config,
-                },
+                'comp_config': {
+                    'type': controller_uid.split('.')[-1],
+                    'family': new_component.controller.family,
+                    'config': json.loads(json.dumps(new_component.config))
+                }
             }
+            # Perform default config update on initial component setup
+            new_component.meta[
+                'finalization_data'
+            ]['comp_config']['config']['boot_update'] = True
             new_component.save()
             GatewayObjectCommand(
                 new_component.gateway, Colonel(
                     id=new_component.config['colonel']
                 ), command='finalize',
-                data=new_component.meta['finalization_data'],
+                data=new_component.meta['finalization_data']
             ).publish()
             return [new_component]
 
         # Literally impossible, but just in case...
         return {'error': 'INVALID INITIAL DISCOVERY FORM!'}
 
-
-class DALIGear(DALIDevice):
-    manual_add = False
-
-    def _send_to_device(self, value):
+    def replace(self):
+        """
+        Hook up brand new replacement device to the dali line
+        and execute this command on existing (dead) component instance,
+        so that it can be replaced by the new physical device.
+        """
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
-            set_val=value,
-            component_id=self.component.id,
+            id=self.component.id, command='call', method='replace'
         ).publish()
 
 
-class DALILamp(DALIGear, BaseSwitch):
+class DALILamp(BaseDimmer, DALIDevice):
     family = 'dali'
     manual_add = False
     name = 'DALI Lamp'
-    config_form = DaliSwitchForm
+    config_form = DaliLampForm
+
+
+class DALIGearGroup(FleeDeviceMixin, BaseDimmer):
+    gateway_class = FleetGatewayHandler
+    family = 'dali'
+    manual_add = True
+    name = 'DALI Gear Group'
+    config_form = DaliGearGroupForm
+
+    def _modify_member_group(self, member, group, remove=False):
+        groups = set(member.config.get('groups', []))
+        if remove:
+            if group in groups:
+                groups.remove(group)
+        else:
+            if group not in groups:
+                groups.add(group)
+        member.config['groups'] = list(groups)
+        member.save()
+        colonel = Colonel.objects.filter(
+            id=member.config.get('colonel', 0)
+        ).first()
+        if not colonel:
+            return
+        GatewayObjectCommand(
+            member.gateway, colonel, id=member.id,
+            command='call', method='update_config',
+            args=[member.controller._get_colonel_config()]
+        ).publish()
+
+
+class DALIRelay(BaseSwitch, DALIDevice):
+    family = 'dali'
+    manual_add = False
+    name = 'DALI Relay'
 
 
-class DALIDimmableLamp(DALIGear, BaseDimmer):
+class DALIOccupancySensor(BaseBinarySensor, DALIDevice):
     family = 'dali'
     manual_add = False
-    name = 'DALI Dimmable Lamp'
+    name = 'DALI Occupancy Sensor'
+    config_form = DaliOccupancySensorConfigForm
 
 
+class DALILightSensor(BaseNumericSensor, DALIDevice):
+    family = 'dali'
+    manual_add = False
+    name = 'DALI Light Sensor'
+    default_value_units = 'lux'
+    config_form = DALILightSensorConfigForm