simo 2.8.14__py3-none-any.whl → 2.9.1__py3-none-any.whl

simo/core/admin.py

@@ -366,7 +366,7 @@ class ComponentAdmin(EasyObjectsDeleteMixin, admin.ModelAdmin):
                     pop_fields_from_form(ctx['form'])
                     if ctx['form'].is_valid():
                         if ctx['form'].controller.is_discoverable:
-                            ctx['form'].controller.init_discovery(
+                            ctx['form'].controller._init_discovery(
                                 ctx['form'].cleaned_data
                             )
                             ctx['discovery_msg'] = ctx['form'].controller.discovery_msg
@@ -383,6 +383,9 @@ class ComponentAdmin(EasyObjectsDeleteMixin, admin.ModelAdmin):
                                 'components-list',
                                 kwargs={'instance_slug': instance.slug}
                             )
+                            ctx['finish_url'] = reverse(
+                                'finish-discovery',
+                            ) + f"?uid={ctx['form'].controller.uid}"
                             return render(
                                 request, 'admin/wizard/discovery.html', ctx
                             )
@@ -486,7 +489,7 @@ class ComponentAdmin(EasyObjectsDeleteMixin, admin.ModelAdmin):
     def info(self, obj):
         if not obj.controller:
             return
-        info = obj.controller.info()
+        info = obj.controller.info(obj)
         if not info:
             return
         return mark_safe(

simo/core/auto_urls.py

@@ -1,6 +1,7 @@
 from django.urls import path
 from .views import (
-    get_timestamp, upgrade, restart, reboot, set_instance, delete_instance
+    get_timestamp, upgrade, restart, reboot, set_instance, delete_instance,
+    finish_discovery
 )
 from .autocomplete_views import (
     IconModelAutocomplete,
@@ -31,6 +32,8 @@ urlpatterns = [
         ComponentAutocomplete.as_view(), name='autocomplete-component'
     ),
     path('set-instance/<slug:instance_slug>/', set_instance, name='set-instance'),
+    path('finish-discovery/',
+         finish_discovery, name='finish-discovery'),
     path('upgrade/', upgrade, name='upgrade'),
     path('restart/', restart, name='restart'),
     path('reboot/', reboot, name='reboot'),

simo/core/controllers.py

@@ -111,9 +111,7 @@ class ControllerBase(ABC):
     @classmethod
     def is_discoverable(cls):
         return hasattr(
-            cls, 'init_discovery'
-        ) and hasattr(
-            cls, '_process_discovery'
+            cls, '_init_discovery'
         )
 
     @classmethod

simo/core/forms.py

@@ -284,7 +284,7 @@ class ComponentAdminForm(forms.ModelForm):
         patched to send all keys, even for checkboxes, via
         input[type="hidden"] fields or some JS magic.
         """
-        # TODO: When creating new component, via admin interface and disabling show_in_app, show_in_app field get's removed, cince there is no "input[type="hidden"] fields or some JS magic" logic implemented.
+        # TODO: When creating new component, via admin interface and disabling any boolean field, field get's removed and effectively receives it's default value, which is usually True, because "input[type="hidden"] fields or some JS magic" logic is not yet implemented.
         if data is None:
             # not a form submission, don't modify self.fields
             return

simo/core/models.py

@@ -294,28 +294,44 @@ class Gateway(DirtyFieldsMixin, models.Model, SimoAdminMixin):
         )
         if result:
             self.refresh_from_db()
-            if not isinstance(result, dict) and isinstance(result, Iterable):
-                for res in result:
-                    if isinstance(res, models.Model):
-                        if res.pk not in self.discovery['result']:
-                            self.discovery['result'].append(res.pk)
-                    else:
-                        if res not in self.discovery['result']:
-                            self.discovery['result'].append(res)
-            else:
-                if isinstance(result, models.Model):
-                    if result.pk not in self.discovery['result']:
-                        self.discovery['result'].append(result.pk)
-                else:
-                    if result not in self.discovery['result']:
-                        self.discovery['result'].append(result)
-
+            self.append_discovery_result(result)
 
         self.save(update_fields=['discovery'])
 
+
     def finish_discovery(self):
+        from .utils.type_constants import CONTROLLER_TYPES_MAP
         self.discovery['finished'] = time.time()
         self.save(update_fields=['discovery'])
+        ControllerClass = CONTROLLER_TYPES_MAP.get(
+            self.discovery['controller_uid']
+        )
+        if hasattr(ControllerClass, '_finish_discovery'):
+            result = ControllerClass._finish_discovery(
+                self.discovery['init_data']
+            )
+            self.append_discovery_result(result)
+        self.save(update_fields=['discovery'])
+
+
+    def append_discovery_result(self, result):
+        if not isinstance(result, dict) and isinstance(result, Iterable):
+            for res in result:
+                if isinstance(res, models.Model):
+                    if res.pk not in self.discovery['result']:
+                        self.discovery['result'].append(res.pk)
+                else:
+                    if res not in self.discovery['result']:
+                        self.discovery['result'].append(res)
+        else:
+            if isinstance(result, models.Model):
+                if result.pk not in self.discovery['result']:
+                    self.discovery['result'].append(result.pk)
+            else:
+                if result not in self.discovery['result']:
+                    self.discovery['result'].append(result)
+
+
 
 
 class Component(DirtyFieldsMixin, models.Model, SimoAdminMixin, OnChangeMixin):

simo/core/serializers.py

@@ -310,7 +310,6 @@ class ComponentSerializer(FormSerializer):
         field_mapping = {
             HiddenField: HiddenSerializerField,
             forms.TypedChoiceField: serializers.ChoiceField,
-            forms.FloatField: serializers.FloatField,
             forms.SlugField: serializers.CharField,
             PlainLocationField: LocationSerializer,
             forms.ModelChoiceField: ComponentPrimaryKeyRelatedField,
@@ -323,8 +322,6 @@ class ComponentSerializer(FormSerializer):
             PasswordField: PasswordSerializer
         }
 
-
-
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         # Set proper instance for OPTIONS request
@@ -547,7 +544,7 @@ class ComponentSerializer(FormSerializer):
         )
         if form.is_valid():
             if form.controller.is_discoverable:
-                form.controller.init_discovery(form.cleaned_data)
+                form.controller._init_discovery(form.cleaned_data)
                 return form.save(commit=False)
             return form.save(commit=True)
         raise serializers.ValidationError(form.errors)
@@ -557,7 +554,7 @@ class ComponentSerializer(FormSerializer):
 
     def get_info(self, obj):
         if obj.controller:
-            return obj.controller.info()
+            return obj.controller.info(obj)
 
     def get_read_only(self, obj):
         user = self.context.get('user')

simo/core/templates/admin/core/component_change_form.html

@@ -56,7 +56,7 @@
 					<h2 style="background: linear-gradient(0.3turn, #5c7ca5, #5a95df);">Info</h2>
 					<div class="form-row">
 						{% if original.controller %}
-						  {{ original.info|markdownify }}
+						  {{ original.info|markdownify|linebreaksbr }}
 						{% endif %}
 					</div>
 				</div>

simo/core/templates/admin/msg_page.html

@@ -25,6 +25,7 @@
         {{ msg|safe }}
       </p>
       <p class="mb-0">{{ suggestion|safe }}</p>
+      <p><a href="{% url 'logout' %}">Logout >></a></p>
     </div>
 
 </div>

simo/core/templates/admin/wizard/discovery.html

@@ -64,8 +64,7 @@
     
     <div id="running-discovery">
       <p style="margin: 30px 15px">
-        <i class="fas fa-spinner fa-spin fa-lg" style="margin-right: 10px"></i> DISCOVERY MODE ACTIVATED! <br>
-        Your new components will appear down bellow once discovered.
+        <i class="fas fa-spinner fa-spin fa-lg" style="margin-right: 10px"></i> DISCOVERY MODE ACTIVATED!
       </p>
       {% if discovery_msg %}
         <p style="margin: 30px 15px">{{ discovery_msg }}</p>
@@ -108,8 +107,8 @@
 
     <div class="submit-row" style="text-align: left;">
 
-    <a href="{% url 'admin:core_component_changelist' %}" class="cancel-link" style="display: block; padding:9px 15px">
-      <i class="fa fa-check"></i> Done
+    <a href="{{ finish_url }}" class="cancel-link" style="display: block; padding:9px 15px">
+      <i class="fa fa-check"></i> Finish
     </a>
 
     </div>

simo/core/templates/admin/wizard/wizard_add.html

@@ -63,7 +63,7 @@
     {% if info %}
       <div class="form-row">
         <div class="markdownified-info">
-          {{ info|markdownify }}
+          {{ info|markdownify|linebreaksbr }}
         </div>
       </div>
     {% endif %}

simo/core/views.py

@@ -9,7 +9,7 @@ from django.http import (
 )
 from django.contrib import messages
 from simo.conf import dynamic_settings
-from .models import Instance
+from .models import Instance, Component, Gateway
 from .tasks import update as update_task, supervisor_restart, hardware_reboot
 from .middleware import introduce_instance
 
@@ -91,4 +91,28 @@ def hub_info(request):
             request.get_host()
         ):
             data['hub_secret'] = dynamic_settings['core__hub_secret']
-    return JsonResponse(data)
+    return JsonResponse(data)
+
+
+@login_required
+def finish_discovery(request):
+    # finish discovery function for admin discovery view
+    if not request.user.is_authenticated:
+        raise Http404()
+    if not request.user.is_master:
+        raise Http404()
+    result = None
+    for gateway in Gateway.objects.filter(
+        discovery__start__gt=time.time() - 60 * 60,  # no more than an hour
+        discovery__controller_uid=request.GET['uid']
+    ):
+        gateway.finish_discovery()
+        for res in gateway.discovery['result']:
+            comp = Component.objects.filter(
+                controller_uid=request.GET['uid'], pk=res
+            ).first()
+            if comp:
+                result = comp
+    if result:
+        return redirect(result.get_admin_url())
+    return reverse('admin:core_component_changelist')

simo/fleet/api.py

@@ -4,11 +4,13 @@ from rest_framework import viewsets
 from rest_framework.response import Response as RESTResponse
 from rest_framework.decorators import action
 from rest_framework.exceptions import ValidationError as APIValidationError
+from django_filters.rest_framework import DjangoFilterBackend
 from simo.core.api import InstanceMixin
 from simo.core.permissions import IsInstanceSuperuser
-from .models import InstanceOptions, Colonel, Interface
+from .models import InstanceOptions, Colonel, Interface, CustomDaliDevice
 from .serializers import (
-    InstanceOptionsSerializer, ColonelSerializer, ColonelInterfaceSerializer
+    InstanceOptionsSerializer, ColonelSerializer, ColonelInterfaceSerializer,
+    CustomDaliDeviceSerializer
 )
 
 
@@ -99,4 +101,25 @@ class InterfaceViewSet(
         return permissions
 
     def get_queryset(self):
-        return Interface.objects.filter(colonel__instance=self.instance)
+        return Interface.objects.filter(colonel__instance=self.instance)
+
+
+class CustomDaliDeviceViewSet(
+    InstanceMixin,
+    viewsets.mixins.RetrieveModelMixin, viewsets.mixins.UpdateModelMixin,
+    viewsets.mixins.ListModelMixin, viewsets.mixins.CreateModelMixin,
+    viewsets.GenericViewSet
+):
+    url = 'fleet/custom-dali-devices'
+    basename = 'custom-dali-devices'
+    serializer_class = CustomDaliDeviceSerializer
+    filter_backends = [DjangoFilterBackend]
+    filterset_fields = ['random_address', 'name']
+
+    def get_permissions(self):
+        permissions = super().get_permissions()
+        permissions.append(IsInstanceSuperuser())
+        return permissions
+
+    def get_queryset(self):
+        return CustomDaliDevice.objects.filter(instance=self.instance)

simo/fleet/base_types.py

@@ -2,4 +2,5 @@ from django.utils.translation import gettext_lazy as _
 
 BASE_TYPES = {
     'dali': _("Dali Device"),
+    'room-sensor': _("Room Sensor"),
 }

simo/fleet/controllers.py

@@ -1,4 +1,4 @@
-import json
+import json, ast
 from django.utils.translation import gettext_lazy as _
 from django.db.transaction import atomic
 from simo.core.middleware import get_current_instance
@@ -9,7 +9,7 @@ from simo.core.controllers import (
     NumericSensor as BaseNumericSensor,
     Switch as BaseSwitch, Dimmer as BaseDimmer,
     MultiSensor as BaseMultiSensor, RGBWLight as BaseRGBWLight,
-    Blinds as BaseBlinds, Gate as BaseGate
+    Blinds as BaseBlinds, Gate as BaseGate,
 )
 from simo.core.app_widgets import NumericSensorWidget, AirQualityWidget
 from simo.core.controllers import Lock, ControllerBase, SingleSwitchWidget
@@ -17,7 +17,8 @@ from simo.core.utils.helpers import heat_index
 from simo.core.utils.serialization import (
     serialize_form_data, deserialize_form_data
 )
-from .models import Colonel
+from simo.core.forms import BaseComponentForm
+from .models import Colonel, CustomDaliDevice
 from .gateways import FleetGatewayHandler
 from .forms import (
     ColonelPinChoiceField,
@@ -31,7 +32,8 @@ from .forms import (
     TTLockConfigForm, DALIDeviceConfigForm, DaliLampForm, DaliGearGroupForm,
     DaliSwitchConfigForm,
     DaliOccupancySensorConfigForm, DALILightSensorConfigForm,
-    DALIButtonConfigForm
+    DALIButtonConfigForm, RoomSensorDeviceConfigForm,
+    RoomZonePresenceConfigForm
 )
 
 
@@ -465,7 +467,7 @@ class TTLock(FleeDeviceMixin, Lock):
     discovery_msg = _("Please activate your TTLock so it can be discovered.")
 
     @classmethod
-    def init_discovery(self, form_cleaned_data):
+    def _init_discovery(self, form_cleaned_data):
         from simo.core.models import Gateway
         print("INIT discovery form cleaned data: ", form_cleaned_data)
         print("Serialized form: ", serialize_form_data(form_cleaned_data))
@@ -663,7 +665,7 @@ class DALIDevice(FleeDeviceMixin, ControllerBase):
         return value
 
     @classmethod
-    def init_discovery(self, form_cleaned_data):
+    def _init_discovery(self, form_cleaned_data):
         from simo.core.models import Gateway
         gateway = Gateway.objects.filter(type=self.gateway_class.uid).first()
         gateway.start_discovery(
@@ -824,4 +826,235 @@ class DALIButton(BaseButton, DALIDevice):
     family = 'dali'
     manual_add = False
     name = 'DALI Button'
-    config_form = DALIButtonConfigForm
+    config_form = DALIButtonConfigForm
+
+
+class RoomSensor(FleeDeviceMixin, ControllerBase):
+    gateway_class = FleetGatewayHandler
+    config_form = RoomSensorDeviceConfigForm
+    name = "Room Sensor"
+    base_type = 'room-sensor'
+    default_value = 0
+    app_widget = NumericSensorWidget
+
+    def _validate_val(self, value, occasion=None):
+        return value
+
+
+class AirQualitySensor(FleeDeviceMixin, BaseMultiSensor):
+    gateway_class = FleetGatewayHandler
+    config_form = BaseComponentForm
+    name = "Air Quality Sensor"
+    app_widget = AirQualityWidget
+    manual_add = False
+
+    default_value = [
+        ["TVOC", 0, "ppb"],
+        ["AQI (UBA)", 0, ""]
+    ]
+
+    def _receive_from_device(self, value, *args, **kwargs):
+        aqi = 5
+        if value < 812:
+            aqi = 4
+        if value < 325:
+            aqi = 3
+        if value < 162:
+            aqi = 2
+        if value < 65:
+            aqi = 1
+        value = [
+            ["TVOC", value, "ppb"],
+            ["AQI (UBA)", aqi, ""]
+        ]
+        return super()._receive_from_device(value, *args, **kwargs)
+
+    def get_tvoc(self):
+        try:
+            for entry in self.component.value:
+                if entry[0] == 'TVOC':
+                    return entry[1]
+        except:
+            return
+
+    def get_aqi(self):
+        try:
+            for entry in self.component.value:
+                if entry[0] == 'AQI (UBA)':
+                    return entry[1]
+        except:
+            return
+
+
+class TempHumSensor(FleeDeviceMixin, BasicSensorMixin, BaseMultiSensor):
+    gateway_class = FleetGatewayHandler
+    config_form = BaseComponentForm
+    name = "Temperature & Humidity sensor"
+    app_widget = NumericSensorWidget
+    manual_add = False
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.sys_temp_units = 'C'
+        if hasattr(self.component, 'zone') \
+                and self.component.zone.instance.units_of_measure == 'imperial':
+            self.sys_temp_units = 'F'
+
+    @property
+    def default_value(self):
+        return [
+            ['temperature', 0, self.sys_temp_units],
+            ['humidity', 20, '%'],
+            ['real_feel', 0, self.sys_temp_units]
+        ]
+
+    def _receive_from_device(self, value, *args, **kwargs):
+
+        if isinstance(value, dict):
+            temp = value['temp']
+            humidity = value['humidity']
+        else:
+            buf = bytes.fromhex(value)
+            humidity = (
+                (buf[0] << 12) | (buf[1] << 4) | (buf[2] >> 4)
+            )
+            humidity = (humidity * 100) / 0x100000
+            humidity = int(round(humidity, 0))
+            temp = ((buf[2] & 0xF) << 16) | (buf[3] << 8) | buf[4]
+            temp = ((temp * 200.0) / 0x100000) - 50
+            temp = round(temp, 1)
+
+        new_val = [
+            ['temperature', temp, self.sys_temp_units],
+            ['humidity', humidity, '%'],
+            ['real_feel', 0, self.sys_temp_units]
+        ]
+
+        if self.sys_temp_units == 'F':
+            new_val[0][1] = round((new_val[0][1] * 9 / 5) + 32, 1)
+
+        real_feel = heat_index(
+            new_val[0][1], new_val[1][1], self.sys_temp_units == 'F'
+        )
+        new_val[2] = ['real_feel', real_feel, self.sys_temp_units]
+
+        return super()._receive_from_device(new_val, *args, **kwargs)
+
+
+class AmbientLightSensor(FleeDeviceMixin, BaseNumericSensor):
+    gateway_class = FleetGatewayHandler
+    name = "Ambient lighting sensor"
+    manual_add = False
+    default_config = {
+        'widget': 'numeric-sensor',
+        'value_units': 'lux',
+        'limits': [
+            {"name": "Dark", "value": 20},
+            {"name": "Moderate", "value": 300},
+            {"name": "Bright", "value": 800},
+        ]
+    }
+
+
+class RoomPresenceSensor(FleeDeviceMixin, BaseBinarySensor):
+    gateway_class = FleetGatewayHandler
+    name = "Human presence sensor"
+    manual_add = False
+
+
+class RoomZonePresenceSensor(FleeDeviceMixin, BaseBinarySensor):
+    gateway_class = FleetGatewayHandler
+    add_form = RoomZonePresenceConfigForm
+    config_form = BaseComponentForm
+    name = "Room zone presence"
+    discovery_msg = _(
+        "Move vigorously in particular zone of the room, "
+        "where presence needs to be detected. "
+        "Your movements are being recorded. "
+        "Hit Done, once you are done."
+    )
+
+    @classmethod
+    def _init_discovery(self, form_cleaned_data):
+        from simo.core.models import Gateway
+        gateway = Gateway.objects.filter(type=self.gateway_class.uid).first()
+        gateway.start_discovery(
+            self.uid, serialize_form_data(form_cleaned_data),
+            timeout=60
+        )
+        if form_cleaned_data['device'].startswith('wifi'):
+            colonel = Colonel.objects.filter(
+                id=form_cleaned_data['device'][5:]
+            ).first()
+            GatewayObjectCommand(
+                gateway, colonel,
+                command='discover', type=self.uid.split('.')[-1],
+            ).publish()
+        else:
+            dali_device = CustomDaliDevice.objects.filter(
+                id=form_cleaned_data['device'][5:]
+            ).first()
+            from .custom_dali_operations import Frame
+            frame = Frame(40, bytes(bytearray(5)))
+            frame[8:11] = 15 # command to custom dali device
+            frame[12:15] = 0 # action to perform: start room zone discovery
+            dali_device.transmit(frame)
+
+
+    @classmethod
+    @atomic
+    def _finish_discovery(cls, started_with):
+        started_with = deserialize_form_data(started_with)
+        form = cls.add_form(
+            controller_uid=cls.uid, data=started_with
+        )
+        form.is_valid()
+        if form.cleaned_data['device'].startswith('wifi'):
+            form.instance.alive = False
+            form.instance.config['colonel'] = int(
+                form.cleaned_data['device'][5:]
+            )
+            new_component = form.save()
+            GatewayObjectCommand(
+                new_component.gateway, Colonel(
+                    id=new_component.config['colonel']
+                ), command='finalize',
+                data={
+                    'comp_config': {
+                        'type': str(cls).split('.')[-1],
+                        'family': new_component.controller.family,
+                        'config': json.loads(json.dumps(new_component.config))
+                    }
+                }
+            ).publish()
+        else:
+            from simo.core.models import Component
+            dali_device = CustomDaliDevice.objects.filter(
+                id=form.cleaned_data['device'][5:]
+            ).first()
+            free_slots = {0, 1, 2, 3, 4, 5, 6, 7}
+            for comp in Component.objects.filter(
+                controller_uid=cls.uid, config__dali_device=dali_device.id
+            ):
+                try:
+                    free_slots.remove(int(comp.config['slot']))
+                except:
+                    continue
+            if not free_slots:
+                return []
+
+            form.instance.alive = False
+            form.instance.config['dali_device'] = int(
+                form.cleaned_data['device'][5:]
+            )
+            form.instance.config['slot'] = free_slots.pop()
+            new_component = form.save()
+            from .custom_dali_operations import Frame
+            frame = Frame(40, bytes(bytearray(5)))
+            frame[8:11] = 15  # command to custom dali device
+            frame[12:15] = 1  # action to perform: stop room zone discovery
+            frame[16:18] = new_component.config['slot']
+            dali_device.transmit(frame)
+
+        print("NEW COMPONENT: ", new_component)
+        return new_component