Message Types

Messages are used to communicate information between Mycroft services and other components. This list of Message types outlines the details and provides sample code for each.

Each Message type listed contains a description outlining it's meaning or purpose. Where relevant, the Message type will also list the specific JSON data packets expected to be emitted with that Message, and the most common producers and consumers of the Message.

See the MessageBus documentation for further information on this service and examples of using Messages.

General

speak

Request to speak utterance

Data:

{
    "utterance": <words to be spoken>,
    "lang": <language code, e.g. en-us>
}

Usage:

...
def initialize(self):
    self.add_event('speak',
                   self.handler_speak)

def handler_speak(self, message):
    # code to excecute when speak message detected...
...

mycroft.internet.connected

Internet connection is now available (only generated on initial connection)

Usage:

...
def initialize(self):
    self.add_event('mycroft.internet.connected',
                   self.handler_mycroft_internet_connected)

def handler_mycroft_internet_connected(self, message):
    # code to excecute when mycroft.internet.connected message detected...
...

mycroft.ready

Sent by start-up sequence when everything is ready for user interaction

Producer

Consumer

skills/padatious_service.py

Pairing Skill

Usage:

...
def initialize(self):
    self.add_event('mycroft.ready',
                   self.handler_mycroft_ready)

def handler_mycroft_ready(self, message):
    # code to excecute when mycroft.ready message detected...
...

mycroft.stop

Stop command (e.g. button pressed)

Usage:

...
def initialize(self):
    self.add_event('mycroft.stop',
                   self.handler_mycroft_stop)

def handler_mycroft_stop(self, message):
    # code to excecute when mycroft.stop message detected...
...

mycroft.not.paired

Start the pairing process when this event is emitted.

Producer

Consumer

Pairing Skill

Weather Skill

Wolfram Alpha Skill

Pairing Skill

...
def initialize(self):
    self.add_event('mycroft.not.paired',
                   self.handler_mycroft_not_paired)

def handler_mycroft_not_paired(self, message):
    # code to excecute when mycroft.not.paired message detected...
...

mycroft.paired

Pairing has completed

Producer

Consumer

Pairing Skill

skills/skill_manager.py

enclosure/mark1/__init__.py

enclosure/generic/__init__.py

client/speech/__main__.py

...
def initialize(self):
    self.add_event('mycroft.paired',
                   self.handler_mycroft_paired)

def handler_mycroft_paired(self, message):
    # code to excecute when mycroft.paired message detected...
...

mycroft.awoken

Has come out of sleep mode

Usage:

...
def initialize(self):
    self.add_event('mycroft.awoken',
                   self.handler_mycroft_awoken)

def handler_mycroft_awoken(self, message):
    # code to excecute when mycroft.awoken message detected...
...

mycroft.debug.log

log level can be: "CRITICAL" "ERROR" "WARNING" "INFO" "DEBUG" These correspond to the Python logging object.

The "bus" parameter allows turning the logging of all bus messages on/off.

Data:

{
   "level" : <log level>,
   "bus": <True/False>
}

Usage:

...
def initialize(self):
    self.add_event('mycroft.debug.log',
                   self.handler_mycroft_debug_log)

def handler_mycroft_debug_log(self, message):
    # code to excecute when mycroft.debug.log message detected...
...

complete_intent_failure

Intent processing failed

Usage:

...
def initialize(self):
    self.add_event('complete_intent_failure',
                   self.handler_complete_intent_failure)

def handler_complete_intent_failure(self, message):
    # code to excecute when complete_intent_failure message detected...
...

configuration.updated

Notification to services that the configuration has changed and needs reloaded

Usage:

...
def initialize(self):
    self.add_event('configuration.updated',
                   self.handler_configuration_updated)

def handler_configuration_updated(self, message):
    # code to excecute when configuration.updated message detected...
...

Recognizer

recognizer_loop:wakeword

Wakeword was heard

Data:

{
    "utterance": <wakeword heard>,
    "session": <session ID>,
}

