An Android client for the Weather Underground Weather API
Java
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/main/java/com/fortysevendeg/android/wunderground/api/service
.gitignore
README.md
pom.xml

README.md

This library is no longer maintained. For all Android REST related features and better support please take a look at https://github.com/47deg/appsly-android-rest.

Android-wunderground-client

An Android client for the Weather Underground Weather API

Introduction

Android-wunderground-client was born out of the need to provide an easy interface for Android apps @ 47 Degrees to interface with Weather Underground's Weather API. Contributions and constructive feedback are always welcome.

Android-wunderground-client uses the open source RESTrung library for getting data from the Weather Underground API.

Download

Maven Dependency

Android-wunderground-client may be automatically imported into your project if you already use Maven. Just declare Android-wunderground-client as a maven dependency. If you wish to always use the latest unstable snapshots, add the Sonatype repository where the snapshot artifacts are being deployed. Official releases will be made available at Maven Central.

<repository>
    <id>sonatype</id>
    <url>https://oss.sonatype.org/content/groups/public/</url>
    <releases>
        <enabled>true</enabled>
        <updatePolicy>daily</updatePolicy>
        <checksumPolicy>fail</checksumPolicy>
    </releases>
    <snapshots>
        <enabled>true</enabled>
        <updatePolicy>always</updatePolicy>
        <checksumPolicy>ignore</checksumPolicy>
    </snapshots>
</repository>

<dependency>
    <groupId>com.fortysevendeg.android</groupId>
    <artifactId>android-wunderground-client</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

Other Downloads

You can get the releases, snapshots and other forms in which Android-wunderground-client is distributed from the Downloads page.

Usage

This library has a single method called "query". This method returns a WundergroundResponse class with all of the data from the Weather Underground API. The amount of data returned depends on the features parameter passed to the query method.

void query(APIDelegate<WundergroundResponse> delegate,
            String apiKey,
            Settings settings,
            Query query,
            FeatureParam... features);

Parameters

ApiKey

Your API key for Weather Underground's Weather API. Get one here

Settings (optional)

Settings relating to the returned data.

Language. Default: EN. Returns the API response in the specified language.

Settings settings = Settings.value(Setting.lang(Lang.EU));

Pws. Default: 1 (true). Use personal weather stations for conditions.

Settings settings = Settings.value(Setting.pws(false));

Bestfct. Default: 1 (true). Use Weather Undergrond Best Forecast for forecast.

Settings settings = Settings.value(Setting.bestfct(false));

You can combine multiple settings

Settings settings = Settings.value(Setting.lang(Lang.EU), Setting.pws(false), Setting.bestfct(false));

Query

The location for which you want weather information. Examples:

US state/city

Query.usStateCity("CA", "San_Francisco")

US ZipCode

Query.usZipCode("60290")

Country/city

Query.internationalStateCity("Australia", "Sydney")

Latitude,longitude

Query.latLng(37.8,-122.4)

FeatureParam

One or more of the following data features. Note that these can be combined into a single request. Complete list feature params is available here

alerts Returns the short name description, expiration time and a long text description of a severe alert — if one has been issued for the searched upon location.

astronomy Returns the moon phase, sunrise and sunset times.

conditions Returns the current temperature, weather condition, humidity, wind, 'feels like' temperature, barometric pressure, and visibility.

forecast Returns a summary of the weather for the next 3 days. This includes high and low temperatures, a string text forecast and the conditions.

webcams Returns locations of nearby Personal Weather Stations and URLs for images from their web cams.

Important!! The feature params "history" and "planner" are dates with the following format "history_YYYYMMDD" and "planner_YYYYMMDD". You can use the withSuffix method to achieve the correct format. Example:

withSuffix(Feature.history, "20120810")

Examples of use

The following example returns conditions (the current temperature, weather condition, humidity, wind, 'feels like' temperature, barometric pressure, and visibility from Weather Underground's Weather API) for a given latitude and longitude

    GeoPoint center = mapView.getMapCenter();
    WundergroundApiProvider.getClient().query(new ContextAwareAPIDelegate<WundergroundResponse>(MainActivity.this, WundergroundResponse.class, RequestCache.LoadPolicy.NEVER) {
        @Override
        public void onResults(WundergroundResponse wundergroundResponse) {
            Toast.makeText(MyActivity.this, wundergroundResponse.getCurrentObservation().getWeather(), Toast.LENGTH_LONG).show();
        }
        @Override
        public void onError(Throwable e) {
            Toast.makeText(MyActivity.this, "fail", Toast.LENGTH_LONG).show();
        }
    }, "Your API Key", Query.latLng(center.getLatitudeE6() / 1E6, center.getLongitudeE6() / 1E6), Feature.conditions);

The following example returns conditions and astronomy (the moon phase, sunrise and sunset times) for a given latitude and longitude

    GeoPoint center = mapView.getMapCenter();
    WundergroundApiProvider.getClient().query(new ContextAwareAPIDelegate<WundergroundResponse>(MainActivity.this, WundergroundResponse.class, RequestCache.LoadPolicy.NEVER) {
        @Override
        public void onResults(WundergroundResponse wundergroundResponse) {
            Toast.makeText(MyActivity.this, wundergroundResponse.getCurrentObservation().getWeather(), Toast.LENGTH_LONG).show();
        }
        @Override
        public void onError(Throwable e) {
            Toast.makeText(MyActivity.this, "fail", Toast.LENGTH_LONG).show();
        }
    }, "Your API Key", Query.latLng(center.getLatitudeE6() / 1E6, center.getLongitudeE6() / 1E6), Feature.conditions, Feature.astronomy);

The following example returns the planner (a weather summary based on historical information between the specified dates (30 days max)) for a given country and city

    WundergroundApiProvider.getClient().query(new ContextAwareAPIDelegate<WundergroundResponse>(MainActivity.this, WundergroundResponse.class, RequestCache.LoadPolicy.NEVER) {
        @Override
        public void onResults(WundergroundResponse wundergroundResponse) {
            Toast.makeText(MyActivity.this, wundergroundResponse.getCurrentObservation().getWeather(), Toast.LENGTH_LONG).show();
        }
        @Override
        public void onError(Throwable e) {
            Toast.makeText(MyActivity.this, "fail", Toast.LENGTH_LONG).show();
        }
    }, "Your API Key", Query.internationalStateCity("Australia", "Sydney"), withSuffix(Feature.planner, "20120810"));

The following example returns conditions for a given latitude/longitude and settings (FR language)

    GeoPoint center = mapView.getMapCenter();
    WundergroundApiProvider.getClient().query(new ContextAwareAPIDelegate<WundergroundResponse>(MainActivity.this, WundergroundResponse.class, RequestCache.LoadPolicy.NEVER) {
        @Override
        public void onResults(WundergroundResponse wundergroundResponse) {
            Toast.makeText(MyActivity.this, wundergroundResponse.getCurrentObservation().getWeather(), Toast.LENGTH_LONG).show();
        }
        @Override
        public void onError(Throwable e) {
            Toast.makeText(MyActivity.this, "fail", Toast.LENGTH_LONG).show();
        }
    }, "Your API Key", Settings.value(Setting.lang(Lang.FR)), Query.latLng(center.getLatitudeE6() / 1E6, center.getLongitudeE6() / 1E6), Feature.conditions);

License

Copyright (C) 2012 47 Degrees, LLC http://47deg.com
hello@47deg.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Terms of Service

Make sure to consult the Weather Underground Terms of Service for applicable restrictions for usage of the API.