simo 2.6.9__py3-none-any.whl → 2.7.1__py3-none-any.whl

simo/core/utils/converters.py

@@ -0,0 +1,59 @@
+import re
+
+
+def input_to_meters(distance: str) -> float:
+    """
+    Converts a distance string to meters based on the units provided.
+
+    Args:
+        distance (str): A string containing a numerical value and a unit (e.g., "10 meters", "32ft.").
+
+    Returns:
+        float: The distance converted to meters.
+
+    Raises:
+        ValueError: If the unit of measurement is not specified or is invalid.
+    """
+    # Dictionary to map units to conversion factors (to meters)
+    unit_conversions = {
+        "meters": 1.0,
+        "meter": 1.0,
+        "m": 1.0,
+        "feet": 0.3048,
+        "foot": 0.3048,
+        "ft": 0.3048,
+        "kilometers": 1000.0,
+        "kilometer": 1000.0,
+        "km": 1000.0,
+        "inches": 0.0254,
+        "inch": 0.0254,
+        "in": 0.0254
+    }
+
+    # Normalize the input: remove trailing dots and extra spaces, and lowercase
+    distance = distance.strip().rstrip('.').lower()
+
+    # Regular expression to handle both spaced and unspaced inputs
+    match = re.match(r"^([\d\.]+)\s*([a-z]+)$", distance)
+
+    if not match:
+        raise ValueError(
+            "Please specify a numerical value followed by a valid unit of measure (e.g., '10 meters', '32ft').")
+
+    # Extract the numerical part and the unit part
+    value_str, unit = match.groups()
+
+    try:
+        value = float(value_str)  # Convert the numerical part to a float
+    except ValueError:
+        raise ValueError("The distance value must be a valid number.")
+
+    # Check if the unit is valid
+    if unit not in unit_conversions:
+        raise ValueError(
+            f"Invalid unit of measure '{unit}'. Valid units are: {', '.join(unit_conversions.keys())}.")
+
+    # Convert the value to meters
+    return value * unit_conversions[unit]
+
+

simo/fleet/auto_urls.py

