home-assistant.io/source/_integrations/openuv.markdown

title, description, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_codeowners, ha_domain

title	description	ha_category	ha_release	ha_iot_class	ha_config_flow	ha_codeowners	ha_domain
Openuv	Instructions on how to integrate OpenUV within Home Assistant.	Health Binary Sensor Sensor	0.76	Cloud Polling	true	@bachya	openuv

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

Generating an API Key

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

Beginning February 1, 2019, the "Limited" plan (which is what new users are given by default) is limited to 50 API requests per day. Because different API plans and locations will have different requirements, the `openuv` component does not automatically query the API for new data after it initially loads. To request new data, the `update_data` service may be used.

Each use of the `update_data` service will consume 2 API calls from the daily quota (since it performs the same tasks as back-to-back calls of the `update_uv_index_data` and the `update_protection_data` services).

Configuration

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

openuv:
  api_key: YOUR_OPENUV_API_KEY

{% configuration %} api_key: description: The OpenUV API key. required: true type: string elevation: description: The elevation of the monitored location; if omitted, the value specified in configuration.yaml will be used. required: false type: float latitude: description: The latitude of the monitored location; if omitted, the value specified in configuration.yaml will be used. required: false type: float longitude: description: The longitude of the monitored location; if omitted, the value specified in configuration.yaml will be used. required: false type: float {% endconfiguration %}

The Fitzpatrick Scale

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.

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.

Services

openuv.update_data

Perform an on-demand update of OpenUV data.

openuv.update_uv_index_data

Perform an on-demand update of OpenUV sensor data including current UV index, but not the uv_protection_window, saving an API call over update_data.

openuv.update_protection_data

Perform an on-demand update of OpenUV uv_protection_window data, but not the sensors, saving an API call.

Examples of Updating Data

One method to retrieve data every 30 minutes and still leave plenty of API key usage is to only retrieve data during the daytime:

automation:
  - alias: Update OpenUV every 30 minutes during the daytime
    trigger:
      platform: time_pattern
      minutes: '/30'
    condition:
      condition: and
      conditions:
        - condition: sun
          after: sunrise
        - condition: sun
          before: sunset
    action:
      service: openuv.update_data

Update the UV index data every 20 minutes while the sun is at least 10 degrees above the horizon:

automation:
  - alias: Update OpenUV every 20 minutes while the sun is at least 10 degrees above the horizon
    trigger:
      platform: time_pattern
      minutes: '/20'
    condition:
      condition: numeric_state
      entity_id: sun.sun
      value_template: '{{ state.attributes.elevation }}'
      above: 10
    action:
      service: openuv.update_uv_index_data

Update the protection window once a day:

automation:
  - alias: Update OpenUV protection window once a day
    trigger:
      platform: time
      at: "02:12:00"
    action:
      service: openuv.update_protection_data

Another method (useful when monitoring locations other than the Home Assistant latitude and longitude, in locations where there is a large amount of sunlight per day, etc.) might be to simply query the API less often:

automation:
  - alias: Update OpenUV every hour (24 of 50 calls per day)
    trigger:
      platform: time_pattern
      minutes: '/60'
    action:
      service: openuv.update_data