Producer

Consumer

client/speech/main.py

Usage:

...
def initialize(self):
    self.add_event('recognizer_loop:wakeword',
                   self.handler_wakeword)

def handler_wakeword(self, message):
    # code to excecute when recognizer_loop:wakeword message detected...
...

recognizer_loop:record_begin

Recording has started

Producer

Consumer

client/speech/main.py

Usage:

...
def initialize(self):
    self.add_event('recognizer_loop:record_begin',
                   self.handler_record_begin)

def handler_record_begin(self, message):
    # code to excecute when recognizer_loop:record_begin message detected...
...

recognizer_loop:record_end

Recording has ended

Producer

Consumer

client/speech/main.py

Usage:

...
def initialize(self):
    self.add_event('recognizer_loop:record_end',
                   self.handler_record_end)

def handler_record_end(self, message):
    # code to excecute when recognizer_loop:record_end message detected...
...

recognizer_loop:utterance

STT has detected the given text or text was injected as an utterance via the CLI.

Data:

{
    "utterances": [text],
    "lang": self.stt.lang,
    "session": session_id
}

Producer

Consumer

client/speech/__main__.py

client/speech/listener.py

client/text/text_client.py

skills/__main__.py

client/text/text_client.py

messagebus/client/client.py

skills/intent_service.py

...
def initialize(self):
    self.add_event('recognizer_loop:utterance',
                   self.handler_utterance)

def handler_utterance(self, message):
    # code to excecute when recognizer_loop:utterance message detected...
...

recognizer_loop:audio_output_start

Text output (TTS) has begun

Producer

Consumer

audio/speech.py

Usage:

...
def initialize(self):
    self.add_event('recognizer_loop:audio_output_start',
                   self.handler_audio_output_start)

def handler_audio_output_start(self, message):
    # code to excecute when recognizer_loop:audio_output_start message detected...
...

recognizer_loop:audio_output_end

Text output (TTS) has ended

Producer

Consumer

audio/speech.py

Usage:

...
def initialize(self):
    self.add_event('recognizer_loop:audio_output_end',
                   self.handler_audio_output_end)

def handler_audio_output_end(self, message):
    # code to excecute when recognizer_loop:audio_output_end message detected...
...

recognizer_loop:sleep

Go into "sleep" mode. Everything except "Hey Mycroft, wake up" will be ignored.

Usage:

...
def initialize(self):
    self.add_event('recognizer_loop:sleep',
                   self.handler_sleep)

def handler_sleep(self, message):
    # code to excecute when recognizer_loop:sleep message detected...
...

recognizer_loop:wake_up

Come out of "sleep" mode.

Usage:

...
def initialize(self):
    self.add_event('recognizer_loop:wake_up',
                   self.handler_wake_up)

def handler_wake_up(self, message):
    # code to excecute when recognizer_loop:wake_up message detected...
...

Enclosure

enclosure.notify.no_internet

Detected a connection error during STT

Producer

Consumer

audio/speech.py

Usage:

...
def initialize(self):
    self.add_event('enclosure.notify.no_internet',
                   self.handler_enclosure_notify_no_internet)

def handler_enclosure_notify_no_internet(self, message):
    # code to excecute when enclosure.notify.no_internet message detected...
...

enclosure.mouth.viseme_list

start: timestamp for audio starts (unix epoch) END_TIME: time in seconds from "start" until the end of the viseme CODE can be 0 = shape for sounds like 'y' or 'aa' 1 = shape for sounds like 'aw' 2 = shape for sounds like 'uh' or 'r' 3 = shape for sounds like 'th' or 'sh' 4 = neutral shape for no sound 5 = shape for sounds like 'f' or 'v' 6 = shape for sounds like 'oy' or 'ao'

Data:

{
  "start": timestamp,
  "visemes": [[CODE,END_TIME],...]
}

Usage:

