simo 3.1.6__py3-none-any.whl → 3.1.7__py3-none-any.whl

simo/core/controllers.py

@@ -647,7 +647,10 @@ class Button(ControllerBase):
     default_value = 'up'
 
     def _validate_val(self, value, occasion=None):
-        if value not in ('down', 'up', 'hold', 'click', 'double-click'):
+        if value not in (
+            'down', 'up', 'hold',
+            'click', 'double-click', 'triple-click', 'quadruple-click', 'quintuple-click'
+        ):
             raise ValidationError("Bad button value!")
         return value
 

simo/core/forms.py

@@ -71,16 +71,45 @@ class CategoryAdminForm(forms.ModelForm):
 class ConfigFieldsMixin:
 
     def __init__(self, *args, **kwargs):
+        """Augment forms with dynamic controller fields and
+        persist non-model fields under component.config.
+
+        Dynamic fields are appended by controllers via
+        `controller._get_dynamic_config_fields()` and are excluded from
+        automatic component.config persistence. Controllers may handle
+        them in `_apply_dynamic_config()` during save.
+        """
         super().__init__(*args, **kwargs)
+
+        # Inject dynamic fields from controller (if any)
+        self._dynamic_fields = []
+        controller = getattr(self, 'controller', None)
+        if controller and hasattr(controller, '_get_dynamic_config_fields'):
+            try:
+                dyn_fields = controller._get_dynamic_config_fields() or {}
+                if isinstance(dyn_fields, dict):
+                    for fname, field in dyn_fields.items():
+                        if fname in self.fields:
+                            continue
+                        self.fields[fname] = field
+                        self._dynamic_fields.append(fname)
+            except Exception:
+                # Never break the form if controller fails here
+                pass
+
+        # Build config-backed field list (exclude model fields and dynamic fields)
         self.model_fields = [
             f.name for f in Component._meta.fields
         ] + ['slaves', ]
         self.config_fields = []
-        for field_name, field in self.fields.items():
+        for field_name in list(self.fields.keys()):
             if field_name in self.model_fields:
                 continue
+            if field_name in self._dynamic_fields:
+                continue
             self.config_fields.append(field_name)
 
+        # Initialize config-backed fields from instance.config
         for field_name in self.config_fields:
             if field_name not in self.instance.config:
                 continue
@@ -106,38 +135,46 @@ class ConfigFieldsMixin:
 
 
     def save(self, commit=True):
+        # Write config-backed fields under component.config
         for field_name in self.config_fields:
             # support for partial forms
             if field_name not in self.cleaned_data:
                 continue
             if isinstance(self.cleaned_data[field_name], models.Model):
-                self.instance.config[field_name] = \
-                    self.cleaned_data[field_name].pk
+                self.instance.config[field_name] = self.cleaned_data[field_name].pk
             elif isinstance(self.cleaned_data[field_name], models.QuerySet):
-                self.instance.config[field_name] = [
-                    obj.pk for obj in self.cleaned_data[field_name]
-                ]
+                self.instance.config[field_name] = [obj.pk for obj in self.cleaned_data[field_name]]
             else:
                 try:
-                    self.instance.config[field_name] = \
-                        json.loads(json.dumps(self.cleaned_data[field_name]))
-                except:
+                    self.instance.config[field_name] = json.loads(json.dumps(self.cleaned_data[field_name]))
+                except Exception:
                     continue
 
+        # Save component
         if commit:
             from simo.users.utils import get_current_user
             actor = get_current_user()
-            if self.instance.pk:
-                verb = 'modified'
-            else:
-                verb = 'created'
-            action.send(
-                actor, target=self.instance, verb=verb,
-                instance_id=self.instance.zone.instance.id,
-                action_type='management_event'
-            )
+            if actor:
+                if self.instance.pk:
+                    verb = 'modified'
+                else:
+                    verb = 'created'
+                action.send(
+                    actor, target=self.instance, verb=verb,
+                    instance_id=self.instance.zone.instance.id,
+                    action_type='management_event'
+                )
+        result = super().save(commit)
 
-        return super().save(commit)
+        # Apply dynamic settings via controller hook
+        controller = getattr(self, 'controller', None)
+        if controller and hasattr(controller, '_apply_dynamic_config'):
+            try:
+                controller._apply_dynamic_config(self.cleaned_data)
+            except Exception:
+                pass
+
+        return result
 
 
 class BaseGatewayForm(ConfigFieldsMixin, forms.ModelForm):
@@ -329,10 +366,24 @@ class ComponentAdminForm(forms.ModelForm):
         base_fields.append('category')
         base_fields.append('show_in_app')
 
+        # Include statically declared fields first
         for field_name in cls.declared_fields:
             if field_name not in main_fields:
                 base_fields.append(field_name)
 
+        # If editing an existing object, include any dynamic fields
+        # that the form instance adds at runtime.
+        if obj is not None:
+            try:
+                tmp_form = cls(request=request, instance=obj, controller_uid=obj.controller_uid)
+                for fname in tmp_form.fields.keys():
+                    if fname in base_fields or fname in main_fields:
+                        continue
+                    base_fields.append(fname)
+            except Exception:
+                # Ignore dynamic field detection issues
+                pass
+
         base_fields.append('control')
         base_fields.append('notes')
 
@@ -389,6 +440,29 @@ class ComponentAdminForm(forms.ModelForm):
 
 
 class BaseComponentForm(ConfigFieldsMixin, ComponentAdminForm):
