Skip to content

Installation Instructions

Jump to bottom
Todd Lucas edited this page Feb 12, 2025 · 3 revisions

Requirements

The following requirements must be met prior to installing the SoundTouchPlus Card.

Limitations

The following limitations are imposed if you choose to install the SoundTouchPlus Card.

  • Some SoundTouch device models support more features than others. Please check the SoundTouch Model Notes reference for more information on limitations for your SoundTouch model.

How To Install

The easiest way to install the card is via the Home Assistant Community Store (or HACS for short). Check out the HACS Install Documentation page for more information on how to install HACS in your Home Assistant environment.

Don't have HACS, or do not want to use HACS? No problem! You can also install the card manually by copying files from the GitHub project.

Both installation types are covered below.

HACS Installation (recommended)

  • On your Home Assistant sidebar menu, go to HACS > Frontend
  • Click on the 3-dot overflow menu in the upper right, and select custom repositories item.
  • Copy / paste https://github.com/thlucas1/homeassistantcomponent_soundtouchplus_card in the Repository textbox and select Dashboard for the category entry.
  • Click on Add to add the custom repository.
  • You can then click on the SoundTouchPlus Card repository entry (you may need to filter your list first to find the new entry).
  • Click on download to start the download. It will install the card to your /config/www/community/homeassistantcomponent_soundtouchplus_card directory.
  • Go back on your dashboard and click on the icon at the right top corner then on Edit dashboard.
  • You can now click on Add card in the bottom right corner and search for "Custom: SoundTouchPlus Card".

Manual Installation

  • Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  • If you do not have a www directory (folder) structure there, you need to create it.
  • From your browser of choice, open the Github Repository Releases page and download the soundtouchplus-card.js file from the latest card release to the www folder.
  • From the HA web UI, browse to the Resources definition page.
  • click on the "Add Resouce" button to add a new resource (or modify the existing resource entry if you already installed manually). Enter the following for the resource definition:
    • URL parameter = /local/soundtouchplus-card.js?v1.0.12 (change version number to match what was downloaded)
    • Resource Type = Javascript Module
    • click "Create" to create the resource.
  • Refresh your browser to reload any cached resources.
  • Go to the dashboard of your choice and add the card via HA Card Picker.
Clone this wiki locally