widget/weather.lua

   1
   2 --[[
   3
   4      Licensed under GNU General Public License v2
   5       * (c) 2015, Luke Bonham
   6
   7 --]]
   8
   9 local helpers  = require("lain.helpers")
  10 local json     = require("lain.util").dkjson
  11 local focused  = require("awful.screen").focused
  12 local naughty  = require("naughty")
  13 local wibox    = require("wibox")
  14 local math     = { floor    = math.floor }
  15 local os       = { time     = os.time,
  16                    date     = os.date,
  17                    difftime = os.difftime }
  18 local string   = { format   = string.format,
  19                    gsub     = string.gsub }
  20 local tonumber = tonumber
  21
  22 -- OpenWeatherMap
  23 -- current weather and X-days forecast
  24 -- lain.widget.weather
  25
  26 local function factory(args)
  27     local weather               = { widget = wibox.widget.textbox() }
  28     local args                  = args or {}
  29     local APPID                 = args.APPID or "3e321f9414eaedbfab34983bda77a66e" -- lain default
  30     local timeout               = args.timeout or 900   -- 15 min
  31     local timeout_forecast      = args.timeout or 86400 -- 24 hrs
  32     local current_call          = args.current_call  or "curl -s 'http://api.openweathermap.org/data/2.5/weather?id=%s&units=%s&lang=%s&APPID=%s'"
  33     local forecast_call         = args.forecast_call or "curl -s 'http://api.openweathermap.org/data/2.5/forecast/daily?id=%s&units=%s&lang=%s&cnt=%s&APPID=%s'"
  34     local city_id               = args.city_id or 0 -- placeholder
  35     local utc_offset            = args.utc_offset or
  36                                   function ()
  37                                       local now = os.time()
  38                                       return os.difftime(now, os.time(os.date("!*t", now))) + ((os.date("*t").isdst and 1 or 0) * 3600)
  39                                   end
  40     local units                 = args.units or "metric"
  41     local lang                  = args.lang or "en"
  42     local cnt                   = args.cnt or 5
  43     local date_cmd              = args.date_cmd or "date -u -d @%d +'%%a %%d'"
  44     local icons_path            = args.icons_path or helpers.icons_dir .. "openweathermap/"
  45     local notification_preset   = args.notification_preset or {}
  46     local notification_text_fun = args.notification_text_fun or
  47                                   function (wn)
  48                                       local day = os.date("%a %d", wn["dt"])
  49                                       local tmin = math.floor(wn["temp"]["min"])
  50                                       local tmax = math.floor(wn["temp"]["max"])
  51                                       local desc = wn["weather"][1]["description"]
  52                                       return string.format("<b>%s</b>: %s, %d - %d ", day, desc, tmin, tmax)
  53                                   end
  54     local weather_na_markup     = args.weather_na_markup or " N/A "
  55     local followtag             = args.followtag or false
  56     local settings              = args.settings or function() end
  57
  58     weather.widget:set_markup(weather_na_markup)
  59     weather.icon_path = icons_path .. "na.png"
  60     weather.icon = wibox.widget.imagebox(weather.icon_path)
  61
  62     function weather.show(t_out)
  63         weather.hide()
  64
  65         if followtag then
  66             notification_preset.screen = focused()
  67         end
  68
  69         if not weather.notification_text then
  70             weather.update()
  71             weather.forecast_update()
  72         end
  73
  74         weather.notification = naughty.notify({
  75             text    = weather.notification_text,
  76             icon    = weather.icon_path,
  77             timeout = t_out,
  78             preset  = notification_preset
  79         })
  80     end
  81
  82     function weather.hide()
  83         if weather.notification then
  84             naughty.destroy(weather.notification)
  85             weather.notification = nil
  86         end
  87     end
  88
  89     function weather.attach(obj)
  90         obj:connect_signal("mouse::enter", function()
  91             weather.show(0)
  92         end)
  93         obj:connect_signal("mouse::leave", function()
  94             weather.hide()
  95         end)
  96     end
  97
  98     function weather.forecast_update()
  99         local cmd = string.format(forecast_call, city_id, units, lang, cnt, APPID)
 100         helpers.async(cmd, function(f)
 101             local pos, err
 102             weather_now, pos, err = json.decode(f, 1, nil)
 103
 104             if not err and type(weather_now) == "table" and tonumber(weather_now["cod"]) == 200 then
 105                 weather.notification_text = ''
 106                 for i = 1, weather_now["cnt"] do
 107                     weather.notification_text = weather.notification_text ..
 108                                                 notification_text_fun(weather_now["list"][i])
 109
 110                     if i < weather_now["cnt"] then
 111                         weather.notification_text = weather.notification_text .. "\n"
 112                     end
 113                 end
 114             end
 115         end)
 116     end
 117
 118     function weather.update()
 119         local cmd = string.format(current_call, city_id, units, lang, APPID)
 120         helpers.async(cmd, function(f)
 121             local pos, err, icon
 122             weather_now, pos, err = json.decode(f, 1, nil)
 123
 124             if not err and type(weather_now) == "table" and tonumber(weather_now["cod"]) == 200 then
 125                 -- weather icon based on localtime
 126                 local now     = os.time()
 127                 local sunrise = tonumber(weather_now["sys"]["sunrise"])
 128                 local sunset  = tonumber(weather_now["sys"]["sunset"])
 129                 local icon    = weather_now["weather"][1]["icon"]
 130                 local loc_m   = os.time { year = os.date("%Y"), month = os.date("%m"), day = os.date("%d"), hour = 0 }
 131                 local offset  = utc_offset()
 132                 local utc_m   = loc_m - offset
 133
 134                 if offset > 0 and (now - utc_m)>=86400 then
 135                     utc_m = utc_m + 86400
 136                 elseif offset < 0 and (utc_m - now)>=86400 then
 137                     utc_m = utc_m - 86400
 138                 end
 139
 140                 -- if we are 1 day after the GMT, return 1 day back, and viceversa
 141                 if offset > 0 and loc_m >= utc_m then
 142                     now = now - 86400
 143                 elseif offset < 0 and loc_m <= utc_m then
 144                     now = now + 86400
 145                 end
 146
 147                 if sunrise <= now and now <= sunset then
 148                     icon = string.gsub(icon, "n", "d")
 149                 else
 150                     icon = string.gsub(icon, "d", "n")
 151                 end
 152
 153                 weather.icon_path = icons_path .. icon .. ".png"
 154                 widget = weather.widget
 155                 settings()
 156             else
 157                 weather.icon_path = icons_path .. "na.png"
 158                 weather.widget:set_markup(weather_na_markup)
 159             end
 160
 161             weather.icon:set_image(weather.icon_path)
 162         end)
 163     end
 164
 165     weather.attach(weather.widget)
 166
 167     weather.timer = helpers.newtimer("weather-" .. city_id, timeout, weather.update, false, true)
 168     weather.timer_forecast = helpers.newtimer("weather_forecast-" .. city_id, timeout, weather.forecast_update, false, true)
 169
 170     return weather
 171 end
 172
 173 return factory