...
def initialize(self):
    self.add_event('enclosure.mouth.viseme_list',
                   self.handler_enclosure_mouth_viseme_list)

def handler_enclosure_mouth_viseme_list(self, message):
    # code to excecute when enclosure.mouth.viseme_list message detected...
...

mycroft.eyes.default

Change eyes to default color

Producer

Consumer

mycroft-mark-1

Usage:

...
def initialize(self):
    self.add_event('mycroft.eyes.default',
                   self.handler_mycroft_eyes_default)

def handler_mycroft_eyes_default(self, message):
    # code to excecute when mycroft.eyes.default message detected...
...

Microphone Behavior

mycroft.mic.listen

Begin recording for STT processing

Usage:

...
def initialize(self):
    self.add_event('mycroft.mic.listen',
                   self.handler_mycroft_mic_listen)

def handler_mycroft_mic_listen(self, message):
    # code to excecute when mycroft.mic.listen message detected...
...

mycroft.mic.mute

Turn off the mic (no wakeword or STT processing)

Producer

Consumer

Pairing Skill

client/speech/main.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.mic.mute',
                   self.handler_mycroft_mic_mute)

def handler_mycroft_mic_mute(self, message):
    # code to excecute when mycroft.mic.mute message detected...
...

mycroft.mic.unmute

Turn on the mic (enable wakeword and STT processing)

Producer

Consumer

Pairing Skill

client/speech/main.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.mic.unmute',
                   self.handler_mycroft_mic_unmute)

def handler_mycroft_mic_unmute(self, message):
    # code to excecute when mycroft.mic.unmute message detected...
...

Audio Playback

mycroft.audio.service.play

Start playback of tracklist

Producer

Consumer

skills/audioservice.py

playback-control

audio/main.py

...
def initialize(self):
    self.add_event('mycroft.audio.service.play',
                   self.handler_mycroft_audio_service_play)

def handler_mycroft_audio_service_play(self, message):
    # code to excecute when mycroft.audio.service.play message detected...
...

mycroft.audio.service.stop

Stop playback

Producer

Consumer

skills/audioservice.py

playback-control

audio/main.py

...
def initialize(self):
    self.add_event('mycroft.audio.service.stop',
                   self.handler_mycroft_audio_service_stop)

def handler_mycroft_audio_service_stop(self, message):
    # code to excecute when mycroft.audio.service.stop message detected...
...

mycroft.audio.service.pause

Pause playback (if supported)

Producer

Consumer

skills/audioservice.py

playback-control

audio/main.py

...
def initialize(self):
    self.add_event('mycroft.audio.service.pause',
                   self.handler_mycroft_audio_service_pause)

def handler_mycroft_audio_service_pause(self, message):
    # code to excecute when mycroft.audio.service.pause message detected...
...

mycroft.audio.service.resume

Resume playback (if supported by backend)

Producer

Consumer

skills/audioservice.py

playback-control

audio/main.py

...
def initialize(self):
    self.add_event('mycroft.audio.service.resume',
                   self.handler_mycroft_audio_service_resume)

def handler_mycroft_audio_service_resume(self, message):
    # code to excecute when mycroft.audio.service.resume message detected...
...

mycroft.audio.service.next

Skip to next track

Producer

Consumer

skills/audioservice.py

playback-control

audio/main.py

...
def initialize(self):
    self.add_event('mycroft.audio.service.next',
                   self.handler_mycroft_audio_service_next)

def handler_mycroft_audio_service_next(self, message):
    # code to excecute when mycroft.audio.service.next message detected...
...

mycroft.audio.service.prev

Skip to previous track

Producer

Consumer

skills/audioservice.py

playback-control

audio/main.py

...
def initialize(self):
    self.add_event('mycroft.audio.service.prev',
                   self.handler_mycroft_audio_service_prev)

def handler_mycroft_audio_service_prev(self, message):
    # code to excecute when mycroft.audio.service.prev message detected...
...

mycroft.audio.service.track_info

Request track info from audio service

