mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-13 04:16:48 +00:00
Fix formatting and some sentences
This commit is contained in:
Fabian Affolter
parent
cb8cdf3452
commit
c66bde1843
@ -9,7 +9,7 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
[Snips.ai] is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
|
||||
[Snips.ai](https://snips.ai/) is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
|
||||
|
||||
The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed.
|
||||
|
||||
@ -17,7 +17,7 @@ HomeAssistant comes with certain Intents builtin to handle common tasks. A compl
|
||||
|
||||
The Snips addon by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a shopping list if that component is enabled.
|
||||
|
||||
If using a USB microphone and speakers plugged into the raspberry pi output, Snips will work without any change to the configuration. Trying saying things like:
|
||||
If using a USB microphone and speakers plugged into the Raspberry Pi output, Snips will work without any change to the configuration. Trying saying things like:
|
||||
|
||||
```
|
||||
Turn on kitchen light
|
||||
@ -27,12 +27,11 @@ What is on my shopping list
|
||||
|
||||
To get started creating your own configuration, follow [their tutorial](https://snips.gitbook.io/documentation/console) to create an assistant and download the training data. You can also add the HomeAssistant Skill to your assistant to enable the built-in intents, and add or create your own intents to do more complex tasks.
|
||||
|
||||
Now install and activate the [Samba] add-on so you can upload your training data. Connect to the "share" Samba share and copy your assistant over. Name the file `assistant.zip` or whatever you have configured in the configuration options.
|
||||
Now install and activate the [Samba](/addons/samba/) add-on so you can upload your training data. Connect to the "share" Samba share and copy your assistant over. Name the file `assistant.zip` or whatever you have configured in the configuration options.
|
||||
|
||||
Now it's time to start Snips for the first time. You can configure the microphone and sound card using the addon gui.
|
||||
Now start the add-on.
|
||||
Now it's time to start Snips for the first time. You can configure the microphone and sound card using the Add-on interface. Now start the add-on.
|
||||
|
||||
### Add-On configuration
|
||||
### {% linkable_title Add-On configuration %}
|
||||
|
||||
```json
|
||||
{
|
||||
@ -52,15 +51,15 @@ Now start the add-on.
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **mqtt_bridge** : Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on.
|
||||
- **assistant** : The name of your custom assistant in /share. If no assistant is found a default assistant will be used.
|
||||
- **language** : Language. This is used to select the default custom assistant, Currently en, de, and fr are supported.
|
||||
- **custom_tts** : Whether to use a TTS provider from Home Assistant for a variety of voices
|
||||
- **tts_platform** : Which tts platform to use.
|
||||
- **mqtt_bridge**: Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on.
|
||||
- **assistant**: The name of your custom assistant in `/share`. If no assistant is found then a default assistant will be used.
|
||||
- **language**: Language. This is used to select the default custom assistant, Currently `en`, `de` and `fr` are supported.
|
||||
- **custom_tts**: Whether to use a TTS provider from Home Assistant for a variety of voices.
|
||||
- **tts_platform**: Which TTS platform to use.
|
||||
|
||||
### {% linkable_title Home Assistant configuration %}
|
||||
|
||||
A simple configuration just requires this. Consult [Snips.ai component][comp] for more options
|
||||
A simple configuration just requires this. Consult [Snips.ai component](/components/snips/) for more options.
|
||||
|
||||
```yaml
|
||||
snips:
|
||||
@ -70,11 +69,11 @@ snips:
|
||||
|
||||
There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support.
|
||||
|
||||
### Examples
|
||||
### {% linkable_title Examples %}
|
||||
|
||||
So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the /share folder on your HassIO installation using the Samba addon.
|
||||
So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the `/share` folder on your HassIO installation using the Samba addon.
|
||||
|
||||
Next create a weather sensor, I happen to use (Dark Sky)[/components/sensor.darksky/] and have my api_key in my secrets file.
|
||||
Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksky/] and put the `api_key` in your `secrets.yaml` file.
|
||||
|
||||
```yaml
|
||||
- platform: darksky
|
||||
@ -89,14 +88,13 @@ Next create a weather sensor, I happen to use (Dark Sky)[/components/sensor.dark
|
||||
- temperature_max
|
||||
- temperature_min
|
||||
```
|
||||
Next add this to your configuration.yaml to reference a new intent_script component.
|
||||
This is a good practice to split your config files up.
|
||||
Next add this to your `configuration.yaml` file to reference a new `intent_script` component. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up.
|
||||
|
||||
```yaml
|
||||
intent_script: !include intent_script.yaml
|
||||
```
|
||||
|
||||
Finally, create this intent_script.yaml file in your config directory
|
||||
Finally, create this `intent_script.yaml` file in your configuration directory.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
@ -113,12 +111,7 @@ searchWeatherForecast:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Now just restart HassIO and ask it what the weather is like!
|
||||
Now just restart HassIO and ask it what the weather is like.
|
||||
|
||||
|
||||
|
||||
[Snips.ai]: https://snips.ai/
|
||||
[their tutorial]: https://github.com/snipsco/snips-platform-documentation/wiki/2.-Create-an-assistant-using-an-existing-bundle
|
||||
[Samba]: /addons/samba/
|
||||
[comp]: /components/snips/
|
||||
|
||||
|
||||
@ -97,7 +97,7 @@ followed by a command, e.g.
|
||||
|
||||
> Set the lights to green in the living room
|
||||
|
||||
As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/<intentName>` topic. The Snips Home Assistant component subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml`, as explained below.
|
||||
As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/<intentName>` topic. The Snips Home Assistant component subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below.
|
||||
|
||||
#### {% linkable_title Optional: specifying an external MQTT broker %}
|
||||
|
||||
@ -256,9 +256,7 @@ intent_script:
|
||||
|
||||
##### {% linkable_title Weather %}
|
||||
|
||||
So now you can open and close your garage door, let's check the weather. Add the Weather by Snips Skill to your assistant.
|
||||
|
||||
Create a weather sensor, in this example (Dark Sky)[/components/sensor.darksky/] and the api_key in the secrets file.
|
||||
So now you can open and close your garage door, let's check the weather. Add the Weather by Snips Skill to your assistant. Create a weather sensor, in this example (Dark Sky)[/components/sensor.darksky/] and the `api_key` in the `secrets.yaml` file.
|
||||
|
||||
```yaml
|
||||
- platform: darksky
|
||||
@ -274,7 +272,7 @@ Create a weather sensor, in this example (Dark Sky)[/components/sensor.darksky/]
|
||||
- temperature_min
|
||||
```
|
||||
|
||||
Then create this intent_script.yaml file in your config directory
|
||||
Then create this `intent_script.yaml` file in your configuration directory.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user