@@ -1,6 +1,7 @@
 from django.urls import path, re_path
 from .views import (
     colonels_ping,
+    ColonelsAutocomplete,
     PinsSelectAutocomplete,
     InterfaceSelectAutocomplete,
     ControlInputSelectAutocomplete
@@ -10,6 +11,10 @@ urlpatterns = [
     re_path(
         r"^colonels-ping/$", colonels_ping, name='colonels-ping'
     ),
+    path(
+        'autocomplete-colonels',
+        ColonelsAutocomplete.as_view(), name='autocomplete-colonels'
+    ),
     path(
         'autocomplete-colonel-pins',
         PinsSelectAutocomplete.as_view(), name='autocomplete-colonel-pins'

simo/fleet/forms.py

@@ -11,15 +11,19 @@ from simo.core.forms import (
     BaseComponentForm, ValueLimitForm, NumericSensorForm
 )
 from simo.core.utils.formsets import FormsetField
+from simo.core.utils.converters import input_to_meters
 from simo.core.widgets import LogOutputWidget
 from simo.core.utils.easing import EASING_CHOICES
 from simo.core.utils.validators import validate_slaves
 from simo.core.utils.admin import AdminFormActionForm
 from simo.core.events import GatewayObjectCommand
+from simo.core.middleware import get_current_instance
 from simo.core.form_fields import (
     Select2ModelChoiceField, Select2ListChoiceField,
     Select2ModelMultipleChoiceField
 )
+from simo.core.form_fields import PlainLocationField
+from simo.users.models import PermissionsRole
 from .models import Colonel, ColonelPin, Interface
 from .utils import INTERFACES_PINS_MAP, get_all_control_input_choices
 
@@ -88,8 +92,9 @@ class InterfaceAdminForm(forms.ModelForm):
 
 
 class ColonelComponentForm(BaseComponentForm):
-    colonel = forms.ModelChoiceField(
-        label="Colonel", queryset=Colonel.objects.all()
+    colonel = Select2ModelChoiceField(
+        label="Colonel", queryset=Colonel.objects.all(),
+        url='autocomplete-colonels',
     )
 
     def clean_colonel(self):
@@ -1316,7 +1321,6 @@ class GateConfigForm(ColonelComponentForm):
                   "when your gate is in closed position?"
     )
 
-
     open_duration = forms.FloatField(
         initial=30, min_value=1, max_value=600,
         help_text="How much time in seconds does it take for your gate "
@@ -1329,9 +1333,53 @@ class GateConfigForm(ColonelComponentForm):
         )
     )
 
+    auto_open_distance = forms.CharField(
+        initial='100 m', required=False,
+        help_text="Open the gate automatically whenever somebody is coming home"
+                  "and comes closer than this distance. Clear this value out, "
+                  "to disable auto opening."
+    )
+    auto_open_for = Select2ModelMultipleChoiceField(
+        queryset=PermissionsRole.objects.all(),
+        url='autocomplete-user-roles',  required=False,
+        help_text="Open the gates automatically only for these user roles. "
+                  "Leaving this field blank opens the gate for all system users."
+    )
+    location = PlainLocationField(
+        zoom=18,
+        help_text="Location of your gate. Required only for automatic opening. "
+                  "Adjust this if this gate is significantly distanced from "
+                  "your actual home location."
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if not self.fields['location'].initial:
+            self.fields['location'].initial = get_current_instance().location
+
+    def clean_distance(self):
+        distance = self.cleaned_data.get('auto_open_distance')
+        if not distance:
+            return distance
+        try:
+            distance = input_to_meters(distance)
+        except Exception as e:
+            raise forms.ValidationError(str(e))
+
+        if distance < 20:
+            raise forms.ValidationError(
+                "That is to little of a distance. At least 20 meters is required."
+            )
+        if distance > 2000:
+            raise forms.ValidationError(
+                "This is to high of a distance. Max 2 km is allowed."
+            )
+
+        return distance
+
+
     def clean(self):
         super().clean()
-
         check_pins = ('open_pin', 'close_pin', 'sensor_pin')
         for pin in check_pins:
             if not self.cleaned_data.get(pin):

simo/fleet/views.py

@@ -11,11 +11,33 @@ def colonels_ping(request):
     return HttpResponse('pong')
 
 
+class ColonelsAutocomplete(autocomplete.Select2QuerySetView):
+
+    def get_queryset(self):
+        if not self.request.user.is_authenticated:
+            raise Http404()
+
+        instance = get_current_instance(self.request)
+        if not instance:
+            return Colonel.objects.none()
+
+        qs = Colonel.objects.filter(instance=instance)
+
+        if self.request.GET.get('value'):
+            qs = qs.filter(pk__in=self.request.GET['value'].split(','))
+        elif self.q:
+            qs = search_queryset(qs, self.q, ('name', ))
+        return qs
+
+
 class PinsSelectAutocomplete(autocomplete.Select2QuerySetView):
 
     def get_queryset(self):
 
-        instance = get_current_instance()
+        if not self.request.user.is_authenticated:
+            raise Http404()
+
+        instance = get_current_instance(self.request)
         if not instance:
             return ColonelPin.objects.none()
 
@@ -52,10 +74,13 @@ class PinsSelectAutocomplete(autocomplete.Select2QuerySetView):
 class InterfaceSelectAutocomplete(autocomplete.Select2QuerySetView):
 
     def get_queryset(self):
+        if not self.request.user.is_authenticated:
+            raise Http404()
 
         try:
             colonel = Colonel.objects.get(
-                pk=self.forwarded.get("colonel")
+                pk=self.forwarded.get("colonel"),
+                instance=get_current_instance(self.request)
             )
         except:
             return Interface.objects.none()
@@ -73,14 +98,19 @@ class InterfaceSelectAutocomplete(autocomplete.Select2QuerySetView):
 class ControlInputSelectAutocomplete(autocomplete.Select2ListView):
 
     def get_list(self):
+        if not self.request.user.is_authenticated:
+            raise Http404()
 
         try:
             colonel = Colonel.objects.get(
-                pk=self.forwarded.get("colonel")
+                pk=self.forwarded.get("colonel"),
+                instance=get_current_instance(self.request)
             )
             pins_qs = ColonelPin.objects.filter(colonel=colonel)
         except:
-            pins_qs = ColonelPin.objects.all()
+            pins_qs = ColonelPin.objects.filter(
+                colonel__instance=get_current_instance(self.request)
+            )
 
         if self.forwarded.get('self') and self.forwarded['self'].startswith('pin-'):
             pins_qs = pins_qs.filter(
@@ -93,7 +123,7 @@ class ControlInputSelectAutocomplete(autocomplete.Select2ListView):
             pins_qs = pins_qs.filter(**self.forwarded.get('pin_filters'))
 
         buttons_qs = Component.objects.filter(
-            base_type='button'
+            base_type='button', zone__instance=get_current_instance(self.request)
         ).select_related('zone')
 
         if self.forwarded.get('button_filters'):
@@ -126,4 +156,5 @@ class ControlInputSelectAutocomplete(autocomplete.Select2ListView):
                [(f'button-{button.id}',
                  f"{button.zone.name} | {button.name}"
                  if button.zone else button.name)
-                for button in buttons_qs]
+                for button in buttons_qs]
+

simo/generic/controllers.py

@@ -1,6 +1,7 @@
 import pytz
 import datetime
 import json
+import time
 from django.core.exceptions import ValidationError
 from django.utils import timezone
 from django.utils.functional import cached_property
@@ -34,12 +35,15 @@ from .app_widgets import (
 from .forms import (
     ThermostatConfigForm, AlarmGroupConfigForm,
     IPCameraConfigForm, WeatherForm,
-    WateringConfigForm, StateSelectForm,
+    WateringConfigForm, StateSelectForm, MainStateSelectForm,
     AlarmClockConfigForm
 )
 
 # ----------- Generic controllers -----------------------------
 
+
+
+
 class Thermostat(ControllerBase):
     name = _("Thermostat")
     base_type = 'thermostat'
@@ -319,6 +323,7 @@ class Weather(ControllerBase):
     admin_widget_template = 'admin/controller_widgets/weather.html'
     default_config = {}
     default_value = {}
+    manual_add = False
 
     def _validate_val(self, value, occasion=None):
         return value
@@ -1054,6 +1059,120 @@ class StateSelect(ControllerBase):
         return value
 
 
+class MainState(StateSelect):
+    name = _("Main State")
+    config_form = MainStateSelectForm
+    default_value = 'day'
+
+    default_config = {
+        'is_main': True,
+        'weekdays_morning_hour': 6,
+        'weekends_morning_hour': 7,
+        'away_on_no_action': 30,
+        'sleeping_phones_hour': 21,
+        'states': [
+            {
+                "icon": "sunrise", "name": "Morning", "slug": "morning",
+                'help_text': "Morning hour to sunrise. Activates 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 static morning hour."
+            },
+            {"icon": "snooze", "name": "Sleep time", "slug": "sleep"},
+            {"icon": "house-person-leave", "name": "Away", "slug": "away"},
+            {"icon": "island-tropical", "name": "Vacation", "slug": "vacation"}
+        ]
+    }
+
+    def get_day_evening_night_morning(self):
+        from simo.automation.helpers import LocalSun
+        sun = LocalSun(self.component.zone.instance.location)
+        timezone.activate(self.component.zone.instance.timezone)
+        localtime = timezone.localtime()
+
+        # It is daytime if the sun is up!
+        if not sun.is_night():
+            return 'day'
+
+        # it is evening if the sun is down at the evening
+        if sun.get_sunset_time(localtime) < localtime:
+            return 'evening'
+
+        if localtime.weekday() < 5:
+            if localtime.hour >= self.component.config['weekdays_morning_hour']:
+                return 'morning'
+        else:
+            if localtime.hour >= self.component.config['weekends_morning_hour']:
+                return 'morning'
+
+        # 0 - 6AM and still dark
+        return 'night'
+
+
+    def check_is_away(self, last_sensor_action):
+        away_on_no_action = not self.component.config.get('away_on_no_action')
+        if not away_on_no_action:
+            return False
+        from simo.users.models import InstanceUser
+        if InstanceUser.objects.filter(
+            is_active=True, at_home=True, instance=self.component.zone.instance
+        ).count():
+            return False
+
+        return (time.time() - last_sensor_action) // 60 >= away_on_no_action
+
+
+    def is_sleep_time(self):
+        timezone.activate(self.component.zone.instance.timezone)
+        localtime = timezone.localtime()
+        if localtime.weekday() < 5:
+            if localtime.hour < self.component.config['weekdays_morning_hour']:
+                return True
+        else:
+            if localtime.hour < self.component.config['weekends_morning_hour']:
+                return True
+        sleeping_phones_hour = self.component.config.get(
+            'sleeping_phones_hour'
+        )
+        if localtime.hour >= sleeping_phones_hour:
+            return True
+
+        return False
+
+
+    def owner_phones_on_sleep(self):
+        sleeping_phones_hour = self.component.config.get('sleeping_phones_hour')
+        if sleeping_phones_hour is not None:
+            return False
+
+        if not self.is_sleep_time():
+            return False
+
+        from simo.users.models import InstanceUser
+
+        for iuser in InstanceUser.objects.filter(
+            is_active=True, role__is_owner=True,
+            instance=self.component.zone.instance
+        ):
+            # skipping users that are not at home
+            if not iuser.at_home:
+                continue
+            if not iuser.phone_on_charge:
+                # at least one user's phone is not yet on charge
+                return False
+
+        return True
+
+
 # ----------- Dummy controllers -----------------------------
 
 class DummyBinarySensor(BinarySensor):

simo/generic/forms.py

@@ -425,21 +425,89 @@ 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."
+
+
+class MainStateSelectForm(BaseComponentForm):
+    weekdays_morning_hour = forms.IntegerField(
+        initial=6, min_value=3, max_value=12
+    )
+    weekends_morning_hour = forms.IntegerField(
+        initial=6, min_value=3, max_value=12
+    )
+    away_on_no_action = forms.IntegerField(
+        required=False, initial=40, min_value=1, max_value=360,
+        help_text="Set state to Away if nobody is at home "
+                  "(requires location and fitness permissions on mobile app) "
+                  "and there were "
+                  "no action for more than given amount of minutes from any "
+                  "security alarm acategory sensors (motion sensors, door sensors etc..).<br>"
+                  "No value disables this behavior."
+    )
+    sleeping_phones_hour = forms.IntegerField(
+        initial=True, required=False, min_value=18, max_value=24,
+        help_text='Set mode to "Sleep" if it is later than given hour '
+                  'and all home owners phones who are at home are put on charge '
+                  '(requires location and fitness permissions on mobile app). <br>'
+                  'Set back to regular state as soon as none of the home owners phones '
+                  'are on charge and it is morning hour or past it.'
     )
+    states = FormsetField(
+        formset_factory(StateForm, can_delete=True, can_order=True, extra=0)
+    )
+
+    def clean(self):
+        if not self.instance.id:
+            if Component.objects.filter(
+                controller_uid='simo.generic.controllers.MainState'
+            ).count():
+                raise forms.ValidationError("Main state already exists!")
+
+        formset_errors = {}
+        required_states = {
+            'morning', 'day', 'evening', 'night', 'sleep', 'away', 'vacation'
+        }
+        found_states = set()
+        for i, state in enumerate(self.cleaned_data.get('states', [])):
+            if state.get('slug') in found_states:
+                formset_errors['i'] = {'slug': "Duplicate!"}
+                continue
+            found_states.add(state.get('slug'))
+
+        errors_list = []
+        if formset_errors:
+            for i, control in enumerate(self.cleaned_data['states']):
+                errors_list.append(formset_errors.get(i, {}))
+        if errors_list:
+            self._errors['states'] = errors_list
+            if 'states' in self.cleaned_data:
+                del self.cleaned_data['states']
+
+        else:
+            missing_states = required_states - found_states
+            if missing_states:
+                if len(missing_states) == 1:
+                    self.add_error(
+                        'states',
+                        f'"{list(missing_states)[0]}" state is missing!'
+                    )
+                self.add_error(
+                    'states',
+                    f"Required states are missing: {list(missing_states)}!"
+                )
+
+        return self.cleaned_data
 
     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()
+        if commit:
+            for s in Component.objects.filter(
+                base_type='state-select', config__is_main=True
+            ).exclude(id=self.instance.id):
+                s.config['is_main'] = False
+                s.save()
         return super().save(commit)
 
 
+
 class AlarmClockEventForm(forms.Form):
     uid = HiddenField(required=False)
     enabled = forms.BooleanField(initial=True)

simo/generic/gateways.py

@@ -72,10 +72,17 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
         ('watch_alarm_clocks', 30),
         ('watch_watering', 60),
         ('watch_alarm_events', 1),
-        ('watch_timers', 1)
+        ('watch_timers', 1),
+        ('watch_main_states', 60)
     )
 
-    terminating_scripts = set()
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.last_sensor_actions = {}
+        self.sensors_on_watch = {}
+        self.sleep_is_on = {}
+
+
 
     def watch_thermostats(self):
         from .controllers import Thermostat
@@ -242,6 +249,78 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
                 print(traceback.format_exc(), file=sys.stderr)
 
 
+    def watch_main_state(self, state):
+        i_id = state.zone.instance.id
+        if state.value in ('day', 'night', 'evening', 'morning'):
+            new_state = state.get_day_evening_night_morning()
+            if new_state != state.value:
+                print(f"New main state of {state.zone.instance} - {new_state}")
+                state.send(new_state)
+
+        if state.config.get('away_on_no_action'):
+            for sensor in Component.objects.filter(
+                    zone__instance=state.zone.instance,
+                    base_type='binary-sensor', alarm_category='security'
+            ):
+                if state.id not in self.sensors_on_watch:
+                    self.sensors_on_watch[state.id] = {}
+
+                if sensor.id not in self.sensors_on_watch[state.id]:
+                    self.sensors_on_watch[state.id][sensor.id] = i_id
+                    self.last_sensor_actions[i_id] = time.time()
+                    sensor.on_change(self.security_sensor_change)
+
+            last_action = self.last_sensor_actions.get(i_id, time.time())
+            if state.check_is_away(last_action):
+                if state.value != 'away':
+                    print(f"New main state of "
+                          f"{state.zone.instance} - away")
+                    state.send('away')
+            else:
+                if state.value == 'away':
+                    try:
+                        new_state = state.get_day_evening_night_morning()
+                    except:
+                        new_state = 'day'
+                    print(f"New main state of "
+                          f"{state.zone.instance} - {new_state}")
+                    state.send(new_state)
+
+        if state.config.get('sleeping_phones_hour') is not None:
+            sleep_time = state.owner_phones_on_sleep()
+            if sleep_time and state.value != 'sleep':
+                print(f"New main state of {state.zone.instance} - sleep")
+                state.send('sleep')
+            elif state.value == 'sleep':
+                try:
+                    new_state = state.get_day_evening_night_morning()
+                except:
+                    new_state = 'day'
+                print(f"New main state of "
+                      f"{state.zone.instance} - {new_state}")
+                state.send(new_state)
+
+
+    def watch_main_states(self):
+        drop_current_instance()
+        from .controllers import MainState
+        for state in Component.objects.filter(
+            controller_uid=MainState.uid
+        ).select_related('zone', 'zone__instance'):
+            try:
+                self.watch_main_state(state)
+            except Exception as e:
+                print(traceback.format_exc(), file=sys.stderr)
+
+
+
+    def security_sensor_change(self, sensor):
+        self.last_sensor_actions[
+            self.sensors_on_watch[sensor.id]
+        ] = time.time()
+
+
+
 class DummyGatewayHandler(BaseObjectCommandsGatewayHandler):
     name = "Dummy"
     config_form = BaseGatewayForm

simo/users/admin.py

@@ -32,6 +32,15 @@ class PermissionsRoleAdmin(admin.ModelAdmin):
     inlines = ComponentPermissionInline,
     list_filter = 'is_superuser', 'is_owner', 'can_manage_users', 'is_default'
 
+
+    def get_queryset(self, request):
+        qs = super().get_queryset(request)
+        instance = get_current_instance()
+        if instance:
+            return qs.filter(instance=instance)
+        return qs
+
+
     def save_model(self, request, obj, form, change):
         if not obj.id:
             obj.instance = request.instance

simo/users/api.py

@@ -11,6 +11,7 @@ from django.utils import timezone
 from django_filters.rest_framework import DjangoFilterBackend
 from simo.conf import dynamic_settings
 from simo.core.api import InstanceMixin
+from simo.core.middleware import drop_current_instance
 from .models import (
     User, UserDevice, UserDeviceReportLog, PermissionsRole, InstanceInvitation,
     Fingerprint, ComponentPermission, InstanceUser
@@ -247,6 +248,7 @@ class UserDeviceReport(InstanceMixin, viewsets.GenericViewSet):
                 self.instance.location, location
             ) < dynamic_settings['users__at_home_radius']
 
+        drop_current_instance()
         for iu in request.user.instance_roles.filter(is_active=True):
             if not relay:
                 iu.at_home = True