aping-plugin-openweathermap v0.8.0

apiNG-plugin-openweathermap is a OpenWeatherMap API plugin for apiNG.

Information

• Supported apiNG models: weather
• This plugin supports the get-native-data parameter
• This plugin needs an api key :warning:
• Used promise library: angular-openweathermap-api-factory (included in distribution files)

Documentation

1. INSTALLATION
   1. Get file
   2. Include file
   3. Add dependency
   4. Add plugin
2. API KEY
   1. Generate your api_key
   2. Insert your api_key into aping-config.js
3. USAGE
   1. Models
   2. Requests
   3. Rate limit

1. INSTALLATION

I. Get file

Install via either bower, npm, CDN (jsDelivr) or downloaded files:

• bower install apiNG-plugin-openweathermap --save
• npm install aping-plugin-openweathermap --save
• use CDN file
• download apiNG-plugin-openweathermap.zip

II. Include file

Include aping-plugin-openweathermap.min.js in your apiNG application

<!-- when using bower -->
<script src="bower_components/apiNG-plugin-openweathermap/dist/aping-plugin-openweathermap.min.js"></script>

<!-- when using npm -->
<script src="node_modules/aping-plugin-openweathermap/dist/aping-plugin-openweathermap.min.js"></script>

<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/aping.plugin-openweathermap/latest/aping-plugin-openweathermap.min.js"></script>

<!-- when using downloaded files -->
<script src="aping-plugin-openweathermap.min.js"></script>

III. Add dependency

Add the module jtt_aping_openweathermap as a dependency to your app module:

angular.module('app', ['jtt_aping', 'jtt_aping_openweathermap']);

IV. Add the plugin

Add the plugin's directive aping-openweathermap="[]" to your apiNG directive and configure your requests

<aping
    template-url="templates/weather.html"
    model="weather"
    aping-openweathermap="[{'cityName':'munich'}]>
</aping>

2. API KEY

I. Get your api_key

1. Login on openweathermap.org
2. Open home.openweathermap.org
   • There is your api_key

II. Insert your api_key into aping-config.js

Create and open js/apiNG/aping-config.js in your application folder. It should be look like this snippet:

angular.module('jtt_aping').config(['$provide', function ($provide) {
    $provide.value("apingDefaultSettings", {
        apingApiKeys : {
            'openweathermap': [
                {'api_key':'<YOUR_OPENWEATHERMAP_API_KEY>'}
            ],
            //...
        }
    });
}]);

:warning: Replace <YOUR_OPENWEATHERMAP_API_KEY> with your api_key

3. USAGE

I. Models

Supported apiNG models

II. Requests

Every apiNG plugin expects an array of requests as html attribute.

Requests by City name

Sample requests:

• [{'cityName':'london'}, {'cityName':'ney work city', 'units':'imperial'}]
• [{'cityName':'berlin', 'countryCode':'de', 'language':'de', 'timeSlot':'forecast5'}]

Requests by City ID

Sample requests:

• [{'cityId':'2172797', 'units':'imperial'}]

Requests by Zip code

Sample requests:

• [{'cityName':'94040', 'countryCode':'us', 'language':'de'}]

Requests by Coordinates

Sample requests:

• [{'lat':'-13.163333', 'lng':'-72.545556', 'language':'es'}]

III. Rate limit

Visit the official OpenWeatherMap Price List

Calls per	Free
minute (no more than)	60
day (no more than)	50,000

Licence

MIT