This is a SCRIPT Blueprint. This provides a way to play canned media files with the big long list of YAML entries but keep the main script or automation clean.
Changelog
- 2023-12-07: Stop log spamming leak. #32
- (Documentation change 2-7-2024 to add License notice. Changes only to Descriptions.)
- 2023-08-07: Updates for Home Assistant 2023.8
- Selector syntax change
- Condition Selector addition (where applicable)
- MQTT Discovery name changes (where applicable)
- Clean-up code formatting
- 2023-07-17: Add ability to feed message and media_player & file type change to script on the fly.
- 2023-03-01: Add Author Tag. Bump HA required Version to 2023-3-0
- 2022-12-12: Add Update Method Note, minor code change.
- Name of Blueprint may have changed meaning you have to re-download with a new link.
- If name changed, it is similar. Variables have not changed.
- 2022-04-11: Add multiple to Speaker Selection and changed minimum HA to 2022.4.0
- 2021-12-28: First blueprint version
About this blueprint
Type of blueprint: SCRIPT
What if I am having problems getting it going?
You can contact me for help, see the links below.
Why do I need this?
I decided I wanted to clean up a bunch of my automations by removing the several lines of YAML every time I wanted to play an mp3 file.
In addition to that, playing specific sound files and other things becomes a simple call to a script file, so really a function. The actual meat and potatoes of the function is exactly the same for all the sounders and if a change needs to be made, it only has to be made in 1 place in a multiple re-use scenario.
License Notice:
-
Copies of the original Blueprint that were converted via the ‘Take Control’ feature or other means are officially not supported by me.
-
I may or may not be able to support you when you have a problem after you make changes to my code, as some of the code is no longer mine.
-
I & my license also require attribution as a link back to the original should you use this code in your own creation.
-
Here is a link to my license & the original github post expected to be followed & referenced as attribution should you use this code elsewhere.
Configuration
Requirements
- 1 or more functioning media_players
- Media file(s) that are accessible to Home Assistant such that they can be played / displayed thru media_player.
- The speakers you want to broadcast to must be working and integrated with the integration that makes them work. This BP does not set-up speakers for you, it only sends files to the speakers. See Links below to help guide you thru speaker set-up.
Field variables to feed variables from calling automation
otf_speaker_target: On-The-Fly Device(s) to send the file to
Change the default media player on the fly
required: false
otf_file_2_play: On-The-Fly Media File to play
This will change the default sound file on-the-fly
required: false
otf_media_type: On-The-Fly Media_Content_type
This will change the default Media_Content_type on-the-fly
required: false
Input fields
speaker_target:/ name: Device(s) to send the file to
Add the media_player that you want to play this on.
Multiples are allowed.
file_2_play:/ name: Media File to play
The media file name needs to be put here.
Please include the path that is accessible to the media player.
A sample path may be 'media-source://media_source/local/sample_file.mp3'.
See more information here:
(https://www.home-assistant.io/more-info/local-media/add-media/)
(https://www.home-assistant.io/more-info/local-media/setup-media/)
(https://www.home-assistant.io/integrations/media_source/)
media_type:/ name: Media_Content_type
This is where you match how the content is encoded with
how the player will play it. Trial and error here can be your friend
unless you are much better at figuring this stuff out than me.
I generally only use 'audio/mp3' and occasionally 'image/jpg'.
More detailed information available here:
(https://www.home-assistant.io/integrations/cast/)
(https://developers.google.com/cast/docs/media/)
Extended Information
For further information, reference these links below.
(https://www.home-assistant.io/more-info/local-media/add-media/) (https://www.home-assistant.io/more-info/local-media/setup-media/) (https://www.home-assistant.io/integrations/media_source/) (https://www.home-assistant.io/integrations/cast/) [](https://my.home-assistant.io/redirect/media_browser/) (https://developers.google.com/cast/docs/media/)
Installation example
Once you have the entities created or decided upon you can build the Script.
To build the script:
- Click on ‘Create Script’
and ‘Use Blueprint’
- Add a Description so you can tell what this one is for
- Use the Drop-downs to select the Entities for the listed purposes
- The media_player field will pull from a pick list but you can extend that with multiple media_players or groups as needed by typing them in. Use the links above to help get your system able to play media files.
- The media type is where you match how the content is encoded with how the player will play it. Trial and error here can be your friend unless you are much better at figuring this stuff out than me. I generally only use ‘audio/mp3’ and occasionally ‘image/jpg’. More detailed information available in the Google Developers link above.
Example Usage
This is a case I use this in my setup. Instead of pasting all the media set-up code in an already busy automation, I set that stuff up with this blueprint and just call the script when I want to to play. The added bonus is I can call on this script again where appropriate and the sounder is just a script call away.
See YAML code in this Sample YAML file / package file
Sending TTS messages based on the Calling Automation
As of Version 2023-07-17, thanks to the script Blueprint from Grumblezz I have found a way to feed data into a Script Blueprint. This uses the Key ‘fields:’.
Aside from that, what you need to know is you can use this to generate a ‘live’ TTS response by feeding data into it from an automation that calls this script with data.
To do this, your first step is setting up the Blueprint input fields so that it all works properly with your system. Next you add the input parameters that that you need in order to have the test message coming out of the speaker of your choice. Then save and close the Blueprint Editor. Then you will be able to ‘call’ this script with a data statement that includes the field variables in this section. If you need help formatting the YAML for this you can get some help in the HA Docs here. You can also contact me for help, see the links below.
If you create an automation that calls the script that you created with this BluePrint, you will be able to manually add text or change the speaker. Advanced users will be able to create variables in the automation that can be passed directly to the script to send the TTS message exactly as required.
- service: script.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaatts_say_testing
data:
otf_speaker_target: media_player.jen_group
otf_file_2_play: "media-source://media_source/local/mp3/Door-chime-sound.mp3"
otf_media_type: "audio/mp3"
Troubleshooting tip
If you are troubleshooting and you want to see more traces back when doing so, here is a TIP I’ve found.
Manually edit the automation created with the ui editor (or manually with a text editor) and add the following to have this automation contain 10 traces instead of the normal 5. Then if the automation is triggering often, you can see the last 10 traces to help you decide what the issue is.
HA Docs on this here.
trace:
stored_traces: 10
Version Updates
Updates will be published on my GIT repository with the rest of my Home Assistant Blueprint collection.
There is not an official version control system for Blueprints. However I have found something that comes pretty close. It is not perfect, but for MOST Blueprints, it does just fine. I encourage you to check this script out and use it to easily check if I have updated this blueprint. 
koter84 Blueprint Update Script
Please Click the 
at the end of this top Post if you find this Useful
Software to Download 
HA link to download blueprint: 
Direct link to download Blueprint: https://github.com/SirGoodenough/HA_Blueprints/blob/master/Scripts/play_media_file_script.yaml
All My Blueprints
https://github.com/SirGoodenough/HA_Blueprints/blob/master/README.md
Contact Links or see my other work
What are we Fixing Today Homepage / Website: https://www.WhatAreWeFixing.Today/
Channel Link URL: (WhatAreWeFixingToday) https://bit.ly/WhatAreWeFixingTodaysYT
Discord Guild: (Sir_Goodenough#9683) WhatAreWeFixingToday?
If you want to support me
Buy me Coffee: https://www.buymeacoffee.com/SirGoodenough
PayPal one-off donation link: PayPal.Me
#WhatAreWeFixingToday
#SirGoodEnough