simo 2.5.3__py3-none-any.whl → 2.5.4__py3-none-any.whl

simo/generic/controllers.py

@@ -37,14 +37,14 @@ from simo.core.utils.config_values import (
 from .gateways import GenericGatewayHandler, DummyGatewayHandler
 from .app_widgets import (
     ScriptWidget, ThermostatWidget, AlarmGroupWidget, IPCameraWidget,
-    WeatherForecastWidget, GateWidget, BlindsWidget, SlidesWidget,
+    WeatherForecastWidget,
     WateringWidget, StateSelectWidget, AlarmClockWidget
 )
 from .forms import (
     ScriptConfigForm, PresenceLightingConfigForm,
     ThermostatConfigForm, AlarmGroupConfigForm,
     IPCameraConfigForm, WeatherForecastForm, GateConfigForm,
-    BlindsConfigForm, WateringConfigForm, StateSelectForm,
+    WateringConfigForm, StateSelectForm,
     AlarmClockConfigForm
 )
 from .scripting import get_current_state
@@ -558,266 +558,6 @@ class IPCamera(ControllerBase):
         )
 
 
-class Gate(ControllerBase, TimerMixin):
-    name = _("Gate")
-    base_type = 'gate'
-    gateway_class = GenericGatewayHandler
-    app_widget = GateWidget
-    config_form = GateConfigForm
-    admin_widget_template = 'admin/controller_widgets/gate.html'
-    default_config = {}
-
-    @property
-    def default_value(self):
-        return 'closed'
-
-    def _validate_val(self, value, occasion=None):
-        if occasion == BEFORE_SEND:
-            if self.component.config.get('action_method') == 'click':
-                if value != 'call':
-                    raise ValidationError(
-                        'Gate component understands only one command: '
-                        '"call". You have provided: "%s"' % (str(value))
-                    )
-            else:
-                if value not in ('call', 'open', 'close'):
-                    raise ValidationError(
-                        'This gate component understands only 3 commands: '
-                        '"open", "close" and "call". You have provided: "%s"' %
-                        (str(value))
-                    )
-        elif occasion == BEFORE_SET and value not in (
-            'closed', 'open', 'open_moving', 'closed_moving'
-        ):
-            raise ValidationError(
-                'Gate component can only be in 4 states:  '
-                '"closed", "closed", "open_moving", "closed_moving". '
-                'You have provided: "%s"' % (str(value))
-            )
-        return value
-
-    def _set_on_the_move(self):
-        def cancel_move():
-            start_value = self.component.value
-            start_sensor_value = self.component.config.get('sensor_value')
-            move_duration = self.component.config.get(
-                'gate_open_duration', 30
-            ) * 1000
-            # stay in moving state for user defined amount of seconds
-            time.sleep(move_duration / 1000)
-            self.component.refresh_from_db()
-            if time.time() - self.component.config.get('last_call', 0) \
-                < move_duration / 1000:
-                # There was another call in between of this wait,
-                # so we must skip this in favor of the new cancel_move function
-                # that is currently running in parallel.
-                return
-
-            # If it is no longer on the move this process becomes obsolete
-            # For example when open/close binary sensor detects closed event
-            # gate value is immediately set to closed.
-            if not self.component.value.endswith('moving'):
-                return
-
-            # Started from closed, sensor already picked up open event
-            # therefore this must now be considered as open.
-            if start_value.startswith('closed') \
-            and self.component.value == 'open_moving' \
-            and self.component.config.get('sensor_value'):
-                self.component.set('open')
-                return
-
-            # In all other occasions we wait for another move_duration
-            # and finish move anyways.
-            time.sleep(move_duration / 1000)
-            self.component.refresh_from_db()
-            if self.component.value.endswith('moving'):
-                self.component.set(self.component.value[:-7])
-
-        self.component.refresh_from_db()
-        self.component.config['last_call'] = time.time()
-        self.component.save(update_fields=['config'])
-
-        if not self.component.value.endswith('_moving'):
-            self.component.set(self.component.value + '_moving')
-        threading.Thread(target=cancel_move, daemon=True).start()
-
-    def open(self):
-        self.send('open')
-
-    def close(self):
-        self.send('close')
-
-    def call(self):
-        self.send('call')
-
-    # TODO: This was in gateway class, however it
-    # needs to be moved here or part of it back to the gateway
-    # as we no longer have Event object.
-    # if msg.topic == Event.TOPIC:
-    # if isinstance(component.controller, Switch):
-    #     value_change = payload['data'].get('value')
-    #     if not value_change:
-    #         return
-    #
-    #     # Handle Gate switches
-    #     for gate in Component.objects.filter(
-    #             controller_uid=Gate.uid, config__action_switch=component.id
-    #     ):
-    #         if gate.config.get('action_method') == 'toggle':
-    #             gate.controller._set_on_the_move()
-    #         else:
-    #             if value_change.get('new') == False:
-    #                 # Button released
-    #                 # set stopped position if it was moving, or set moving if not.
-    #                 if gate.value.endswith('moving'):
-    #                     if gate.config.get('sensor_value'):
-    #                         gate.set('open')
-    #                     else:
-    #                         gate.set('closed')
-    #                 else:
-    #                     gate.controller._set_on_the_move()
-    #
-    #     return
-    #
-    # elif isinstance(component.controller, BinarySensor):
-    #     value_change = payload['data'].get('value')
-    #     if not value_change:
-    #         return
-    #     # Handle Gate binary sensors
-    #     for gate in Component.objects.filter(
-    #             controller_uid=Gate.uid,
-    #             config__open_closed_sensor=component.id
-    #     ):
-    #         gate.config['sensor_value'] = component.value
-    #         gate.save(update_fields=['config'])
-    #         # If sensor goes from False to True, while gate is moving
-    #         # it usually means that gate just started the move and must stay in the move
-    #         # user defined amount of seconds to represent actual gate movement.
-    #         # Open state therefore is reached only after user defined duration.
-    #         # If it was not in the move, then it simply means that it was
-    #         # opened in some other way and we set it to open immediately.
-    #         if component.value:
-    #             if gate.value.endswith('moving'):
-    #                 print("SET OPEN MOVING!")
-    #                 gate.set('open_moving')
-    #             else:
-    #                 gate.set('open')
-    #         # if binary sensor detects gate close event
-    #         # we set gate value to closed immediately as it means that
-    #         # gate is now truly closed and no longer moving.
-    #         else:
-    #             gate.set('closed')
-
-
-class Blinds(ControllerBase, TimerMixin):
-    name = _("Blind")
-    base_type = 'blinds'
-    gateway_class = GenericGatewayHandler
-    config_form = BlindsConfigForm
-    admin_widget_template = 'admin/controller_widgets/blinds.html'
-    default_config = {}
-
-    @property
-    def app_widget(self):
-        if self.component.config.get('control_mode') == 'slide':
-            return SlidesWidget
-        else:
-            return BlindsWidget
-
-    @property
-    def default_value(self):
-        # target and current positions in milliseconds, angle in degrees (0 - 180)
-        return {'target': 0, 'position': 0, 'angle': 0}
-
-    def _validate_val(self, value, occasion=None):
-
-        if occasion == BEFORE_SEND:
-            if isinstance(value, int) or isinstance(value, float):
-                # legacy support
-                value = {'target': int(value)}
-            if 'target' not in value:
-                raise ValidationError("Target value is required!")
-            target = value.get('target')
-            if type(target) not in (float, int):
-                raise ValidationError(
-                    "Bad target position for blinds to go."
-                )
-            if target > self.component.config.get('open_duration') * 1000:
-                raise ValidationError(
-                    "Target value lower than %d expected, "
-                    "%d received instead" % (
-                        self.component.config['open_duration'] * 1000,
-                        target
-                    )
-                )
-            if 'angle' in value:
-                try:
-                    angle = int(value['angle'])
-                except:
-                    raise ValidationError(
-                        "Integer between 0 - 180 is required for blinds angle."
-                    )
-                if angle < 0 or angle > 180:
-                    raise ValidationError(
-                        "Integer between 0 - 180 is required for blinds angle."
-                    )
-            else:
-                value['angle'] = self.component.value.get('angle', 0)
-
-        elif occasion == BEFORE_SET:
-            if not isinstance(value, dict):
-                raise ValidationError("Dictionary is expected")
-            for key, val in value.items():
-                if key not in ('target', 'position', 'angle'):
-                    raise ValidationError(
-                        "'target', 'position' or 'angle' parameters are expected."
-                    )
-                if key == 'position':
-                    if val < 0:
-                        raise ValidationError(
-                            "Positive integer expected for blind position"
-                        )
-                    if val > self.component.config.get('open_duration') * 1000:
-                        raise ValidationError(
-                            "Positive value is to big. Must be lower than %d, "
-                            "but you have provided %d" % (
-                                self.component.config.get('open_duration') * 1000, val
-                            )
-                        )
-
-            self.component.refresh_from_db()
-            if 'target' not in value:
-                value['target'] = self.component.value.get('target')
-            if 'position' not in value:
-                value['position'] = self.component.value.get('position')
-            if 'angle' not in value:
-                value['angle'] = self.component.value.get('angle')
-
-        return value
-
-    def open(self):
-        send_val = {'target': 0}
-        angle = self.component.value.get('angle')
-        if angle is not None and 0 <= angle <= 180:
-            send_val['angle'] = angle
-        self.send(send_val)
-
-    def close(self):
-        send_val = {'target': self.component.config['open_duration'] * 1000}
-        angle = self.component.value.get('angle')
-        if angle is not None and 0 <= angle <= 180:
-            send_val['angle'] = angle
-        self.send(send_val)
-
-    def stop(self):
-        send_val = {'target': -1}
-        angle = self.component.value.get('angle')
-        if angle is not None and 0 <= angle <= 180:
-            send_val['angle'] = angle
-        self.send(send_val)
-
-
 class Watering(ControllerBase):
     STATUS_CHOICES = (
         'stopped', 'running_program', 'running_custom',

simo/generic/forms.py

@@ -620,55 +620,6 @@ class GateConfigForm(BaseComponentForm):
     )
 
 
