Skip to content

Commit

Permalink
Add HACS support
Browse files Browse the repository at this point in the history
  • Loading branch information
jjlawren committed Jul 28, 2021
1 parent c332108 commit 04a8750
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Sonos Cloud integration for Home Assistant

[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/custom-components/hacs)

The `sonos_cloud` integration uses the cloud-based [Sonos Control API](https://developer.sonos.com/reference/control-api/) to send [audioClip](https://developer.sonos.com/reference/control-api/audioclip/) commands to speakers. This allows playback of short clips (e.g., alert sounds, TTS messages) on Sonos speakers without interrupting playback. Audio played in this manner will reduce the volume of currently playing music, play the clip on top of the music, and then automatically return the music to its original volume. This is an alternative approach to the current method which requires taking snapshots & restoring speakers with complex scripts and automations.

This API requires audio files to be in `.mp3` or `.wav` format and to have publicly accessible URLs.
Expand Down
5 changes: 3 additions & 2 deletions custom_components/sonos_cloud/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"domain": "sonos_cloud",
"name": "Sonos Cloud",
"config_flow": true,
"documentation": "https://github.com/jjlawren/sonos_cloud/blob/main/README.md",
"documentation": "https://github.com/jjlawren/sonos_cloud/",
"issue_tracker": "https://github.com/jjlawren/sonos_cloud/issues",
"requirements": [],
"ssdp": [],
"zeroconf": [],
Expand All @@ -13,6 +14,6 @@
"codeowners": [
"@jjlawren"
],
"iot_class": "cloud_push",
"iot_class": "cloud_polling",
"version": "0.0.1"
}
8 changes: 8 additions & 0 deletions hacs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "Sonos Cloud",
"country": "US",
"domains": ["media_player"],
"homeassistant": "2021.7.0",
"render_readme": true,
"iot_class": "Cloud Polling"
}

0 comments on commit 04a8750

Please sign in to comment.