simo 2.4.2__py3-none-any.whl → 2.5.1__py3-none-any.whl

simo/backups/tasks.py

@@ -1,5 +1,6 @@
 import os, subprocess, json, uuid, datetime, shutil, pytz
-from datetime import datetime, timezone
+from datetime import datetime, timedelta
+from django.utils import timezone
 from celeryc import celery_app
 from simo.conf import dynamic_settings
 from simo.core.utils.helpers import get_random_string
@@ -407,8 +408,17 @@ def restore_backup(backup_id):
         subprocess.run('reboot', shell=True)
 
 
+@celery_app.task
+def clean_old_logs():
+    from .models import BackupLog
+    BackupLog.objects.filter(
+        datetime__lt=timezone.now() - timedelta(days=90)
+    )
+
+
 @celery_app.on_after_finalize.connect
 def setup_periodic_tasks(sender, **kwargs):
     sender.add_periodic_task(60 * 60, check_backups.s())
     # perform auto backup every 12 hours
     sender.add_periodic_task(60 * 60 * 12, perform_backup.s())
+    sender.add_periodic_task(60 * 60, clean_old_logs.s())

simo/core/admin.py

@@ -232,11 +232,11 @@ class ComponentPermissionInline(admin.TabularInline):
         return qs.filter(role__instance__in=request.user.instances)
 
 
-    # def has_delete_permission(self, request, obj=None):
-    #     return False
+    def has_delete_permission(self, request, obj=None):
+        return False
 
-    # def has_add_permission(self, request, obj=None):
-    #     return False
+    def has_add_permission(self, request, obj=None):
+        return False
 
 
 @admin.register(Component)

simo/core/api.py

@@ -167,6 +167,12 @@ def get_components_queryset(instance, user):
     ).values('id').first()
     if main_alarm_group:
         c_ids.add(main_alarm_group['id'])
+    state = Component.objects.filter(
+        zone__instance=instance,
+        base_type='state-select', config__is_main=True
+    ).values('id').first()
+    if state:
+        c_ids.add(state['id'])
 
     user_role = user.get_role(instance)
 
@@ -369,7 +375,7 @@ class ComponentHistoryViewSet(InstanceMixin, viewsets.ReadOnlyModelViewSet):
         if not component.controller:
             return
 
-        history_display_example = component.controller.history_display([component.value])
+        history_display_example = component.controller._history_display([component.value])
         if not history_display_example:
             return None
 
@@ -393,9 +399,9 @@ class ComponentHistoryViewSet(InstanceMixin, viewsets.ReadOnlyModelViewSet):
                     values = []
                     for item in history_items:
                         values.append(item.value)
-                    val = component.controller.history_display(values)
+                    val = component.controller._history_display(values)
             else:
-                val = component.controller.history_display([])
+                val = component.controller._history_display([])
 
             if not val:
                 val = prev_val
@@ -425,7 +431,7 @@ class ComponentHistoryViewSet(InstanceMixin, viewsets.ReadOnlyModelViewSet):
             component=component, date__lt=start_from, type='value'
         ).order_by('date').last()
         if last_event:
-            prev_val = component.controller.history_display([last_event.value])
+            prev_val = component.controller._history_display([last_event.value])
         else:
             prev_val = history_display_example
 
@@ -544,6 +550,15 @@ class SettingsViewSet(InstanceMixin, viewsets.GenericViewSet):
         if main_alarm_group:
             main_alarm_group_id = main_alarm_group.id
 
