Skip to content

Commit

Permalink
fixed internal links
Browse files Browse the repository at this point in the history
  • Loading branch information
builderjer committed Nov 23, 2023
1 parent 1688b01 commit bc1fc1b
Show file tree
Hide file tree
Showing 24 changed files with 126 additions and 81 deletions.
2 changes: 1 addition & 1 deletion docs/000-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ These documents are your starting point for installing and using OpenVoiceOS sof
Please [open Issues](https://github.com/OpenVoiceOS/community-docs/issues) [and Pull Requests](https://github.com/OpenVoiceOS/community-docs/pulls)!

## Just want to get started with OVOS?
Check out our [Quick Start Guide](qs_intro.md) for help with installing an image, your first boot, and basic configuration.
Check out our [Quick Start Guide](030-qs_intro.md) for help with installing an image, your first boot, and basic configuration.

## Getting Involved
If this is your first experience with OpenVoiceOS, or you're not sure where to get started,
Expand Down
14 changes: 7 additions & 7 deletions docs/011-hardware_audio.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ Most USB devices should work without any issues. But, not all devices are creat
- Generic webcam (Works, but is not guaranteed to work with some camera skills)
- PS3 Eye (Same as Generic webcam)
- Kinect V1 (Same as Generic webcam)
- [Andrea Electronics C1-1028100-3](https://mycroft-ai.gitbook.io/docs/using-mycroft-ai/get-mycroft/picroft#tested-hardware)
- [Andrea Electronics C1-1028100-3](https://mycroft-ai.gitbook.io/docs/using-mycroft-ai/get-mycroft/picroft#tested-hardware)

[Audio Troubleshooting - USB](troubleshooting_audio.md#USB)
[Audio Troubleshooting - USB](145-troubleshooting_audio.md#USB)

## HDMI
HDMI audio should work without issues if your device supports it.

[Audio Troubleshooting - HDMI](troubleshooting_audio.md#HDMI)
[Audio Troubleshooting - HDMI](145-troubleshooting_audio.md#HDMI)

## Analog
Analog output to headphones, or external speakers should work also. There may be some configuration needed on some devices.

[Audio Troubleshooting - Analog](troubleshooting_audio.md#analog)
[Audio Troubleshooting - Analog](145-troubleshooting_audio.md#analog)

## Raspberry Pi HATs
There are several HAT's that are available, some with just a microphone, others that play audio out also. Several are supported and tested, others should work with the proper configuration.
Expand All @@ -43,17 +43,17 @@ There are several HAT's that are available, some with just a microphone, others
- 2/4/6/8 mic boards (Works native with Buildroot image. Others needs configuration)
- AIY VoiceHat V1 (Works with `/boot/config.txt` modification)
- AIY VoiceBonnet V2 (Works with custom driver update and `/boot/config.txt` modification)
- [Audio Troubleshooting - HATs](troubleshooting_audio.md#hats)
- [Audio Troubleshooting - HATs](145-troubleshooting_audio.md#hats)

## Specialty Hardware
Some special sound boards are also supported.

- SJ201 sound board (Mark 2 sound board)
- Buildroot Native support
- Supported on other devices with manual install of drivers
- [Audio Troubleshooting - SJ201](troubleshooting_audio.md#sj201)
- [Audio Troubleshooting - SJ201](145-troubleshooting_audio.md#sj201)

- Mark 1 custom sound board
- (Native support - raspbian-ovos mark1 image)
- Other device support with `/boot.config.txt` modification
- [Audio Troubleshooting - Mark 1](troubleshooting_audio.md#mk1)
- [Audio Troubleshooting - Mark 1](145-troubleshooting_audio.md#mk1)
2 changes: 1 addition & 1 deletion docs/012-hardware_video.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ If your device supports video out, you can use a screen on your device. (RPI3/3b

OVOS supports touchscreen interaction, but not all are created equally. It has been noted that on some USB touchscreens, the touch matrix is not synced with the OVOS display and requires an x11 setup with a window manager to adjust the settings to work.

[Troubleshooting Video](troubleshooting_video.md)
[Troubleshooting Video](999-not-implemented)
27 changes: 17 additions & 10 deletions docs/020-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@ Two STT plugins may be loaded at once. If the primary plugin fails, the second

Having a lower accuracy offline model as fallback will account for internet outages, which ensures your device never becomes fully unusable.

Several different STT (Speech To Text) plugins are available for use. OVOS provides a number of public services using the [ovos-stt-plugin-server](https://github.com/OpenVoiceOS/ovos-stt-plugin-server) plugin which are hosted by OVOS trusted members [(Members hosting services)](members.md#Members-hosting-services). No additional configuration is required.
Several different STT (Speech To Text) plugins are available for use. OVOS provides a number of public services using the [ovos-stt-plugin-server](https://github.com/OpenVoiceOS/ovos-stt-plugin-server) plugin which are hosted by OVOS trusted members [(Members hosting services)](325-members.md#Members-hosting-services). No additional configuration is required.

[OVOS Supported STT Plugins](https://github.com/orgs/OpenVoiceOS/repositories?q=ovos-stt-plugin&type=all&language=&sort=)

[Changing STT Plugin](ht_stt.md)
[Changing STT Plugin](102-ht_stt.md)

### Hotwords

Expand All @@ -83,15 +83,15 @@ OVOS uses "Hotwords" to trigger any number of actions. You can load any number
- take ovos-core out of sleep mode, also called a **wakeup_word** or **standup_word**
- take ovos-core out of recording mode, also called a **stop_word**

[Setting and adding Hotwords](ht_ww.md)
[Setting and adding Hotwords](104-ht_ww.md)

#### WakeWord Plugins

A Wake word is what OVOS uses to activate the device. By default `Hey Mycroft` is used by OVOS. Like other things in the OVOS ecosystem, this is configurable.

[Wake word plugins](https://github.com/orgs/OpenVoiceOS/repositories?q=ovos-ww-plugin&type=all&language=&sort=)

[Changing the Wake word](ht-ww.md)
[Changing the Wake word](104-ht-ww.md)


### VAD Plugins
Expand All @@ -101,24 +101,24 @@ Most of the time, this will not need changed. If you are having trouble with yo

[Supported VAD Plugins](https://github.com/orgs/OpenVoiceOS/repositories?q=ovos-vad-plugin&type=all&language=&sort=)

[Changing VAD Plugin](ht_vad.md)
[Changing VAD Plugin](105-ht_vad.md)

## Audio
[ovos-audio](https://github.com/OpenVoiceOS/ovos-audio)

The audio service handles the output of all audio. It is how you hear the voice responses, music, or any other sound from your OVOS device.

[Configuring Audio](audio_conf.md)
[Configuring Audio](999-not-implemented)

### TTS Plugins

TTS (Text To Speech) is the verbal response from OVOS. There are several plugins available that support different engines. Multiple languages and voices are available to use.

OVOS provides a set of public TTS servers hosted by OVOS trusted members [(Members hosting services)](members.md#Members-hosting-services). It uses the [ovos-tts-server-plugin](https://github.com/OpenVoiceOS/ovos-tts-server-plugin), and no additional configuration is needed.
OVOS provides a set of public TTS servers hosted by OVOS trusted members [(Members hosting services)](325-members.md#Members-hosting-services). It uses the [ovos-tts-server-plugin](https://github.com/OpenVoiceOS/ovos-tts-server-plugin), and no additional configuration is needed.

[Supported TTS Plugins](https://github.com/orgs/OpenVoiceOS/repositories?q=ovos-tts-plugin&type=all&language=&sort=)

[Changing TTS Plugin](ht_tts.md)
[Changing TTS Plugin](090-ht_tts.md)

## PHAL
[ovos-PHAL](https://github.com/OpenVoiceOS/ovos-PHAL)
Expand All @@ -129,12 +129,12 @@ Any number of plugins providing functionality can be loaded and validated at run

[Supported PHAL Plugins](https://github.com/orgs/OpenVoiceOS/repositories?q=ovos-phal-plugin&type=all&language=&sort=)

[PHAL Plugins](ht_phal.md)
[PHAL Plugins](110-ht_phal.md)

### Admin PHAL
Similar to regular PHAL, but is used when `sudo` or `privlidged user` is needed
**Be extremely careful when adding `admin-phal plugins`. They give OVOS administrative privileges, or root privileges to your operating system**
[Admin PHAL](ht_phal.md#adimn-phal)
[Admin PHAL](110-ht_phal.md#adimn-phal)

## GUI
OVOS uses the standard mycroft-gui framework, you can find the official documentation [here](https://mycroft-ai.gitbook.io/docs/skill-development/displaying-information/mycroft-gui)
Expand All @@ -154,3 +154,10 @@ OVOS provides a number of helper scripts to allow the user to control the device
- `ovos-speak` This takes your command and runs it through the TTS (Text To Speech) engine and speaks what was provided.
- `ovos-speak "hello world"` will output `"hello world"` in the configured TTS voice
- `ovos-config` is a command line interface that allows you to view and set configuration values.

**Newest (> Nov 2023) raspOVOS images only**

- docs-community View the OVOS Community docs in the terminal
- docs-techincal View the OVOS Technical docs in the terminal
- docs-hivemind View the HiveMind docs in the terminal
- docs-messages View OVOS Message specs in the terminal
36 changes: 34 additions & 2 deletions docs/030-qs_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ OVOS provides a "Headless" image that is similar to the original `picroft` softw

- [headless images](https://ovosimages.ziggyai.online/raspbian/development)

[Instructions on flashing the image can be found here](flashing_images.md).
[Instructions on flashing the image can be found here](#flashing_an_image.md).

#### Buildroot Latest Image

The most advanced and featureful is the Buildroot image. If you want the full GUI, this is currently your only choice. _Please note that this image is older and running on OVOS 0.0.6. A new Buildroot image is in development but not yet available._

- [RPi4-64](https://drive.google.com/file/d/1PUtNXfZ5jMUlVAgyN-KXPdVdX6r51eBw/view?usp=share_link)

[Instructions on flashing the image can be found here](flashing_images.md).
[Instructions on flashing the image can be found here](#flashing_an_image.md).

#### Docker on Raspberry Pi

Expand All @@ -61,3 +61,35 @@ For Debian-based Linux distros, [you can install OVOS manually via a shell scrip
## Need Help?

The OVOS community is always happy to help. If you have any questions, please feel free to ask in the [OVOS Support Matrix room](https://matrix.to/#/#OpenVoiceOS-Support:matrix.org).

## Flashing an image

There are a few ways to flash your image to a drive to use in a Raspberry PI. Both methods described below will work for either OVOS image that you would like to try.

### Raspberry PI Imager

This method can be used with a Linux or Windows host machine.

The people at raspberry pi provide a great little program made for burning an image to a device. You can get it [here](https://www.raspberrypi.com/software/). The team at OVOS has tried to make the setup as simple as possible, and if you follow the steps below, you should have no problems on your first boot.

- Start up the Raspberry Pi Imager. On Linux, start Raspberry Pi Imager with `sudo raspi-imager`.
- For "Choose OS", select "Use custom" and select the OVOS image file downloaded from the step above.
- For "Choose Storage", select your removable boot media, probably something like "Internal SD Card Reader".
- Then select "Write". Do not click the cog. Do not change the username. Username is ovos and is built in. Do not enter WiFi credentials, you will add them at first boot.

### Linux dd command

**Be careful with the dd command, you can easily render your computer useless if the command is entered wrong**

- Find the location of your boot medium with the `lsblk` command.
- It should show up as something like `sdb`. If you are unsure what drive it is, remove it, and run the command again. The one that is missing, is the drive you want to use.
- Write the image to the disk with the `dd` command.

**WARNING: Please make sure you are writing to the correct location, as this is the step that can screw everything up**

- `sudo dd if=<path_to_unzipped_image> of=<path_to_boot_medium> bs=4M status=progress`
- This step will take several minutes to complete.
- When the command is done, and the prompt apears again, finish the process with the command `sudo sync`

With either method used, you should now have a bootable disk to use with your Raspberry PI

6 changes: 3 additions & 3 deletions docs/031-qs_first_boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ When you first boot the Buildroot image, you will be greeted with an OVOS splash

![Splash Screen](https://raw.githubusercontent.com/OpenVoiceOS/ovos_assets/master/Images/Screenshot%20-%20Buildroot%20bootsplash.png)

As this is the first time you have booted your device, it might take a bit longer than normal as the system is preparing its local filesystem and extending it over the full size of the sdcard/USB device.
As this is the first time you have booted your device, it might take a bit longer than normal as the system is preparing its local filesystem and extending it over the full size of the sdcard/USB device.
Eventually the progress bar will be filled up indicating the Operating System has been fully booted, after which the ovos-shell animated loading screen will be shown.

![Loading Spinner](https://raw.githubusercontent.com/OpenVoiceOS/ovos_assets/master/Images/Screenshot%20-%20Spinner.png)
Expand Down Expand Up @@ -98,6 +98,6 @@ Thats it!! You should have a working OVOS device, **QUICK**!!

While this is the fastest and easiest way to get OVOS, it is not the only way.

[Installing OVOS with libraries](start-libraries.md)
[Installing OVOS with modules](051-starting-modules.md)

[Installing OVOS Docker](start-docker.md)
[Installing OVOS Docker](053-starting-docker.md)
14 changes: 7 additions & 7 deletions docs/032-qs_next_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,30 @@ Speak these commands and enjoy the spoils:

While there are several default skills installed, there are many more available to be used. The link below will show you how to find and install more skills.

[Installing Skills](ht_skills.md)
[Installing Skills](080-ht_skills.md)

But wait, there's more!!

OVOS is highly configurable, and uses a file in either `JSON` or `YAML` format to provide these options. While in most cases, OVOS should just work, sometimes you either need to, or want to change some options.

[OVOS Configuration](config.md)
[OVOS Configuration](060-config.md)

OVOS ships with a default TTS (Text to Speech) engine which speaks in the original `Alan-Pope` voice that Mycroft used. There are MANY more to choose from. The following link will help you choose and configure a different voice for your assistant.

[Configuring TTS](ht_tts.md)
[Configuring TTS](090-ht_tts.md)

Your device does not understand your voice when you speak? There are options for different STT (Speech To Text) engines also. Some work better than others, but can provide less privacy.

[Changing STT](ht_stt.md)
[Changing STT](102-ht_stt.md)

Your OVOS assistant uses a "wake word" which lets it know it is time to start listening to your commands. By default, the phrase to wake OVOS is `Hey Mycroft`. This, like most things in OVOS, is totally configurable. Follow the link to learn more.

[Changing the Wake Word](ht_ww.md)
[Changing the Wake Word](104-ht_ww.md)

PHAL plugins allow OVOS to interact with the underlying hardware and operating system. Several are available, and may be installed and run together.

[Configuring PHAL](ht_phal.md)
[Configuring PHAL](110-ht_phal.md)

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](#) **WIP**
[Install your own Services](999-not-implemented) **WIP**
6 changes: 3 additions & 3 deletions docs/040-install_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ The easiest and fastest way to experience what OVOS has to offer is to use one o
- [raspbian-ovos](https://ovosimages.ziggyai.online/raspbian/development)
- The newest image from the OVOS team. This is a "headless" image (NO GUI), but comes with a preinstalled set of skills also. This image will provide you with an experience similar to the origional [picroft](https://github.com/MycroftAI/enclosure-picroft)

[Get started with an image](qs_intro.md)
[Get started with an image](030-qs_intro.md)

### From source as a library

Images are not the only way to use OVOS. It can be installed on almost any system as a set of Python libraries. `ovos-core` is very modular; depending on where you are running `ovos-core` you may want to run only a subset of the services

This is an advanced setup and requires access to a command shell and can take more effort to get working.

[Get started with OVOS libraries](install_ovos_core.md)
[Get started with OVOS modules](042-install_ovos_core.md)

### Docker

Docker images are also available and have been tested and working on Linux, Windows, and even Mac.

[Get started with OVOS Docker](install_ovos_docker.md)
[Get started with OVOS Docker](043-install_ovos_docker.md)
Loading

0 comments on commit bc1fc1b

Please sign in to comment.