DOCSEARCHbyAlgolia
Submit Docs

KNX Ultimate for Node-RED

repository·main·Indexed 41 days ago

https://github.com/supergiovane/node-red-contrib-knx-ultimate

A comprehensive Node-RED integration for KNX/IP and KNX Secure (version 8.0.1). It features ETS project import, routing, diagnostics, virtual devices, and automation utilities. The palette includes specialized nodes such as KNX Device, KNX Utility, KNX Viewer, KNX IoT Bridge, KNX Multi Routing, and KNX Router Filter. It provides native integration paths for Philips Hue, Matter, and AI-driven control via complementary packages.

Tokens
221.5K
Snippets
341
Records
948
Agent score
46%

What's inside KNX Ultimate

  1. Overview of KNX Ultimate features

    main

    KNX Ultimate is a Node-RED palette for KNX/IP and KNX Secure communication. It supports ETS project import, routing, diagnostics, virtual devices, and automation utilities.

    The available nodes in the palette include:

    • KNX Device
    • KNX Utility
    • KNX Viewer
    • KNX IoT Bridge
    • KNX Multi Routing
    • KNX Router Filter

  2. Overview of HUE Controller capabilities

    main

    The HUE Controller is a unified Node-RED node that consolidates 15 different Hue device functions into a single interface. It uses the Hue API v2 and provides optional seamless integration with KNX.

    Key functional categories include:

    • Lighting & Power: Lights, light groups, and plugs (on/off, dimming, color temperature, RGB/HSV, effects, presets, and bidirectional feedback).
    • Scenes & Controllers: Scenes, buttons, and Tap dials (DPT 1/18 mapping, long/short press, rotation events).
    • Presence & Security: Motion sensors (motion, area motion, camera motion) and contact sensors.
    • Environment: Light level, temperature, and humidity sensors mapped to KNX data points.
    • Device Health: Battery levels, Zigbee connectivity, and software update availability.

  3. Overview of HUE Controller

    main

    The HUE Controller is a unified Node-RED node that consolidates all previous dedicated Hue nodes into a single, autonomous node. It uses the Hue API v2 to interact with native resources.

    Key features include:

    • Device-Oriented Selection: Choose a Hue device or resource, and the node automatically detects its type and adapts the editor, KNX mappings, and flow ports.
    • 15 Device Functions: Covers lighting (on/off, dimming, RGB, effects), scenes, buttons, motion sensors, environmental sensors (light, temp, humidity), and device health (battery, Zigbee connectivity, software updates).
    • Optional KNX Integration: Allows mapping Hue commands and states to KNX group addresses (GA) and DPTs, or can be used as a standalone Hue–Node-RED integration by setting the KNX gateway to none.

  4. Overview of the HUE Controller node

    main

    The HUE Controller is a unified Node-RED node that consolidates fifteen previously separate Hue-specific nodes into a single, maintained interface. It uses the Hue API v2 to interact with native resources and provides optional integration with KNX via a gateway.

    Key Capabilities

    • Lighting & Power: Control lights (individual or grouped) and plugs. Supports On/Off, dimming (relative/absolute), tunable white, RGB/HSV, effects, day/night presets, and power control with bidirectional feedback.
    • Scenes & Controls: Manage scenes, buttons, and tap dials (rotary controls) with support for short/long/repeat presses and rotary events.
    • Presence & Security: Monitor motion (device, area, or camera) and contact sensors (open/closed states).
    • Environment: Access sensor readings for light levels, temperature, and humidity.
    • Device Health: Monitor battery percentage, Zigbee connectivity, and software update availability.

    Core Features

    • Automatic Type Detection: Selecting a Hue device automatically configures the editor, KNX mappings, and Node-RED flow pins based on the device's capabilities.
    • KNX Integration: Map Hue commands and statuses to KNX Group Addresses (GA) or ETS names. If no KNX gateway is selected (none), the node functions as a pure Hue-to-Node-RED integration.

  5. Understand the KNX Utility node functions

    main

    The KNX Utility node is a multi-purpose palette node that consolidates eleven different KNX helper functions into a single node type. The specific settings, icon, and flow ports (inputs/outputs) change based on the Function you select within the node configuration.

    Available Functions

    FunctionPurposeInputs / Outputs
    AlerterReport alerted devices individually, together, or as the most recent alert.1 / 3
    AutoResponderAnswer KNX group read requests using configured or previously received values.0 / 0
    DateTimeSend the current date and time using DPT 19.001, 11.001, and 10.001.0 / 0
    WatchDogMonitor the gateway or a KNX device and report connection problems.1 / 1
    Global ContextShare KNX values through the configured Node-RED global context store.0 / 0
    LoggerRecord bus telegrams as ETS-compatible XML and count traffic.1 / 2
    StaircaseControl timed staircase lighting with status, override, and pre-warning options.1 / 1
    GarageManage garage commands, impulse control, safety inputs, and automatic closing.1 / 1
    Scene ControllerRecall, record, and store scenes with configurable group addresses and values.1 / 1
    Load ControlShed and restore configured loads according to power consumption and limits.1 / 1
    Home Assistant TranslatorTranslate Home Assistant state strings to boolean values.1 / 1

    Special Function Behaviors

    • AutoResponder and Global Context: These work directly with the KNX bus and Node-RED context and have no flow ports (0/0).
    • DateTime: Uses scheduled sends and a canvas button; it has no flow input or output (0/0).
    • Home Assistant Translator: Does not require a KNX gateway. You configure a message property to translate (e.g., payload or data.new_state.state) and define mappings (e.g., open:true and closed:false). It outputs the translated boolean in msg.payload.

  6. Security Policy and Liability Disclaimer

    main

    The node-red-contrib-knx-ultimate repository is intended only as an automation aid. Users must recognize that home automation involves significant risks, such as fire hazards (e.g., lights left on) or physical injury (e.g., garage doors closing on people/animals).

    Key Safety Principles:

    • Primary Concern: Building safety must always be the priority.
    • Certified Hardware: Use KNX-Ultimate only to control actuators that have been secured by other certified mechanical or electronic means (e.g., a garage door should have its own certified safety system).
    • Liability: The developers of this project are not responsible for any damages. All usage is governed by the MIT License.

  7. Use the HUE Scene node to publish Hue scenes to KNX

    main

    The HUE Scene node allows you to publish Philips Hue scenes to your KNX bus and forward raw Hue events to your Node-RED flow.

    Key Features:

    • Autocomplete: The Scena HUE field supports autocomplete for available scenes.
    • Refresh Catalog: If you create new scenes on your Hue Bridge, click the refresh icon in the node editor to reload the list.
    • Output Behavior: The output pin can be shown or hidden via the Comportamento tab. Even without a configured KNX gateway, the output pin remains active so Hue events can still reach your Node-RED flow.

  8. Security Policy and Safety Guidelines for KNX-Ultimate

    main

    Safety Warning

    KNX-Ultimate is an automation aid and should not be used as the primary safety mechanism for critical systems. The developer is not liable for damages as per the MIT License.

    Core Safety Principles

    • Use Certified Hardware: Only use KNX-Ultimate to control actuators that are already secured by other certified mechanical or electronic means. For example, a garage door should have a certified mechanical/electronic safety system to prevent injury to people or animals, regardless of the automation command.
    • Assume Failure: Always design your system assuming that automation might fail. Implement backups and redundant safety measures for all high-risk scenarios.
    • Avoid Single Points of Failure: Do not rely solely on software/networked commands for life-safety or property-protection tasks.

  9. Security Policy and Liability for KNX Ultimate

    main

    Using node-red-contrib-knx-ultimate to control a home or building involves inherent risks. A software bug or user error could lead to fire hazards (e.g., lights left on), physical injury (e.g., garage doors closing on people), or security breaches.

    Core Security Principles:

    • Building Security First: Always prioritize physical building security over automation convenience.
    • Use Certified Actuators: Use the KNX node only to control actuators that are already secured by other certified mechanical or electronic means. For example, a garage door should have a certified mechanical/electronic system to prevent injury or damage regardless of the KNX command.
    • Liability: The developers of node-red-contrib-knx-ultimate are not responsible for any damages. The project is provided under the MIT license.
    • Redundancy: Always implement a backup and, for critical safety/health risks, implement a double-safety backup system.

  10. Use the HUE Plug / Outlet node

    main

    The Hue Plug / Outlet node links a Philips Hue smart plug (service plug) with KNX group addresses. It allows you to control the plug's power and track its state directly from the KNX BUS.

    Note: This node is deprecated. For new projects, use the HUE Controller instead. The HUE Plug node is maintained for existing flows and is marked (deprecated) in the palette. A migration tool is available within the node editor to convert legacy nodes to the new controller format.

  11. What is the KNX Utility node?

    main

    The KNX Utility node is a multi-purpose palette node that consolidates eleven distinct KNX helper functions into a single node type. Instead of having eleven separate nodes in your palette, you drag one KNX Utility node into your flow and select the specific function you need from its configuration settings.

    Note: The KNX Utility node is for specialized helper tasks. For standard sending and receiving of KNX telegrams, you should continue to use the KNX Device (KNXUltimate) node.

    Key characteristics:

    • Selecting a function dynamically changes the node's icon, configuration settings, and available input/output ports.
    • Some functions (like AutoResponder and Global Context) interact directly with the bus or Node-RED context and may have no flow connections.
    • Other functions (like Staircase or Garage) act as logic controllers with specific input/output requirements.

  12. Understand Flood Protection and Loop Protection

    main

    KNX-Ultimate includes protections to prevent overloading the UI or the KNX bus:

    Flood Protection (Rate Limiting)

    To prevent UI/Bus overload, each node is limited to receiving a maximum of 120 messages per 1-second window.

    • Mitigation: Use a delay node to spread out messages or an RBE (Report by Exception) node to filter duplicate values.

    Loop Protection (Circular Reference)

    To prevent infinite loops, the system will disable connections where two nodes are connected directly via the same Group Address (Out $\rightarrow$ In).

    • Mitigation: Split the nodes in your flow, introduce a "buffer" node between them, or use an RBE node to prevent loops.