GilOliveira / FasterWhisper

Faster Whisper for Home Assistant - custom integration with a local Speech-to-Text engine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Faster Whisper for Home Assistant

Faster Whisper is a local Speech-to-Text engine. With Home Assistant, it allows you to create your own personal local voice assistant.

This is same code base as Home Assistant Wisper Add-on, developed by @synesthesiam from Nabu Casa.

But packaged as Home Assistant custom integration. This can be useful when your environment does not allow you to install add-ons. For example, when your Home Assistant is running in venv, Docker or Windows.

Warnings

Using such heavy software inside Home Assistant can cause performance and stability problems. Use with caution!

Large language models require a lot of RAM. Use with caution!

The models are downloaded to the Home Assistant config folder. They can greatly increase the size of your backups or sync with GitHub. Use with caution!

You have to delete unnecessary models yourself from the Home Assistant config folder.

Installation

HACS > Integrations > 3 dots (upper top corner) > Custom repositories > URL: AlexxIT/FasterWhisper, Category: Integration > Add > wait > Faster Whisper > Install

Or manually copy faster_whisper folder from latest release to /config/custom_components folder.

Configuration

Settings > Integrations > Add Integration > Faster Whisper

You can setup multiple integrations with different models, languages, and other settings. If you need to change settings, just delete the integration and set it up again.

Remember that each integration setup will consume a significant amount of RAM.

Usage

You can use Speech-to-Text (STT) only inside Assist pipeline.

Settings > Voice assistants > Home Assistant > Select STT engine.

You can create several pipelines with different settings for different situations.

You can use StreamAssist custom component to convert almost any camera and almost any speaker into a local voice assistant.

You can try Home Assistant with local voice assistant on any PC with Windows using HassWP and this integration.

About

Faster Whisper for Home Assistant - custom integration with a local Speech-to-Text engine

License:MIT License


Languages

Language:Python 100.0%