Mycroft

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

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

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

Configuration

To use Mycroft in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for KS Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for KS Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart KS Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry
mycroft:
  host: 0.0.0.0

Configuration Variables

host string Required

The IP address of your Mycroft instance.

Using notifications

To use Mycroft for sending notifications, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for KS Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:

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

Configuration Variables

name string Required

Frendly name of your Mycroft instance.

Examples

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

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