Mopiqtt 2.0.0__py3-none-any.whl

mopiqtt/__init__.py

@@ -0,0 +1,39 @@
+from __future__ import unicode_literals
+
+from __future__ import absolute_import
+import logging
+import os
+
+from mopidy import config, ext
+
+
+__version__ = "2.0.0"
+logger = logging.getLogger(__name__)
+
+
+class Extension(ext.Extension):
+
+    dist_name = "Mopiqtt"
+    ext_name = "mopiqtt"
+    version = __version__
+
+    def get_default_config(self):
+        conf_file = os.path.join(os.path.dirname(__file__), "ext.conf")
+        return config.read(conf_file)
+
+    def get_config_schema(self):
+        schema = super(Extension, self).get_config_schema()
+
+        schema["host"] = config.Hostname()
+        schema["port"] = config.Port(optional=True)
+        schema["topic"] = config.String()
+
+        schema["username"] = config.String(optional=True)
+        schema["password"] = config.Secret(optional=True)
+
+        return schema
+
+    def setup(self, registry):
+        from mopiqtt.frontend import MopiqttFrontend
+
+        registry.add("frontend", MopiqttFrontend)

mopiqtt/ext.conf

@@ -0,0 +1,7 @@
+[mopiqtt]
+enabled = true
+host = 127.0.0.1
+port = 1883
+topic = mopidy
+username =
+password =

mopiqtt/frontend.py

