Add aggregated group stats

We need to ignore some changes in the test for group aggregates to pass

python/ethaudio/api.py

@@ -432,15 +432,16 @@ def __init__(self, rt = MockRt()):
         { "id": 14, "name": "Zone 15", "source_id": 0, "mute": True, "disabled": False, "vol": -79 },
         { "id": 15, "name": "Zone 16", "source_id": 0, "mute": True, "disabled": False, "vol": -79 },
         { "id": 16, "name": "Zone 17", "source_id": 0, "mute": True, "disabled": False, "vol": -79 },
-        { "id": 17, "name": "Zone 18", "source_id": 0, "mute": True, "disabled": False, "vol": -79 }
+        { "id": 17, "name": "Zone 18", "source_id": 0, "mute": True, "disabled": False, "vol": -79 },
       ],
       "groups": [ # this is an array of groups that have been created , each group has a friendly name and an array of member zones
-        # TODO: need to add mute, vol_delta, and source_id to groups
-        { "id": 0, "name": "Group 1", "zones": [0,1,2] },
-        { "id": 1, "name": "Group 2", "zones": [2,3,4] },
-        { "id": 2, "name": "Group 3", "zones": [5] }
+        # TODO: need to add mute, and source_id to groups
+        { "id": 0, "name": "Group 1", "zones": [0,1,2], "source_id": 0, "mute": True, "vol_delta": -79 },
+        { "id": 1, "name": "Group 2", "zones": [2,3,4], "source_id": 0, "mute": True, "vol_delta": -79 },
+        { "id": 2, "name": "Group 3", "zones": [5],     "source_id": 0, "mute": True, "vol_delta": -79 },
       ]
     }
+
   def visualize_api(self, prev_status=None):
     viz = ''
     # visualize source configuration
@@ -602,6 +603,9 @@ def set_zone(self, id, name=None, source_id=None, mute=None, vol=None, disabled=
           else:
             return error('set zone failed: unable to update zone volume')
 
+        # update the group stats (individual zone volumes, sources, and mute configuration can effect a group)
+        self.update_groups()
+
         if type(self._rt) == RpiRt and DEBUG_PREAMPS:
           self._rt._bus.print()
         return None
@@ -616,6 +620,21 @@ def get_group(self, id):
         return i,g
     return -1, None
 
+  def update_groups(self):
+    """ Update the group's aggregate fields to maintain consistency and simplify app interface """
+    for g in self.status['groups']:
+      zones = [ self.status['zones'][z] for z in g['zones'] ]
+      mutes = [ z['mute'] for z in zones ]
+      sources  = set([ z['source_id'] for z in zones ])
+      vols = [ z['vol'] for z in zones ]
+      vols.sort()
+      g['mute'] = False not in mutes # group is only considered muted if all zones are muted
+      if len(sources) == 1:
+        g['source_id'] = sources.pop() # TODO: how should we handle different sources in the group?
+      else: # multiple sources
+        g['source_id'] = None
+      g['vol_delta'] = (vols[0] + vols[-1]) // 2 # group volume is the midpoint between the highest and lowest source
+
   def set_group(self, id, name=None, source_id=None, zones=None, mute=None, vol_delta=None):
     """ Configure an existing group
         parameters will be used to configure each sone in the group's zones
@@ -649,6 +668,7 @@ def set_group(self, id, name=None, source_id=None, zones=None, mute=None, vol_de
         vol_change = 0
     except Exception as e:
       return error('failed to configure group, error getting current state: {}'.format(e))
+
     g['name'] = name
     g['zones'] = zones
 
@@ -661,6 +681,9 @@ def set_group(self, id, name=None, source_id=None, zones=None, mute=None, vol_de
       self.set_zone(z['id'], None, source_id, mute, vol)
     g['vol_delta'] = vol_delta
 
+    # update the group stats
+    self.update_groups()
+
     if type(self._rt) == RpiRt and DEBUG_PREAMPS:
       self._rt._bus.print()
 
@@ -696,8 +719,9 @@ def create_group(self, name, zones):
     # add the new group
     group = { 'id': id, 'name' : name, 'zones' : zones, 'vol_delta' : 0 }
     self.status['groups'].append(group)
-    print('created group!')
-    pprint.pprint(self.status['groups'])
+
+    # update the group stats and populate uninitialized fields of the group
+    self.update_groups()
 
   def delete_group(self, id):
     """delete an existing group"""

python/tests/test_ethaudio_mock.py

@@ -282,6 +282,7 @@ def check_json_tst(name, result, expected_result, expected_changes):
   changes, added, removed = get_state_changes()
   # handle additions and removals in expected changes as optional, making sure to remove them from the actual changes comparison
   expected_changes2 = dict(expected_changes)
+  # TODO: handle changes that should be ignored
   if 'added' in expected_changes:
     assert added == expected_changes['added']
     del expected_changes2['added']
@@ -320,7 +321,7 @@ def check_all_tsts(api):
   check_json_tst('Configure source 1 (digital)', eth_audio_api.set_source(1, 'Pandora', True), None, {'sources[1].name' : 'Pandora'})
   check_json_tst('Configure source 2 (Analog)', eth_audio_api.set_source(2, 'TV', False), None, {'sources[2].name' : 'TV', 'sources[2].digital' : False})
   check_json_tst('Configure source 3 (Analog)', eth_audio_api.set_source(3, 'PC', False), None, {'sources[3].name' : 'PC', 'sources[3].digital' : False})
-  check_json_tst('Configure zone 0, Party Zone', eth_audio_api.set_zone(0, 'Party Zone', 1, False, 0, False), None, {'zones[0].name' : 'Party Zone', 'zones[0].source_id' : 1, 'zones[0].vol': 0, 'zones[0].mute' : False})
+  check_json_tst('Configure zone 0, Party Zone', eth_audio_api.set_zone(0, 'Party Zone', 1, False, 0, False), None, {'zones[0].name' : 'Party Zone', 'zones[0].source_id' : 1, 'zones[0].vol': 0, 'zones[0].mute' : False, 'groups[0].mute' : False, 'groups[0].vol_delta' : -40})
   check_json_tst('Configure zone 1, Drone Zone', eth_audio_api.set_zone(1, 'Drone Zone', 2, False, -20, False), None, {'zones[1].name' : 'Drone Zone', 'zones[1].source_id' : 2, 'zones[1].vol': -20, 'zones[1].mute' : False})
   check_json_tst('Configure zone 2, Sleep Zone', eth_audio_api.set_zone(2, None, None, None, None, False), None, {})
   check_json_tst('Configure zone 2, Sleep Zone', eth_audio_api.set_zone(2, 'Sleep Zone', 3, True, None, False), None, {'zones[2].name' : 'Sleep Zone', 'zones[2].source_id' : 3})