https://github.com/dwettstein/node-red-contrib-comfortbox

Node-RED nodes for configuring and using the ComfortBox API services (https://github.com/dwettstein/comfortbox-api-services)
https://github.com/dwettstein/node-red-contrib-comfortbox

comfortbox iot node-red nodes web-of-things

Last synced: over 1 year ago
JSON representation

Node-RED nodes for configuring and using the ComfortBox API services (https://github.com/dwettstein/comfortbox-api-services)

• Host: GitHub
• URL: https://github.com/dwettstein/node-red-contrib-comfortbox
• Owner: dwettstein
• License: mit
• Created: 2017-05-30T19:04:41.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-03-16T14:15:42.000Z (over 5 years ago)
• Last Synced: 2024-10-24T10:07:06.956Z (over 1 year ago)
• Topics: comfortbox, iot, node-red, nodes, web-of-things
• Language: HTML
• Size: 335 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# node-red-contrib-comfortbox

_node-red-contrib-comfortbox_ is a [Node-RED](https://nodered.org/) package containing nodes for configuring and using the ComfortBox API services (https://github.com/dwettstein/comfortbox-api-services).

## Overview

The package contains the following Node-RED nodes:

- `comfortbox-amqp-server` \- A configuration node to set an AMQP endpoint for the event trigger.

- `comfortbox-api-server` \- A configuration node to set the API endpoint.

- `event trigger` \- A node to trigger a flow from an AMQP event.

- `configure box`\- A node to configure a registered ComfortBox device (e.g. set the MQTT host).

- `display color` \- A node to display one or multiple colors on a ComfortBox device.

- `display text` \- A node to display a text on a ComfortBox device.

- `query data` \- A node to query data of a ComfortBox device.

- `register box` \- A node to register a new ComfortBox device to the API services.

## Example flows

For adding the examples to your Node-RED installation, just copy the content of the file [Usecase flows](./examples/usecase_flows.json) and import it to Node-RED using the clipboard import.

### Use Case 1: Register multiple devices

This use case shows how to register multiple comfortbox devices to the API services.

![usecase_register.png](./examples/usecase_register.png)

### Use Case 2: Reconfigure all devices

This use case shows how to reconfigure all registered devices (e.g. changing the MQTT host).

![usecase_reconfigure.png](./examples/usecase_reconfigure.png)

### Use Case 3: Listen to button thumb-down

This use case shows an example of how to listen to a specific event. This can also be used to add functionality to the device buttons.

![usecase_button.png](./examples/usecase_button.png)

## Installation

Currently, the package is not yet available from the _npm repository_. For installing the nodes, just clone the repository into your Node-RED user folder (usually `~/.node-red/nodes`) and run `npm install .`.