Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OVOSHatchery/ovos-skill-node-red
mycroft skills with node red
https://github.com/OVOSHatchery/ovos-skill-node-red
hivemind mycroft mycroft-fallback mycroft-skill mycroft-skills mycroftai node-red skill websocket-connection
Last synced: 3 months ago
JSON representation
mycroft skills with node red
- Host: GitHub
- URL: https://github.com/OVOSHatchery/ovos-skill-node-red
- Owner: OVOSHatchery
- License: apache-2.0
- Created: 2018-01-27T10:15:07.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-15T03:54:10.000Z (8 months ago)
- Last Synced: 2024-07-30T02:24:10.686Z (3 months ago)
- Topics: hivemind, mycroft, mycroft-fallback, mycroft-skill, mycroft-skills, mycroftai, node-red, skill, websocket-connection
- Language: Python
- Homepage:
- Size: 1.42 MB
- Stars: 30
- Watchers: 3
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# NodeRed mycroft skill
[Node Red](https://nodered.org/) - Mycroft interface
beginners and non technical users can now leverage visual programming and easily extend mycroft functionality
- [Additional Setup](#additional-setup)
* [Installing node red](#installing-node-red)
+ [Firewall](#firewall)
+ [Launch Node red](#launch-node-red)
* [Import base flows](#import-base-flows)
* [Configure Websocket](#configure-websocket)
* [Build Intents](#build-intents)
- [Extra functionality](#extra-functionality)
* [Webui](#webui)
* [Debug](#debug)
# Platform support
- :heavy_check_mark: - tested and confirmed working
- :x: - incompatible/non-functional
- :question: - untested
- :construction: - partial support
| platform | status | tag | version | last tested |
|:---------------:|:----------:|:-----:|:-------:|:-----------:|
| [Chatterbox](https://hellochatterbox.com) | :question: | dev | | never |
| [HolmesV](https://github.com/HelloChatterbox/HolmesV) | :question: | dev | | never |
| [LocalHive](https://github.com/JarbasHiveMind/LocalHive) | :question: | dev | | never |
| [Mycroft Mark1](https://github.com/MycroftAI/enclosure-mark1) | :question: | dev | | never |
| [Mycroft Mark2](https://github.com/MycroftAI/hardware-mycroft-mark-II) | :question: | dev | | never |
| [NeonGecko](https://neon.ai) | :question: | dev | | never |
| [OVOS](https://github.com/OpenVoiceOS) | :question: | dev | | never |
| [Picroft](https://github.com/MycroftAI/enclosure-picroft) | :question: | dev | | never |
| [Plasma Bigscreen](https://plasma-bigscreen.org/) | :question: | dev | | never |
- `tag` - link to github release / branch / commit
- `version` - link to release/commit of platform repo where this was tested
# Additional Setup
This skill requires [Mycroft HiveMind Skill](https://github.com/JarbasSkills/skill-hivemind)
After installing the node red skill you need to deploy some flows in node red
## Installing node red
read the Node Red [Getting Started Guide](https://nodered.org/docs/getting-started/)
you might need to install
```bash
apt-get install libssl-dev libffi-dev
```
### Firewall
Node red can be running in any machine, does not need to run in same
place as mycroft, if this is the case open port 6789 in mycroft
```bash
sudo ufw allow 6789
```
Note that it is node red that starts a connection to mycroft, not the other
way around
### Launch Node red
node red must be running, it can be started with
```bash
node-red-start
```
or made into a system service
```bash
sudo systemctl enable nodered.service
sudo service nodered start
```
verify that node-red is running at http://noderedip:1880
## Import base flows
- Copy the JSON text from [base_flows.json](base_flows.json)
- Go to http://noderedip:1880
- In the upper righthand corner menu, choose... Import > Clipboard
- This will open the "Import nodes window"
- Paste the contents from the sample_flow.txt
- Click on Import and the flow should appear
- Next click on Deploy
- After you deploy, the websocket nodes should say 'connected' if the skill was properly configured
## Configure Websocket
NodeRed will open a websocket connection to communicate with mycroft
ws://username:[email protected]:6789
username can be anything, secret is set in web ui of the skill
You need to edit mycroft-in and mycroft-out websocket nodes with the correct secret and mycroft's ip address
## Build Intents
Edit intents flow to add your node red intents
# Extra functionality
There are 2 flows providing extra functionality
## Webui
A basic webchat is provided, you can access it at http://noderedip:1880/ui
## Debug
Test different payload with the debug flow
