Mycroft AI
  • Documentation
  • About Mycroft AI
    • Why use Mycroft AI?
    • Glossary of terms
    • Contributing
    • FAQ
  • Using Mycroft AI
    • Get Mycroft
      • Mark II
        • Mark II Dev Kit
      • Mark 1
      • Picroft
      • Linux
      • Mac OS and Windows with VirtualBox
      • Docker
      • Android
    • Pairing Your Device
    • Basic Commands
    • Installing New Skills
    • Customizations
      • Configuration Manager
      • mycroft.conf
      • Languages
        • Français (French)
        • Deutsch (German)
      • Using a Custom Wake Word
      • Speech-To-Text
      • Text-To-Speech
    • Troubleshooting
      • General Troubleshooting
      • Audio Troubleshooting
      • Wake Word Troubleshooting
      • Log Files
      • Support Skill
      • Getting more support
  • Skill Development
    • Voice User Interface Design Guidelines
      • What can a Skill do?
      • Design Process
      • Voice Assistant Personas
      • Interactions
        • Intents
        • Statements and Prompts
        • Confirmations
      • Conversations
      • Error Handling
      • Example Interaction Script
      • Prototyping
      • Design to Development
    • Development Setup
      • Python Resources
      • Your First Skill
    • Skill Structure
      • Lifecycle Methods
      • Logging
      • Skill Settings
      • Dependencies
        • Manifest.yml
        • Requirements files
      • Filesystem access
      • Skill API
    • Integration Tests
      • Test Steps
      • Scenario Outlines
      • Test Runner
      • Reviewing the Report
      • Adding Custom Steps
      • Old Test System
    • User interaction
      • Intents
        • Padatious Intents
        • Adapt Intents
      • Statements
      • Prompts
      • Parsing Utterances
      • Confirmations
      • Conversational Context
      • Converse
    • Displaying information
      • GUI Framework
      • Show Simple Content
      • Mycroft-GUI on a PC
      • Mark 1 Display
    • Advanced Skill Types
      • Fallback Skill
      • Common Play Framework
      • Common Query Framework
      • Common IoT Framework
    • Mycroft Skills Manager
      • Troubleshooting
    • Marketplace Submission
      • Skills Acceptance Process
        • Information Review Template
        • Code Review Template
        • Functional Review Template
        • Combined Template
      • Skill README.md
    • FAQ
  • Mycroft Technologies
    • Technology Overview
    • Roadmap
    • Mycroft Core
      • MessageBus
      • Message Types
      • Services
        • Enclosure
        • Voice Service
        • Audio Service
        • Skills Service
      • Plugins
        • Audioservice Plugins
        • STT Plugins
        • TTS Plugins
        • Wake Word Plugins
      • Testing
      • Legacy Repo
    • Adapt
      • Adapt Examples
      • Adapt Tutorial
    • Lingua Franca
    • Mimic TTS
      • Mimic 3
      • Mimic 2
      • Mimic 1
      • Mimic Recording Studio
    • Mycroft GUI
      • Remote STT and TTS
    • Mycroft Skills Kit
    • Mycroft Skills Manager
    • Padatious
    • Precise
    • Platforms
Powered by GitBook
On this page
  • Text
  • Static Image
  • Animated Image
  • HTML Page
  • Remote URL

Was this helpful?

  1. Skill Development
  2. Displaying information

Show Simple Content

The Mycroft GUI Framework has a number of common methods for displaying standard simple content types.

Text

Display simple strings of text.

self.gui.show_text(self, text, title=None, override_idle=None, override_animations=False)

Arguments:

  • text (str): Main text content. It will auto-paginate

  • title (str): A title to display above the text content.

  • override_idle (boolean, int):

    • True: Takes over the resting page indefinitely

    • (int): Delays resting page for the specified number of seconds.

  • override_animations (boolean):

    • True: Disables showing all platform skill animations.

    • False: 'Default' always show animations.

Static Image

Display a static image such as a jpeg or png.

self.gui.show_image(self, url, caption=None, title=None, fill=None, override_idle=None, override_animations=False)

Arguments:

  • url (str): Pointer to the image

  • caption (str): A caption to show under the image

  • title (str): A title to display above the image content

  • fill (str): Fill type - supports:

    • 'PreserveAspectFit',

    • 'PreserveAspectCrop',

    • 'Stretch'

  • override_idle (boolean, int):

    • True: Takes over the resting page indefinitely

    • (int): Delays resting page for the specified number of seconds.

  • override_animations (boolean):

    • True: Disables showing all platform skill animations.

    • False: 'Default' always show animations.

Animated Image

Display an animated image such as a gif.

self.gui.show_animated_image(self, url, caption=None, title=None, fill=None, override_idle=None, override_animations=False)

Arguments:

  • url (str): Pointer to the .gif image

  • caption (str): A caption to show under the image

  • title (str): A title to display above the image content

  • fill (str): Fill type - supports:

    • 'PreserveAspectFit',

    • 'PreserveAspectCrop',

    • 'Stretch'

  • override_idle (boolean, int):

    • True: Takes over the resting page indefinitely

    • (int): Delays resting page for the specified number of seconds.

  • override_animations (boolean):

    • True: Disables showing all platform skill animations.

    • False: 'Default' always show animations.

HTML Page

Display a local HTML page.

self.gui.show_html(self, html, resource_url=None, override_idle=None, override_animations=False)

Arguments:

  • html (str): HTML text to display

  • resource_url (str): Pointer to HTML resources

  • override_idle (boolean, int):

    • True: Takes over the resting page indefinitely

    • (int): Delays resting page for the specified number of seconds.

  • override_animations (boolean):

    • True: Disables showing all platform skill animations.

    • False: 'Default' always show animations.

Remote URL

Display a webpage.

self.gui.show_url(self, url, override_idle=None, override_animations=False)

Arguments:

  • url (str): URL to render

  • override_idle (boolean, int):

    • True: Takes over the resting page indefinitely

    • (int): Delays resting page for the specified number of seconds.

  • override_animations (boolean):

    • True: Disables showing all platform skill animations.

    • False: 'Default' always show animations.

PreviousGUI FrameworkNextMycroft-GUI on a PC

Last updated 4 years ago

Was this helpful?