You're viewing old version number 18. - Current version

2 min

Perl ForecastIO module README for GitHub

ForecastIO.pm

This Perl wrapper API is used to process weather data that is provided in JSON format by forecast.io.

Related: forecast.io developer API info. From the forecast.io website:

"The easiest, most advanced, weather API on the web. The same API that powers Forecast.io and Dark Sky for iOS can provide accurate short­term and long­term weather predictions to your business, application, or crazy idea."

A working example that uses this Perl module can be found at Toledo Weather. This weather Web app uses jQuery mobile on the client side. Several Perl scripts execute at different intervals in cron that fetch RSS, custom XML, and HTML files from the National Weather Service to provide the data for display. The forecast.io section of this Web app uses a small part of this Perl module. Code for the entire Toledo weather Web app exists on GitHub at ToledoWX.

Perl Module

This ForecastIO.pm Perl module was inspired by the PHP forecast.io wrapper located at tobias-redmann/forecast.io-php-api.

Usage

View the test Perl script in the bin directory.

Also, view the output file, created by the above test script.

Include the module in your program.

perl use ForecastIO;

Set your API key and location.

perl my $forecast = ForecastIO->new($api_key, $latitude, $longitude);

Download JSON data and convert it to a Perl hash.

perl $forecast->fetch_data;

Alerts

Forecast.io data includes special weather statements, watches, and warnings that have been issued by the National Weather Service, such as Severe Thunderstorm Warning, Heat Advisory, etc.

if ( @alerts ) {  
    foreach my $a ( @alerts ) {  
        print "alert =       " . $a->alert_title  . "\n";  
        print "uri =         " . $a->alert_uri . "\n";  
        print "expires =     " . ForecastIOUtils::format_date($a->alert_expires) . "\n";  
        print "description = " . $a->alert_description . "\n";  
    }  
}  

See below in the Utilities section, concerning ForecastIOUtils.

Current Conditions

Get the object for the current conditions.

perl my $currently = $forecast->currently;

Get methods available for the currently object:

perl $currently->time
$currently->summary
$currently->icon
$currently->temperature
$currently->dewPoint
$currently->windBearing
$currently->windSpeed
$currently->pressure
$currently->humidity
$currently->ozone
$currently->precipProbability
$currently->cloudCover
$currently->cloudCover
$currently->precipIntensity
$currently->precipType
$currently->visibility

NEx

Utilities

I like the raw data provided by forecast.io. It provides the user or developer with options on how to display the data. Some of the forecast.io data needs additional processing or formatting to display it in a more "normal" way. The ForecastIO.pm module also contains a utilities package.

Each subroutine is preceded by ForecastIOUtils::

perl format_date($currently->time)
degrees_to_cardinal($currently->windBearing)
round($currently->windSpeed)
round($currently->temperature)
round($currently->dewPoint)
millibars_to_inches($currently->pressure)
cloud_cover_description($currently->cloudCover)
calc_intensity($currently->precipIntensity)
calc_intensity_color($currently->precipIntensity)

format_date

Forecast.io contains date and time in epoch seconds. The format_date subroutine returns info in the format as: 2013-07-10T17:57:36Z which is ISO 8601 format.

If no epoch seconds are passed to subroutine, then format_date returns the current date and time.

You can modify the format_date subroutine to produce a different format. And you can play with the precipitation intensity subroutine to produce text values that seem more appropriate with your own observations. Thus far, I think the text-based intensity values returned in this module match my observations in Toledo, Ohio.

From JR's : articles
491 words - 3818 chars - 2 min read
created on
updated on - #
source - versions



A     A     A     A     A

© 2013-2017 JotHut - Online notebook

current date: Nov 15, 2024 - 4:43 a.m. EST