simo 2.0.42__py3-none-any.whl → 2.1.2__py3-none-any.whl

simo/fleet/gateways.py

@@ -22,7 +22,20 @@ class FleetGatewayHandler(BaseObjectCommandsGatewayHandler):
     )
 
     def run(self, exit):
-        from simo.fleet.controllers import TTLock
+        from simo.fleet.controllers import (
+            Switch, PWMOutput, RGBLight, Blinds, DALIGearGroup, DALILamp, TTLock
+        )
+
+        self.buttons_on_watch = set()
+        for component in Component.objects.filter(
+            controller_uid__in=(
+                Switch.uid, PWMOutput.uid, RGBLight.uid, Blinds.uid,
+                DALIGearGroup.uid, DALILamp.uid
+            )
+        ):
+            self.watch_buttons(component)
+
+
         self.door_sensors_on_watch = set()
         for lock in Component.objects.filter(controller_uid=TTLock.uid):
             if not lock.config.get('door_sensor'):
@@ -34,6 +47,7 @@ class FleetGatewayHandler(BaseObjectCommandsGatewayHandler):
                 continue
             self.door_sensors_on_watch.add(door_sensor.id)
             door_sensor.on_change(self.on_door_sensor)
+
         super().run(exit)
 
 
@@ -44,11 +58,16 @@ class FleetGatewayHandler(BaseObjectCommandsGatewayHandler):
             door_sensor = get_event_obj(payload, Component)
             if not door_sensor:
                 return
-            print("Adding door sensor to lock watch!")
             if door_sensor.id in self.door_sensors_on_watch:
                 return
+            print("Adding new door sensor to lock watch!")
             self.door_sensors_on_watch.add(door_sensor.id)
             door_sensor.on_change(self.on_door_sensor)
+        if payload.get('command') == 'watch_buttons':
+            component = get_event_obj(payload, Component)
+            if not component:
+                return
+            self.watch_buttons(component)
 
     def on_door_sensor(self, sensor):
         from simo.fleet.controllers import TTLock
@@ -96,3 +115,35 @@ class FleetGatewayHandler(BaseObjectCommandsGatewayHandler):
                     type=gw.discovery['controller_uid'],
                     i=form_cleaned_data['interface'].no
                 ).publish()
+
+    def watch_buttons(self, component):
+        for i, ctrl in enumerate(component.config.get('controls', [])):
+            if not ctrl.get('input', '').startswith('button'):
+                continue
+            button = Component.objects.filter(id=ctrl['input'][7:]).first()
+            if not button:
+                continue
+            if button.id in self.buttons_on_watch:
+                continue
+            if button.config.get('colonel') == component.config.get('colonel'):
+                # button is on a same colonel, therefore colonel handles
+                # all control actions and we do not need to do it here
+                continue
+
+            def button_action(btn):
+                self.button_action(component, btn)
+            print(f"Binding button {button} to {component}!")
+            button.on_change(button_action)
+            self.buttons_on_watch.add(button.id)
+
+    def button_action(self, comp, btn):
+        comp.refresh_from_db()
+        for j, ctrl in enumerate(comp.config.get('controls', [])):
+            if ctrl['input'] == f'button-{btn.id}':
+                method = ctrl.get('method', 'momentary')
+                print(
+                    f"Button [{j}] {btn}: {btn.value} on {comp} "
+                    f"| Btn type: {method}"
+                )
+                comp.controller._ctrl(j, btn.value, method)
+                break

simo/fleet/migrations/0036_auto_20240605_0702.py

