Skip to content

idc-milab/NodeRed-Butter

Repository files navigation


Logo

NodeRed-Butter

This repo defines node-red nodes that encapsulate butter.mas.api opertaions.

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

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

  • Download Node-Red (Dah..) Plese refer to this link for easy installation on Windows.

  • npm install the package with the cmd while inside your user data directory (usually $HOME/.node-red)

    npm install node-red-contrib-milab-butter@latest -g
  • Restart node red and validate that the new nodes exist in your node pallete !

Usage

Once you have completed the prerequisites, the new nodes should appear in all their glory in the node pallete :)

pallete pic

You can drag the butter nodes to use in your flows:

flow pic

Refer to the documentation given inside the node-red GUI to understand the usage better - have fun !

To learn more about Node-Red, please refer to their Documentation
To understand more about Butter, please refer to their Documentation

Contributing

We always have space for improvements, here is how to help:

  1. Fork the repo.
  2. Submit a PR.
  3. Bump the version in package.json.
  4. Write a concise summary of your change in the RELEASE-NOTES.md file.
  5. If your contribution includes a new node in the UI or any client facing feature, consult with @RonGissin about updating the example-flow file.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ron Gissin - ron.gissin@milab.idc.ac.il

Project Link: NodeRed-Butter

Authors

Acknowledgements

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published