thing-it-device-enocean-ip/README.md

[thing-it-node] Device Plugin for EnOcean IP products.

# thing-it-device-enocean-ip

[![NPM](https://nodei.co/npm/thing-it-device-enocean-ip.png)](https://nodei.co/npm/thing-it-device-enocean-ip/)
[![NPM](https://nodei.co/npm-dl/thing-it-device-enocean-ip.png)](https://nodei.co/npm/thing-it-device-enocean-ip/)

Device Plugins for [[thing-it-node]](https://github.com/marcgille/thing-it-node) and [thing-it.com](wwww.thing-it.com) for Enocean IP-connected devices e.g. leverage products of (http://enocean-gateway.eu/en/).

<a href="./documentation/images/gateway.png"><img src="./documentation/images/gateway.png" width="50%" height="50%"></a>

<div style="color: red">Note, that this Plugin is Work under construction!</div>

The Plugin currently supports a number of concrete Devices

* Switch (EEP F6-02, Rocker Switch)
* Occupancy Sensor (EEP A5-07)
* Power Outlet/Plug (EEP D5-00-01)
* Temperature Sensor (EEP A5-02)

Over time, we are going to support a broader bandwidth of [EnOcean Equipment Profiles](https://www.enocean-alliance.org/products/eeps).

## Installation and Configuration

### Installation of NodeJS and [thing-it-node]

First, install [nodejs](https://nodejs.org/en/download/) on your computer (e.g. your PC or your Raspberry Pi).

Then install **[thing-it-node]** via

```
npm install -g thing-it-node
```
 
### Initialization and Start of [thing-it-node] 

The **[thing-it-device-enocean-ip]** Plugin is installed with **[thing-it-node]**, hence there is no need to install it separately.

The Plugin supports Autodiscovery, hence you only have to create a directory in which you intend to run the configuration, e.g.
 
```
mkdir ~/enocean-test
cd ~/enocean-test
```

and invoke

```
tin init
```

and then start **[thing-it-node]** via

```
tin run
```

Install the **[thing-it] Mobile App** from the Apple Appstore or Google Play and set it up to connect to **[thing-it-node]** 
locally as described [here](https://thing-it.com/thing-it/#/documentationPanel/mobileClient/connectionModes) or just connect your browser under 
[http://localhost:3001](http://localhost:3001).
 
### EnOcean Device Setup

Connect your EnOcean Gateway to an IP network reachable from the **[thing-it-node]** Gateway you have configured above 
and connect/pair all EnOcean Devices to it.

As Auto-discovery is not in place yet, you will have to configure the connected Devices manually as e.g. in the [sample configuration]("./examples.configuration").

## Mobile UI

The following screenshot shows the Devices in [sample configuration]("./examples.configuration"):

<a href="./documentation/images/mobile-ui.png"><img src="./documentation/images/mobile-ui.png" width="50%" height="50%"></a>

## Gateway Simulator

This Plugin also contains a simulator to simulate EnOcean IP Gateways. To run the simulator invoke

```
node gatewaySimulator
```

in the **server** subdirectory which simulates a Gateway connected to the Devices in the [sample configuration]("./examples.configuration").

## Where to go from here ...

After completing the above, you may be interested in

* Connecting additional [Devices](https://www.thing-it.com/thing-it/#/documentationPanel/mobileClient/deviceConfiguration) and configuring
[Groups](https://www.thing-it.com/thing-it/#/documentationPanel/mobileClient/groupConfiguration), 
[Services](https://www.thing-it.com/thing-it/#/documentationPanel/mobileClient/serviceConfiguration), 
[Event Processing](https://www.thing-it.com/thing-it/#/documentationPanel/mobileClient/eventConfiguration), 
[Storyboards](https://www.thing-it.com/thing-it/#/documentationPanel/mobileClient/storyboardConfiguration) and 
[Jobs](https://www.thing-it.com/thing-it/#/documentationPanel/mobileClient/jobConfiguration) via your **[thing-it] Mobile App**.
* Use [thing-it.com](https://www.thing-it.com) to safely connect your Gateway Computer from everywhere, manage complex configurations, store and analyze historical data 
* Explore other Device Plugins like [Texas Instruments Sensor Tag](https://www.npmjs.com/package/thing-it-device-ti-sensortag), [Philips Hue Lighting](https://www.npmjs.com/package/thing-it-device-philips-hue) and many more. For a full set of 
Device Plugins search for **thing-it-device** on [npm](https://www.npmjs.com/). Or [write your own Plugins](https://github.com/marcgille/thing-it-node/wiki/Plugin-Development-Concepts).