@@ -0,0 +1,415 @@
+from builtins import str
+from importlib import import_module
+import json
+import logging
+
+import pykka
+from mopidy.core import CoreListener
+from mopidy.models import SearchResult
+
+from .mqtt import Comms
+from .utils import describe_track, describe_stream, get_track_artwork
+
+
+def _load_playback_state():
+    for module_name in ("mopidy.types", "mopidy.audio"):
+        try:
+            module = import_module(module_name)
+            return getattr(module, "PlaybackState")
+        except (AttributeError, ImportError):
+            continue
+
+    raise ImportError("Cannot import PlaybackState from Mopidy")
+
+
+PlaybackState = _load_playback_state()
+
+log = logging.getLogger(__name__)
+
+
+VOLUME_MAX = 100
+VOLUME_MIN = 0
+
+
+class MopiqttFrontend(pykka.ThreadingActor, CoreListener):
+    def __init__(self, config, core):
+        """
+        config (dict): The entire Mopidy configuration.
+        core (ActorProxy): Core actor for Mopidy Core API.
+        """
+        super(MopiqttFrontend, self).__init__()
+        self.core = core
+        self.mqtt = Comms(frontend=self, **config["mopiqtt"])
+        self.defaultImage = (
+            "https://upload.wikimedia.org/wikipedia/commons/1/14/No_Image_Available.jpg"
+        )
+
+    def on_start(self):
+        """
+        Hook for doing any setup that should be done *after* the actor is
+        started, but *before* it starts processing messages.
+        """
+        log.debug("Starting MQTT frontend: %s", self)
+        self.mqtt.start()
+
+    def on_stop(self):
+        """
+        Hook for doing any cleanup that should be done *after* the actor has
+        processed the last message, and *before* the actor stops.
+        """
+        log.debug("Stopping MQTT frontend: %s", self)
+        self.mqtt.stop()
+
+    def on_failure(self, exception_type, exception_value, traceback):
+        """
+        Hook for doing any cleanup *after* an unhandled exception is raised,
+        and *before* the actor stops.
+        """
+        log.error("MQTT frontend failed: %s", exception_value)
+
+    @property
+    def volume(self):
+        return self.core.mixer.get_volume().get()
+
+    @volume.setter
+    def volume(self, value):
+        # Normalize.
+        value = min(value, VOLUME_MAX)
+        value = max(value, VOLUME_MIN)
+        self.core.mixer.set_volume(value).get()
+
+    @property
+    def current_state(self):
+        return self.core.playback.get_state().get()
+
+    def tracklist_changed(self):
+        # reports any change to the current tracklist
+        # and triggers trklist
+        log.debug("MQTT tracklist changed")
+        #
+        # get list of all tracks in the queue
+        #
+        tk_list = self.core.tracklist.get_tracks().get()
+        tracks = []
+        item = {}
+        for a in tk_list:
+            name = a.name or ""
+            if a.artists:
+                artist = next(iter(a.artists)).name or ""
+                item_name = "{} - {}".format(artist, name) if artist else name
+            else:
+                item_name = name
+            item = {"name": item_name, "uri": a.uri}
+            tracks.append(item)
+        self.mqtt.publish("trklist", json.dumps(tracks))
+        log.debug("Generated tracklist list")
+
+    def playback_state_changed(self, old_state, new_state):
+        """
+        old_state (mopidy.core.PlaybackState) - the state before the change.
+        new_state (mopidy.core.PlaybackState) - the state after the change.
+        """
+        log.debug("MQTT playback state changed: %s", new_state)
+        self.mqtt.publish("plstate", new_state)
+
+    def track_playback_started(self, tl_track):
+        """
+        tl_track (mopidy.models.TlTrack) - the track that just started playing.
+        """
+        log.debug("MQTT track started: %s", tl_track.track)
+        self.mqtt.publish("trk", describe_track(tl_track.track))
+
+        # get track's uri
+        self.mqtt.publish("trk_uri", tl_track.track.uri)
+
+        # get track's artwork (if any)
+        self.mqtt.publish("artw", get_track_artwork(self, tl_track.track))
+
+        # get track playing indexes
+        curr = self.core.tracklist.index().get()
+        last = self.core.tracklist.get_length().get()
+        pl_index = {}
+        pl_index["current"] = curr + 1 if curr is not None else None
+        pl_index["last"] = last
+        pl_index = json.dumps(pl_index)
+        self.mqtt.publish("trk-index", pl_index)
+
+    def track_playback_ended(self, tl_track, time_position):
+        """
+        tl_track (mopidy.models.TlTrack) - the track that was played before
+                                           playback stopped.
+        time_position (int) - the time position in milliseconds.
+        """
+        log.debug("MQTT track ended: %s", tl_track.track.name)
+        self.mqtt.publish("trk", "")
+
+    def volume_changed(self, volume):
+        """
+        volume (int) - the new volume in the range [0..100].
+        """
+        log.debug("MQTT volume changed: %s", volume)
+        self.mqtt.publish("vol", str(volume))
+
+    def stream_title_changed(self, title):
+        """
+        title (string) - the new stream title.
+        """
+        log.debug("MQTT title changed: %s", title)
+        self.mqtt.publish("trk", describe_stream(title))
+
+    def playlists_loaded(self):
+        log.debug("Playlists loaded event")
+        self.mqtt.publish("refreshed", "")
+
+    def on_action_plb(self, value):
+        """Playback control."""
+        if value == "play":
+            return self.core.playback.play().get()
+        if value == "stop":
+            return self.core.playback.stop().get()
+        if value == "pause":
+            return self.core.playback.pause().get()
+        if value == "resume":
+            return self.core.playback.resume().get()
+
+        if value == "toggle":
+            if self.current_state == PlaybackState.PLAYING:
+                return self.core.playback.pause().get()
+            if self.current_state == PlaybackState.PAUSED:
+                return self.core.playback.resume().get()
+            if self.current_state == PlaybackState.STOPPED:
+                return self.core.playback.play().get()
+
+        if value == "prev":
+            return self.core.playback.previous().get()
+        if value == "next":
+            return self.core.playback.next().get()
+
+        log.warning("Unknown playback control action: %s", value)
+
+    def on_action_vol(self, value):
+        """Volume control."""
+        if not value or len(value) < 2:
+            return log.warning("Invalid volume control parameter: %s", value)
+
+        operator = value[0]
+        try:
+            amount = int(value[1:])
+        except ValueError:
+            return log.warning("Invalid volume setting value: %s", value[1:])
+
+        # Exact volume.
+        if operator == "=":
+            self.volume = amount
+            return
+        # Volume down.
+        if operator == "-":
+            self.volume -= amount
+            return
+        # Volume up.
+        if operator == "+":
+            self.volume += amount
+            return
+
+        log.warning("Unknown volume control operator: %s", operator)
+
+    def on_action_add(self, value):
+        """Append URI to queue (tracklist)."""
+        if not value:
+            return log.warning("Cannot add empty track to queue")
+
+        track = []
+        track.append(value)
+        self.core.tracklist.add(uris=track).get()
+        log.debug("Added track: %s", value)
+
+    def _resolve_tracks(self, uris):
+        if not uris:
+            return None
+
+        # Mopidy 3 and 4 implement tracklist.add(uris=...) using this same
+        # lookup and flattening each URI in order. Iterating the original URI
+        # list here also preserves duplicate playlist entries.
+        lookup = self.core.library.lookup(uris=uris).get()
+        if not lookup:
+            return None
+
+        tracks = []
+        for uri in uris:
+            uri_tracks = lookup.get(uri)
+            if not uri_tracks:
+                return None
+            tracks.extend(uri_tracks)
+
+        return tracks
+
+    def _restore_tracklist(self, tracks):
+        try:
+            self.core.tracklist.clear().get()
+            if tracks:
+                self.core.tracklist.add(tracks=tracks).get()
+        except Exception:
+            log.exception("Failed to restore previous tracklist")
+            return False
+
+        return True
+
+    def _replace_tracklist(self, tracks, shuffle=False):
+        try:
+            previous_version = self.core.tracklist.get_version().get()
+            previous_tracks = self.core.tracklist.get_tracks().get()
+            if self.core.tracklist.get_version().get() != previous_version:
+                log.warning("Tracklist changed while preparing replacement")
+                return False
+        except Exception:
+            log.exception("Cannot snapshot the current tracklist")
+            return False
+
+        try:
+            self.core.tracklist.clear().get()
+            self.core.tracklist.add(tracks=tracks).get()
+            if shuffle:
+                self.core.tracklist.shuffle().get()
+            self.core.playback.play().get()
+        except Exception:
+            log.exception("Failed to replace tracklist; restoring previous queue")
+            self._restore_tracklist(previous_tracks)
+            return False
+
+        return True
+
+    def on_action_pstream(self, value):
+        """Load and start a radio stream or a single track (tracklist)."""
+        if not value:
+            return log.warning("Cannot load empty track to queue")
+
+        try:
+            tracks = self._resolve_tracks([value])
+        except Exception:
+            log.exception("Failed to validate stream: %s", value)
+            return
+
+        if not tracks:
+            log.info("Invalid stream: %s", value)
+            return
+
+        if self._replace_tracklist(tracks):
+            log.debug("Started track: %s", value)
+
+    def _get_playlist_tracks(self, uri):
+        items = self.core.playlists.get_items(uri).get()
+        if not items:
+            return None
+
+        uris = []
+        for item in items:
+            item_uri = getattr(item, "uri", None)
+            if not item_uri:
+                return None
+            uris.append(item_uri)
+
+        return self._resolve_tracks(uris)
+
+    def on_action_pload(self, value):
+        """Replace current queue with playlist from URI."""
+        if not value:
+            return log.warning("Cannot load unnamed playlist")
+
+        try:
+            tracks = self._get_playlist_tracks(value)
+        except Exception:
+            log.exception("Failed to validate playlist: %s", value)
+            return
+
+        if not tracks:
+            log.info("Invalid playlist: %s", value)
+            return
+
+        if self._replace_tracklist(tracks):
+            log.debug("Started Playlist: %s", value)
+
+    def on_action_ploadshfl(self, value):
+        # Replace current queue with shuffled playlist from URI.
+        if not value:
+            return log.warning("Cannot load unnamed playlist")
+
+        try:
+            tracks = self._get_playlist_tracks(value)
+        except Exception:
+            log.exception("Failed to validate playlist: %s", value)
+            return
+
+        if not tracks:
+            log.info("Invalid playlist: %s", value)
+            return
+
+        if self._replace_tracklist(tracks, shuffle=True):
+            log.debug("Started shuffled Playlist: %s", value)
+
+    def on_action_clr(self, value):
+        """Clear the queue (tracklist)."""
+        return self.core.tracklist.clear().get()
+
+    def on_action_plist(self, value):
+        # Request a list of all playlist
+        plist = self.core.playlists.as_list()
+        playlists = []
+        item = {}
+        for a in plist.get():
+            item = {"name": a.name, "uri": a.uri}
+            playlists.append(item)
+        self.mqtt.publish("plists", json.dumps(playlists))
+        log.debug("Generated playlist list")
+
+    def on_action_plrefresh(self, value):
+        # refresh a single playlist or all
+        # value = uri_scheme, if value=None, all playlists are refreshed
+        if value:
+            self.core.playlists.refresh(uri_scheme=value).get()
+            log.debug("Refreshed playlists with uri_scheme: %s", value)
+        else:
+            self.core.playlists.refresh().get()
+            log.debug("Refreshed all playlists")
+
+    def on_action_chgtrk(self, value):
+        # change current playing track in the queue
+        if not value:
+            return log.info("chgtrk: Cannot change track to empty uri")
+
+        flt = self.core.tracklist.filter(criteria={"uri": [value]}).get()
+        if not flt:
+            return log.info("chgtrk: Invalid track")
+        tl_track = flt[0]
+        self.core.playback.play(tlid=tl_track.tlid).get()
+        log.debug("Changed track to tlid: %s", tl_track.tlid)
+
+    def on_action_queryschemes(self, value):
+        # request uri_schemes handled by search
+        schemes = self.core.get_uri_schemes().get()
+        log.debug("Uri_schemes handled by search: %s", schemes)
+        self.mqtt.publish("uri_schemes", json.dumps(schemes))
+
+    def on_action_search(self, value):
+        if not value:
+            return log.info("search: Cannot search empty strings")
+        value = json.loads(value)
+        lookup_str = value["search"]
+        lookup_uris = value["uri_schemes"]
+        query = {"any": lookup_str}
+        results = self.core.library.search(query=query, uris=lookup_uris).get()
+        if isinstance(results, SearchResult):
+            search_result = results
+        else:
+            search_result = next(iter(results or ()), None)
+
+        tracks = getattr(search_result, "tracks", ()) or ()
+        found = len(tracks)
+        item = {}
+        final_list = []
+        for k in tracks:
+            item = {"name": k.name, "uri": k.uri}
+            final_list.append(item)
+        log.debug(
+            "Search for %s in %s ended. Found %d tracks", lookup_str, lookup_uris, found
+        )
+        self.mqtt.publish("search_results", json.dumps(final_list))

mopiqtt/mqtt.py

@@ -0,0 +1,119 @@
+import logging
+import random
+
+from paho.mqtt import client as mqtt
+from paho.mqtt.enums import CallbackAPIVersion
+
+
+log = logging.getLogger(__name__)
+
+
+HANDLER_PREFIX = "on_action_"
+
+
+class Comms:
+    def __init__(
+        self,
+        frontend,
+        host="localhost",
+        port=1883,
+        topic="mopidy",
+        username=None,
+        password=None,
+        **kwargs
+    ):
+        """
+        Configure MQTT communication client.
+        frontend (MopiqttFrontend): Instance of extension's frontend.
+        """
+        self.frontend = frontend
+        self.host = host
+        self.port = port
+        self.topic = topic
+        self.user = username
+        self.password = password
+
+        self.client = mqtt.Client(
+            callback_api_version=CallbackAPIVersion.VERSION2,
+            client_id="mopidy-{}".format(random.randint(1000, 9999)),
+        )
+        self.client.on_connect = self._on_connect
+        self.client.on_message = self._on_message
+
+    def start(self):
+        """
+        Attempt connection to MQTT broker and initialise network loop.
+        """
+        if self.user and self.password:
+            self.client.username_pw_set(username=self.user, password=self.password)
+
+        self.client.connect_async(host=self.host, port=self.port)
+        log.debug("Connecting to MQTT broker at %s:%s", self.host, self.port)
+        self.client.loop_start()
+        log.debug("Started MQTT communication loop.")
+
+    def stop(self):
+        """
+        Clean up and disconnect from MQTT broker.
+        """
+        self.client.disconnect()
+        log.debug("Disconnected from MQTT broker")
+
+    def _on_connect(self, client, userdata, flags, rc, properties):
+        if rc != 0:
+            log.error("Failed to connect to MQTT broker, result: %s", rc)
+            return
+
+        log.info("Successfully connected to MQTT broker, result :%s", rc)
+
+        for name in dir(self.frontend):
+            if not name.startswith(HANDLER_PREFIX):
+                continue
+
+            suffix = name[len(HANDLER_PREFIX) :]
+            full_topic = "{}/cmnd/{}".format(self.topic, suffix)
+            result, _ = self.client.subscribe(full_topic)
+
+            if result == mqtt.MQTT_ERR_SUCCESS:
+                log.debug("Subscribed to MQTT topic: %s", full_topic)
+            else:
+                log.warning(
+                    "Failed to subscribe to MQTT topic: %s, result: %s",
+                    full_topic,
+                    result,
+                )
+
+    def _on_message(self, client, userdata, message):
+        topic = "<unknown>"
+        payload = None
+
+        try:
+            topic = message.topic
+            action = topic.split("/")[-1]
+
+            handler = getattr(self.frontend, HANDLER_PREFIX + action, None)
+            if not handler:
+                log.warning("Cannot handle MQTT messages on topic: %s", topic)
+                return
+
+            payload = message.payload.decode("utf8")
+            log.debug(
+                "Passing payload: %s to MQTT handler: %s",
+                message.payload,
+                handler.__name__,
+            )
+            handler(value=payload)
+        except Exception:
+            if payload is None:
+                payload = getattr(message, "payload", None)
+            log.exception(
+                "Failed to process MQTT message: topic=%s payload=%r",
+                topic,
+                payload,
+            )
+
+    def publish(self, subtopic, value):
+        full_topic = "{}/stat/{}".format(self.topic, subtopic)
+
+        log.debug("Publishing: %s to MQTT topic: %s", value, full_topic)
+        return self.client.publish(topic=full_topic, payload=value)

