OpenUV


The openuv component displays UV and Ozone data from openuv.io.

Generating an API Key

To generate an API key, simply log in to the OpenUV website.

The “Limited” plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the openuv component queries the API every 30 minutes by default. This value can be modifed (via the scan_interval key), but please note that over-running the API will require you to upgrade to a paid plan (and may disable your access in the meantime).

Configuration

To retrieve data from OpenUV, add the following to your configuration.yaml file:

openuv:
  api_key: YOUR_OPENUV_API_KEY

Configuration Variables

api_key

(string)(Required)The OpenUV API key.

scan_interval

(integer)(Optional)the frequency (in seconds) between data updates.

Default value: 1800

binary_sensors

(map)(Optional)The binary sensor-related configuration options.

monitored_conditions

(list)(Optional)The conditions to create sensors from.

Default value: all

uv_protection_window

Displays if UV protection (sunscreen, etc.) is recommended at the current date and time.

sensors

(map)(Optional)The sensor-related configuration options.

monitored_conditions

(list)(Optional)The conditions to create sensors from.

Default value: all

current_ozone_level

The current ozone level in du (Dobson Units).

current_uv_index

The current UV index.

current_uv_level

The level of current UV index, which is calculated based on UV Index Levels & Colors.

max_uv_index

The maximum UV index that will be encountered that day (at solar noon).

safe_exposure_time_type_1

The approximate exposure time for skin type I.

safe_exposure_time_type_2

The approximate exposure time for skin type II.

safe_exposure_time_type_3

The approximate exposure time for skin type III.

safe_exposure_time_type_4

The approximate exposure time for skin type IV.

safe_exposure_time_type_5

The approximate exposure time for skin type V.

safe_exposure_time_type_6

The approximate exposure time for skin type VI.

The approximate number of minutes of a particular skin type can be exposed to the sun before burning/tanning starts is based on the Fitzpatrick scale.

Full example

To configure additional functionality, add configuration options beneath a binary_sensor and/or sensor key within the openuv section of the configuration.yaml file as below:

openuv:
  api_key: YOUR_OPENUV_API_KEY
  binary_sensors:
    monitored_conditions:
      - uv_protection_window
  sensors:
    monitored_conditions:
      - current_ozone_level
      - current_uv_index
      - current_uv_level
      - max_uv_index
      - safe_exposure_time_type_1
      - safe_exposure_time_type_2
      - safe_exposure_time_type_3
      - safe_exposure_time_type_4
      - safe_exposure_time_type_5
      - safe_exposure_time_type_6

The above guidelines constitute estimates and are intended to help informed decision making. They should not replace analysis, advice or diagnosis from a trained medical professional.