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

simo/fleet/controllers.py

@@ -8,7 +8,8 @@ from simo.core.controllers import (
     Button as BaseButton,
     NumericSensor as BaseNumericSensor,
     Switch as BaseSwitch, Dimmer as BaseDimmer,
-    MultiSensor as BaseMultiSensor, RGBWLight as BaseRGBWLight
+    MultiSensor as BaseMultiSensor, RGBWLight as BaseRGBWLight,
+    Blinds as BaseBlinds, Gate as BaseGate
 )
 from simo.core.app_widgets import NumericSensorWidget, AirQualityWidget
 from simo.core.controllers import Lock, ControllerBase, SingleSwitchWidget
@@ -16,8 +17,7 @@ from simo.core.utils.helpers import heat_index
 from simo.core.utils.serialization import (
     serialize_form_data, deserialize_form_data
 )
-from simo.generic.controllers import Blinds as GenericBlinds
-from .models import Colonel, ColonelPin
+from .models import Colonel
 from .gateways import FleetGatewayHandler
 from .forms import (
     ColonelPinChoiceField,
@@ -26,7 +26,8 @@ from .forms import (
     ColonelNumericSensorConfigForm, ColonelRGBLightConfigForm,
     ColonelDHTSensorConfigForm, DS18B20SensorConfigForm,
     BME680SensorConfigForm, MPC9808SensorConfigForm, ENS160SensorConfigForm,
-    DualMotorValveForm, BlindsConfigForm, BurglarSmokeDetectorConfigForm,
+    DualMotorValveForm, BlindsConfigForm, GateConfigForm,
+    BurglarSmokeDetectorConfigForm,
     TTLockConfigForm, DALIDeviceConfigForm, DaliLampForm, DaliGearGroupForm,
     DaliSwitchConfigForm,
     DaliOccupancySensorConfigForm, DALILightSensorConfigForm,
@@ -71,9 +72,6 @@ class FleeDeviceMixin:
                 config[key] = val
         return config
 
-    def _fix_pin_relations(self):
-        pass
-
 
 class BasicSensorMixin:
     gateway_class = FleetGatewayHandler
@@ -83,21 +81,6 @@ class BasicSensorMixin:
             self.component.config['pin_no'],
         ]
 
-    @atomic
-    def _fix_pin_relations(self):
-        colonel = Colonel.objects.filter(
-            id=self.component.config.get('colonel', 0)
-        ).first()
-        if not colonel:
-            return
-        cp = ColonelPin.objects.filter(
-            colonel=colonel, no=self.component.config['pin_no']
-        ).first()
-        if self.component.config.get('pin') != cp.id:
-            self.component.config['pin'] = cp.id
-            self.component.save()
-
-
 class BinarySensor(FleeDeviceMixin, BasicSensorMixin, BaseBinarySensor):
     config_form = ColonelBinarySensorConfigForm
 
@@ -116,26 +99,6 @@ class BurglarSmokeDetector(BinarySensor):
             self.component.config['sensor_pin_no']
         ]
 
-    @atomic
-    def _fix_pin_relations(self):
-        colonel = Colonel.objects.filter(
-            id=self.component.config.get('colonel', 0)
-        ).first()
-        if not colonel:
-            return
-        cp = ColonelPin.objects.filter(
-            colonel=colonel, no=self.component.config['power_pin_no']
-        ).first()
-        if self.component.config.get('power_pin') != cp.id:
-            self.component.config['power_pin'] = cp.id
-            self.component.save()
-        cp = ColonelPin.objects.filter(
-            colonel=colonel, no=self.component.config['sensor_pin_no']
-        ).first()
-        if self.component.config.get('sensor_pin') != cp.id:
-            self.component.config['sensor_pin'] = cp.id
-            self.component.save()
-
 
 # class AnalogSensor(FleeDeviceMixin, BasicSensorMixin, BaseNumericSensor):
 #     config_form = ColonelNumericSensorConfigForm
@@ -281,34 +244,6 @@ class BasicOutputMixin:
                 pins.append(ctrl['pin_no'])
         return pins
 
