simo 2.8.15__py3-none-any.whl → 2.10.1__py3-none-any.whl

simo/fleet/forms.py

@@ -1,10 +1,11 @@
 import time
+import datetime
 from django import forms
 from django.utils.translation import gettext_lazy as _
 from django.forms import formset_factory
 from django.urls.base import get_script_prefix
 from django.contrib.contenttypes.models import ContentType
-from dal import autocomplete
+from django.utils import timezone
 from dal import forward
 from simo.core.models import Component
 from simo.core.forms import (
@@ -24,7 +25,7 @@ from simo.core.form_fields import (
 )
 from simo.core.form_fields import PlainLocationField
 from simo.users.models import PermissionsRole
-from .models import Colonel, ColonelPin, Interface
+from .models import Colonel, ColonelPin, Interface, CustomDaliDevice
 from .utils import INTERFACES_PINS_MAP, get_all_control_input_choices
 
 
@@ -1817,4 +1818,132 @@ class DALILightSensorConfigForm(DALIDeviceConfigForm, BaseComponentForm):
 
 
 class DALIButtonConfigForm(DALIDeviceConfigForm, BaseComponentForm):
-    pass
+    pass
+
+
+class CustomDaliDeviceForm(BaseComponentForm):
+    device = forms.ChoiceField()
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        choices = []
+        instance = get_current_instance()
+        for colonel in Colonel.objects.filter(
+                type='room-sensor', instance=instance
+        ):
+            if not colonel.is_connected:
+                continue
+            choices.append((f"wifi-{colonel.id}", colonel.name))
+        for device in CustomDaliDevice.objects.filter(
+                instance=instance,
+                last_seen__gt=timezone.now() - datetime.timedelta(minutes=10)
+        ):
+            choices.append((f"dali-{device.id}", device.name))
+        self.fields['device'].choices = choices
+
+    def get_device(self, field_val):
+        if field_val.startswith('wifi'):
+            return Colonel.objects.filter(
+                id=self.cleaned_data['device'][5:]
+            ).first()
+        else:
+            return CustomDaliDevice.objects.filter(
+                id=self.cleaned_data['device'][5:]
+            )
+
+
+class RoomSensorDeviceConfigForm(CustomDaliDeviceForm):
+
+    def save(self, commit=True):
+        from simo.core.models import Icon
+        colonel = None
+        dali_device = None
+        device = self.get_device(self.cleaned_data['device'])
+        if not device:
+            return
+        if isinstance(device, CustomDaliDevice):
+            dali_device = device
+        else:
+            colonel = device
+
+        from .controllers import (
+            AirQualitySensor, TempHumSensor, AmbientLightSensor,
+            RoomPresenceSensor
+        )
+
+        org_name = self.cleaned_data['name']
+        org_icon = self.cleaned_data['icon']
+        for CtrlClass, icon, suffix in (
+            (AirQualitySensor, 'leaf', 'air quality'),
+            (TempHumSensor, 'temperature-half', 'temperature'),
+            (AmbientLightSensor, 'brightness-low', 'brightness'),
+            (RoomPresenceSensor, 'person', 'presence')
+        ):
+            default_icon = Icon.objects.filter(slug=icon).first()
+            if default_icon:
+                self.cleaned_data['icon'] = default_icon.slug
+            else:
+                self.cleaned_data['icon'] = org_icon
+            self.cleaned_data['name'] = f"{org_name} {suffix}"
+
+            if colonel:
+                comp = Component.objects.filter(
+                    config__colonel=colonel.id,
+                    controller_uid=CtrlClass.uid
+                ).first()
+            else:
+                comp = Component.objects.filter(
+                    config__dali_device=dali_device.id,
+                    controller_uid=CtrlClass.uid
+                ).first()
+
+            form = CtrlClass.config_form(
+                controller_uid=CtrlClass.uid, instance=comp,
+                data=self.cleaned_data
+            )
+            if form.is_valid():
+                comp = form.save()
+                if colonel:
+                    comp.config['colonel'] = colonel.id
+                else:
+                    comp.config['dali_device'] = dali_device.id
+                comp.save()
+            else:
+                raise Exception(form.errors)
+
+        if colonel:
+            GatewayObjectCommand(
+                comp.gateway, colonel, id=comp.id,
+                command='call', method='update_config', args=[
+                    comp.controller._get_colonel_config()
+                ]
+            ).publish()
+
+        return comp
+
+
+class RoomZonePresenceConfigForm(CustomDaliDeviceForm):
+
+    def clean_device(self):
+        value = self.cleaned_data['device']
+        if value.startswith('wifi'):
+            return value
+        from .controllers import RoomZonePresenceSensor
+        dali_device = CustomDaliDevice.objects.filter(
+            id=value[5:]
+        ).first()
+        free_slots = {0, 1, 2, 3, 4, 5, 6, 7}
+        for comp in Component.objects.filter(
+            controller_uid=RoomZonePresenceSensor.uid,
+            config__dali_device=dali_device.id
+        ):
+            try:
+                free_slots.remove(int(comp.config['slot']))
+            except:
+                continue
+        if not free_slots:
+            raise forms.ValidationError(
+                "This device already has 8 zones defined. "
+                "Please first delete some to add a new one."
+            )
+        return value

simo/fleet/managers.py

@@ -8,7 +8,9 @@ class ColonelsManager(models.Manager):
         qs = super().get_queryset()
         instance = get_current_instance()
         if instance:
-            qs = qs.filter(instance__is_active=True)
+            qs = qs.filter(
+                instance__is_active=True
+            )
         return qs
 
 

simo/fleet/migrations/0045_alter_colonel_type_customdalidevice.py

@@ -0,0 +1,29 @@
+# Generated by Django 4.2.10 on 2025-04-03 14:35
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0049_alter_gateway_type'),
+        ('fleet', '0044_auto_20241210_0707'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='colonel',
+            name='type',
+            field=models.CharField(choices=[('4-relays', '4 Relay'), ('ample-wall', 'Ample Wall'), ('game-changer', 'Game Changer'), ('game-changer-mini', 'Game Changer Mini'), ('room-sensor', 'Room Sensor')], default='ample-wall', max_length=20),
+        ),
+        migrations.CreateModel(
+            name='CustomDaliDevice',
+            fields=[
+                ('random_address', models.PositiveIntegerField(primary_key=True, serialize=False)),
+                ('name', models.CharField(help_text='User given name on initial pairing', max_length=200)),
+                ('colonel', models.ForeignKey(blank=True, editable=False, help_text='Colonel on which it has already appeared.', null=True, on_delete=django.db.models.deletion.SET_NULL, to='fleet.colonel')),
+                ('instance', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='core.instance')),
+            ],
+        ),
+    ]

