simo 2.11.4__py3-none-any.whl → 3.0.1__py3-none-any.whl

simo/fleet/base_types.py

@@ -1,6 +1,37 @@
 from django.utils.translation import gettext_lazy as _
+from simo.core.base_types import BaseComponentType
 
-BASE_TYPES = {
-    'dali': _("Dali Device"),
-    'room-sensor': _("Room Sensor"),
-}
+
+class DaliDeviceType(BaseComponentType):
+    slug = 'dali'
+    name = _("Dali Device")
+    description = _("DALI bus device discovered and managed by Fleet.")
+    purpose = _("Use for DALI-compliant gear integration.")
+
+
+class SentinelType(BaseComponentType):
+    slug = 'sentinel'
+    name = _("Sentinel")
+    description = _("Room environment sensor reporting readings, alarm siren, AI voice assistant.")
+    purpose = _("Use to capture ambient conditions of a zone, raise alarms, provice AI voice assistant.")
+
+
+class VoiceAssistantType(BaseComponentType):
+    slug = 'voice-assistant'
+    name = _("Voice Assistant")
+    description = _("SIMO AI smart home voice assistant.")
+    purpose = _("Control smart home instance using voice commands.")
+
+
+
+def _export_base_types_dict():
+    import inspect as _inspect
+    mapping = {}
+    for _name, _obj in globals().items():
+        if _inspect.isclass(_obj) and issubclass(_obj, BaseComponentType) \
+                and _obj is not BaseComponentType and getattr(_obj, 'slug', None):
+            mapping[_obj.slug] = _obj.name
+    return mapping
+
+
+BASE_TYPES = _export_base_types_dict()

simo/fleet/controllers.py

@@ -13,13 +13,14 @@ from simo.core.controllers import (
     Lock, ControllerBase, SingleSwitchWidget
 )
 from simo.core.app_widgets import NumericSensorWidget, AirQualityWidget
+from .base_types import DaliDeviceType, SentinelType, VoiceAssistantType
 from simo.core.utils.helpers import heat_index
 from simo.core.utils.serialization import (
     serialize_form_data, deserialize_form_data
 )
 from simo.core.forms import BaseComponentForm
 from simo.generic.controllers import StateSelect
-from .models import Colonel, CustomDaliDevice
+from .models import Colonel
 from .gateways import FleetGatewayHandler
 from .forms import (
     ColonelPinChoiceField,
@@ -33,14 +34,19 @@ from .forms import (
     TTLockConfigForm, DALIDeviceConfigForm, DaliLampForm, DaliGearGroupForm,
     DaliSwitchConfigForm,
     DaliOccupancySensorConfigForm, DALILightSensorConfigForm,
-    DALIButtonConfigForm, RoomSensorDeviceConfigForm,
-    RoomZonePresenceConfigForm
+    DALIButtonConfigForm, SentinelDeviceConfigForm,
+    RoomZonePresenceConfigForm, VoiceAssistantConfigForm
 )
 
 
 class FleetDeviceMixin:
 
     def update_options(self, options):
+        """Update runtime options on the device via the Colonel gateway.
+
+        Parameters:
+        - options (dict): Device-specific options; merged on the device side.
+        """
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
@@ -50,12 +56,14 @@ class FleetDeviceMixin:
         ).publish()
 
     def disable_controls(self):
+        """Disable device controls temporarily (e.g., lock UI inputs)."""
         options = self.component.meta.get('options', {})
         if options.get('controls_enabled', True) != False:
             options['controls_enabled'] = False
             self.update_options(options)
 
     def enable_controls(self):
+        """Enable device controls if previously disabled."""
         options = self.component.meta.get('options', {})
         if options.get('controls_enabled', True) != True:
             options['controls_enabled'] = True
@@ -86,6 +94,7 @@ class FleetDeviceMixin:
 
 class BasicSensorMixin:
     gateway_class = FleetGatewayHandler
