simo 2.0.32__py3-none-any.whl → 2.0.34__py3-none-any.whl

simo/cli.py

@@ -3,48 +3,35 @@ import sys
 import click
 import os
 import shutil
-import requests
-from subprocess import Popen, PIPE
 import simo
 from django.template import Context, Engine
 from django.core.management.utils import get_random_secret_key
 
 
-template_file_extensions = ['.py', '.conf']
-
-
 def copy_default_template(to_directory='/etc/SIMO'):
+    template_file_extensions = ['.py', '.conf']
+
     context = Context({
         'secret_key': get_random_secret_key(),
         'project_dir': to_directory,
         'base_dir': to_directory
     }, autoescape=False)
-
-
     template_dir = os.path.join(
         os.path.dirname(simo.__file__), '_hub_template'
     )
-
     prefix_length = len(template_dir) + 1
-
     for root, dirs, files in os.walk(template_dir):
-
         relative_dir = root[prefix_length:]
         target_dir = os.path.join(to_directory, relative_dir)
         os.makedirs(target_dir, exist_ok=True)
-
         for filename in files:
             if filename.endswith(('.pyo', '.pyc', '.py.class')):
                 # Ignore some files as they cause various breakages.
                 continue
-
             old_path = os.path.join(root, filename)
             new_path = os.path.join(target_dir, filename)
-
             os.makedirs(target_dir, exist_ok=True)
-
             fn, file_extension = os.path.splitext(new_path)
-
             if file_extension in template_file_extensions:
                 with open(old_path, encoding='utf-8') as template_file:
                     content = template_file.read()
@@ -54,9 +41,7 @@ def copy_default_template(to_directory='/etc/SIMO'):
                     new_file.write(content)
             else:
                 shutil.copyfile(old_path, new_path)
-
             shutil.copymode(old_path, new_path)
-
         for dirname in dirs[:]:
             if dirname.startswith('.') or dirname == '__pycache__':
                 dirs.remove(dirname)

simo/core/admin.py

