User Guide: KNX Agent
Pierre Kil edited this page May 31, 2021
·
8 revisions
Home
User Guide
Deploying
Manager UI
Assets & Attributes
Agents/Protocols
- Overview
- Bluetooth Mesh
- HTTP
- KNX
- LoRa
- MQTT
- Simulator
- SNMP
- Serial
- TCP
- UDP
- Velbus
- Websocket
- Z-Wave
- Partner Integrations
Disabled Protocols
Manager APIs
Rules & forecasting
Identity & Security
Gateways & Devices
- OpenRemote as Edge Gateway
- Auto provisioning devices and users
- Connect ESP32 or ESP8266 using MQTT
- Firmware updating with Hawkbit
- Partner Integrations
Tutorials
- Weather data using HTTP Agent
- Connect Your MQTT Client
- ChirpStack LoRaWAN Integration
- Celcius to Fahrenheit with Flow
- Configure mobile app behaviour
- Simulating data in attribute
- Create an Energy Management System
Developer Guide
- Preparing the environment
- Installing and using Docker
- Setting up an IDE
- Building and testing
- Working on UI and apps
- Working on maps
- Docker compose profiles
- Creating a custom project
- Maintaining an installation
- Adding Widgets on Insights
- Working on the mobile consoles
- Connecting Protocol adaptors with Agents
- Edge device firmware updating
- Licensing guidelines for contributors
- Useful commands and queries
- Data migration
Architecture
Clone this wiki locally
Connect to a KNX network via a KNX IP Interface/Router.
Agent configuration
The following describes the supported agent configuration attributes:
Attribute | Description | Value type | Required |
---|---|---|---|
host |
IP Interface/Router hostname or IP address | Hostname or IP address | Y |
port |
IP Interface/Router port | Port number | N |
NATMode |
Enable NAT mode | Boolean | N (Default = false ) |
routingMode |
Enable Routing mode | Boolean | N (Default = false ) |
messageSourceAddress |
Source group address | Text (KNX Group Address e.g. 1.1.1 ) |
N (Default = 0.0.0 ) |
Agent link
For attributes linked to this agent, the following describes the supported agent link fields which are in addition to the standard Agent Link fields:
Field | Description | Value type | Required |
---|---|---|---|
type |
Agent type | Text (Must be KNXAgentLink ) |
Y |
dpt |
The DPT (data point type) of the group address | Text (DPT e.g. 1.001 ) |
Y |
actionGroupAddress |
Group address for attribute write | Text (KNX Group Address e.g. 1.1.1 ) |
N (Default = 0.0.0 ) |
statusGroupAddress |
Group address for attribute read | Text (KNX Group Address e.g. 1.1.1 ) |
N (Default = 0.0.0 ) |
Discovery and Import
To understand discovery and import refer to Agent and Asset Discovery/Import. This protocol supports the following:
- Protocol Asset Import (
*.knxproj
)
Each group address in the project file will create a new asset with a single attribute also with the same name (no spaces in attribute name), the attribute type is determined by the following naming convention:
- Group Address ends with #A - Actuator (executable attribute)
- Group Address ends with #S - Sensor (read only)
- Group Address ends with #SA or #AS - Actuator and sensor
Only group addresses using this convention will be imported