https://github.com/bushvin/hass-integrations
My custom Home Assistant integrations
https://github.com/bushvin/hass-integrations
hacs hacs-integration home-assistant mopidy
Last synced: 12 months ago
JSON representation
My custom Home Assistant integrations
- Host: GitHub
- URL: https://github.com/bushvin/hass-integrations
- Owner: bushvin
- License: apache-2.0
- Created: 2021-01-08T16:15:05.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-06T17:52:52.000Z (over 1 year ago)
- Last Synced: 2025-07-14T05:13:30.575Z (12 months ago)
- Topics: hacs, hacs-integration, home-assistant, mopidy
- Language: Python
- Homepage:
- Size: 252 KB
- Stars: 66
- Watchers: 5
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Home Assitant integrations
Additional integrations for [Home Assistant](https://www.home-assistant.io/)
![badge_mastodon]
## Mopidy
![badge_version] ![badge_issues] ![badge_hacs_pipeline]
This is a platform integration for [Mopidy Music Servers](https://mopidy.com/)
### Installation
Please look at the [Mopidy installation & configuration instructions](https://docs.mopidy.com/en/latest/installation/) to set up a Mopidy Server.
#### HACS
1. Install [HACS](https://hacs.xyz)
1. Go to any of the sections (integrations, frontend, automation).
1. Click on the 3 dots in the top right corner.
1. Select "Custom repositories"
1. Add the URL to the repository.
1. Select the correct category.
1. Click the "ADD" button.
1. Go to Home Assistant settings -> Integrations and add Mopidy
1. Restart HA
#### Manual
1. Clone this repository
2. Copy `custom_components/mopidy` to your Home Assistant instance on `/custom_components/`
### Setup
#### zeroconf
Your Mopidy Servers can be detected and added to Home Assistant through zeroconf.
#### GUI
1. Go to the *Integrations* page and click **+ ADD INTEGRATION**
1. Select *Mopidy* in the list of integrations
1. Fill out the requested information. Make sure to enter your correct FQDN or IP address. Using `localhost`, `127.0.0.1`, `::1` or any other loopback address will disable Mopidy-Local artwork.
1. Click Submit.
Repeat the above steps to add more Mopidy Server instances.
#### Manual Configuration
1. add a media player to your home assistant configuration (`/configuration.yaml`):
```yaml
media_player:
- name:
host:
port:
platform: mopidy
```
2. Restart your Home assistant to make changes take effect.
### Configuration
```yaml
- name: # The name of your Mopidy server.
host: # The FQDN or IP address of your Mopidy Server, do not use ::1, localhost or 127.0.0.1
port: # The port number of the Mopidy Server, default: 6680
platform: mopidy # specify mopidy platform
```
### Services
#### Service mopidy.get_search_result
*This service was originally developed by [Daniele Ricci](https://github.com/daniele-athome)*
Search media based on keywords and return them for use in a script or automation.
**Note:** One of the keyword fields **must** be used: `keyword`, `keyword_album`, `keyword_artist`, `keyword_genre` or `keyword_track_name`
|Service data attribute|Optional|Description|Example|
|-|-|-|-|
|`entity_id`|no|String or list of `entity_id`s to search and return the result to.| |
|`exact`|yes|String. Should the search be an exact match|false|
|`keyword`|yes|String. The keywords to search for. Will search all track fields.|Everlong|
|`keyword_album`|yes|String. The keywords to search for in album titles.|From Mars to Sirius|
|`keyword_artist`|yes|String. The keywords to search for in artists.|Queens of the Stoneage|
|`keyword_genre`|yes|String. The keywords to search for in genres.|rock|
|`keyword_track_name`|yes|String. The keywords to search for in track names.|Lazarus|
|`source`|yes|String. URI sources to search. `local`, `spotify` and `tunein` are the only supported options. Make sure to have these extensions enabled on your Mopidy Server! Separate multiple sources with a comma (,).|local,spotify|
##### Example
The service is to be used as a normal service returning some data into a variable. The result is actually a dictionary
with keys corresponding to the media player entities used as targets in the service call. Every item has in turn a
`result` attribute containing the list of actual media IDs matching the search parameters.
```yaml
script:
search_and_play_music:
fields:
[...]
sequence:
- action: mopidy.get_search_result
data:
keyword_artist: "Some music artist"
keyword_track_name: "Some song title"
source: local
target:
entity_id: "media_player.music"
response_variable: music_tracks # result will be returned into this variable
- if: "{{ music_tracks['media_player.music'].result|length > 0 }}"
then:
- action: media_player.play_media
data:
media_content_id: "{{ music_tracks['media_player.music'].result[0] }}"
media_content_type: music
target:
entity_id: "media_player.music"
```
#### Service media_player.play_media
The `media_content_id` needs to be formatted according to the Mopidy URI scheme. These can be easily found using the *Developer tools*.
When using the `play_media` service, the Mopidy Media Player platform will attempt to discover your URL when not properly formatted.
Currently supported for:
- Youtube
#### Service mopidy.restore
Restore a previously taken snapshot of one or more Mopidy Servers
The playing queue is snapshotted
|Service data attribute|Optional|Description|
|-|-|-|
|`entity_id`|no|String or list of `entity_id`s that should have their snapshot restored.|
#### Service mopidy.search
Search media based on keywords and add them to the queue. This service does not replace the queue, nor does it start playing the queue. This can be achieved through the use of [media\_player.clear\_playlist](https://www.home-assistant.io/integrations/media_player/) and [media\_player.media\_play](https://www.home-assistant.io/integrations/media_player/)
**Note:** One of the keyword fields **must** be used: `keyword`, `keyword_album`, `keyword_artist`, `keyword_genre` or `keyword_track_name`
|Service data attribute|Optional|Description|Example|
|-|-|-|-|
|`entity_id`|no|String or list of `entity_id`s to search and return the result to.| |
|`exact`|yes|String. Should the search be an exact match|false|
|`keyword`|yes|String. The keywords to search for. Will search all track fields.|Everlong|
|`keyword_album`|yes|String. The keywords to search for in album titles.|From Mars to Sirius|
|`keyword_artist`|yes|String. The keywords to search for in artists.|Queens of the Stoneage|
|`keyword_genre`|yes|String. The keywords to search for in genres.|rock|
|`keyword_track_name`|yes|String. The keywords to search for in track names.|Lazarus|
|`source`|yes|String. URI sources to search. `local`, `spotify` and `tunein` are the only supported options. Make sure to have these extensions enabled on your Mopidy Server! Separate multiple sources with a comma (,).|local,spotify|
#### Service mopidy.set_consume_mode
Set the mopidy consume mode for the specified entity
|Service data attribute|Optional|Description|
|-|-|-|
|`entity_id`|no|String or list of `entity_id`s to set the consume mode of.|
|`consume_mode`|no|`True` to enable consume mode, `False` to disable |
#### Service mopidy.snapshot
Take a snapshot of what is currently playing on one or more Mopidy Servers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards.
**Warning:** *This service is controlled by the platform, this is not a built-in function of Mopidy Server! Restarting Home Assistant will cause the snapshot to be lost.*
|Service data attribute|Optional|Description|
|-|-|-|
|`entity_id`|no|String or list of `entity_id`s ito take a snapshot of.|
### Notes
Due to the nature of the way Mopidy provides thumbnails of the media,
proxying them through Home Assistant is very resource intensive,
causing delays. Therefore, I have decided to not proxy the art when
using the Media Library for the time being.
## Testers
- [Jan Gutowski](https://github.com/Switch123456789)
[badge_version]: https://img.shields.io/github/v/tag/bushvin/hass-integrations?label=Version&style=flat-square&color=2577a1
[badge_issues]: https://img.shields.io/github/issues/bushvin/hass-integrations?style=flat-square
[badge_mastodon]: https://img.shields.io/mastodon/follow/1084764?domain=https%3A%2F%2Fmastodon.social&logo=mastodon&logoColor=white&style=flat-square&label=%40bushvin%40mastodon.social
[badge_hacs_pipeline]: https://img.shields.io/github/actions/workflow/status/bushvin/hass-integrations/validate.yml?label=HACS%20build%20validation&style=flat-square