https://github.com/johnnythetank/aping-plugin-openweathermap
OpenWeatherMap Plugin for apiNG
https://github.com/johnnythetank/aping-plugin-openweathermap
angular api aping aping-plugin openweathermap openweathermap-api owm weather weather-api
Last synced: 3 months ago
JSON representation
OpenWeatherMap Plugin for apiNG
- Host: GitHub
- URL: https://github.com/johnnythetank/aping-plugin-openweathermap
- Owner: JohnnyTheTank
- License: mit
- Created: 2015-12-12T21:32:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-09-26T10:07:05.000Z (over 8 years ago)
- Last Synced: 2025-02-21T16:13:42.031Z (4 months ago)
- Topics: angular, api, aping, aping-plugin, openweathermap, openweathermap-api, owm, weather, weather-api
- Language: JavaScript
- Size: 30.3 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[logo]: http://aping.io/logo/320/aping-plugin.png "apiNG Plugin"
![apiNG][logo]
[](https://gitter.im/JohnnyTheTank/apiNG?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://badge.fury.io/js/aping-plugin-openweathermap)
[](https://badge.fury.io/bo/apiNG-plugin-openweathermap)
**_apiNG-plugin-openweathermap_** is a [OpenWeatherMap API](http://openweathermap.org/api) plugin for [**apiNG**](https://github.com/JohnnyTheTank/apiNG).
# Information
* **Supported apiNG models: `weather`**
* This plugin supports the [`get-native-data` parameter](https://aping.readme.io/docs/advanced#parameters)
* This plugin needs an [api key](#2-api-key) :warning:
* Used promise library: [angular-openweathermap-api-factory](https://github.com/JohnnyTheTank/angular-openweathermap-api-factory) _(included in distribution files)_
# Documentation
1. [INSTALLATION](#1-installation)
1. Get file
2. Include file
3. Add dependency
4. Add plugin
2. [API KEY](#2-api-key)
1. Generate your `api_key`
2. Insert your `api_key` into `aping-config.js`
3. [USAGE](#3-usage)
1. Models
2. Requests
3. Rate limit
## 1. INSTALLATION
### I. Get file
Install via either [bower](http://bower.io/), [npm](https://www.npmjs.com/), CDN (jsDelivr) or downloaded files:
* `bower install apiNG-plugin-openweathermap --save`
* `npm install aping-plugin-openweathermap --save`
* use [CDN file](https://www.jsdelivr.com/projects/aping.plugin-openweathermap)
* download [apiNG-plugin-openweathermap.zip](https://github.com/JohnnyTheTank/apiNG-plugin-openweathermap/zipball/master)
### II. Include file
Include `aping-plugin-openweathermap.min.js` in your apiNG application
```html
```
### III. Add dependency
Add the module `jtt_aping_openweathermap` as a dependency to your app module:
```js
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](#ii-requests)
```html
'}
],
//...
}
});
}]);
```
:warning: Replace `` with your `api_key`
## 3. USAGE
### I. Models
Supported apiNG models
| model | content |
|----------|---------|
| `weather` | **weather data** |
### II. Requests
Every **apiNG plugin** expects an array of **requests** as html attribute.
#### Requests by City name
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| **`cityName`** | `berlin` | | You can call by city name | no |
| **`countryCode`** | `de` | | ISO 3166 country codes | yes |
| **`timeSlot`** | `forecast5` | `now` | Valid values: `now` and `forecast5` (5 days forecast) | yes |
| **`type`** | `like` | | To set the accuracy level either use the `accurate` or `like` type parameter. `accurate` returns exact match values. `like` returns results by searching for that substring | yes |
| **`units`** | `imperial` | `metric` | Temperature is available in Fahrenheit, Celsius and Kelvin units. For temperature in Fahrenheit use `imperial`. For temperature in Celsius use `metric`. For temperature in Kelvin use `kelvin` | yes |
| **`language`** | `ru` | `en` | English: `en`, Russian: `ru`, Italian: `it`, Spanish: `es` (or `sp`), Ukrainian: `uk` (or `ua`), German: `de`, Portuguese: `pt`, Romanian: `ro`, Polish: `pl`, Finnish: `fi`, Dutch: `nl`, French: `fr`, Bulgarian: `bg`, Swedish: `sv` (or `se`), Chinese Traditional: `zh_tw`, Chinese Simplified: `zh` (or `zh_cn`), Turkish: `tr`, Croatian: `hr`, Catalan: `ca` | yes |
Sample requests:
* `[{'cityName':'london'}, {'cityName':'ney work city', 'units':'imperial'}]`
* `[{'cityName':'berlin', 'countryCode':'de', 'language':'de', 'timeSlot':'forecast5'}]`
#### Requests by City ID
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| **`cityId`** | `2172797` | | You can call by city ID. API responds with exact result. List of city ID city.list.json.gz can be downloaded [here](http://bulk.openweathermap.org/sample/). | no |
| **`timeSlot`** | `forecast5` | `now` | Valid values: `now` and `forecast5` (5 days forecast) | yes |
| **`units`** | `imperial` | `metric` | Temperature is available in Fahrenheit, Celsius and Kelvin units. For temperature in Fahrenheit use `imperial`. For temperature in Celsius use `metric`. For temperature in Kelvin use `kelvin` | yes |
| **`language`** | `ru` | `en` | English: `en`, Russian: `ru`, Italian: `it`, Spanish: `es` (or `sp`), Ukrainian: `uk` (or `ua`), German: `de`, Portuguese: `pt`, Romanian: `ro`, Polish: `pl`, Finnish: `fi`, Dutch: `nl`, French: `fr`, Bulgarian: `bg`, Swedish: `sv` (or `se`), Chinese Traditional: `zh_tw`, Chinese Simplified: `zh` (or `zh_cn`), Turkish: `tr`, Croatian: `hr`, Catalan: `ca` | yes |
Sample requests:
* `[{'cityId':'2172797', 'units':'imperial'}]`
#### Requests by Zip code
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| **`zip`** | `94040` | | You can call by zip Code | no |
| **`countryCode`** | `us` | | ISO 3166 country codes | no |
| **`units`** | `imperial` | `metric` | Temperature is available in Fahrenheit, Celsius and Kelvin units. For temperature in Fahrenheit use `imperial`. For temperature in Celsius use `metric`. For temperature in Kelvin use `kelvin` | yes |
| **`language`** | `ru` | `en` | English: `en`, Russian: `ru`, Italian: `it`, Spanish: `es` (or `sp`), Ukrainian: `uk` (or `ua`), German: `de`, Portuguese: `pt`, Romanian: `ro`, Polish: `pl`, Finnish: `fi`, Dutch: `nl`, French: `fr`, Bulgarian: `bg`, Swedish: `sv` (or `se`), Chinese Traditional: `zh_tw`, Chinese Simplified: `zh` (or `zh_cn`), Turkish: `tr`, Croatian: `hr`, Catalan: `ca` | yes |
Sample requests:
* `[{'cityName':'94040', 'countryCode':'us', 'language':'de'}]`
#### Requests by Coordinates
| parameter | sample | default | description | optional |
|----------|---------|---------|---------|---------|
| **`lat`** | `-13.163333` | | latitude of the location of your interest | no |
| **`lng`** | `-72.545556` | | longitude of the location of your interest | no |
| **`timeSlot`** | `forecast5` | `now` | Valid values: `now` and `forecast5` (5 days forecast) | yes |
| **`units`** | `imperial` | `metric` | Temperature is available in Fahrenheit, Celsius and Kelvin units. For temperature in Fahrenheit use `imperial`. For temperature in Celsius use `metric`. For temperature in Kelvin use `kelvin` | yes |
| **`language`** | `ru` | `en` | English: `en`, Russian: `ru`, Italian: `it`, Spanish: `es` (or `sp`), Ukrainian: `uk` (or `ua`), German: `de`, Portuguese: `pt`, Romanian: `ro`, Polish: `pl`, Finnish: `fi`, Dutch: `nl`, French: `fr`, Bulgarian: `bg`, Swedish: `sv` (or `se`), Chinese Traditional: `zh_tw`, Chinese Simplified: `zh` (or `zh_cn`), Turkish: `tr`, Croatian: `hr`, Catalan: `ca` | yes |
Sample requests:
* `[{'lat':'-13.163333', 'lng':'-72.545556', 'language':'es'}]`
### III. Rate limit
Visit the official [OpenWeatherMap Price List](http://openweathermap.org/price)
> | Calls per | Free |
> |----------|---------|
| **minute** (no more than) | 60 |
| **day** (no more than) | 50,000 |
# Licence
MIT