simo/fleet/migrations/0046_delete_customdalidevice.py

@@ -0,0 +1,16 @@
+# Generated by Django 4.2.10 on 2025-04-04 05:28
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('fleet', '0045_alter_colonel_type_customdalidevice'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='CustomDaliDevice',
+        ),
+    ]

simo/fleet/migrations/0047_customdalidevice.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.10 on 2025-04-04 05:32
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0049_alter_gateway_type'),
+        ('fleet', '0046_delete_customdalidevice'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CustomDaliDevice',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('random_address', models.PositiveIntegerField(db_index=True, editable=False)),
+                ('name', models.CharField(help_text='User given name on initial pairing', max_length=200)),
+                ('colonel', models.ForeignKey(blank=True, editable=False, help_text='Colonel on which it has already appeared.', null=True, on_delete=django.db.models.deletion.SET_NULL, to='fleet.colonel')),
+                ('instance', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='core.instance')),
+            ],
+            options={
+                'unique_together': {('instance', 'random_address')},
+            },
+        ),
+    ]

simo/fleet/migrations/0048_remove_customdalidevice_colonel_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.10 on 2025-04-07 07:27
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('fleet', '0047_customdalidevice'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='customdalidevice',
+            name='colonel',
+        ),
+        migrations.AddField(
+            model_name='customdalidevice',
+            name='interface',
+            field=models.ForeignKey(blank=True, editable=False, help_text='Colonel interface on which it operates.', null=True, on_delete=django.db.models.deletion.SET_NULL, to='fleet.interface'),
+        ),
+        migrations.AddField(
+            model_name='customdalidevice',
+            name='last_seen',
+            field=models.DateTimeField(editable=False, null=True),
+        ),
+    ]

simo/fleet/models.py

@@ -1,5 +1,6 @@
 import requests
 import time
+import random
 from actstream import action
 from django.core.exceptions import ValidationError
 from django.db import transaction