+    """Base form for all components.
+
+    Dynamic controller-backed fields
+    --------------------------------
+    Controllers can expose device-scoped, dynamic options by implementing
+    the following optional hooks on the controller instance:
+
+    - _get_dynamic_config_fields(self) -> dict[str, django.forms.Field]
+        Return a mapping of additional form fields to append at runtime.
+        These fields are not persisted automatically to component.config.
+        Set each field's `initial` to reflect the current device value.
+
+    - _apply_dynamic_config(self, form_data: dict) -> None
+        Called after the form is saved. Receives the full cleaned form
+        data (including dynamic fields). Use this to apply device options
+        (e.g. send commands to a gateway or write to component.config if
+        your integration needs to persist something custom).
+
+    Notes
+    - Dynamic fields are excluded from `basic_fields`, so only higher-level
+      users (instance superusers/masters) will see and edit them.
+    - All existing static fields and behavior remain unchanged.
+    """
     pass
 
 

{simo-3.1.6.dist-info → simo-3.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simo
-Version: 3.1.6
+Version: 3.1.7
 Summary: Smart Home Supremacy
 Author-email: "Simon V." <simon@simo.io>
 Project-URL: Homepage, https://simo.io

{simo-3.1.6.dist-info → simo-3.1.7.dist-info}/RECORD

@@ -102,12 +102,12 @@ simo/core/auto_urls.py,sha256=fM9Tqzt0OfJ2FNnePGp7LcbJAWzgEwaNAJy7FNXHY-o,1299
 simo/core/autocomplete_views.py,sha256=x3MKOZvXYS3xVQ-V1S7Liv_U5bxr-uc0gePa85wv5nA,4561
 simo/core/base_types.py,sha256=FNIS9Y7wmdbVl-dISLdSBYvMEiV4zSLpBOBDYOVyam0,6580
 simo/core/context.py,sha256=LKw1I4iIRnlnzoTCuSLLqDX7crHdBnMo3hjqYvVmzFc,1557
-simo/core/controllers.py,sha256=jGn9bDvUuAbFL_uCAV8aqXgDJz9akYDroJuyU0ONsC8,48563
+simo/core/controllers.py,sha256=uEC4hSeSpyHLZjojIdMPrzy2-JiK9DkMmCZpE3BcK-I,48651
 simo/core/dynamic_settings.py,sha256=bUs58XEZOCIEhg1TigR3LmYggli13KMryBZ9pC7ugAQ,1872
 simo/core/events.py,sha256=mjrYsByw0hGct4rXoLmnbBodViN8S1ReBIZG3g660Yo,6735
 simo/core/filters.py,sha256=6wbn8C2WvKTTjtfMwwLBp2Fib1V0-DMpS4iqJd6jJQo,2540
 simo/core/form_fields.py,sha256=b4wZ4n7OO0m0_BPPS9ILVrwBvhhjUB079YrroveFUWA,5222
-simo/core/forms.py,sha256=IwuljCxwqPcSn3eXJRF2pWjktvlQ4DH2LCsncHzCHw0,22720
+simo/core/forms.py,sha256=koGOIVt3gE1eejpjHFjAH-QZ1Zm2Woy51F5txh_AJVI,26191
 simo/core/gateways.py,sha256=cM_du3VsHbSYUSWL5JHxXMV8yn6s-QrSzB3WreglGjw,4736
 simo/core/loggers.py,sha256=EBdq23gTQScVfQVH-xeP90-wII2DQFDjoROAW6ggUP4,1645
 simo/core/managers.py,sha256=Ampwe5K7gfE6IJULNCV35V8ysmMOdS_wz7mRzfaLZUw,3014
@@ -11034,9 +11034,9 @@ simo/users/templates/invitations/expired_msg.html,sha256=47DEQpj8HBSa-_TImW-5JCe
 simo/users/templates/invitations/expired_suggestion.html,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 simo/users/templates/invitations/taken_msg.html,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 simo/users/templates/invitations/taken_suggestion.html,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-simo-3.1.6.dist-info/licenses/LICENSE.md,sha256=M7wm1EmMGDtwPRdg7kW4d00h1uAXjKOT3HFScYQMeiE,34916
-simo-3.1.6.dist-info/METADATA,sha256=3ZPTUNXT0K8Vdj8pNXmdll7TIhFDbYpKHtByuNk1Kio,2224
-simo-3.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-simo-3.1.6.dist-info/entry_points.txt,sha256=S9PwnUYmTSW7681GKDCxUbL0leRJIaRk6fDQIKgbZBA,135
-simo-3.1.6.dist-info/top_level.txt,sha256=GmS1hrAbpVqn9OWZh6UX82eIOdRLgYA82RG9fe8v4Rs,5
-simo-3.1.6.dist-info/RECORD,,
+simo-3.1.7.dist-info/licenses/LICENSE.md,sha256=M7wm1EmMGDtwPRdg7kW4d00h1uAXjKOT3HFScYQMeiE,34916
+simo-3.1.7.dist-info/METADATA,sha256=478oQ_ahEy-rp4E2VvKgkzhLPFYrTOMG7IJAttlmJXM,2224
+simo-3.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+simo-3.1.7.dist-info/entry_points.txt,sha256=S9PwnUYmTSW7681GKDCxUbL0leRJIaRk6fDQIKgbZBA,135
+simo-3.1.7.dist-info/top_level.txt,sha256=GmS1hrAbpVqn9OWZh6UX82eIOdRLgYA82RG9fe8v4Rs,5
+simo-3.1.7.dist-info/RECORD,,