Add more docs

rhasspy · Sep 20, 2023 · b84a4d8 · b84a4d8
1 parent b956f3d
commit b84a4d8
Show file tree

Hide file tree

Showing 17 changed files with 99 additions and 764 deletions.
diff --git a/assist_microphone/CHANGELOG.md b/assist_microphone/CHANGELOG.md
@@ -0,0 +1,6 @@
+# Changelog
+
+## 1.0.0
+
+- Initial release
+
diff --git a/assist_microphone/DOCS.md b/assist_microphone/DOCS.md
@@ -0,0 +1,14 @@
+# Assist Microphone
+
+Works with the [openWakeWord add-on](https://my.home-assistant.io/redirect/supervisor_addon/?addon=47701997_openwakeword&repository_url=https%3A%2F%2Fgithub.com%2Frhasspy%2Fhassio-addons)
+
+Requires a long-lived access token from Home Assistant.
+To create a token:
+
+1. Go to your profile page in Home Assistant
+2. Scroll down to **Long-lived access tokens**
+3. Click **Create token**
+4. Provide a name for the token and click **OK**
+5. Copy the token using the **copy button** 
+6. Paste the token into this add-on's configuration page
+7. Click **Save**
diff --git a/assist_microphone/Dockerfile b/assist_microphone/Dockerfile
@@ -5,11 +5,9 @@ FROM ${BUILD_FROM}
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 
 WORKDIR /usr/src
+ARG HOMEASSISTANT_SATELLITE_VERSION
 ENV PIP_BREAK_SYSTEM_PACKAGES=1
 
-COPY requirements.txt ./
-COPY hass_satellite/ ./hass_satellite/
-
 RUN \
     apt-get update \
     && apt-get install -y --no-install-recommends \
@@ -25,14 +23,13 @@ RUN \
         setuptools \
         wheel \
     && pip3 install --no-cache-dir \
-        -r requirements.txt \
+        "homeassistant_satellite[silerovad]@https://github.com/synesthesiam/homeassistant-satellite/archive/refs/tags/${HOMEASSISTANT_SATELLITE_VERSION}.tar.gz" \
     \
     && apt-get remove --yes build-essential python3-dev \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
 COPY sounds/ ./sounds/
-COPY models/ ./models/
 
 WORKDIR /
 COPY rootfs /
diff --git a/assist_microphone/README.md b/assist_microphone/README.md
@@ -1,3 +1,5 @@
 # Assist Microphone
 
-Small add-on to stream audio from a local microphone to the Assist websocket API.
+Use [Assist](https://www.home-assistant.io/voice_control/) voice control with a USB microphone.
+
+Works with the [openWakeWord add-on](https://my.home-assistant.io/redirect/supervisor_addon/?addon=47701997_openwakeword&repository_url=https%3A%2F%2Fgithub.com%2Frhasspy%2Fhassio-addons)
diff --git a/assist_microphone/build.yaml b/assist_microphone/build.yaml
@@ -5,3 +5,5 @@ build_from:
 codenotary:
   signer: [email protected]
   base_image: [email protected]
+args:
+  HOMEASSISTANT_SATELLITE_VERSION: v1.0.0
diff --git a/assist_microphone/config.yaml b/assist_microphone/config.yaml
@@ -1,25 +1,28 @@
 ---
-version: 0.3.0
+version: 1.0.0
 slug: assist_microphone
-name: assist_microphone
+name: Assist Microphone
 description: Stream microphone audio to Assist
 url: https://github.com/rhasspy/hassio-addons
 arch:
   - amd64
   - aarch64
+map:
+  - share:rw
 options:
   token: null
   vad: "disabled"
   mic_device: ""
   snd_device: ""
   volume: 1.0
-  awake_sound: true
-  done_sound: true
+  awake_sound: "/usr/src/sounds/awake.wav"
+  done_sound: "/usr/src/sounds/done.wav"
   noise_suppression: 0
   auto_gain: 0
   wake_buffer_seconds: 0.0
   udp_mic: false
   debug_logging: false
+  debug_recording_dir: ""
 schema:
   token: str
   vad: list(disabled|webrtcvad|silero)
@@ -28,11 +31,12 @@ schema:
   volume: float
   noise_suppression: int
   auto_gain: int
-  awake_sound: bool
-  done_sound: bool
+  awake_sound: str
+  done_sound: str
   wake_buffer_seconds: float
   udp_mic: bool
   debug_logging: bool
+  debug_recording_dir: str
 init: false
 audio: true
 homeassistant_api: true

diff --git a/assist_microphone/hass_satellite/__init__.py b/assist_microphone/hass_satellite/__init__.py