Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pedesen/node-red-contrib-pilight

Basic Node-RED nodes to receive configuration updates from pilight
https://github.com/pedesen/node-red-contrib-pilight

433mhz node-red pilight smarthome

Last synced: 11 days ago
JSON representation

Basic Node-RED nodes to receive configuration updates from pilight

Awesome Lists containing this project

README

        

# pilight bridge for Node-RED

Basic [Node-RED](https://nodered.org) nodes to receive configuration updates from [pilight](https://www.pilight.org/).

## Configure pilight

This pilight bridge is tested to work with pilight 7.0. First a configuration of pilight is needed to be able to communicate with its daemon. First set a fixed port in the settings section of the pilight configuration file `config.json`:

```
"settings": {
"port": 5000,
...
}
```

Then add your devices (RF switches etc.) to the device section of the config file ([more info](http://manual.pilight.org/configuration/devices.html)). pilight will send configuration updates via its API for these devices.

## Install via npm

In the terminal open the user data directory ˜/.node-red and install the package

```
cd ˜/.node-red
npm install node-red-contrib-pilight
```

Then run or restart Node-RED

```
node-red
```

Open your Node-RED instance, typically under http://localhost:1880, and you should see the new nodes available in the palette.

## Usage

Right now there is one node: `pilight-receive`. Its purpose it to receive configuration updates for devices defined in pilight. Every time a device changes its state (i.e. a switch was turned off) the pilight-receive node will receive an event for that.

If you want to use one or more `pilight-receive` nodes, just drag the node from the palette. The first thing to do is to define the host and port of pilight. Just double click on the node and add a new pilight daemon as shown below.

![Add pilight daemon](docs/pilight-daemon-1.png)

![Configure pilight daemon](docs/pilight-daemon-2.png)

After you deployed your flow, you should be connected to the pilight-daemon. You can check the logs in a terminal and should see something like `[pilight-receive:xxxxxxx.xxxxx] socket connection: success`.

You can connect a debug node to the pilight-receive node to check what is received from pilight. The events should look similar to this:

```javascript
{
origin: "update",
type: 1,
uuid: "0000-00-00-00-000000",
devices: {
0: "mySwitch"
},
values: {
timestamp: 1509835595,
state: "on"
}
}

```

You can add filters and functions in Node-RED to react on specific devices and states.

## License

This project is licensed under the MIT License - sees [LICENSE.md](LICENSE.md) file for details