Skip to content

Commit

Permalink
[plugins] Update the list for phal, stt and tts
Browse files Browse the repository at this point in the history
  • Loading branch information
goldyfruit committed Jan 31, 2024
1 parent cee01fd commit e1d3e04
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/getting-started/docker/plugins/phal.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The [Plugin based Hardware Abstraction Layer](../../../about/glossary/components
The `ovos_phal` container comes with few pre-installed PHAL plugins such as:

- `ovos-PHAL-plugin-alsa` controls system volume with [ALSA](https://en.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture)
- `ovos-PHAL-plugin-ipgeo` provides geolocation information via the message bus
- `ovos-PHAL-plugin-system` handles bus events to interact with the operating system

If the existing PHAL plugins are not enough then you can install yours by following the same principle as for the [STT plugins](./stt.md) by adding a `phal.list` or `phal_admin.list` files within the `~/ovos/config/` directory, this file acts as a Python `requirements.txt` file.
Expand Down
1 change: 1 addition & 0 deletions docs/getting-started/docker/plugins/stt.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The [Speech-To-Text](../../../about/glossary/terms.md#speech-to-text-stt) plugin

The `ovos_listener` container comes with few pre-installed STT plugins such as:

- `ovos-stt-plugin-chromium` uses the Google Chrome browser API
- `ovos-stt-plugin-server` allows you to reach an external STT service
- `ovos-stt-plugin-vosk` is an offline STT service

Expand Down
6 changes: 2 additions & 4 deletions docs/getting-started/docker/plugins/tts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ The [Text-To-Speech](../../../about/glossary/terms.md#text-to-speech-tts) plugin

The `ovos_audio` container comes with few pre-installed TTS plugins such as:

- `ovos-tts-plugin-mimic` is the original Mycroft AI TTS with the iconic Alan Pope's voice
- `ovos-tts-plugin-mimic2` is the cloud based version hosted on Mycroft AI infrastructure
- `ovos-tts-plugin-mimic3-server` is the latest Mycroft AI TTS engine
- `ovos-tts-plugin-polly` is the Amazon Polly TTS server _(authentication required)_
- `ovos-tts-plugin-server` allows you to reach an external TTS service

If the existing TTS plugins are not enough then you can install yours by following the same principle as for the [skills](../installation/skills.md) by adding an `audio.list` file within the `~/ovos/config/` directory, this file acts as a Python `requirements.txt` file.
Expand All @@ -24,7 +22,7 @@ When the `ovos_audio` container starts, it will look for this file and install t
```ini title="~/ovos/config/audio.list"
ovos-tts-plugin-marytts==0.0.1a1 # Specific plugin version on PyPi
neon-tts-plugin-mozilla-remote # Latest plugin version on PyPi
git+https://github.com/NeonGeckoCom/neon-tts-plugin-polly.git@fix/whatever # Specific branch of a plugin on GitHub
git+https://github.com/OpenVoiceOS/ovos-tts-plugin-piper.git@fix/whatever # Specific branch of a plugin on GitHub
```

The `ovos_audio` container must be restarted if a change occurs in the `audio.list` file.
Expand Down

0 comments on commit e1d3e04

Please sign in to comment.