node-red-contrib-openhab2 1.0.0

openhab home automation for node-red

npm install node-red-contrib-openhab2

Description

Nodes facilitating the automation of openHAB ( http://www.openhab.org ) items with Node-RED ( http://nodered.org ).

Installation

$ cd ~/.node-red
$ npm install node-red-contrib-openhab2

Nodes

- openhab2-controller

Performs all communication with the configured openHAB controller.

Configuration:

  • Name : Specify a name
  • openHAB host : Specify the hostname or ip address of the openHAB server
  • openHAB port : Specify the port of the openHAB server
- openhab2-in

Listens to state changes of a selected openHAB Item.

Configuration:

  • Name : Optionally specify a name
  • Controller : Select the openHAB controller
  • Item : Select the Item to monitor

Messages injected in NodeRED flows (2 channels):

Channel 1:

  • msg.item : the item's itemname (not label)
  • msg.topic : "StateEvent"
  • msg.payload : the new state of the selected item

Channel 2:

  • msg.item : the item's itemname (not label)
  • msg.topic : "RawEvent"
  • msg.payload : raw (unprocessed) event for the selected item
- openhab2-monitor

Monitors the openhab2-controller node.

Configuration:

  • Name : Optionally specify a name
  • Controller : Select the openHAB controller

Messages injected in NodeRED flows (3 channels):

Channel 1:

  • msg.topic : "ConnectionStatus"
  • msg.payload : connection status ('ON' or 'OFF')

Channel 2:

  • msg.topic : "ConnectionError"
  • msg.payload : error message

Channel 3:

  • msg.topic : "RawEvent"
  • msg.payload : raw (unprocessed) event for all items
- openhab2-out

Sends commands or state updates to a selected openHAB Item. E.g. "ON", "OFF", "REFRESH", ...

Configuration:

  • Name : Optionally specify a name
  • Controller : Select the openHAB controller
  • Item : Select the Item to address
  • Topic : Optionally select "ItemCommand" or "ItemUpdate". If specified, it overrides the topic specified in the incoming message.
  • Payload : Optionally specify the command or update value to send to the selected item. If specified, it overrides the payload specified in the incoming message.

Messages accepted by NodeRED flows:

  • msg.topic : optionally "ItemCommand", "ItemUpdate"
  • msg.payload : optionally the fixed command or update value to send to the selected item

Node Info

Version: 1.0.0
Updated 1 day ago
License: Apache-2.0

Downloads

11 in the last day
63 in the last week
231 in the last month

Nodes

  • openhab2-controller
  • openhab2-in
  • openhab2-monitor
  • openhab2-out

Keywords

  • node-red
  • openhab2

Maintainers

  • pdmangel