{"id":13744622,"url":"https://github.com/OVOSHatchery/ovos-skill-node-red","last_synced_at":"2025-05-09T03:32:43.938Z","repository":{"id":114497216,"uuid":"119153589","full_name":"OVOSHatchery/ovos-skill-node-red","owner":"OVOSHatchery","description":"mycroft skills with node red","archived":false,"fork":false,"pushed_at":"2024-03-15T03:54:10.000Z","size":1492,"stargazers_count":30,"open_issues_count":3,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-29T03:01:46.042Z","etag":null,"topics":["hivemind","mycroft","mycroft-fallback","mycroft-skill","mycroft-skills","mycroftai","node-red","skill","websocket-connection"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OVOSHatchery.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-01-27T10:15:07.000Z","updated_at":"2024-03-15T00:42:01.000Z","dependencies_parsed_at":"2024-03-15T04:48:02.058Z","dependency_job_id":"1729c0cc-ea58-45c2-8f4c-b3a44360be8b","html_url":"https://github.com/OVOSHatchery/ovos-skill-node-red","commit_stats":null,"previous_names":["ovoshatchery/ovos-skill-node-red","jarbasskills/skill-node-red"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OVOSHatchery%2Fovos-skill-node-red","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OVOSHatchery%2Fovos-skill-node-red/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OVOSHatchery%2Fovos-skill-node-red/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OVOSHatchery%2Fovos-skill-node-red/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OVOSHatchery","download_url":"https://codeload.github.com/OVOSHatchery/ovos-skill-node-red/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224811082,"owners_count":17373914,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hivemind","mycroft","mycroft-fallback","mycroft-skill","mycroft-skills","mycroftai","node-red","skill","websocket-connection"],"created_at":"2024-08-03T05:01:12.863Z","updated_at":"2024-11-15T16:31:20.614Z","avatar_url":"https://github.com/OVOSHatchery.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# NodeRed mycroft skill\n\n![](./logo.png)\n\n[Node Red](https://nodered.org/) - Mycroft interface\n\nbeginners and non technical users can now leverage visual programming and easily extend mycroft functionality\n\n- [Additional Setup](#additional-setup)\n  * [Installing node red](#installing-node-red)\n    + [Firewall](#firewall)\n    + [Launch Node red](#launch-node-red)\n  * [Import base flows](#import-base-flows)\n  * [Configure Websocket](#configure-websocket)\n  * [Build Intents](#build-intents)\n- [Extra functionality](#extra-functionality)\n  * [Webui](#webui)\n  * [Debug](#debug)\n\n\n# Platform support\n\n- :heavy_check_mark: - tested and confirmed working\n- :x: - incompatible/non-functional\n- :question: - untested\n- :construction: - partial support\n\n|     platform    |   status   |  tag  | version | last tested | \n|:---------------:|:----------:|:-----:|:-------:|:-----------:|\n|    [Chatterbox](https://hellochatterbox.com)   | :question: |  dev  |         |    never    | \n|     [HolmesV](https://github.com/HelloChatterbox/HolmesV)     | :question: |  dev  |         |    never    | \n|    [LocalHive](https://github.com/JarbasHiveMind/LocalHive)    | :question: |  dev  |         |    never    |  \n|  [Mycroft Mark1](https://github.com/MycroftAI/enclosure-mark1)    | :question: |  dev  |         |    never    | \n|  [Mycroft Mark2](https://github.com/MycroftAI/hardware-mycroft-mark-II)    | :question: |  dev  |         |    never    |  \n|    [NeonGecko](https://neon.ai)      | :question: |  dev  |         |    never    |   \n|       [OVOS](https://github.com/OpenVoiceOS)        | :question: |  dev  |         |    never    |    \n|     [Picroft](https://github.com/MycroftAI/enclosure-picroft)       | :question: |  dev  |         |    never    |  \n| [Plasma Bigscreen](https://plasma-bigscreen.org/)  | :question: |  dev  |         |    never    |  \n\n- `tag` - link to github release / branch / commit\n- `version` - link to release/commit of platform repo where this was tested\n\n\n# Additional Setup\n\nThis skill requires [Mycroft HiveMind Skill](https://github.com/JarbasSkills/skill-hivemind)\n\nAfter installing the node red skill you need to deploy some flows in node red\n\n## Installing node red\n\n    \nread the Node Red [Getting Started Guide](https://nodered.org/docs/getting-started/)\n\nyou might  need to install\n\n```bash\napt-get install libssl-dev libffi-dev\n```\n\n### Firewall\n\nNode red can be running in any machine, does not need to run in same \nplace as mycroft, if this is the case open port 6789 in mycroft\n\n```bash\nsudo ufw allow 6789\n```\n\nNote that it is node red that starts a connection to mycroft, not the other \nway around\n\n### Launch Node red\n\nnode red must be running, it can be started with\n\n```bash\n node-red-start\n```\n\nor made into a system service\n\n```bash\nsudo systemctl enable nodered.service\nsudo service nodered start\n```\n   \nverify that node-red is running at http://noderedip:1880\n\n\n## Import base flows\n\n\n- Copy the JSON text from [base_flows.json](base_flows.json)\n- Go to http://noderedip:1880\n- In the upper righthand corner menu, choose... Import \u003e Clipboard\n- This will open the \"Import nodes window\"\n- Paste the contents from the sample_flow.txt\n- Click on Import and the flow should appear\n- Next click on Deploy\n- After you deploy, the websocket nodes should say 'connected' if the skill was properly configured\n\n\n## Configure Websocket\n\nNodeRed will open a websocket connection to communicate with mycroft\n\n    ws://username:secret@127.0.0.1:6789\n\nusername can be anything, secret is set in web ui of the skill\n\nYou need to edit mycroft-in and mycroft-out websocket nodes with the correct secret and mycroft's ip address\n\n![](bus.png)\n\n## Build Intents\n \nEdit intents flow to add your node red intents\n\n![](intents.png)\n\n\n# Extra functionality\n\nThere are 2 flows providing extra functionality\n\n## Webui\n\nA basic webchat is provided, you can access it at http://noderedip:1880/ui\n\n![](chat.png)\n\n![](chat_flow.png)\n\n## Debug\n\nTest different payload with the debug flow\n\n![](debug.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOVOSHatchery%2Fovos-skill-node-red","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOVOSHatchery%2Fovos-skill-node-red","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOVOSHatchery%2Fovos-skill-node-red/lists"}