node-red-contrib-enoceanip v0.1.2

enoceanip

I/O nodes for Node-RED to communicate with EnOcean REST API. This API comes along with a certain software bundle containing neccessary translation of Enocean serial protocol, administration and learn in functionality of Enocean devices. Once configured and connected to EnOcean REST API, Node-RED is kept informed continously by receiving JSON messages including Enocean telegrams that have been occured on Enocean radio.

Enoceanip covers two nodes that seperate incoming and outgoing communication to EnOcean REST API. A configuration node will organize several API credentials and held them safe of being exported.

Prerequisites

• node.js v0.10.41
• npm 1.4.29
• Node-RED 0.13.1

may run on different set up as well

• EnOcean REST API - running on Smart EnOcean Gateway - Install hardware in your local network

or

• EnOcean REST API - DIY (coming soon) - Install software and attach EnOcean adapter on your own. (e.g. USB300 or TCM310)

How to install

This process describes how to retrieve and integrate enoceanip in Node-RED (http://npmjs.org).

• Install via Node-Red-Ui (recommended)
• Manual installation:

1. Open terminal and go to your local Node-RED folder. e.g. cd ~/.node-red
2. Execute npm command to install node npm install node-red-contrib-enoceanip
3. Restart Node-RED
4. Reload Node-RED Web UI
5. Find "enocean" nodes underneath categories Input and Output

What to configure

1. Drag and drop the enocean nodes to your canvas
2. Configure API related settings. Open an enocean node edit screen and create or select an API connection. They can be managed via Node-RED menu->view->configuration sidebar.
3. After deploying Node-RED flow, status indicator should change
4. Configure/learn in enocean devices via software bundles Webinterface http://Hostname-Of-API/dcgw/enocean/newdevice (Note: If filtermode (http://Hostname-Of-API/dcgw/admin/enoceanchip) has been turned off, you will receive any event happening on enocean radio)

Public gateway / debug

pw: user

Use sample flow

A sample flow is provided that includes a couple of predefined requests for enocean out and reveal its equivalent REST calls.

• Open flows/sampleFlow.json in any editor and copy its content while using the import function in Node-RED menu bar in the upper right corner.
• simply start Node-RED with node-red sampleFlow.json

Quickstart

Once your set up is done, you need to provide API-Origin by specifying host, port and credentials. This information will be held in a configuration node and is available to other enocean nodes as well. But your credentials are saved securely and won't be part of any exports. In case you've activated JSON encryption please prepend host field by https protocol instead of http protocol.

node - enocean out

Usage, API resources

Change device state

How state should look like?

State and FunctionGroups

A state is represented by a set of key-value pairs and is encapsulated in a functionGroup. Each functionGroup specify the communication direction (to/from) in addition. FunctionGroups therefore represent information that can be held or had been hold by enocean telegrams. However, enocean profiles - widely used to organize EnOcean communication- sometimes specify more than one telegram or functionGroup per profile. Each device communicates by using at least one EnOcean equipment profile (EEP).

The function names with their interface specification can be retrieved anytime through HTTP requests in a syntax: All profiles /profiles Single profile/profiles/f6-02-01 Ask the device /devices/DEVICE-ID/profile

node - enocean in

Events

Filter options:

Author / Copyright

(c) 2017 Digital Concepts | Dominic Böhler | @boehlefeld