Merge pull request #3910 from Rengyr/master

Weather: Add v2 weather parsing in Weather App (forecast support)

Author: thyttan

apps/weather/ChangeLog

@@ -26,3 +26,9 @@
 0.27: Add UV index display
 0.28: Fix UV positioning, hide when 0
 0.29: Add feels-like temperature data and clock_info
+0.30: Refactor code to more modern javascript style
+      Split settings and weather data into two files in storage
+      Add support for new version of weather data and forecast from GadgetBridge (requires version 0.86.0 or higher)
+      Add support to automatically fetch weather at time interval defined in settings (requires GadgetBridge version 0.86.0 or higher)
+      Add button to settings to force fetch weather data (requires GadgetBridge version 0.86.0 or higher)
+      Add new API to get weather from Weather App for other Apps

apps/weather/README.md

@@ -3,7 +3,7 @@
 This allows your Bangle.js to display weather reports from the Gadgetbridge app for an Android phone, or by using the iOS shortcut below to push weather information.
 
 It adds a widget with a weather pictogram and the temperature.
-It also adds a ClockInfo list to Bangle.js. 
+It also adds a ClockInfo list to Bangle.js.
 You can view the full report through the app:
 
 ![Screenshot](screenshot.png)
@@ -12,35 +12,35 @@ You can view the full report through the app:
 
 Use the iOS shortcut [here](https://www.icloud.com/shortcuts/73be0ce1076446f3bdc45a5707de5c4d). The shortcut uses Apple Weather for weather updates, and sends a notification, which is read by Bangle.js. To push weather every hour, or interval, you will need to create a shortcut automation for every time you want to push the weather.
 
-
 ## Android Setup
 
-1. Install [Gadgetbridge for Android](https://f-droid.org/packages/nodomain.freeyourgadget.gadgetbridge/) on your phone.
-2. Set up [Gadgetbridge weather reporting](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Weather).
-
-If using the `Bangle.js Gadgetbridge` app on your phone (as opposed to the standard F-Droid `Gadgetbridge`) you need to set the package name
-to `com.espruino.gadgetbridge.banglejs` in the settings of the weather app (`settings -> gadgetbridge support -> package name`).
+1. Install [Gadgetbridge for Android](https://f-droid.org/packages/nodomain.freeyourgadget.gadgetbridge/) on your phone
+2. Set up [Gadgetbridge weather reporting](https://gadgetbridge.org/basics/features/weather/)
 
 ### Android Weather Apps
 
-There are two weather apps for Android that can connect with Gadgetbridge:
+There are multiple weather apps for Android that can connect with Gadgetbridge:
 
 * Tiny Weather Forecast Germany
- * F-Droid - https://f-droid.org/en/packages/de.kaffeemitkoffein.tinyweatherforecastgermany/
- * Source code - https://codeberg.org/Starfish/TinyWeatherForecastGermany
- 
+  * F-Droid - https://f-droid.org/en/packages/de.kaffeemitkoffein.tinyweatherforecastgermany/
+  * Source code - https://codeberg.org/Starfish/TinyWeatherForecastGermany
+
 * QuickWeather
- * F-Droid - https://f-droid.org/en/packages/com.ominous.quickweather/
- * Google Play - https://play.google.com/store/apps/details?id=com.ominous.quickweather
- * Source code - https://github.com/TylerWilliamson/QuickWeather
- 
+  * F-Droid - https://f-droid.org/en/packages/com.ominous.quickweather/
+  * Google Play - https://play.google.com/store/apps/details?id=com.ominous.quickweather
+  * Source code - https://github.com/TylerWilliamson/QuickWeather
+
+* Breezy Weather
+  * F-Droid - https://f-droid.org/en/packages/org.breezyweather/
+  * Source code - https://github.com/breezy-weather/breezy-weather
+
 ### Tiny Weather Forecast Germany
 
 Even though Tiny Weather Forecast Germany is made for Germany, it can be used around the world. To do this:
- 
+
 1. Tap on the three dots in the top right hand corner and go to settings
 2. Go down to Location and tap on the checkbox labeled "Use location services". You may also want to check on the "Check Location checkbox". Alternatively, you may select the "manual" checkbox and choose your location.
-3. Scroll down further to the "other" section and tap "Gadgetbridge support". Then tap on "Enable". You may also choose to tap on "Send current time". 
+3. Scroll down further to the "other" section and tap "Gadgetbridge support". Then tap on "Enable". You may also choose to tap on "Send current time".
 4. If you're using the specific Gadgetbridge for Bangle.JS app, you'll want to tap on "Package name." In the dialog box that appears, you'll want to put in "com.espruino.gadgetbridge.banglejs" without the quotes. If you're using the original Gadgetbridge, leave this as the default.
 
 ### QuickWeather
@@ -51,9 +51,17 @@ If you're using OpenWeatherMap you will need the "One Call By Call" plan, which
 
 When you first load QuickWeather, it will take you through the setup process. You will fill out all the required information as well as put your API key in. If you do not have the "One Call By Call", or commonly known as "One Call", API, you will need to sign up for that. QuickWeather will work automatically with both the main version of Gadgetbridge and Gadgetbridge for Bangle.JS.
 
+### Breezy Weather
+
+Enabling connection to Gadgetbridge:
+
+1. Tap on the three dots in the top right hand corner and go to settings
+2. Find "Widgets & Live wallpaper" settings
+3. Under "Data sharing" tap on "Send Gadgetbridge data" and enable for Gadgetbridge flavor you are using
+
 ### Weather Notification
 
-**Note:** at one time, the Weather Notification app also worked with Gadgetbridge. However, many users are reporting it's no longer seeing the OpenWeatherMap API key as valid. The app has not received any updates since August of 2020, and may be unmaintained. 
+**Note:** at one time, the Weather Notification app also worked with Gadgetbridge. However, many users are reporting it's no longer seeing the OpenWeatherMap API key as valid. The app has not received any updates since August of 2020, and may be unmaintained.
 
 ## Clock Infos
 
@@ -67,7 +75,9 @@ Adds:
 
 ## Settings
 
-* Expiration timespan can be set after which the local weather data is considered as invalid
+* Expiration time span can be set after which the local weather data is considered as invalid
+* Automatic weather data request interval can be set (weather data are pushed to Bangle automatically, but this can help in cases when it fails) (requires Gadgetbridge v0.86+)
+* Extended or forecast weather data can be enabled (this requires other App to use this data, Weather App itself doesn't show the forecast data) (requires Gadgetbridge v0.86+)
 * Widget can be hidden
 * To change the units for wind speed, you can install the [`Languages app`](https://banglejs.com/apps/?id=locale) which
 allows you to choose the units used for speed/distance/temperature and so on.
@@ -76,3 +86,44 @@ allows you to choose the units used for speed/distance/temperature and so on.
 
 * BTN2: opens the launcher (Bangle.js 1)
 * BTN: opens the launcher (Bangle.js 2)
+
+## Weather App API
+
+Note: except `getWeather()` and `get()` it is android only for now
+
+Weather App can provide weather and forecast data to other Apps.
+
+* Get weather data without forecast/extended:
+  ```javascript
+   const weather = require("weather");
+   weatherData = weather.getWeather(false);  // or weather.get()
+  ```
+
+* Get weather data with forecast/extended (needs forecast/extended enabled in settings):
+  ```javascript
+   const weather = require("weather");
+   weatherData = weather.getWeather(true);
+  ```
+
+* Fetch new data from Gadgetbridge:
+  ```javascript
+   const weather = require("weather");
+   weather.updateWeather(false); // Can set to true if we want to ignore debounce
+  ```
+
+* React to updated weather data:
+  ```javascript
+   const weather = require("weather");
+
+   // For weather data without forecast
+   weather.on("update", () => {
+     currentData = weather.getWeather(false);
+     // console.log(currentData);
+   }
+
+   // For weather data with forecast
+   weather.on("update2", () => {
+     currentData = weather.getWeather(true);
+     // console.log(currentData);
+   }
+  ```

apps/weather/app.js

@@ -16,24 +16,24 @@ var layout = new Layout({type:"v", bgCol: g.theme.bg, c: [
         render: l => {
           if (!current || current.uv === undefined) return;
           const uv = Math.min(parseInt(current.uv), 11); // Cap at 11
-          
+
           // UV color thresholds: [max_value, color] based on WHO standards
           const colors = [[2,"#0F0"], [5,"#FF0"], [7,"#F80"], [10,"#F00"], [11,"#F0F"]];
           const color = colors.find(c => uv <= c[0])[1];
-          
+
           // Setup and measure label
           g.setFont("6x8").setFontAlign(-1, 0);
           const label = "UV: ";
           const labelW = g.stringWidth(label);
-          
+
           // Calculate centered position (4px block + 1px spacing) * blocks - last spacing
           const totalW = labelW + uv * 5 - (uv > 0 ? 1 : 0);
           const x = l.x + (l.w - totalW) / 2;
           const y = l.y + l.h+6;
-          
+
           // Draw label
           g.setColor(g.theme.fg).drawString(label, x, y);
-          
+
           // Draw UV blocks
           g.setColor(color);
           for (let i = 0; i < uv; i++) {
@@ -58,7 +58,7 @@ var layout = new Layout({type:"v", bgCol: g.theme.bg, c: [
         {type: "txt", font: "6x8", pad: 2, halign: 1, label: /*LANG*/"Hum:"},
         {type: "txt", font: "9%", pad: 2, halign: 1, id: "hum", label: "000%"},
       ]},
-      
+
       {filly: 1},
       {type: "txt", font: "6x8", pad: 2, halign: -1, label: /*LANG*/"Wind"},
       {type: "h", halign: -1, c: [
@@ -79,7 +79,7 @@ var layout = new Layout({type:"v", bgCol: g.theme.bg, c: [
 ]}, {lazy: true});
 
 function formatDuration(millis) {
-  let pluralize = (n, w) => n + " " + w + (n == 1 ? "" : "s");
+  let pluralize = (n, w) => `${n} ${w}${n === 1 ? "" : "s"}`;
   if (millis < 60000) return /*LANG*/"< 1 minute";
   if (millis < 3600000) return pluralize(Math.floor(millis/60000), /*LANG*/"minute");
   if (millis < 86400000) return pluralize(Math.floor(millis/3600000), /*LANG*/"hour");
@@ -98,11 +98,11 @@ function draw() {
   }else{
     layout.feelslike.label = feelsLikeTemp[1]+feelsLikeTemp[2];
   }
-  
-  layout.hum.label = current.hum+"%";
+
+  layout.hum.label = `${current.hum}%`;
   const wind = locale.speed(current.wind).match(/^(\D*\d*)(.*)$/);
   layout.wind.label = wind[1];
-  layout.windUnit.label = wind[2] + " " + (current.wrose||'').toUpperCase();
+  layout.windUnit.label = `${wind[2]} ${(current.wrose||'').toUpperCase()}`;
   layout.cond.label = current.txt.charAt(0).toUpperCase()+(current.txt||'').slice(1);
   layout.loc.label = current.loc;
   layout.updateTime.label = `${formatDuration(Date.now() - current.time)} ago`; // How to autotranslate this and similar?

apps/weather/clkinfo.js

@@ -1,5 +1,4 @@
-
-(function() {
+(() => {
     var weather;
     var weatherLib = require("weather");
 
@@ -8,9 +7,9 @@
       if(weather){
         weather.temp = require("locale").temp(weather.temp-273.15);
         weather.feels = require("locale").temp(weather.feels-273.15);
-        weather.hum = weather.hum + "%";
+        weather.hum = `${weather.hum}%`;
         weather.wind = require("locale").speed(weather.wind).match(/^(\D*\d*)(.*)$/);
-        weather.wind = Math.round(weather.wind[1]) + "kph";
+        weather.wind = `${Math.round(weather.wind[1])}kph`;
       } else {
         weather = {
           temp: "?",