@@ -261,8 +261,8 @@ class ComponentAdmin(admin.ModelAdmin):
         'alarm_category', 'show_in_app',
     )
     readonly_fields = (
-        'id', 'controller_uid', 'base_type', 'gateway', 'config', 'alive',
-        'battery_level',
+        'id', 'controller_uid', 'base_type', 'gateway', 'config',
+        'alive', 'error_msg', 'battery_level',
         'control', 'value', 'arm_status', 'history', 'meta'
     )
     list_filter = (

simo/core/api.py

@@ -125,6 +125,22 @@ class ZoneViewSet(InstanceMixin, viewsets.ModelViewSet):
         serializer.validated_data['instance'] = self.instance
         serializer.save()
 
+    @action(detail=False, methods=['post'])
+    def reorder(self, request, pk=None, *args, **kwargs):
+        data = request.data
+        if not isinstance(request.data, dict):
+            data = data.dict()
+        request_data = restore_json(data)
+        zones = {str(z.id): z for z in Zone.objects.filter(instance=self.instance)}
+        if len(request_data.get('zones', [])) != len(zones):
+            raise APIValidationError(
+                _('All zones must be provided to perform reorder.'), code=400
+            )
+        for i, id in enumerate(request_data.get('zones')):
+            zones[str(id)].order = i
+        Zone.objects.bulk_update([z for id, z in zones.items()], fields=['order'])
+        return RESTResponse({'status': 'success'})
+
 
 def get_components_queryset(instance, user):
     qs = Component.objects.filter(zone__instance=instance)
@@ -552,15 +568,32 @@ class StatesViewSet(InstanceMixin, viewsets.GenericViewSet):
         component_values = get_components_queryset(
             self.instance, request.user
         ).filter(zone__instance=self.instance).values(
-            'id', 'value', 'last_change', 'arm_status', 'battery_level',
-            'alive', 'meta'
+            'id', 'value', 'last_change', 'last_modified',
+            'arm_status', 'battery_level', 'alive', 'error_msg',
+            'meta'
         )
         for vals in component_values:
             vals['last_change'] = datetime.datetime.timestamp(
                 vals['last_change']
             )
+            vals['last_modified'] = datetime.datetime.timestamp(
+                vals['last_modified']
+            )
+
+        categories = Category.objects.filter(instance=self.instance).values(
+            'id', 'last_modified'
+        )
+        for cat in categories:
+            cat['last_modified'] = datetime.datetime.timestamp(
+                cat['last_modified']
+            )
+
 
         return RESTResponse({
+            'zones': Zone.objects.filter(instance=self.instance).values(
+                'id', 'name'
+            ),
+            'categories': categories,
             'component_values': component_values,
             'users': UserSerializer(
                 users_qs, many=True, context={
@@ -591,7 +624,8 @@ class ControllerTypes(InstanceMixin, viewsets.GenericViewSet):
                 'uid': uid,
                 'name': cls.name,
                 'is_discoverable': cls.is_discoverable,
-                'manual_add': cls.manual_add
+                'manual_add': cls.manual_add,
+                'discovery_msg': cls.discovery_msg
             })
 
         return RESTResponse(data)
@@ -634,10 +668,18 @@ class RunningDiscoveries(InstanceMixin, viewsets.GenericViewSet):
     def list(self, request, *args, **kwargs):
         return RESTResponse(self.get_data(self.get_gateways(request)))
 
-    @action(detail=False, methods=['get'])
+    @action(detail=False, methods=['get', 'post'])
     def retry(self, request, *args, **kwargs):
         gateways = self.get_gateways(request)
         if 'controller_uid' in request.GET:
             for gateway in gateways:
                 gateway.retry_discovery()
+        return RESTResponse(self.get_data(gateways))
+
+    @action(detail=False, methods=['get', 'post'])
+    def finish(self, request, *args, **kwargs):
+        gateways = self.get_gateways(request)
+        if 'controller_uid' in request.GET:
+            for gateway in gateways:
+                gateway.finish_discovery()
         return RESTResponse(self.get_data(gateways))

simo/core/controllers.py

@@ -33,8 +33,10 @@ class ControllerBase(ABC):
     admin_widget_template = 'admin/controller_widgets/generic.html'
     default_config = {}
     default_meta = {}
+    default_value_units = None
     discovery_msg = None
     manual_add = True # Can be added manually
+    family = None
 
     @property
     @abstractmethod
@@ -187,8 +189,6 @@ class ControllerBase(ABC):
             bulk_send_map = {self.component: value}
             for slave in self.component.slaves.all():
                 bulk_send_map[slave] = value
-
-            print("BULK SEND MAP: ", bulk_send_map)
             from .models import Component
             Component.objects.bulk_send(bulk_send_map)
             return
@@ -232,7 +232,9 @@ class ControllerBase(ABC):
         self.component.change_init_fingerprint = None
         self.component.save()
 
-    def _receive_from_device(self, value, is_alive=True, battery_level=None):
+    def _receive_from_device(
+        self, value, is_alive=True, battery_level=None, error_msg=None
+    ):
         value = self._prepare_for_set(value)
         actor = self._get_actor(value)
 
@@ -245,9 +247,11 @@ class ControllerBase(ABC):
         # in relation to the change of this component
         introduce(actor)
         self.component.alive = is_alive
+        if error_msg != None:
+            self.component.error_msg = error_msg if error_msg.strip() else None
         if battery_level:
             self.component.battery_level = battery_level
-        self.component.save(update_fields=['alive', 'battery_level'])
+        self.component.save(update_fields=['alive', 'battery_level', 'error_msg'])
         self.set(value, actor)
 
         if init_by_device and self.component.slaves.count():
@@ -465,7 +469,7 @@ class Dimmer(ControllerBase, TimerMixin, OnOffPokerMixin):
     admin_widget_template = 'admin/controller_widgets/knob.html'
     default_config = {'min': 0.0, 'max': 100.0, 'inverse': False}
     default_value = 0
-
+    default_value_units = '%'
 
     def _prepare_for_send(self, value):
         if isinstance(value, bool):
@@ -759,6 +763,7 @@ class Lock(Switch):
     base_type = 'lock'
     app_widget = LockWidget
     admin_widget_template = 'admin/controller_widgets/lock.html'
+    default_value = 'unlocked'
 
     UNLOCKED = 0
     LOCKED = 1
@@ -772,7 +777,9 @@ class Lock(Switch):
     def unlock(self):
         self.turn_off()
 
-    def _receive_from_device(self, value, is_alive=True, battery_level=None):
+    def _receive_from_device(
+        self, value, *args, **kwargs
+    ):
         if type(value) == bool:
             if value:
                 value = 'locked'
@@ -788,7 +795,7 @@ class Lock(Switch):
             }
             value = values_map.get(value, 'fault')
         return super()._receive_from_device(
-            value, is_alive=is_alive, battery_level=battery_level
+            value, *args, **kwargs
         )
 
     def _validate_val(self, value, occasion=None):

simo/core/forms.py

@@ -323,6 +323,7 @@ class ComponentAdminForm(forms.ModelForm):
                 self.instance.controller_uid = ControllerClass.uid
                 self.instance.base_type = self.controller.base_type
                 self.instance.value = self.controller.default_value
+                self.instance.value_units = self.controller.default_value_units
                 self.instance.value_previous = self.controller.default_value
                 self.instance.config = self.controller.default_config
                 self.instance.meta = self.controller.default_meta
@@ -393,7 +394,7 @@ class ComponentAdminForm(forms.ModelForm):
         fieldsets.extend([
             (_("Meta"), {
                 'fields': (
-                    'alive', 'battery_level',
+                    'alive', 'error_msg', 'battery_level',
                     'config', 'meta',
                     'value', 'value_units',
                     'history'
@@ -684,7 +685,6 @@ class DimmerConfigForm(BaseComponentForm):
         return validate_slaves(self.cleaned_data['slaves'], self.instance)
 
     def save(self, commit=True):
-        self.instance.config['output_pin_no'] = self.cleaned_data['output_pin'].no
         obj = super().save(commit=commit)
         if commit:
             obj.slaves.set(self.cleaned_data['slaves'])

simo/core/managers.py

@@ -71,11 +71,7 @@ class ComponentsManager(models.Manager):
                 gateway_components[comp.gateway] = {}
             gateway_components[comp.gateway][comp.id] = value
 
-        print("BULK SEND: ", gateway_components)
         for gateway, send_vals in gateway_components.items():
             GatewayObjectCommand(gateway, bulk_send=send_vals).publish(
                 retain=False
-            )
-
-
-
+            )

simo/core/migrations/0003_create_default_zones_and_categories.py

@@ -1,47 +1,10 @@
 # Generated by Django 2.2.12 on 2021-11-04 14:10
-import os
-import shutil
 from django.db import migrations
-from django.conf import settings
 
 
 def create_objects(apps, schema_editor):
-
-    core_dir_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
-    imgs_folder = os.path.join(
-        core_dir_path, 'static/defaults/category_headers'
-    )
-
-    Icon = apps.get_model("core", "Icon")
-    Zone = apps.get_model("core", "Zone")
-    Category = apps.get_model("core", "Category")
-
-    for zone_name in (
-        'Living Room', 'Kitchen', 'Bathroom', 'Porch', 'Garage', 'Yard', 'Other'
-    ):
-        Zone.objects.create(name=zone_name)
-
-    categories_media_dir = os.path.join(settings.MEDIA_ROOT, 'categories')
-    if not os.path.exists(categories_media_dir):
-        os.makedirs(categories_media_dir)
-
-    for i, data in enumerate([
-        ("All", 'star'), ("Climate", 'temperature-half'),
-        ("Lights", 'lightbulb'), ("Security", 'eye'),
-        ("Watering", 'faucet'), ("Other", 'flag-pennant')
-    ]):
-        shutil.copy(
-            os.path.join(imgs_folder, "%s.jpg" % data[0].lower()),
-            os.path.join(
-                settings.MEDIA_ROOT, 'categories', "%s.jpg" % data[0].lower()
-            )
-        )
-        Category.objects.create(
-            name=data[0], icon=Icon.objects.get(slug=data[1]),
-            all=i==0, header_image=os.path.join(
-                'categories', "%s.jpg" % data[0].lower()
-            ), order=i+10
-        )
+    # legacy..
+    pass
 
 
 def delete_objects(apps, schema_editor):

simo/core/migrations/0004_create_generic.py

@@ -4,27 +4,28 @@ from django.db import migrations
 
 
 def create_objects(apps, schema_editor):
-
-    Icon = apps.get_model("core", "Icon")
-    Zone = apps.get_model("core", "Zone")
-    Category = apps.get_model("core", "Category")
-    Gateway = apps.get_model("core", "Gateway")
-    Component = apps.get_model("core", "Component")
-
-    generic, new = Gateway.objects.get_or_create(
-        type='simo.generic.gateways.GenericGatewayHandler'
-    )
-    weather_icon = Icon.objects.get(slug='cloud-bolt-sun')
-    other_zone = Zone.objects.get(name='Other')
-    climate_category = Category.objects.get(name='Climate')
-    Component.objects.create(
-        name='Weather', icon=weather_icon,
-        zone=other_zone,
-        category=climate_category,
-        gateway=generic, base_type='weather-forecast',
-        controller_uid='simo.generic.controllers.WeatherForecast',
-        config={'is_main': True}
-    )
+    pass
+    # legacy
+    # Icon = apps.get_model("core", "Icon")
+    # Zone = apps.get_model("core", "Zone")
+    # Category = apps.get_model("core", "Category")
+    # Gateway = apps.get_model("core", "Gateway")
+    # Component = apps.get_model("core", "Component")
+    #
+    # generic, new = Gateway.objects.get_or_create(
+    #     type='simo.generic.gateways.GenericGatewayHandler'
+    # )
+    # weather_icon = Icon.objects.get(slug='cloud-bolt-sun')
+    # other_zone = Zone.objects.get(name='Other')
+    # climate_category = Category.objects.get(name='Climate')
+    # Component.objects.create(
+    #     name='Weather', icon=weather_icon,
+    #     zone=other_zone,
+    #     category=climate_category,
+    #     gateway=generic, base_type='weather-forecast',
+    #     controller_uid='simo.generic.controllers.WeatherForecast',
+    #     config={'is_main': True}
+    # )
 
 
 def delete_objects(apps, schema_editor):

simo/core/migrations/0013_auto_20231003_0754.py

@@ -3,49 +3,51 @@ from django.db import migrations
 
 
 def forwards_func(apps, schema_editor):
-    Instance = apps.get_model("core", "Instance")
-    Component = apps.get_model("core", "Component")
-    GlobalPreferenceModel = apps.get_model(
-        'dynamic_preferences', "GlobalPreferenceModel"
-    )
-
-    Instance.objects.create(
-        uid=GlobalPreferenceModel.objects.get(
-            section='core', name='hub_uid'
-        ).raw_value,
-        name=GlobalPreferenceModel.objects.get(
-            section='core', name='hub_name'
-        ).raw_value,
-        cover_image=GlobalPreferenceModel.objects.get(
-            section='core', name='cover_image'
-        ).raw_value,
-        cover_image_synced=True,
-        secret_key=GlobalPreferenceModel.objects.get(
-            section='core', name='hub_secret'
-        ).raw_value,
-        location=GlobalPreferenceModel.objects.get(
-            section='core', name='location_coordinates'
-        ).raw_value,
-        timezone=GlobalPreferenceModel.objects.get(
-            section='core', name='time_zone'
-        ).raw_value,
-        units_of_measure=GlobalPreferenceModel.objects.get(
-            section='core', name='units_of_measure'
-        ).raw_value,
-        share_location=True,
-        remote_http=GlobalPreferenceModel.objects.get(
-            section='core', name='remote_http'
-        ).raw_value,
-        remote_connection_version=int(GlobalPreferenceModel.objects.get(
-            section='core', name='remote_conn_version'
-        ).raw_value),
-        indoor_climate_sensor=Component(id=int(GlobalPreferenceModel.objects.get(
-            section='core', name='indoor_climate_sensor'
-        ).raw_value)),
-        history_days=int(GlobalPreferenceModel.objects.get(
-            section='core', name='history_days'
-        ).raw_value)
-    )
+    pass
+    # legacy
+    # Instance = apps.get_model("core", "Instance")
+    # Component = apps.get_model("core", "Component")
+    # GlobalPreferenceModel = apps.get_model(
+    #     'dynamic_preferences', "GlobalPreferenceModel"
+    # )
+    #
+    # Instance.objects.create(
+    #     uid=GlobalPreferenceModel.objects.get(
+    #         section='core', name='hub_uid'
+    #     ).raw_value,
+    #     name=GlobalPreferenceModel.objects.get(
+    #         section='core', name='hub_name'
+    #     ).raw_value,
+    #     cover_image=GlobalPreferenceModel.objects.get(
+    #         section='core', name='cover_image'
+    #     ).raw_value,
+    #     cover_image_synced=True,
+    #     secret_key=GlobalPreferenceModel.objects.get(
+    #         section='core', name='hub_secret'
+    #     ).raw_value,
+    #     location=GlobalPreferenceModel.objects.get(
+    #         section='core', name='location_coordinates'
+    #     ).raw_value,
+    #     timezone=GlobalPreferenceModel.objects.get(
+    #         section='core', name='time_zone'
+    #     ).raw_value,
+    #     units_of_measure=GlobalPreferenceModel.objects.get(
+    #         section='core', name='units_of_measure'
+    #     ).raw_value,
+    #     share_location=True,
+    #     remote_http=GlobalPreferenceModel.objects.get(
+    #         section='core', name='remote_http'
+    #     ).raw_value,
+    #     remote_connection_version=int(GlobalPreferenceModel.objects.get(
+    #         section='core', name='remote_conn_version'
+    #     ).raw_value),
+    #     indoor_climate_sensor=Component(id=int(GlobalPreferenceModel.objects.get(
+    #         section='core', name='indoor_climate_sensor'
+    #     ).raw_value)),
+    #     history_days=int(GlobalPreferenceModel.objects.get(
+    #         section='core', name='history_days'
+    #     ).raw_value)
+    # )
 
 
 def reverse_func(apps, schema_editor):

simo/core/migrations/0018_auto_20231005_0622.py

@@ -4,22 +4,24 @@ from django.db import migrations
 
 
 def forwards_func(apps, schema_editor):
-    Instance = apps.get_model("core", "Instance")
-    GlobalPreferenceModel = apps.get_model(
-        'dynamic_preferences', "GlobalPreferenceModel"
-    )
-
-    instance = Instance.objects.all().first()
-    GlobalPreferenceModel.objects.update_or_create(
-        section='core', name='hub_uid', defaults={
-            'raw_value': instance.uid
-        }
-    )
-    GlobalPreferenceModel.objects.update_or_create(
-        section='core', name='hub_secret', defaults={
-            'raw_value': instance.secret_key
-        }
-    )
+    pass
+    # legacy
+    # Instance = apps.get_model("core", "Instance")
+    # GlobalPreferenceModel = apps.get_model(
+    #     'dynamic_preferences', "GlobalPreferenceModel"
+    # )
+    #
+    # instance = Instance.objects.all().first()
+    # GlobalPreferenceModel.objects.update_or_create(
+    #     section='core', name='hub_uid', defaults={
+    #         'raw_value': instance.uid
+    #     }
+    # )
+    # GlobalPreferenceModel.objects.update_or_create(
+    #     section='core', name='hub_secret', defaults={
+    #         'raw_value': instance.secret_key
+    #     }
+    # )
 
 def reverse_func(apps, schema_editor):
     pass

simo/core/migrations/0033_auto_20240509_0821.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.2.9 on 2024-05-09 08:21
+
+from django.db import migrations, models
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0032_auto_20240506_0834'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='component',
+            name='last_modified',
+            field=models.DateTimeField(auto_now_add=True, db_index=True, default=django.utils.timezone.now, help_text='Last time component was modified.'),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='component',
+            name='last_change',
+            field=models.DateTimeField(auto_now_add=True, help_text='Last time component state was changed.', null=True),
+        ),
+    ]

simo/core/migrations/0034_component_error_msg.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.9 on 2024-05-09 10:25
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0033_auto_20240509_0821'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='component',
+            name='error_msg',
+            field=models.TextField(blank=True, editable=False, null=True),
+        ),
+    ]

simo/core/migrations/0035_remove_instance_share_location.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.2.9 on 2024-05-20 11:46
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0034_component_error_msg'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='instance',
+            name='share_location',
+        ),
+    ]

simo/core/migrations/0036_auto_20240521_0823.py

@@ -0,0 +1,22 @@
+# Generated by Django 3.2.9 on 2024-05-21 08:23
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0035_remove_instance_share_location'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='category',
+            name='header_image_last_change',
+        ),
+        migrations.AddField(
+            model_name='category',
+            name='last_modified',
+            field=models.DateTimeField(auto_now=True),
+        ),
+    ]