owmbeat

README

Open Weather Map Beat (owmbeat)

Welcome to Owmbeat.

Owmbeat implements one (start simple) api call from OmenWeatherMap service.

You can configure Cities within a rectangle zone

Example API call might look like following

http://api.openweathermap.org/data/2.5/box/city?bbox=12,32,15,37,10

Installation

Download and install appropriate package for your system. Check release page for latest packages.

You also can use Docker image docker pull radoondas/owmbeat

Configuration

To run owmbeat you need to register and generate your appid to authenticate your API requests.

  appid: "yourappid"

Period definition defines how often to pull data from service. This time period depends on your level of subscription. For free API id does not make sense to pull new documents less than 1h. Set period to 1h.

  period: 1m

Next, define your regions. Each region is one bbox definition from api call. YOu can define multiple regions to cover different areas.

  regions:
    - region:
      enabled: true
      name: "Slovakia"
      description: "Somewhere in Europe"
      lon-left: 16
      lat-bottom: 47
      lon-right: 23
      lat-top: 50
      zoom: 10

Run

./owmbeat -c owmbeat.yml -e 

Build

If you want to build Owmbeat from scratch, follow build documentation.