350 lines
14 KiB
Python
350 lines
14 KiB
Python
# Copyright 2019 Mycroft AI Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
""" Interface for interacting with the Mycroft gui qml viewer. """
|
|
from os.path import join
|
|
|
|
from mycroft.configuration import Configuration
|
|
from mycroft.messagebus.message import Message
|
|
from mycroft.util import resolve_resource_file
|
|
|
|
|
|
class SkillGUI:
|
|
"""SkillGUI - Interface to the Graphical User Interface
|
|
|
|
Values set in this class are synced to the GUI, accessible within QML
|
|
via the built-in sessionData mechanism. For example, in Python you can
|
|
write in a skill:
|
|
self.gui['temp'] = 33
|
|
self.gui.show_page('Weather.qml')
|
|
Then in the Weather.qml you'd access the temp via code such as:
|
|
text: sessionData.time
|
|
"""
|
|
|
|
def __init__(self, skill):
|
|
self.__session_data = {} # synced to GUI for use by this skill's pages
|
|
self.page = None # the active GUI page (e.g. QML template) to show
|
|
self.skill = skill
|
|
self.on_gui_changed_callback = None
|
|
self.config = Configuration.get()
|
|
|
|
@property
|
|
def remote_url(self):
|
|
"""Returns configuration value for url of remote-server."""
|
|
return self.config.get('remote-server')
|
|
|
|
def build_message_type(self, event):
|
|
"""Builds a message matching the output from the enclosure."""
|
|
return '{}.{}'.format(self.skill.skill_id, event)
|
|
|
|
def setup_default_handlers(self):
|
|
"""Sets the handlers for the default messages."""
|
|
msg_type = self.build_message_type('set')
|
|
self.skill.add_event(msg_type, self.gui_set)
|
|
|
|
def register_handler(self, event, handler):
|
|
"""Register a handler for GUI events.
|
|
|
|
When using the triggerEvent method from Qt
|
|
triggerEvent("event", {"data": "cool"})
|
|
|
|
Arguments:
|
|
event (str): event to catch
|
|
handler: function to handle the event
|
|
"""
|
|
msg_type = self.build_message_type(event)
|
|
self.skill.add_event(msg_type, handler)
|
|
|
|
def set_on_gui_changed(self, callback):
|
|
"""Registers a callback function to run when a value is
|
|
changed from the GUI.
|
|
|
|
Arguments:
|
|
callback: Function to call when a value is changed
|
|
"""
|
|
self.on_gui_changed_callback = callback
|
|
|
|
def gui_set(self, message):
|
|
"""Handler catching variable changes from the GUI.
|
|
|
|
Arguments:
|
|
message: Messagebus message
|
|
"""
|
|
for key in message.data:
|
|
self[key] = message.data[key]
|
|
if self.on_gui_changed_callback:
|
|
self.on_gui_changed_callback()
|
|
|
|
def __setitem__(self, key, value):
|
|
"""Implements set part of dict-like behaviour with named keys."""
|
|
self.__session_data[key] = value
|
|
|
|
if self.page:
|
|
# emit notification (but not needed if page has not been shown yet)
|
|
data = self.__session_data.copy()
|
|
data.update({'__from': self.skill.skill_id})
|
|
self.skill.bus.emit(Message("gui.value.set", data))
|
|
|
|
def __getitem__(self, key):
|
|
"""Implements get part of dict-like behaviour with named keys."""
|
|
return self.__session_data[key]
|
|
|
|
def __contains__(self, key):
|
|
"""Implements the "in" operation."""
|
|
return self.__session_data.__contains__(key)
|
|
|
|
def clear(self):
|
|
"""Reset the value dictionary, and remove namespace from GUI."""
|
|
self.__session_data = {}
|
|
self.page = None
|
|
self.skill.bus.emit(Message("gui.clear.namespace",
|
|
{"__from": self.skill.skill_id}))
|
|
|
|
def send_event(self, event_name, params=None):
|
|
"""Trigger a gui event.
|
|
|
|
Arguments:
|
|
event_name (str): name of event to be triggered
|
|
params: json serializable object containing any parameters that
|
|
should be sent along with the request.
|
|
"""
|
|
params = params or {}
|
|
self.skill.bus.emit(Message("gui.event.send",
|
|
{"__from": self.skill.skill_id,
|
|
"event_name": event_name,
|
|
"params": params}))
|
|
|
|
def show_page(self, name, override_idle=None,
|
|
override_animations=False):
|
|
"""Begin showing the page in the GUI
|
|
|
|
Arguments:
|
|
name (str): Name of page (e.g "mypage.qml") to display
|
|
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.
|
|
"""
|
|
self.show_pages([name], 0, override_idle, override_animations)
|
|
|
|
def show_pages(self, page_names, index=0, override_idle=None,
|
|
override_animations=False):
|
|
"""Begin showing the list of pages in the GUI.
|
|
|
|
Arguments:
|
|
page_names (list): List of page names (str) to display, such as
|
|
["Weather.qml", "Forecast.qml", "Details.qml"]
|
|
index (int): Page number (0-based) to show initially. For the
|
|
above list a value of 1 would start on "Forecast.qml"
|
|
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.
|
|
"""
|
|
if not isinstance(page_names, list):
|
|
raise ValueError('page_names must be a list')
|
|
|
|
if index > len(page_names):
|
|
raise ValueError('Default index is larger than page list length')
|
|
|
|
self.page = page_names[index]
|
|
|
|
# First sync any data...
|
|
data = self.__session_data.copy()
|
|
data.update({'__from': self.skill.skill_id})
|
|
self.skill.bus.emit(Message("gui.value.set", data))
|
|
|
|
# Convert pages to full reference
|
|
page_urls = []
|
|
for name in page_names:
|
|
if name.startswith("SYSTEM"):
|
|
page = resolve_resource_file(join('ui', name))
|
|
else:
|
|
page = self.skill.find_resource(name, 'ui')
|
|
if page:
|
|
if self.config.get('remote'):
|
|
page_urls.append(self.remote_url + "/" + page)
|
|
else:
|
|
page_urls.append("file://" + page)
|
|
else:
|
|
raise FileNotFoundError("Unable to find page: {}".format(name))
|
|
|
|
self.skill.bus.emit(Message("gui.page.show",
|
|
{"page": page_urls,
|
|
"index": index,
|
|
"__from": self.skill.skill_id,
|
|
"__idle": override_idle,
|
|
"__animations": override_animations}))
|
|
|
|
def remove_page(self, page):
|
|
"""Remove a single page from the GUI.
|
|
|
|
Arguments:
|
|
page (str): Page to remove from the GUI
|
|
"""
|
|
return self.remove_pages([page])
|
|
|
|
def remove_pages(self, page_names):
|
|
"""Remove a list of pages in the GUI.
|
|
|
|
Arguments:
|
|
page_names (list): List of page names (str) to display, such as
|
|
["Weather.qml", "Forecast.qml", "Other.qml"]
|
|
"""
|
|
if not isinstance(page_names, list):
|
|
raise ValueError('page_names must be a list')
|
|
|
|
# Convert pages to full reference
|
|
page_urls = []
|
|
for name in page_names:
|
|
page = self.skill.find_resource(name, 'ui')
|
|
if page:
|
|
page_urls.append("file://" + page)
|
|
else:
|
|
raise FileNotFoundError("Unable to find page: {}".format(name))
|
|
|
|
self.skill.bus.emit(Message("gui.page.delete",
|
|
{"page": page_urls,
|
|
"__from": self.skill.skill_id}))
|
|
|
|
def show_text(self, text, title=None, override_idle=None,
|
|
override_animations=False):
|
|
"""Display a GUI page for viewing simple text.
|
|
|
|
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.
|
|
"""
|
|
self.clear()
|
|
self["text"] = text
|
|
self["title"] = title
|
|
self.show_page("SYSTEM_TextFrame.qml", override_idle,
|
|
override_animations)
|
|
|
|
def show_image(self, url, caption=None,
|
|
title=None, fill=None,
|
|
override_idle=None, override_animations=False):
|
|
"""Display a GUI page for viewing an image.
|
|
|
|
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.
|
|
"""
|
|
self.clear()
|
|
self["image"] = url
|
|
self["title"] = title
|
|
self["caption"] = caption
|
|
self["fill"] = fill
|
|
self.show_page("SYSTEM_ImageFrame.qml", override_idle,
|
|
override_animations)
|
|
|
|
def show_animated_image(self, url, caption=None,
|
|
title=None, fill=None,
|
|
override_idle=None, override_animations=False):
|
|
"""Display a GUI page for viewing an image.
|
|
|
|
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.
|
|
"""
|
|
self.clear()
|
|
self["image"] = url
|
|
self["title"] = title
|
|
self["caption"] = caption
|
|
self["fill"] = fill
|
|
self.show_page("SYSTEM_AnimatedImageFrame.qml", override_idle,
|
|
override_animations)
|
|
|
|
def show_html(self, html, resource_url=None, override_idle=None,
|
|
override_animations=False):
|
|
"""Display an HTML page in the GUI.
|
|
|
|
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.
|
|
"""
|
|
self.clear()
|
|
self["html"] = html
|
|
self["resourceLocation"] = resource_url
|
|
self.show_page("SYSTEM_HtmlFrame.qml", override_idle,
|
|
override_animations)
|
|
|
|
def show_url(self, url, override_idle=None,
|
|
override_animations=False):
|
|
"""Display an HTML page in the GUI.
|
|
|
|
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.
|
|
"""
|
|
self.clear()
|
|
self["url"] = url
|
|
self.show_page("SYSTEM_UrlFrame.qml", override_idle,
|
|
override_animations)
|
|
|
|
def shutdown(self):
|
|
"""Shutdown gui interface.
|
|
|
|
Clear pages loaded through this interface and remove the skill
|
|
reference to make ref counting warning more precise.
|
|
"""
|
|
self.clear()
|
|
self.skill = None
|