OpenWeatherMapHistory

Functionality

A home assistant sensor that uses the OpenWeatherMap API to return:

• Up to 30 days of history data (rain, snow, min temp, max temp)
• 7 days of forecast (pop, rain, snow, humidity, min temp, max temp)
• Current observations (rain, snow, humidity, current temp, current pressure)
• Aggrgate daily data by date (precipitation, min temp, max temp, date)
• Status information (remaining backlog to load, current days API count)

Any number of sensors can be created using templates.

While HA recommends using individual sensors, you can assign additional attributes to a sensor.

The data is in 24 hour time slots, not date based, but data for the preceeding 24hrs.

Two API calls are used each hour, one to collect the new history data and another to collect the forecast and current observations.

When a new locations is created:

• Two API calls are made to collect the current observations and the last hour.
• Every refresh cycle (defaults to 10 min) 24 calls (1 day) will be made to load the history data (default 5 days) until the API limit (default 500) has been reached or all data has been provisioned.

You can configure the retention of the data so while you may choose to backload 5 days you can keep up to 30 days of data. This will be accumulated until the limit is reached.

This integration was initially built to support the Irrigation Program custom component and can be used to:

• alter the watering time/volume
• alter the watering frequency

You need an API key, which is free, but requires a registration. You do need to provide a payment method, however, the first 1000 calls are free and you can set an upper limit of calls. Setting this to 1000 will prevent you incurring any costs.

Note If you have an existing key you will still need to subscribe to the One Call 3.0 API, follow the instructions above.

Installation

HACS installation Adding as a custom repository using HACS is the simplest approach, will be published soon.

Manual Installation

• Copy the openweathermaphistory folder to the ‘config/custom components/’ directory

Configuration Config Flow

• Define the program using the UI. From Setting, Devices & Services choose 'ADD INTEGRATION'. Search for OpenWeatherMap History.
• Add the integration multiple times if you want more than one location. The second location must be at least 1000m away from any previously configured location to prevent accidental creation of 'duplicate' weather monitoring. Be aware that the API limit is for each location. Locations are not aware of API usage by any other location configured.

Location

|Key |Type|Optional|Description|Default| |---|---|---|---|---| |Location Name|string|Required|Instance identifier, cannot be modified|Home Assistant configured name| |API Key|string|Required|OpenWeatherMap API key|| |Location|location|Required|Select from the map, cannot be within 1000m of an already configured location|Home Assistant configure location| |Days to keep data|integer|Required|Retention period of the captured data. Can be longer than initial download. Data will accumulate as collected until the limit is reached. Will default to backload days it is defined with a value less thant the backload days|5 days| |Days to backload|integer|Required|Days for initial population, can be increased after the initial load, a new backload will commence|5 days| |Max API calls per day|integer|Required|The daily API limit, the count is for one integration, if you have two instances with 500 then each can use 500 api calls|500|

<img width="427" alt="image" src="https://github.com/petergridge/Irrigation-V5/assets/40281772/3aa18655-52e3-4b84-b9a8-7ceb75f320bd">

Sensor

Key |Type|Optional|Description|Default| |---|---|---|---|---| |Sensor name|string|Required|Sensor name, modify using HA once created|| |Jinja2 Template|template|Required|A valid template that will define the sensor|| |Attributes to expose|string|Optional|A comma seperated list of valid variables to add as attributes to the sensor|| |Sensor Type|string|Optional|Select the type to define unit of measure. A template that returns a text value must be set to None|None|

<img width="287" alt="image" src="https://github.com/petergridge/Irrigation-V5/assets/40281772/ef095fee-67c5-4895-9e10-a81c33385206"><img width="286" alt="image" src="https://github.com/petergridge/Irrigation-V5/assets/40281772/ac77c8ed-d6e4-4621-a1b9-7bab956259c9">

Units of measure

All data is captured in metric measurements.

To ensure that you see the information in your local unit of measure:

• Ensure you select the appropriate 'Type of sensor'. This will allow HA to display information in the unit of measure defined for your instance.
• If you change the type of sensor you will see warnings in the log as the unit of measure will be inconsistent, go to the developers tools/statistics page to fix the issue.

