Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 2.79 KB

README.md

File metadata and controls

88 lines (70 loc) · 2.79 KB

Weather module for Fitbit OS

This library permits to retrieve weather information from the device.
You can choose your favourite weather provider between Yahoo, OpenWeatherMap, DarkSky and WeatherUnderground Weatherbit

Usage

Copy the common/weather folder in your commons folder

Companion

Create an index.js file in the companion folder if you don't already have one.
Add the following code in this file :

import Weather from '../common/weather/phone';
let weather = new Weather();

App

Add the following code in your app/index.js file

import Weather from '../common/weather/device';

let weather = new Weather();
weather.setProvider("yahoo"); 
weather.setApiKey("mykey");
weather.setMaximumAge(25 * 1000); 
weather.setFeelsLike(true);

weather.onsuccess = (data) => {
  console.log("Weather is " + JSON.stringify(data));
}

weather.onerror = (error) => {
  console.log("Weather error " + error);
}

weather.fetch();

API

  • setProvider(string) : set the weather provider (possible values are yahoo, owm, wunderground, darksky or weatherbit). Default is yahoo
  • setApiKey(string) : set the api key for your provider. Default is ``
  • setFeelsLike(boolean) : some providers can return the apparent temperature. Default is true
  • setMaximumAge(int) : set the maximum age in milliseconds of a possible cached weather data that is acceptable to return. Default is 0
  • onsuccess(data) : it is the event handler when the weather data arrives
  • onerror(error) : it is the event handler when the library fails
  • fetch() : retrieve the weather
  • getData() : returns the last known weather data. This can be useful to display the weather when your app/face starts. The old data is automatically stored by the library and restored when the Weather object is created.

Example of result

  {
    "temperatureC":15,
    "temperatureF":59,
    "location":"Castelnau-D'Estretefonds",
    "description":"Mostly Clear",
    "isDay":false,
    "conditionCode":0,
    "realConditionCode":"this is the real conditioncode returned by the provider",
    "sunrise":1507442496594,
    "sunset":1507483356594,
    "timestamp":1507496916594
  }

Condition codes

let Conditions = {
  ClearSky        : 0,
  FewClouds       : 1,
  ScatteredClouds : 2,
  BrokenClouds    : 3,
  ShowerRain      : 4,
  Rain            : 5,
  Thunderstorm    : 6,
  Snow            : 7,
  Mist            : 8,
  Unknown         : 1000,
};

Contribution

I'm not a javascript expert so every comment/code reactoring/best practice is appreciated. Don't hesitate to make PR and tell me what's wrong.