-class BlindsConfigForm(BaseComponentForm):
-    open_switch = forms.ModelChoiceField(
-        Component.objects.filter(base_type=Switch.base_type),
-        widget=autocomplete.ModelSelect2(
-            url='autocomplete-component', attrs={'data-html': True},
-            forward=(
-                forward.Const([Switch.base_type], 'base_type'),
-            )
-        )
-    )
-    close_switch = forms.ModelChoiceField(
-        Component.objects.filter(base_type=Switch.base_type),
-        widget=autocomplete.ModelSelect2(
-            url='autocomplete-component', attrs={'data-html': True},
-            forward=(
-                forward.Const([Switch.base_type], 'base_type'),
-            )
-        )
-    )
-    open_direction = forms.ChoiceField(
-        label='Closed > Open direction',
-        required=True, choices=(
-            ('up', "Up"), ('down', "Down"),
-            ('right', "Right"), ('left', "Left")
-        ),
-        help_text="Move direction from fully closed to fully open."
-
-    )
-    open_duration = forms.FloatField(
-        label='Open duration', min_value=0.001, max_value=360000,
-        initial=30,
-        help_text="Time in seconds it takes for your blinds to go "
-                  "from fully closed to fully open."
-    )
-    slats_angle_duration = forms.FloatField(
-        label='Slats angle duration', min_value=0.01, max_value=360000,
-        required=False,
-        help_text="Takes effect only with App control mode - 'Slide', "
-                  "can be used with slat blinds to control slats angle. <br>"
-                  "Time in seconds it takes "
-                  "to go from fully closed to the start of open movement. <br>"
-                  "Usually it's in between of 1 - 3 seconds."
-    )
-    control_mode = forms.ChoiceField(
-        label="App control mode", required=True, choices=(
-            ('click', "Click"), ('hold', "Hold"), ('slide', "Slide")
-        ),
-    )
-
 
 class ContourForm(forms.Form):
     uid = forms.CharField(widget=forms.HiddenInput(), required=False)

