https://github.com/research-virtualfortknox/node-red-contrib-msb
Nodes to connect to the Manufacturing Service Bus (MSB) developed by VFK Research (Fraunhofer IPA)
https://github.com/research-virtualfortknox/node-red-contrib-msb
msb msb-client msb-client-websocket node-red websocket-interface
Last synced: 5 months ago
JSON representation
Nodes to connect to the Manufacturing Service Bus (MSB) developed by VFK Research (Fraunhofer IPA)
- Host: GitHub
- URL: https://github.com/research-virtualfortknox/node-red-contrib-msb
- Owner: research-virtualfortknox
- License: apache-2.0
- Created: 2020-06-29T12:13:31.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-07-12T09:08:57.000Z (11 months ago)
- Last Synced: 2025-09-24T03:41:42.176Z (9 months ago)
- Topics: msb, msb-client, msb-client-websocket, node-red, websocket-interface
- Language: JavaScript
- Homepage:
- Size: 244 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MSB integration in node-RED flows
[](https://badge.fury.io/js/%40vfk_research%2Fnode-red-contrib-msb)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fresearch-virtualfortknox%2Fnode-red-contrib-msb?ref=badge_shield)
**Compatibility Matrix**
Version compatibility to MSB versions:
| | **1.5.x-RELEASE** | **1.6.x-RELEASE** |
|---|:---:|:---:|
| 1.0.x | x | x |
## Welcome
If you want to contribute, please read the [Contribution Guidelines](.github/CONTRIBUTING.md).
If you want to know how to use this integration in your own node-RED flows, read below.
## What is VFK MSB
TODO: Link to general documentation about VFK MSB
You can use this integration to connect a node-RED flow to VFK MSB.
## Install package to node-RED
Install npm package to your node-RED instance:
```sh
npm install @vfk_research/node-red-contrib-msb
```
or add the ``node-red-contrib-msb`` package via the node-RED package manager.
## Available nodes
Available nodes:
- __msb-object node__: Main node to set up the self-description and connection to MSB
- __msb-event node__: Node to link messages to an MSB event (always wire its output to the msb-object node)
- __msb-config node__: Node to get the current value of a MSB configuration parameter
## Restrictions
Currently, only one __msb-object node__ should be used within the same Node-Red instance. A single Node-Red instance is able to represent only one ``samrt object``connected to the ``VFK MSB``.
## Sample flow
You can use [this sample flow](doc/flows/sample-flow.json) to test the capabilities of the nodes:
To connect the flow to an MSB instance and test it, some steps need to be done:
1. Update following field in the __msb-object node__:
- ``UUID``: You can create UUIDs using this [Online Generator](https://www.uuidgenerator.net/version4).
- ``Token``: Choose your token to be used in MSB verification later
- ``MSB-URL``: Set the URL to your MSB instance (websocket interface)
2. __Deploy__ the flow - this will establish the connection to MSB
3. __Verify__ your node app in MSB GUI
4. Now you are ready to __test messages__ from the node app to MSB (use the inject-nodes)
5. Optional: if you also want to test incoming messages from MSB to the node app,
you can __add an integration flow__ in MSB GUI linking hte node app events to its functions (just for testing) e.g.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fresearch-virtualfortknox%2Fnode-red-contrib-msb?ref=badge_large)