awesome-wm-widgets/weather-widget
pingarelho 4768d48a3b Fix documentation inconsistencies (mainly tables) 2023-09-20 23:01:55 +01:00
..
icons [weather] fix #161 + redesign with breaking change 2020-07-12 17:36:28 -04:00
locale Adding a Portuguese language file to the weather widget locale 2022-06-25 13:21:07 -03:00
README.md Fix documentation inconsistencies (mainly tables) 2023-09-20 23:01:55 +01:00
both.png [weather] fix #176 - support negative temp 2020-10-19 23:16:28 -04:00
example1.png [weather] fix #176 - support negative temp 2020-10-19 23:16:28 -04:00
example2.png [weather] fix #176 - support negative temp 2020-10-19 23:16:28 -04:00
example_response.json [weather] fix #176 - support negative temp 2020-10-19 23:16:28 -04:00
negative.png [weather] fix #176 - support negative temp 2020-10-19 23:16:28 -04:00
weather-widget.png [weather] fix #176 - support negative temp 2020-10-19 23:16:28 -04:00
weather.lua Treat C-locale in the weather widget as English 2022-05-10 00:33:34 +02:00

README.md

Weather widget

GitHub issues by-label Twitter URL

The widget showing current, hourly and daily weather forecast:

screenshot

The widget consists of three sections:

  • current weather, including humidity, wind speed, UV index
  • hourly forecast for the next 24 hours
  • daily forecast for the next five days

Customization

It is possible to customize widget by providing a table with all or some of the following config parameters:

Name Default Description
coordinates Required Table with two elements: latitude and longitude, e.g. {46.204400, 6.143200}
api_key Required Get it here
font_name beautiful.font:gsub("%s%d+$", "") Name of the font to use e.g. 'Play'
both_units_widget false Show temperature in both units - '28°C (83°F)
units metric metric for celsius, imperial for fahrenheit
show_hourly_forecast false Show hourly forecase section
time_format_12h false 12 or 24 hour format (13:00 - default or 1pm)
show_daily_forecast false Show daily forecast section
icon_pack_name weather-underground-icons Name of the icon pack, could be weather-underground-icon or VitalyGorbachev or create your own, more details below
icons_extension .png File extension of icons in the pack
timeout 120 How often in seconds the widget refreshes

Icons:

The widget comes with two predefined icon packs:

  • weather-underground-icons taken from here
  • VitalyGorbachev taken from here

To add your custom icons, create a folder with the pack name under /icons and use the folder name in widget's config. There should be 18 icons, preferably 128x128 minimum. Icons should also respect the naming convention, please check widget's source.

Examples:

Custom font, icons

example1

weather_curl_widget({
    api_key='<your-key>',
    coordinates = {45.5017, -73.5673},
    time_format_12h = true,
    units = 'imperial',
    both_units_widget = true,
    font_name = 'Carter One',
    icons = 'VitalyGorbachev',
    icons_extension = '.svg',
    show_hourly_forecast = true,
    show_daily_forecast = true,
}),

Only current weather

example2

weather_curl_widget({
    api_key='<your-key>',
    coordinates = {45.5017, -73.5673},
}),

Installation

  1. Download json parser for lua from github.com/rxi/json.lua and place it under ~/.config/awesome/ (don't forget to star a repo ):

    wget -P ~/.config/awesome/ https://raw.githubusercontent.com/rxi/json.lua/master/json.lua
    
  2. Clone this repo under ~/.config/awesome/:

    git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
    
  3. Get Open Weather Map app id here: openweathermap.org/appid.

  4. Require weather widget at the beginning of rc.lua:

    local weather_widget = require("awesome-wm-widgets.weather-widget.weather")
    
  5. Add widget to the tasklist:

    s.mytasklist, -- Middle widget
        { -- Right widgets
            layout = wibox.layout.fixed.horizontal,
            ...
            --default
            weather_widget({
                api_key='<your-key>',
                coordinates = {45.5017, -73.5673},
            }),
            ,
            --customized
            weather_curl_widget({
                api_key='<your-key>',
                coordinates = {45.5017, -73.5673},
                time_format_12h = true,
                units = 'imperial',
                both_units_widget = true,
                font_name = 'Carter One',
                icons = 'VitalyGorbachev',
                icons_extension = '.svg',
                show_hourly_forecast = true,
                show_daily_forecast = true,
            }),
            ...
    

More screenshots

Only negative temperature:

negative

Both positive and negative tempertature:

both

How it works

TBW