add gui_mobile.md

OpenVoiceOS · Nov 21, 2023 · 974f249 · 974f249
1 parent 03620f8
commit 974f249
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/docs/gui_mobile.md b/docs/gui_mobile.md
@@ -0,0 +1,11 @@
+# GUI on mobile extension
+
+Handles mycroft-gui running on android
+
+# Listens to
+
+| Message Type                           | Message Data | Description                                              | Emitted Response Type | Handled by             |
+|----------------------------------------|--------------|----------------------------------------------------------|-----------------------|------------------------|
+| `mycroft.gui.screen.close`             |              | Forces the display of the home screen in the GUI.        |                       | handle_show_homescreen |
+| `mycroft.gui.forceHome`                |              | Forces the display of the home screen in the GUI.        |                       | handle_show_homescreen |
+| `mycroft.gui.screen.request.page.back` |              | Handles a request to navigate back to previous GUI page. |                       | handle_page_back       |
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -23,7 +23,8 @@ nav:
         - WIFI Balena: phal_balena.md
         - Audio GGWave: ggwave.md
     - GUI Extensions:
-        - GUI Bigscreen: gui_bigscreen.md
+        - Plasma Bigscreen: gui_bigscreen.md
+        - Mobile: gui_mobile.md
     - Skills:
         - Homescreen: ovos_homescreen.md