simo/generic/gateways.py

@@ -20,62 +20,6 @@ from simo.core.events import GatewayObjectCommand, get_event_obj
 from simo.core.loggers import get_gw_logger, get_component_logger
 
 
-
-class BlindsRunner(threading.Thread):
-
-    def __init__(self, blinds, *args, **kwargs):
-        self.blinds = blinds
-        self.target = self.blinds.value['target']
-        self.position = self.blinds.value['position']
-        self.open_duration = self.blinds.config.get('open_duration', 0) * 1000
-        assert self.target >= -1
-        assert self.target <= self.open_duration
-        self.exit = multiprocessing.Event()
-        super().__init__(*args, **kwargs)
-
-    def run(self):
-        try:
-            self.open_switch = Component.objects.get(
-                pk=self.blinds.config.get('open_switch')
-            )
-            self.close_switch = Component.objects.get(
-                pk=self.blinds.config.get('close_switch')
-            )
-        except:
-            self.done = True
-            return
-        self.start_position = self.blinds.value['position']
-        self.position = self.blinds.value['position']
-        self.start_time = time.time()
-        self.last_save = time.time()
-        while not self.exit.is_set():
-            change = (time.time() - self.start_time) * 1000
-            if self.target > self.start_position:
-                self.position = self.start_position + change
-                if self.position >= self.target:
-                    self.blinds.set(
-                        {'position': self.target, 'target': -1}
-                    )
-                    self.open_switch.turn_off()
-                    self.close_switch.turn_off()
-                    return
-            else:
-                self.position = self.start_position - change
-                if self.position < self.target:
-                    self.blinds.set({'position': self.target, 'target': -1})
-                    self.open_switch.turn_off()
-                    self.close_switch.turn_off()
-                    return
-
-            if self.last_save < time.time() - 1:
-                self.blinds.set({'position': self.position})
-                self.last_save = time.time()
-            time.sleep(0.01)
-
-    def terminate(self):
-        self.exit.set()
-
-
 class CameraWatcher(threading.Thread):
 
     def __init__(self, component_id, exit, *args, **kwargs):