@@ -61,6 +62,7 @@ class Colonel(DirtyFieldsMixin, models.Model):
             ('ample-wall', "Ample Wall"),
             ('game-changer', "Game Changer"),
             ('game-changer-mini', "Game Changer Mini"),
+            ('room-sensor', "Room Sensor")
         )
     )
     firmware_version = models.CharField(
@@ -258,7 +260,7 @@ class ColonelPin(models.Model):
 @receiver(post_save, sender=Colonel)
 def after_colonel_save(sender, instance, created, *args, **kwargs):
     if created:
-        for no, data in GPIO_PINS.get(instance.type).items():
+        for no, data in GPIO_PINS.get(instance.type, {}).items():
             ColonelPin.objects.get_or_create(
                 colonel=instance, no=no,
                 defaults={
@@ -306,11 +308,13 @@ def post_component_save(sender, instance, created, *args, **kwargs):
     colonel.components.add(instance)
     from .controllers import (
         TTLock, DALILamp, DALIGearGroup, DALIRelay, DALIOccupancySensor,
-        DALILightSensor, DALIButton
+        DALILightSensor, DALIButton,
+        AirQualitySensor, TempHumSensor, AmbientLightSensor, RoomPresenceSensor
     )
     if instance.controller and instance.controller_cls in (
         TTLock, DALILamp, DALIGearGroup, DALIRelay, DALIOccupancySensor,
-        DALILightSensor, DALIButton
+        DALILightSensor, DALIButton,
+        AirQualitySensor, TempHumSensor, AmbientLightSensor, RoomPresenceSensor
     ):
         return
     colonel.rebuild_occupied_pins()
@@ -466,16 +470,13 @@ def post_interface_save(sender, instance, created, *args, **kwargs):
                 address=addr,
             )
     elif instance.type == 'dali':
-        InterfaceAddress.objects.filter(
-            interface=instance
-        ).exclude(address_type__startswith='dali').delete()
         for addr in range(64):
-            InterfaceAddress.objects.create(
+            InterfaceAddress.objects.get_or_create(
                 interface=instance, address_type='dali-gear',
                 address=addr,
             )
         for addr in range(16):
-            InterfaceAddress.objects.create(
+            InterfaceAddress.objects.get_or_create(
                 interface=instance, address_type='dali-group',
                 address=addr,
             )
@@ -492,4 +493,48 @@ def post_interface_delete(sender, instance, *args, **kwargs):
             occupied_by_content_type=ct,
             occupied_by_id=instance.id
         ):
-            pin.occupied_by_content_type = None
+            pin.occupied_by_content_type = None
+
+
+class CustomDaliDevice(models.Model):
+    '''
+    Our own custom dali line device, 
+    not compatible with anything else of DALI!
+    '''
+    instance = models.ForeignKey(Instance, on_delete=models.CASCADE)
+    random_address = models.PositiveIntegerField(db_index=True, editable=False)
+    name = models.CharField(
+        max_length=200, help_text="User given name on initial pairing"
+    )
+    interface = models.ForeignKey(
+        Interface, null=True, blank=True, editable=False,
+        on_delete=models.SET_NULL, related_name='custom_devices',
+        help_text="Colonel interface on which it operates."
+    )
+    last_seen = models.DateTimeField(null=True, editable=False)
+
+    class Meta:
+        unique_together = 'instance', 'random_address'
+
+    def save(self, *args, **kwargs):
+        if not self.random_address:
+            while True:
+                self.random_address = random.randint(0, 255)
+                if CustomDaliDevice.objects.filter(
+                    random_address=self.random_address,
+                    instance=self.instance
+                ).first():
+                    continue
+                break
+        return super().save(*args, **kwargs)
+
+    def transmit(self, frame):
+        from .gateways import FleetGatewayHandler
+        frame[0:7] = self.random_address
+        gateway = Gateway.objects.filter(type=FleetGatewayHandler.uid).first()
+        GatewayObjectCommand(
+            gateway, self.interface.colonel,
+            command='da-tx', interface=self.interface.no,
+            msg=frame.pack.hex()
+        ).publish()
+

simo/fleet/serializers.py

@@ -1,6 +1,8 @@
 from rest_framework import serializers
 from simo.core.serializers import TimestampField
-from .models import InstanceOptions, Colonel, ColonelPin, Interface
+from .models import (
+    InstanceOptions, Colonel, ColonelPin, Interface, CustomDaliDevice
+)
 
 
 class InstanceOptionsSerializer(serializers.ModelSerializer):
@@ -84,3 +86,15 @@ class ColonelSerializer(serializers.ModelSerializer):
         instance = super().update(instance, validated_data)
         instance.update_config()
         return instance
+
+
+class CustomDaliDeviceSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = CustomDaliDevice
+        fields = 'id', 'random_address', 'name'
+        read_only_fields = 'random_address',
+
+    def create(self, validated_data):
+        validated_data['instance'] = self.context['instance']
+        return super().create(validated_data)

simo/fleet/socket_consumers.py

@@ -450,6 +450,12 @@ class FleetConsumer(AsyncWebsocketConsumer):
                         process_discovery_result, thread_sensitive=True
                     )()
 
+                elif 'dali-raw' in data:
+                    from .custom_dali_operations import process_frame
+                    await sync_to_async(process_frame, thread_sensitive=True)(
+                        self.colonel.id, data['dali-raw'], data['data']
+                    )
+
 
             elif bytes_data:
                 if not self.colonel_logger:

simo/fleet/tasks.py

@@ -20,18 +20,38 @@ def check_colonels_connected():
 @celery_app.task
 def check_colonel_components_alive():
     from simo.core.models import Component
-    from .models import Colonel
+    from .gateways import FleetGatewayHandler
+    from .models import Colonel, CustomDaliDevice
     drop_current_instance()
     for lost_colonel in Colonel.objects.filter(
         last_seen__lt=timezone.now() - datetime.timedelta(seconds=60)
     ).prefetch_related(Prefetch(
         'components', queryset=Component.objects.filter(alive=True),
         to_attr='alive_components'
-    )):
+    ), 'interfaces'):
         for comp in lost_colonel.alive_components:
             print(f"{comp} is no longer alive!")
             comp.alive = False
             comp.save()