Producer

Consumer

skills/audioservice.py

playback-control

audio/main.py

...
def initialize(self):
    self.add_event('mycroft.audio.service.track_info',
                   self.handler_mycroft_audio_service_track_info)

def handler_mycroft_audio_service_track_info(self, message):
    # code to excecute when mycroft.audio.service.track_info message detected...
...

mycroft.audio.service.track_info_reply

Reply to track info request

Producer

Consumer

audio/main.py

skills/audioservice.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.audio.service.track_info_reply',
                   self.handler_mycroft_audio_service_track_info_reply)

def handler_mycroft_audio_service_track_info_reply(self, message):
    # code to excecute when mycroft.audio.service.track_info_reply message detected...
...

mycroft.audio.service.list_backends

Returns list of available backends.

Producer

Consumer

skills/audioservice.py

audio/main.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.audio.service.list_backends',
                   self.handler_mycroft_audio_service_list_backends)

def handler_mycroft_audio_service_list_backends(self, message):
    # code to excecute when mycroft.audio.service.list_backends message detected...
...

Volume Control

mycroft.volume.increase

Enclosure Volume up

Data:

{"play_sound": True}

Producer

Consumer

client/enclosure/__init__.py

Volume Skill

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.increase',
                   self.handler_mycroft_volume_increase)

def handler_mycroft_volume_increase(self, message):
    # code to excecute when mycroft.volume.increase message detected...
...

mycroft.volume.decrease

Enclosure Volume down

Data:

{"play_sound": True}

Producer

Consumer

client/enclosure/__init__.py

Volume Skill

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.decrease',
                   self.handler_mycroft_volume_decrease)

def handler_mycroft_volume_decrease(self, message):
    # code to excecute when mycroft.volume.decrease message detected...
...

mycroft.volume.mute

Enclosure Volume muted

Data:

{"speak_message": True}

Producer

Consumer

skill-naptime

Volume Skill

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.mute',
                   self.handler_mycroft_volume_mute)

def handler_mycroft_volume_mute(self, message):
    # code to excecute when mycroft.volume.mute message detected...
...

mycroft.volume.unmute

Enclosure Volume unmuted

Data:

{"speak_message": True}

Producer

Consumer

skill-naptime

Volume Skill

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.unmute',
                   self.handler_mycroft_volume_unmute)

def handler_mycroft_volume_unmute(self, message):
    # code to excecute when mycroft.volume.unmute message detected...
...

mycroft.volume.set

Set enclosure volume (0.0 = no output, 1.0 = loudest possible)

Data:

{"percent": float}

Producer

Consumer

Volume Skill

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.set',
                   self.handler_mycroft_volume_set)

def handler_mycroft_volume_set(self, message):
    # code to excecute when mycroft.volume.set message detected...
...

mycroft.volume.get

Request volume level

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.get',
                   self.handler_mycroft_volume_get)

def handler_mycroft_volume_get(self, message):
    # code to excecute when mycroft.volume.get message detected...
...

mycroft.volume.get.response

Data:

{
    "percent": <volume percentage>,
    "muted": <true/false>
}

Producer

Consumer

Enclosure (skill-mark-2)

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.get.response',
                   self.handler_mycroft_volume_get_response)

def handler_mycroft_volume_get_response(self, message):
    # code to excecute when mycroft.volume.get.response message detected...
...

mycroft.volume.duck

Reduce the volume level temporarily

Producer

Consumer

Enclosure (skill-mark-2)

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.duck',
                   self.handler_mycroft_volume_duck)

def handler_mycroft_volume_duck(self, message):
    # code to excecute when mycroft.volume.duck message detected...
...

mycroft.volume.unduck

Restore the volume level

Producer

Consumer

Enclosure (skill-mark-2)

Usage:

...
def initialize(self):
    self.add_event('mycroft.volume.unduck',
                   self.handler_mycroft_volume_unduck)

