Butter MAS NodeRed API
This repo defines Node-Red nodes that encapsulate Butter MAS API.
Table of Contents
About The Project
This project extends the basic node-red node types with new nodes that encapsulate Butter Robotics operations and api calls. This can prove very useful when building IoT flows and orchestration using Node-Red, and needing to use Butter as well.
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
- Node-Red (Please refer to this documentation for easy installation on Windows).
Installation
- Install the package.
npm install @butter-robotics/mas-node-red-api@latest -g
- Restart Node-Red and validate that the new nodes exist in your node pallette.
Usage
Once you have completed the prerequisites, the new nodes should appear in all their glory in the node pallette:
You can drag the butter nodes to use in your flows:
For further explanation, please refer to the documentation given inside the node-red GUI.
To learn more about Node-Red, please refer to their Documentation
To understand more about Butter Robotics Javascript API, please refer to this Documentation
Contributing
We always have space for improvements, here is how to help:
- Fork the repo.
- Submit a PR.
- Bump the version in package.json.
- Write a concise summary of your change in the RELEASE-NOTES.md file.
License
Distributed under the Apache 2.0 License. See LICENSE for more information.