AAC Online Speak & Translate Plug-in for Windows ("AAC Speak Helper")

For Full Documentation see here https://docs.acecentre.org.uk/products/v/aac-speak-helper-tool/

Introduction

AAC Speak Helper is designed to enhance your ability to communicate. It leverages the copy-paste clipboard to offer translation services in various languages. It uses multiple providers' Text-to-Speech (TTS) technology to read aloud the translated text. You can easily configure all these functionalities through our Configure app and maintain numerous settings files for different tasks.

Use Case

Imagine you are a Ukrainian speaker with limited English skills residing in a care facility. AAC Speak Helper bridges you and your caregivers, translating Ukrainian text into English. Moreover, it supports people who need to speak languages less commonly supported by TTS technology.

Compatibility

AAC Speak Helper is a Windows executable. It can be called from any AAC app on Windows that can run external programs. To make it work you currently need to run the server and client separately - but also edit your pagesets and a speak button.

How it Works

AAC Speak Helper reads the text once the text is copied to the clipboard (using Ctrl+C). Depending on the configuration settings, it either translates the text using the selected service, speaks it aloud, or reads it. There are additional features, such as putting intonation (or style) onto some voices. We have a graphical application that can configure the app. The main application, though, has no interface.

Developer details

see this mermaid graph

Overview of project

See build details here.

To build the encryption key

Fill your .env (or github env vars) with the correct keys for google/azure

eg.

MICROSOFT_TOKEN="token-here"
MICROSOFT_REGION="uksouth"
GOOGLE_CREDS_JSON="jq -c '@json' ttsandtranslate-7dd2e2d80d42.json - contents here"
MICROSOFT_TOKEN_TRANS="token-for-trans"
CONFIG_ENCRYPTION_KEY="key"

To get config encryption key run the following command

from cryptography.fernet import Fernet
print(Fernet.generate_key().decode())

Once this is all filled up run the following command to encrypt the config file

poetry run python prepare_config_enc.py

It will now have a config.enc file created. Our code will use that. If keys are in settings.cfg that overrides these keys

Prerequisites

Install Python 3.11 (or higher) for Windows from the official Python website.
Install Poetry if you don't have it already. You can install Poetry by running:
```
curl -sSL https://install.python-poetry.org | python3 -
```
Alternatively, on Windows, you can use:
```
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
```
Ensure that Poetry is available in your PATH. You can verify this by running:
```
poetry --version
```

Setting Up the Development Environment

Clone the Repository if you haven't already:

git clone https://github.com/AceCentre/AACSpeakHelper.git
cd AACSpeakHelper

Create a Virtual Environment and Install Dependencies:

Poetry automatically handles virtual environments, so you don't need to manually create one. Simply run:
```
poetry install
```
This command will:
- Create a virtual environment in the .venv directory within your project.
- Install all dependencies listed in pyproject.toml and lock them in poetry.lock.
Activate the Virtual Environment (if needed):

While Poetry typically handles this automatically, you can activate the virtual environment manually if required:
```
poetry shell
```

Running the Application

Run the Server:

With the virtual environment active, you can run the application directly:
```
poetry run python AACSpeakHelperServer.py
```
This ensures that the Python interpreter and dependencies used are from the Poetry-managed environment.

to call the client now you do (in a different terminal/console)
```
poetry run python client.py
```
And GUI
```
poetry run python GUI_TranslateAndTTS/widget.py
```

Additional Tips

Adding Dependencies: To add new dependencies, use:
```
poetry add <package_name>
```
Updating Dependencies: To update all dependencies to their latest versions (within the constraints defined):
```
poetry update
```
Exiting the Virtual Environment: To exit the Poetry shell (virtual environment), simply type:
```
exit
```

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Ace Centre for funding and supporting this project.
Will Wade (TTS-Wrapper is heavily dependent on this project. Will converted the MMS models to sherpa-onnx which is used in this project)
Gavin Henderson and all of the Ace Centre team for their support and feedback.

AceCentre / AACSpeakHelper

readme