Skip to content

Commit

Permalink
feat(docs): ovos-bus-client scripts (#87)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikejgray authored Mar 16, 2024
1 parent dd73e40 commit 290c409
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/032-qs_next_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,34 @@ PHAL plugins allow OVOS to interact with the underlying hardware and operating s
OVOS ships with default services available to the public to use. These include public TTS and STT servers, a weather API provided by [OpenMeteo](https://openmeteo.com/), access to Wolfram, and more. Since OVOS is an open and private system, you can also change these to your own preferences.

[Install your own Services](999-not-implemented) **WIP**

## Interacting by command line

While OVOS is primarily a voice-driven platform, sometimes it makes sense to interact by CLI for troubleshooting, testing, or development. OVOS ships several tools with [ovos-bus-client](https://github.com/OpenVoiceOS/ovos-bus-client) in most distros.

### ovos-listen

Typing the command `ovos-listen` will make the listener service start listening for voice commands. If you haven't set up a wakeword or you're having issues with your wakeword, this can be a good way to check if the entire listener is not working.

### ovos-speak

The `ovos-speak` command will tell the assistant to speak whatever you type after it. This command can be useful for demonstrations or to play pranks on nearby family members or roommates. For example:

```bash
$ ovos-speak "Look ma, no data shared with big companies!"
```

Note the quotes - you must include the quotes, otherwise the assistant would only say "look."

### ovos-say-to

The `ovos-say-to` command will send an utterance to the assistant, to be processed normally by the assistant. It effectively skips the speech-to-text portion of the interaction. This command is useful in situations where you can't or don't want to speak to the assistant - for example, when roommates or family members are sleeping, or you're already typing to test new skill code.

Example:

```bash
$ ovos-say-to "What time is it?"
```

Again, note the quotes. Without quotes only the first word will be sent to the assistant, which will typically result in an error.

0 comments on commit 290c409

Please sign in to comment.