def handler_mycroft_volume_unduck(self, message):
    # code to excecute when mycroft.volume.unduck message detected...
...

Mycroft Skill Core

mycroft.skill.handler.start

Data:

{handler: class/function name}

Usage:

...
def initialize(self):
    self.add_event('mycroft.skill.handler.start',
                   self.handler_mycroft_skill_handler_start)

def handler_mycroft_skill_handler_start(self, message):
    # code to excecute when mycroft.skill.handler.start message detected...
...

mycroft.skill.handler.complete

Usage:

...
def initialize(self):
    self.add_event('mycroft.skill.handler.complete',
                   self.handler_mycroft_skill_handler_complete)

def handler_mycroft_skill_handler_complete(self, message):
    # code to excecute when mycroft.skill.handler.complete message detected...
...

mycroft.skill.enable_intent

Enable disabled intent

Data:

{"intent_name": "name"}

Producer

Consumer

mycroft/skills/core.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.skill.enable_intent',
                   self.handler_mycroft_skill_enable_intent)

def handler_mycroft_skill_enable_intent(self, message):
    # code to excecute when mycroft.skill.enable_intent message detected...
...

mycroft.skill.disable_intent

Disable intent

Data:

{"intent_name": "name"}

Producer

Consumer

mycroft/skills/core.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.skill.disable_intent',
                   self.handler_mycroft_skill_disable_intent)

def handler_mycroft_skill_disable_intent(self, message):
    # code to excecute when mycroft.skill.disable_intent message detected...
...

mycroft.skills.loaded

A Skill has been loaded

Data:

{
    "id": <skill ID>,
    "name": <skill name>,
    "path": <skill directory>,
    "modified": <modified time>
}

Producer

Consumer

skills/main.py

mycroft/skills/intent_service.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.skills.loaded',
                   self.handler_mycroft_skills_loaded)

def handler_mycroft_skills_loaded(self, message):
    # code to excecute when mycroft.skills.loaded message detected...
...

mycroft.skills.loading_failure

A Skill has failed to load

Data:

{
    "id": <skill ID>,
    "folder": <skill directory>
}

Producer

Consumer

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.skills.loading_failure',
                   self.handler_mycroft_skills_loading_failure)

def handler_mycroft_skills_loading_failure(self, message):
    # code to excecute when mycroft.skills.loading_failure message detected...
...

mycroft.skills.shutdown

A Skill has shutdown

Data:

{
    "id": <skill ID>,
    "folder": <skill directory>
}

Producer

Consumer

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.skills.shutdown',
                   self.handler_mycroft_skills_shutdown)

def handler_mycroft_skills_shutdown(self, message):
    # code to excecute when mycroft.skills.shutdown message detected...
...

mycroft.skills.initialized

Upon startup, all skills have been loaded

Producer

Consumer

mycroft/skills/skill_manager.py

mycroft/skills/padatious_service.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.skills.initialized',
                   self.handler_mycroft_skills_initialized)

def handler_mycroft_skills_initialized(self, message):
    # code to excecute when mycroft.skills.initialized message detected...
...

mycroft.skills.list

List of loaded skills (response to 'skillmanager.list')

Data:

{"skills": [<list of skill IDs>] }

Producer

Consumer

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.skills.list',
                   self.handler_mycroft_skills_list)

def handler_mycroft_skills_list(self, message):
    # code to excecute when mycroft.skills.list message detected...
...

mycroft.skills.settings.update

Pull new skill settings from the server

Producer

Consumer

Configuration Skill

mycroft/skills/settings.py

Usage:

...
def initialize(self):
    self.add_event('mycroft.skills.settings.update',
                   self.handler_mycroft_skills_settings_update)

def handler_mycroft_skills_settings_update(self, message):
    # code to excecute when mycroft.skills.settings.update message detected...
...

Mycroft Skill Manager (MSM)

msm.updating

MSM install has begun

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.updating',
                   self.handler_msm_updating)

def handler_msm_updating(self, message):
    # code to excecute when msm.updating message detected...
