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: