react-mycroft-gui

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

react-mycroft-gui

★ 23 Open GitHub ↗

A React based front-end for Mycroft.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# React-Mycroft-Gui

The React-Mycroft-Gui is an out-of-the-box solution for a GUI using the Mycroft open-source assistant, originally designed for the official 7 inch raspberry pi touch screen.

While it works without configuration for certain skills that currently have templates, it's easily extensible, and can be used with any Mycroft skill that outputs messages on the gui message bus.

# Setup

Simply clone, install dependencies with 'npm install', and run with 'npm start'

# Test

To test, you can use an existing gui template, run Mycroft and ask something like:
"Wiki {query}"

# Adding your own interfaces

All skills in the React-Mycroft-Gui are referenced from the `skill_component_handler.jsx`,
 which resides in `src < components < mycroft_messagebus_elements`. 
Here you can add a conditional that triggers when your desired skill runs. 
This file then references skill components in the `src < components < skill_components` directory, where all skill related assets and components are kept.

To make your own skills you can either build the components from scratch, or otherwise use prebuilt functional components in the `src < components < skill_components` directory. 
These functional components utilize a state hook in the `mycroft_message_bus.jsx` that reset state if a page focus event happens, important for updating a component after render.
If you do choose to make your own components from scratch, it's important to keep these event's in mind and make sure they are handled accordingly if they occur.

---

Big Shoutout to forslund at mycroft, his ideas on making a js gui solution were the basis of this project.

react-mycroft-gui

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README