...

msm.installing

MSM update has begun

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.installing',
                   self.handler_msm_installing)

def handler_msm_installing(self, message):
    # code to excecute when msm.installing message detected...
...

msm.install.succeeded

MSM install succeeded for given skill

Data:

{ "skill" : <skill name> }

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.install.succeeded',
                   self.handler_msm_install_succeeded)

def handler_msm_install_succeeded(self, message):
    # code to excecute when msm.install.succeeded message detected...
...

msm.install.failed

MSM install failed for given skill

Data:

{
    "skill" : <skill name>,
    "error": <error code>
}

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.install.failed',
                   self.handler_msm_install_failed)

def handler_msm_install_failed(self, message):
    # code to excecute when msm.install.failed message detected...
...

msm.installed

MSM install is complete

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.installed',
                   self.handler_msm_installed)

def handler_msm_installed(self, message):
    # code to excecute when msm.installed message detected...
...

msm.updated

MSM update is complete

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.updated',
                   self.handler_msm_updated)

def handler_msm_updated(self, message):
    # code to excecute when msm.updated message detected...
...

msm.removing

MSM remove has begun

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.removing',
                   self.handler_msm_removing)

def handler_msm_removing(self, message):
    # code to excecute when msm.removing message detected...
...

msm.remove.succeeded

MSM remove succeeded for given skill

Data:

{ "skill" : <skill name> }

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.remove.succeeded',
                   self.handler_msm_remove_succeeded)

def handler_msm_remove_succeeded(self, message):
    # code to excecute when msm.remove.succeeded message detected...
...

msm.remove.failed

MSM remove failed for given skill

Data:

{
    "skill" : <skill name>,
    "error": <error code>
}

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.remove.failed',
                   self.handler_msm_remove_failed)

def handler_msm_remove_failed(self, message):
    # code to excecute when msm.remove.failed message detected...
...

msm.removed

MSM remove is complete

Producer

Consumer

msm.sh

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('msm.removed',
                   self.handler_msm_removed)

def handler_msm_removed(self, message):
    # code to excecute when msm.removed message detected...
...

Skill Manager

skillmanager.deactivate

Deactivate a skill. Activate by typing ":deactivate " in the CLI

Data:

{'skill': <skill directory name>}

Producer

Consumer

CLI (client/text/main.py)

skills/skill_manager.py

Usage:

...
def initialize(self):
    self.add_event('skillmanager.deactivate',
                   self.handler_skillmanager_deactivate)

def handler_skillmanager_deactivate(self, message):
    # code to excecute when skillmanager.deactivate message detected...
...

skillmanager.list

List installed skills. Activate by typing ":list" in the CLI

Producer

Consumer

CLI (client/text/main.py)

skills/skill_manager.py

Usage:

...
def initialize(self):
    self.add_event('skillmanager.list',
                   self.handler_skillmanager_list)

def handler_skillmanager_list(self, message):
    # code to excecute when skillmanager.list message detected...
...

skillmanager.update

Request immediate update of all skills

Producer

Consumer

skills/main.py

Usage:

...
def initialize(self):
    self.add_event('skillmanager.update',
                   self.handler_skillmanager_update)

def handler_skillmanager_update(self, message):
    # code to excecute when skillmanager.update message detected...
...

Messagebus Connection

open

websocket connection has closed

Producer

Consumer

messagebus\client\ws.py

Usage:

...
def initialize(self):
    self.add_event('open',
                   self.handler_open)

def handler_open(self, message):
    # code to excecute when open message detected...
...

close

websocket connection was lost, reconnecting

Producer

Consumer

messagebus\client\ws.py

Usage:

...
def initialize(self):
    self.add_event('close',
                   self.handler_close)

def handler_close(self, message):
    # code to excecute when close message detected...
...

reconnecting

websocket connection has opened

Producer

Consumer

messagebus\client\ws.py

Usage:

