summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTursiae <git@tursiae.org>2025-02-06 17:00:32 +1100
committerTursiae <git@tursiae.org>2025-02-06 17:00:32 +1100
commitffc62ee5e0b5d7f81c07aeb430a1b2566466f717 (patch)
tree922482b9d40a06263d76ba9c592e11aa8df7368a /src
parent2d8fdbf67f5623ec47a578f31059323ab8bb7d8f (diff)
downloadtangara-fw-ffc62ee5e0b5d7f81c07aeb430a1b2566466f717.tar.gz
Update the docs to eliminate the mention of the Spoken Interface setting until re-added.
Diffstat (limited to 'src')
-rw-r--r--src/tangara/tts/README.md24
1 files changed, 13 insertions, 11 deletions
diff --git a/src/tangara/tts/README.md b/src/tangara/tts/README.md
index 27c6801b..63d587da 100644
--- a/src/tangara/tts/README.md
+++ b/src/tangara/tts/README.md
@@ -15,10 +15,12 @@ The code is structured in three pieces:
## End-user Configuration
-Text-to-speech can be enabled under the Display settings on Tangara, by
-enabling the _"Spoken Interface"_ setting. Please note that this will not be
-a user-visible change unless TTS phrases are loaded onto the SD card under
-`/.tangara-tts/`.
+Text-to-speech will automatically be enabled if you have loaded TTS phrases
+onto the SD card, under `/.tangara-tts/`. These samples must be formatted
+and named as per the instructions below.
+
+To disable TTS, rename or delete the `/.tangara-tts/` directory on your SD
+card.
## Supported Codecs
@@ -35,13 +37,13 @@ files, with a `.wav` extension, named as the hexadecimal version of the
For example, `Settings` hashes to `1e3e816187453bf8`. If you recorded a
short sample as a 48kHz (mono or stereo) WAV file, and stored it on the SD
-card as `/.tangara-tts/1e3e816187453bf8.wav`, it would be played back when the
-settings icon is highlighted.
+card as `/.tangara-tts/1e3e816187453bf8.wav`, it would be played back when
+the settings icon is highlighted.
## Finding the KOMIHASH of UI strings
-If you connect to your Tangara via the serial console, the `provider` module
-logs a `WARN`ing each time it cannot find a TTS sample. You can enable these
-log messages on the console by using the command `loglevel warn`, and then
-manipulating the click wheel to move through the UI to discover other missing
-TTS samples.
+If you connect to your Tangara via the serial console, the TTS provider
+logs a `WARN`ing each time it cannot find a TTS sample. You can enable
+these log messages on the console by using the command `loglevel warn`,
+and then manipulating the click wheel to move through the UI to discover
+other missing TTS samples.