-    @atomic
-    def _fix_pin_relations(self):
-        colonel = Colonel.objects.filter(
-            id=self.component.config.get('colonel', 0)
-        ).first()
-        if not colonel:
-            return
-        cp = ColonelPin.objects.filter(
-            colonel=colonel, no=self.component.config['output_pin_no']
-        ).first()
-        if self.component.config.get('output_pin') != cp.id:
-            self.component.config['output_pin'] = cp.id
-
-        for ctrl in self.component.config.get('controls', []):
-            if 'pin_no' not in ctrl:
-                continue
-            if not ctrl.get('input').startswith('pin-'):
-                continue
-            cp = ColonelPin.objects.filter(
-                colonel=colonel, no=ctrl['pin_no']
-            ).first()
-            if not cp:
-                continue
-            ctrl['input'] = f'pin-{cp.id}'
-
-        self.component.save()
-
-
     def _ctrl(self, ctrl_no, ctrl_event, method):
         GatewayObjectCommand(
             self.component.gateway,
@@ -485,26 +420,6 @@ class DualMotorValve(FleeDeviceMixin, BasicOutputMixin, BaseDimmer):
             self.component.config['close_pin_no']
         ]
 
-    @atomic
-    def _fix_pin_relations(self):
-        colonel = Colonel.objects.filter(
-            id=self.component.config.get('colonel', 0)
-        ).first()
-        if not colonel:
-            return
-        cp = ColonelPin.objects.filter(
-            colonel=colonel, no=self.component.config['open_pin_no']
-        ).first()
-        if self.component.config.get('open_pin') != cp.id:
-            self.component.config['open_pin'] = cp.id
-        cp = ColonelPin.objects.filter(
-            colonel=colonel, no=self.component.config['close_pin_no']
-        ).first()
-        if self.component.config.get('close_pin') != cp.id:
-            self.component.config['close_pin'] = cp.id
-
-        self.component.save()
-
     def _prepare_for_send(self, value):
         conf = self.component.config
         if value >= conf.get('max', 100):
@@ -525,7 +440,7 @@ class DualMotorValve(FleeDeviceMixin, BasicOutputMixin, BaseDimmer):
         return conf.get('min', 0) + (value / 100) * val_amplitude
 
 
-class Blinds(FleeDeviceMixin, BasicOutputMixin, GenericBlinds):
+class Blinds(FleeDeviceMixin, BasicOutputMixin, BaseBlinds):
     gateway_class = FleetGatewayHandler
     config_form = BlindsConfigForm
 
@@ -539,35 +454,21 @@ class Blinds(FleeDeviceMixin, BasicOutputMixin, GenericBlinds):
                 pins.append(ctrl['pin_no'])
         return pins
 
-    @atomic
-    def _fix_pin_relations(self):
-        colonel = Colonel.objects.filter(
-            id=self.component.config.get('colonel', 0)
-        ).first()
-        if not colonel:
-            return
-        cp = ColonelPin.objects.filter(
-            colonel=colonel, no=self.component.config['open_pin_no']
-        ).first()
-        if self.component.config.get('open_pin') != cp.id:
-            self.component.config['open_pin'] = cp.id
-        cp = ColonelPin.objects.filter(
-            colonel=colonel, no=self.component.config['close_pin_no']
-        ).first()
-        if self.component.config.get('close_pin') != cp.id:
-            self.component.config['close_pin'] = cp.id
+
+class Gate(FleeDeviceMixin, BasicOutputMixin, BaseGate):
+    gateway_class = FleetGatewayHandler
+    config_form = GateConfigForm
+
+    def _get_occupied_pins(self):
+        pins = [
+            self.component.config['control_pin_no'],
+            self.component.config['sensor_pin_no']
+        ]
         for ctrl in self.component.config.get('controls', []):
-            if 'pin_no' not in ctrl:
-                continue
-            if not ctrl.get('input').startswith('pin-'):
-                continue
-            cp = ColonelPin.objects.filter(
-                colonel=colonel, no=ctrl['pin_no']
-            ).first()
-            if not cp:
-                continue
-            ctrl['input'] = f'pin-{cp.id}'
-        self.component.save()
+            if 'pin_no' in ctrl:
+                pins.append(ctrl['pin_no'])
+        return pins
+
 
 
 class TTLock(FleeDeviceMixin, Lock):

simo/fleet/forms.py

@@ -1256,6 +1256,107 @@ class BlindsConfigForm(ColonelComponentForm):
         return obj
 
 