mopiqtt/utils.py

@@ -0,0 +1,74 @@
+import logging
+
+
+log = logging.getLogger(__name__)
+
+
+UNKNOWN = ""
+
+
+def describe_track(track):
+    """
+    Prepare a short human-readable Track description.
+
+    track (mopidy.models.Track): Track to source song data from.
+    """
+    title = track.name or UNKNOWN
+
+    # Simple/regular case: normal song (e.g. from Spotify).
+    if track.artists:
+        artist = next(iter(track.artists)).name
+    elif track.album and track.album.artists:  # Album-only artist case.
+        artist = next(iter(track.album.artists)).name
+    else:
+        artist = UNKNOWN
+
+    if track.album and track.album.name:
+        album = track.album.name
+    else:
+        album = UNKNOWN
+
+    return ";".join([title, artist, album])
+
+
+def describe_stream(raw_title):
+    """
+    Attempt to parse given stream title in very rudimentary way.
+    """
+    title = UNKNOWN
+    artist = UNKNOWN
+    album = UNKNOWN
+
+    # Very common separator.
+    if "-" in raw_title:
+        parts = raw_title.split("-")
+        artist = parts[0].strip()
+        title = parts[1].strip()
+    else:
+        # Just assume we only have track title.
+        title = raw_title
+
+    return ";".join([title, artist, album])
+
+
+def get_track_artwork(self, track):
+    track_uri = getattr(track, "uri", None)
+    if not track_uri:
+        return self.defaultImage
+
+    try:
+        artwork = self.core.library.get_images([track_uri]).get()
+        images = (artwork or {}).get(track_uri, ())
+        if not images:
+            return self.defaultImage
+
+        image_uri = getattr(images[0], "uri", None)
+        if not image_uri:
+            return self.defaultImage
+        if image_uri == "/local" or image_uri.startswith("/local/"):
+            return self.defaultImage
+
+        return image_uri
+    except Exception:
+        log.exception("Failed to get artwork for track URI: %s", track_uri)
+        return self.defaultImage

