simo 2.0.42__py3-none-any.whl → 2.1.0__py3-none-any.whl

simo/core/__init__.py

@@ -0,0 +1 @@
+default_app_config = 'core.apps.SIMOCoreAppConfig'

simo/core/admin.py

@@ -1,6 +1,8 @@
+import markdown
 from django.utils.translation import gettext_lazy as _
 from django.contrib import admin
 from django.urls import reverse
+from django.utils.safestring import mark_safe
 from easy_thumbnails.fields import ThumbnailerField
 from adminsortable2.admin import SortableAdminMixin
 from django.template.loader import render_to_string
@@ -8,6 +10,7 @@ from django.utils.decorators import method_decorator
 from django.views.decorators.csrf import csrf_protect
 from django.shortcuts import redirect, render
 from simo.users.models import ComponentPermission
+from simo.core.utils.admin import EasyObjectsDeleteMixin
 from .utils.type_constants import (
     ALL_BASE_TYPES, GATEWAYS_MAP, CONTROLLERS_BY_GATEWAY
 )
@@ -27,7 +30,7 @@ csrf_protect_m = method_decorator(csrf_protect)
 
 
 @admin.register(Icon)
-class IconAdmin(admin.ModelAdmin):
+class IconAdmin(EasyObjectsDeleteMixin, admin.ModelAdmin):
     form = IconForm
     list_display = 'slug', 'preview', 'copyright'
     search_fields = 'slug', 'keywords',
@@ -57,8 +60,9 @@ class IconAdmin(admin.ModelAdmin):
 
 
 
+
 @admin.register(Instance)
-class InstanceAdmin(admin.ModelAdmin):
+class InstanceAdmin(EasyObjectsDeleteMixin, admin.ModelAdmin):
     list_display = 'name', 'timezone', 'uid'
     exclude = 'learn_fingerprints_start', 'learn_fingerprints'
 
@@ -75,7 +79,7 @@ class InstanceAdmin(admin.ModelAdmin):
 
 
 @admin.register(Zone)
-class ZoneAdmin(SortableAdminMixin, admin.ModelAdmin):
+class ZoneAdmin(EasyObjectsDeleteMixin, SortableAdminMixin, admin.ModelAdmin):
     list_display = 'name', 'instance'
     search_fields = 'name',
     list_filter = 'instance',
@@ -91,7 +95,7 @@ class ZoneAdmin(SortableAdminMixin, admin.ModelAdmin):
 
 
 @admin.register(Category)
-class CategoryAdmin(SortableAdminMixin, admin.ModelAdmin):
+class CategoryAdmin(EasyObjectsDeleteMixin, SortableAdminMixin, admin.ModelAdmin):
     form = CategoryAdminForm
     list_display = 'name_display', 'all'
     search_fields = 'name',
@@ -118,7 +122,7 @@ class CategoryAdmin(SortableAdminMixin, admin.ModelAdmin):
 
 
 @admin.register(Gateway)
-class GatewayAdmin(admin.ModelAdmin):
+class GatewayAdmin(EasyObjectsDeleteMixin, admin.ModelAdmin):
     list_display = 'type', 'status'
     readonly_fields = ('type', 'control')
 
@@ -254,14 +258,14 @@ class ComponentPermissionInline(admin.TabularInline):
 
 
 @admin.register(Component)
-class ComponentAdmin(admin.ModelAdmin):
+class ComponentAdmin(EasyObjectsDeleteMixin, admin.ModelAdmin):
     form = BaseComponentForm
     list_display = (
         'id', 'name_display', 'value_display', 'base_type', 'alive', 'battery_level',
         'alarm_category', 'show_in_app',
     )
     readonly_fields = (
-        'id', 'controller_uid', 'base_type', 'gateway', 'config',
+        'id', 'controller_uid', 'base_type', 'info', 'gateway', 'config',
         'alive', 'error_msg', 'battery_level',
         'control', 'value', 'arm_status', 'history', 'meta'
     )
@@ -274,6 +278,9 @@ class ComponentAdmin(admin.ModelAdmin):
     list_per_page = 100
     change_list_template = 'admin/component_change_list.html'
     inlines = ComponentPermissionInline,
+    # standard django admin change_form.html template + adds side panel
+    # for displaying component controller info.
+    #change_form_template = 'admin/core/component_change_form.html'
 
     def get_fieldsets(self, request, obj=None):
         form = self._get_form_for_get_fields(request, obj)
