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

simo/fleet/models.py

@@ -91,7 +91,7 @@ class Colonel(DirtyFieldsMixin, models.Model):
                                  "and reset if a lot of data is being transmitted. "
                                  "Leave this off, unleess you know what you are doing!"
     )
-    pwm_frequency = models.IntegerField(default=1, choices=(
+    pwm_frequency = models.IntegerField(default=0, choices=(
         (0, "3kHz"), (1, "22kHz")
     ), help_text="Affects Ample Wall dimmer PWM output (dimmer) frequency")
 
@@ -311,7 +311,7 @@ def post_component_delete(sender, instance, *args, **kwargs):
                 comp, instance.config.get('da', 0), remove=True
             )
 
-    elif instance.controller.family == 'dali':
+    elif instance.controller and instance.controller.family == 'dali':
         colonel = Colonel.objects.filter(id=instance.config['colonel']).first()
         if colonel:
             GatewayObjectCommand(

simo/generic/controllers.py

@@ -3,6 +3,10 @@ import threading
 import pytz
 import datetime
 import json
+import requests
+import traceback
+import sys
+from bs4 import BeautifulSoup
 from django.core.exceptions import ValidationError
 from django.utils import timezone
 from django.utils.functional import cached_property
@@ -16,6 +20,7 @@ from simo.core.events import GatewayObjectCommand
 from simo.core.models import RUN_STATUS_CHOICES_MAP, Component
 from simo.core.utils.helpers import get_random_string
 from simo.core.utils.operations import OPERATIONS
+from simo.core.middleware import get_current_instance
 from simo.core.controllers import (
     BEFORE_SEND, BEFORE_SET, ControllerBase,
     BinarySensor, NumericSensor, MultiSensor, Switch, Dimmer, DimmerPlus,
@@ -42,12 +47,14 @@ from .forms import (
     BlindsConfigForm, WateringConfigForm, StateSelectForm,
     AlarmClockConfigForm
 )
+from .scripting import get_current_state
+from .scripting.serializers import UserSerializer
 
 # ----------- Generic controllers -----------------------------
 
+
 class Script(ControllerBase, TimerMixin):
-    masters_only = True
-    name = _("Script")
+    name = _("AI Script")
     base_type = 'script'
     gateway_class = GenericGatewayHandler
     app_widget = ScriptWidget
@@ -101,6 +108,38 @@ class Script(ControllerBase, TimerMixin):
         else:
             self.send('start')
 
+    def ai_assistant(self, wish):
+        try:
+            request_data = {
+                'hub_uid': dynamic_settings['core__hub_uid'],
+                'hub_secret': dynamic_settings['core__hub_secret'],
+                'instance_uid': get_current_instance().uid,
+                'system_data': json.dumps(get_current_state()),
+                'wish': wish,
+            }
+        except Exception as e:
+            print(traceback.format_exc(), file=sys.stderr)
+            return {'status': 'error', 'result': f"Internal error: {e}"}
+        user = get_current_user()
+        if user:
+            request_data['current_user'] = UserSerializer(user, many=False).data
+        try:
+            response = requests.post(
+                'https://simo.io/hubs/ai-assist/scripts/', json=request_data
+            )
+        except:
+            return {'status': 'error', 'result': "Connection error"}
+
+        if response.status_code != 200:
+            content = response.content.decode()
+            if '<html' in content:
+                # Parse the HTML content
+                soup = BeautifulSoup(response.content, 'html.parser')
+                content = F"Server error {response.status_code}: {soup.title.string}"
+            return {'status': 'error', 'result': content}
+
+        return {'status': 'success', 'result': response.content.decode()}
+
 
 class PresenceLighting(Script):
     masters_only = False

simo/generic/forms.py

@@ -1,3 +1,4 @@
+import time
 from django import forms
 from django.forms import formset_factory
 from django.db.models import Q
@@ -35,11 +36,30 @@ class ScriptConfigForm(BaseComponentForm):
         initial=True, required=False,
         help_text="Restart the script if it fails. "
     )
-    code = forms.CharField(widget=PythonCode)
+    assistant_request = forms.CharField(
+        label="Request for AI assistant", required=False, max_length=1000,
+        widget=forms.Textarea(
+            attrs={'placeholder':
+                    "Close the blind and turn on the main light "
+                    "in my living room when it get's dark."
+            }
+        ),
+        help_text="Clearly describe in your own words what kind of automation "
+                  "you want to happen with this scenario script. <br>"
+                  "The more defined, exact and clear is your description the more "
+                  "accurate automation script SIMO.io AI assistanw will generate.<br>"
+                  "Use component, zone and category id's for best accuracy. <br>"
+                  "SIMO.io AI will re-generate your automation code, "                  
+                  "every time this field is changed. <br>"
+                  "Actual script code can only be edited via SIMO.io Admin.",
+    )
+    code = forms.CharField(widget=PythonCode, required=False)
     log = forms.CharField(
         widget=forms.HiddenInput, required=False
     )
 
+    app_exclude_fields = ('alarm_category', 'code', 'log')
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.basic_fields.extend(['autostart', 'keep_alive'])
@@ -47,19 +67,20 @@ class ScriptConfigForm(BaseComponentForm):
             prefix = get_script_prefix()
             if prefix == '/':
                 prefix = ''
-            self.fields['log'].widget = LogOutputWidget(
-                prefix + '/ws/log/%d/%d/' % (
-                    ContentType.objects.get_for_model(Component).id,
-                    self.instance.id
+            if 'log' in self.fields:
+                self.fields['log'].widget = LogOutputWidget(
+                    prefix + '/ws/log/%d/%d/' % (
+                        ContentType.objects.get_for_model(Component).id,
+                        self.instance.id
+                    )
                 )
-            )
 
     @classmethod
     def get_admin_fieldsets(cls, request, obj=None):
         base_fields = (
             'id', 'gateway', 'base_type', 'name', 'icon', 'zone', 'category',
             'show_in_app', 'autostart', 'keep_alive',
-            'code', 'control', 'log'
+            'assistant_request', 'code', 'control', 'log'
         )
 
         fieldsets = [
@@ -71,6 +92,36 @@ class ScriptConfigForm(BaseComponentForm):
         ]
         return fieldsets
 
+    def clean(self):
+        if self.cleaned_data.get('assistant_request'):
+            if self.instance.pk:
+                org = Component.objects.get(pk=self.instance.pk)
+                call_assistant = org.config.get('assistant_request') \
+                                 != self.cleaned_data['assistant_request']
+            else:
+                call_assistant = True
+            if call_assistant:
+                resp = self.instance.ai_assistant(
+                    self.cleaned_data['assistant_request'],
+                )
+                if resp['status'] == 'success':
+                    self.cleaned_data['code'] = resp['result']
+                    self.instance.config['code'] = resp['result']
+                elif resp['status'] == 'error':
+                    self.add_error('assistant_request', resp['result'])
+
+        return self.cleaned_data
+
+    def save(self, commit=True):
+        obj = super().save(commit)
+        if commit:
+            obj.controller.stop()
+            if self.cleaned_data.get('keep_alive') \
+            or self.cleaned_data.get('autostart'):
+                time.sleep(2)
+                obj.controller.start()
+        return obj
+
 
 class ConditionForm(forms.Form):
     component = forms.ModelChoiceField(
@@ -717,6 +768,19 @@ class StateSelectForm(BaseComponentForm):
     states = FormsetField(
         formset_factory(StateForm, can_delete=True, can_order=True, extra=0)
     )
+    is_main = forms.BooleanField(
+        initial=False, required=False,
+        help_text="Will be displayed in the app "
+                  "right top corner for quick access."
+    )
+
+    def save(self, commit=True):
+        if commit and self.cleaned_data['is_main']:
+            from .controllers import StateSelect
+            for c in Component.objects.filter(controller_uid=StateSelect.uid):
+                c.config['is_main'] = False
+                c.save()
+        return super().save(commit)
 
 
 class AlarmClockEventForm(forms.Form):

simo/generic/models.py

@@ -56,7 +56,6 @@ def handle_alarm_groups(sender, instance, *args, **kwargs):
                     )
                     from simo.notifications.utils import notify_users
                     notify_users(
-                        alarm_group_component.zone.instance,
                         'alarm', str(alarm_group_component), body,
                         component=alarm_group_component
                     )

simo/generic/scripting/__init__.py

@@ -0,0 +1,16 @@
+from .serializers import *
+from simo.core.models import Zone, Category, Component
+from simo.users.models import InstanceUser
+from simo.core.middleware import get_current_instance
+
+
+def get_current_state():
+    get_current_instance()
+    return {
+        'zones': ZoneSerializer(Zone.objects.all(), many=True).data,
+        'categories': CategorySerializer(Category.objects.all(), many=True).data,
+        'component': ComponentSerializer(Component.objects.all(), many=True).data,
+        'instanceusers': InstanceUserSerializer(
+            InstanceUser.objects.all(), many=True
+        ).data,
+    }

simo/generic/scripting/helpers.py

@@ -0,0 +1,35 @@
+from django.utils import timezone
+from suntime import Sun
+from simo.core.models import Instance
+
+
+class LocalSun(Sun):
+
+    def __init__(self, instance=None):
+        if not instance:
+            instance = Instance.objects.all().first()
+        coordinates = instance.location.split(',')
+        try:
+            lat = float(coordinates[0])
+        except:
+            lat = 0
+        try:
+            lon = float(coordinates[1])
+        except:
+            lon = 0
+        super().__init__(lat, lon)
+
+    def is_night(self):
+        if timezone.now() > self.get_sunset_time():
+            return True
+        if timezone.now() < self.get_sunrise_time():
+            return True
+        return False
+
+    def seconds_to_sunset(self):
+        return (self.get_sunset_time() - timezone.now()).total_seconds()
+
+    def seconds_to_sunrise(self):
+        return (self.get_sunrise_time() - timezone.now()).total_seconds()
+
+

simo/generic/scripting/serializers.py

@@ -0,0 +1,77 @@
+from rest_framework import serializers
+from simo.core.models import Zone, Category, Component
+from simo.users.models import User, InstanceUser, PermissionsRole
+
+
+class ZoneSerializer(serializers.ModelSerializer):
+    '''Zone serializer for AI scripts helper'''
+
+    class Meta:
+        model = Zone
+        fields = 'id', 'name'
+
+
+class CategorySerializer(serializers.ModelSerializer):
+    '''Category serializer for AI scripts helper'''
+
+    class Meta:
+        model = Category
+        fields = 'id', 'name'
+
+
+class ComponentSerializer(serializers.ModelSerializer):
+    '''Component serializer for AI scripts helper'''
+
+    MAX_LENGTH = 500
+
+    value = serializers.SerializerMethodField()
+    meta = serializers.SerializerMethodField()
+    config = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Component
+        fields = (
+            'id', 'name', 'icon', 'zone', 'category', 'base_type',
+            'value', 'value_units', 'meta', 'config'
+        )
+
+    def get_value(self, obj):
+        if obj.base_type in ('ip-camera', ):
+            return 'SKIP'
+        if len(str(obj.value)) > self.MAX_LENGTH:
+            return 'SKIP'
+        return obj.value
+
+    def get_meta(self, obj):
+        if len(str(obj.value)) > self.MAX_LENGTH:
+            return 'SKIP'
+        return obj.value
+
+    def get_config(self, obj):
+        if len(str(obj.value)) > self.MAX_LENGTH:
+            return 'SKIP'
+        return obj.value
+
+
+class UserSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = User
+        fields = 'email', 'name'
+
+
+class PermissionsRoleSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = PermissionsRole
+        fields = 'id', 'name', 'is_owner', 'is_superuser'
+
+
+class InstanceUserSerializer(serializers.ModelSerializer):
+    '''Role serializer for AI scripts helper'''
+    user = UserSerializer()
+    role = PermissionsRoleSerializer()
+
+    class Meta:
+        model = InstanceUser
+        fields = 'user', 'role',

simo/generic/templates/admin/controller_widgets/weather_forecast.html

@@ -3,11 +3,11 @@
        data-ws_url="{{ obj.get_socket_url|default_if_none:"" }}">
 <span style="
     width: 20px; height:20px;
-    background: url({% static 'weather_icons' %}/{{ obj.value.current.weather.0.icon }}@2x.png) center no-repeat;
+    background: url({% static 'weather_icons' %}/{{ obj.value.weather.0.icon }}@2x.png) center no-repeat;
     background-size: 150%;
     display: inline-block;
     position: relative;
     bottom: -4px;
 "></span>
- {{ obj.value.current.temp }}ᴼ {% if obj.zone.instance.units_of_measure == 'metric' %}C{% else %}F{% endif %}
+ {{ obj.value.temp }}ᴼ {% if obj.zone.instance.units_of_measure == 'metric' %}C{% else %}F{% endif %}
 </div>

simo/notifications/utils.py

@@ -1,8 +1,27 @@
-from simo.users.models import User
+from simo.core.middleware import get_current_instance
 from .models import Notification, UserNotification
 
 
-def notify_users(instance, severity, title, body=None, component=None, users=None):
+def notify_users(severity, title, body=None, component=None, instance_users=None, instance=None):
+    '''
+    Sends a notification to specified users with a given severity level and message details.
+    :param severity: One of: 'info', 'warning', 'alarm'
+    :param title: A short, descriptive title of the event.
+    :param body: (Optional) A more detailed description of the event.
+    :param component: (Optional) simo.core.Component linked to this event.
+    :param instance_users: List of instance users to receive this notification. All active instance users will receive the message if not specified.
+    :return:
+    '''
+    if not instance:
+        if component:
+            instance = component.zone.instance
+        else:
+            instance = get_current_instance()
+    if not instance:
+        return
+    if component and component.zone.instance != instance:
+        # something is completely wrong!
+        return
     assert severity in ('info', 'warning', 'alarm')
     notification = Notification.objects.create(
         instance=instance,
@@ -10,20 +29,19 @@ def notify_users(instance, severity, title, body=None, component=None, users=Non
         severity=severity, body=body,
         component=component
     )
-    if not users:
-        users = User.objects.filter(
-            instance_roles__instance=instance,
-            instance_roles__is_active=True
-        )
-    for user in users:
+    if not instance_users:
+        instance_users = instance.instance_users.filter(
+            is_active=True
+        ).select_related('user')
+    for iuser in instance_users:
         # do not send emails to system users
-        if user.email.endswith('simo.io'):
+        if iuser.user.email.endswith('simo.io'):
             continue
-        if instance not in user.instances:
+        if iuser.instance.id != instance.id:
             continue
-        if component and not component.can_write(user):
+        if component and not component.can_read(iuser.user):
             continue
         UserNotification.objects.create(
-            user=user, notification=notification,
+            user=iuser.user, notification=notification,
         )
     notification.dispatch()

simo/scripting.py

@@ -1,13 +1,13 @@
 from django.utils import timezone
 from suntime import Sun
-from simo.core.models import Instance
+from simo.core.middleware import get_current_instance
 
 
 class LocalSun(Sun):
 
     def __init__(self, instance=None):
         if not instance:
-            instance = Instance.objects.all().first()
+            instance = get_current_instance()
         coordinates = instance.location.split(',')
         try:
             lat = float(coordinates[0])

simo/users/api.py

@@ -4,17 +4,18 @@ from rest_framework import viewsets, mixins, status
 from rest_framework.serializers import Serializer
 from rest_framework.decorators import action
 from rest_framework.response import Response as RESTResponse
-from rest_framework.exceptions import ValidationError
+from rest_framework.exceptions import ValidationError, PermissionDenied
 from django.contrib.gis.geos import Point
 from django.utils import timezone
+from django_filters.rest_framework import DjangoFilterBackend
 from simo.core.api import InstanceMixin
 from .models import (
     User, UserDevice, UserDeviceReportLog, PermissionsRole, InstanceInvitation,
-    Fingerprint
+    Fingerprint, ComponentPermission, InstanceUser
 )
 from .serializers import (
     UserSerializer, PermissionsRoleSerializer, InstanceInvitationSerializer,
-    FingerprintSerializer
+    FingerprintSerializer, ComponentPermissionSerializer
 )
 
 
@@ -63,9 +64,6 @@ class UsersViewSet(mixins.RetrieveModelMixin,
                 request.data.pop(key)
 
 
-        target_user.set_instance(self.instance)
-
-
         serializer = self.get_serializer(
             target_user, data=request.data, partial=partial
         )
@@ -135,12 +133,38 @@ class RolesViewsets(InstanceMixin, viewsets.ReadOnlyModelViewSet):
     url = 'users/roles'
     basename = 'roles'
     serializer_class = PermissionsRoleSerializer
-    queryset = PermissionsRole.objects.all()
 
     def get_queryset(self):
         return PermissionsRole.objects.filter(instance=self.instance)
 
 
+class ComponentPermissionViewsets(
+    InstanceMixin,
+    mixins.RetrieveModelMixin, mixins.UpdateModelMixin,
+    mixins.ListModelMixin, viewsets.GenericViewSet
+):
+    url = 'users/componentpermissions'
+    basename = 'componentpermissions'
+    serializer_class = ComponentPermissionSerializer
+    filter_backends = [DjangoFilterBackend]
+    filterset_fields = ['component', 'role']
+
+    def get_queryset(self):
+        return ComponentPermission.objects.filter(role__instance=self.instance)
+
+    def update(self, request, *args, **kwargs):
+        if request.user.is_master:
+            return super().update(request, *args, **kwargs)
+        iuser = InstanceUser.objects.get(
+            instance=self.instance, user=request.user
+        ).select_related('role')
+        if not iuser.is_active:
+            raise PermissionDenied()
+        if iuser.role.is_owner or iuser.role.is_superuser:
+            return super().update(request, *args, **kwargs)
+        raise PermissionDenied()
+
+
 class UserDeviceReport(InstanceMixin, viewsets.GenericViewSet):
     url = 'users'
     basename = 'device_report'
@@ -188,6 +212,11 @@ class UserDeviceReport(InstanceMixin, viewsets.GenericViewSet):
             ).exclude(id=user_device.id).update(is_primary=False)
         user_device.save()
 
+        for iu in request.user.instance_roles.filter(is_active=True):
+            iu.last_seen_location = user_device.last_seen_location
+            iu.last_seen_location_datetime = user_device.last_seen
+            iu.save()
+
         request.user.last_seen_location = user_device.last_seen_location
         request.user.last_seen_location_datetime = user_device.last_seen
         request.user.save()

simo/users/managers.py

@@ -1,7 +1,11 @@
 from django.db import models
+from simo.core.middleware import get_current_instance
 
 
 class ActiveInstanceManager(models.Manager):
 
     def get_queryset(self):
-        return super().get_queryset().filter(instance__is_active=True)
+        instance = get_current_instance()
+        return super().get_queryset().filter(
+            instance__is_active=True, instance=instance
+        )

simo/users/migrations/0033_alter_user_ssh_key.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.10 on 2024-10-09 09:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('users', '0032_remove_userdevice_user_alter_userdevice_users'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='user',
+            name='ssh_key',
+            field=models.TextField(blank=True, help_text='Will be placed in /root/.ssh/authorized_keys if user is active and is master of a hub.', null=True),
+        ),
+    ]

simo/users/migrations/0034_instanceuser_last_seen_location_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.2.10 on 2024-10-18 08:00
+
+from django.db import migrations, models
+import location_field.models.plain
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('users', '0033_alter_user_ssh_key'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='instanceuser',
+            name='last_seen_location',
+            field=location_field.models.plain.PlainLocationField(blank=True, help_text='Sent by user mobile app', max_length=63, null=True),
+        ),
+        migrations.AddField(
+            model_name='instanceuser',
+            name='last_seen_location_datetime',
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+    ]