Installation Instructions - thlucas1/homeassistantcomponent_soundtouchplus GitHub Wiki

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

If you do not want to use HACS, you can also install the integration manually by copying files from the GitHub project.

Both installation types are covered below.

HACS Installation Instructions

It's recommended that you utilize the local HA instance URL (e.g. http://homeassistant.local:8123) when installing via HACS, as some public URL access providers (Cloudfare, etc) block access to the GitHub repository site by default unless properly configured. It is also recommended that you use a desktop browser (not a mobile / tablet device) for the install process.

Use the following link to open (and add) the custom repository in HACS:

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

If the above does not work for you, then use the following steps to add the custom repository manually.

  • go to HACS main menu.
  • click on the 3-dot overflow menu in the upper right, and select custom repositories item.
  • copy / paste https://github.com/thlucas1/homeassistantcomponent_soundtouchplus in the Repository textbox and select Integration for the category entry.
  • click on Add to add the custom repository.
  • you can then click on the SoundTouchPlus repository entry (you may need to filter your list first to find the new entry).

Note at this point you have only added the repository to the HACS Repository List. Now it's time to actually download the contents of the repository itself. You should now be displaying the repository details, which will also display a Download button (lower right corner) that can be used to download the repository contents.

  • click on download to start the download. It will install the soundtouchplus integration to your config/custom_components directory.
  • restart HA to start using the component.

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 custom_components directory (folder) there, you need to create it.
  • In the custom_components directory (folder) create a new folder called soundtouchplus.
  • Download all of the files from the custom_components/soundtouchplus/ directory (folder) in this repository.
  • Place the files you downloaded in the new directory (folder) you created.
  • Restart Home Assistant.
  • In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Bose SoundTouchPlus"

Configuration

All configuration of the integration is done in the UI; check out the Device Configuration Options wiki page for more details.