home-assistant.io/source/_integrations/mycroft.markdown

title, description, ha_category, ha_iot_class, ha_release, ha_domain, ha_platforms, ha_integration_type, related

title	description	ha_category	ha_iot_class	ha_release	ha_domain	ha_platforms	ha_integration_type	related
Mycroft	Instructions on how to setup Mycroft AI within Home Assistant.	Notifications Voice	Local Push	0.53	mycroft	notify	integration	docs title /docs/configuration/ Configuration file

Mycroft is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant.

There is currently support for the following device types within Home Assistant:

• Notifications - Allows to deliver notifications from Home Assistant to Mycroft AI.

Configuration

To use Mycroft in your installation, add the following to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# Example configuration.yaml entry
mycroft:
  host: 0.0.0.0

{% configuration %} host: description: The IP address of your Mycroft instance. required: true type: string {% endconfiguration %}

Using notifications

To use Mycroft for sending notifications, add the following to your {% term "configuration.yaml" %} file:

# Example configuration.yaml entry
notify:
  - platform: mycroft
    name: mycroft

{% configuration %} name: description: Frendly name of your Mycroft instance. required: true type: string {% endconfiguration %}

Examples

Send a message to Mycroft by calling notify.mycroft action:

message: "Hey Mycroft. Turn on the office light. "