OpenWeatherMap-Android-Library
You need an API Key to use the OpenWeatherMap API. Head on over to their website if you don't already have one.
Download
Step 1. Add the JitPack repository to your root build.gradle file.
allprojects {
repositories {
...
maven {
url 'https://jitpack.io'
}
}
}
Step 2 : Download via Gradle:
compile 'com.github.KwabenBerko:OpenWeatherMap-Android-Library:v1.1.1'Note: Remember to include the INTERNET permission to your manifest file
Usage
Instantiate the OpenWeatherMapHelper class
OpenWeatherMapHelper helper = new OpenWeatherMapHelper();
Set your API Key (Required)
helper.setApiKey(getString(R.string.OPEN_WEATHER_MAP_API_KEY));
Set your Units (Optional, Kelvin by default)
helper.setUnits(Units.IMPERIAL);
Unit Options:
-
Units.IMPERIAL (Fahrenheit) -
Units.METRIC (Celsius)
Features
(1) Current Weather
Get current weather by City Name:
helper.getCurrentWeatherByCityName("Accra", new OpenWeatherMapHelper.CurrentWeatherCallback() {
@Override
public void onSuccess(CurrentWeather currentWeather) {
Log.v(TAG,
"Coordinates: " + currentWeather.getCoord().getLat() + ", "+currentWeather.getCoord().getLat() +"\n"
+"Weather Description: " + currentWeather.getWeatherArray().get(0).getDescription() + "\n"
+"Max Temperature: " + currentWeather.getMain().getTempMax()+"\n"
+"Wind Speed: " + currentWeather.getWind().getSpeed() + "\n"
+"City, Country: " + currentWeather.getName() + ", " + currentWeather.getSys().getCountry()
);
}
@Override
public void onFailure(Throwable throwable) {
Log.v(TAG, throwable.getMessage());
}
}
);
Get current weather by City ID:
helper.getCurrentWeatherByCityID("524901", new OpenWeatherMapHelper.CurrentWeatherCallback() {
@Override
public void onSuccess(CurrentWeather currentWeather) {
Log.v(TAG,
"Coordinates: " + currentWeather.getCoord().getLat() + ", "+currentWeather.getCoord().getLat() +"\n"
+"Weather Description: " + currentWeather.getWeatherArray().get(0).getDescription() + "\n"
+"Max Temperature: " + currentWeather.getMain().getTempMax()+"\n"
+"Wind Speed: " + currentWeather.getWind().getSpeed() + "\n"
+"City, Country: " + currentWeather.getName() + ", " + currentWeather.getSys().getCountry()
);
}
@Override
public void onFailure(Throwable throwable) {
Log.v(TAG, throwable.getMessage());
}
}
);
Get current weather by Geographic Coordinates:
helper.getCurrentWeatherByGeoCoordinates(5.6037, 0.1870, new OpenWeatherMapHelper.CurrentWeatherCallback() {
@Override
public void onSuccess(CurrentWeather currentWeather) {
Log.v(TAG,
"Coordinates: " + currentWeather.getCoord().getLat() + ", "+currentWeather.getCoord().getLat() +"\n"
+"Weather Description: " + currentWeather.getWeatherArray().get(0).getDescription() + "\n"
+"Max Temperature: " + currentWeather.getMain().getTempMax()+"\n"
+"Wind Speed: " + currentWeather.getWind().getSpeed() + "\n"
+"City, Country: " + currentWeather.getName() + ", " + currentWeather.getSys().getCountry()
);
}
@Override
public void onFailure(Throwable throwable) {
Log.v(TAG, throwable.getMessage());
}
}
);
Get current weather by Zip Code:
helper.getCurrentWeatherByZipCode("90003", new OpenWeatherMapHelper.CurrentWeatherCallback() {
@Override
public void onSuccess(CurrentWeather currentWeather) {
Log.v(TAG,
"Coordinates: " + currentWeather.getCoord().getLat() + ", "+currentWeather.getCoord().getLat() +"\n"
+"Weather Description: " + currentWeather.getWeatherArray().get(0).getDescription() + "\n"
+"Max Temperature: " + currentWeather.getMain().getTempMax()+"\n"
+"Wind Speed: " + currentWeather.getWind().getSpeed() + "\n"
+"City, Country: " + currentWeather.getName() + ", " + currentWeather.getSys().getCountry()
);
}
@Override
public void onFailure(Throwable throwable) {
Log.v(TAG, throwable.getMessage());
}
}
);
(2) 5 day / 3 hour forecast
Get three hour forecast by City Name:
helper.getThreeHourForecastByCityName("Pretoria", new OpenWeatherMapHelper.ThreeHourForecastCallback() {
@Override
public void onSuccess(ThreeHourForecast threeHourForecast) {
Log.v(TAG,
"City/Country: "+ threeHourForecast.getCity().getName() + "/" + threeHourForecast.getCity().getCountry() +"\n"
+"Forecast Array Count: " + threeHourForecast.getCnt() +"\n"
//For this example, we are logging details of only the first forecast object in the forecasts array
+"First Forecast Date Timestamp: " + threeHourForecast.getThreeHourWeatherArray().get(0).getDt() +"\n"
+"First Forecast Weather Description: " + threeHourForecast.getThreeHourWeatherArray().get(0).getWeatherArray().get(0).getDescription()+ "\n"
+"First Forecast Max Temperature: " + threeHourForecast.getThreeHourWeatherArray().get(0).getMain().getTempMax()+"\n"
+"First Forecast Wind Speed: " + threeHourForecast.getThreeHourWeatherArray().get(0).getWind().getSpeed() + "\n"
);
}
@Override
public void onFailure(Throwable throwable) {
Log.v(TAG, throwable.getMessage());
}
}
);
Get three hour forecast by City ID:
helper.getThreeHourForecastByCityID("524901", new OpenWeatherMapHelper.ThreeHourForecastCallback() {
@Override
public void onSuccess(ThreeHourForecast threeHourForecast) {
Log.v(TAG,
"City/Country: "+ threeHourForecast.getCity().getName() + "/" + threeHourForecast.getCity().getCountry() +"\n"
+"Forecast Array Count: " + threeHourForecast.getCnt() +"\n"
//For this example, we are logging details of only the first forecast object in the forecasts array
+"First Forecast Date Timestamp: " + threeHourForecast.getThreeHourWeatherArray().get(0).getDt() +"\n"
+"First Forecast Weather Description: " + threeHourForecast.getThreeHourWeatherArray().get(0).getWeatherArray().get(0).getDescription()+ "\n"
+"First Forecast Max Temperature: " + threeHourForecast.getThreeHourWeatherArray().get(0).getMain().getTempMax()+"\n"
+"First Forecast Wind Speed: " + threeHourForecast.getThreeHourWeatherArray().get(0).getWind().getSpeed() + "\n"
);
}
@Override
public void onFailure(Throwable throwable) {
Log.v(TAG, throwable.getMessage());
}
}
);
Get three hour forecast by Geographic Coordinates:
helper.getThreeHourForecastByGeoCoordinates(6.5244,3.3792, new OpenWeatherMapHelper.ThreeHourForecastCallback() {
@Override
public void onSuccess(ThreeHourForecast threeHourForecast) {
Log.v(TAG,
"City/Country: "+ threeHourForecast.getCity().getName() + "/" + threeHourForecast.getCity().getCountry() +"\n"
+"Forecast Array Count: " + threeHourForecast.getCnt() +"\n"
//For this example, we are logging details of only the first forecast object in the forecasts array
+"First Forecast Date Timestamp: " + threeHourForecast.getThreeHourWeatherArray().get(0).getDt() +"\n"
+"First Forecast Weather Description: " + threeHourForecast.getThreeHourWeatherArray().get(0).getWeatherArray().get(0).getDescription()+ "\n"
+"First Forecast Max Temperature: " + threeHourForecast.getThreeHourWeatherArray().get(0).getMain().getTempMax()+"\n"
+"First Forecast Wind Speed: " + threeHourForecast.getThreeHourWeatherArray().get(0).getWind().getSpeed() + "\n"
);
}
@Override
public void onFailure(Throwable throwable) {
Log.v(TAG, throwable.getMessage());
}
}
);
Get three hour forecast by Zip Code:
helper.getThreeHourForecastByZipCode("94040", new OpenWeatherMapHelper.ThreeHourForecastCallback() {
@Override
public void onSuccess(ThreeHourForecast threeHourForecast) {
Log.v(TAG,
"City/Country: "+ threeHourForecast.getCity().getName() + "/" + threeHourForecast.getCity().getCountry() +"\n"
+"Forecast Array Count: " + threeHourForecast.getCnt() +"\n"
//For this example, we are logging details of only the first forecast object in the forecasts array
+"First Forecast Date Timestamp: " + threeHourForecast.getThreeHourWeatherArray().get(0).getDt() +"\n"
+"First Forecast Weather Description: " + threeHourForecast.getThreeHourWeatherArray().get(0).getWeatherArray().get(0).getDescription()+ "\n"
+"First Forecast Max Temperature: " + threeHourForecast.getThreeHourWeatherArray().get(0).getMain().getTempMax()+"\n"
+"First Forecast Wind Speed: " + threeHourForecast.getThreeHourWeatherArray().get(0).getWind().getSpeed() + "\n"
);
}
@Override
public void onFailure(Throwable throwable) {
Log.v(TAG, throwable.getMessage());
}
}
);
Upcoming Feature
- 16 day / daily forecast