...
def initialize(self):
    self.add_event('reconnecting',
                   self.handler_reconnecting)

def handler_reconnecting(self, message):
    # code to excecute when reconnecting message detected...
...

System Administrative Actions

system.wifi.setup

Kick off a a wifi-setup session

Producer

Consumer

mycroft-wifi-setup: mycroft_admin_service.py

Usage:

...
def initialize(self):
    self.add_event('system.wifi.setup',
                   self.handler_system_wifi_setup)

def handler_system_wifi_setup(self, message):
    # code to excecute when system.wifi.setup message detected...
...

system.wifi.reset

Clear the saved wifi settings

Producer

Consumer

mycroft-wifi-setup: mycroft_admin_service.py

Usage:

...
def initialize(self):
    self.add_event('system.wifi.reset',
                   self.handler_system_wifi_reset)

def handler_system_wifi_reset(self, message):
    # code to excecute when system.wifi.reset message detected...
...

system.ntp.sync

Force the system clock to synchronize with NTP servers

Producer

Consumer

mycroft-wifi-setup: mycroft_admin_service.py

Usage:

...
def initialize(self):
    self.add_event('system.ntp.sync',
                   self.handler_system_ntp_sync)

def handler_system_ntp_sync(self, message):
    # code to excecute when system.ntp.sync message detected...
...

system.ssh.enable

Configure system to allow SSH connections

Producer

Consumer

mycroft-wifi-setup: mycroft_admin_service.py

Usage:

...
def initialize(self):
    self.add_event('system.ssh.enable',
                   self.handler_system_ssh_enable)

def handler_system_ssh_enable(self, message):
    # code to excecute when system.ssh.enable message detected...
...

system.ssh.disable

Configure system to block SSH connections

Producer

Consumer

mycroft-wifi-setup: mycroft_admin_service.py

Usage:

...
def initialize(self):
    self.add_event('system.ssh.disable',
                   self.handler_system_ssh_disable)

def handler_system_ssh_disable(self, message):
    # code to excecute when system.ssh.disable message detected...
...

system.reboot

Force a Linux reboot

Producer

Consumer

mycroft-wifi-setup: mycroft_admin_service.py

Usage:

...
def initialize(self):
    self.add_event('system.reboot',
                   self.handler_system_reboot)

def handler_system_reboot(self, message):
    # code to excecute when system.reboot message detected...
...

system.shutdown

Force a Linux shutdown

Producer

Consumer

mycroft-wifi-setup: mycroft_admin_service.py

Usage:

...
def initialize(self):
    self.add_event('system.shutdown',
                   self.handler_system_shutdown)

def handler_system_shutdown(self, message):
    # code to excecute when system.shutdown message detected...
...

system.update

Force an apt-get update on 'mycroft-mark-1' or 'mycroft-picroft' package (as appropriate)

Producer

Consumer

mycroft-wifi-setup: mycroft_admin_service.py

Usage:

...
def initialize(self):
    self.add_event('system.update',
                   self.handler_system_update)

def handler_system_update(self, message):
    # code to excecute when system.update message detected...
...

Common Play System

play:query

Data:

{ "phrase": <something to be played> }

Usage:

...
def initialize(self):
    self.add_event('play:query',
                   self.handler_query)

def handler_query(self, message):
    # code to excecute when play:query message detected...
...

play:query.response

There are three responses to a play:query. These are not intended to be consumed directly by a Skill, see the methods available in the CommonPlaySkill Class.

Confirm Search

The initial response confirms that a search is being attempted. It also extends the Skill timeout while it looks for a match.

Data:

{
  "phrase": search_phrase,
  "skill_id": self.skill_id,
  "searching": True
}

Search Result

Emitted if a result is found. Responses from the Play services must be received within 1 second to be included.

Data:

