Update Mycroft documentation (#6171)

This commit is contained in:
Fabian Affolter 2018-09-02 22:58:27 +02:00 committed by GitHub
parent 6867750560
commit 990885e5b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 8 deletions

View File

@ -14,18 +14,21 @@ ha_release: 0.53
[Mycroft](https://mycroft.ai) is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant.
## {% linkable_title Configuration %}
To use Mycroft in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
mycroft:
host: 0.0.0.0
```
`host` is your IP address of your mycroft instance. Once you have added your host to your `configuration.yaml` file, restart your Home Assistant server. This will load up the Mycroft component and make a service available to notify on Mycroft and more eventually.
{% configuration %}
host:
description: The IP address of your Mycroft instance.
required: true
type: string
{% endconfiguration %}
The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/).
To use this notification platform you simply need to input into the configuration that mycroft is your notification platform like seen above.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

View File

@ -12,4 +12,9 @@ ha_category: Notifications
ha_release: "0.53"
---
Please see the main [Mycroft Component](/components/mycroft)
The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/).
Please check the [`mycroft` component](/components/mycroft/) for details.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).