jacobtomlinson / datapoint-js Goto Github PK

A JavaScript library for accessing UK weather data via the Met Office's open data API known as Datapoint.

License: GNU General Public License v3.0

JavaScript 100.00%

datapoint-js's Introduction

DataPoint for JavaScript

A JavaScript library for accessing weather data via the Met Office's open data API known as DataPoint.

Disclaimer: This module is in no way part of the DataPoint project/service. This module is intended to simplify the use of DataPoint for JavaScript projects. No support for this module is provided by the Met Office and may break as the DataPoint service grows/evolves. The author will make reasonable efforts to keep it up to date and fully featured.

Features

List forecast/observation sites
Get nearest forecast/observation site from longitude and latitiude
Get the following 5 day forecast types for any site
Daily (Two timesteps, midday and midnight UTC)
3 hourly (Eight timesteps, every 3 hours starting at midnight UTC)
Get hourly observations for the last 48 hours
Get regional forecasts for the next 30 days (Grouped in four timesteps)

Installation

NodeJS

npm install datapoint-js

Manual

Download the contents /src (for node) and include them in your project.

Example Usage

Node

var datapoint = require('datapoint-js')

datapoint.set_key("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")

site = datapoint.get_nearest_forecast_site(-0.124626, 51.500728)

forecast = datapoint.get_forecast_for_site(site.id, "3hourly")

current_timestep = forecast.days[0].timesteps[0]

console.log("Temperature is " + current_timestep.temperature.value + "°" + current_timestep.temperature.units + " in " + site.name)

Output

Temperature is 15°C in London

Contributing changes

Please feel free to submit issues and pull requests.

To work on the project simply clone the project and run npm install.

This project uses gulp as its task runner and can be used to browserify the code and generate the documentation.

Documentation

Documentation can be automatically generated using JSDoc by running gulp document.

License

GPL v3

datapoint-js's People

Contributors

Stargazers

Watchers

Forkers

rossburton

datapoint-js's Issues

Cinema

It's raining, here are the cinema listings.

Bug in example

var obs_site = datapoint.get_nearest_obs_site(lon, lat)
var forecast_site = datapoint.get_nearest_obs_site(lon, lat)

I think you meant get_nearest_forecast_site in the second line.

Requirements

High level requirements:

Features:

Get all sites
Get nearest site
Get forecast for site (3hourly and daily)
Text forecast element

Install with bower

The projects has not had any bower work done. This needs adding.

Synchronous requests

Browser shows warning

Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check http://xhr.spec.whatwg.org/.

Obs for multiple IDs

Datapoint API allows "all" and comma separated list of IDs. Maybe add this functionality to get_obs_for_site.

Or catch the resulting error. i.e.

TypeError: Cannot read property 'length' of undefined
at Object.module.exports.clean_days (/Users/mike/Documents/openshift/nodejs/node_modules/datapoint-js/src/obs.js:30:33)
at Object.module.exports.get_obs_for_site (/Users/mike/Documents/openshift/nodejs/node_modules/datapoint-js/src/obs.js:21:27)
at Object.module.exports.get_obs_for_site (/Users/mike/Documents/openshift/nodejs/node_modules/datapoint-js/src/datapoint.js:73:16)

As bower doesn't work this way then maybe it should be dropped and npm used exclusively.