+        for interface in lost_colonel.interfaces.all():
+            if interface.type == 'dali':
+                for device in interface.custom_devices.all():
+                    for comp in Component.objects.filter(
+                        gateway__type=FleetGatewayHandler.uid,
+                        config__dali_device=device.id, alive=True
+                    ):
+                        comp.alive = False
+                        comp.save()
+
+    for device in CustomDaliDevice.objects.filter(
+        last_seen__gt=timezone.now() - datetime.timedelta(seconds=60)
+    ):
+        for comp in Component.objects.filter(
+            gateway__type=FleetGatewayHandler.uid,
+            config__dali_device=device.id, alive=True
+        ):
+            comp.alive = False
+            comp.save()
 
 
 @celery_app.on_after_finalize.connect

simo/fleet/templates/fleet/controllers_info/RoomZonePresenceSensor.md

@@ -0,0 +1,8 @@
+Detects human presence in particular zone of a room.  
+
+{% if component %}
+{% else %}
+**IMPORTANT!** Make sure the room is empty!  
+  
+Take position in desired area where presence needs to be detected, before continuing.
+{% endif %}

simo/generic/controllers.py

@@ -69,11 +69,16 @@ class Thermostat(ControllerBase):
 
     @property
     def default_config(self):
-        min = 3
-        max = 100
+        instance = get_current_instance()
+        min = 4
+        max = 36
+        if instance and instance.units_of_measure == 'imperial':
+            min = 40
+            max = 95
         return {
             'temperature_sensor': 0, 'heater': 0, 'cooler': 0,
-            'reaction_difference': 0, 'min': min, 'max': max,
+            'engagement': 'dynamic','reaction_difference': 2,
+            'min': min, 'max': max,
             'has_real_feel': False,
             'user_config': config_to_dict(self._get_default_user_config())
         }
@@ -161,12 +166,12 @@ class Thermostat(ControllerBase):
         temperature_sensor = Component.objects.filter(
             pk=self.component.config.get('temperature_sensor')
         ).first()
-        heater = Component.objects.filter(
-            pk=self.component.config.get('heater')
-        ).first()
-        cooler = Component.objects.filter(
-            pk=self.component.config.get('cooler')
-        ).first()
+        heaters = Component.objects.filter(
+            pk__in=self.component.config.get('heater')
+        )
+        coolers = Component.objects.filter(
+            pk__in=self.component.config.get('cooler')
+        )
 
         if not temperature_sensor or not temperature_sensor.alive:
             self.component.error_msg = "No temperature sensor"
