soco-cli 0.4.75__tar.gz → 0.4.77__tar.gz

{soco-cli-0.4.75/soco_cli.egg-info → soco_cli-0.4.77}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: soco-cli
-Version: 0.4.75
+Version: 0.4.77
 Summary: Sonos command line control utility, based on SoCo
 Author-email: Avantrec Ltd <soco_cli@avantrec.com>
 Project-URL: Homepage, https://github.com/avantrec/soco-cli
@@ -12,7 +12,7 @@ Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: soco==0.27.1; python_version < "3.6"
-Requires-Dist: soco>=0.29.0; python_version >= "3.6"
+Requires-Dist: soco>=0.30.2; python_version >= "3.6"
 Requires-Dist: ifaddr==0.1.7; python_version < "3.7"
 Requires-Dist: ifaddr>=0.2.0; python_version >= "3.7"
 Requires-Dist: tabulate

{soco-cli-0.4.75 → soco_cli-0.4.77}/README.md

@@ -62,6 +62,7 @@
       * [Using the Local Speaker Cache](#using-the-local-speaker-cache)
       * [HTTP Request Structure](#http-request-structure)
       * [Return Values](#return-values)
+      * [Asynchronous Commands (Experimental)](#asynchronous-commands-experimental)
       * [Macros: Defining Custom HTTP API Server Actions](#macros-defining-custom-http-api-server-actions)
          * [Macro Definition and Usage](#macro-definition-and-usage)
          * [Macro Arguments](#macro-arguments)
@@ -84,7 +85,7 @@
    * [Resources](#resources)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: pwt, at: Mon Oct  9 14:49:13 BST 2023 -->
+<!-- Added by: pwt, at: Sat May 11 11:52:19 BST 2024 -->
 
 <!--te-->
 
@@ -409,6 +410,7 @@ sonos Kitchen play_from_queue 5
 - **`play_m3u <m3u_file> <options>`** (or **`play_local_m3u`**): Plays a local M3U/M3U8 playlist consisting of local audio files (in supported audio formats). Can be followed by options `p` to print each filename before it plays, and/or `s` to shuffle the playlist, or `r` to play a single, random track from the playlist. (If using multiple options, concatenate them: e.g., `ps`.) Example: `sonos Study play_m3u my_playlist.m3u ps`. Add the `i` option to invoke **interactive** mode, which allows use of the keyboard to go to the (N)ext track, to (P)ause, or to (R)esume playback.
 - **`play_mode` (or `mode`)**: Returns the play mode of the speaker, one of `NORMAL`, `REPEAT_ONE`, `REPEAT_ALL`, `SHUFFLE`, `SHUFFLE_REPEAT_ONE`, or `SHUFFLE_NOREPEAT`.
 - **`play_mode <mode>` (or `mode`)**: Sets the play mode of the speaker to `<mode>`, which is one of the values above.
+- **`play_sharelink <sharelink>`**: Adds a sharelink to the end of the queue and starts playback.
 - **`play_uri <uri> <title>` (or `uri`, `pu`)**: Plays the audio object given by the `<uri>` parameter (e.g., a radio stream URL). `<title>` is optional, and if present will be used for the title of the audio stream.
 - **`previous` (or `prev`)**: Move to the previous track (if applicable for the audio source).
 - **`repeat` (or `rpt`)**: Returns the repeat mode state: 'off', 'one', or 'all'.
@@ -1075,6 +1077,20 @@ If the command is successful, the **`result`** field contains the result string,
 
 If the command is unsuccessful, the **`error_msg`** field contains an error message describing the error.
 
+### Asynchronous Commands (Experimental)
+
+It's sometimes useful for the HTTP API server to respond immediately while its invoked action continues to run in the background. For example, if one wants to invoke a `play_file` action, and allow it to run in the background.
+
+This can be achieved by prefixing the action with `async_`. For example:
+
+```commandline
+http://192.168.0.100:8000/Kitchen/async_play_file/my_file.mp3
+```
+
+Note that the data returned in this case may not be useful: it will simply indicate whether the background command was invoked successfully, not whether the command was successful.
+
+The `async_` functionality does not (yet) apply to the Macros feature described below.
+
 ### Macros: Defining Custom HTTP API Server Actions
 
 The **macros** feature allows the creation of custom actions or sequences of actions to be executed by the HTTP API server, and available at the `/macro/<macro_name>` endpoint. Macros are defined in a text file that is loaded when the server starts, and which can subsequently be reloaded using the `/macros/reload` endpoint.

{soco-cli-0.4.75 → soco_cli-0.4.77}/requirements.txt

@@ -1,5 +1,5 @@
 soco == 0.27.1; python_version < "3.6"
-soco >= 0.29.0; python_version >= "3.6"
+soco >= 0.30.2; python_version >= "3.6"
 ifaddr == 0.1.7; python_version < "3.7"
 ifaddr >= 0.2.0; python_version >= "3.7"
 tabulate

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/__init__.py

@@ -10,4 +10,4 @@ server, to control Sonos via HTTP requests.
 For more information, please see: https://github.com/avantrec/soco-cli
 """
 
-__version__ = "0.4.75"
+__version__ = "0.4.77"

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/action_processor.py

@@ -1659,8 +1659,7 @@ def wait_stopped_for_core(speaker, action, duration_arg, not_paused=False):
             start_time = current_time
         remaining_time = duration - (current_time - start_time)
         logging.info(
-            "Elapsed since last 'STOPPED' = {}s | total elapsed = {}s | remaining = {}s"
-            .format(
+            "Elapsed since last 'STOPPED' = {}s | total elapsed = {}s | remaining = {}s".format(
                 int(current_time - start_time),
                 int(current_time - original_start_time),
                 int(remaining_time),
@@ -2358,8 +2357,9 @@ def trueplay(speaker, action, args, soco_function, use_local_speaker_list):
                 parameter_type_error(action, "on|off")
         except:
             error_report(
-                "No Trueplay profile available for '{}' (or Trueplay not supported)"
-                .format(speaker.player_name)
+                "No Trueplay profile available for '{}' (or Trueplay not supported)".format(
+                    speaker.player_name
+                )
             )
             return False
     return True
@@ -2579,6 +2579,29 @@ def add_sharelink_to_queue(
     return True
 
 
+@one_parameter
+def play_sharelink(speaker, action, args, soco_function, use_local_speaker_list):
+    share_link = ShareLinkPlugin(speaker)
+    uri = args[0]
+
+    if not share_link.is_share_link(uri):
+        error_report("Invalid sharelink: '{}'".format(uri))
+        return False
+
+    position = speaker.queue_size + 1
+
+    try:
+        # Return the queue position of the first added item
+        queue_position = share_link.add_share_link_to_queue(uri, position)
+        save_queue_insertion_position(queue_position)
+    except SoCoUPnPException as e:
+        error_report("Unable to play sharelink to queue: {}".format(e))
+        return False
+
+    speaker.play_from_queue(queue_position - 1)
+    return True
+
+
 @zero_parameters
 def reboot_count(speaker, action, args, soco_function, use_local_speaker_list):
     print(speaker.boot_seqnum)
@@ -3142,6 +3165,7 @@ actions = {
     "channel": SonosFunction(get_channel, "", True),
     "add_sharelink_to_queue": SonosFunction(add_sharelink_to_queue, "", True),
     "sharelink": SonosFunction(add_sharelink_to_queue, "", True),
+    "play_sharelink": SonosFunction(play_sharelink, "", True),
     "is_indexing": SonosFunction(is_indexing, "", False),
     "reboot_count": SonosFunction(reboot_count, "", False),
     "play_directory": SonosFunction(play_directory, "", True),

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/alarms.py

@@ -53,18 +53,20 @@ def list_alarms(speaker, action, args, soco_function, use_local_speaker_list):
             duration = alarm.duration.strftime("%H:%M")
         else:
             duration = "No Limit"
-        details.append([
-            alarm.alarm_id,
-            alarm.zone.player_name,
-            time,
-            duration,
-            alarm.recurrence,
-            convert_true_false(alarm.enabled),
-            title,
-            alarm.play_mode,
-            alarm.volume,
-            convert_true_false(alarm.include_linked_zones),
-        ])
+        details.append(
+            [
+                alarm.alarm_id,
+                alarm.zone.player_name,
+                time,
+                duration,
+                alarm.recurrence,
+                convert_true_false(alarm.enabled),
+                title,
+                alarm.play_mode,
+                alarm.volume,
+                convert_true_false(alarm.include_linked_zones),
+            ]
+        )
 
     # Sort alarms by start time, room. Apply sorts in reverse order.
     details.sort(key=lambda field: field[1])  # Room
@@ -341,8 +343,9 @@ def copy_modify_alarm(speaker, action, args, soco_function, use_local_speaker_li
             break
     else:
         error_report(
-            "Alarm ID '{}' not found; use the 'alarms' action to find the integer ID"
-            .format(alarm_id)
+            "Alarm ID '{}' not found; use the 'alarms' action to find the integer ID".format(
+                alarm_id
+            )
         )
         return False
 
@@ -360,8 +363,9 @@ def copy_modify_alarm(speaker, action, args, soco_function, use_local_speaker_li
         new_alarm.save()
     except SoCoUPnPException as e:
         error_report(
-            "Failed to copy/move alarm; did you remember to modify the start time?: {}"
-            .format(e)
+            "Failed to copy/move alarm; did you remember to modify the start time?: {}".format(
+                e
+            )
         )
         return False
 

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/http_api.py

@@ -10,7 +10,7 @@ import argparse
 import pprint
 import shlex
 from os.path import abspath
-from subprocess import STDOUT, CalledProcessError, check_output
+from subprocess import STDOUT, CalledProcessError, Popen, check_output
 from typing import Dict, Tuple
 
 import uvicorn  # type: ignore
@@ -33,6 +33,7 @@ PREFIX_MACRO = PREFIX + "Macro: "
 MACROS: Dict[str, str] = {}
 MACRO_FILE = ""
 PP = pprint.PrettyPrinter(indent=len(PREFIX_MACRO))
+ASYNC_PREFIX = "async_"
 
 # Gets used with the local speaker list only
 SPEAKER_LIST = Speakers(network_timeout=1.0)
@@ -56,9 +57,21 @@ def command_core(
     device, error_msg = get_speaker(speaker, use_local_speaker_list=use_local)
     if device:
         speaker = device.player_name
-        exit_code, result, error_msg = sc_run(
-            device, action, *args, use_local_speaker_list=use_local
-        )
+        if not action.startswith(ASYNC_PREFIX):
+            exit_code, result, error_msg = sc_run(
+                device, action, *args, use_local_speaker_list=use_local
+            )
+        else:
+            action = action.replace(ASYNC_PREFIX, "")
+            try:
+                Popen(["sonos", str(device.ip_address), action, *args])
+                exit_code = 0
+                error_msg = ""
+                result = ""
+            except Exception as e:
+                exit_code = 1
+                error_msg = str(e)
+                result = ""
     else:
         exit_code = 1
         result = ""

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/interactive.py

@@ -443,8 +443,9 @@ def interactive_loop(
                         name = args.pop(0)
                         if name in ACTIONS_TO_EXEC_NO_SPEAKER:
                             print(
-                                "Please set an active speaker to use the '{}' action"
-                                .format(name)
+                                "Please set an active speaker to use the '{}' action".format(
+                                    name
+                                )
                             )
                             continue
                         else:
@@ -649,8 +650,9 @@ def _get_speaker_names(use_local_speaker_list=False):
             names = speaker_cache().get_all_speaker_names()
         except Exception as e:
             print(
-                "Speaker listing failed: please check your network connection [{}]"
-                .format(e)
+                "Speaker listing failed: please check your network connection [{}]".format(
+                    e
+                )
             )
             names = []
     return names

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/match_speaker_names.py

@@ -36,8 +36,9 @@ def speaker_name_matches(name_supplied, name_stored):
     name_stored = name_stored.replace("’", "'")
     if name_supplied == name_stored:
         logging.info(
-            "Found apostrophe-normalised exact speaker name match for '{}' as '{}'"
-            .format(name_supplied_original, name_stored_original)
+            "Found apostrophe-normalised exact speaker name match for '{}' as '{}'".format(
+                name_supplied_original, name_stored_original
+            )
         )
         return True, True
 

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/play_local_file.py

@@ -3,6 +3,7 @@
 import functools
 import http.client
 import logging
+import socket
 import sys
 import time
 import urllib.parse
@@ -148,19 +149,36 @@ def get_server_ip(speaker: SoCo) -> Optional[str]:
     for adapter in adapters:
         for ip in adapter.ips:
             if ip.is_IPv4 and ip.ip != "127.0.0.1":
+                # Find an available port
+                for port in range(PORT_START, PORT_END + 1):
+                    try:
+                        logging.info("Checking if port {} is available".format(port))
+                        with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+                            s.bind((ip.ip, port))
+                            available_port = port
+                            logging.info("Port {} is available".format(port))
+                            break
+                    except socket.error:
+                        continue
+                else:
+                    logging.info("No available ports for IP address '{}'".format(ip.ip))
+                    continue
                 try:
                     logging.info(
-                        "Checking target speaker's reachability from IP address '{}'"
-                        .format(ip.ip)
+                        "Checking target speaker's reachability from IP address '{}'".format(
+                            ip.ip
+                        )
                     )
                     http_connection = http.client.HTTPConnection(
                         speaker.ip_address,
                         port=1400,
-                        timeout=0.5,
-                        source_address=(ip.ip, PORT_END),
+                        timeout=5.0,
+                        source_address=(ip.ip, available_port),
                     )
                     http_connection.request("GET", "/status/info")
-                    if http_connection.getresponse().status == 200:
+                    response = http_connection.getresponse()
+                    http_connection.close()
+                    if response.status == 200:
                         return ip.ip
                 except:
                     continue

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/sonos.py

@@ -410,8 +410,9 @@ def main():
             if env_speaker:
                 if env_spkr_inserted[sequence_pointer] is False:
                     logging.info(
-                        "Getting speaker name '{}' from the $SPKR environment variable"
-                        .format(env_speaker)
+                        "Getting speaker name '{}' from the $SPKR environment variable".format(
+                            env_speaker
+                        )
                     )
                     sequence.insert(0, env_speaker)
                     speaker_name = env_speaker

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli/speakers.py

@@ -305,13 +305,15 @@ class Speakers:
                 visible = "Visible"
             else:
                 visible = "Hidden"
-            households[device.household_id].append((
-                device.speaker_name,
-                device.ip_address,
-                device.model_name.replace("Sonos ", ""),
-                visible,
-                device.display_version,
-            ))
+            households[device.household_id].append(
+                (
+                    device.speaker_name,
+                    device.ip_address,
+                    device.model_name.replace("Sonos ", ""),
+                    visible,
+                    device.display_version,
+                )
+            )
             num_devices += 1
 
         headers = [

{soco-cli-0.4.75 → soco_cli-0.4.77/soco_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: soco-cli
-Version: 0.4.75
+Version: 0.4.77
 Summary: Sonos command line control utility, based on SoCo
 Author-email: Avantrec Ltd <soco_cli@avantrec.com>
 Project-URL: Homepage, https://github.com/avantrec/soco-cli
@@ -12,7 +12,7 @@ Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: soco==0.27.1; python_version < "3.6"
-Requires-Dist: soco>=0.29.0; python_version >= "3.6"
+Requires-Dist: soco>=0.30.2; python_version >= "3.6"
 Requires-Dist: ifaddr==0.1.7; python_version < "3.7"
 Requires-Dist: ifaddr>=0.2.0; python_version >= "3.7"
 Requires-Dist: tabulate

{soco-cli-0.4.75 → soco_cli-0.4.77}/soco_cli.egg-info/requires.txt

@@ -9,7 +9,7 @@ soco==0.27.1
 ifaddr==0.1.7
 
 [:python_version >= "3.6"]
-soco>=0.29.0
+soco>=0.30.2
 
 [:python_version >= "3.7"]
 ifaddr>=0.2.0