@@ -346,6 +353,7 @@ class ComponentAdmin(admin.ModelAdmin):
                 ctx['selected_type'] = ALL_BASE_TYPES.get(
                     controller_cls.base_type, controller_cls.base_type
                 )
+                ctx['info'] = controller_cls.info(controller_cls)
                 if request.method == 'POST':
                     ctx['form'] = add_form(
                         request=request,
@@ -356,7 +364,6 @@ class ComponentAdmin(admin.ModelAdmin):
                     pop_fields_from_form(ctx['form'])
                     if ctx['form'].is_valid():
                         if ctx['form'].controller.is_discoverable:
-                            print("INIT DISCOVERY!!!")
                             ctx['form'].controller.init_discovery(
                                 ctx['form'].cleaned_data
                             )
@@ -395,7 +402,6 @@ class ComponentAdmin(admin.ModelAdmin):
                     if ctx['form'].is_valid():
                         request.session['add_comp_type'] = \
                             ctx['form'].cleaned_data['controller_type']
-                        print("Session controller type: ", request.session['add_comp_type'])
                         return redirect(request.path)
 
                 else:
@@ -475,6 +481,18 @@ class ComponentAdmin(admin.ModelAdmin):
             }
         )
 
+    def info(self, obj):
+        if not obj.controller:
+            return
+        info = obj.controller.info()
+        if not info:
+            return
+        return mark_safe(
+            f'<div class="markdownified-info">'
+            f'{markdown.markdown(info)}'
+            f'</div>'
+        )
+
     def history(self, obj):
         if not obj:
             return ''
@@ -483,4 +501,4 @@ class ComponentAdmin(admin.ModelAdmin):
                 'value_history': obj.history.filter(type='value').order_by('-date')[:50],
                 'arm_status_history': obj.history.filter(type='security').order_by('-date')[:50]
             }
-        )
+        )

simo/core/api.py

@@ -9,6 +9,7 @@ from django.utils import timezone
 from django.http import HttpResponse, Http404
 from simo.core.utils.helpers import get_self_ip, search_queryset
 from rest_framework import status
+from actstream.models import Action
 from rest_framework.pagination import PageNumberPagination
 from rest_framework import viewsets
 from django_filters.rest_framework import DjangoFilterBackend
@@ -23,7 +24,8 @@ from .models import (
 )
 from .serializers import (
     IconSerializer, CategorySerializer, ZoneSerializer,
-    ComponentSerializer, ComponentHistorySerializer
+    ComponentSerializer, ComponentHistorySerializer,
+    ActionSerializer
 )
 from .permissions import (
     IsInstanceSuperuser, InstanceSuperuserCanEdit, ComponentPermission
@@ -494,6 +496,22 @@ class ComponentHistoryViewSet(InstanceMixin, viewsets.ReadOnlyModelViewSet):
         return vectors
 
 
+class ActionsViewset(InstanceMixin, viewsets.ReadOnlyModelViewSet):
+    url = 'core/actions'
+    basename = 'actions'
+    serializer_class = ActionSerializer
+    pagination_class = HistoryResultsSetPagination
+
+    def get_queryset(self):
+        qs = Action.objects.filter(data__instance_id=self.instance.id)
+        if self.request.user.is_superuser:
+            return qs
+        user_role = self.request.user.get_role(self.instance)
+        if user_role.is_owner:
+            return qs
+        Action.objects.none()
+
+
 class SettingsViewSet(InstanceMixin, viewsets.GenericViewSet):
     url = 'core/settings'
     basename = 'settings'
@@ -626,7 +644,8 @@ class ControllerTypes(InstanceMixin, viewsets.GenericViewSet):
                 'name': cls.name,
                 'is_discoverable': cls.is_discoverable,
                 'manual_add': cls.manual_add,
-                'discovery_msg': cls.discovery_msg
+                'discovery_msg': cls.discovery_msg,
+                'info': cls.info(cls)
             })
 
         return RESTResponse(data)

simo/core/api_meta.py

@@ -1,8 +1,10 @@
 from collections import OrderedDict
+from django.urls import reverse
 from django.utils.encoding import force_str
-from rest_framework import serializers
 from rest_framework.metadata import SimpleMetadata
