diff --git a/ada/CHANGELOG.md b/ada/CHANGELOG.md index 7f56ddb..6e0ad54 100644 --- a/ada/CHANGELOG.md +++ b/ada/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## 0.9 + +- Corrected link to documentation inside the add-on +- Adjust source links in Dockerfile +- Update add-on documentation to match current state + ## 0.8 - Fix API url for access to Home Assistant diff --git a/ada/Dockerfile b/ada/Dockerfile index 50a8558..12d9d4f 100644 --- a/ada/Dockerfile +++ b/ada/Dockerfile @@ -1,11 +1,12 @@ ARG BUILD_FROM FROM ${BUILD_FROM} -# Install Dude +# Install Ada WORKDIR /usr/src/ada ARG ADA_VERSION -RUN apt-get update && apt-get install -y --no-install-recommends \ +RUN apt-get update \ + && apt-get install -y --no-install-recommends \ portaudio19-dev \ libsndfile1 \ mplayer \ @@ -16,12 +17,13 @@ RUN apt-get update && apt-get install -y --no-install-recommends \ git \ build-essential \ \ - && git clone --depth 1 -b ${ADA_VERSION} https://github.com/home-assistant/dude . \ + && git clone --depth 1 -b ${ADA_VERSION} \ + "https://github.com/home-assistant/ada" . \ && rm -rf .git \ && pip3 install --no-cache-dir -U setuptools wheel \ && pip3 install --no-cache-dir -r requirements.txt \ && pip3 install --no-cache-dir -e . \ - && python3 -m compileall dude \ + && python3 -m compileall ada \ \ && apt-get purge -y --auto-remove \ git \ diff --git a/ada/README.md b/ada/README.md index 37c6777..26c446d 100644 --- a/ada/README.md +++ b/ada/README.md @@ -8,7 +8,7 @@ Home Assistant featured voice assist. ## Installation -The installation of this add-on is straightforward and easy to do. +Follow these steps to get the add-on installed on your system: 1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**. 2. Find the "Hey Ada!" add-on and click it. @@ -18,7 +18,9 @@ The installation of this add-on is straightforward and easy to do. The basic thing to get the add-on running would be: -1. Start the add-on. +1. Select input and output audio device to use in the "Audio" configuration + section of the add-on configuration. +2. Start the add-on. ## Configuration @@ -26,9 +28,27 @@ Example add-on configuration: ```json { + "stt": "cloud", + "tts": "cloud" } ``` +### Option: `stt` (required) + +The Home Assistant STT (Speech-to-Text) integration to use when converting +detected audio to text for Almond to process. + +Please note, this STT integration has to be configured and active in +Home Assistant before using it with this add-on! + +### Option: `tts` (required) + +The Home Assistant TTS (Text-to-Speech) integration to use when converting +the response from Almond back to audio. + +Please note, this TTS integration has to be configured and active in +Home Assistant before using it with this add-on! + ## Support Got questions? diff --git a/ada/azure-pipelines.yml b/ada/azure-pipelines.yml index 076e962..129e8d0 100644 --- a/ada/azure-pipelines.yml +++ b/ada/azure-pipelines.yml @@ -3,20 +3,19 @@ trigger: branches: include: - - master + - master paths: include: - - ada/* + - ada/* pr: none variables: - name: versionBuilder - value: '2.0' + value: "2.0" - group: docker - jobs: -- template: /.azure/azp-template-addon.yml - parameters: - addon: 'ada' - arch: '--amd64 --armv7 --armhf' + - template: /.azure/azp-template-addon.yml + parameters: + addon: "ada" + arch: "--amd64 --armv7 --armhf" diff --git a/ada/build.json b/ada/build.json index f2f02d5..a96a9c3 100644 --- a/ada/build.json +++ b/ada/build.json @@ -1,8 +1,8 @@ { "build_from": { "amd64": "homeassistant/amd64-base-debian:buster", - "armv7": "homeassistant/armv7-base-debian:buster", - "armhf": "homeassistant/armhf-base-debian:buster" + "armhf": "homeassistant/armhf-base-debian:buster", + "armv7": "homeassistant/armv7-base-debian:buster" }, "args": { "ADA_VERSION": "0.7" diff --git a/ada/config.json b/ada/config.json index 897a9e5..15ee986 100644 --- a/ada/config.json +++ b/ada/config.json @@ -1,9 +1,9 @@ { "name": "Hey Ada!", - "version": "0.8", + "version": "0.9", "slug": "ada", "description": "Home Assistant featured voice assist", - "url": "https://home-assistant.io/addons/ada/", + "url": "https://github.com/home-assistant/hassio-addons/blob/master/ada", "arch": ["armhf", "armv7", "amd64"], "startup": "application", "boot": "auto",