Skip to content

Commit 6b48005

Browse files
H5N1v2H5N1v2
committed
docs(README): update documentation to reflect merger of Open Meteo Weather and PV Forecast, enhance feature descriptions, and improve clarity
1 parent 8ae8c7b commit 6b48005

1 file changed

Lines changed: 157 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 157 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,25 @@
1111
![Test and Release](https://github.com/H5N1v2/iobroker.open-meteo-weather/workflows/Test%20and%20Release/badge.svg)
1212
![node-lts](https://img.shields.io/node/v-lts/iobroker.open-meteo-weather?style=flat-square)
1313

14+
## Important information:
15+
16+
Open Meteo Weather and Open Meteo PV Forecast have now been merged into this adapter. Open Meteo PV Forecast is no longer maintained.
17+
18+
---
19+
1420
**This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.** For more details and instructions on disabling error reporting, please refer to the [Sentry-Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Use of Sentry reporting starts with js-controller 3.0.
1521

1622
I use my own Sentry server based on Glitchtip.
1723

18-
**The Open-Meteo Weather Service Adapter for ioBroker.**
24+
**The Open-Meteo Weather & PV Forecast Service Adapter for ioBroker.**
1925

20-
## First: If you are looking for a widget specifically for this adapter, then create it using [VIS2-widget-script-om-weather](https://github.com/H5N1v2/VIS2-widget-script-om-weather).
26+
## First: If you are looking for a widget (only Weather) specifically for this adapter, then create it using [VIS2-widget-script-om-weather](https://github.com/H5N1v2/VIS2-widget-script-om-weather).
2127

22-
This adapter provides precise weather data, forecasts, air quality, and pollen information powered by [Open-Meteo.com](https://open-meteo.com/). It is free for non-commercial use (under 10,000 daily API calls) and requires no API key registration, making the setup process extremely simple.
28+
This adapter provides precise weather data, forecasts, air quality, pollen & Photovoltaic Forecast information powered by [Open-Meteo.com](https://open-meteo.com/). It is free for non-commercial use (under 10,000 daily API calls) and requires no API key registration, making the setup process extremely simple.
2329

2430
---
2531

26-
## Features
32+
# Features Weather
2733

2834
* **Current Weather Data:** Real-time retrieval of temperature, humidity, air pressure, and wind data.
2935
* **Flexible Forecasts:** Configurable number of forecast days and hourly resolution.
@@ -82,9 +88,10 @@ After installation, configure the following fields in the instance settings:
8288
The adapter provides dynamic icon paths that can be used directly in visualizations such as **vis, iQontrol, or Jarvis**.
8389

8490
* **Weather Icons:** Found under `weather.current.icon_url`. The adapter automatically distinguishes between day and night (e.g., Sun vs. Moon).
85-
* **Wind Direction:** Static paths under `wind_direction_icon` display a compass arrow corresponding to the degree value.
91+
* **Wind Direction:** Static paths under `wind_direction_icon` display a compass arrow corresponding to the degree value (Display direction selectable).
8692
* **Wind Gust Warning:** A warning icon is displayed under `wind_gust_icon` for wind speeds above approx. 39 km/h (Bft 6), featuring levels 0–4.
8793
* **Moon Phases Icons:** Moon icons can be found under `moon_phase_icon` they display the moon phases.
94+
* **Multible Icons:** You can choose between static and animated (by [basmilius](https://github.com/basmilius/meteocons)) icons.
8895

8996
---
9097

@@ -97,7 +104,142 @@ The adapter provides dynamic icon paths that can be used directly in visualizati
97104
| `weather.current` | Current measurements (Temp, Dew point, Wind, etc.) |
98105
| `weather.forecast.dayX` | Daily forecast for Day X |
99106
| `weather.forecast.hourly.hourX` | Hourly details per full hour |
100-
| `info.lastUpdate` | Shows Date and Time from last Update |
107+
| `info.lastUpdate_weather` | Shows Date and Time from last Weather Update |
108+
109+
---
110+
#### If you do not need the weather forecasts, leave the location field blank, no states will be entered.
111+
---
112+
---
113+
114+
# Features PV Forecast (if enabled)
115+
116+
* **Multiple Locations:** Support for multiple PV systems/locations, e.g., for East/West orientations.
117+
* **Hourly Forecast:** Detailed prediction of power output, temperature, cloud cover, and sunshine duration.
118+
* **Daily Forecast:** Summary of expected energy (Wh) for up to 14 days.
119+
* **15-Minutes Forecast:** 15-Minutely forecast for current day, 24 hours.
120+
* **Physical Simulation:**
121+
* **Tilt & Azimuth:** Irradiance calculation based on panel orientation.
122+
* **PV Module Temperature:** Estimation of cell temperature considering ambient temperature, radiation intensity, and wind speed (Faiman model).
123+
* **Sunshine Duration:** Conversion of sunshine duration into minutes per hour.
124+
* **Aggregation:** Automatic summing of all locations (total forecast) on both a daily, hourly and 15-minutely basis.
125+
* **System Integration:** Automatic acquisition of location coordinates from the ioBroker system configuration if not manually set.
126+
* **PV Module Temperature:** Estimated PV Module Temperature, based on Faiman model.
127+
128+
---
129+
130+
## Data Points (Objects)
131+
132+
For each configured location, a channel is created with the following data points in:
133+
| Folder | Description |
134+
|:---|:---|
135+
| `pv-forecast` | Folder for PV-Forecast Data |
136+
137+
### 15 Minutely Forecast (`15-min-forecast.0 - 95`), (24 Hours of current day), if enebled
138+
| Data Point | Unit | Description |
139+
|:---|:---|:---|
140+
| `global_tilted_irradiance` | Wh | Expected energy based on installed capacity (kWp). |
141+
| `pv_temperature` | °C | Estimated PV module temperature (Faiman calculation). |
142+
| `temperature_2m` | °C | Air temperature at 2 meters height. |
143+
| `time` | - | Forecast time (HH:mm). |
144+
| `wind_speed_10m` | km/h | Wind speed at 10 meters height. |
145+
146+
Info: temperature_2m and wind_spread_10m are needed to calculate the PV module temperature.
147+
148+
Optionally selectable if needed, otherwise the DP are included in the weather.
149+
| Data Point | Unit | Description |
150+
|:---|:---|:---|
151+
| `cloud_cover` | % | Total cloud cover in percent. |
152+
| `sunshine_duration` | min | Actual sunshine minutes within this hour. |
153+
154+
### Daily Forecast (`daily-forecast.dayX`)
155+
| Data Point | Unit | Description |
156+
|:---|:---|:---|
157+
| `Date` | - | Forecast date (DD.MM.YYYY). |
158+
| `Peak_day` | Wh | Expected total daily yield. |
159+
160+
### Forecast JSON (`location_folder`) if enebled
161+
| Data Point | Unit | Description |
162+
|:---|:---|:---|
163+
| `15-min-json_chart` | - | JSON 15-min |
164+
| `hourly-json_chart` | - | JSON hourly |
165+
166+
### Hourly Forecast (`hourly-forecast.hourX`)
167+
| Data Point | Unit | Description |
168+
|:---|:---|:---|
169+
| `time` | - | Forecast time (HH:mm). |
170+
| `global_tilted_irradiance` | Wh | Expected energy based on installed capacity (kWp). |
171+
| `pv_temperature` | °C | Estimated PV module temperature (Faiman calculation). |
172+
| `temperature_2m` | °C | Air temperature at 2 meters height. |
173+
| `wind_speed_10m` | km/h | Wind speed at 10 meters height. |
174+
175+
Info: temperature_2m and wind_spread_10m are needed to calculate the PV module temperature.
176+
177+
Optionally selectable if needed, otherwise the DP are included in the weather.
178+
| Data Point | Unit | Description |
179+
|:---|:---|:---|
180+
| `cloud_cover` | % | Total cloud cover in percent. |
181+
| `sunshine_duration` | min | Actual sunshine minutes within this hour. |
182+
183+
### sum_peak_locations_15_Minutly (`0-95`) if enebled
184+
| Data Point | Unit | Description |
185+
|:---|:---|:---|
186+
| `sum_locations` | Wh | Sum of Locations 15 Minutely |
187+
| `time` | - | Forecast time (HH:mm). |
188+
189+
### sum_peak_locations_Daily (`dayX`) if enebled
190+
| Data Point | Unit | Description |
191+
|:---|:---|:---|
192+
| `sum_locations` | Wh | Sum of Locations Daily |
193+
194+
### sum_peak_locations_Hourly (`HourX`) if enebled
195+
| Data Point | Unit | Description |
196+
|:---|:---|:---|
197+
| `sum_locations` | Wh | Sum of Locations Hourly |
198+
| `time` | - | Forecast time (HH:mm). |
199+
200+
### JSON Datapoints if enebled
201+
| Data Point | Unit | Description |
202+
|:---|:---|:---|
203+
| `sum_peak_15-min-json_chart` | - | Sum of Locations 15 min in JSON |
204+
| `sum_peak_hourly-json_chart` | - | Sum of Locations hourly in JSON |
205+
206+
207+
---
208+
209+
## Configuration
210+
211+
### Basic Settings
212+
* **Forecast Hours:** Timeframe for the hourly view (3 to 48 hours).
213+
* **Forecast Days:** Duration of the daily forecast (3 to 14 days).
214+
* **Update Interval:** Frequency of data updates (15, 30, 60 minutes or once before Sunrise).
215+
216+
### Datapoints Settings
217+
* **Rolling Hours or Fixed Hours:** If 'Rolling Hours' is selected, the hourly forecast will always show the next hours starting from the current hour. If 'Fixed Hours' is selected, the hourly forecast will show fixed time intervals (e.g., 00:00-23:00) regardless of the current time.
218+
* **15-minutes Forecast:** If enabled, additional states will be created for a 15-minute forecast (up to 24 hours for the current day). Please note that 15-minute data availability depends on the Open-Meteo API and may vary by location or time.
219+
220+
### Locations (Table)
221+
The following values must be defined for each location:
222+
1. **Name:** Unique identifier (sanitized for the object ID).
223+
2. **Latitude/Longitude:** GPS position (optional: uses system values otherwise).
224+
3. **Tilt:** Angle of the modules (0° = flat, 90° = vertical).
225+
4. **Azimuth:** Orientation (-180° to 180°, 0° = South, -90° = East, 90° = West).
226+
5. **Power (kWp):** Installed peak capacity of the system.
227+
6. **Timezone:** Selection of the local timezone (Default: Auto).
228+
229+
![Logo](admin/img/doc.png)
230+
231+
### Global Options, only adjustable if you have multible Locations!
232+
* **Total Sum (Daily):** Creates the channel `sum_peak_locations_Daily`, summing the yields of all systems.
233+
* **Total Sum (Hourly):** Creates the channel `sum_peak_locations_Hourly` for the total hourly performance.
234+
* **Total Sum (15-Minutely):** Creates the channel `sum_peak_locations_15_Minutely` for the total 15 Minutes forecast.
235+
236+
---
237+
238+
## Technical Details & Calculation
239+
240+
### PV Temperature Model
241+
The adapter uses the **Faiman model** to estimate the module temperature. This model accounts for wind cooling, which directly impacts efficiency:
242+
`pvTemp = Ambient Temperature + Irradiance / (25 + 6.84 * Wind Speed)`.
101243

102244
---
103245

@@ -106,6 +248,12 @@ The adapter provides dynamic icon paths that can be used directly in visualizati
106248
After a new adapter update, it is recommended to delete the entire directory tree and let it be recreated.
107249

108250
## Changelog
251+
### **WORK IN PROGRESS**
252+
* (H5N1v2) merged open-meteo-weather and open-meteo-pv-forecast
253+
* (H5N1v2) adding icon selection tab and animated icons for weather by Bas Milius
254+
* (H5N1v2) adding solar_noon in daily, freezing_level_height and snowfall_height in hourly
255+
* (H5N1v2) remove global_tilted_irradiance datapoint from weather.hourly
256+
109257
### 2.6.4 (2026-03-30)
110258
* (H5N1v2) Update axios dependency to version 1.14.0
111259

@@ -121,16 +269,14 @@ After a new adapter update, it is recommended to delete the entire directory tre
121269
* (mcm1957) fix: language used for stateIds and names
122270
* (mcm1957) fix: creation of intermediate objects missing
123271

124-
### 2.6.0 (2026-02-19)
125-
* (H5N1v2) feat: Leave latitude and longitude empty to use system coordinates in settings.
126-
* (H5N1v2) feat: Added dropdown menu for timezones in settings.
127-
128272
[OLDER CHANGELOG](CHANGELOG_OLD.md)
129273

130274
## Legal & Copyright
131275

132276
### Icons & Images
133-
The weather and wind direction icons included in this adapter are subject to the creator's copyright.
277+
Animatetd weather icons by [Bas Milius](https://github.com/basmilius/meteocons)
278+
279+
The static weather and wind direction icons included in this adapter are subject to the creator's copyright.
134280
* **Usage:** These icons are licensed for use within ioBroker. Commercial redistribution or use outside of this adapter requires the explicit consent of the author: h5n1@iknox.de.
135281
* **Weather Data:** All weather data is provided by [Open-Meteo.com](https://open-meteo.com/). Please review their terms of use for commercial purposes.
136282

0 commit comments

Comments
 (0)