Trigger scenes (#161)

* Add scene triggering on and off
* Fix issue with cleanup messages for dimmer devices
* Fix issue with thermostat mode value

Author: teharris1

insteonplm/devices/__init__.py

@@ -592,18 +592,13 @@ def _handle_device_info_response(self, msg):
         self._device_info_queue.put_nowait(msg)
 
     def _handle_all_link_complete(self, msg):
-        if msg and msg.group == 0 and msg.linkcode == 0x01:
-            # IM is controller of group 1
-            # Set up other needed links
-            self.aldb.add_loaded_callback(self.create_default_links)
-
-        last_record = None
-        for mem_addr in self.aldb:
-            aldb_rec = self.aldb[mem_addr]
-            if aldb_rec.control_flags.is_high_water_mark:
-                last_record = mem_addr
-        if last_record:
-            self.aldb.pop(last_record)
+        # Not ready for prime time
+        # if msg and msg.group == 0 and msg.linkcode == 0x01:
+        #    # IM is controller of group 1
+        #    # Set up other needed links
+        #    self.aldb.add_loaded_callback(self.create_default_links)
+
+        self._aldb.remove_unused()
         self.read_aldb()
 
     def _register_messages(self):
@@ -1262,6 +1257,16 @@ def clear(self):
         """Remove all records."""
         self._records.clear()
 
+    def remove_unused(self):
+        """Remove All-Link records marked as not in use."""
+        unused = []
+        for mem_addr in self._records:
+            rec = self._records[mem_addr]
+            if rec.control_flags.is_available:
+                unused.append(mem_addr)
+        for mem_addr in unused:
+            self._records.pop(mem_addr)
+
     # pylint: disable=too-many-locals
     def write_record(self, mem_addr: int, mode: str, group: int, target,
                      data1=0x00, data2=0x00, data3=0x00):

insteonplm/plm.py

@@ -333,13 +333,69 @@ async def close(self):
         await self.pause_writing()
         await asyncio.sleep(0, loop=self._loop)
 
+    def trigger_group_on(self, group):
+        """Trigger an All-Link Group on."""
+        from .messages.standardSend import StandardSend
+        from .constants import COMMAND_LIGHT_ON_0X11_NONE
+        target = Address(bytearray([0x00, 0x00, group]))
+        flags = 0xc0
+        msg = StandardSend(target, COMMAND_LIGHT_ON_0X11_NONE,
+                           cmd2=0xff, flags=flags)
+        self.send_msg(msg)
+        dev_list = self._find_scene(group)
+        _LOGGER.debug('Scene %d turned on', group)
+        for addr in dev_list:
+            device = self._devices[addr.id]
+            if hasattr(device, 'async_refresh_state'):
+                _LOGGER.debug('Checking status of device %s', addr.human)
+                device.async_refresh_state()
+
+    def trigger_group_off(self, group):
+        """Trigger an All-Link Group off."""
+        from .messages.standardSend import StandardSend
+        from .constants import COMMAND_LIGHT_OFF_0X13_0X00
+        target = Address(bytearray([0x00, 0x00, group]))
+        flags = 0xc0
+        msg = StandardSend(target, COMMAND_LIGHT_OFF_0X13_0X00, flags=flags)
+        self.send_msg(msg)
+        dev_list = self._find_scene(group)
+        _LOGGER.debug('Scene %d turned off', group)
+        for addr in dev_list:
+            device = self._devices[addr.id]
+            if hasattr(device, 'async_refresh_state'):
+                _LOGGER.debug('Checking status of device %s', addr.human)
+                device.async_refresh_state()
+
+    def _find_scene(self, group):
+        """Identify all devices that are part of a scene."""
+        device_list = []
+        for rec_num in self._aldb:
+            rec = self._aldb[rec_num]
+            _LOGGER.debug('Checking record for scene: %s', rec)
+            if (rec.control_flags.is_controller and rec.group == group):
+                if rec.address not in device_list:
+                    device_list.append(rec.address)
+        for addr in self._devices:
+            device = self._devices[addr]
+            aldb = device.aldb
+            for mem_addr in aldb:
+                rec = aldb[mem_addr]
+                _LOGGER.debug('Checking record for scene: %s', rec)
+                if (rec.control_flags.is_in_use and
+                        rec.group == group and
+                        rec.address == self._address):
+                    if rec.address not in device_list:
+                        device_list.append(device.address)
+        return device_list
+
     async def _setup_devices(self):
         await self.devices.load_saved_device_info()
         _LOGGER.debug('Found %d saved devices',
                       len(self.devices.saved_devices))
         self._get_plm_info()
         self.devices.add_known_devices(self)
 
+        # Comment out the following lines for testing
         if self._load_aldb:
             self._load_all_link_database()
         else:

insteonplm/states/dimmable.py

@@ -145,13 +145,13 @@ def _register_messages(self):
             cmd2=None)
 
         self._message_callbacks.add(template_on_cleanup,
-                                    self._on_message_received)
+                                    self._manual_change_received)
         self._message_callbacks.add(template_on_fast_cleanup,
-                                    self._on_message_received)
+                                    self._manual_change_received)
         self._message_callbacks.add(template_off_cleanup,
-                                    self._off_message_received)
+                                    self._manual_change_received)
         self._message_callbacks.add(template_off_fast_cleanup,
-                                    self._off_message_received)
+                                    self._manual_change_received)
         self._message_callbacks.add(template_manual_cleanup,
                                     self._manual_change_received)
         self._message_callbacks.add(template_instant_cleanup,

insteonplm/states/thermostat.py

@@ -193,6 +193,7 @@ def _status_received(self, msg):
     def _ext_status_received(self, msg):
         sysmode = msg.userdata['d6']
         ext_mode = sysmode >> 4
+        mode = None
         if ext_mode == 0:
             mode = ThermostatMode.OFF
         elif ext_mode == 1:
@@ -201,7 +202,8 @@ def _ext_status_received(self, msg):
             mode = ThermostatMode.HEAT
         elif ext_mode == 3:
             mode = ThermostatMode.COOL
-        self._update_subscribers(mode)
+        if mode is not None:
+            self._update_subscribers(mode)
 
     def _register_messages(self):
         mode_status_msg = StandardReceive.template(

setup.py

@@ -11,7 +11,7 @@ def readme():
 
 setup(
     name='insteonplm',
-    version='0.15.4',
+    version='0.16.0',
     author='David McNett',
     author_email='[email protected]',
     url='https://github.com/nugget/python-insteonplm',