Skip to content

Commit

Permalink
Update protocol.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JarbasAl authored Oct 6, 2023
1 parent 84aec29 commit 8d96cd4
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ This protocol defines how ovos-gui communicates with connected clients
- [CONNECTION](#connection)
- [NAMESPACES](#namespaces)
* [Active Skills - mycroft.system.active_skills](#active-skills---mycroftsystemactive-skills)
* [Pages - mycroft.gui.list.xxx](#pages---mycroftguilistxxx)
+ [Insert new page at position](#insert-new-page-at-position)
+ [Move pages within the list](#move-pages-within-the-list)
+ [Remove pages from the list](#remove-pages-from-the-list)
- [PAGES - mycroft.gui.list.xxx](#pages---mycroftguilistxxx)
* [Insert new page at position](#insert-new-page-at-position)
* [Move pages within the list](#move-pages-within-the-list)
* [Remove pages from the list](#remove-pages-from-the-list)
- [EVENTS - mycroft.events.triggered](#events---mycrofteventstriggered)
* [SPECIAL EVENT: page_gained_focus](#special-event--page-gained-focus)
- [SKILL DATA - mycroft.session.xxx](#skill-data---mycroftsessionxxx)
Expand All @@ -20,6 +20,7 @@ This protocol defines how ovos-gui communicates with connected clients
+ [Move items within the list](#move-items-within-the-list)
+ [Remove items from the list](#remove-items-from-the-list)


# CONNECTION

on connection gui clients announce themselves
Expand Down Expand Up @@ -52,13 +53,13 @@ a reserved namespace is "mycroft.system.active_skills", the data contained in th
Recent skills are ordered from the last used to the oldest, so the first item of the model will always be the the one showing any GUI page, if available.


## Pages - mycroft.gui.list.xxx
# PAGES - mycroft.gui.list.xxx

Each active skill is associated with a model with uris to the QML files of all gui items that are supposed to be visible.

Non QT GUIS get sent other file extensions such as .jsx or .html using the same message format

### Insert new page at position
## Insert new page at position
```javascript
{
"type": "mycroft.gui.list.insert",
Expand All @@ -68,7 +69,7 @@ Non QT GUIS get sent other file extensions such as .jsx or .html using the same
}
```

### Move pages within the list
## Move pages within the list
```javascript
{
"type": "mycroft.gui.list.move",
Expand All @@ -79,7 +80,7 @@ Non QT GUIS get sent other file extensions such as .jsx or .html using the same
}
```

### Remove pages from the list
## Remove pages from the list
```javascript
{
"type": "mycroft.gui.list.remove",
Expand Down

0 comments on commit 8d96cd4

Please sign in to comment.