+        main_state = Component.objects.filter(
+            zone__instance=self.instance,
+            base_type='state-select', config__is_main=True
+        ).first()
+        if main_state:
+            main_state = main_state.id
+        else:
+            main_state = None
+
         return RESTResponse({
             'hub_uid': dynamic_settings['core__hub_uid'],
             'instance_name': self.instance.name,
@@ -553,6 +568,7 @@ class SettingsViewSet(InstanceMixin, viewsets.GenericViewSet):
             'last_event': last_event,
             'weather_forecast': wf_comp_id,
             'main_alarm_group': main_alarm_group_id,
+            'main_state': main_state,
             # TODO: Remove these two when the app is updated for everybody.
             'remote_http': dynamic_settings['core__remote_http'],
             'local_http': 'https://%s' % get_self_ip(),

simo/core/app_widgets.py

@@ -100,3 +100,8 @@ class LockWidget(BaseAppWidget):
     name = _("Lock")
     size = [2, 2]
 
+
+class AirQualityWidget(BaseAppWidget):
+    uid = 'air-quality'
+    name = _("Air Quality")
+    size = [2, 2]

simo/core/controllers.py

@@ -302,7 +302,7 @@ class ControllerBase(ABC):
             from .models import Component
             Component.objects.bulk_send(bulk_send_map)
 
-    def history_display(self, values):
+    def _history_display(self, values):
         assert type(values) in (list, tuple)
 
         if type(self.component.value) in (int, float):
@@ -445,7 +445,7 @@ class MultiSensor(ControllerBase):
                 ))
         return value
 
-    def history_display(self, values):
+    def _history_display(self, values):
         assert type(values) in (list, tuple)
 
         vectors = []

simo/core/events.py

@@ -92,7 +92,9 @@ def get_event_obj(payload, model_class=None, gateway=None):
 
 class OnChangeMixin:
 
+    _on_change_function = None
     on_change_fields = ('value', )
+    _mqtt_client = None
 
     def get_instance(self):
         # default for component

simo/core/forms.py

@@ -212,6 +212,8 @@ class ComponentAdminForm(forms.ModelForm):
     controller_type = None
     has_icon = True
     has_alarm = True
+    # do not allow modification via app of these fields
+    app_exclude_fields = []
 
     # fields that can be edited via SIMO.io app by instance owners.
     # Users who have is_owner enabled on their user role.

simo/core/management/commands/gateways_manager.py

@@ -17,9 +17,6 @@ from simo.core.models import Gateway
 from simo.core.loggers import get_gw_logger
 
 
-
-
-
 class GatewayRunHandler(multiprocessing.Process):
     gateway = None
     logger = None

simo/core/middleware.py

@@ -30,12 +30,18 @@ def get_current_instance(request=None):
     if not instance and request and request.session.get('instance_id'):
         from simo.core.models import Instance
         instance = Instance.objects.filter(
-            id=request.session['instance_id']
+            id=request.session['instance_id'], is_active=True
         ).first()
         if not instance:
             del request.session['instance_id']
         else:
             introduce_instance(instance, request)
+
+    if not instance:
+        from .models import Instance
+        instance = Instance.objects.filter(is_active=True).first()
+        if instance:
+            introduce_instance(instance)
     return instance
 
 

simo/core/models.py

@@ -406,8 +406,8 @@ def is_in_alarm(self):
 
     _controller_initiated = False
 
-    _mqtt_client = None
-    _on_change_function = None
+
+
     _obj_ct_id = 0
 
     class Meta:
@@ -517,11 +517,13 @@ def is_in_alarm(self):
                 actor.last_action = timezone.now()
                 actor.save()
 
-            if any(
-                f in dirty_fields for f in
-                ['value', 'arm_status', 'battery_level', 'alive', 'meta']
-            ):
+            changing_fields = ['value', 'arm_status', 'battery_level', 'alive', 'meta']
+            if any(f in dirty_fields for f in changing_fields):
                 self.last_change = timezone.now()
+                if 'update_fields' in kwargs \
+                and 'last_change' not in kwargs['update_fields']:
+                    kwargs['update_fields'].append('last_change')
+
 
             modifying_fields = (
                 'name', 'icon', 'zone', 'category', 'config', 'meta',
@@ -529,6 +531,9 @@ def is_in_alarm(self):
             )
             if any(f in dirty_fields for f in modifying_fields):
                 self.last_modified = timezone.now()