+    accepts_value = False
 
     def _get_occupied_pins(self):
         return [
@@ -565,6 +574,11 @@ class TTLock(FleetDeviceMixin, Lock):
 
 
     def add_code(self, code):
+        """Add a numeric access code to the smart lock.
+
+        Parameters:
+        - code (str|int): 4–8 digit numeric code.
+        """
         code = str(code)
         assert 4 <= len(code) <= 8
         for no in code:
@@ -580,6 +594,11 @@ class TTLock(FleetDeviceMixin, Lock):
         ).publish()
 
     def delete_code(self, code):
+        """Delete a numeric access code from the lock.
+
+        Parameters:
+        - code (str|int): The exact code to remove.
+        """
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
@@ -588,6 +607,7 @@ class TTLock(FleetDeviceMixin, Lock):
         ).publish()
 
     def clear_codes(self):
+        """Remove all numeric access codes from the lock."""
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
@@ -596,6 +616,7 @@ class TTLock(FleetDeviceMixin, Lock):
         ).publish()
 
     def get_codes(self):
+        """Request the list of numeric access codes from the lock."""
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
@@ -604,6 +625,7 @@ class TTLock(FleetDeviceMixin, Lock):
         ).publish()
 
     def add_fingerprint(self):
+        """Start lock-side enrollment of a new fingerprint."""
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
@@ -612,6 +634,7 @@ class TTLock(FleetDeviceMixin, Lock):
         ).publish()
 
     def delete_fingerprint(self, code):
+        """Delete a fingerprint by its identifier on the lock."""
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
@@ -620,6 +643,7 @@ class TTLock(FleetDeviceMixin, Lock):
         ).publish()
 
     def clear_fingerprints(self):
+        """Remove all fingerprints from the lock."""
         self.component.meta['clear_fingerprints'] = True
         self.component.save(update_fields=['meta'])
         GatewayObjectCommand(
@@ -630,6 +654,7 @@ class TTLock(FleetDeviceMixin, Lock):
         ).publish()
 
     def get_fingerprints(self):
+        """Request the list of fingerprint identifiers from the lock."""
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
@@ -638,22 +663,12 @@ class TTLock(FleetDeviceMixin, Lock):
         ).publish()
 
     def check_locked_status(self):