WARNING (Recorder) [homeassistant.components.sensor.recorder] The unit of sensor.current_temp (°C) cannot be converted ...
Go to https://my.home-assistant.io/redirect/developer_statistics to fix this

• You can change the unit of measure (°C to °F) for each sensor in the sensor settings.

Note

Unit of measure is not applied to attributes only to the sensor state. Attribute values are supplied as metric values

Attribute example

day0rain, day1rain, day2rain, day3rain, day4rain, day0max, day1max, day2max, day3max, day4max, day0min, day1min, day2min, day3min, day4min

Jinja2 Template

Calculations are performed in the native unit of measure, so all calculations are in mm, mm/hr, °C, hPa, %.

Examples

Determine the watering frequency based on temperature

{% set avgtemp = (forecast1max + forecast2max + forecast3max)/3 -%}
{% if avgtemp < 10 -%}
Off
{% elif avgtemp < 20 -%}
Mon, Fri
{% else -%}
Mon, Thu, Sat
{% endif -%}

Display current temperature

{{current_temp}}

Version 1 factor, verifying to an expected 10mm rainfall. The resulting factor can be used to reduce the watering time or volume when there has been some rain but not enough to not water at all. This example could be extended to include temperature and increase the watering if it is hotter than expected.

{{ 
  [(10 
  - day0rain 
  - day1rain*0.5
  - day2rain*0.25
  - day3rain*0.12
  - day4rain*0.06)/10
  ,0]|max
}}

Factor utilising forecast rain and probability of precipitation

{{ 
  [(10 
  - day0rain 
  - day1rain*0.5
  - day2rain*0.25
  - forecast1rain*forecast1pop*0.5
  - forecast2rain*forecast2pop*0.25)/10
  ,0]|max
}}

Using the cumulative data

A common usecase is to show daily/monthly rainfall. Using the cumulative data elements this can be achieved with the Utility Meter sensor

Available variables

For each day of history available, day 0 represent the past 24 hours

|Variable|example|Description| |---|---|---| |day{i}rain|day0rain|Rainfall in the 24 hour period| |day{i}snow|day1snow|Snow in the 25-48 hour period| |day{i}max||Maximum temperature in the 24 hour period| |day{i}min||Minimum temperature in the 24 hour period|

Forecast provides 7 days of data, day 0 represent the future 24 hours

|Variable|example|Description| |---|---|---| |forecast{i}pop|forecast0pop|Probobility of precipitation in the 24 hour period| |forecast{i}rain|forecast1rain|Forecast rain in the 25-48 hour period| |forecast{i}snow||Forecast snow in the 24 hour period| |forecast{i}humidity||Average humidity| |forecast{i}max||Maximum temperature in the 24 hour period| |forecast{i}min||Minimum temperature in the 24 hour period|

Current observations

|Variable|Description| |---|---| |current_rain|Current hours rainfall| |current_snow|Current hours snow| |current_humidity|Current hours humidity| |current_temp|Current hours temperature| |current_pressure|Current hours pressure|

Cumulative totals (under development)

|Variable|Description| |---|---| |cumulative_rain|Continually increasing total of all rainfall recorded| |cumulative_snow|Continually increasing total of all snowfall recorded|

Status values

|Variable|Description| |---|---| |remaining_backlog|Hours of data remaining to be gathered| |daily_count|Number of API calls for all instances of the integration, resets midnight GMT. This will not always match between instance of the integration due to the update frequency|

Using Plotty to graph rain history

Plotty is a card available on HACS

<img width="232" height="23" alt="image" src="https://github.com/user-attachments/assets/4eea4d6e-714d-42d8-a8eb-3d073b4fe939" />

Create a sensor in OWMH with this specification:

<img width="233" height="271" alt="image" src="https://github.com/user-attachments/assets/93922812-34ad-4fb5-9cf8-19379e17724d" />

Define the 'Plotty' card:

<img width="559" height="355" alt="image" src="https://github.com/use