git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.weathercompany.internal.model;
  14
  15 /**
  16  * The {@link DayPartDTO} is the JSON object that contains the n-day forecast.
  17  *
  18  * The daypart object as well as the temperatureMax field will
  19  * appear as null in the API after 3:00 pm Local Apparent Time.
  20  *
  21  * @author Mark Hilbush - Initial contribution
  22  */
  23 public class DayPartDTO {
  24     /*
  25      * The name of a 12 hour daypart not including day names in the
  26      * first 48 hours (Today, Tonight)
  27      */
  28     public String[] daypartName;
  29
  30     /*
  31      * Day or night indicator (D, N)
  32      */
  33     public String[] dayOrNight;
  34
  35     /*
  36      * The narrative forecast for the daypart period
  37      */
  38     public String[] narrative;
  39
  40     /*
  41      * Sensible weather phrase
  42      */
  43     public String[] wxPhraseLong;
  44
  45     /*
  46      * Sensible weather phrase
  47      */
  48     public String[] wxPhraseShort;
  49
  50     /*
  51      * The maximum temperature between 7am and 7pm for daytime temperature and the minimum temperature
  52      * between 7pm and 7am for night-time temperature. Minimum temperature also
  53      */
  54     public Double[] temperature;
  55
  56     /*
  57      * Maximum heat index.
  58      * An apparent temperature. It represents what the air temperature “feels like” on exposed human skin
  59      * due to the combined effect of warm temperatures and high humidity.
  60      * When the temperature is 70°F or higher, the Feels Like value represents the computed Heat Index.
  61      * For temperatures between 40°F and 70°F, the Feels Like value and Temperature are the same,
  62      * regardless of wind speed and humidity, so use the Temperature value
  63      */
  64     public Double[] temperatureHeatIndex;
  65
  66     /*
  67      * Minimum wind chill.
  68      * An apparent temperature. It represents what the air temperature “feels like” on exposed human skin
  69      * due to the combined effect of the cold temperatures and wind speed.
  70      * When the temperature is 61°F or lower the Feels Like value represents the computed Wind Chill so display the
  71      * Wind Chill value.
  72      * For temperatures between 61°F and 75°F, the Feels Like value and Temperature are the same, regardless
  73      * of wind speed and humidity, so display the Temperature value.
  74      */
  75     public Double[] temperatureWindChill;
  76
  77     /*
  78      * The relative humidity of the air, which is defined as the ratio of the amount of water vapor
  79      * in the air to the amount of vapor required to bring the air to saturation at a constant
  80      * temperature. Relative humidity is always expressed as a percentage
  81      */
  82     public Double[] relativeHumidity;
  83
  84     /*
  85      * Daytime average cloud cover expressed as a percentage
  86      */
  87     public Integer[] cloudCover;
  88
  89     /*
  90      * The maximum forecasted wind speed.
  91      * The wind is treated as a vector; hence, winds must have direction and magnitude (speed).
  92      * The wind information reported in the hourly current conditions corresponds to a 10-minute average
  93      * called the sustained wind speed. Sudden or brief variations in the wind speed are known
  94      * as “wind gusts” and are reported in a separate data field. Wind directions are always expressed
  95      * as "from whence the wind blows" meaning that a North wind blows from North to South. If you face
  96      * North in a North wind the wind is at your face. Face southward and the North wind is at your back
  97      */
  98     public Double[] windSpeed;
  99
 100     /*
 101      * Average wind direction in magnetic notation
 102      */
 103     public Integer[] windDirection;
 104
 105     /*
 106      * Average wind direction in cardinal notation
 107      * N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW, CALM, VAR
 108      */
 109     public String[] windDirectionCardinal;
 110
 111     /*
 112      * The phrase that describes the wind direction and speed for a 12 hour daypart
 113      */
 114     public String[] windPhrase;
 115
 116     /*
 117      * Maximum probability of precipitation
 118      */
 119     public Integer[] precipChance;
 120
 121     /*
 122      * Type of precipitation to display with the probability of precipitation
 123      * data element. (rain, snow, precip)
 124      */
 125     public String[] precipType;
 126
 127     /*
 128      * The description of probability thunderstorm activity in an area for 12 hour daypart
 129      * 0 = "No thunder"; 1 = "Thunder possible"; 2 = "Thunder expected"; 3 = "Severe thunderstorms possible";
 130      * 4 = "Severe thunderstorms likely"; 5 = "High risk of severe thunderstorms"
 131      */
 132     public String[] thunderCategory;
 133
 134     /*
 135      * The enumeration of thunderstorm probability within an area for a 12 hour daypart
 136      */
 137     public Integer[] thunderIndex;
 138
 139     /*
 140      * The forecasted measurable precipitation (liquid or liquid equivalent) during 12 or 24 hour period
 141      */
 142     public Double[] qpf;
 143
 144     /*
 145      * The forecasted measurable precipitation as snow during the 12 or 24 hour forecast period
 146      */
 147     public Double[] qpfSnow;
 148
 149     /*
 150      * A phrase associated to the qualifier code describing special weather criteria
 151      */
 152     public String[] qualifierPhrase;
 153
 154     /*
 155      * ????
 156      */
 157     public String[] qualifierCode;
 158
 159     /*
 160      * Snow accumulation amount for the 12 hour forecast period
 161      */
 162     public String[] snowRange;
 163
 164     /*
 165      * The UV Index Description which complements the UV Index value by providing an associated
 166      * level of risk of skin damage due to exposure.
 167      * -2 = Not Available, -1 = No Report, 0 to 2 = Low, 3 to 5 = Moderate,
 168      * 6 to 7 = High, 8 to 10 = Very High, 11 to 16 = Extreme
 169      */
 170     public String[] uvDescription;
 171
 172     /*
 173      * Maximum UV index for the 12 hour forecast period
 174      */
 175     public Integer[] uvIndex;
 176
 177     /*
 178      * This number is the key to the weather icon lookup. The data field shows the icon
 179      * number that is matched to represent the observed weather conditions
 180      */
 181     public Integer[] iconCode;
 182
 183     /*
 184      * Code representing full set sensible weather
 185      */
 186     public Integer[] iconCodeExtend;
 187 }