Phillips Hue Bridge and Clickhouse Integration

Input and output integration overview

This plugin gathers status from Hue Bridge devices using the CLIP API interface.

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

Phillips Hue Bridge

The Hue Bridge plugin allows users to gather real-time status from Philips Hue Bridge devices utilizing the CLIP API interface. By communicating with Hue Bridges, this plugin is capable of retrieving various metrics related to home lighting and environmental conditions. It offers multiple schemes for accessing the bridges, such as local LAN, cloud, and mDNS, ensuring flexibility in deployment scenarios. The plugin can handle diverse configurations such as room assignments for devices, which optimizes the evaluation of statuses, especially in environments with many devices. Furthermore, it provides various monitoring metrics applicable to lights, temperature sensors, motion sensors, and device power status, thereby enabling comprehensive insights into a smart home setup. The configuration options allow users to tailor their connections to optimize performance and security, including optional TLS configurations for secure communication.

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

Phillips Hue Bridge

[[inputs.huebridge]]
  ## URL of bridges to query in the form ://:@
/
  ## See documentation for available schemes.
  bridges = [ "address://:@/" ]

  ## Manual device to room assignments to apply during status evaluation.
  ## E.g. for motion sensors which are reported without a room assignment.
  # room_assignments = { "Motion sensor 1" = "Living room", "Motion sensor 2" = "Corridor" }

  ## Timeout for gathering information
  # timeout = "10s"

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  # tls_key_pwd = "secret"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false
</code></pre>

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

Phillips Hue Bridge

1. Automated Lighting Control Based on Room Occupancy: Utilize the Hue Bridge plugin to monitor motion sensors within various rooms of a home. When motion is detected, the system can automatically trigger the lights to turn on, providing convenience and energy efficiency. This integration could significantly enhance user experience and preferences, adapting the lighting to occupancy levels without manual intervention.

2. Environmental Monitoring in Smart Homes: Implement the Hue Bridge plugin to track temperature and light levels within the house. By continuously monitoring these metrics, users can create a comfortable indoor climate, adjusting heating and cooling systems based on temperature trends or activating lights based on light levels detected. This data-driven approach leads to smart home automation that responds to actual environmental conditions.

3. Integration with Home Automation Systems: Leverage this plugin to integrate Philips Hue Bridge statistics into broader home automation frameworks. For example, collecting light and temperature data can feed into a centralized dashboard that provides homeowners with insights about their energy usage patterns. Environments can be programmed to respond proactively to user habits, promoting efficiency and energy conservation.

4. Battery Monitoring for Smart Devices: Use the Hue Bridge plugin to monitor battery levels across various connected smart devices. By being alerted about low battery states, homeowners can take timely actions to replace or recharge devices, preventing outages and ensuring smooth operation of their smart home systems.

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.