A JavaScript library for accessing UK weather data via the Met Office's open data API known as Datapoint.
JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

DataPoint for JavaScript Build Status

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