Plugin ‚openweathermap‘ Konfiguration

plugin logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin openweathermap konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann. [1]

Es handelt sich bei diesem Plugin um ein web Plugin.

Beschreibung

Wetterdaten über OpenWeatherMap.

Anforderungen

  • Minimum SmartHomeNG Version: 1.9.0

Konfiguration

Im folgenden ist beschrieben, wie das Plugin openweathermap konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann.

Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/plugin.yaml konfiguriert werden:

altitude

Altitude des Ortes, für den die Wetterdaten abgerufen werden sollen. Default: SmartHomeNG Settings.

  • Datentyp: str

api_version

Version der Openweathermap Onecall API. Neue User nutzen 3.0

  • Datentyp: str

  • Standardwert: 2.5

  • Mögliche Werte:

    • 2.5

    • 3.0

cycle

(optional) Zeit zwischen zwei Updateläufen.

  • Datentyp: int

  • Standardwert: 900

key

Persönlicher API Key für OpenWeatherMap. Registrierung unter https://openweathermap.org/.

  • Datentyp: str

lang

Sprache der zurückgelieferten Daten. Mögliche Werte siehe https://openweathermap.org/api.

  • Datentyp: str

  • Standardwert: de

latitude

Latitude des Ortes, für den die Wetterdaten abgerufen werden sollen (max. 4 Dezimalstellen). Default: SmartHomeNG Settings

  • Datentyp: str

longitude

Longitude des Ortes, für den die Wetterdaten abgerufen werden sollen (max. 4 Dezimalstellen). Default: SmartHomeNG Settings.

  • Datentyp: str

softfail_precipitation

Wenn keine optionalen Niederschlagswerte (Regen/Schnee) geliefert werden, aber eine Aktualisierung passiert ist - was soll geschrieben werden?

  • Datentyp: str

  • Standardwert: number=0

  • Mögliche Werte:

    • number=0

    • number=-1

    • no_update

    • log_info

softfail_wind_gust

Wenn keine Werte für Windböen geliefert werden, aber eine Aktualisierung passiert ist - was soll geschrieben werden?

  • Datentyp: str

  • Standardwert: relative=../wind_speed

  • Mögliche Werte:

    • number=0

    • number=-1

    • no_update

    • relative=../wind_speed

    • log_info

units

Einheit der zurückgelieferten Daten. Mögliche Werte sind imperial und metric.

  • Datentyp: str

  • Standardwert: metric

Item Attribute

Das Plugin unterstützt folgende Item Attribute, die in den Dateien im Verzeichnis ../items verwendet werden:

owm_coord_x

X-Koordinate für die entsprechenden Layer-Bilder-Links von OpenWeatherMap. Nur nutzbar mit owm_matchstring: precipitation_new und clouds_new.

  • Datentyp: num

owm_coord_y

Y-Koordinate für die entsprechenden Layer-Bilder-Links von OpenWeatherMap. Nur nutzbar mit owm_matchstring: precipitation_new und clouds_new.

  • Datentyp: num

owm_coord_z

Z-Koordinate für die entsprechenden Layer-Bilder-Links von OpenWeatherMap. Nur nutzbar mit owm_matchstring: precipitation_new und clouds_new.

  • Datentyp: num

owm_match_prefix

Präfix der dem Matchstring vorangestellt wird. Kann in einem struct vererbt werden über ..:.

  • Datentyp: str

  • Standardwert: None

owm_matchstring

Matchstring für die OpenWeatherMap Daten, siehe Beispiele in der README.

  • Datentyp: str

owm_raw_file

Name einer Datenquelle, der JSON hier komplett eingebunden wird

  • Datentyp: str

Item-Structs

Das Plugin stellt die folgenden Item-Structs zur Verfügung. Diese Informationen sind aus der plugin.yaml entnommen und möglicherweise nicht vollständig.

airpollution

