summaryrefslogtreecommitdiff
path: root/weather-widget/weather.lua
blob: b0aa070c2a14cd8502e8bd89eb05aea65ce0295f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
-------------------------------------------------
-- Weather Widget based on the OpenWeatherMap
-- https://openweathermap.org/
--
-- @author Pavel Makhov
-- @copyright 2018 Pavel Makhov
-------------------------------------------------

local socket = require("socket")
local http = require("socket.http")
local ltn12 = require("ltn12")
local json = require("json")
local naughty = require("naughty")
local wibox = require("wibox")
local gears = require("gears")

local path_to_icons = "/usr/share/icons/Arc/status/symbolic/"

local weather_widget = {}

local function worker(args)

    local args = args or {}

    local font = args.font or 'Play 9'
    local city = args.city or 'Montreal,ca'
    local api_key = args.api_key or naughty.notify{preset = naughty.config.presets.critical, text = 'OpenweatherMap API key is not set'}
    local units = args.units or 'metric'
    local both_units_widget = args.both_units_widget or false
    local both_units_popup = args.both_units_popup or false

    local weather_api_url = (
            'https://api.openweathermap.org/data/2.5/weather'
                    .. '?q='     .. city
                    .. '&appid=' .. api_key
                    .. '&units=' .. units
    )

    local icon_widget = wibox.widget {
        {
            id = "icon",
            resize = false,
            widget = wibox.widget.imagebox,
        },
        layout = wibox.container.margin(_, 0, 0, 3),
        set_image = function(self, path)
            self.icon.image = path
        end,
    }

    local temp_widget = wibox.widget {
        font = font,
        widget = wibox.widget.textbox,
    }

    weather_widget = wibox.widget {
        icon_widget,
        temp_widget,
        layout = wibox.layout.fixed.horizontal,
    }

    --- Maps openWeatherMap icons to Arc icons
    local icon_map = {
        ["01d"] = "weather-clear-symbolic.svg",
        ["02d"] = "weather-few-clouds-symbolic.svg",
        ["03d"] = "weather-clouds-symbolic.svg",
        ["04d"] = "weather-overcast-symbolic.svg",
        ["09d"] = "weather-showers-scattered-symbolic.svg",
        ["10d"] = "weather-showers-symbolic.svg",
        ["11d"] = "weather-storm-symbolic.svg",
        ["13d"] = "weather-snow-symbolic.svg",
        ["50d"] = "weather-fog-symbolic.svg",
        ["01n"] = "weather-clear-night-symbolic.svg",
        ["02n"] = "weather-few-clouds-night-symbolic.svg",
        ["03n"] = "weather-clouds-night-symbolic.svg",
        ["04n"] = "weather-overcast-symbolic.svg",
        ["09n"] = "weather-showers-scattered-symbolic.svg",
        ["10n"] = "weather-showers-symbolic.svg",
        ["11n"] = "weather-storm-symbolic.svg",
        ["13n"] = "weather-snow-symbolic.svg",
        ["50n"] = "weather-fog-symbolic.svg"
    }

    --- Return wind direction as a string.
    local function to_direction(degrees)
        -- Ref: https://www.campbellsci.eu/blog/convert-wind-directions
        if degrees == nil then
            return "Unknown dir"
        end
        local directions = {
            "N",
            "NNE",
            "NE",
            "ENE",
            "E",
            "ESE",
            "SE",
            "SSE",
            "S",
            "SSW",
            "SW",
            "WSW",
            "W",
            "WNW",
            "NW",
            "NNW",
            "N",
        }
        return directions[math.floor((degrees % 360) / 22.5) + 1]
    end

    -- Convert degrees Celsius to Fahrenheit
    local function celsius_to_fahrenheit(c)
        return c*9/5+32
    end

    -- Convert degrees Fahrenheit to Celsius
    local function fahrenheit_to_celsius(f)
        return (f-32)*5/9
    end

    local weather_timer = gears.timer({ timeout = 60 })
    local resp

    local function gen_temperature_str(temp, fmt_str, show_other_units)
        local temp_str = string.format(fmt_str, temp)
        local s =  temp_str .. '°' .. (units == 'metric' and 'C' or 'F')

        if (show_other_units) then
            local temp_conv, units_conv
            if (units == 'metric') then
                temp_conv = celsius_to_fahrenheit(temp)
                units_conv = 'F'
            else
                temp_conv = fahrenheit_to_celsius(temp)
                units_conv = 'C'
            end

            local temp_conv_str = string.format(fmt_str, temp_conv)
            s = s .. ' ' ..  '('.. temp_conv_str .. '°' .. units_conv .. ')'
        end
        return s
    end

    weather_timer:connect_signal("timeout", function ()
        local resp_json = {}
        local res, status = http.request{
            url=weather_api_url,
            sink=ltn12.sink.table(resp_json),
            -- ref:
            -- http://w3.impa.br/~diego/software/luasocket/old/luasocket-2.0/http.html
            create=function()
                -- ref: https://stackoverflow.com/a/6021774/595220
                local req_sock = socket.tcp()
                -- 't' — overall timeout
                req_sock:settimeout(0.2, 't')
                -- 'b' — block timeout
                req_sock:settimeout(0.001, 'b')
                return req_sock
            end
        }
        if (resp_json ~= nil) then
            resp_json = table.concat(resp_json)
        end

        if (status ~= 200 and resp_json ~= nil and resp_json ~= '') then
            local err_resp = json.decode(resp_json)
            naughty.notify{
                title = 'Weather Widget Error',
                text = err_resp.message,
                preset = naughty.config.presets.critical,
            }
        elseif (resp_json ~= nil and resp_json ~= '') then
            resp = json.decode(resp_json)
            icon_widget.image = path_to_icons .. icon_map[resp.weather[1].icon]
            temp_widget:set_text(gen_temperature_str(resp.main.temp, '%.0f', both_units_widget))
        end
    end)
    weather_timer:start()
    weather_timer:emit_signal("timeout")

    --- Notification with weather information. Popups when mouse hovers over the icon
    local notification
    weather_widget:connect_signal("mouse::enter", function()
        notification = naughty.notify{
            icon = path_to_icons .. icon_map[resp.weather[1].icon],
            icon_size=20,
            text =
                '<big>' .. resp.weather[1].main .. ' (' .. resp.weather[1].description .. ')</big><br>' ..
                '<b>Humidity:</b> ' .. resp.main.humidity .. '%<br>' ..
                '<b>Temperature:</b> ' .. gen_temperature_str(resp.main.temp, '%.1f',
                                              both_units_popup) .. '<br>' ..
                '<b>Pressure:</b> ' .. resp.main.pressure .. 'hPa<br>' ..
                '<b>Clouds:</b> ' .. resp.clouds.all .. '%<br>' ..
                '<b>Wind:</b> ' .. resp.wind.speed .. 'm/s (' .. to_direction(resp.wind.deg) .. ')',
            timeout = 5, hover_timeout = 10,
            width = (both_units_popup == true and 210 or 200)
        }
    end)

    weather_widget:connect_signal("mouse::leave", function()
        naughty.destroy(notification)
    end)

    return weather_widget
end

return setmetatable(weather_widget, { __call = function(_, ...)
    return worker(...)
end })