-        '''
-        Lock state is monitored by capturing adv data
-        periodically transmitted by the lock.
-        This data includes information about it's lock/unlock position
-        also if there are any new events in it that we are not yet aware of.
-
-        If anything new is observer, connection is made to the lock
-        and reported back to the system.
-        This helps to save batteries of a lock,
-        however it is not always as timed as we would want to.
-        Sometimes it can take even up to 20s for these updates to occur.
-
-        This method is here to force immediate connection to the lock
-        to check it's current status. After this method is called,
-        we might expect to receive an update within 2 seconds or less.
-        '''
+        """Force an immediate connection to the lock to refresh status.
+
+        The lock usually reports status periodically to save batteries; this
+        method asks the gateway to connect proactively so that an update is
+        expected within a couple of seconds.
+        """
         GatewayObjectCommand(
             self.component.gateway,
             Colonel(id=self.component.config['colonel']),
@@ -687,13 +702,21 @@ class DALIDevice(FleetDeviceMixin, ControllerBase):
     name = "DALI Device"
     discovery_msg = _("Please hook up your new DALI device to your DALI bus.")
 
-    base_type = 'dali'
+    base_type = DaliDeviceType
     default_value = False
     app_widget = SingleSwitchWidget
 
     def _validate_val(self, value, occasion=None):
         return value
 
+    def send(self, value):
+        """Control DALI device on/off.
+
+        Parameters:
+        - value (bool): True to turn on; False to turn off.
+        """
+        return super().send(value)
+
     @classmethod
     def _init_discovery(self, form_cleaned_data):
         from simo.core.models import Gateway
@@ -748,7 +771,9 @@ class DALIDevice(FleetDeviceMixin, ControllerBase):
         if data['result'].get('di') is not None:
             started_with['name'] += f" - {data['result']['di']}"
         started_with['controller_uid'] = controller_uid
-        started_with['base_type'] = controller_cls.base_type
+        # Normalize base type to slug for form
+        bt = getattr(controller_cls, 'base_type', None)
+        started_with['base_type'] = bt if isinstance(bt, str) else getattr(bt, 'slug', None)
         form = controller_cls.config_form(
             controller_uid=controller_cls.uid, data=started_with
         )
@@ -781,10 +806,10 @@ class DALIDevice(FleetDeviceMixin, ControllerBase):
         return {'error': 'INVALID INITIAL DISCOVERY FORM!'}
 
     def replace(self):
-        """
-        Hook up brand new replacement device to the dali line
-        and execute this command on existing (dead) component instance,
-        so that it can be replaced by the new physical device.
+        """Replace a failed DALI device with a brand new one on the line.
+
+        Connect a new device to the DALI bus and invoke this method on the
+        existing (dead) component to transfer configuration to the newcomer.
         """
         GatewayObjectCommand(
             self.component.gateway,
@@ -857,13 +882,14 @@ class DALIButton(BaseButton, DALIDevice):
     manual_add = False
     name = 'DALI Button'
     config_form = DALIButtonConfigForm
+    accepts_value = False
 
 
-class RoomSensor(FleetDeviceMixin, ControllerBase):
+class Sentinel(FleetDeviceMixin, ControllerBase):
     gateway_class = FleetGatewayHandler
-    config_form = RoomSensorDeviceConfigForm
-    name = "Room Sensor"
-    base_type = 'room-sensor'
+    config_form = SentinelDeviceConfigForm
+    name = "Sentinel"
+    base_type = SentinelType
     default_value = 0
     app_widget = NumericSensorWidget
 
@@ -894,21 +920,9 @@ class RoomSiren(FleetDeviceMixin, StateSelect):
         self.send('silent')
 
     def _send_to_device(self, value):
-        if self.component.config.get('colonel'):
-            GatewayObjectCommand(
-                self.component.gateway, self.component, set_val=value
-            ).publish()
-        else:
-            dali_device = CustomDaliDevice.objects.filter(
-                id=self.component.config['dali_device']
-            ).first()
-            from .custom_dali_operations import Frame
-            frame = Frame(40, bytes(bytearray(5)))
-            frame[8:11] = 15  # command to custom dali device
-            frame[12:15] = 6  # action to perform: set value
-            frame[16:20] = 0 # device on which to perform value set
-            frame[21:24] = self.VALUES_MAP[value]
-            dali_device.transmit(frame)
+        GatewayObjectCommand(
+            self.component.gateway, self.component, set_val=value
+        ).publish()
 
 
 class AirQualitySensor(FleetDeviceMixin, BaseMultiSensor):
@@ -917,6 +931,7 @@ class AirQualitySensor(FleetDeviceMixin, BaseMultiSensor):
     name = "Air Quality Sensor"
     app_widget = AirQualityWidget
     manual_add = False
+    accepts_value = False
 
     default_value = [
         ["TVOC", 0, "ppb"],
@@ -975,14 +990,16 @@ class TempHumSensor(FleetDeviceMixin, BasicSensorMixin, BaseMultiSensor):
         return [
             ['temperature', 0, self.sys_temp_units],
             ['humidity', 20, '%'],
-            ['real_feel', 0, self.sys_temp_units]
+            ['real_feel', 0, self.sys_temp_units],
+            ['core', 0, 'C'],
+            ['outside', 0, 'C']
         ]
 
     def _receive_from_device(self, value, *args, **kwargs):
 
         if isinstance(value, dict):
             temp = value['temp']
-            humidity = value['humidity']
+            humidity = value['hum']
         else:
             buf = bytes.fromhex(value)
             humidity = (
@@ -997,7 +1014,9 @@ class TempHumSensor(FleetDeviceMixin, BasicSensorMixin, BaseMultiSensor):
         new_val = [
             ['temperature', temp, self.sys_temp_units],
             ['humidity', humidity, '%'],
-            ['real_feel', 0, self.sys_temp_units]
+            ['real_feel', 0, self.sys_temp_units],
+            ['core', value.get('core'), 'C'],
+            ['outside', value.get('out'), 'C']
         ]
 
         if self.sys_temp_units == 'F':
@@ -1056,23 +1075,16 @@ class RoomZonePresenceSensor(FleetDeviceMixin, BaseBinarySensor):
             self.uid, serialize_form_data(form_cleaned_data),
             timeout=60
         )
-        if form_cleaned_data['device'].startswith('wifi'):
-            colonel = Colonel.objects.filter(
-                id=form_cleaned_data['device'][5:]
-            ).first()
+        colonel = Colonel.objects.filter(
+            id=form_cleaned_data.get('colonel')
+            if isinstance(form_cleaned_data.get('colonel'), int)
+            else getattr(form_cleaned_data.get('colonel'), 'id', None)
+        ).first()
+        if colonel:
             GatewayObjectCommand(
                 gateway, colonel,
                 command='discover', type=self.uid.split('.')[-1],
             ).publish()
-        else:
-            from .custom_dali_operations import Frame
-            dali_device = CustomDaliDevice.objects.filter(
-                id=form_cleaned_data['device'][5:]
-            ).first()
-            frame = Frame(40, bytes(bytearray(5)))
-            frame[8:11] = 15 # command to custom dali device
-            frame[12:15] = 0 # action to perform: start room zone discovery
-            dali_device.transmit(frame)
 
 
     @classmethod
@@ -1088,112 +1100,94 @@ class RoomZonePresenceSensor(FleetDeviceMixin, BaseBinarySensor):
             controller_uid=cls.uid, data=started_with
         )
         form.is_valid()
-        if form.cleaned_data['device'].startswith('wifi'):
-            form.instance.alive = False
-            form.instance.config['colonel'] = int(
-                form.cleaned_data['device'][5:]
-            )
-            new_component = form.save()
-            GatewayObjectCommand(
-                new_component.gateway, Colonel(
-                    id=new_component.config['colonel']
-                ), command='finalize',
-                data={
-                    'permanent_id': new_component.id,
-                    'comp_config': {
-                        'type': cls.uid.split('.')[-1],
-                        'family': new_component.controller.family,
-                        'config': json.loads(json.dumps(new_component.config)),
-                    }
+        form.instance.alive = False
+        form.instance.config['colonel'] = int(
+            getattr(form.cleaned_data['colonel'], 'id', form.cleaned_data['colonel'])
+        )
+        new_component = form.save()
+        GatewayObjectCommand(
+            new_component.gateway, Colonel(
+                id=new_component.config['colonel']
+            ), command='finalize',
+            data={
+                'permanent_id': new_component.id,
+                'comp_config': {
+                    'type': cls.uid.split('.')[-1],
+                    'family': new_component.controller.family,
+                    'config': json.loads(json.dumps(new_component.config)),
                 }
-            ).publish()
-        else:
-            from simo.core.models import Component
-            from .custom_dali_operations import Frame
-            dali_device = CustomDaliDevice.objects.filter(
-                id=form.cleaned_data['device'][5:]
-            ).first()
-            free_slots = {0, 1, 2, 3, 4, 5, 6, 7}
-            for comp in Component.objects.filter(
-                controller_uid=cls.uid, config__dali_device=dali_device.id
-            ):
-                try:
-                    free_slots.remove(int(comp.config['slot']))
-                except:
-                    continue
-            if not free_slots:
-                return []
-
-            form.instance.alive = False
-            form.instance.config['dali_device'] = int(
-                form.cleaned_data['device'][5:]
-            )
-            form.instance.config['slot'] = free_slots.pop()
-            new_component = form.save()
-            frame = Frame(40, bytes(bytearray(5)))
-            frame[8:11] = 15  # command to custom dali device
-            frame[12:15] = 1  # action to perform: stop room zone discovery
-            frame[16:18] = new_component.config['slot']
-            dali_device.transmit(frame)
+            }
+        ).publish()
 
         return new_component
 
     def repaint(self):
         """Repaint included 3D space"""
-        if self.component.config['device'].startswith('wifi'):
-            GatewayObjectCommand(
-                self.component.gateway, Colonel(
-                    id=self.component.config['colonel']
-                ), command='call', method='repaint', id=self.component.id
-            ).publish()
-        else:
-            dali_device = CustomDaliDevice.objects.filter(
-                id=self.component.config['device'][5:]
-            ).first()
-            from .custom_dali_operations import Frame
-            frame = Frame(40, bytes(bytearray(5)))
-            frame[8:11] = 15  # command to custom dali device
-            frame[12:15] = 3  # action to perform: repaint
-            frame[16:18] = self.component.config['slot']
-            dali_device.transmit(frame)
+        GatewayObjectCommand(
+            self.component.gateway, Colonel(
+                id=self.component.config['colonel']
+            ), command='call', method='repaint', id=self.component.id
+        ).publish()
 
     def finish_repaint(self):
         """Finish repainting of 3D space"""
-        if self.component.config['device'].startswith('wifi'):
-            GatewayObjectCommand(
-                self.component.gateway, Colonel(
-                    id=self.component.config['colonel']
-                ), command='call', method='finish_repaint',
-                id=self.component.id
-            ).publish()
-        else:
-            dali_device = CustomDaliDevice.objects.filter(
-                id=self.component.config['device'][5:]
-            ).first()
-            from .custom_dali_operations import Frame
-            frame = Frame(40, bytes(bytearray(5)))
-            frame[8:11] = 15  # command to custom dali device
-            frame[12:15] = 4  # action to perform: finish repaint
-            frame[16:18] = self.component.config['slot']
-            dali_device.transmit(frame)
+        GatewayObjectCommand(
+            self.component.gateway, Colonel(
+                id=self.component.config['colonel']
+            ), command='call', method='finish_repaint',
+            id=self.component.id
+        ).publish()
 
     def cancel_repaint(self):
         """Finish repainting of 3D space"""
-        if self.component.config['device'].startswith('wifi'):
-            GatewayObjectCommand(
-                self.component.gateway, Colonel(
-                    id=self.component.config['colonel']
-                ), command='call', method='cancel_repaint',
-                id=self.component.id
-            ).publish()
-        else:
-            dali_device = CustomDaliDevice.objects.filter(
-                id=self.component.config['device'][5:]
-            ).first()
-            from .custom_dali_operations import Frame
-            frame = Frame(40, bytes(bytearray(5)))
-            frame[8:11] = 15  # command to custom dali device
-            frame[12:15] = 5  # action to perform: cancel repaint
-            frame[16:18] = self.component.config['slot']
-            dali_device.transmit(frame)
+        GatewayObjectCommand(
+            self.component.gateway, Colonel(
+                id=self.component.config['colonel']
+            ), command='call', method='cancel_repaint',
+            id=self.component.id
+        ).publish()
+
+
+class VoiceAssistant(FleetDeviceMixin, BaseBinarySensor):
+    base_type = VoiceAssistantType
+    name = _("AI Voice Assistant")
+    gateway_class = FleetGatewayHandler
+    config_form = VoiceAssistantConfigForm
+    manual_add = False
+    default_config = {'voice': 'male', 'enabled': True}
+
+    def arm(self):
+        """
+            Arming voice assistant is means disabling it,
+            so that it can not be used by invaders.
+        """
+        self.component.refresh_from_db()
+        self.component.config['enabled'] = False
+        self.component.arm_status = 'armed'
+        self.component.save()
+        GatewayObjectCommand(
+            self.component.gateway, Colonel(
+                id=self.component.config['colonel']
+            ), command='call', method='disable',
+            id=self.component.id
+        ).publish()
+
+    def disarm(self):
+        """
+            Disarming voice assistant is means enabling it,
+            so that anyone can use it to control the smart home system.
+        """
+        self.component.refresh_from_db()
+        self.component.config['enabled'] = True
+        self.component.arm_status = 'disarmed'
+        self.component.save()
+        GatewayObjectCommand(
+            self.component.gateway, Colonel(
+                id=self.component.config['colonel']
+            ), command='call', method='enable',
+            id=self.component.id
+        ).publish()
 
+    def is_in_alarm(self):
+        """Returns always False"""
+        return False