+class GateConfigForm(ColonelComponentForm):
+    control_pin = Select2ModelChoiceField(
+        label="Control Relay Port",
+        queryset=ColonelPin.objects.filter(output=True),
+        url='autocomplete-colonel-pins',
+        forward=[
+            forward.Self(),
+            forward.Field('colonel'),
+            forward.Const({'output': True}, 'filters')
+        ]
+    )
+    open_action = forms.ChoiceField(
+        choices=(('HIGH', "HIGH"), ('LOW', "LOW")), initial='HIGH'
+    )
+    control_method = forms.ChoiceField(
+        choices=(('pulse', "Pulse"), ('hold', "Hold")), initial="pulse",
+        help_text="What your gate motor expects to receive as control command?"
+    )
+    sensor_pin = Select2ModelChoiceField(
+        label='Gate open/closed sensor port',
+        queryset=ColonelPin.objects.filter(input=True),
+        url='autocomplete-colonel-pins',
+        forward=[
+            forward.Self(),
+            forward.Field('colonel'),
+            forward.Const({'input': True}, 'filters')
+        ]
+    )
+    closed_value = forms.ChoiceField(
+        label='Gate closed value',
+        choices=(("LOW", "LOW"), ('HIGH', "HIGH")), initial="LOW",
+        help_text="What is the input sensor value, "
+                  "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 "
+                  "to go from fully closed to fully open?"
+    )
+
+    controls = FormsetField(
+        formset_factory(
+            ControlForm, can_delete=True, can_order=True, extra=0, max_num=2
+        )
+    )
+
+    def clean(self):
+        super().clean()
+
+        if self.cleaned_data.get('control_pin') \
+        and self.cleaned_data.get('sensor_pin') \
+        and self.cleaned_data['control_pin'] == self.cleaned_data['sensor_pin']:
+            self.add_error(
+                'sensor_pin', "Can't be the same as control port!"
+            )
+
+        if self.cleaned_data.get('control_pin'):
+            self._clean_pin('control_pin')
+        if self.cleaned_data.get('sensor_pin'):
+            self._clean_pin('sensor_pin')
+
+        if 'controls' in self.cleaned_data:
+
+            self._clean_controls()
+
+            if self.cleaned_data.get('control_pin') and self.cleaned_data.get('controls'):
+                for ctrl in self.cleaned_data['controls']:
+                    if not ctrl['input'].startswith('pin'):
+                        continue
+                    if int(ctrl['input'][4:]) == self.cleaned_data['control_pin'].id:
+                        self.add_error(
+                            "control_pin",
+                            "Can't be used as control pin at the same time!"
+                        )
+
+            if self.cleaned_data.get('sensor_pin') and self.cleaned_data.get('controls'):
+                for ctrl in self.cleaned_data['controls']:
+                    if not ctrl['input'].startswith('pin'):
+                        continue
+                    if int(ctrl['input'][4:]) == self.cleaned_data['sensor_pin'].id:
+                        self.add_error(
+                            "sensor_pin",
+                            "Can't be used as control pin at the same time!"
+                        )
+        return self.cleaned_data
+
+    def save(self, commit=True):
+        if 'control_pin' in self.cleaned_data:
+            self.instance.config['control_pin_no'] = \
+                self.cleaned_data['control_pin'].no
+        if 'sensor_pin' in self.cleaned_data:
+            self.instance.config['sensor_pin_no'] = \
+                self.cleaned_data['sensor_pin'].no
+        obj = super().save(commit=commit)
+        if commit and self.cleaned_data.get('controls'):
+            GatewayObjectCommand(
+                self.instance.gateway, obj, command='watch_buttons'
+            ).publish()
+        return obj
+
+
 class BurglarSmokeDetectorConfigForm(ColonelComponentForm):
     power_pin = Select2ModelChoiceField(
         label="Power port",

simo/generic/app_widgets.py

@@ -38,24 +38,6 @@ class WeatherForecastWidget(BaseAppWidget):
     size = [4, 2]
 
 
-class GateWidget(BaseAppWidget):
-    uid = 'gate'
-    name = _('Gate')
-    size = [2, 1]
-
-
-class BlindsWidget(BaseAppWidget):
-    uid = 'blinds'
-    name = _('Blinds')
-    size = [4, 1]
-
-
-class SlidesWidget(BaseAppWidget):
-    uid = 'slides'
-    name = _('Slides')
-    size = [2, 1]
-
-
 class WateringWidget(BaseAppWidget):
     uid = 'watering'
     name = _('Watering')

simo/generic/base_types.py

@@ -6,8 +6,6 @@ BASE_TYPES = {
     'alarm-group': _("Alarm Group"),
     'ip-camera': _("IP Camera"),
     'weather-forecast': _("Weather Forecast"),
-    'gate': _("Gate"),
-    'blinds': _("Blinds"),
     'watering': _("Watering"),
     'state-select': _("State Select"),
     'alarm-clock': _("Alarm Clock"),

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',