Registry / iot / node-red-contrib-loxone

node-red-contrib-loxone

library0.10.13jsnpmunverified

A Node-RED package that connects to Loxone Miniserver via Websocket API, providing nodes for event-driven control and monitoring. Current stable version is 0.10.13. It relies on the underlying node-lox-ws-api library and supports token-based authentication for Loxone V9+. Key differentiators: direct websocket integration with no abstraction layer, multiple node types (Control-In, Control-Out, Webservice, Stream-In, Stream-All, Online, Keepalive), and full access to miniserver structure file data.

iot

npm install node-red-contrib-loxone

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · NODE-RED-CONTRIB-L

node-red-contrib-loxone

iotjavascriptv0.10.13

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Miniserver

✓ import Miniserver from 'node-red-contrib-loxone'; // Not applicable as it's a Node-RED plugin

✗ const { Miniserver } = require('node-red-contrib-loxone'); // Does not export symbols directly

This package provides Node-RED nodes, not programmable exports. Install via Node-RED palette manager or npm, then configure in flows.

Control-In

✓ npm install node-red-contrib-loxone # Then add 'loxone miniserver' and 'loxone control-in' nodes in Node-RED

✗ require('node-red-contrib-loxone').ControlIn; // No such export

Nodes are registered automatically on install. Use the Node-RED editor to drag and configure.

Control-Out

✓ npm install node-red-contrib-loxone # Then add 'loxone control-out' node

✗ import { ControlOut } from 'node-red-contrib-loxone'; // No such export

Nodes are added via the Node-RED palette. No JavaScript imports; all configuration is GUI-based.

Shows how to install and configure Loxone Miniserver and Control-In nodes in Node-RED using the palette manager or CLI.

// No programmatic usage; install via Node-RED palette manager or CLI: // npm install node-red-contrib-loxone // Then in Node-RED, add a 'loxone miniserver' node, configure host/port/auth. // Connect 'loxone control-in' node to it, select control and state. // Connect output to debug or function node. // Example flow JSON: [{"id":"1","type":"loxone miniserver","name":"My Miniserver","host":"192.168.1.100","port":8080,"authtype":"token"},{"id":"2","type":"loxone control-in","name":"Light","server":"1","control":"","state":"active"}]

Debug

Known issues

breakingVersion 0.10.4+ requires git command installed on the system to fetch node-lox-ws-api from GitHub; otherwise you get 'undefined ls-remote' error

fix

Install git (e.g., 'apt-get install git' on Debian/Ubuntu, 'brew install git' on macOS) before npm install

affects: >=0.10.4

deprecatedAES-256-CBC and Hash authentication methods are deprecated for Loxone V9+; use token-based authentication

fix

Set authtype to 'token' in miniserver node configuration and provide valid token credentials

affects: >=V9

gotchaStream-All node emits EVERY event from miniserver, which can cause performance issues if not used carefully

fix

Use with caution; prefer Stream-In with room/category filters to reduce event load

affects: all

gotchaOnline node emits 'false' repeatedly on each failed connection attempt until connection is established

fix

Consider adding a debounce or throttle in downstream logic to avoid flooding on connection failures

affects: all

gotchamsg.payload contains raw data from Loxone websocket without abstraction; must handle according to structure file format

fix

Refer to Loxone structure file documentation to parse control IDs and states correctly

affects: all

Errors

Common errors & fixes

undefined ls-remote

Git command not installed; node-lox-ws-api is fetched from GitHub during npm install

fix

Install git on your system, then re-run npm install

Error: connect ECONNREFUSED 192.168.1.100:8080

Miniserver host/port incorrect or unreachable

fix

Verify miniserver IP and port in node configuration, ensure network connectivity

Error: Invalid authentication type

Using old auth method (AES/Hash) with Loxone V9+ or token when not supported

fix

Update authtype in miniserver config to match your Loxone version (token for V9+, AES/Hash for older)

TypeError: Cannot read property 'length' of undefined

Structure file not loaded or empty; miniserver not yet connected

fix

Ensure miniserver node is connected and structure file is retrieved (check Loxone config web service URL)

Upgrade

Version history

0.10.13latest on npm

Audit

Dependencies

node-lox-ws-apirequiredCore library for Loxone Miniserver WebSocket communication; pulled from GitHub at install time

gitrequiredRequired system dependency for pulling node-lox-ws-api from GitHub during npm install

Agent activity

19 hits · last 30 days

node

Resources

githubhttps://github.com/codmpm/node-red-contrib-loxone ↗

packagenode-red-contrib-loxone ↗

homepagehttps://github.com/codmpm/node-red-contrib-loxone#readme ↗