@@ -0,0 +1,68 @@
+# Generated by Django 3.2.9 on 2024-06-05 07:02
+
+from django.db import migrations
+
+
+def forwards_func(apps, schema_editor):
+    from simo.fleet.utils import GPIO_PINS
+    Component = apps.get_model("core", "Component")
+    Colonel = apps.get_model('fleet', "Colonel")
+    ColonelPin = apps.get_model('fleet', "ColonelPin")
+    for comp in Component.objects.filter(config__has_key='controls'):
+        if not isinstance(comp.config['controls'], list):
+            continue
+        for ctrl in comp.config['controls']:
+            if 'pin_no' in ctrl and 'pin' in ctrl:
+                ctrl['input'] = f"pin-{ctrl['pin']}"
+                del ctrl['pin']
+            if 'pin' in ctrl and 'pin_no' not in ctrl:
+                # time to fix legacy remainings..
+                colonel = Colonel.objects.filter(
+                    id=comp.config.get('colonel', 0)
+                ).first()
+                if not colonel:
+                    # Colonel no longer exists, there is no point in
+                    # continuing with this
+                    comp.config['controls'] = []
+                    continue
+                try:
+                    pin_no = ctrl['pin']
+                except:
+                    continue
+
+                pin_data = {}
+                for no, pin_data in GPIO_PINS.get(colonel.type).items():
+                    if no == pin_no:
+                        break
+                pin, new = ColonelPin.objects.get_or_create(
+                    colonel=colonel, no=pin_no,
+                    defaults={
+                        'input': pin_data.get('input'),
+                        'output': pin_data.get('output'),
+                        'capacitive': pin_data.get('capacitive'),
+                        'adc': pin_data.get('adc'),
+                        'native': pin_data.get('native'),
+                        'note': pin_data.get('note')
+                    }
+                )
+
+                ctrl['pin_no'] = pin.no
+                ctrl['input'] = f'pin-{pin.id}'
+                del ctrl['pin']
+
+        comp.save()
+
+
+def reverse_func(apps, schema_editor):
+    pass
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('fleet', '0035_auto_20240514_0855'),
+    ]
+
+    operations = [
+        migrations.RunPython(forwards_func, reverse_func, elidable=True),
+    ]

simo/fleet/migrations/0037_alter_colonelpin_options_alter_colonelpin_no_and_more.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.10 on 2024-06-12 08:14
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('fleet', '0036_auto_20240605_0702'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='colonelpin',
+            options={'ordering': ('colonel', 'no')},
+        ),
+        migrations.AlterField(
+            model_name='colonelpin',
+            name='no',
+            field=models.PositiveIntegerField(db_index=True),
+        ),
+        migrations.AlterField(
+            model_name='interfaceaddress',
+            name='address_type',
+            field=models.CharField(choices=[('i2c', 'I2C'), ('dali-gear', 'DALI Gear'), ('dali-group', 'DALI Gear Group'), ('dali-device', 'DALI Control Device')], db_index=True, max_length=100),
+        ),
+    ]

simo/fleet/models.py

@@ -203,7 +203,7 @@ class ColonelPin(models.Model):
     colonel = models.ForeignKey(
         Colonel, related_name='pins', on_delete=models.CASCADE
     )
-    no = models.PositiveIntegerField()
+    no = models.PositiveIntegerField(db_index=True)
     label = models.CharField(db_index=True, max_length=200)
     input = models.BooleanField(default=False, db_index=True)
     output = models.BooleanField(default=False, db_index=True)
@@ -227,6 +227,7 @@ class ColonelPin(models.Model):
 
     class Meta:
         unique_together = 'colonel', 'no'
