Skip to content

Latest commit

 

History

History
61 lines (49 loc) · 2.77 KB

README.md

File metadata and controls

61 lines (49 loc) · 2.77 KB

Camera Lux

Camera Lux is a custom Home Assistant integration that utilizes camera feeds to estimate ambient light levels (lux) in your environment. By analyzing images from your cameras, cameralux provides virtual lux readings that can be used to automate lighting, monitor lighting conditions, and enhance your smart home setup.

Features

  • Real-Time Lux Monitoring: Continuously estimate ambient light levels using your existing cameras.
  • Configurable Update Intervals: Customize how frequently each sensor updates its lux readings.
  • Region of Interest (ROI): Focus on specific areas within the camera's field of view for more accurate measurements.
  • Calibration Factor: Scale luminance to lux calculations to better align with real-world lighting conditions.
  • Compatibility: Works with any camera integrated into Home Assistant, supporting both camera entities and direct image URLs.

Configuration Parameters

  • entity_id: The camera entity from which to fetch images.
  • image_url (optional): Direct HTTP URL pointing to an image file (e.g., JPEG, PNG).
  • update_interval (optional): Seconds between updates. Default is 30 seconds.
  • brightness_roi (optional): Defines a rectangular region within the image for focused brightness assessment.
    • x: The x-coordinate of the top-left corner of the ROI.
    • y: The y-coordinate of the top-left corner of the ROI.
    • width: The width of the ROI.
    • height: The height of the ROI.
  • calibration_factor (optional): A float value to calibrate the percieved luminance to lux. Defaults to 2000 if not specified.

Note: Each sensor must have either entity_id or image_url configured, but not both.

Example Configuration

Add the following to your configuration.yaml:

sensor:
  - platform: cameralux
    sensors:
      Office Wallpanel lux:
        entity_id: camera.rtsp_office_wallpanel
        calibration_factor: 1250
        update_interval: 30  # Updates every 30 seconds
        brightness_roi:
          x: 100
          y: 150
          width: 200
          height: 100
      Kitchen Image lux:
        image_url: https://your-domain.com/images/kitchen.jpg
        calibration_factor: 500
        update_interval: 45  # Updates every 45 seconds

Installation

  1. Using HACS (Recommended):

    • Open Home Assistant.
    • Navigate to HACS > Integrations.
    • Click on the "+" button.
    • Search for "Camera Lux Sensor" and install it.

  2. Manual Installation:

    • Download the cameralux repository from GitHub.
    • Place the cameralux folder inside your custom_components directory.
    • Restart Home Assistant.