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.
Two modes are available: normal & simple.
This mode uses an algorithm from the US Naval Observatory1 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.
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.
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:
| Integration | Notes |
|---|---|
| AccuWeather | weather |
| Buienradar Sensor | Condition sensor |
| ecobee | |
| Meteorologisk institutt (Met.no) | weather |
| OpenWeatherMap | weather; cloud_coverage & condition sensor |
You can use HACS to manage the installation and provide update notifications.
- Add this repo as a custom repository:
https://github.com/pnbruckner/ha-illuminance
- Install the integration using the appropriate button on the HACS Integrations page. Search for "illuminance".
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
Rawbutton from each file's page.
This custom integration supports HomeAssistant versions 2023.4.0 or newer.
Reloads Illuminance from the YAML-configuration. Also adds ILLUMINANCE to the Developers Tools -> YAML page.
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.
| Key | Optional | Description |
|---|---|---|
unique_id |
no | Unique identifier for sensor. This allows any of the remaining options to be changed without looking like a new sensor. (Only required for YAML-based configuration.) |
entity_id |
no | Entity ID of another entity that indicates current weather conditions |
fallback |
yes | Illuminance divisor to use when weather data is not available. Must be in the range of 1 (clear) through 10 (dark.) Default is 10. |
mode |
yes | Mode of operation. Choices are normal (default) which uses sun elevation, and simple which uses time of day. |
name |
yes | Name of the sensor. Default is Illuminance. |
scan_interval |
yes | Update interval. Minimum is 5 minutes. Default is 5 minutes. |
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: 10This 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: 10See https://github.com/pnbruckner/homeassistant-config/blob/master/docs/illuminance.md.
Footnotes
-
Janiczek, P. M., and DeYoung, J. A. Computer Programs for Sun and Moon Illuminance With Contingent Tables and Diagrams. Circular No. 171. Washington, D. C.: United States Naval Observatory, 1987 Google Scholar ↩