Illuminance Sensor

Creates a sensor entity that estimates outdoor illuminance based on either sun elevation or time of day. In either case, the value is adjusted based on current weather conditions obtained from another, existing entity.

Modes of operation

Two modes are available: normal & simple.

Normal mode - Sun elevation

This mode uses an algorithm from the US Naval Observatory¹ for estimating sun illuminance based on the sun's elevation (aka altitude.) The maximum value is about 150,000 lx. Below is an example of what that might look like over a three day period.

Simple mode - Time of day

At night the value is 10 lx. From a little before sunrise to a little after the value is ramped up to whatever the current conditions indicate. The same happens around sunset, except the value is ramped down. The maximum value is 10,000 lx. Below is an example of what that might look like over a three day period.

Supported weather sources

Any weather entity that uses the standard list of conditions, or that provides a cloud coverage percentage, should work with this integration. The following sources of weather data are known to be supported:

Installation

With HACS

You can use HACS to manage the installation and provide update notifications.

1. Add this repo as a custom repository:

https://github.com/pnbruckner/ha-illuminance

2. Install the integration using the appropriate button on the HACS Integrations page. Search for "illuminance".

Manual

Place a copy of the files from custom_components/illuminance in <config>/custom_components/illuminance, where <config> is your Home Assistant configuration directory.

NOTE: When downloading, make sure to use the Raw button from each file's page.

Versions

This custom integration supports HomeAssistant versions 2023.4.0 or newer.

Services

illuminance.reload

Reloads Illuminance from the YAML-configuration. Also adds ILLUMINANCE to the Developers Tools -> YAML page.

Configuration variables

A list of configuration options for one or more sensors. Each sensor is defined by the following options.

Note: This defines configuration via YAML. However, the same sensors can be added in the UI.

Converting from platform configuration

In previous versions, configuration was done under sensor. This is now deprecated and will generate a warning at startup. It should be converted to the new illuminance format as described above. Or simply remove it and add the sensor(s) via the UI.

Here is an example of the old format:

sensor:
  - platform: illuminance
    entity_id: weather.home_forecast
    fallback: 5
    mode: normal
    name: Weather-Based Sun Illuminance
    scan_interval:
      minutes: 10

This is the equivalent configuration in the new format:

illuminance:
  - unique_id: 1
    entity_id: weather.home_forecast
    fallback: 5
    mode: normal
    name: Weather-Based Sun Illuminance
    scan_interval:
      minutes: 10

Releases Before 2.1.0

See https://github.com/pnbruckner/homeassistant-config/blob/master/docs/illuminance.md.