Skip to content

Commit 6d37cce

Browse files
committed
Improve readme for wyoming module
1 parent fce41f4 commit 6d37cce

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

internal/wyoming/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,20 @@ wyoming:
7979
internal-detection: WriteEvent("run-pipeline", '{"start_stage":"asr","end_stage":"tts"}') && Stream()
8080
```
8181

82+
Supported functions and variables:
83+
84+
- `Detect()` - start the VAD and WAKE word detection process
85+
- `Stream()` - start transmission of audio data to the client (Home Assistant)
86+
- `Stop()` - stop and disconnect stream without disconnecting client (Home Assistant)
87+
- `Pause()` - temporary pause of audio transfer, without disconnecting the stream
88+
- `PlayAudio()` - playing the last audio that was sent from client (Home Assistant)
89+
- `WriteEvent(type, data)` - send event to client (Home Assistant)
90+
- `Sleep(duration)` - temporary script pause (ex. `Sleep('1.5s')`)
91+
- `PlayFile(path)` - play audio from `wav` file
92+
- `Type` - type (name) of event
93+
- `Data` - event data in JSON format (ex. `{"text":"how are you"}`)
94+
- also available other functions from [expr](https://github.com/AlexxIT/go2rtc/blob/master/internal/expr/README.md) module (ex. `fetch`)
95+
8296
If you write a script for an event - the default action is no longer executed. You need to repeat the necessary steps yourself.
8397

8498
In addition to the standard events, there are two additional events:
@@ -160,7 +174,7 @@ wyoming:
160174
vad_threshold: 1
161175
```
162176

163-
Satellite on Dahua camera with two-way audio support.
177+
Satellite on external wyoming Microphone and Sound.
164178

165179
```yaml
166180
streams:

0 commit comments

Comments
 (0)