KNX and Clickhouse Integration

Input and output integration overview

The KNX plugin listens for messages from the KNX home-automation bus via a KNX-IP interface, allowing for real-time data integration from KNX-enabled devices.

Telegraf’s SQL plugin sends collected metrics to an SQL database using a straightforward table schema and dynamic column generation. When configured for ClickHouse, it adjusts DSN formatting and type conversion settings to ensure seamless data integration.

Integration details

KNX

The KNX plugin allows for the listening to messages transmitted over the KNX home-automation bus. It establishes a connection with the KNX bus through a KNX-IP interface, making it compatible with various message datapoint types that KNX employs. The plugin supports service input configuration, wherein it remains active to listen for relevant metrics or events rather than relying solely on scheduled intervals. This inherent characteristic enables real-time data capture from the KNX systems, enhancing automation and integration possibilities for building management and smart home applications. Additionally, this plugin is designed to handle multiple measurements from the KNX data, allowing for a flexible categorization of metrics based on the derived datapoint types, thus broadening the scope of data integration in smart environments.

Clickhouse

Telegraf’s SQL plugin is engineered to write metric data into an SQL database by dynamically creating tables and columns based on incoming metrics. When configured for ClickHouse, it utilizes the clickhouse-go v1.5.4 driver, which employs a unique DSN format and a set of specialized type conversion rules to map Telegraf’s data types directly to ClickHouse’s native types. This approach ensures optimal storage and retrieval performance in high-throughput environments, making it well-suited for real-time analytics and large-scale data warehousing. The dynamic schema creation and precise type mapping enable detailed time-series data logging, crucial for monitoring modern, distributed systems.

Configuration

KNX

[[inputs.knx_listener]]
  ## Type of KNX-IP interface.
  ## Can be either "tunnel_udp", "tunnel_tcp", "tunnel" (alias for tunnel_udp) or "router".
  # service_type = "tunnel"

  ## Address of the KNX-IP interface.
  service_address = "localhost:3671"

  ## Measurement definition(s)
  # [[inputs.knx_listener.measurement]]
  #   ## Name of the measurement
  #   name = "temperature"
  #   ## Datapoint-Type (DPT) of the KNX messages
  #   dpt = "9.001"
  #   ## Use the string representation instead of the numerical value for the
  #   ## datapoint-type and the addresses below
  #   # as_string = false
  #   ## List of Group-Addresses (GAs) assigned to the measurement
  #   addresses = ["5/5/1"]

  # [[inputs.knx_listener.measurement]]
  #   name = "illumination"
  #   dpt = "9.004"
  #   addresses = ["5/5/3"]

Clickhouse

[[outputs.sql]]
  ## Database driver
  ## Valid options include mssql, mysql, pgx, sqlite, snowflake, clickhouse
  driver = "clickhouse"

  ## Data source name
  ## For ClickHouse, the DSN follows the clickhouse-go v1.5.4 format.
  ## Example DSN: "tcp://localhost:9000?debug=true"
  data_source_name = "tcp://localhost:9000?debug=true"

  ## Timestamp column name
  timestamp_column = "timestamp"

  ## Table creation template
  ## Available template variables:
  ##  {TABLE}        - table name as a quoted identifier
  ##  {TABLELITERAL} - table name as a quoted string literal
  ##  {COLUMNS}      - column definitions (list of quoted identifiers and types)
  table_template = "CREATE TABLE {TABLE} ({COLUMNS})"

  ## Table existence check template
  ## Available template variables:
  ##  {TABLE} - table name as a quoted identifier
  table_exists_template = "SELECT 1 FROM {TABLE} LIMIT 1"

  ## Initialization SQL (optional)
  init_sql = ""

  ## Maximum amount of time a connection may be idle. "0s" means connections are never closed due to idle time.
  connection_max_idle_time = "0s"

  ## Maximum amount of time a connection may be reused. "0s" means connections are never closed due to age.
  connection_max_lifetime = "0s"

  ## Maximum number of connections in the idle connection pool. 0 means unlimited.
  connection_max_idle = 2

  ## Maximum number of open connections to the database. 0 means unlimited.
  connection_max_open = 0

  ## Metric type to SQL type conversion for ClickHouse.
  ## The conversion maps Telegraf metric types to ClickHouse native data types.
  [outputs.sql.convert]
    conversion_style = "literal"
    integer          = "Int64"
    text             = "String"
    timestamp        = "DateTime"
    defaultvalue     = "String"
    unsigned         = "UInt64"
    bool             = "UInt8"
    real             = "Float64"

Input and output integration examples

KNX

1. Smart Home Energy Monitoring: Utilize the KNX plugin to monitor energy consumption across various devices in a smart home setup. By configuring measurements for different appliances, users can gather real-time data on power usage, enabling them to optimize energy consumption and reduce costs. This setup can also integrate with visualization tools to provide insights into energy trends and usage patterns.

2. Automated Lighting Control System: Leverage this plugin to listen for lighting status updates from KNX sensors in a building. By capturing measurements related to illumination, users can develop an automated lighting control system that adjusts the brightness based on the time of day or occupancy, enhancing comfort and energy efficiency.

3. HVAC Performance Tracking: Implement the KNX plugin to track temperature and ventilation data across different zones in a building. By monitoring these metrics, facilities managers can identify trends in HVAC performance, optimize climate control strategies, and proactively address maintenance needs to ensure consistent environmental quality.

4. Integrated Security Solutions: Use the plugin to capture data from KNX security sensors, such as door/window open/close statuses. This information can be routed into a central monitoring system, providing real-time alerts and enabling automated responses, such as locking doors or activating alarms, thus enhancing the building’s security posture.

Clickhouse

1. Real-Time Analytics for High-Volume Data: Use the plugin to feed streaming metrics from large-scale systems into ClickHouse. This setup supports ultra-fast query performance and near real-time analytics, ideal for monitoring high-traffic applications.

2. Time-Series Data Warehousing: Integrate the plugin with ClickHouse to create a robust time-series data warehouse. This use case allows organizations to store detailed historical metrics and perform complex queries for trend analysis and capacity planning.

3. Scalable Monitoring in Distributed Environments: Leverage the plugin to dynamically create tables per metric type in ClickHouse, making it easier to manage and query data from a multitude of distributed systems without prior schema definitions.

4. Optimized Storage for IoT Deployments: Deploy the plugin to ingest data from IoT sensors into ClickHouse. Its efficient schema creation and native type mapping facilitate the handling of massive volumes of data, enabling real-time monitoring and predictive maintenance.

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.