+from rest_framework import serializers
 from rest_framework.utils.field_mapping import ClassLookupDict
+from simo.core.models import Icon
 from .serializers import (
     HiddenSerializerField, ComponentManyToManyRelatedField,
     TextAreaSerializerField
@@ -40,7 +42,9 @@ class SIMOAPIMetadata(SimpleMetadata):
         TextAreaSerializerField: 'textarea',
     })
 
+
     def get_field_info(self, field):
+
         """
         Given an instance of a serializer field, return a dictionary
         of metadata about it.
@@ -51,6 +55,7 @@ class SIMOAPIMetadata(SimpleMetadata):
 
         form_field = field.style.get('form_field')
         if form_field:
+            #TODO: Delete these completely once autocomplete fields are fully implemented
             if hasattr(form_field, 'queryset'):
                 model = form_field.queryset.model
                 field_info['related_object'] = ".".join(
@@ -59,6 +64,10 @@ class SIMOAPIMetadata(SimpleMetadata):
             if hasattr(form_field, 'filter_by'):
                 field_info['filter_by'] = form_field.filter_by
 
+            if hasattr(form_field, 'forward'):
+                field_info['autocomplete_url'] = reverse(form_field.url)
+                field_info['forward'] = form_field.forward
+
         attrs = [
             'read_only', 'label', 'help_text',
             'min_length', 'max_length',
@@ -76,17 +85,18 @@ class SIMOAPIMetadata(SimpleMetadata):
         elif getattr(field, 'fields', None):
             field_info['children'] = self.get_serializer_info(field)
 
+        if form_field and hasattr(form_field, 'queryset') \
+        and form_field.queryset.model == Icon:
+            return field_info
+
         if not field_info.get('read_only') and hasattr(field, 'choices'):
-            add_choices = True
-            queryset = getattr(field, 'queryset', None)
-            if queryset and queryset.count() > 1000:
-                add_choices = False
-            if add_choices:
-                field_info['choices'] = [
-                    {
-                        'value': choice_value,
-                        'display_name': force_str(choice_name, strings_only=True)
-                    }
-                    for choice_value, choice_name in field.choices.items()
-                ]
+            print(f"DO choices for: {field.label}")
+            field_info['choices'] = [
+                {
+                    'value': choice_value,
+                    'display_name': force_str(choice_name, strings_only=True)
+                }
+                for choice_value, choice_name in field.choices.items()
+            ]
+
         return field_info

simo/core/app_widgets.py

@@ -23,6 +23,12 @@ class BinarySensorWidget(BaseAppWidget):
     size = [2, 1]
 
 
+class ButtonWidget(BaseAppWidget):
+    uid = 'button'
+    name = _("Button")
+    size = [2, 1]
+
+
 class NumericSensorWidget(BaseAppWidget):
     uid = 'numeric-sensor'
     name = _("Numeric sensor")

simo/core/apps.py

@@ -0,0 +1,10 @@
+from django.apps import AppConfig
+
+
+class SIMOCoreAppConfig(AppConfig):
+    name = 'simo.core'
+
+    def ready(self):
+        from actstream import registry
+        registry.register(self.get_model('Component'))
+        registry.register(self.get_model('Gateway'))

simo/core/base_types.py

@@ -8,6 +8,7 @@ BASE_TYPES = {
     'numeric-sensor': _("Numeric sensor"),
     'multi-sensor': _("Multi sensor"),
     'binary-sensor': _("Binary sensor"),
+    'button': _("Button"),
     'dimmer': _("Dimmer"),
     'dimmer-plus': _("Dimmer Plus"),
     'rgbw-light': _('RGB(W) light'),

simo/core/controllers.py

@@ -5,8 +5,10 @@ import statistics
 import threading
 from decimal import Decimal as D
 from abc import ABC, ABCMeta, abstractmethod
+from django.utils.functional import cached_property
 from django.core.exceptions import ValidationError
 from django.utils import timezone
+from django.template.loader import render_to_string
 from django.utils.translation import gettext_lazy as _
 from simo.users.middleware import introduce, get_current_user
 from simo.users.utils import get_device_user
@@ -73,6 +75,11 @@ class ControllerBase(ABC):
         :return: Default value of this base component type
         """
 
