ForecastIO.V2.Types

This module defines data types for the various JSON types returned by the Forecast.io service.

These definitions are generally straight conversions from the original JSON. Use of the Forecast.io service should return JSON that can be directly decoded into a Forecast object:

eitherDecode json :: Either String Forecast

Some of the ByteString libraries seem not to parse certain unicode characters correctly (or maybe it's an Aeson problem; this hasn't yet been determined). If your decoding fails, you may need to filter out certain of these characters before decoding. In particular, the degree symbol (Unicode character \176) has been known to cause decoding errors.

Another thing to be wary of is that potentially any field is not guaranteed to be returned in the JSON. This effectively makes every definition live within a Maybe.

Documentation

data DataPoint

Defines a single data point in the weather forecast. For a full explanation of the various records, please consult the official documentation.

Constructors

DataPoint

Fields

dataPoint_time :: Maybe Int

dataPoint_summary :: Maybe Text

dataPoint_icon :: Maybe Text

dataPoint_sunriseTime :: Maybe Int

dataPoint_sunsetTime :: Maybe Int

dataPoint_moonPhase :: Maybe Float

dataPoint_moonPhaseError :: Maybe Float

dataPoint_nearestStormDistance :: Maybe Float

dataPoint_nearestStormDistanceError :: Maybe Float

dataPoint_nearestStormBearing :: Maybe Float

dataPoint_nearestStormBearingError :: Maybe Float

dataPoint_precipIntensity :: Maybe Float

dataPoint_precipIntensityError :: Maybe Float

dataPoint_precipIntensityMax :: Maybe Float

dataPoint_precipIntensityMaxError :: Maybe Float

dataPoint_precipIntensityMaxTime :: Maybe Int

dataPoint_precipProbability :: Maybe Float

dataPoint_precipProbabilityError :: Maybe Float

dataPoint_precipType :: Maybe Text

dataPoint_precipAccumulation :: Maybe Float

dataPoint_precipAccumulationError :: Maybe Float

dataPoint_temperature :: Maybe Float

dataPoint_temperatureError :: Maybe Float

dataPoint_temperatureMin :: Maybe Float

dataPoint_temperatureMinError :: Maybe Float

dataPoint_temperatureMinTime :: Maybe Int

dataPoint_temperatureMax :: Maybe Float

dataPoint_temperatureMaxError :: Maybe Float

dataPoint_temperatureMaxTime :: Maybe Int

dataPoint_apparentTemperature :: Maybe Float

dataPoint_apparentTemperatureError :: Maybe Float

dataPoint_apparentTemperatureMin :: Maybe Float

dataPoint_apparentTemperatureMinError :: Maybe Float

dataPoint_apparentTemperatureMinTime :: Maybe Int

dataPoint_apparentTemperatureMax :: Maybe Float

dataPoint_apparentTemperatureMaxError :: Maybe Float

dataPoint_apparentTemperatureMaxTime :: Maybe Int

dataPoint_dewPoint :: Maybe Float

dataPoint_dewPointError :: Maybe Float

dataPoint_windSpeed :: Maybe Float

dataPoint_windSpeedError :: Maybe Float

dataPoint_windBearing :: Maybe Float

dataPoint_windBearingError :: Maybe Float

dataPoint_cloudCover :: Maybe Float

dataPoint_cloudCoverError :: Maybe Float

dataPoint_humidity :: Maybe Float

dataPoint_humidityError :: Maybe Float

dataPoint_pressure :: Maybe Float

dataPoint_pressureError :: Maybe Float

dataPoint_visibility :: Maybe Float

dataPoint_visibilityError :: Maybe Float

dataPoint_ozone :: Maybe Float

dataPoint_ozoneError :: Maybe Float

Instances

Read DataPoint

Show DataPoint

ToJSON DataPoint

FromJSON DataPoint

data DataBlock

Defines a summary "block" of information that can contain multiple DataPoints.

Constructors

DataBlock

Fields

dataBlock_summary :: Maybe Text

dataBlock_icon :: Maybe Text

dataBlock_data :: Maybe [DataPoint]

Instances

Read DataBlock

Show DataBlock

ToJSON DataBlock

FromJSON DataBlock

data Alerts

Defines severe weather alerts that may be being broadcast by a variety of weather services.

Constructors

Alerts

Fields

alerts_title :: Maybe Text

alerts_expires :: Maybe Int

alerts_description :: Maybe Text

alerts_uri :: Maybe Text

Instances

Read Alerts

Show Alerts

ToJSON Alerts

FromJSON Alerts

data Flags

Flags define general information about the returned data.

Constructors

Flags

Fields

flags_darksky_unavailable :: Maybe Text

flags_darksky_stations :: Maybe [Text]

flags_datapoint_stations :: Maybe [Text]

flags_isd_stations :: Maybe [Text]

flags_lamp_stations :: Maybe [Text]

flags_madis_stations :: Maybe [Text]

flags_metar_stations :: Maybe [Text]

flags_metno_license :: Maybe Text

flags_sources :: Maybe [Text]

flags_units :: Maybe Text

Instances

Read Flags

Show Flags

ToJSON Flags

FromJSON Flags

data Forecast

This is the container type for the returned data. You should be able to just directly take the downloaded JSON and transform it into this data type.

Constructors

Forecast

Fields

forecast_latitude :: Maybe Float

forecast_longitude :: Maybe Float

forecast_timezone :: Maybe Text

forecast_offset :: Maybe Float

forecast_currently :: Maybe DataPoint

forecast_minutely :: Maybe DataBlock

forecast_hourly :: Maybe DataBlock

forecast_daily :: Maybe DataBlock

forecast_alerts :: Maybe [Alerts]

forecast_flags :: Maybe Flags

Instances

Read Forecast

Show Forecast

ToJSON Forecast

FromJSON Forecast