├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.md ├── mopidy_mqtt ├── __init__.py ├── ext.conf └── frontend.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include mopidy_mqtt/ext.conf 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Features 2 | 3 | This Mopidy Frontend Extension allows you to control Mopidy with MQTT and retrieve some information from Mopidy via MQTT. 4 | The implementation is very basic. Open for any kind of pull requests. 5 | Tested with Mopidy V3. 6 | 7 | ## Status update 8 | 9 | Mopidy sends an update as soon the playback state changes: 10 | 11 | `mytopic/state -> 'paused'` 12 | 13 | When a new title or stream is started Mopidy sends this via `nowplaying` 14 | 15 | `mytopic/nowplaying -> 'myradio'` 16 | 17 | Also the image url is send: 18 | 19 | `mytopic/image -> 'https://i1.sndcdn.com/artworks-kT5TLalLJI36UD05-BMX4rQ-t500x500.jpg'` 20 | 21 | ## Play a song or stream 22 | You can start playback of a song or stream via MQTT. Send the following: 23 | 24 | `mytopic/play -> 'tunein:station:s48720'` 25 | 26 | ## Stop playback 27 | You can stop the playback via MQTT. Send the following: 28 | 29 | `mytopic/control -> 'stop'` 30 | 31 | ## Change volume 32 | You can change the mixer volume from 0 to 100 via MQTT. Send the following: 33 | 34 | `mytopic/volume -> '50'` 35 | 36 | # Installation 37 | 38 | This is an example how to install on a Raspi: 39 | 40 | ``` 41 | cd ~ 42 | git clone https://github.com/magcode/mopidy-mqtt.git 43 | cd mopidy-mqtt 44 | sudo python3 setup.py develop 45 | ``` 46 | Alternatively for a local installation you can change the last line to 47 | ``` 48 | python3 setup.py install --user 49 | ``` 50 | 51 | Now configure the following file: `/etc/mopidy/mopidy.conf` 52 | 53 | ``` 54 | [mqtthook] 55 | enabled = true 56 | mqtthost = 57 | mqttport = 58 | username = (Optional) 59 | password = (Optional) 60 | topic = 61 | stoppedimage = An image url which will be posted to the 'image' topic in case Mopidy playback is stopped. Use https://mydomain/myimage.png 62 | defaultimage = An image url which will be posted to the 'image' topic in case there is no other image available. Use https://mydomain/myimage.png 63 | ``` 64 | 65 | Restart Mopidy with `sudo service mopidy restart` 66 | 67 | To check Mopidy log run `sudo tail -f /var/log/mopidy/mopidy.log` 68 | -------------------------------------------------------------------------------- /mopidy_mqtt/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import unicode_literals 2 | 3 | import logging 4 | import os 5 | 6 | from mopidy import config, ext 7 | 8 | __version__ = '0.2.0' 9 | logger = logging.getLogger(__name__) 10 | 11 | class Extension(ext.Extension): 12 | 13 | dist_name = 'Mopidy-MQTT' 14 | ext_name = 'mqtthook' 15 | version = __version__ 16 | 17 | def get_default_config(self): 18 | conf_file = os.path.join(os.path.dirname(__file__), 'ext.conf') 19 | return config.read(conf_file) 20 | 21 | def get_config_schema(self): 22 | schema = super(Extension, self).get_config_schema() 23 | schema['tls'] = config.Boolean() 24 | schema['topic'] = config.String() 25 | schema['mqtthost'] = config.String() 26 | schema['mqttport'] = config.Integer() 27 | schema['username'] = config.String() 28 | schema['password'] = config.String() 29 | schema['stoppedimage'] = config.String() 30 | schema['defaultimage'] = config.String() 31 | schema['publishbase64image'] = config.Boolean(optional=True) 32 | return schema 33 | 34 | def setup(self, registry): 35 | from .frontend import MQTTFrontend 36 | registry.add('frontend', MQTTFrontend) 37 | -------------------------------------------------------------------------------- /mopidy_mqtt/ext.conf: -------------------------------------------------------------------------------- 1 | [mqtthook] 2 | enabled = true 3 | tls = false 4 | mqtthost = 192.168.0.1 5 | mqttport = 1883 6 | topic = home/livingroom/music 7 | username = username 8 | password = password 9 | stoppedimage = http://domain/stop.png 10 | defaultimage = http://domain/play.png 11 | publishbase64image = stopped 12 | -------------------------------------------------------------------------------- /mopidy_mqtt/frontend.py: -------------------------------------------------------------------------------- 1 | # future imports 2 | from __future__ import absolute_import 3 | from __future__ import unicode_literals 4 | 5 | # stdlib imports 6 | import logging 7 | import time 8 | import requests 9 | from PIL import Image 10 | import base64 11 | from io import BytesIO 12 | 13 | from mopidy import core 14 | 15 | import paho.mqtt.client as mqtt 16 | 17 | # third-party imports 18 | import pykka 19 | 20 | logger = logging.getLogger(__name__) 21 | 22 | class MQTTFrontend(pykka.ThreadingActor, core.CoreListener): 23 | 24 | def __init__(self, config, core): 25 | logger.info("Initializing ... ") 26 | self.core = core 27 | self.mqttClient = mqtt.Client(client_id="mopidy-" + str(int(round(time.time() * 1000))), clean_session=True) 28 | self.mqttClient.on_message = self.mqtt_on_message 29 | self.mqttClient.on_connect = self.mqtt_on_connect 30 | 31 | self.config = config['mqtthook'] 32 | host = self.config['mqtthost'] 33 | port = self.config['mqttport'] 34 | tls = self.config['tls'] 35 | self.stoppedImage = self.config['stoppedimage'] 36 | self.defaultImage = self.config['defaultimage'] 37 | self.publishBase64Image = self.config['publishbase64image'] 38 | self.topic = self.config['topic'] 39 | if tls: 40 | self.mqttClient.tls_set() 41 | if self.config['username'] and self.config['password']: 42 | self.mqttClient.username_pw_set(self.config['username'], password=self.config['password']) 43 | self.mqttClient.connect_async(host, port, 60) 44 | 45 | self.mqttClient.loop_start() 46 | super(MQTTFrontend, self).__init__() 47 | self.MQTTHook = MQTTHook(self, core, config, self.mqttClient) 48 | 49 | def mqtt_on_connect(self, client, userdata, flags, rc): 50 | logger.info("Connected with result code %s" % rc) 51 | for sub in ["/play","/control","/volume","/info","/search"]: 52 | rc = self.mqttClient.subscribe(self.topic+sub) 53 | if rc[0] != mqtt.MQTT_ERR_SUCCESS: 54 | logger.warn("Error during subscribe: " + str(rc[0])) 55 | else: 56 | logger.info("Subscribed to " + self.topic + sub) 57 | 58 | def mqtt_on_message(self, mqttc, obj, msg): 59 | payload = msg.payload.decode() 60 | logger.info("received a message on " + msg.topic+" with payload " + payload) 61 | topPlay = self.topic + "/play" 62 | topControl = self.topic + "/control" 63 | topVolume = self.topic + "/volume" 64 | topInfo = self.topic + "/info" 65 | topSearch = self.topic + "/search" 66 | 67 | if msg.topic == topPlay: 68 | self.core.tracklist.clear() 69 | self.core.tracklist.add(uris=[payload]) 70 | self.core.playback.play() 71 | elif msg.topic == topControl: 72 | if payload == "stop": 73 | self.core.playback.stop() 74 | elif payload == "pause": 75 | self.core.playback.pause() 76 | elif payload == "play": 77 | self.core.playback.play() 78 | elif payload == "resume": 79 | self.core.playback.resume() 80 | elif payload == "next": 81 | self.core.playback.next() 82 | elif payload == "previous": 83 | self.core.playback.previous() 84 | elif payload == "volplus": 85 | vol=self.core.mixer.get_volume().get()+10 86 | if (vol>100): 87 | vol=100 88 | self.core.mixer.set_volume(vol) 89 | elif payload == "volminus": 90 | vol=self.core.mixer.get_volume().get()-10 91 | if (vol<0): 92 | vol=0 93 | self.core.mixer.set_volume(vol) 94 | 95 | elif msg.topic == topVolume: 96 | try: 97 | volume=int(msg.payload) 98 | self.core.mixer.set_volume(volume) 99 | except ValueError: 100 | logger.warn("invalid payload for volume: " + msg.payload) 101 | elif msg.topic == topInfo: 102 | if msg.payload == "volume": 103 | self.MQTTHook.publish("/info","volume;"+str(self.core.mixer.get_volume().get())) 104 | elif msg.payload == "list": 105 | plist=self.core.playlists.as_list() 106 | for a in plist.get(): 107 | self.MQTTHook.publish("/lists","%s;%s"%(a.name,a.uri) ) 108 | elif msg.topic == topSearch: 109 | search=msg.payload.replace("de ","") 110 | res=self.core.library.search({'any': [search]},uris=['local:']).get() 111 | found=(len(res[0].tracks)) 112 | logger.info("Adding %d tunes from %s"%(found,search)) 113 | 114 | if (found>0): 115 | self.core.tracklist.clear() 116 | self.core.tracklist.add(tracks=res[0].tracks) 117 | self.MQTTHook.publish("/state","Adding %d tunes from %s"%(found,search)) 118 | self.core.mixer.set_volume(7) 119 | self.core.playback.play() 120 | 121 | 122 | def on_stop(self): 123 | logger.info("mopidy_mqtt shutting down ... ") 124 | self.mqttClient.disconnect() 125 | 126 | def stream_title_changed(self, title): 127 | logger.info("before" + title) 128 | titleStripped = title.rstrip('.mp3') 129 | logger.info("after" + titleStripped) 130 | self.MQTTHook.publish("/nowplaying", titleStripped) 131 | 132 | def playback_state_changed(self, old_state, new_state): 133 | self.MQTTHook.publish("/state", new_state) 134 | if (new_state == "stopped"): 135 | self.MQTTHook.publish("/nowplaying", "stopped") 136 | self.MQTTHook.publish("/image", self.stoppedImage) 137 | 138 | 139 | def track_playback_started(self, tl_track): 140 | track = tl_track.track 141 | artists="unknown" 142 | if (len(track.artists)>0): 143 | artists = ', '.join(sorted([a.name for a in track.artists])) 144 | if (track.name is None): 145 | tn="stream" 146 | else: 147 | tn=track.name 148 | tn = tn.rstrip('.mp3') 149 | self.MQTTHook.publish("/nowplaying", artists + ":" + tn) 150 | imageUri=self.core.library.get_images([track.uri]).get()[track.uri] 151 | if (imageUri): 152 | self.MQTTHook.publish("/image", imageUri[0].uri) 153 | if self.publishBase64Image: 154 | self.base64_image_publish(imageUri[0].uri) 155 | else: 156 | self.MQTTHook.publish("/image", self.defaultImage) 157 | 158 | def base64_image_publish(self, imageUri): 159 | defaultHeaders = { 160 | 'user-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.93 Safari/537.36'} 161 | response = requests.get(imageUri,headers=defaultHeaders) 162 | img = Image.open(BytesIO(response.content)) 163 | new_image = img.resize((8, 8)) 164 | temp = BytesIO() 165 | new_image.save(temp,format="JPEG") 166 | encoded_image = base64.b64encode(temp.getvalue()) 167 | self.MQTTHook.publish("/imageBase64", encoded_image.decode('ascii')) 168 | 169 | class MQTTHook(): 170 | def __init__(self, frontend, core, config, client): 171 | self.config = config['mqtthook'] 172 | self.mqttclient = client 173 | 174 | def publish(self, topic, state): 175 | full_topic = self.config['topic'] + topic 176 | try: 177 | rc = self.mqttclient.publish(full_topic, state) 178 | if rc[0] == mqtt.MQTT_ERR_NO_CONN: 179 | logger.warn("Error during publish: MQTT_ERR_NO_CONN") 180 | else: 181 | logger.info("Sent " + state + " to " + full_topic) 182 | except Exception as e: 183 | logger.error('Unable to send', exc_info=True) 184 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # future imports 2 | from __future__ import unicode_literals 3 | 4 | # stdlib imports 5 | import re 6 | from setuptools import find_packages 7 | from setuptools import setup 8 | 9 | 10 | def get_version(filename): 11 | content = open(filename).read() 12 | metadata = dict(re.findall("__([a-z]+)__ = '([^']+)'", content)) 13 | return metadata['version'] 14 | 15 | 16 | setup( 17 | name='Mopidy-MQTT', 18 | version=get_version('mopidy_mqtt/__init__.py'), 19 | url='', 20 | license='Apache License, Version 2.0', 21 | author='magcode', 22 | author_email='', 23 | description='Mopidy extension that sends POSTs to Openhab', 24 | long_description=open('README.md').read(), 25 | packages=find_packages(exclude=['tests', 'tests.*']), 26 | zip_safe=False, 27 | include_package_data=True, 28 | install_requires=[ 29 | 'setuptools', 30 | 'Mopidy >= 0.18', 31 | 'Pykka >= 1.1', 32 | 'paho-mqtt' 33 | ], 34 | test_suite='nose.collector', 35 | tests_require=[ 36 | 'nose', 37 | 'mock >= 1.0', 38 | ], 39 | entry_points={ 40 | 'mopidy.ext': [ 41 | 'mqtthook = mopidy_mqtt:Extension', 42 | ], 43 | }, 44 | classifiers=[ 45 | 'Environment :: No Input/Output (Daemon)', 46 | 'Intended Audience :: End Users/Desktop', 47 | 'License :: OSI Approved :: Apache Software License', 48 | 'Operating System :: OS Independent', 49 | 'Programming Language :: Python :: 2', 50 | 'Topic :: Multimedia :: Sound/Audio :: Players', 51 | ], 52 | ) 53 | --------------------------------------------------------------------------------