+    @property
+    def info_template_path(self) -> str:
+        return f"{self.__class__.__module__.split('.')[-2]}/" \
+               f"controllers_info/{self.__class__.__name__.lower()}.md"
+
     @abstractmethod
     def _validate_val(self, value, occasion=None):
         """
@@ -113,6 +120,24 @@ class ControllerBase(ABC):
             cls, '_process_discovery'
         )
 
+    def info(self):
+        '''
+        Override this to give users help on how to use this component type,
+        after you do that, include any component instance specific information
+        if you see it necessary.
+        :return: Markdown component info on how to set it up and use it
+        along with any other relative information,
+         regarding this particular component instance
+        '''
+        try:
+            return render_to_string(
+                self.info_template_path, {
+                    'component': self.component if hasattr(self, 'component') else None
+                }
+            )
+        except:
+            return
+
     def _aggregate_values(self, values):
         if type(values[0]) in (float, int):
             return [statistics.mean(values)]
@@ -306,6 +331,8 @@ class ControllerBase(ABC):
         return value
 
 
+
+
 class TimerMixin:
 
     def __init__(self, *args, **kwargs):
@@ -459,6 +486,36 @@ class BinarySensor(ControllerBase):
         return value
 
 
+class Button(ControllerBase):
+    name = _("Button")
+    base_type = 'button'
+    app_widget = ButtonWidget
+    admin_widget_template = 'admin/controller_widgets/button.html'
+    default_value = 'up'
+
+    def _validate_val(self, value, occasion=None):
+        if value not in ('down', 'up', 'hold', 'click', 'double-click'):
+            raise ValidationError("Bad button value!")
+        return value
+
+    def is_down(self):
+        return self.component.value in ('down', 'hold')
+
+    def is_held(self):
+        return self.component.value == 'hold'
+
+    @cached_property
+    def bonded_gear(self):
+        from simo.core.models import Component
+        gear = []
+        for comp in Component.objects.filter(config__has_key='controls'):
+            for ctrl in comp.config['controls']:
+                if ctrl.get('button') == self.component.id:
+                    gear.append(comp)
+                    break
+        return gear
+
+
 class OnOffPokerMixin:
     _poke_toggle = False
 

simo/core/form_fields.py

@@ -0,0 +1,93 @@
+import copy
+from django import forms
+from dal import autocomplete
+
+
+class LazyChoicesMixin:
+
+    _choices = ()
+
+    @property
+    def choices(self):
+        if callable(self._choices):
+            return self._choices()
+        return self._choices
+
+    @choices.setter
+    def choices(self, value):
+        self._choices = value
+
+    def __deepcopy__(self, memo):
+        obj = copy.copy(self)
+        obj.attrs = self.attrs.copy()
+        if not callable(self._choices):
+            obj._choices = copy.copy(self._choices)
+        memo[id(self)] = obj
+        return obj
+
+    def optgroups(self, name, value, attrs=None):
+        for (val, display) in self.choices:
+            if val == value[0]:
+                self.choices = [(val, display)]
+                break
+        return super().optgroups(name, value, attrs)
+
+
+class ListSelect2(LazyChoicesMixin, autocomplete.ListSelect2):
+    pass
+
+
+class Select2Multiple(LazyChoicesMixin, autocomplete.Select2Multiple):
+    pass
+
+
+class Select2ListMixin:
+
+    def __init__(self, url, forward=None, *args, **kwargs):
+        self.url = url
+        self.forward = []
+        if forward:
+            self.forward = [fw.to_dict() for fw in forward]
+
+        widget = ListSelect2(
+            url=url, forward=forward, attrs={'data-html': True},
+
+        )
+        widget.choices = kwargs.get('choices', None)
+
+        super().__init__(widget=widget, *args, **kwargs)
+
+class Select2ModelChoiceField(Select2ListMixin, forms.ModelChoiceField):
+    pass
+
+
+class Select2ListChoiceField(Select2ListMixin, forms.ChoiceField):
+    pass
+
+
+class Select2MultipleMixin:
+
+    def __init__(self, url, forward=None, *args, **kwargs):
+        self.url = url
+        self.forward = []
+        if forward:
+            self.forward = [fw.to_dict() for fw in forward]
+
+        widget = Select2Multiple(
+            url=url, forward=forward, attrs={'data-html': True}
+        )
+        widget.choices = kwargs.pop('choices', None)
+
+        super().__init__(widget, *args, **kwargs)
+
+
+class Select2ModelMultipleChoiceField(
+    Select2MultipleMixin, forms.ModelMultipleChoiceField
+):
+    pass
+
+
+class Select2ListMultipleChoiceField(
+    Select2MultipleMixin, forms.MultipleChoiceField
+):
+    pass

simo/core/forms.py

@@ -12,6 +12,7 @@ from django.urls.base import get_script_prefix
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 from django.contrib.contenttypes.models import ContentType
+from actstream import action
 from timezone_utils.choices import ALL_TIMEZONES_CHOICES
 from dal import autocomplete
 from .models import (
@@ -209,6 +210,19 @@ class ConfigFieldsMixin:
                 self.instance.config[field_name] = \
                     self.cleaned_data[field_name]
 
+        if commit:
+            from simo.users.middleware import get_current_user
+            actor = get_current_user()
+            if self.instance.pk:
+                verb = 'modified'
+            else:
+                verb = 'created'
+            action.send(
+                actor, target=self.instance, verb=verb,
+                instance_id=self.instance.zone.instance.id,
+                action_type='management_event'
+            )
+
         return super().save(commit)
 
 
@@ -364,7 +378,7 @@ class ComponentAdminForm(forms.ModelForm):
             'alarm_category', 'arm_status',
             'notes'
         )
-        base_fields = ['id', 'gateway', 'base_type', 'name']
+        base_fields = ['id', 'gateway', 'base_type', 'info', 'name']
         if cls.has_icon:
             base_fields.append('icon')
 
@@ -432,8 +446,6 @@ class ComponentAdminForm(forms.ModelForm):
         return self.cleaned_data['instance_methods']
 
 
-
-
 class BaseComponentForm(ConfigFieldsMixin, ComponentAdminForm):
     pass
 

simo/core/gateways.py

@@ -74,7 +74,7 @@ class BaseObjectCommandsGatewayHandler(BaseGatewayHandler):
     def _run_periodic_task(self, exit, task, period):
         while not exit.is_set():
             try:
-                print(f"Run periodic task {task}!")
+                #print(f"Run periodic task {task}!")
                 getattr(self, task)()
             except Exception as e:
                 self.logger.error(e, exc_info=True)

simo/core/managers.py

@@ -1,10 +1,21 @@
 import sys
 import traceback
+from actstream.managers import ActionManager as OrgActionManager
 from .middleware import get_current_instance
 from django.utils import timezone
 from django.db import models
 
 
+class ActionManager(OrgActionManager):
+
+    def get_queryset(self):
+        qs = super().get_queryset()
+        instance = get_current_instance()
+        if instance:
+            qs = qs.filter(data__instance_id=instance.id)
+        return qs
+
+
 class ZonesManager(models.Manager):
 
     def get_queryset(self):
@@ -32,7 +43,7 @@ class ComponentsManager(models.Manager):
         instance = get_current_instance()
         if instance:
             qs = qs.filter(zone__instance=instance)
-        return qs
+        return qs.select_related('zone', 'zone__instance', 'gateway')
 
     def bulk_send(self, data):
         """
@@ -50,6 +61,8 @@ class ComponentsManager(models.Manager):
 
         gateway_components = {}
         for comp, value in data.items():
+            if not comp.controller:
+                continue
             try:
                 value = comp.controller._validate_val(value, BEFORE_SEND)
             except:

simo/core/migrations/0037_auto_20240606_1057.py

@@ -0,0 +1,33 @@
+# Generated by Django 4.2.10 on 2024-06-06 10:57
+
+from django.db import migrations
+
+def forwards_func(apps, schema_editor):
+
+    Component = apps.get_model("core", "Component")
+    Gateway = apps.get_model('core', "Gateway")
+
+    generic_gateway = Gateway.objects.filter(
+        type='simo.generic.gateways.GenericGatewayHandler'
+    ).first()
+    if not generic_gateway:
+        return
+
+    Component.objects.filter(
+        controller_uid='simo.generic.controllers.StateSelect'
+    ).update(gateway=generic_gateway)
+
+
+def reverse_func(apps, schema_editor):
+    pass
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0036_auto_20240521_0823'),
+    ]
+
+    operations = [
+        migrations.RunPython(forwards_func, reverse_func, elidable=True),
+    ]