From 6d37cceb9153068b37f69ed27a271a2bc549f70d Mon Sep 17 00:00:00 2001 From: Alex X Date: Fri, 25 Apr 2025 14:52:11 +0300 Subject: [PATCH] Improve readme for wyoming module --- internal/wyoming/README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/internal/wyoming/README.md b/internal/wyoming/README.md index 45273df8..f98acb05 100644 --- a/internal/wyoming/README.md +++ b/internal/wyoming/README.md @@ -79,6 +79,20 @@ wyoming: internal-detection: WriteEvent("run-pipeline", '{"start_stage":"asr","end_stage":"tts"}') && Stream() ``` +Supported functions and variables: + +- `Detect()` - start the VAD and WAKE word detection process +- `Stream()` - start transmission of audio data to the client (Home Assistant) +- `Stop()` - stop and disconnect stream without disconnecting client (Home Assistant) +- `Pause()` - temporary pause of audio transfer, without disconnecting the stream +- `PlayAudio()` - playing the last audio that was sent from client (Home Assistant) +- `WriteEvent(type, data)` - send event to client (Home Assistant) +- `Sleep(duration)` - temporary script pause (ex. `Sleep('1.5s')`) +- `PlayFile(path)` - play audio from `wav` file +- `Type` - type (name) of event +- `Data` - event data in JSON format (ex. `{"text":"how are you"}`) +- also available other functions from [expr](https://github.com/AlexxIT/go2rtc/blob/master/internal/expr/README.md) module (ex. `fetch`) + If you write a script for an event - the default action is no longer executed. You need to repeat the necessary steps yourself. In addition to the standard events, there are two additional events: @@ -160,7 +174,7 @@ wyoming: vad_threshold: 1 ``` -Satellite on Dahua camera with two-way audio support. +Satellite on external wyoming Microphone and Sound. ```yaml streams: