simo 2.5.41__py3-none-any.whl → 2.6.2__py3-none-any.whl

simo/core/signal_receivers.py

@@ -76,6 +76,9 @@ def create_instance_defaults(sender, instance, created, **kwargs):
     dummy, new = Gateway.objects.get_or_create(
         type='simo.generic.gateways.DummyGatewayHandler'
     )
+    automation, new = Gateway.objects.get_or_create(
+        type='simo.automation.gateways.AutomationsGatewayHandler'
+    )
     weather_icon = Icon.objects.get(slug='cloud-bolt-sun')
 
     Component.objects.create(
@@ -95,9 +98,23 @@ def create_instance_defaults(sender, instance, created, **kwargs):
         controller_uid='simo.generic.controllers.StateSelect',
         value='day',
         config={"states": [
-            {"icon": "house-day", "name": "Day", "slug": "day"},
-            {"icon": "house-night", "name": "Evening", "slug": "evening"},
-            {"icon": "moon-cloud", "name": "Night", "slug": "night"},
+            {
+                "icon": "sunrise", "name": "Morning", "slug": "morning",
+                'help_text': "6:00 AM to sunrise. Activates only in dark time of a year."
+            },
+            {
+                "icon": "house-day", "name": "Day", "slug": "day",
+                'help_text': "From sunrise to sunset."
+            },
+            {
+                "icon": "house-night", "name": "Evening", "slug": "evening",
+                'help_text': "From sunrise to midnight"
+            },
+            {
+                "icon": "moon-cloud", "name": "Night", "slug": "night",
+                'help_text': "From midnight to sunrise or 6:00 AM."
+            },
+            {"icon": "snooze", "name": "Sleep time", "slug": "sleep"},
             {"icon": "house-person-leave", "name": "Away", "slug": "away"},
             {"icon": "island-tropical", "name": "Vacation", "slug": "vacation"}
         ], "is_main": True}
@@ -105,45 +122,61 @@ def create_instance_defaults(sender, instance, created, **kwargs):
 
 
     auto_state_code = render_to_string(
-        'core/auto_state_script.py', {'state_comp_id': state_comp.id}
+        'automations/auto_state_script.py', {'state_comp_id': state_comp.id}
     )
     Component.objects.create(
         name='Auto state', icon=Icon.objects.get(slug='bolt'),
         zone=other_zone,
         category=other_category, show_in_app=False,
-        gateway=generic, base_type='script',
-        controller_uid='simo.generic.controllers.Script',
+        gateway=automation, base_type='script',
+        controller_uid='simo.automation.controllers.Script',
         config={
             "code": auto_state_code, 'autostart': True, 'keep_alive': True,
             "notes": f"""
-            The script automatically controls the states of the "State" component (ID:{state_comp.id}) — 'day,' 'evening,' 'night,' 'away.'
-            The 'day' state is activated on weekdays from 10 a.m., and on weekends from 11 a.m. When the sun sets, the 'evening' state is activated, and at midnight, the 'night' state is activated.            
-            If no one is home, the 'away' state is activated.            
-            If a different state, such as 'vacation,' is selected, the script stops running and waits until the State is switched back to one of the controlled states.            
-            If one of the controlled states is manually selected, the script waits until that state is reached automatically and, once aligned with the manually set state, resumes its operation in normal mode.
+            The script automatically controls the states of the "State" component (ID:{state_comp.id}) — 'morning', 'day', 'evening', 'night'. 
+            
             """
         }
     )
 
     code = render_to_string(
-        'core/auto_night_day_script.py', {'state_comp_id': state_comp.id}
+        'automations/phones_sleep_script.py', {'state_comp_id': state_comp.id}
     )
     Component.objects.create(
-        name='Auto night/day by owner phones on charge',
+        name='Sleep mode when owner phones are charge',
         icon=Icon.objects.get(slug='bolt'), zone=other_zone,
         category=other_category, show_in_app=False,
-        gateway=generic, base_type='script',
-        controller_uid='simo.generic.controllers.Script',
+        gateway=automation, base_type='script',
+        controller_uid='simo.automation.controllers.Script',
         config={
             "code": code, 'autostart': True, 'keep_alive': True,
             "notes": f"""
-Automatically sets State component (ID: {state_comp.id}) to "night" if it is later than 10pm and all home owners phones who are at home are put on charge.
-Sets State component to "day" state as soon as none of the home owners phones are on charge and it is 6am or later. 
+Automatically sets State component (ID: {state_comp.id}) to "Sleep" if it is later than 10pm and all home owners phones who are at home are put on charge.
+Sets State component back to regular state as soon as none of the home owners phones are on charge and it is 6am or later. 
 
 """
         }
     )
 
+    code = render_to_string(
+        'automations/auto_away.py', {'state_comp_id': state_comp.id}
+    )
+    Component.objects.create(
+        name='Auto Away State',
+        icon=Icon.objects.get(slug='bolt'), zone=other_zone,
+        category=other_category, show_in_app=False,
+        gateway=automation, base_type='script',
+        controller_uid='simo.automation.controllers.Script',
+        config={
+            "code": code, 'autostart': True, 'keep_alive': True,
+            "notes": f"""
+    Automatically set mode to "Away" there are no users at home and there was no motion for more than 30 seconds.
+    Set it back to a regular mode as soon as somebody comes back home or motion is detected.
+
+    """
+        }
+    )
+
     # Create default User permission roles
 
     PermissionsRole.objects.create(

simo/core/utils/type_constants.py

@@ -51,7 +51,7 @@ CONTROLLER_TYPES_MAP = get_controller_types_map()
 def get_controller_types_choices(gateway=None):
     choices = []
     for controller_cls in get_controller_types_map(gateway).values():
-        choices.append((controller_cls.uid, controller_cls.name))
+        choices.append((controller_cls.uid, f"{controller_cls.gateway_class.name} | {controller_cls.name}"))
     return choices
 
 

simo/fleet/api.py

@@ -1,6 +1,7 @@
 from django.db.models import Count
 from django.utils.translation import gettext_lazy as _
 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 simo.core.api import InstanceMixin
@@ -37,6 +38,7 @@ class ColonelsViewSet(InstanceMixin, viewsets.ModelViewSet):
     def check_for_upgrade(self, request, pk=None, *args, **kwargs):
         colonel = self.get_object()
         colonel.check_for_upgrade()
+        return RESTResponse({'status': 'success'})
 
     @action(detail=True, methods=['post'])
     def upgrade(self, request, pk=None, *args, **kwargs):
@@ -45,16 +47,19 @@ class ColonelsViewSet(InstanceMixin, viewsets.ModelViewSet):
             colonel.update_firmware(colonel.major_upgrade_available)
         elif colonel.minor_upgrade_available:
             colonel.update_firmware(colonel.minor_upgrade_available)
+        return RESTResponse({'status': 'success'})
 
     @action(detail=True, methods=['post'])
     def restart(self, request, pk=None, *args, **kwargs):
         colonel = self.get_object()
         colonel.restart()
+        return RESTResponse({'status': 'success'})
 
     @action(detail=True, methods=['post'])
     def update_config(self, request, pk=None, *args, **kwargs):
         colonel = self.get_object()
         colonel.update_config()
+        return RESTResponse({'status': 'success'})
 
     @action(detail=True, methods=['post'])
     def move_to(self, request, pk, *args, **kwargs):
@@ -68,6 +73,7 @@ class ColonelsViewSet(InstanceMixin, viewsets.ModelViewSet):
         if not target:
             raise APIValidationError(_('Invalid target.'), code=400)
         colonel.move_to(target)
+        return RESTResponse({'status': 'success'})
 
 
 class InterfaceViewSet(

simo/fleet/controllers.py

@@ -661,6 +661,7 @@ class TTLock(FleeDeviceMixin, Lock):
         self.component.save(update_fields=['meta'])
 
 
+
 class DALIDevice(FleeDeviceMixin, ControllerBase):
     gateway_class = FleetGatewayHandler
     config_form = DALIDeviceConfigForm

simo/fleet/forms.py

@@ -1459,6 +1459,18 @@ class TTLockConfigForm(ColonelComponentForm):
         ), required=False,
         help_text="Quickens up lock status reporting on open/close if provided."
     )
+    auto_lock = forms.IntegerField(
+        min_value=0, max_value=60, required=False,
+        help_text="Lock the lock after given amount of seconds."
+    )
+    inverse = forms.BooleanField(
+        required=False,
+        help_text="Inverse operation (if supported by the lock)."
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.basic_fields.extend(['auto_lock', 'inverse'])
 
     def clean(self):
         if not self.instance or not self.instance.pk:
@@ -1475,10 +1487,17 @@ class TTLockConfigForm(ColonelComponentForm):
 
     def save(self, commit=True):
         obj = super(ColonelComponentForm, self).save(commit)
-        if commit and 'door_sensor' in self.cleaned_data:
+        if commit:
+            if 'door_sensor' in self.cleaned_data:
+                GatewayObjectCommand(
+                    self.instance.gateway, self.cleaned_data['door_sensor'],
+                    command='watch_lock_sensor'
+                ).publish()
             GatewayObjectCommand(
-                self.instance.gateway, self.cleaned_data['door_sensor'],
-                command='watch_lock_sensor'
+                obj.gateway, self.cleaned_data['colonel'], id=obj.id,
+                command='call', method='update_config', args=[
+                    obj.controller._get_colonel_config()
+                ]
             ).publish()
         return obj
 

simo/fleet/serializers.py

@@ -1,4 +1,5 @@
 from rest_framework import serializers
+from simo.core.serializers import TimestampField
 from .models import InstanceOptions, Colonel, ColonelPin, Interface
 
 
@@ -43,6 +44,8 @@ class ColonelSerializer(serializers.ModelSerializer):
     pins = serializers.SerializerMethodField()
     interfaces = serializers.SerializerMethodField()
     newer_firmware_available = serializers.SerializerMethodField()
+    last_seen = TimestampField()
+    is_empty = serializers.SerializerMethodField()
 
     class Meta:
         model = Colonel
@@ -51,10 +54,12 @@ class ColonelSerializer(serializers.ModelSerializer):
             'firmware_version', 'firmware_auto_update',
             'newer_firmware_available',
             'socket_connected', 'last_seen', 'pins', 'interfaces',
+            'is_empty'
         )
         read_only_fields = [
             'uid', 'type', 'firmware_version', 'newer_firmware_available',
-            'socket_connected', 'last_seen', 'pins', 'interfaces'
+            'socket_connected', 'last_seen', 'pins', 'interfaces',
+            'is_empty'
         ]
 
     def get_pins(self, obj):
@@ -72,6 +77,9 @@ class ColonelSerializer(serializers.ModelSerializer):
     def get_newer_firmware_available(self, obj):
         return obj.newer_firmware_available()
 
+    def get_is_empty(self, obj):
+        return not bool(obj.components.all().count())
+
     def update(self, instance, validated_data):
         instance = super().update(instance, validated_data)
         instance.update_config()

simo/generic/app_widgets.py

@@ -2,12 +2,6 @@ from django.utils.translation import gettext_lazy as _
 from simo.core.app_widgets import BaseAppWidget
 
 
-class ScriptWidget(BaseAppWidget):
-    uid = 'script'
-    name = _("Script")
-    size = [2, 1]
-
-
 class ThermostatWidget(BaseAppWidget):
     uid = 'thermostat'
     name = _("Thermostat")

simo/generic/controllers.py

@@ -1,31 +1,21 @@
-import time
-import threading
 import pytz
 import datetime
 import json
-import requests
-import traceback
-import sys
-import random
-from bs4 import BeautifulSoup
 from django.core.exceptions import ValidationError
 from django.utils import timezone
 from django.utils.functional import cached_property
 from django.utils.translation import gettext_lazy as _
 from django.conf import settings
 from django.urls import reverse_lazy
-from simo.conf import dynamic_settings
 from simo.users.middleware import get_current_user, introduce
 from simo.users.utils import get_system_user
-from simo.core.events import GatewayObjectCommand
-from simo.core.models import RUN_STATUS_CHOICES_MAP, Component
+from simo.core.models import 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,
+    BEFORE_SEND, ControllerBase,
     BinarySensor, NumericSensor, MultiSensor, Switch, Dimmer, DimmerPlus,
-    RGBWLight, TimerMixin,
+    RGBWLight,
     DoubleSwitch, TripleSwitch, QuadrupleSwitch, QuintupleSwitch
 )
 from simo.core.utils.config_values import (
@@ -37,265 +27,19 @@ from simo.core.utils.config_values import (
 )
 from .gateways import GenericGatewayHandler, DummyGatewayHandler
 from .app_widgets import (
-    ScriptWidget, ThermostatWidget, AlarmGroupWidget, IPCameraWidget,
+    ThermostatWidget, AlarmGroupWidget, IPCameraWidget,
     WateringWidget, StateSelectWidget, AlarmClockWidget,
     WeatherWidget
 )
 from .forms import (
-    ScriptConfigForm, PresenceLightingConfigForm,
     ThermostatConfigForm, AlarmGroupConfigForm,
     IPCameraConfigForm, WeatherForm,
     WateringConfigForm, StateSelectForm,
     AlarmClockConfigForm
 )
-from .scripting import get_current_state
-from .scripting.serializers import UserSerializer
 
 # ----------- Generic controllers -----------------------------
 
-
-class Script(ControllerBase, TimerMixin):
-    name = _("AI Script")
-    base_type = 'script'
-    gateway_class = GenericGatewayHandler
-    app_widget = ScriptWidget
-    config_form = ScriptConfigForm
-    admin_widget_template = 'admin/controller_widgets/script.html'
-    default_config = {'autostart': True, 'autorestart': True}
-    default_value = 'stopped'
-
-    def _validate_val(self, value, occasion=None):
-        if occasion == BEFORE_SEND:
-            if value not in ('start', 'stop'):
-                raise ValidationError("Must be 'start' or 'stop'")
-        elif occasion == BEFORE_SET:
-            if value not in RUN_STATUS_CHOICES_MAP.keys():
-                raise ValidationError(
-                    "Invalid script controller status!"
-                )
-        return value
-
-    def _prepare_for_send(self, value):
-        if value == 'start':
-            new_code = getattr(self.component, 'new_code', None)
-            if new_code:
-                self.component.new_code = None
-                self.component.refresh_from_db()
-                self.component.config['code'] = new_code
-                self.component.save(update_fields=['config'])
-        return value
-
-    def _val_to_success(self, value):
-        if value == 'start':
-            return 'running'
-        else:
-            return 'stopped'
-
-    def start(self, new_code=None):
-        if new_code:
-            self.component.new_code = new_code
-        self.send('start')
-
-    def play(self):
-        return self.start()
-
-    def stop(self):
-        self.send('stop')
-
-    def toggle(self):
-        self.component.refresh_from_db()
-        if self.component.value == 'running':
-            self.send('stop')
-        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.json()['script'],
-            'description': response.json()['description']
-        }
-
-
-class PresenceLighting(Script):
-    masters_only = False
-    name = _("Presence lighting")
-    config_form = PresenceLightingConfigForm
-
-    # script specific variables
-    sensors = {}
-    condition_comps = {}
-    light_org_values = {}
-    is_on = False
-    turn_off_task = None
-    last_presence = 0
-    hold_time = 60
-    conditions = []
-
-    def _run(self):
-        self.hold_time = self.component.config.get('hold_time', 0) * 10
-        for id in self.component.config['presence_sensors']:
-            sensor = Component.objects.filter(id=id).first()
-            if sensor:
-                sensor.on_change(self._on_sensor)
-                self.sensors[id] = sensor
-
-        if self.component.config['off_value'] != 0:
-            for id in self.component.config['lights']:
-                light = Component.objects.filter(id=id).first()
-                if not light or not light.controller:
-                    continue
-                light.on_change(self._on_light_change)
-
-        for condition in self.component.config.get('conditions', []):
-            comp = Component.objects.filter(
-                id=condition.get('component', 0)
-            ).first()
-            if comp:
-                condition['component'] = comp
-                self.conditions.append(condition)
-                comp.on_change(self._on_condition)
-                self.condition_comps[comp.id] = comp
-
-        while True:
-            self._regulate(on_val_change=False)
-            time.sleep(random.randint(5, 15))
-
-    def _on_sensor(self, sensor=None):
-        if sensor:
-            self.sensors[sensor.id] = sensor
-            self._regulate()
-
-    def _on_condition(self, condition_comp=None):
-        if condition_comp:
-            for condition in self.conditions:
-                if condition['component'].id == condition_comp.id:
-                    condition['component'] = condition_comp
-            self._regulate()
-
-
-    def _on_light_change(self, light):
-        if self.is_on:
-            self.light_org_values[light.id] = light.value
-
-
-    def _regulate(self, on_val_change=True):
-        presence_values = [s.value for id, s in self.sensors.items()]
-        if self.component.config.get('act_on', 0) == 0:
-            must_on = any(presence_values)
-        else:
-            must_on = all(presence_values)
-
-        if must_on and on_val_change:
-            print("Presence detected!")
-
-        additional_conditions_met = True
-        for condition in self.conditions:
-
-            comp = condition['component']
-
-            op = OPERATIONS.get(condition.get('op'))
-            if not op:
-                continue
-
-            if condition['op'] == 'in':
-                if comp.value not in self._string_to_vals(condition['value']):
-                    if must_on and on_val_change:
-                        print(
-                            f"Condition not met: [{comp} value:{comp.value} "
-                            f"{condition['op']} {condition['value']}]"
-                        )
-                    additional_conditions_met = False
-                    break
-
-            if not op(comp.value, condition['value']):
-                if must_on and on_val_change:
-                    print(
-                        f"Condition not met: [{comp} value:{comp.value} "
-                        f"{condition['op']} {condition['value']}]"
-                    )
-                additional_conditions_met = False
-                break
-
-        if must_on and additional_conditions_met and not self.is_on:
-            print("Turn the lights ON!")
-            self.is_on = True
-            self.light_org_values = {}
-            for id in self.component.config['lights']:
-                comp = Component.objects.filter(id=id).first()
-                if not comp or not comp.controller:
-                    continue
-                self.light_org_values[comp.id] = comp.value
-                comp.controller.send(self.component.config['on_value'])
-            return
-
-        if self.is_on:
-            if not additional_conditions_met:
-                return self._turn_it_off()
-            if not any(presence_values):
-                if not self.component.config.get('hold_time', 0):
-                    return self._turn_it_off()
-
-                if not self.last_presence:
-                    self.last_presence = time.time()
-
-                if self.hold_time and (
-                    time.time() - self.hold_time > self.last_presence
-                ):
-                    self._turn_it_off()
-
-
-    def _turn_it_off(self):
-        print("Turn the lights OFF!")
-        self.is_on = False
-        self.last_presence = 0
-        for id in self.component.config['lights']:
-            comp = Component.objects.filter(id=id).first()
-            if not comp or not comp.controller:
-                continue
-            if self.component.config['off_value'] == 0:
-                comp.send(0)
-            else:
-                comp.send(self.light_org_values.get(comp.id, 0))
-
-
-# TODO: Night lighting
-#
-# Lights: components (switches, dimmers)
-# On value: 40
-# Sunset offset (mins): negative = earlier, positive = later
-# Save energy at night: 1 - 6 turn the lights completely off at night.
-
-
 class Thermostat(ControllerBase):
     name = _("Thermostat")
     base_type = 'thermostat'