@@ -174,7 +118,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
     config_form = BaseGatewayForm
 
     running_scripts = {}
-    blinds_runners = {}
     periodic_tasks = (
         ('watch_thermostats', 60),
         ('watch_alarm_clocks', 30),
@@ -207,6 +150,9 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
         dead_processes = []
         for id, process in self.running_scripts.items():
             if process.is_alive():
+                if not Component.objects.filter(id=id).count():
+                    # script is deleted.
+                    process.terminate()
                 continue
             component = Component.objects.filter(id=id).exclude(
                 value__in=('error', 'finished')
@@ -270,7 +216,7 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
             component.save()
 
         # Start scripts that are designed to be autostarted
-        # as well as those who are designed to be kept alive, but
+        # as well as those that are designed to be kept alive, but
         # got terminated unexpectedly
         for script in Component.objects.filter(
             base_type='script',
@@ -291,9 +237,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
             mqtt_client.loop()
         mqtt_client.disconnect()
 
-        for id, runner in self.blinds_runners.items():
-            runner.terminate()
-
         script_ids = [id for id in self.running_scripts.keys()]
         for id in script_ids:
             self.stop_script(
@@ -310,7 +253,7 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
     def on_mqtt_message(self, client, userdata, msg):
         print("Mqtt message: ", msg.payload)
         from simo.generic.controllers import (
-            Script, Blinds, AlarmGroup, Gate
+            Script, AlarmGroup
         )
         payload = json.loads(msg.payload)
         component = get_event_obj(payload, Component)
@@ -323,12 +266,8 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
                 elif payload.get('set_val') == 'stop':
                     self.stop_script(component)
                 return
-            elif component.controller_uid == Blinds.uid:
-                self.control_blinds(component, payload.get('set_val'))
             elif component.controller_uid == AlarmGroup.uid:
                 self.control_alarm_group(component, payload.get('set_val'))
-            elif component.controller_uid == Gate:
-                self.control_gate(component, payload.get('set_val'))
             else:
                 component.controller.set(payload.get('set_val'))
         except Exception:
@@ -385,43 +324,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
 
             threading.Thread(target=kill, daemon=True).start()
 
-    def control_blinds(self, blinds, target):
-        try:
-            open_switch = Component.objects.get(
-                pk=blinds.config['open_switch']
-            )
-            close_switch = Component.objects.get(
-                pk=blinds.config['close_switch']
-            )
-        except:
-            return
-
-        blinds.set({'target': target})
-
-        blinds_runner = self.blinds_runners.get(blinds.id)
-        if blinds_runner:
-            blinds_runner.terminate()
-
-        if target == -1:
-            open_switch.turn_off()
-            close_switch.turn_off()
-
-        elif target != blinds.value['position']:
-            try:
-                self.blinds_runners[blinds.id] = BlindsRunner(blinds)
-                self.blinds_runners[blinds.id].daemon = True
-            except:
-                pass
-            else:
-                if target > blinds.value['position']:
-                    close_switch.turn_off()
-                    open_switch.turn_on()
-                else:
-                    open_switch.turn_off()
-                    close_switch.turn_on()
-
-                self.blinds_runners[blinds.id].start()
-
     def control_alarm_group(self, alarm_group, value):
         from simo.generic.controllers import AlarmGroup
 
@@ -464,21 +366,6 @@ class GenericGatewayHandler(BaseObjectCommandsGatewayHandler):
             other_group.refresh_status()
 
 
-    def control_gate(self, gate, value):
-        switch = Component.objects.filter(
-            pk=gate.config.get('action_switch')
-        ).first()
-        if not switch:
-            return
-
-        if gate.config.get('action_method') == 'click':
-            switch.click()
-        else:
-            if value == 'open':
-                switch.turn_on()
-            else:
-                switch.turn_off()
-
     def watch_alarm_events(self):
         from .controllers import AlarmGroup
         for alarm in Component.objects.filter(

simo/generic/scripting/example.py

@@ -0,0 +1,67 @@
+import time
+import random
+import pytz
+from datetime import datetime
+from django.utils import timezone
+from simo.core.middleware import get_current_instance
+from simo.core.models import Component
+from simo.users.models import InstanceUser
+from simo.generic.scripting.helpers import LocalSun
+
+
+class Automation:
+    REZIMAS_COMPONENT_ID = 130
+
+    def __init__(self):
+        self.instance = get_current_instance()
+        self.rezimas = Component.objects.get(id=self.REZIMAS_COMPONENT_ID)
+        self.sun = LocalSun(self.instance.location)
+        self.night_is_on = False
+
+    def check_owner_phones(self, rezimas, instance_users, datetime):
+        if not self.night_is_on:
+            if not (datetime.hour >= 22 or datetime.hour < 6):
+                return
+
+            for iuser in instance_users:
+                # 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
+            self.night_is_on = True
+            return 'night'
+        else:
+            # return new_rezimas diena only if there are still users
+            # at home, none of them have their phones on charge
+            # and current rezimas is still night
+            for iuser in instance_users:
+                # skipping users that are not at home
+                if not iuser.at_home:
+                    continue
+                if iuser.phone_on_charge:
+                    # at least one user's phone is still on charge
+                    return
+                else:
+                    self.night_is_on = False
+            if not self.night_is_on and rezimas.value == 'night':
+                return 'day'
+
+    def run(self):
+        while True:
+            instance_users = InstanceUser.objects.filter(
+                is_active=True, role__is_owner=True
+            )
+            self.rezimas.refresh_from_db()
+            new_rezimas = self.check_owner_phones(
+                self.rezimas, instance_users, timezone.localtime()
+            )
+            if new_rezimas:
+                self.rezimas.send(new_rezimas)
+
+            # randomize script load
+            time.sleep(random.randint(20, 40))
+
+
+    def test(self):

simo/generic/scripting/helpers.py

@@ -1,3 +1,5 @@
+import pytz
+import math
 from django.utils import timezone
 from suntime import Sun
 from simo.core.models import Instance
@@ -5,10 +7,12 @@ from simo.core.models import Instance
 
 class LocalSun(Sun):
 
-    def __init__(self, instance=None):
-        if not instance:
+    def __init__(self, location=None):
+        if not location:
             instance = Instance.objects.all().first()
-        coordinates = instance.location.split(',')
+            coordinates = instance.location.split(',')
+        else:
+            coordinates = location.split(',')
         try:
             lat = float(coordinates[0])
         except:
@@ -19,17 +23,69 @@ class LocalSun(Sun):
             lon = 0
         super().__init__(lat, lon)
 
-    def is_night(self):
-        if timezone.now() > self.get_sunset_time():
+    def get_sunrise_time(self, localdatetime=None):
+        sunrise = super().get_sunrise_time(date=localdatetime)
+        if not localdatetime or not localdatetime.tzinfo:
+            return sunrise
+        return sunrise.astimezone(localdatetime.tzinfo)
+
+    def get_sunset_time(self, localdatetime=None):
+        sunset = super().get_sunset_time(date=localdatetime)
+        if not localdatetime or not localdatetime.tzinfo:
+            return sunset
+        return sunset.astimezone(localdatetime.tzinfo)
+
+    def _get_utc_datetime(self, localdatetime=None):
+        if not localdatetime:
+            utc_datetime = timezone.now()
+        else:
+            utc_datetime = localdatetime.astimezone(pytz.utc)
+        return utc_datetime
+
+    def is_night(self, localdatetime=None):
+        utc_datetime = self._get_utc_datetime(localdatetime)
+        if utc_datetime > self.get_sunset_time(utc_datetime):
             return True
-        if timezone.now() < self.get_sunrise_time():
+        if utc_datetime < self.get_sunrise_time(utc_datetime):
             return True
         return False
 
-    def seconds_to_sunset(self):
-        return (self.get_sunset_time() - timezone.now()).total_seconds()
+    def seconds_to_sunset(self, localdatetime=None):
+        utc_datetime = self._get_utc_datetime(localdatetime)
+        return (self.get_sunset_time(utc_datetime) - utc_datetime).total_seconds()
+
+    def seconds_to_sunrise(self, localdatetime=None):
+        utc_datetime = self._get_utc_datetime(localdatetime)
+        return (self.get_sunrise_time(utc_datetime) - utc_datetime).total_seconds()
+
+
+def haversine_distance(location1, location2, units_of_measure='metric'):
+    # Radius of Earth in meters
+    R = 6371000
+
+    # Unpack coordinates
+    lat1, lon1 = location1.split(',')
+    lat2, lon2 = location2.split(',')
+    lat1, lon1, lat2, lon2 = float(lat1), float(lon1), float(lat2), float(lon2)
+
+    # Convert latitude and longitude from degrees to radians
+    phi1 = math.radians(lat1)
+    phi2 = math.radians(lat2)
+    delta_phi = math.radians(lat2 - lat1)
+    delta_lambda = math.radians(lon2 - lon1)
+
+    # Haversine formula
+    a = math.sin(delta_phi / 2) ** 2 + math.cos(phi1) * math.cos(
+        phi2) * math.sin(delta_lambda / 2) ** 2
+    c = 2 * math.atan2(math.sqrt(a), math.sqrt(1 - a))
 
-    def seconds_to_sunrise(self):
-        return (self.get_sunrise_time() - timezone.now()).total_seconds()
+    # Distance in meters
+    distance_meters = R * c
 
+    # Convert to feet if 'imperial' is chosen
+    if units_of_measure == 'imperial':
+        distance = distance_meters * 3.28084  # Convert meters to feet
+    else:
+        distance = distance_meters  # Keep in meters for 'metric'
 
+    return distance