README

n8n-nodes-deconz

Provides n8n node implementation to enables communicating with dresden elektronik deCONZ gateway. It allows you to query as well set state such as on/off, set the brightness on devices and get information on devices.

Supported Nodes

Trigger Node to read lights and sensors data
- Read (near) real-time feedback from devices like lights, groups, switches, and sensors
Node to monitor and control single resource
- Get light state
- Set light state
- Get sensor state

Prerequisites

You need a deCONZ gateway to connect n8n to your ZigBee lights, switches, and sensors.

Installation

To use a n8n-nodes-deconz, it needs to be installed within n8n. For example like this

# Install n8n
npm install n8n

# Navigate to the n8n installed directory. The full path might vary on different system
cd /usr/local/lib/node_modules/n8n

# Install n8n-nodes-deconz
npm install n8n-nodes-deconz

# Start n8n
n8n

Next step is to create an API key to access deCONZ. This key is required to monitor and control resources. Go to Settings → Gateway → Advanced → Authenticate app in the Phoscon App and then use the deCONZ node in n8n (Type: Configuration, Configuration: Get API key) to retrieve the new API key. Since I have not figured out how to programmatically save API key to credentials, you will need to copy the output of this node to the credential.

Alternative, you can retrieve the API key from the console.

curl -d '{"devicetype": "n8n-test"}' -H "Content-Type: application/json" -X POST -s http://<deconz_host>:80/api/

Development/Testing

# Build the code
npm run build

# "Publish" the package locally
npm link

# "Install" the above locally published module
npm link n8n-nodes-deconz

# Start n8n
n8n

Contribution

To make this node even better, please let me know. Commits are always welcome.

Issues

If you have any issues, please let me know on GitHub.

Usage no npm install needed!