mopiqtt-2.0.0.dist-info/METADATA

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: Mopiqtt
+Version: 2.0.0
+Summary: Control mopidy music server through MQTT broker
+Home-page: https://github.com/fmarzocca/mopiqtt
+Author: Fabio Marzocca
+Author-email: marzoccafabio@gmail.com
+License: Apache License, Version 2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players
+Classifier: Environment :: No Input/Output (Daemon)
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Mopidy<5,>=3.4
+Requires-Dist: paho-mqtt>=2.0
+Requires-Dist: Pykka>=2.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+Based on [mopidy-mqtt](https://github.com/odiroot/mopidy-mqtt)
+
+# Mopiqtt
+[![CI](https://github.com/fmarzocca/Mopiqtt/actions/workflows/ci.yml/badge.svg?branch=Development)](https://github.com/fmarzocca/Mopiqtt/actions/workflows/ci.yml)
+
+ MQTT interface for Mopidy music server. Allows easy integration with Node Red or any MQTT client.
+ This package is mainly useful to Node Red users, who can embed in their flows a full control over Mopidy by simple mqtt-in or mqtt-out nodes. See [Node Red examples](https://github.com/fmarzocca/Mopiqtt/tree/Development/NodeRed%20examples). Of course, it can be used by any other MQTT client too.
+
+# Requirements
+
+* Python 3.13 or later
+* Mopidy 3.4.x or Mopidy 4.0.x
+* An MQTT broker
+
+Mopidy 4 is recommended for new installations. Mopidy 3.4 compatibility is
+maintained throughout the Mopiqtt 2.x series.
+
+# Installation
+
+Using pip:
+```
+[sudo] python3 -m pip install Mopiqtt
+```
+(If you are running Mopidy as a service, use `sudo`)
+
+# Configuration
+
+Add the following section to your mopidy's configuration file: `/etc/mopidy/mopidy.conf`
+
+
+```
+[mopiqtt]
+host = <mqtt broker address>
+port = 1883
+topic = mopidy
+username =
+password =
+```
+
+*Note*: Remember to also supply `username` and `password` options if your
+MQTT broker requires authentication. If not, just leave blank the two values.
+
+*Note*: Restart Mopidy with `sudo service mopidy restart`
+
+To check Mopidy log run `sudo tail -f /var/log/mopidy/mopidy.log`
+
+### Mopidy 3 compatibility
+
+Mopidy 3 imports `pkg_resources` at runtime. If you use Mopidy 3, keep
+`setuptools` below version 82, since version 82 removed `pkg_resources`.
+Mopidy 4 does not require this constraint.
+
+Mopidy 3 compatibility is maintained in the 2.x series and may be removed in a
+future major release. New installations should use Mopidy 4.
+
+# Features
+
+* Sends information about Mopidy state on any change
+    - Playback status
+    - Volume
+    - Track description
+    - Playlists list
+    - Artwork
+    - Track index
+* Reacts to control commands
+    - Playback control
+    - Tracklist control
+    - Volume control
+    - Load & play a playlist (straight or shuffle)
+    - Request playlists list
+    - Refresh playlists
+    - Get tracklist
+    - Search for artist/album/track name
+
+
+# MQTT protocol
+
+## Topics
+
+Default top level topic: `mopidy`.
+
+Control topic: `mopidy/cmnd`.
+
+Information topic `mopidy/stat`.
+
+## Messages to subscribe to (mopidy/stat/`<msg>`)
+
+|               |  Subtopic |                  Values                   |
+|:-------------:|:---------:|:-----------------------------------------:|
+| Playback State|   `/plstate`  | `paused` / `stopped` / `playing`         |
+| Volume        |   `/vol`  |               `<level(int)>`               |
+| Current track |   `/trk`  | `<title(str)>;<artist(str)>;<album(str)>` or ` ` |
+| List of playlists | `/plists` | `<array of playlists name:uri>`       |
+| Track Artwork (*)| `/artw`   |   `<url of image to download>`         | 
+| Track uri (*)| `/trk_uri`   |   `<track uri (string)>`         | 
+| Playing track index (*)| `/trk-index` |  ` {current: x, last: y}`     |
+| Playlists have been refreshed | `/refreshed` | ` `                    |
+| List of tracks in the queue(**)   | `/trklist` | `<array of tracks name:uri>` |
+| List of URI schemes Mopidy can handle in search(***) | `/uri_schemes` | `<array of schemes (str)>` |
+| Search results | `/search_results` | `<array of objects {name: .. , uri:...}>` |
+
+`(*)`  Published after any track started playback. Local artwork is NOT supported  
+`(**)` Published after any tracklist change  
+`(***)`Published after a request `queryschemes`
+
+## Messages to publish to (mopidy/cmnd/`<msg>`)
+
+|                 | Subtopic |                               Parameters                           |
+|:----------------:|:--------:|:-----------------------------------------------------------------:|
+| Playback control | `/plb`   | `play` / `stop` / `pause` / `resume` / `toggle` / `prev` / `next` |
+| Volume control   | `/vol`   | `=<int>` or `-<int>` or `+<int>`                                  |
+| Clear queue      | `/clr`   | ` `                                                               |
+| Add to queue     | `/add`   | `<uri(str)>`                                                       |
+| Load and play playlist (straight)  | `/pload` | `<uri(str)>`                                     |
+| Load and play playlist (shuffle)   |   `/ploadshfl` | `<uri(str)>`                               |   
+| Request list of playlists| `/plist` | ` `                                                       |
+| Load and play a radio stream (or a single track) | `/pstream`| `<uri(str)>`                      |
+| Refresh one or all playlists(*)| `/plrefresh` | `<uri_scheme>` or `None`                        |
+| Change current playing track(**)| `/chgtrk` |    `<uri(str)>`                                    |
+| Query URI schemes Mopidy can handle in search | `/queryschemes` |  ` `                           |
+| Search for any string (artist, track, album) | `/search` | `<JSON {"search": [list of strings], "uri_schemes": [list of schemes]}>` | 
+
+
+`(*)` If `uri_scheme` is None, all backends are asked to refresh. If `uri_scheme` is an URI scheme handled by a backend, only that backend is asked to refresh.  
+`(**)` Note that the track must already be in the tracklist.
+
+Playlist and stream load commands validate every URI before changing the queue. If
+loading fails after the replacement starts, Mopiqtt attempts to restore the previous
+queue using Mopidy's public tracklist operations. This rollback is best-effort and
+only covers queue contents; it does not restore the current track, TLID, playback
+position, or playback state.
+
+
+# Contribute
+
+You can contribute to Mopiqtt by:
+   
+[![paypal](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://www.paypal.com/donate/?hosted_button_id=NQHVVDCNK3UDL)
+
+# Credits
+- Current maintainer: [fmarzocca](https://github.com/fmarzocca)
+
+Based on previous works of:
+-  [odiroot](https://github.com/odiroot)
+-  [magcode](https://github.com/magcode>)
+
+# Project resources
+[![Downloads](https://pepy.tech/badge/mopiqtt)](https://pepy.tech/project/mopiqtt)
+
+- [Source code](<https://github.com/fmarzocca/mopiqtt>)
+- [Issue tracker](<https://github.com/fmarzocca/mopiqtt/issues>)
+- [Changelog](<https://github.com/fmarzocca/mopiqtt/blob/main/CHANGELOG.md>)

mopiqtt-2.0.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+mopiqtt/__init__.py,sha256=1nU0N2oz04WA6BJa_-iIUC8t84MiT9PFRDILEsJKZ9I,963
+mopiqtt/ext.conf,sha256=sX7ejcS6-Whl5RSpoRprEZstRQC7Q5vcPExUfFSo87c,98
+mopiqtt/frontend.py,sha256=0mPcDB4gIJ6SO0GGaeMmovSXoEp_OWE7mSo1jRzpjaI,14002
+mopiqtt/mqtt.py,sha256=nhx_BedXpez6p70bgQrXWWrillOHL_MIAKSO-iCllGQ,3671
+mopiqtt/utils.py,sha256=I4VDMKH_ddmrrG3aR-0Bl8cYapnj0aibBrWqv_TOV6o,1880
+mopiqtt-2.0.0.dist-info/licenses/LICENSE,sha256=UOZ1F5fFDe3XXvG4oNnkL1-Ecun7zpHzRxjp-XsMeAo,11324
+mopiqtt-2.0.0.dist-info/METADATA,sha256=R2TutOYng9sKD5zU9I0Q-SyrGKcyNW1R4VZa2kfzUpE,7641
+mopiqtt-2.0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+mopiqtt-2.0.0.dist-info/entry_points.txt,sha256=-BJFFSMBNL7I7NYM4-TWX3_PGuzfJE3AVR_xAv-E1-Q,41
+mopiqtt-2.0.0.dist-info/top_level.txt,sha256=JOydIglHbWPv_XZnlDM8eKwqPDRaKKqg6A9-OxYVeH8,8
+mopiqtt-2.0.0.dist-info/RECORD,,

mopiqtt-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mopiqtt-2.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[mopidy.ext]
+mopiqtt = mopiqtt:Extension

mopiqtt-2.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mopiqtt-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+mopiqtt