iobroker.swiss-weather-api

2.1.0 • Public • Published

Logo

ioBroker.swiss-weather-api

NPM version Downloads Number of Installations (latest) Number of Installations (stable) Known Vulnerabilities GitHub issues GitHub Workflow Status

NPM

swiss-weather-api adapter for ioBroker

Connects to the great SRF weather API - Version 2 (https://developer.srgssr.ch/api-catalog/srf-weather/srf-weather-description). The SRF Weather REST API allows you to get weather forecasts and reports from more than 25.000 locations across Switzerland. A "Freemium" subscription allows you to get 25 Request/day.

Please Be aware:

  1. This adapter only supports locations within Switzerland.
  2. SRF Weather API V1 is supported until Adapter-Version 1.0.6. SRF Weather API V2 is supported from Version 2.0.0

Update procedure Version 1.x.x to 2.0.x

  • Remove the adapter (delete all Adapter-Objects in ioBroker!)
  • Install Adapter completly new => New Objects will be generated
  • Since SRF has changed the Path-Names, you have to update your Visu. Just reimport the views.

Getting started

  1. Get a free accout on https://developer.srgssr.ch/
  2. Go to "Apps" and add new App. Here you can choose a API-Product. "SRF-MeteoProductFreemium" is their free product. If you only want a forecast for one location and get only 25 request per day (every 60min) or/and don't want to pay for more request per day, "SRF-MeteoProductFreemium" is what you want to choose. Now, this will create a specific ConsumerKey and ConsumerSecret
  3. Find out Longitude / Latitude (decimal degrees) of the chosen location for which forecast is needed. This information is optional if you have set your location in the ioBroker settings (main settings) (via the map). In this case you could leave the latitude and longitude fields empty. The adapter then ueses the settings of the ioBroker. Latitude and longitude entered in the adapter configuration override the ioBroker settings.
  4. Install this Adapter on ioBroker => This can take several minutes (~7min on a Raspberry Pi 3)
  5. On Adapter Configuration fill in
    1. Name of App
    2. ConsumerKey of App
    3. ConsumerSecret of App
    4. Longitude / Latitude of the chosen swiss location for which forecast is needed. => Please use decimal degrees (for example Zürich: 47.36667 / 8.5)
    5. Poll Interval in Minutes (By default 60 minutes - 25 Request/Day)

The first query is made 10s after the adapter was started. After the first start, the query will be executed regularly according to the conifugation parameter (Poll Interval in Minutes). The Objects in forecast.current_hour will be createt 30s after frist startup and updated every hour by copying the corresponding values from forecast.hours.

Visualisation Example

Prerequisite:
Example

Simple Example: Tablet

Extended Example: Tablet

Week-Widget Example: Tablet

Changelog

2.1.0 (2024-01-10)

2.0.4-alpha.2 (2023-09-06)

  • (baerengraben) Dummy-Deploy - because npm did not get 2.0.4-alpha.1 (2nd try...)

2.0.4-alpha.1 (2023-09-05)

2.0.4-alpha.0 (2023-08-03)

  • (baerengraben) Adding four new hour-based Views
  • (baerengraben) JSON-Chart is now starting with 00:00 instead of 01:00
  • (baerengraben) SRF sometimes delivers more and sometimes less daily data. This can lead to old data in certain objects. To prevent this, I delete the entire object tree with each new call to rebuild it.

2.0.3 (2023-08-01)

License

MIT License

Copyright (c) 2024 baerengraben baerengraben@intelli.ch

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Dependencies (3)

Dev Dependencies (23)

Package Sidebar

Install

npm i iobroker.swiss-weather-api

Weekly Downloads

39

Version

2.1.0

License

MIT

Unpacked Size

176 kB

Total Files

20

Last publish

Collaborators

  • bluefox
  • baerengraben