+        ordering = 'colonel', 'no'
         indexes = [
             models.Index(
                 fields=["occupied_by_content_type", "occupied_by_id"]
@@ -255,9 +256,11 @@ def after_colonel_save(sender, instance, created, *args, **kwargs):
         for no, data in GPIO_PINS.get(instance.type).items():
             ColonelPin.objects.get_or_create(
                 colonel=instance, no=no,
-                input=data.get('input'), output=data.get('output'),
-                capacitive=data.get('capacitive'), adc=data.get('adc'),
-                native=data.get('native'), note=data.get('note')
+                defaults = {
+                    'input': data.get('input'), 'output': data.get('output'),
+                    'capacitive': data.get('capacitive'), 'adc': data.get('adc'),
+                    'native': data.get('native'), 'note': data.get('note')
+                }
             )
         fleet_gateway, new = Gateway.objects.get_or_create(
             type='simo.fleet.gateways.FleetGatewayHandler'
@@ -266,6 +269,31 @@ def after_colonel_save(sender, instance, created, *args, **kwargs):
             fleet_gateway.start()
 
 
+@receiver(post_save, sender=Component)
+def post_component_save(sender, instance, created, *args, **kwargs):
+    if not instance.controller_uid.startswith('simo.fleet'):
+        return
+    if 'config' not in instance.get_dirty_fields():
+        return
+    colonel = Colonel.objects.filter(id=instance.config.get('colonel', 0)).first()
+    if not colonel:
+        return
+    colonel.components.add(instance)
+    from .controllers import (
+        TTLock, DALILamp, DALIGearGroup, DALIRelay, DALIOccupancySensor,
+        DALILightSensor, DALIButton
+    )
+    if instance.controller and instance.controller_cls in (
+        TTLock, DALILamp, DALIGearGroup, DALIRelay, DALIOccupancySensor,
+        DALILightSensor, DALIButton
+    ):
+        return
+    colonel.rebuild_occupied_pins()
+    colonel.save()
+    colonel.update_config()
+
+
+
 @receiver(pre_delete, sender=Component)
 def post_component_delete(sender, instance, *args, **kwargs):
     if not instance.controller_uid.startswith('simo.fleet'):
@@ -274,7 +302,7 @@ def post_component_delete(sender, instance, *args, **kwargs):
     from .controllers import DALIGearGroup
     if instance.controller_uid == DALIGearGroup.uid:
         for comp in Component.objects.filter(
-                id__in=instance.config.get('members', [])
+            id__in=instance.config.get('members', [])
         ):
             instance.controller._modify_member_group(
                 comp, instance.config.get('da', 0), remove=True
@@ -360,7 +388,8 @@ class InterfaceAddress(models.Model):
         db_index=True, max_length=100, choices=(
             ('i2c', "I2C"),
             ('dali-gear', "DALI Gear"),
-            ('dali-group', "DALI Gear Group")
+            ('dali-group', "DALI Gear Group"),
+            ('dali-device', "DALI Control Device"),
         )
     )
     address = models.JSONField(db_index=True)

simo/fleet/socket_consumers.py

@@ -102,7 +102,7 @@ class FleetConsumer(AsyncWebsocketConsumer):
                 )
                 if not new:
                     for key, val in defaults.items():
-                        if key in ('new', ):
+                        if key == 'name':
                             continue
                         setattr(colonel, key, val)
                     colonel.save()

simo/fleet/templates/fleet/controllers_info/button.md

@@ -0,0 +1,16 @@
+This component represents a physical button that can be used with other components in the system as a control input.
+Usually, it is better to use the input ports of a colonel board directly as input controls. 
+However, if you want to control something that is connected to a different colonel or control more than one component with a single button, then this component provides a way to do it.
+
+- Create a button first, then use it as a control input on components that you want to control.
+- Use GND as a reference. 
+- PULL -> UP if used with SIMO.io input port module.
+
+{% if component.controller.bonded_gear %}
+---
+### Bonded gear:
+
+{% for comp in component.controller.bonded_gear %}
+- [{{comp.id}}] {{ comp }}
+{% endfor %}
+{% endif %}

simo/fleet/utils.py

@@ -1,3 +1,6 @@
+from simo.core.utils.cache import get_cached_data
+from simo.core.middleware import get_current_instance
+
 GPIO_PIN_DEFAULTS = {
     'output': True, 'input': True, 'default_pull': 'FLOATING',
     'native': True, 'adc': False,
@@ -118,4 +121,31 @@ for no, data in BASE_ESP32_GPIO_PINS.items():
 
 INTERFACES_PINS_MAP = {
     1: [13, 23], 2: [32, 33]
-}
+}
+
+
+def get_all_control_input_choices():
+    '''
+    This is called multiple times by component form,
+    so we cache the data to speed things up!
+    '''
+    def get_control_input_choices():
+        from .models import ColonelPin
+        from simo.core.models import Component
+        pins_qs = ColonelPin.objects.all()
+
+        buttons_qs = Component.objects.filter(
+            base_type='button'
+        ).select_related('zone')
+
+        return [(f'pin-{pin.id}', str(pin)) for pin in pins_qs] + \
+               [(f'button-{button.id}',
+                 f"{button.zone.name} | {button.name}"
+                 if button.zone else button.name)
+                for button in buttons_qs]
+
+    instance = get_current_instance()
+
+    return get_cached_data(
+        f'{instance.id}-fleet-control-inputs', get_control_input_choices, 10
+    )

simo/fleet/views.py

@@ -2,6 +2,7 @@ from django.http import HttpResponse, Http404
 from django.db.models import Q
 from dal import autocomplete
 from simo.core.utils.helpers import search_queryset
+from simo.core.models import Component
 from .models import Colonel, ColonelPin, Interface
 
 
@@ -61,3 +62,47 @@ class InterfaceSelectAutocomplete(autocomplete.Select2QuerySetView):
             qs = qs.filter(**self.forwarded.get('filters'))
 
         return qs
+
+
+class ControlInputSelectAutocomplete(autocomplete.Select2ListView):
+
+    def get_list(self):
+
+        try:
+            colonel = Colonel.objects.get(
+                pk=self.forwarded.get("colonel")
+            )
+            pins_qs = ColonelPin.objects.filter(colonel=colonel)
+        except:
+            pins_qs = ColonelPin.objects.all()
+
+        if self.forwarded.get('self') and self.forwarded['self'].startswith('pin-'):
+            pins_qs = pins_qs.filter(
+                Q(occupied_by_id=None) | Q(id=int(self.forwarded['self'][4:]))
+            )
+        else:
+            pins_qs = pins_qs.filter(occupied_by_id=None)
+
+        if self.forwarded.get('pin_filters'):
+            pins_qs = pins_qs.filter(**self.forwarded.get('pin_filters'))
+
+        if self.q:
+            pins_qs = search_queryset(pins_qs, self.q, ('label',))
+
+        buttons_qs = Component.objects.filter(
+            base_type='button'
+        ).select_related('zone')
+
+        if self.forwarded.get('button_filters'):
+            buttons_qs = buttons_qs.filter(**self.forwarded.get('button_filters'))
+
+        if self.q:
+            buttons_qs = search_queryset(
+                buttons_qs, self.q, ('name', 'zone__name', 'category__name')
+            )
+
+        return [(f'pin-{pin.id}', str(pin)) for pin in pins_qs] + \
+               [(f'button-{button.id}',
+                 f"{button.zone.name} | {button.name}"
+                 if button.zone else button.name)
+                for button in buttons_qs]

simo/generic/controllers.py

@@ -223,7 +223,7 @@ class Thermostat(ControllerBase):
     def default_config(self):
         min = 3
         max = 36
-        if dynamic_settings['core__units_of_measure'] == 'imperial':
+        if self.component.zone.instance.units_of_measure == 'imperial':
             min = 36
             max = 100
         return {
@@ -237,7 +237,7 @@ class Thermostat(ControllerBase):
         raise ValidationError("This component type does not accept set value!")
 
     def _get_default_user_config(self):
-        if dynamic_settings['core__units_of_measure'] == 'imperial':
+        if self.component.zone.instance.units_of_measure == 'imperial':
             target_temp = 70
             low_target = 60
             high_target = 75
@@ -681,31 +681,51 @@ class Blinds(ControllerBase, TimerMixin):
 
     @property
     def default_value(self):
-        # target and current positions in milliseconds
-        return {'target': 0, 'position': 0}
+        # 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 type(value) not in (float, int):
+            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(
-                    "target position for blinds to go."
+                    "Bad target position for blinds to go."
                 )
-            if value > self.component.config.get('open_duration') * 1000:
+            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,
-                        value
+                        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['angle']
 
         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'):
+                if key not in ('target', 'position', 'angle'):
                     raise ValidationError(
-                        "'target' or 'position' parameter expected."
+                        "'target', 'position' or 'angle' parameters are expected."
                     )
                 if key == 'position':
                     if val < 0:
@@ -725,17 +745,31 @@ class Blinds(ControllerBase, TimerMixin):
                 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):
-        self.send(0)
+        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):
-        self.send(self.component.config['open_duration'] * 1000)
+        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):
-        self.send(-1)
+        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):
@@ -1433,10 +1467,8 @@ class AlarmClock(ControllerBase):
         return current_value
 
 