+                if 'update_fields' in kwargs \
+                and 'last_modified' not in kwargs['update_fields']:
+                    kwargs['update_fields'].append('last_modified')
 
         obj = super().save(*args, **kwargs)
 
@@ -581,6 +586,21 @@ def is_in_alarm(self):
             return False
         return perm.write
 
+    def get_controller_methods(self):
+        c_methods = []
+        for m in inspect.getmembers(
+            self.controller, predicate=inspect.ismethod
+        ):
+            method = m[0]
+            if method.startswith('_'):
+                continue
+            if method in ('info', 'set'):
+                continue
+            c_methods.append(method)
+        if self.alarm_category:
+            c_methods.extend(['arm', 'disarm'])
+        return c_methods
+
 
 class ComponentHistory(models.Model):
     component = models.ForeignKey(

simo/core/serializers.py

@@ -27,6 +27,8 @@ from .forms import ComponentAdminForm
 from .models import Category, Zone, Icon, ComponentHistory
 
 
+
+
 class TimestampField(serializers.Field):
 
     def to_representation(self, value):
@@ -318,7 +320,7 @@ class ComponentSerializer(FormSerializer):
             form_field = form[field_name]
 
             cls = form_field.field.__class__
-            if field_name == 'notes':
+            if isinstance(form_field.field.widget, forms.Textarea):
                 serializer_field_class = TextAreaSerializerField
             else:
                 try:
@@ -416,16 +418,19 @@ class ComponentSerializer(FormSerializer):
             controller_uid=controller_uid, instance=instance,
             **kwargs
         )
-        # only masters and superusers can fully manage components via app
-        # others can only change basic fields
-        if not self.context['request'].user.is_master:
-            user_role = self.context['request'].user.get_role(
-                self.context['instance']
-            )
-            if not user_role.is_superuser:
-                for field_name in list(form.fields.keys()):
-                    if field_name not in form.basic_fields:
-                        del form.fields[field_name]
+
+        user_role = self.context['request'].user.get_role(
+            self.context['instance']
+        )
+        for field_name in list(form.fields.keys()):
+            if field_name in form.app_exclude_fields:
+                del form.fields[field_name]
+                continue
+            if field_name in form.basic_fields:
+                continue
+            if self.context['request'].user.is_master or user_role.is_superuser:
+                continue
+            del form.fields[field_name]
 
         if form_key is not None:
             self.context['forms'][form_key] = form
@@ -492,12 +497,7 @@ class ComponentSerializer(FormSerializer):
         raise serializers.ValidationError(form.errors)
 
     def get_controller_methods(self, obj):
-        c_methods = [m[0] for m in inspect.getmembers(
-            obj.controller, predicate=inspect.ismethod
-        ) if not m[0].startswith('_')]
-        if obj.alarm_category:
-            c_methods.extend(['arm', 'disarm'])
-        return c_methods
+        return obj.get_controller_methods()
 
     def get_info(self, obj):
         if obj.controller:

simo/core/tasks.py

@@ -211,7 +211,11 @@ def sync_with_remote():
                 ).first()
                 if weather_component:
                     weather_component.track_history = False
-                    weather_component.controller.set(weather_forecast)
+                    weather_component.controller.set(
+                        weather_forecast.pop('current', None)
+                    )
+                    weather_component.meta['forecast'] = weather_forecast
+                    weather_component.save()
 
             for email, options in users_data.items():
 
@@ -380,15 +384,14 @@ def low_battery_notifications():
             zone__instance=instance,
             battery_level__isnull=False, battery_level__lt=20
         ):
-            users = User.objects.filter(
-                roles__is_owner=True, roles__instance=comp.zone.instance,
-                instance_roles__is_active=True
-            ).distinct()
-            if users:
+            iusers = comp.zone.instance.instance_users.filter(
+                is_active=True, role__is_owner=True
+            )
+            if iusers:
                 notify_users(
                     comp.zone.instance, 'warning',
                     f"Low battery ({comp.battery_level}%) on {comp}",
-                    component=comp, users=users
+                    component=comp, instance_users=iusers
                 )
 
 

