Merge pull request #315 from hklages/remove_sub

Remove sub

Author: hklages

src/Helper.js

@@ -117,6 +117,43 @@ module.exports = {
       return item.replace(/:LR|:RR/, '')
     }) 
   },
+
+  /** Returns the UUID of the subwoofer.
+   * @param {string} mapString string from HTSatChanMapSet or channelMapSet
+   * 
+   * @returns {"Promise<string>"} subwoofer UUID
+   * 
+   * @throws {error} 
+   * 
+   */
+  // Example
+  // eslint-disable-next-line max-len
+  // RINCON_48A6B8B5614E01400:LF,RF;RINCON_38420B92ABE601400:RR;RINCON_7828CA042C8401400:LR;RINCON_542A1B108A6201400:SW
+   
+  extractSubwooferUuid: async (mapString) => {
+    debug('method:%s', 'extractSubwooferUuid')
+
+    if (!module.exports.isTruthy(mapString)) {
+      throw new Error('invalid parameter - invalid/missing')
+    }
+    if (typeof mapString !== 'string') {
+      throw new Error('invalid parameter - is not string')
+    }
+    
+    if (!mapString.includes(';')) {
+      throw new Error('invalid parameter - no subwoofer (missing ;)')
+    }
+    const uuidsPlusChannel = mapString.split(';')
+    const subwooferUuidArray = uuidsPlusChannel.filter((item) => {
+      return item.includes(':SW')
+    })
+    if ((subwooferUuidArray.length !== 1)) {
+      throw new Error('invalid parameter -  no subwoofer found')
+    }
+    
+    // remove identifier :SW
+    return subwooferUuidArray[0].replace(/:SW/, '')
+  },
 
   /** Converts hh:mm:ss time to milliseconds. Does not check input!
    * No validation: hh 0 to 23, mm 0 to 59 ss 0 59, : must exist

src/sonos-universal.html

@@ -183,6 +183,7 @@
     { cmd: "household.get.sonosplaylists" },
     { cmd: "household.get.sonosplaylisttracks" },
     { cmd: "household.remove.satellites" },
+    { cmd: "household.remove.subwoofer" },
     { cmd: "household.remove.sonosplaylist" },
     { cmd: "household.separate.group" },
     { cmd: "household.separate.stereopair" },

src/sonos-universal.js

@@ -31,8 +31,8 @@ const { executeActionV8, failureV2, getDeviceInfo, getDeviceProperties, getMusic
 } = require('./Extensions.js')
 
 const { isTruthy, isTruthyProperty, isTruthyPropertyStringNotEmpty, validRegex,
-  validToInteger, encodeHtmlEntity, extractSatellitesUuids, validTime, validPropertyRequiredRegex,
-  validPropertyRequiredInteger, validPropertyRequiredOnOff
+  validToInteger, encodeHtmlEntity, extractSatellitesUuids, extractSubwooferUuid, validTime,
+  validPropertyRequiredRegex, validPropertyRequiredInteger, validPropertyRequiredOnOff
 } = require('./Helper.js')
 
 const { SonosDevice, MetaDataHelper } = require('@svrooij/sonos/lib')
@@ -112,6 +112,7 @@ module.exports = function (RED) {
     'household.get.sonosplaylisttracks': householdGetSonosPlaylistTracks,
     'household.remove.satellites': householdRemoveSatellites,
     'household.remove.sonosplaylist': householdRemoveSonosPlaylist,
+    'household.remove.subwoofer': householdRemoveSubwoofer,
     'household.separate.group': householdSeparateGroup,
     'household.separate.stereopair': householdSeparateStereoPair,
     'household.set.alarmtime': householdSetAlarmTime,
@@ -2802,7 +2803,7 @@ module.exports = function (RED) {
   }
 
   /**
-   *  Removes only the satellites (not the subwoofer) of players. 
+   *  Removes only the satellites (not the subwoofer) of a player. 
    * All players will become visible again. Github #238
    * @param {object} msg incoming message
    * @param {string} msg.payload - main SONOS-Playername, is visible
@@ -2850,6 +2851,59 @@ module.exports = function (RED) {
     return {}
   }
 
+  /**
+   * Removes only the subwoofer of a player. 
+   * The subwoofer will become visible again. 
+   * @param {object} msg incoming message
+   * @param {string} msg.payload - main SONOS-Playername, is visible
+   * @param {object} tsPlayer any sonos-ts player with .urlObject as Javascript build-in URL
+   *
+   * @returns {promise<object>} {}
+   *
+   * @throws {error} 'all groups data undefined', 
+   * 'main player name left was not found'
+   * @throws {error} all methods
+   * 
+   * CAUTION: The command has to be send to the main player!
+   *
+   */
+  async function householdRemoveSubwoofer (msg, tsPlayer) {
+    debug('command:%s', 'householdRemoveSubwoofer')
+
+    const mainPlayername = validRegex(msg, 'payload', REGEX_ANYCHAR, 'main player name')
+
+    // Get all player and find the given one
+    const allGroupsData = await getGroupsAll(tsPlayer, true)
+    if (!isTruthy(allGroupsData)) {
+      throw new Error(`${PACKAGE_PREFIX} all groups data undefined`)
+    }
+    // - flatten the array of groups of player and search for main player
+    const flatArrayOfPlayer = [].concat.apply([], allGroupsData)
+    const mainPlayerData = flatArrayOfPlayer.find(singlePlayer => {
+      return singlePlayer.playerName === mainPlayername
+    })
+    if (mainPlayerData === undefined) {
+      throw new Error(`${PACKAGE_PREFIX} could not find given main player`)
+    }
+
+    // Get Satellites UUIDs
+    // :SW can be in htSatChanMapSet or channelMapSet
+    let mapSet = mainPlayerData.htSatChanMapSet 
+    if (!mapSet.includes(':SW')) {
+      mapSet = mainPlayerData.channelMapSet
+    }
+    
+    const subwooferUuid = await extractSubwooferUuid(mapSet)
+    console.log(subwooferUuid)
+
+    // IMPORTANT: Must be send to main player
+    const tsMainPlayer = new SonosDevice(mainPlayerData.urlObject.hostname)
+    await tsMainPlayer.DevicePropertiesService.RemoveHTSatellite(
+      { 'SatRoomUUID': subwooferUuid })
+
+    return {}
+  }
+
   /**
    *  Household test player connection
    * @param {object} msg incoming message