@@ -187,50 +192,100 @@ class Thermostat(ControllerBase):
         target_temp = self.get_current_target_temperature()
         mode = self.component.config['user_config'].get('mode', 'auto')
 
+        low = target_temp - self.component.config['reaction_difference']
+        high = target_temp + self.component.config['reaction_difference']
+
+        heating = False
+        cooling = False
+
+        if self.component.config.get('engagement', 'static'):
+            if heaters:
+                for heater in heaters:
+                    if current_temp < low:
+                        if heater.base_type == 'dimmer':
+                            heater.max_out()
+                        else:
+                            heater.turn_on()
+                        heating = True
+                    elif current_temp > high:
+                        heater.turn_off()
+                        heating = False
+                    else:
+                        if heater.value:
+                            heating = True
+                            break
+
+            if coolers:
+                for cooler in coolers:
+                    if heating: # Do not cool if heating!
+                        cooler.turn_off()
+                    else:
+                        if current_temp > high:
+                            if heater.base_type == 'dimmer':
+                                cooler.max_out()
+                            else:
+                                cooler.turn_on()
+                            cooling = True
+                        elif current_temp < low:
+                            if cooler.value:
+                                cooler.turn_off()
+                            cooling = False
+                        else:
+                            if cooler.value:
+                                cooling = True
+                                break
+
+        else:
+            window = high - low
+            if heaters:
+                reach = high - current_temp
+                reaction_force = self._get_reaction_force(window, reach)
+                if reaction_force:
+                    heating = True
+                self._engage_devices(heaters, reaction_force)
+            if coolers:
+                if heating: # Do not cool if heating!
+                    reaction_force = 0
+                else:
+                    reach = current_temp - low
+                    reaction_force = self._get_reaction_force(window, reach)
+                self._engage_devices(coolers, reaction_force)
+
         self.component.set({
             'mode': mode,
             'current_temp': current_temp,
             'target_temp': target_temp,
-            'heating': False, 'cooling': False
+            'heating': heating, 'cooling': cooling
         }, actor=get_system_user())
 
-        low = target_temp - self.component.config['reaction_difference'] / 2
-        high = target_temp + self.component.config['reaction_difference'] / 2
-
-        if mode in ('auto', 'heater'):
-            if (not heater or not heater.alive) and mode == 'heater':
-                self.component.error_msg = "No heater"
-                self.component.alive = False
-                self.component.save()
-                return
-            if current_temp < low:
-                if not heater.value:
-                    heater.turn_on()
-                self.component.value['heating'] = True
-            elif current_temp > high:
-                if heater.value:
-                    heater.turn_off()
-                self.component.value['heating'] = False
-        if mode in ('auto', 'cooler') and cooler:
-            if not cooler or not cooler.alive:
-                if mode == 'cooler' or (not heater or not heater.alive):
-                    print(f"No cooler or heater on {self.component}!")
-                    self.component.alive = False
-                    self.component.save()
-                    return
-            if current_temp > high:
-                if not cooler.value:
-                    cooler.turn_on()
-                self.component.value['cooling'] = True
-            elif current_temp < low:
-                if cooler.value:
-                    cooler.turn_off()
-                self.component.value['cooling'] = False
-
         self.component.error_msg = None
         self.component.alive = True
         self.component.save()
 
+
+    def _get_reaction_force(self, window, reach):
+        if reach > window:
+            reaction_force = 100
+        elif reach <= 0:
+            reaction_force = 0
+        else:
+            reaction_force = reach / window * 100
+        return reaction_force
+
+
+    def _engage_devices(self, devices, reaction_force):
+        for device in devices:
+            if device.base_type == 'dimmer':
+                device.output_percent(reaction_force)
+            elif device.base_type == 'switch':
+                if reaction_force == 100:
+                    device.turn_on()
+                elif reaction_force == 0:
+                    device.turn_off()
+                else:
+                    device.pulse(30, reaction_force)
+
+
     def update_user_conf(self, new_conf):
         self.component.refresh_from_db()
         self.component.config['user_config'] = validate_new_conf(
@@ -241,6 +296,7 @@ class Thermostat(ControllerBase):
         self.component.save()
         self.evaluate()
 
+
     def hold(self, temperature=None):
         if temperature != None:
             self.component.config['user_config']['hard'] = {