simo/fleet/controllers.py

@@ -10,8 +10,7 @@ from simo.core.controllers import (
     Switch as BaseSwitch, Dimmer as BaseDimmer,
     MultiSensor as BaseMultiSensor, RGBWLight as BaseRGBWLight
 )
-from simo.conf import dynamic_settings
-from simo.core.app_widgets import NumericSensorWidget
+from simo.core.app_widgets import NumericSensorWidget, AirQualityWidget
 from simo.core.controllers import Lock, ControllerBase, SingleSwitchWidget
 from simo.core.utils.helpers import heat_index
 from simo.core.utils.serialization import (
@@ -23,7 +22,7 @@ from .gateways import FleetGatewayHandler
 from .forms import (
     ColonelPinChoiceField,
     ColonelBinarySensorConfigForm, ColonelButtonConfigForm,
-    ColonelSwitchConfigForm, ColonelPWMOutputConfigForm,
+    ColonelSwitchConfigForm, ColonelPWMOutputConfigForm, DCDriverConfigForm,
     ColonelNumericSensorConfigForm, ColonelRGBLightConfigForm,
     ColonelDHTSensorConfigForm, DS18B20SensorConfigForm,
     BME680SensorConfigForm, MPC9808SensorConfigForm, ENS160SensorConfigForm,
@@ -239,6 +238,7 @@ class ENS160AirQualitySensor(FleeDeviceMixin, BaseMultiSensor):
     gateway_class = FleetGatewayHandler
     config_form = ENS160SensorConfigForm
     name = "ENS160 Air Quality Sensor (I2C)"
+    app_widget = AirQualityWidget
 
     default_value = [
         ["CO2", 0, "ppm"],
@@ -386,42 +386,87 @@ class PWMOutput(FadeMixin, FleeDeviceMixin, BasicOutputMixin, BaseDimmer):
             value = conf.get('min', 0)
 
         if value >= conf.get('max', 100):
-            if conf.get('inverse'):
-                pwm_value = 0
-            else:
-                pwm_value = 1023
+            pwm_value = 0
         elif value <= conf.get('min', 100):
-            if conf.get('inverse'):
-                pwm_value = 1023
-            else:
-                pwm_value = 0
+            pwm_value = 1023
         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)
-            pwm_value = conf.get('duty_min', 0.0) + pwm_amplitude * val_relative
 
-            if conf.get('inverse'):
-                pwm_value = conf.get('duty_max', 1023) - pwm_value + conf.get('duty_min')
+            duty_max = 1023 - (conf.get('device_min', 0) * 0.01 * 1023)
+            duty_min = 1023 - conf.get('device_max', 100) * 0.01 * 1023
+
+            pwm_amplitude = duty_max - duty_min
+            pwm_value = duty_min + pwm_amplitude * val_relative
+
+            pwm_value = duty_max - pwm_value + duty_min
 
         return pwm_value
 
     def _prepare_for_set(self, pwm_value):
         conf = self.component.config
-        if pwm_value > conf.get('duty_max', 1023):
+        duty_max = 1023 - (conf.get('device_min', 0) * 0.01 * 1023)
+        duty_min = 1023 - conf.get('device_max', 100) * 0.01 * 1023
+
+        if pwm_value > duty_max:
             value = conf.get('max', 100)
-        elif pwm_value < conf.get('duty_min', 0.0):
+        elif pwm_value < duty_min:
             value = conf.get('min', 0)
         else:
-            pwm_amplitude = conf.get('duty_max', 1023) - conf.get('duty_min', 0.0)
-            relative_value = (pwm_value - conf.get('duty_min', 0.0)) / pwm_amplitude
+            pwm_amplitude =duty_max - duty_min
+            relative_value = (pwm_value - duty_min) / pwm_amplitude
             val_amplitude = conf.get('max', 100) - conf.get('min', 0)
             value = conf.get('min', 0) + val_amplitude * relative_value
 
-        if self.component.config.get('inverse'):
-            value = conf.get('max', 100) - value + conf.get('min', 0)
+        value = conf.get('max', 100) - value + conf.get('min', 0)
 
-        return value
+        return round(value, 3)
+
+
+class DCDriver(FadeMixin, FleeDeviceMixin, BasicOutputMixin, BaseDimmer):
+    name = "0 - 24V DC Driver"
+    config_form = DCDriverConfigForm
+    default_value_units = 'V'
+
+    def _prepare_for_send(self, value):
+        conf = self.component.config
+        if value >= conf.get('max', 24):
+            value = conf.get('max', 24)
+        elif value < conf.get('min', 0):
+            value = conf.get('min', 0)
+
+        if value >= conf.get('max', 24):
+            pwm_value = 1023
+        elif value <= conf.get('min', 100):
+            pwm_value = 0
+        else:
+            val_amplitude = conf.get('max', 24) - conf.get('min', 0)
+            val_relative = value / val_amplitude
+
+            duty_max = conf.get('device_max', 24) / 24 * 1023
+            duty_min = conf.get('device_min', 0) / 24 * 1023
+
+            pwm_amplitude = duty_max - duty_min
+            pwm_value = duty_min + pwm_amplitude * val_relative
+
+        return pwm_value
+
+    def _prepare_for_set(self, pwm_value):
+        conf = self.component.config
+        duty_max = conf.get('device_max', 24) / 24 * 1023
+        duty_min = conf.get('device_min', 0) / 24 * 1023
+
+        if pwm_value > duty_max:
+            value = conf.get('max', 24)
+        elif pwm_value < duty_min:
+            value = conf.get('min', 0)
+        else:
+            pwm_amplitude = duty_max - duty_min
+            relative_value = (pwm_value - duty_min) / pwm_amplitude
+            val_amplitude = conf.get('max', 24) - conf.get('min', 0)
+            value = conf.get('min', 0) + val_amplitude * relative_value
+
+        return round(value, 3)
 
 
 class RGBLight(FleeDeviceMixin, BasicOutputMixin, BaseRGBWLight):
@@ -460,6 +505,25 @@ class DualMotorValve(FleeDeviceMixin, BasicOutputMixin, BaseDimmer):
 
         self.component.save()
 
+    def _prepare_for_send(self, value):
+        conf = self.component.config
+        if value >= conf.get('max', 100):
+            value = conf.get('max', 100)
+        elif value < conf.get('min', 0):
+            value = conf.get('min', 0)
+        val_amplitude = conf.get('max', 100) - conf.get('min', 0)
+        return ((value - conf.get('min', 0)) / val_amplitude) * 100
+
+
+    def _prepare_for_set(self, value):
+        conf = self.component.config
+        if value > conf.get('max', 100):
+            value = conf.get('max', 100)
+        elif value < conf.get('min', 0.0):
+            value = conf.get('min', 0)
+        val_amplitude = conf.get('max', 100) - conf.get('min', 0)
+        return conf.get('min', 0) + (value / 100) * val_amplitude
+
 
 class Blinds(FleeDeviceMixin, BasicOutputMixin, GenericBlinds):
     gateway_class = FleetGatewayHandler

simo/fleet/forms.py

@@ -741,14 +741,21 @@ class ColonelPWMOutputConfigForm(ColonelComponentForm):
         help_text="Maximum component value"
     )
     value_units = forms.CharField(required=False)
-    duty_min = forms.IntegerField(
-        min_value=0, max_value=1023, required=True, initial=0,
-        help_text="Minumum PWM signal output duty (0 - 1023)"
+
+    device_min = forms.IntegerField(
+        label="Device minimum (%).",
+        help_text="Device will turn off once it reaches this internal value. "
+                  "Usually it is a good idea to "                  
+                  "set this somewhere in between of 5 - 15 %. ",
+        initial=10, min_value=0, max_value=100,
     )
-    duty_max = forms.IntegerField(
-        min_value=0, max_value=1023, required=True, initial=900,
-        help_text="Maximum PWM signal output duty (0 - 1023)"
+    device_max = forms.IntegerField(
+        label="Device maximum (%).",
+        help_text="Can be used to prevent reaching maximum values. "
+                  "Default is 100%",
+        initial=100, min_value=0, max_value=100,
     )
+
     turn_on_time = forms.IntegerField(
         min_value=0, max_value=60000, initial=1000,
         help_text="Turn on speed in ms. 1500 is a great quick default. "
@@ -763,9 +770,6 @@ class ColonelPWMOutputConfigForm(ColonelComponentForm):
         initial='easeOutSine', choices=EASING_CHOICES,
         help_text="easeOutSine - offers most naturally looking effect."
     )
-    inverse = forms.BooleanField(
-        label=_("Inverse dimmer signal"), required=False, initial=True
-    )
     on_value = forms.FloatField(
         required=True, initial=100,
         help_text="ON value when used with toggle switch"
@@ -854,6 +858,71 @@ class ColonelPWMOutputConfigForm(ColonelComponentForm):
         return obj
 
 
+class DCDriverConfigForm(ColonelComponentForm):
+    output_pin = Select2ModelChoiceField(
+        label="Port",
+        queryset=ColonelPin.objects.filter(output=True),
+        url='autocomplete-colonel-pins',
+        forward=[
+            forward.Self(),
+            forward.Field('colonel'),
+            forward.Const({'output': True}, 'filters')
+        ]
+    )
+    min = forms.FloatField(
+        required=True, initial=0,
+        help_text="Minimum component value displayed to the user."
+    )
+    max = forms.FloatField(
+        required=True, initial=24,
+        help_text="Maximum component value displayed to the user."
+    )
+    value_units = forms.CharField(required=False)
+
+    device_min = forms.FloatField(
+        label="Device minimum Voltage.",
+        help_text="This will be the lowest possible voltage value of a device.\n"
+                   "Don't forget to adjust your component min value accordingly "
+                   "if you change this.",
+        initial=0, min_value=0, max_value=24,
+    )
+    device_max = forms.IntegerField(
+        label="Device maximum Voltage.",
+        help_text="Can be set lower than it's natural maximum of 24V. \n"
+                  "Don't forget to adjust your component max value accordingly "
+                  "if you change this.",
+        initial=24, min_value=0, max_value=24,
+    )
+
+    def clean(self):
+        super().clean()
+        if 'output_pin' in self.cleaned_data:
+            self._clean_pin('output_pin')
+        return self.cleaned_data
+
+
+    def save(self, commit=True):
+        if 'output_pin' in self.cleaned_data:
+            self.instance.config['output_pin_no'] = self.cleaned_data['output_pin'].no
+
+        update_colonel = False
+        if not self.instance.pk:
+            update_colonel = True
+        elif 'output_pin' in self.changed_data:
+            update_colonel = True
+
+        obj = super().save(commit=commit)
+
+        if not update_colonel:
+            GatewayObjectCommand(
+                obj.gateway, self.cleaned_data['colonel'], id=obj.id,
+                command='call', method='update_config', args=[
+                    obj.controller._get_colonel_config()
+                ]
+            ).publish()
+        return obj
+
+
 class ColonelRGBLightConfigForm(ColonelComponentForm):
     output_pin = Select2ModelChoiceField(
         label="Port",
@@ -1010,6 +1079,12 @@ class DualMotorValveForm(ColonelComponentForm):
         required=True, min_value=0.01, max_value=1000000000,
         initial=10, help_text="Time in seconds to close."
     )
+    min = forms.FloatField(
+        label="Minimum displayed value", required=True, initial=0
+    )
+    max = forms.FloatField(
+        label="Maximum displayed value", required=True, initial=100
+    )
 
 
     def clean(self):