Skip to main content

Control mopidy music server through MQTT broker

Project description

Based on mopidy-mqtt

Mopiqtt

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. Of course, it can be used by any other MQTT client too.

Installation

Using pip:

python3 -m pip install Mopiqtt

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

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

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 / stop / playing
Volume /vol <level:int>
Current track /trk <artist:str>;<title:str>;<album> or
List of playlists /plists <array of playlists name:uri>
Track Artwork (*) /artw <url of image to download>
Playing track index (*) /trk-index {current: x, last: y}
Playlists have been refreshed /refreshed

(*) Published after any track started playback

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

(*) 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.

Credits

Based on previous works of:

Contribute

You can contribute to Mopiqtt by:

paypal

Changelog

Downloads

1.0.1

  • First release

1.0.2

  • Added mopidy/cmnd/ploadshf to load and play shuffled playlists

1.0.3

  • Better playlist list formatting Breaking change: Now the list is an array of objects
  • Introducing position of current playing track

1.0.4

  • Fixed bug on mopidy/cmnd/add
  • Added mopidy/cmnd/pstream to load and play a radio stream (or any single track)
  • Added mopidy/stat/refreshed event when playlists have been refreshed
  • Added mopidy/stat/plrefresh to refresh one or all playlists

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Mopiqtt-1.0.4.tar.gz (13.2 kB view details)

Uploaded Source

File details

Details for the file Mopiqtt-1.0.4.tar.gz.

File metadata

  • Download URL: Mopiqtt-1.0.4.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.5

File hashes

Hashes for Mopiqtt-1.0.4.tar.gz
Algorithm Hash digest
SHA256 edab9bc7913c48bf45b29a84670ba9e9c9383acf9b824ff389883e5db09ebdc8
MD5 b4c12d132d0522124d5c4be6f7fae0ff
BLAKE2b-256 6498e4c8b5a15169c2c8eed7fe488b1e749324c94c5ffdeee4df619f56519cbf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page