# snowboy-seasalt

**Repository Path**: devopssec/snowboy-seasalt

## Basic Information

- **Project Name**: snowboy-seasalt
- **Description**: Web interface for creating snowboy personal wake words locally

雪童个人唤醒词记录器
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-15
- **Last Updated**: 2024-12-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Snowboy Personal Wake Word Recorder

Docker-based web interface for generating `.pmdl` files from audio examples for [snowboy](https://github.com/Kitt-AI/snowboy).

Credit to [seasalt-ai](https://github.com/seasalt-ai/snowboy)

## Docker Image

To get started, run the pre-built Docker image:

```sh
$ docker run -it -p 8000:8000 rhasspy/snowboy-seasalt
```

The web interface will now be available at http://localhost:8000

If you'd like to build the Docker image yourself, see `scripts/build-docker.sh`

## Web Interface

Examples can be recorded and submitted directly in a web browser. Once you've enabled your microphone (required by Chrome), each example can be recorded by:

1. Clicking the "Record" button and waiting until it's ready
2. Speaking the wake word and then quietly waiting until it's done

The timeouts here are used to avoid needing to trim out button clicks from the audio.

Once you have 3 examples, click "Submit" and you should see a "Save Model" button appear. Save the `.pmdl` file somewhere and enjoy your new wake word!

![Screen shot of web interface](screenshot.png)

Audio visualization is provided by [wavesurfer-js](https://wavesurfer-js.org/)

## HTTP API

You can also `POST` your audio examples to the web server directly and get a `.pmdl` file back!

The `/generate` endpoint expects form data with:

* A `modelName` field with your wake word name
* At least 3 files with audio samples
    * These will be converted to the appropriate format with `ffmpeg`
    * Unless `?noTrim=true` is given, silence is automatically trimmed from the beginning and end of each example

```sh
$ curl \
    -X POST \
    -F modelName=okay-rhasspy \
    -F example1=@example1.wav \
    -F example2=@example2.wav \
    -F example3=@example3.wav \
    --output okay-rhasspy.pmdl \
    localhost:8000/generate
```