OpenWeatherMap airpollution data

  • airpollution (foo, OpenWeatherMap airpollution data)

    • aqi (num, AirQualityIndex)

    • co (num, CO Wert)

    • no (num, NO Wert)

    • no2 (num, NO2 Wert)

    • o3 (num, O3 Wert)

    • so2 (num, SO2 Wert)

    • pm25 (num, Partikel 2-5µm)

    • pm10 (num, Partikel 10µm)

    • nh3 (num, NH3 Wert)

alerts

OpenWeatherMap national weather alerts data from major national weather warning systems

  • alerts (foo, OpenWeatherMap national weather alerts data from major national weather warning systems)

    • sender_name (str, Name of the alert source.)

    • event (str, Alert event name)

    • start (str, Date and time of the start of the alert, Unix, UTC)

    • end (str, Date and time of the end of the alert, Unix, UTC)

    • description (str, Description of the alert)

current

OpenWeatherMap current weather data

  • current (foo, OpenWeatherMap current weather data)

    • dt (str, Current time, Unix, UTC)

    • sunrise (str, Sunrise time, Unix, UTC)

    • sunset (str, Sunset time, Unix, UTC)

    • temp (num, Temperature. Units - default kelvin, metric Celsius, imperial Fahrenheit.)

    • feels_like (num, Temperature. This temperature parameter accounts for the human perception of weather. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • pressure (num, Atmospheric pressure on the sea level, hPa)

    • humidity (num, Humidity, %)

    • dew_point (num, Atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • clouds (num, Cloudiness,%)

    • uvi (num, Current UV index)

    • visibility (num, Average visibility, metres)

    • wind_speed (num, Wind speed. Wind speed. Units default metre/sec, metric metre/sec, imperial miles/hour.)

      • beaufort_nr (num, wind speed as beaufort number)

      • beaufort_string (str, wind speed as beaufort string)

    • wind_gust (num, (where available) Wind gust. Units default metre/sec, metric metre/sec, imperial miles/hour.)

      • beaufort_nr (num, wind gusts as beaufort number)

      • beaufort_string (str, wind gusts as beaufort string)

    • wind_deg (num, Wind direction, degrees (meteorological))

      • wind_direction_string (str, —)

    • rain (num, (where available) Rain volume for last hour, mm)

    • snow (num, (where available) Snow volume for last hour, mm)

    • weather_id (num, Weather condition id)

    • weather_main (str, Group of weather parameters (Rain, Snow, Extreme etc.))

    • weather_description (str, Weather condition within the group (full list of weather conditions). Get the output in your language)

    • weather_icon (str, Weather icon id. How to get icons)

darksky2owm_current_weather

Current weather of Weather report from openweathermap matching item defined in darksky-plugin struct

  • darksky2owm_current_weather (foo, Current weather of Weather report from openweathermap matching item defined in darksky-plugin struct)

    • time_epoch (num, —)

    • time (str, —)

    • summary (str, —)

    • icon (str, —)

    • icon_visu (str, —)

    • temperature (num, —)

    • apparenttemperature (num, —)

    • dewpoint (num, —)

    • humidity (num, —)

    • pressure (num, —)

    • windSpeed (num, —)

    • windGust (num, —)

    • windBearing (num, —)

    • cloudCover (num, —)

    • uvIndex (num, —)

    • visibility (num, —)

    • ozone (num, —)

    • date (str, —)

    • day (num, —)

darksky2owm_forecast_daily

Daily forcast of Weather report from openweathermap matching item defined in darksky-plugin struct

  • darksky2owm_forecast_daily (foo, Daily forcast of Weather report from openweathermap matching item defined in darksky-plugin struct)

    • time_epoch (num, —)

    • time (str, —)

    • summary (str, —)

    • icon (str, —)

    • icon_visu (str, —)

    • temperature (num, —)

    • apparenttemperature (num, —)

    • dewpoint (num, —)

    • humidity (num, —)

    • pressure (num, —)

    • windSpeed (num, —)

    • windGust (num, —)

    • windBearing (num, —)

    • cloudCover (num, —)

    • uvIndex (num, —)

    • temperatureMin (num, —)

    • temperatureMax (num, —)

    • date (str, —)

    • weekday (num, —)

    • precipProbability_mean (num, —)

darksky2owm_forecast_hourly

Hourly forcast of Weather report from openweathermap matching item defined in darksky-plugin struct

  • darksky2owm_forecast_hourly (foo, Hourly forcast of Weather report from openweathermap matching item defined in darksky-plugin struct)

    • time_epoch (num, —)

    • time (str, —)

    • summary (str, —)

    • icon (str, —)

    • icon_visu (str, —)

    • temperature (num, —)

    • apparenttemperature (num, —)

    • dewpoint (num, —)

    • humidity (num, —)

    • pressure (num, —)

    • windSpeed (num, —)

    • windGust (num, —)

    • windBearing (num, —)

    • cloudCover (num, —)

    • uvIndex (num, —)

    • visibility (num, —)

    • date (str, —)

    • weekday (str, —)

darksky2owm_locals

Locals report openweathermap matching item defined in darksky-plugin struct

  • darksky2owm_locals (foo, Locals report openweathermap matching item defined in darksky-plugin struct)

    • latitude (num, —)

    • longitude (num, —)

    • timezone (str, —)

forecast_daily

OpenWeatherMap daily weather forecast data

  • forecast_daily (foo, OpenWeatherMap daily weather forecast data)

    • dt (str, Time of the forecasted data, Unix, UTC)

    • dt_weekday (str, Time of the forecasted data, Unix, UTC)

    • sunrise (str, Sunrise time, Unix, UTC)

    • sunset (str, Sunset time, Unix, UTC)

    • moonrise (str, The time of when the moon rises for this day, Unix, UTC)

    • moonset (str, The time of when the moon sets for this day, Unix, UTC)

    • moon_phase (num, Moon phase. 0 and 1 are ‚new moon‘, 0.25 is ‚first quarter moon‘, 0.5 is ‚full moon‘ and 0.75 is ‚last quarter moon‘. The periods in between are called ‚waxing crescent‘, ‚waxing gibous‘, ‚waning gibous‘, and ‚waning crescent‘, respectively.)

    • temp (foo, Temperature. Units default kelvin, metric Celsius, imperial Fahrenheit.)

      • temp_morn (num, Morning temperature.)

      • temp_day (num, Day temperature.)

      • temp_eve (num, Evening temperature.)

      • temp_night (num, Night temperature.)

      • temp_min (num, Min daily temperature.)

      • temp_max (num, Max daily temperature.)

    • feels_like (foo, This accounts for the human perception of weather. Units default kelvin, metric Celsius, imperial Fahrenheit.)

      • feels_like_morn (num, Morning temperature.)

      • feels_like_day (num, Day temperature.)

      • feels_like_eve (num, Evening temperature.)

      • feels_like_night (num, Night temperature.)

    • pressure (num, Atmospheric pressure on the sea level, hPa)

    • humidity (num, Humidity, %)

    • dew_point (num, Atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • wind_speed (num, Wind speed. Units default metre/sec, metric metre/sec, imperial miles/hour.)

      • beaufort_nr (num, wind speed as beaufort number)

      • beaufort_string (str, wind speed as beaufort string)

    • wind_gust (num, (where available) Wind gust. Units default metre/sec, metric metre/sec, imperial miles/hour.)

      • beaufort_nr (num, wind gusts as beaufort number)

      • beaufort_string (str, wind gusts as beaufort string)

    • wind_deg (num, Wind direction, degrees (meteorological))

      • wind_direction_string (str, —)

    • clouds (num, Cloudiness, %)

    • uvi (num, The maximum value of UV index for the day)

    • pop (num, Probability of precipitation)

    • rain (num, (where available) Precipitation volume, mm)

    • snow (num, (where available) Snow volume, mm)

    • weather_id (num, Weather condition id)

    • weather_main (str, Group of weather parameters (Rain, Snow, Extreme etc.))

    • weather_description (str, Weather condition within the group (full list of weather conditions). Get the output in your language)

    • weather_icon (str, Weather icon id. How to get icons)

forecast_hourly

OpenWeatherMap hourly weather forecast data

  • forecast_hourly (foo, OpenWeatherMap hourly weather forecast data)

    • dt (str, Time of the forecasted data, Unix, UTC)

    • temp (num, Temperature. Units default kelvin, metric Celsius, imperial Fahrenheit. How to change units used)

    • feels_like (num, Temperature. This accounts for the human perception of weather. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • pressure (num, Atmospheric pressure on the sea level, hPa)

    • humidity (num, Humidity, %)

    • dew_point (num, Atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • uvi (num, UV index)

    • clouds (num, Cloudiness, %)

    • visibility (num, Average visibility, metres)

    • wind_speed (num, Wind speed. Units default metre/sec, metric metre/sec, imperial miles/hour. How to change units used)

    • wind_gust (num, (where available) Wind gust. Units default metre/sec, metric metre/sec, imperial miles/hour. How to change units used)

    • wind_deg (num, Wind direction, degrees (meteorological))

    • pop (num, Probability of precipitation)

    • rain (num, (where available) Rain volume for last hour, mm)

    • snow (num, (where available) Snow volume for last hour, mm)

    • weather_id (num, Weather condition id)

    • weather_main (str, Group of weather parameters (Rain, Snow, Extreme etc.))

    • weather_description (str, Weather condition within the group (full list of weather conditions). Get the output in your language)

    • weather_icon (str, Weather icon id. How to get icons)

historical_daily

OpenWeatherMap historical weather data for dedicated day

  • historical_daily (foo, OpenWeatherMap historical weather data for dedicated day)

    • dt (str, Time of the forecasted data, Unix, UTC)

    • sunrise (str, Sunrise time, Unix, UTC)

    • sunset (str, Sunset time, Unix, UTC)

    • temp (num, Temperature. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • feels_like (num, This accounts for the human perception of weather. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • pressure (num, Atmospheric pressure on the sea level, hPa)

    • humidity (num, Humidity, %)

    • dew_point (num, Atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • wind_speed (num, Wind speed. Units default metre/sec, metric metre/sec, imperial miles/hour.)

    • wind_gust (num, (where available) Wind gust. Units default metre/sec, metric metre/sec, imperial miles/hour.)

    • wind_deg (num, Wind direction, degrees (meteorological))

    • clouds (num, Cloudiness, %)

    • uvi (num, The maximum value of UV index for the day)

    • rain (num, (where available) Precipitation volume, mm)

    • snow (num, (where available) Snow volume, mm)

    • weather_id (num, Weather condition id)

    • weather_main (str, Group of weather parameters (Rain, Snow, Extreme etc.))

    • weather_description (str, Weather condition within the group (full list of weather conditions). Get the output in your language)

    • weather_icon (str, Weather icon id. How to get icons)

historical_hourly

OpenWeatherMap historical weather data for dedicated hour

  • historical_hourly (foo, OpenWeatherMap historical weather data for dedicated hour)

    • dt (str, Time of the forecasted data, Unix, UTC)

    • temp (num, Temperature. Units default kelvin, metric Celsius, imperial Fahrenheit. How to change units used)

    • feels_like (num, Temperature. This accounts for the human perception of weather. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • pressure (num, Atmospheric pressure on the sea level, hPa)

    • humidity (num, Humidity, %)

    • dew_point (num, Atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form. Units default kelvin, metric Celsius, imperial Fahrenheit.)

    • clouds (num, Cloudiness, %)

    • visibility (num, Average visibility, metres)

    • wind_speed (num, Wind speed. Units default metre/sec, metric metre/sec, imperial miles/hour.How to change units used)

    • wind_gust (num, (where available) Wind gust. Units default metre/sec, metric metre/sec, imperial miles/hour. How to change units used)

    • wind_deg (num, Wind direction, degrees (meteorological))

    • rain (num, (where available) Rain volume for last hour, mm)

    • snow (num, (where available) Snow volume for last hour, mm)

    • weather_id (num, Weather condition id)

    • weather_main (str, Group of weather parameters (Rain, Snow, Extreme etc.))

    • weather_description (str, Weather condition within the group (full list of weather conditions). Get the output in your language)

    • weather_icon (str, Weather icon id. How to get icons)

irrigation

  • irrigation (bool, —)
    • schedule_seconds (num, —)

      • remaining_time (num, —)

    • todays_water_demand_in_l (num, —)

    • evaporation (num, —)

      • exposure_factor (num, How exposed is your area to evaporation? Lower the factor for less exposure (e.g. shading, or wind-shields) or higher the factor if there is more sun (reflection) or wind (droughty areas).)

    • rain (num, —)

      • past_12h (num, —)

      • next_12h (num, —)

      • exposure_factor (num, How exposed is your area to rain? Lower the factor for less exposure (e.g. roofs or bushes) or higher the factor if additional water is put there (e.g. from roof-drains).)

    • factors (num, —)

      • flowrate_l_per_min (num, How much water is transported by your irrigation-system? liters per minute)

      • area_in_sqm (num, This is the irrigated area. This is important for the effectivity of rain vs. evaporation.)

      • crop_coefficient (num, This is the coefficient that can be set based on the plants. Typically 0.3 to 0.9)

      • plant_density (num, How dense are the plants planted? Typically 0.3 to 1.5)

      • gut_feeling (num, This is a factor that should be used to tweak irrigation based on gut-feelings, typically this should be assigned centrally for the whole yard (use eval).)

irrigation_weekly

  • irrigation_weekly (bool, —)
    • schedule_seconds (num, —)

      • remaining_time (num, —)

    • weeks_water_demand_in_l (num, —)

    • evaporation (num, —)

      • day_past3 (num, —)

      • day_past2 (num, —)

      • day_past1 (num, —)

      • day_past0 (num, —)

      • day_next0 (num, —)

      • day_next1 (num, —)

      • day_next2 (num, —)

      • exposure_factor (num, How exposed is your area to evaporation? Lower the factor for less exposure (e.g. shading, or wind-shields) or higher the factor if there is more sun (reflection) or wind (droughty areas).)

    • rain (num, —)

      • past_4d (num, —)

      • next_3d (num, —)

      • exposure_factor (num, How exposed is your area to rain? Lower the factor for less exposure (e.g. roofs or bushes) or higher the factor if additional water is put there (e.g. from roof-drains).)

    • factors (num, —)

      • flowrate_l_per_min (num, How much water is transported by your irrigation-system? liters per minute)

      • area_in_sqm (num, This is the irrigated area. This is important for the effectivity of rain vs. evaporation.)

      • gut_feeling (num, This is a factor that should be used to tweak irrigation based on gut-feelings, typically this should be assigned centrally for the whole yard (use eval).)

locals

OpenWeatherMap local data

  • locals (foo, OpenWeatherMap local data)

    • lat (num, Geographical coordinates of the location (latitude))

    • lon (num, Geographical coordinates of the location (longitude))

    • timezone (str, Timezone name for the requested location)

    • timezone_offset (num, Shift in seconds from UTC)

    • location (str, Name of the requested location)

Logik Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/logic.yaml konfiguriert werden:

Keine Logik Parameter in den Metadaten beschrieben - Bitte in der README nachsehen (siehe Fußnote)

Plugin Functions

Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.

get_beaufort_description(speed_in_bft)

Gibt die angegebene Windstärke als beschreibeneden Text aus

  • Ergebnistyp der Funktion: str

speed_in_bft

Windstärke in bft, integer zwischen 0 und 12

  • Datentyp: num

get_beaufort_number(speed_in_mps)

Berechnet den Beaufort-Wert (0 - 12) aus der Windgeschwindigkeit in m/s

  • Ergebnistyp der Funktion: num

speed_in_mps

Windstärke in m/s

  • Datentyp: num

get_raw_data_file(data_source_key)

Stellt die JSON-Datei der Datenquelle bereit

  • Ergebnistyp der Funktion: str

data_source_key

Datenquelle

  • Datentyp: str

get_value(owm_matchstring)

Lädt einen Wert

  • Die Funktion liefert kein Ergebnis

owm_matchstring

Zum Beispiel /day/0/rain

  • Datentyp: str