-# ----------- Dummy controllers -----------------------------
-
 class StateSelect(ControllerBase):
-    gateway_class = DummyGatewayHandler
+    gateway_class = GenericGatewayHandler
     name = _("State select")
     base_type = 'state-select'
     app_widget = StateSelectWidget
@@ -1452,40 +1484,51 @@ class StateSelect(ControllerBase):
         return value
 
 
+# ----------- Dummy controllers -----------------------------
+
 class DummyBinarySensor(BinarySensor):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummyNumericSensor(NumericSensor):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummyMultiSensor(MultiSensor):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummySwitch(Switch):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummyDoubleSwitch(DoubleSwitch):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummyTripleSwitch(TripleSwitch):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummyQuadrupleSwitch(QuadrupleSwitch):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummyQuintupleSwitch(QuintupleSwitch):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummyDimmer(Dimmer):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
     def _prepare_for_send(self, value):
         if self.component.config.get('inverse'):
@@ -1495,7 +1538,9 @@ class DummyDimmer(Dimmer):
 
 class DummyDimmerPlus(DimmerPlus):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'
 
 
 class DummyRGBWLight(RGBWLight):
     gateway_class = DummyGatewayHandler
+    info_template_path = 'generic/controllers_info/dummy.md'

simo/generic/forms.py