{
    "phrase": phrase,
    "skill_id":  self.skill_id,
    "callback_data": data,
    "service_name": self.spoken_name,
    "conf": confidence
}

  • phrase - the phrase that was queried for this response

  • id - uniquely identifies the skill, normally the Skill's self.skill_id

  • callback_data - optional data structure to return in play:start

  • service_name - the name of the service returning the highest confidence in a speakable format

  • conf - the confidence it can handle the request, between 0.0 and 1.0

Confidence guidelines:

  • 1.0 = exact command match, e.g. "play npr news"

  • >0.9 = multi-key match for database entry, e.g. "play madonna's lucky star" or "play artist madona" (matches "artist" and "madonna"). For each additional key over 2, add 0.1 to the confidence, so "play madonna's lucky star on spotify" would be 0.91 for three keywords

  • >0.8 = single-key match for database title entry, e.g. "play lucky star"

  • >0.7 = single-key match for database artist or group, e.g. "play madonna"

  • >0.6 = single-key match for database genre or category, e.g. "play reggae"

  • >0.5 = generic match, e.g. "play some music" or "play a movie"

Search Failed

No suitable result was found.

Data:

{
  "phrase": search_phrase,
  "skill_id": self.skill_id,
  "searching": False
}

play:start

  • skill_id -- the unique ID of the skill that is being invoked

  • phrase -- the original phrase user said, e.g. "some thing" from utterance "play some thing"

  • callback_data -- (optional) data the skill can use to start playback

Data:

{
    "skill_id": <skill_id>,
     "phrase": phrase,
     "callback_data": optional_data
}

Common Query System

question:query

Data:

{"phrase": "complete question"}

Usage:

...
def initialize(self):
    self.add_event('question:query',
                   self.handler_query)

def handler_query(self, message):
    # code to excecute when question:query message detected...
...

question:query.response

  • skill_id -- the unique ID of the skill that is being invoked

  • phrase -- the original phrase user said, e.g. "some thing" from utterance "how tall was abraham lincoln"

  • conf -- confidence level of answers validity

  • callback_data -- (optional) data the skill can use for any additional actions (such as image url or similar)

  • searching -- true if more time is needed to complete the search, otherwise false

Data:

{
    "phrase": phrase,
    "skill_id": <skill_id>,
    "answer": "answer string",
    "conf": confidence,
    "callback_data": <json data>,
    "searching": true/false
}

Usage:

...
def initialize(self):
    self.add_event('question:query.response',
                   self.handler_query_response)

def handler_query_response(self, message):
    # code to excecute when question:query.response message detected...
...

question:action

  • skill_id -- the unique ID of the skill that is being invoked

  • phrase -- the original phrase user said, e.g. "some thing" from utterance "how tall was abraham lincoln"

  • callback_data -- (optional) data the skill can use to take additional actions

Usage:

...
def initialize(self):
    self.add_event('question:action',
                   self.handler_action)

def handler_action(self, message):
    # code to excecute when question:action message detected...
...

Mycroft Alarm Skill

private.mycroftai.has_alarm

Count of running alarms (0 == no alarms)

Data:

{"active_alarms": COUNT }

Usage:

...
def initialize(self):
    self.add_event('private.mycroftai.has_alarm',
                   self.handler_private_mycroftai_has_alarm)

def handler_private_mycroftai_has_alarm(self, message):
    # code to excecute when private.mycroftai.has_alarm message detected...
...

PROPOSED

skill.namespace.*

e.g. "skill.mycroft.noftify.alarm_changed" or "skill.jaguar.notify.car_stopped"

Usage:

...
def initialize(self):
    self.add_event('skill.namespace.*',
                   self.handler_skill_namespace_*)

def handler_skill_namespace_*(self, message):
    # code to excecute when skill.namespace.* message detected...
...

private.github_username.*

for private (not intended to be used by anyone else)

Usage:

...
def initialize(self):
    self.add_event('private.github_username.*',
                   self.handler_private_github_username_*)

def handler_private_github_username_*(self, message):
    # code to excecute when private.github_username.* message detected...
...
PreviousMessageBusNextServices

Last updated