@@ -273,9 +273,6 @@ class ThermostatConfigForm(BaseComponentForm):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        if dynamic_settings['core__units_of_measure'] == 'imperial':
-            self.fields['min'].initial = 36
-            self.fields['max'].initial = 100
         if self.instance.pk:
             self.fields['mode'].initial = \
                 self.instance.config['user_config']['mode']

simo/generic/gateways.py

@@ -12,6 +12,7 @@ from django.db import connection as db_connection
 from django.db.models import Q
 import paho.mqtt.client as mqtt
 from simo.core.models import Component
+from simo.core.middleware import introduce_instance
 from simo.core.gateways import BaseObjectCommandsGatewayHandler
 from simo.core.forms import BaseGatewayForm
 from simo.core.utils.logs import StreamToLogger
@@ -131,6 +132,7 @@ class ScriptRunHandler(multiprocessing.Process):
         self.component = Component.objects.get(id=self.component_id)
         tz = pytz.timezone(self.component.zone.instance.timezone)
         timezone.activate(tz)
+        introduce_instance(self.component.zone.instance)
         self.logger = get_component_logger(self.component)
         sys.stdout = StreamToLogger(self.logger, logging.INFO)
         sys.stderr = StreamToLogger(self.logger, logging.ERROR)

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

@@ -26,7 +26,8 @@
 
   <span style="bottom: 5px; position: relative;">
     position: <strong id='blinds_position'>{{ obj.value.position }}</strong>,
-    target: <strong id='blinds_target'>{{ obj.value.target }}</strong>
+    target: <strong id='blinds_target'>{{ obj.value.target }}</strong>,
+    angle: <strong id='blinds_angle'>{{ obj.value.angle }}</strong>
   </span>
 
 </div>

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

@@ -9,5 +9,5 @@
     position: relative;
     bottom: -4px;
 "></span>
- {{ obj.value.current.temp }}ᴼ {% if global_preferences.core__units_of_measure == 'metric' %}C{% else %}F{% endif %}
+ {{ obj.value.current.temp }}ᴼ {% if obj__zone__instance__units_of_measure == 'metric' %}C{% else %}F{% endif %}
 </div>

simo/generic/templates/generic/controllers_info/dummy.md

@@ -0,0 +1,3 @@
+Dummy components do not represent any real devices; 
+however, they are handy when you are in the process 
+of building custom, script-based systems.

simo/generic/templates/generic/controllers_info/stateselect.md

@@ -0,0 +1,2 @@
+This component does not represent any real device; 
+however it is super handy if you are in a process of building state aware systems. 

simo/{_hub_template → management/_hub_template}/hub/nginx.conf

@@ -4,7 +4,7 @@ server{
 
     charset     utf-8;
 
-    client_max_body_size 20M;
+    client_max_body_size 100M;
 
 
     location /protected/static {
@@ -55,7 +55,7 @@ server{
 
     ssl_session_cache shared:TLS:2m;
 
-    client_max_body_size 20M;
+    client_max_body_size 100M;
 
 
     location /protected/static {