conkywx help

USAGE ^ 

NAME ^ 

• conkywx − Program to display weather information using conky

• For latest conkywx updates visit this Blog

SYNOPSIS ^ 

• conkywx [-c or --config with path] [-t or --template with path]
  conkywx [-c or --config with path] [-d or --data element]

• conkywx without options or parameters will start Conkywx Assistant

DESCRIPTION ^ 

• conkywx gets the weather data from various websites and displays the information using conky. This just helps in not having a web page open all the time - though that may have it’s own benefits.
• I have used other weather programs but all RSS or json feeds are too limited - one has to refer to the data on the web pages. Thus we have a solution which gets the job done.
• The program does it’s own calculations for:
• Trends - 15 in all
• Trend Graphs using lua - Temperature, Wind Speed, Wind Gust, Humidity, Dew Point and Pressure.
• UV condition
• Perl Date, time, time zones and strftime recoded - though some parts based on earlier work.
• Feels like or apparent temperature also known as heat index.
• Astronomy Information a C module magellan which gives out information required by conkywx - sun and moon rise, moon phase etc. This module also decodes METAR information.
• Conkywx will automatically check once every 24 hours for new release of conkywx.

• A smooth scroller [up, down, left, right and bounce] - a long time pending request - A First for Conky
• RSS reader
• Global Disaster Alert and Coordination System
• View latest News from any news service that has a RSS feed

• UV data from Copyright © KNMI/ESA
• Seismic data from USGS and EMSC
• Tidal data
• Satellite images for storms and wind patterns
• Current weather from 6 websites
• Forecast weather 8 to 10 days from 3 websites
• Historical data for weather graphs from 2 websites
• Animated Windvane [Lua]
• Animated Anemometer [Lua]
• Dynamic Moon
• Font to Image
• Trend Graphs
• Scrolling Weather Alerts
• Active Weather Alerts
• Tropical Weather Storm Warnings
• Moon Works for Both Hemispheres

GETTING STARTED ^ 

To get Help

• Type conkywx in the terminal - will give you conkywx assistant and type 2 to read the conkywx help documentation in your browser.
• Except on Arch Linux - the astronomy module magellan is pre-compiled and will run on 64 bit, 32 bit and Atom systems. On Arch Linux this is compiled during installation.

What is Required

• Your conky version must be 1.10x or above - use conky -v to check the version of your conky program.
• Learn how to install Perl modules at CPAN
• Fonts required for VinDSL conky template.
• Dependencies for Arch Linux are cmake, perl, wget and lua 5.3.
• If you are using Arch Linux - it is strongly recommended to use the AUR packages conky_cairo - These have been uploaded by the author and you will be delighted with the speed increment.

Stand Alone Version

• Run conkywx_fonts_assistant.sh to install or remove conkywx fonts - located in the conkywx directory. It asks for user password as required.
• Read the file things_a_stand_alone_user_needs_to_do.txt and be guided.
• Run conkywx_fonts_assistant.sh to install fonts. It asks for user password if required.

You will need to make changes to the conky rc files for *own_window_type* depending on your Desktop Environment and/or the Window Manager. There 2 files which can assist you in making these changes - rpm_own_window_Fix.sh and deb_own_window_Fix.sh. You may use these files to make further changes by editing them as required. In the Installation Version this is already done.

To use conkywx - use the script run-conkywx.sh - this is an example script.

The config files conkywx.conf and conkywx-02.conf are located in the conkywx examples directory. See the conkywx --help -> Troubleshooting -> Files - to see which templates are using which config file.

Installation Version

• The idea is to reduce help desk activities and make it really simple for the user to play around and edit the templates as required.
• A copy is made of the examples folder in /.config/conkywx/examples190409 - the number 190409 in examples190409 is the conkywx version number. This version number show above is an example and your current working version will be different. This way the earlier examples are not over written. See Lets get started below for more information.
• If you are using Gnome 3 - own_window_type in the *conkyrc.sh in examples directory needs to be changed to normal, desktop or dock - see what works for your system.

Lets get started

• check if conky is working
• Type conky in a terminal window prompt - if you can see black box with some text on it… means your conky is working !!! You can type killall conky to stop that process.
• check if conkywx is working
• Open a terminal window and type /usr/share/conkywx/run-conkywx.sh at the prompt and press Enter key. You should see some text indicating files being downloaded and finally get some weather on the desktop.
• Once you do this a new folder will be created /.config/conkywx/examples190409 - this will contain a copy of all conky resource files, conkywx configs and templates etc which were located at /usr/share/conkywx/examples folder.
• In the event you only see data being downloaded and nothing on the desktop - check the own_window_type - take a look at /.config/conkywx/examples190409/conky-restart.sh file and see the default rc ( conky config/resource files with rc at the end of the file name ) files used depending on your version of conky.
• Subsequent running of conkywx
• /.config/conkywx/examples190409/conky-restart.sh ^[ 1 ] can be used to run conky and conkywx. This file can be copied to any location to run conkywx.
• To switch templates
• Edit /.config/conkywx/examples190409/conky-restart.sh and comment the current template line and un-comment the another template line. You can add your existing or new conky configs in this file.
• To customize templates
• Modify templates in /.config/conkywx/examples190409 folder.
• How to reset the /.config/conkywx/examples190409 folder
• You MUST rename or delete this folder and run /usr/share/conkywx/run-conkywx.sh - otherwise the original content at /usr/share/conkywx/examples will not be copied.
• How to get weather for your location
• Edit the conkywx config file .conf - excluding system.conf - there are 5 conf files of interest. The name of the conf file is self explanatory except that most of the templates use either conkywx.conf or conkywx-02.conf. See FILES section.
• This should get you going

1. ^ This number 190409 is the conkywx version number and will be different for the version you finally install.

OPTIONS ^ 

-h

• will launch Conkywx Weather Program Assistant

--help

• will launch this help file in your browser.

-v, --version

• show conkywx version number

-c, --config

• This defines the location and name of conkywx config file to use.
• To use multiple locations - multiple conky config files can be used - but - you will also need separate conkyrc and template files.

-t, --template ^[ 1 ]

• This defines the location and name of conkywx template file to use.
• This program can use the template concept for updating a conky file. This is not to be confused with conky’s own in built user variable template. The benefits are that less code for the conkyrc file and the update is in one burst using a single call to execpi.
• Template files are the same data that you would normally place in a conkyrc file but here you place it in a separate file and give its location in the conkyrc file - see the example directory. This gets rid of putting execpi call for each element that needs to be called and then shown. Using execpi is also said to be a huge resource hog as per the Conky Documentation.
• Each weather element to be placed in square brackets ^[ 2 ] like so [BF] for Bearing font character. Look in the example directory for ideas - but it will be like ${image [PIC] -p 12,20 -s 100x100} - the [PIC] will be automatially be replaced by the full path of the image.

-d, --data ^[ 3 ]

• This program can also use individual data elements ^[ 4 ] in the conkyrc directly by placing element after -d or --data.
• Multiple locations can also be checked by placing a separate config file for each required element in one conkyrc.
• See examples below.

1. ^ To get template based weather output from conkywx we need three files. The rc file - passed to conky program with -c option. The config file - passed to conkywx program in the rc file above. The template file - passed to conkywx program in the rc file above.
For example conkywx -c config file -t template file

2. ^ Square brackets "[ ]" are only required in templates - where -d option is used no square brackets to be used.

3. ^ Using single -d or --data elements could be relatively slow.

4. ^ For a list of data elements see below WEATHER DATA ELEMENTS.

CONKYWX ASSISTANT ^ 

• This utility is there to assist you in certain tasks which are required under certain conditions. You will need to choose from numbers 1 to 6 as displayed below.
• Available options are:
• 1 - Quick HELP with conkywx weather program
• Show short help message and usage

• 2 - Refer to off-line conkywx WIKI Manual in your browser
• Show this conkywx help wiki (local copy) in your browser

• 3 - FORCE update conkywx data
• Update and override minimum fetch time.
• The list of active conf files will be presented to the user for selection.
• conkywx will restart automatically to present you with updated information.

• 4 - Get detailed DEBUG information for conkywx - Has changes in the new version - also refer to config file section below
• The list of active conf files will be presented to the user for selection.
• This option will dump complete data set in various forms as it is collated in to a compressed log file named "wund_debug.log.bz2" in the conkywx temporary cache in the tmp directory. Complete path will be stated on completion.
• This would be useful to see if the data being computed / collected is correct or perhaps the issue is in the source data at wunderground.

• 5 - Reset Forecast trend information
• Trends that are seen on conky desktop are based on comparison between present values and these stored values.
• The list of trend files will be presented to the user for selection.

• 6 - Reset Graphs trend information
• Graphs data for temperature, pressure and dew point can be reset using this option.

CONFIG FILE ^ 

• Note:
• The program typically takes the config file from the -c option on the command line.
  This is useful when you have multiple conky weather instances for different locations - as each instance would require a separate config file.
• If you specify the full path of the config file with the -c option then the config file can reside anywhere.
• On the other hand you can place the config file in $HOME/.config/conkywx/conkywx.conf.
  This is required if you do not give a -c option on the command line - for both the -t template option and the -d data option.

• There are 2 config files as described below.

system.conf

• system.conf is located at $HOME/.config/conkywx/system.conf

ConkyStartScript

• Path to the conky starting script - Used by debug and force update.
• This script must have a - killall conky - command before any conky process is started. This allows any conky process to be stopped and restarted.

language_for_msgs

• Language to see Messages in
• Comment this option if not required.
• English is default

conkywx.conf or config file used with -c option

• Weather is obtainable from 6 different locations in various combinations see default_wx below.

link_tmp_folder ^ 

Requirement:

• Show 2 or more conky displays for the same location

Solution:

• to show 2 displays we need 2 rc files - we also need to use 2 separate config files
• Note here:
• primary referred to below is the system we want to copy FROM
• secondary referred to below is the system we want to copy TO
• The primary reference will be used for the location information and any other download information - such as images xml info etc - rest information will be taken from the secondary conf.
• The secondary file system will by-pass any download mechanism offered by conkywx.
• A new conkywx config file element: link_tmp_folder is introduced:
• example: link_tmp_folder='/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39'
• This is the path to the primary conkywx temp folder.
• This element will only exist in the secondary config file
• No need to make any other changes to the secondary config file besides this element.
• The primary will function as normal without a care in the world as usual
• The secondary will also function as normal except as below:
• If the primary tmp folder exists - all content will be copied to the secondary folder.
• Other wise all secondary config location info data will be downloaded.

LOCATION ^ 

default_wx ^ 

• usage:
• Note: intellicast weather does not exist any longer.
• use colon : character to separate current condition and forecast

• Website options Matrix

1. ^ Uses your latitude and longitude as defined in your conkywx configuration file.

2. ^ Refer to ICAO Station list with ICAO ID - the stations.txt file - for a METAR reporting airport near your location.
Not all stations report - even though they have qualified to be on the list.

darkSkyLoc ^ 

• To use darksky.net - simply use default_wx=d or as a forecast option like default_wx=1:d - you only need to set Latitude and Longitude settings. See User Position and elevation
• As Dark Sky does not provide a location city name - you can use your position lat long in the dark sky url and see what city name is given on the web page. This name can be used in the variable darkSkyLoc below.
• If this variable is not used then your positional co-ordinates will be shown.
• Forecast is for 7 days.

darkSkyLoc='Your city location name'

icao_id ^ 

• Required for METAR weather - if m option is used
• Use for current conditions only
• METAR ICAO Airport code consists of 4 characters
• Refer to ICAO Station list with ICAO ID - the stations.txt file - for a METAR reporting airport near your location.
  Not all stations report - even though they have qualified to be in the list.
• eg: for Singapore Changi airport

icao_id=WSSS

yahooURL ^ 

• Required for yahoo weather - simple yahoo weather web page url - same as in the example.

yahooURL='https://www.yahoo.com/news/weather/singapore/singapore/singapore-1062617'

xml_ID ^ 

• state the list of pws in an array. The nearest pws to be placed first.

xml_ID=( IWESTERN144 IWESTERN145 IWESTERN154 IWESTERN544 IWESTERN146 )

• One of the many "USP"s of wunderground is that it has access to many thousands of personal weather stations from around the world. These automated devices also have a phenomenal update rate over the internet.
• You can state your preferred xml_ID here OR state your Latitude and Longitude below.
• If this option is not required use xml_ID=nouse

xml_ID=( IWESTERN144 )

POSITION N TIME ^ 

User Position and elevation ^ 

• Your location is used by conkywx for :^[ 1 ]
• astronomy module
• to locate a pws nearest to you.
• for using wunderground weather
• for using weather.com
• for using darksky weather
• for using msn weather
• for using accuweather weather
• for using timeanddate weather
• UV index calculations require Position and elevation. The UV index is collected from the European Space Agency - Copyright © KNMI/ESA; http://www.temis.nl/
• Standard convention: South and West co-ordinates are minus
• Enter Latitude, Longitude in decimal format. ^[ 2 ]

Latitude=23.45      for North location.
Longitude=-123.45   for West location.
elevation=7200      in Feet

1. ^ Visit this site for getting your Latitude, Longitude and elevation. Using zip or pin code will still get you a general location - use the map and click exactly where you are.

2. ^ If Latitude and/or Longitude values are not filled here - they will be picked from the main data downloaded except as mentioned above. This will normally be a general position in 1 decimal place of the weather station.

t_zone_pick ^ 

• Comment this option - conkywx will use your PC time zone information
• Places that have DayLight Saving Time are also handled by the Linux system time. ^[ 1 ]
• OR - To use custom time zone. ^[ 2 ] State the time zone here
• eg: For location East of Greenwich Prime Meridian:

In decimal format   t_zone_pick=10.5
	OR
In hours format	    t_zone_pick=+1030

• eg: For location West of Greenwich Prime Meridian:

In decimal format   t_zone_pick=-6
	OR
In hours format     t_zone_pick=-0600

1. ^ There are places which use Daylight Saving Time.
You can refer to this blog which refers to the topic of updating daylight saving time on linux.
Arch Linux wiki on Time is a good guide
Basically set your hardware clock to UTC.

2. ^ Custom entry will be required if you are tracking weather for other locations not in your time zone.
Other wise you will see the Astronomical data relative to your time for that location.
For instance you have a Sun Rise for a location at 3 pm - that is the sun rise time for that location time zone - which may be 7 am.

use_short_date ^ 

• 0 or Comment to show Friday 09
• 1 show Fri 09
• 2 show Friday 9 - without the leading zero for the date
• 3 show Fri 9 - without the leading zero for the date
• eg: for displaying Fri 9

use_short_date=3

Time_format ^ 

• Use upper or lower case AM PM or am pm for 12 hour time format OR use 24 hour time format
• 1 ALL UPPERCASE
• 2 all lowercase [Default]
• 3 Hide am pm
• 4 all lowercase with no padding/spacing
• 5 Use 24 hour time format [Default]
• OR - To Use custom time format. State the format here.
• Refer to man strftime or build your own strftime string here.
• example

Time_format='%_I:%M %p'

moon_time ^ 

• Show time with month and day for Moon Phases
• 1 Show month day time The time will follow the Time_format settings above.
• 2 Show only month n day [Default]
• Refer to man strftime for more date formats or build your own strftime string here.

today_date_format ^ 

• Refer to man strftime or build your own strftime string here.

minimum_fetch_time ^ 

• Default set to 1800 seconds which is 30 min.
• Please be kind - do not reduce this time or else the websites may make amends to disable our access.
• If you are using multiple instances of the program to get weather - space them out time wise.
• You could distribute between sites. Refer to LOCATION - we have many options.

SURFACE IMAGES ^ 

cimss_surface_image ^ 

• Get surface analysis image from CIMSS - Tropical Cyclone Research Team ^{[ 1 ] [ 2 ]}
• Default is upper level winds 1:u - using indian area as example.
• For lower level winds use 1:l
• If you live closer to the coast then lower level may be better
• You can get a "storm zoom" ^[ 3 ] image 1:uz or 1:lz
• storm zoom is not available for areas 6 and 9

1. ^ There is no conkywx element for this image. It is stored directly in the conkywx temp folder with the name gsi_image.gif.
Use normal conky image placement eg: ${image ${template3} -p 0, 0 -s 800x600}.
Refer to conkywx-surface-image.sh in examples folder.

2. ^ To understand wind barbs see the image on the right.

3. ^ Storm Zoom - if there is a storm in any of the listed areas - the image focus zooms over the storm in that area.
This magic is automatic from CIMSS - provided you use the zoom option.

cimss_watervapour ^ 

water vapour image from CIMSS

• 1 indian
• 2 east pacific
• 3 west pacific
• 4 south east pacific
• 5 north atlantic
• 6 east atlantic
• 7 east australia
• 8 west australia

options:

• :1 colour background
• :2 visible
• :3 infrared colour background
• :4 infrared
• :5 infrared NHC Enhancement
• :6 infrared BD Enhancement

• There is no conkywx element for this image. It is stored directly in the conkywx temp folder with the name wv_image.gif.
  Use normal conky image placement eg: ${image ${template3} -p 0, 0 -s 800x600}.
  Refer to conkywx-surface-imagerc in examples folder.

wund_surface_image ^ 

• Get surface analysis image ^[ 1 ] from wunderground
• You have a list of locations and types of images
• Choose the location:type of image - with : as separator

1. ^ There is no conkywx element for this image. It is stored directly in the conkywx temp folder with the name gwsi_image.gif.
Use normal conky image placement eg: ${image ${template3} -p 0, 0 -s 800x600}.
Refer to conkywx-surface-imagerc in examples folder.

noaa_cyclone_image ^ 

• noaa world cyclone / hurricane image

intel_surface_image ^ 

• This will go out of service in due course as intellicast.com has been merged with wunderground.
• Get surface analysis image ^[ 1 ] from intellicast
• 1 Africa
• 2 Africa North Western
• 3 Africa Eastern
• 4 Africa Western
• 5 Africa South
• 6 Asia
• 7 Asia Russia
• 8 Asia India
• 9 Asia Indonesia
• 10 Asia Japan
• 11 Asia Middle East
• 12 Asia South Eastern
• 13 Australia
• 14 Australia North Eastern
• 15 Australia South Eastern
• 16 Australia Western
• 17 New Zealand
• 18 America North
• 19 America Central
• 20 America South
• 21 America South Northern
• 22 America South Southern
• 23 America Carribean
• 24 America Brazil
• 25 America Mexico
• 26 Canada Central
• 27 Canada Eastern
• 28 Canada Western
• 29 Europe
• 30 Europe North Eastern
• 31 Europe North Western
• 32 Europe Scandinavia
• 33 Europe South Eastern
• 34 Europe South Western
• 35 Europe United Kingdom
• 36 US Continental
• 37 US North East
• 38 US North West
• 39 US Great Plains
• 40 US Mid Atlantic
• 41 US Mid West
• 42 US Pacific
• 43 US South Central
• 44 US South East
• 45 US South West

1. ^ There is no conkywx element for this image. It is stored directly in the conkywx temp folder with the name gisi_image.jpg.
Use normal conky image placement eg: ${image ${template3} -p 0, 0 -s 800x600}.
Refer to conkywx-surface-image.sh in examples folder.

world_wx_image ^ 

• Get short weather info for some cities around the planet from eldoradocountyweather.com.
• 1 Fahrenheit / Imperial
• 2 Celsius / Metric

OUTPUT FORMAT ^ 

language_to_use ^ 

• This allows you to see the output data and conkywx messages in any supported ^[ 1 ] language.
• There are 2 files that require translation. One for desktop display and the other for messages. ex: en.lang and en.msgs for English - which is Default.
• Display language file settings reside in each of your conkywx config files and you can choose if you speak multiple languages and if we have those supported - see each conkywx Desktop display in that language. This language file has translations of weather conditions etc.
• Please refer to the config files for the languages that are supported.

1. ^ English and deutsch languages are actively supported for the time being. Kindly volunteer if you would like this program in your language

Units_to_Use ^ 

• SI for Metric
• IM for Imperial
• You need to use one of the two or you will get a stop error.
• eg: for using Metric units

Units_to_Use=SI

Units_show ^ 

• 1 see units like km/h etc
• 0 or Comment to switch off all units.
• You can show your own units in conkyrc or the template file.
• eg: for displaying units

Units_show=1

show_degsym_fc_temp ^ 

• Show degree symbol in forecast temps,
• 1 Hide all deg symbols
• 2 Show all deg symbols
• 3 Show all deg symbols, depending on Unit_to_Use
• 4 Show deg symbol ONLY, after forecast pair
• 5 Show deg symbol AND unit, after forecast pair [Default]

Arrows to show forecast trends ^ 

• See the WEATHER DATA ELEMENTS To show this in your template.
• example Arrows font code

risingtrend='c'
fallingtrend='d'
steadytrend='RQ'

pc_what_case ^ 

How do you want to capitalize the present conditon

• 1 first char each word uppercase Default
• 2 all upper case
• 3 all lower case or
• 4 sentence case - only first character of the full present condition

NOTIFICATIONS N ALERTS ^ 

Real-time Air Quality ^ 

• World Air Quality Index project.
• This should work for most cases - in the event you see an error in the terminal of conky output - get your own token from http://aqicn.org/data-platform/token/
• Your position lat and long will be used to get the nearest station
• To disable - comment waqiToken variable

RSS reader ^ 

• GDACS or News reader
• Global Disaster Alert and Coordination System
• Near real-time alerts about natural disaster with a potential humanitarian impact
• URL for GDACS rss feed http://www.gdacs.org/xml/rss.xml
• GDACS Alert types:: tropical cyclone, earthquake, tsunami, flood, volcano
• GDACS Alert level:: Red, Orange, Green and White
• By default all alert types and levels are shown up to past 10 days.
• Information is presented in the sequence it is published. If a published item is new but presented later in the rss data - it will show up at that sequence. The published date is displayed just above the article title. This date can be user formated - see below for options gPublishDateFormat for GDACS or nPublishDateFormat for News.
• For GDACS use vertical-scroller-gdacs-conkyrc file in examples folder
• For News use vertical-scroller-news-conkyrc file in examples folder
• Following options are to be declared in your main conkywx config file and the template0 should have the path to the gdacs or news files.
  example template0 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gdacs',
• GDACS options
• gdacsUrl Set the url in quotes to enable this widget
• gtextWrapColumn 45 The column you want to wrap text to fit scroll width [Default 45]
• gshowImperial 1 If you need to see data in Imperial format
• gpastEventDays 3 Number of days you want to see information for. [Default 10 days] - if there is information going back that many days.
• gnotReqType 'earthquake' To disable any 1 alert type
• gnotReqLevel 'green' To disable any 1 alert level
• greqTitleOrDesc set to 1 to see titles or 2 to see description OR comment reqTitleOrDesc to see both
• gPublishDateFormat Define you own format for the publish date of the article
• News options
• newsUrl Set the url in quotes to enable this widget
• ntextWrapColumn 45 The column you want to wrap text to fit scroll width [Default 45]
• nshowImperial 1 If you need to see data in Imperial format
• nreqTitleOrDesc set to 1 to see titles or 2 to see description OR comment reqTitleOrDesc to see both
• npastEventDays 3 Number of days you want to see information for. [Default 10 days] - if there is information going back that many days.
• nNumberOfItemsToView number - There are feeds which do not have the publication time for each title - in which case you can control the number of items by using this variable.
  Note: npastEventDays will take precedence if used with this option and if published time is available.
• nPublishDateFormat Define you own format for the publish date of the article

Height of Tide ^ 

• source from Height of Tide ^[ 1 ]
• We get 1 full month of tidal data - the data gets updated once in 20 days.
• tides_url is the main variable and the other 2 listed below should be commented and you will see present day Tidal Information.
• tide_days_opt options:
• 1 current day default
• 2 previous days
• 3 following days
• 4 all days
• 5 search by date ^[ 2 ]
• tide_days_num total number of days you want to list [default 7 ] - only works if tide_days_opt is 2 or 3
• Example tides_url='http://www.tide-forecast.com/locations/Patrick-Air-Force-Base-Florida/tides/latest'

1. ^ How to get the url
On the home page of this site you have 2 drop down lists country and port.
If you do not find your port click on "Tides by country" link and then drill down to your port - your port may not be listed so look for the one nearest to your port or see if it is there with another name.
Case in example Florida - does not work for me - so I clicked on "Tides by country"
I was looking for Indian Harbour Beach, FL - no way - aha but found Patrick Air Force Base - same location.
We use similar approach as wxalert - we write a file tides in conkywx temp folder and use that - so place a template7 or something with full path to file named tides.
conkywx lua SCROLLER has been updated to handle such tabular data.

2. ^ conkywx does word matching for the start Not the end.
so if you put date as '5 june' you get 5 june data as it exists
but if you put '2 june' - you get no data - if it does not exist.
single '2' will get all dates starting with 2.
The month is not case sensitive.

Earth Quakes / Seismic Activity ^ 

• data feed taken from www.emsc-csem.org and usgs portals.
• all data collected is for minimum 2.5 magnitude and 60 events each feed.
• get_seismic 1 to enable or Comment this or set to 0 to disable
• num_of_events - number of you want to see [Default 30 ]
• minimum_magnitude - of the seismic activity [Default 4.5 ]
  will show an indicator marker > in the time column and the colour is yellow.
• seismic_time_format - standard date time formate
• alarm_magnitude - set the alarm at a magnitude [Default 5 ]
• loc_width - number of characters for Location field [Default 45 ] minimum is 24
• loc_watch - locations you want to keep an eye on - will show * character as indicator marker before the location.
  This line will have magenta colour.
  Separate words with a : character if more than one.
• alarm_flash - At this value the line will start to flash - raise and lower the intensity.
  The indicator marker will become >> in the time column.
  Useful for magnitudes where things start to fall apart - say 7 - all values above and including this magnitude will get flashed.
• box_char - allows you to change the box in which the data is shown
• 3 types of character sets are used - horizontal, column and joiners
• Default box_char example set ┄:|:╬:╩:╦:╠:╣:╔:╗:╚:╝ Note that : is a separator
• example set ┄ = horizontal, | = column and rest are joiners
• the sequence of these characters is important
• 5 styles for horizontal/columns and 2 sets for joiners
• horizontal/columns styles 1=┄ |, 2=╴ ╷, 3=- |, 4=~ ║, 5=═ ║
• joiner styles 1=╬ ╩ ╦ ╠ ╣ ╔ ╗ ╚ ╝, 2=┼ ┴ ┬ ├ ┤ ╭ ╮ ╰ ╯
• define style horizontal/columns:joiner = 1:1 [Default]
• for vertical scrolling use a single character in quotes example .
• Character NOT TO BE USED as box characters @ * >

• Seismic example in config file:

get_seismic=1
seismic_time_format='%d-%H:%M'
# seismic_time_format='%d-%I:%M %p'
# seismic_time_format='%d-%I:%M %P'
num_of_events=70
minimum_magnitude=5
alarm_magnitude=5.5
alarm_flash=6
loc_width=36
loc_watch='thai:malay:indo:paki:afgh:japan:nepal:india:saudi'
# box_char="╴"
box_char='.'
# box_char='1:1'
# box_char='┄:|:╬:╩:╦:╠:╣:╔:╗:╚:╝'

show_notification ^ 

• Everytime the data is updated - you get a popup notification
• 1 show popup notification
• 0 or Comment to disable
• eg: for displaying Sun 27

show_notification=1

show_wx_alerts ^ 

• 1 show Weather alerts
• 0 or Comment to disable
• Alerts - depending what action is happening at your location

show_wx_Tropical_alerts

• not used anymore

enable_new_version_check ^ 

• 1 Check for new version of conkywx every 24 hours
• 0 or Comment to disable

ICON SETS N FONTS ^ 

moon_outline ^ 

• 1 for moon outline fonts
• 0 or Comment for simple fonts
• only used in font templates

Dynamic_Moon ^ 

• Comment this option for static Moon images to be displayed.
• refer to the Moon - example in conkywx-lua documentation SHOWCOND
• View Moon image as it appears outside
• Only works for Image Templates
• Needs conky with Lua support - Imagemagick is NOT used
• 1 use your local time,
• 2 use station local time for calculation

wx_iconset ^ 

• Choose weather icon / image set ^[ 1 ]
• 1 to 5 Enable icon set
• OR - To define custom icons - state full path here.

1. ^ You can also use conkywx-lua to show the same image - refer to the Condition - example in conkywx-lua documentation SHOWCOND

wx_fcast_iconset ^ 

• Choose weather icon / image set ^[ 1 ]
• 1 to 5 Enable icon set
• OR - To define custom icons - state full path here. ^[ 2 ]

1. ^ Same options as wx_iconset - but I found that using set 5 for Present weather condition is great but for forecast weather - it looks better when other sets are used.

2. ^ You can also use conkywx-lua to show the same image - refer to SHOWCOND conditon example.

wx_wind_iconset ^ 

• Choose wind rose icon set
• 1 to 3 All icons made by Paramvir
• Note: to view these icon sets - you need to use conkywx element [BI] with conky image element.
• OR - To Use custom icon set. State full path here in single quotes.

wx_wind_iconset='/home/username/path to icons set folder name'

wx_wind_fontset ^ 

• Show wind direction using ConkyWindNESW font set
• 1 to 4 All fonts are from the font ConkyWindNESW
• OR - To Use custom font set. Refer to EXAMPLES on how to use.

Trend Graphs

• refer to the wxgraph in conkywx-lua documentation WXGRAPH
• We have the ability to generate graphs for temperature, pressure, dewpoint, wind speed, wind gust speed and humidity.
• To see graphs you need conky with Lua support - gnuplot NOT required.
• This option No Longer exists in the config file

TEMPLATE FIX ^ 

pcondition_blacklist ^ 

• Add words in this list that you want to remove from Present Condition text.
• Comment this variable if not required.
• Separate words with space or new line.
• If you have two words together - then quote the words eg: "Low Drifting"
• To replace words use format 'orginal text:new text' - remember the quotes.
• To replace everything use format ".*orginaltext.*:newtext"
• The list is not case sensitive.
• Output will be based on pc_what_case above.
• Single line list is also supported - just remember to quote word groups that contain spaces.
• Caveat:: In the single line version you cannot comment an individual item :)
• example 1: Multi-line:

pcondition_blacklist=(
	"light:lt"
	"heavy:hvy"
	"Severe:svr"
	"Widespread:ws"
	pellets
	# pellet			items commented out
	Freezing
	# "with:+"			items commented out
	"and:+"
	'Thunder.*m:t-storm'
	"Patches of"
	"Low Drifting"
	Small
	Precipitation
	)

• example 2: Single line

pcondition_blacklist=( "light:lt" "heavy:hvy" "Severe:svr" "Widespread:ws" pellets pellet Freezing "with:+" "and:+" 'Thunder.*m:t-storm' "Patches of" "Low Drifting" Small Precipitation )

template_cleanup ^ 

• Process the final template before showtime add, remove or change any information on the template at run time - original template information is not modified.
• Comment this variable if not required.
• Separate words with space or new line.
• If you have two words together - then quote the words eg: "Low Drifting"
• To replace words use format 'orginal text:new text' - remember the quotes.
• To replace everything use format ".*orginaltext.*:newtext"
• The list is case sensitive. You have to match the case of the text you want to replace.
• Single line list is also supported - just remember to quote word groups that contain spaces.
• Caveat:: In the single line version you cannot comment an individual item :)
• example:

template_cleanup=(
		'Regen:Schüttung'
		'teilweise bewölkt:teilweise wolkig'
		)

SCROLLER TEMPLATE ONLY ^ 

do_not_output_to_conky ^ 

• Only available in scroller template config file. The data is not output to screen but wxconkywx_scroller file in the conkywx tmp directory. This file data is displayed in the conkywx scroller.
• This is required for smooth scroller as well.
• [1] Enable this option
• [0] or Comment to disable

DATA ELEMENTS ^ 

WORLD AIR QUALITY INDEX ELEMENTS ^ 

WEATHER DATA ELEMENTS ^ 

1. ^ METAR information can be shown and word folded in conkywx or your templates.
Both work equally well and both are part of GNU coreutils.
Refer to the EXAMPLES below for possible METAR data formatting in conky.

2. ^ This is one particular situation in the moon phases that moon never actually reaches a 100% mathematically - since the calculation are in decimals. To get this information we round the 99.5 . Actual Full Moon phase time is the tipping point from waxing to waning of the moon - therefore the shown illumination of 100% is about 18 hours of this Full Moon time.

3. ^ Interesting element - takes the illumination for today and the next day and the difference is your change per day. This will vary sometimes like any real time element. Percent illumination for change may have taken place for today but not yet for next day same time - so you will see a drop in change but overall it gives you an interesting check at the speed at which our Moon moves.

4. ^ For these transit elements you may see N.M.T. - which means No Meridian Transit.
The body will not pass overhead on your Longitude during the present 24 hour period.

5. ^ We refer to the Sun and the Moon here. At times you will see A.A.H. or A.B.H..
A.A.H. - means the relevant Body is Always Above Horizon - the Body will not set within the present day 24 hour period, or for a duration if you are in the Polar regions.
A.B.H. - means the relevant Body is Always Below Horizon - the Body will not rise within the present day 24 hour period, or for a duration if you are in the Polar regions.

6. ^ These events normally occur above the polar circles affecting the twilight times.
No Sun Rise = The day light is never Bright enough for this twilight to occur.
No Sun Set = The day light is never Dark enough for this twilight to occur.

7. ^ If there is an Alert generated by wunderground - the Present Condition text will get ! character before the text. For example ! Clear.
If there are more than one alerts then a number after ! will indicate the number of alerts at wunderground. For example !2 Overcast.
Refer to EXAMPLES and conkywx lua widget SCROLLER for conkywx weather alerts / warnings examples.

8. ^ Station Name can be different with different sites.
- pws station name [pws used by wunderground main or pws xml user specified],
- ICAO Station name ,
- city name minus country .

9. ^ Station ID can be different with different sites.
- pws station ID [pws used by wunderground main or pws xml user specified],
- ICAO code ,
- weatherdotcom_ID ,
- "MSNWX" .

FORECAST TREND GRAPH ELEMENTS ^ 

1. ^ Refer to WXGRAPH in conkywx lua help file for usage.

FORECAST ELEMENTS ^ 

FORECAST TREND ELEMENTS ^ 

Notes:

• There are 2 types of trends
• Type 1 that are updated hourly - pressure, presenttemp, windspeed, humidity, UV, dewpoint, visibility.
• Type 2 that are updated every 24 hours - Sunrise, Sunset, Moonrise, Moonset, length of Vis light, length of day, Moon Illumination, Maximum forecast temperature.
• You will not see trends for an element under certain conditions.
• If the value of the current data or the value of the stored data is N/A. This is because there is no way to get a comparison when one of the data is Not Available.
• When you first start using these trend elements - you will start getting trends for these elements depending on when you started conkywx first time with these elements [ get reference data ] and the next update from wunderground for these elements.
• Other trend elements update normally with each weather update.
• If you are using Location - unless it is Rapid Fire type - the trends displayed for Type 1 trends will be Steady a lot of the time. This is because of the slow rate of updates that are received. If you see steady arrow <> for most of the type 1 trends - check the Last Update time - which will give you the reason. For example the last update I got was 8:30 pm and it is 10 pm now and all the type 1 trends are steady.

TROUBLESHOOTING ^ 

FILES ^ 

Set of conky config and templates files in the *examples* directory

Notes:

• Each conkyrc file (conky resource file) has Font or Image template information.
• Just comment the Fonts section to get the Fonts template to work and same is the case with Image template.
• The conkyrc file also has references to the required conkywx config file for you to edit.
• Understanding the file path that the user needs to change in conky resource files.
• Here is an example of a data file for use in conkywx - this has a reference in the conkyrc file config section: template5 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• /tmp is the temporary Linux folder,
• wx-param-conkywx-02.conf-pChA_r_27u0-m39 is the conkywx sub-folder,
  param is the USERNAME - replace this with your system user name,
  conkywx-02.conf is the conkywx config file name in use.
• wxalert is the Alerts data file.
• Three files work together - config file, conky rc file and template file.
• Each of these files are well documentated - in any case - that is the idea ;-). This saves the task of documenting each template.
• To fit a template to your desktop - have a look at the rc file and change the xftfont or font size in the rc config section.
• Line endings in conkyrc config section:
• wxalert: This is the container file for any alert messages form conkywx.
• tides: This is the container file for tidal information.
• vumeterdata.lua: Tabular data file for the vumeter lua widget.
• wxringdata.lua: Tabular data file for the wxring lua widget.
• seismic: Tabular data file for the seismic data.
• wxconkywx_scroller: This is the container file for the smooth scroll engine to display and scroll.
• /tmp/trackPlaying containes the music track information for the smooth scroll engine to display during media playback by wx media player - our own home grown mplayer front end - refer to wx media player options in music_sort.
• You will be surprised how little you have to change for things to work.
• There are many ways to quote in the config section - you will see text in single quotes or in double square brackets - both do the same thing.

Files and their associated templateN assignments

For conky versions 1.10.x

• alert-smscrollrc
• template1 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• big-luamix-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/big-luamix-template',
• template3 = [[ -j 0 ]],
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template5 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides',
• template6 = [[./examples/vumeterdata.lua]],
• template7 = '/tmp/biglua',
• big-luamix-gauge-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/big-luamix-gauge-template',
• template3 = [[ -j 0 ]],
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template5 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides',
• template7 = '/tmp/biglua',
• conky-musicrc
• template0 = [[conky -c ./examples/music-smscrollrc]],
• template1 = '/tmp/trackPlaying',
• conky-systemrc
• template9 = 'w83627ehf.656',
• template0 = '${voffset 1}',
• template1 = './examples/wxringdata.lua',
• conkywx-surface-imagerc
• template1 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gsi_image.gif',
• template2 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gwsi_image.gif',
• template3 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gisi_image_sat.jpg',
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gl_sst_mm.gif',
• template8 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gisi_image_sur.jpg',
• template6 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wv_image.gif',
• template5 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• conkywx-weather-rings-systemrc
• template0 = '$WX_DIR/conkywx.sh',
• template1 = '$WX_DIR/examples/conkywx-02.conf',
• template2 = '$WX_DIR/examples/conkywx-weather-systemrc-template',
• template3 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template5 = './examples/conkywx-systemrc-wxringdata.lua',
• template6 = [[1]], -- template6 used for triggering events
• template7 = [[ -w ci ]], -- for current condition
• template8 = [[ -w Wi ]], -- for wind compass
• template9 = [[ -w mi ]], -- for moon
• template6 = [[3]],
• expanded-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/expanded-template',
• template3 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides',
• template6 = [[1]],
• template5 = [[ -w ci ]],
• template7 = [[
  -w ci ]],
• template8 = [[
  -w Wi ]],
• template9 = [[
  -w mi ]],
• flip-big-luamix-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/flip-big-luamix-template',
• template3 = '-j 0 ',
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template5 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides',
• template6 = './examples/vumeterdata.lua',
• template7 = '/tmp/biglua',
• flip-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/flip-template',
• template3 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides',
• template5 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gisi_image_sur.jpg',
• hartley-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/hartley-template',
• template3 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides',
• template6 = [[1]],
• template7 = [[
  -w ci ]],
• template8 = [[
  -w Wi ]],
• template9 = [[
  -w mi ]],
• hartley-gauge-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/hartley-gauge-template',
• template3 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides',
• template6 = [[1]],
• template7 = [[
  -w ci ]],
• template8 = [[
  -w Wi ]],
• template9 = [[
  -w mi ]],
• horizontal-scroller-weather-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/horizontal-scroller-weather-conkywx.conf',
• template2 = './examples/horizontal-scroller-weather-template',
• template3 = '/tmp/wx-param-horizontal-scroller-weather-conkywx.conf-pChA_r_27u0-m39/wxalert',
• template4 = '/tmp/wx-param-horizontal-scroller-weather-conkywx.conf-pChA_r_27u0-m39/wxconkywx_scroller',
• music-smscrollrc
• template1 = '/tmp/trackPlaying',
• template2 = [[${lua main -n smscroller -f 11 -e 20 -p 10,42 -w 310 -i ${template1} }]],
• now-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/now-template',
• template3 = '/tmp/wx-param-conkywx.conf-pChA_r_27u0-m39/wxalert',
• template6 = [[1]],
• scroller-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/scroller-conkywx.conf',
• template2 = './examples/horizontal-scroller-weather-template',
• template3 = '/tmp/wx-param-scroller-conkywx.conf-pChA_r_27u0-m39/wxalertA',
• template4 = '/tmp/wx-param-scroller-conkywx.conf-pChA_r_27u0-m39/wxconkywx_scroller',
• seismicrc
• template0 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/seismic',
• short-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/short-template',
• template3 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert',
• template4 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides',
• template6 = [[1]],
• template7 = [[
  -w ci ]],
• template8 = [[
  -w Wi ]],
• template9 = [[
  -w mi ]],
• slim-conky.rc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/slim-image-template',
• template3 = '/tmp/wx-param-conkywx.conf-pChA_r_27u0-m39/wxalert',
• slim-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/conkywx-02.conf',
• template2 = './examples/slim-template',
• template3 = '/tmp/wx-param-conkywx.conf-pChA_r_27u0-m39/wxalert',
• template6 = [[1]],
• template7 = [[
  -w ci ]],
• template8 = [[
  -w Wi ]],
• template9 = [[
  -w mi ]],
• smooth-scrollrc
• template0 = 'This is a long test to scroll so that I can show a smooth scrolling text. ',
• template1 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalertA',
• template2 = '/tmp/luascroller',
• vertical-scroller-gdacs-conkyrc
• template0 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gdacs',
• vertical-scroller-news-conkyrc
• template0 = [[/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/news]],
• template1 = [[/tmp/conkywx_param/sleepnews]],
• vertical-scroller-seismic-conkyrc
• template0 = '/tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/seismic',
• vertical-scroller-vindsl-weather-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/vertical-scroller-vindsl-weather-conkywx.conf',
• template2 = './examples/vertical-scroller-vindsl-weather-template',
• template3 = '/tmp/wx-param-vertical-scroller-vindsl-weather-conkywx.conf-pChA_r_27u0-m39/wxalert',
• template4 = '/tmp/wx-param-vertical-scroller-vindsl-weather-conkywx.conf-pChA_r_27u0-m39/wxconkywx_scroller',
• vertical-scroller-weather-conkyrc
• template0 = '$WX_DIR/conkywx.sh',
• template1 = '$WX_DIR/examples/vertical-scroller-weather-conkywx.conf',
• template2 = '$WX_DIR/examples/vertical-scroller-weather-template',
• template3 = [[/tmp/wx-param-vertical-scroller-weather-conkywx.conf-pChA_r_27u0-m39/wxalert]],
• template4 = [[/tmp/wx-param-vertical-scroller-weather-conkywx.conf-pChA_r_27u0-m39/wxconkywx_scroller]],
• vindsl-org-conkyrc
• template0 = './conkywx.sh',
• template1 = './examples/vindsl-org-conkywx.conf',
• template4 = './examples/vindsl-weather-dingbat-template',
• template7 = '/tmp/wx-param-vindsl-org-conkywx.conf-pChA_r_27u0-m39/wxalert',
• template9 = 'C',

For conky versions 1.9.x

• big-luamix-conkyrc.sh
• template0 /usr/share/conkywx/conkywx.sh
• template1 ./examples/conkywx-02.conf
• template2 ./examples/big-luamix-template.sh
• template9 /tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert
• template7 /tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/tides
• conky-systemrc.sh
• template0 /usr/share/conkywx/conkywx.sh
• template9 /sys/class/hwmon/hwmon0/
• template8 /sys/devices/platform/w83627ehf.656/temp4_input
• template7 /sys/devices/platform/w83627ehf.656/fan2_input
• conkywx-surface-imagerc.sh
• template1 ./examples/conkywx-02.conf
• template2 /tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gwsi_image.gif
• template3 /tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/gisi_image.jpg
• template7 /tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/seismic
• expanded-conkyrc.sh
• template0 /usr/share/conkywx/conkywx.sh
• template1 ./examples/conkywx-02.conf
• template2 ./examples/expanded-image-template.sh
• template3 /tmp/wx-param-conkywx-02.conf-pChA_r_27u0-m39/wxalert
• now-conkyrc.sh
• template0 /usr/share/conkywx/conkywx.sh
• template1 ./examples/conkywx-02.conf
• template2 ./examples/now-font-template.sh
• template3 /tmp/wx-param-conkywx-now.conf-pChA_r_27u0-m39/wxalert
• scroller-conkyrc.sh
• template0 /usr/share/conkywx/conkywx.sh
• template1 ./examples/conkywx-02.conf
• template2 ./examples/scroller-template.sh
• template3 /tmp/wx-param-scroller-conkywx.conf-pChA_r_27u0-m39/wxalert
• template4 /tmp/wx-param-scroller-conkywx.conf-pChA_r_27u0-m39/wxconkywx_scroller
• slim-conkyrc.sh
• template0 /usr/share/conkywx/conkywx.sh
• template1 ./examples/conkywx-02.conf
• template2 ./examples/slim-font-template.sh
• template3 /tmp/wx-param-conkywx.conf-pChA_r_27u0-m39/wxalert
• vindsl-conkyrc.sh
• template0 /usr/share/conkywx/conkywx.sh
• template1 ./examples/conkywx-02.conf
• template4 ./examples/vindsl-weather-graphic-template.sh
• template7 /tmp/wx-param-vindsl-conkywx.conf-pChA_r_27u0-m39/wxalert
• template9 C

Weather Condition icon sets

Fonts installed in the system fonts directory

The program location The program location is /usr/share/conkywx directory. There are two directories below this - examples, images. The images directory has bgrounds, wxicons and moonicons directories. See details below.

conky-restart.sh This file is in the program directory and is usable as is and will show system details on the right of the screen and on the left default location weather. By default the system conkyrc is commented out - to use uncomment the line.

Set of Background png images in the *images/bgrounds* directory The name of the image gives you the hint with which template it is associated.

EXAMPLES ^ 

• These example statements come below the TEXT statement in conkyrc file.

-d --data option examples

• path is the location of the file

Delhi: ${execpi conkywx -d CT -c path/delhi.conf}
Cape Town: ${execpi conkywx -d CT -c path/capetown.conf}
Svalbard: ${execpi conkywx -d CT -c path/svalbard.conf}

• As you will notice that for each -d data element you will need to state an execpi call - in other words for 20 data elements execpi will be executed 20 times - which will be slower in relative terms to a single call of execpi in -t template format. That is why templates are so much faster.

-t --template option examples

• template statement is the last statement below the TEXT statement in conkyrc file.

${execpi 900 conkywx -c "path/conkywx.conf" -t "path/wx-wu-font-template"}

• For more see the conkyrc and template files in /usr/share/conkywx/examples directory.

METAR examples

${exec echo "[METAR]" | exec fmt -u -w 55}
 OR
${exec echo "[METAR]" | exec fold -s -w 55}

Weather Alerts examples

• By default Present Condition information automatically gives the user Alert Indication by placing an exclamation before the present condition like ! Clear. There is no user input required.
• If there are more than one alerts - the exclamation is followed by the number of alerts.
• To use the alerts - add the following code in the template where ever you want to see the alerts.
• The lua scroller option -p is for adjusting the position of the alerts.
• You can use any free template number from template0 to template9

template9 /tmp/conckywx tmp folder name/wxalert

${if_existing ${template9}}#
${color8}Alert:${lua main -n scroller -f 14 -l 70 -s 15 -p 60,966 -o ${template9}}#
${else}${color4}${hr}${color8}${endif}

• For more information on lua implementation in conkywx - refer to SCROLLER

How to use custom fonts for showing wind direction

• State characters in single quotes
• Characters that need to be escaped with \ character

'\[', '\\', '\]', '\#', '\(', '\)'

• Characters that cannot be used are $ and '
• "N to NNW", unknown, variable and N/A characters = 19 characters
• Total numbers of characters MUST be 19 including spaces excluding single quotes
• "N to NNW" = 16 characters
• unknown, variable and N/A = 3 characters
• If you are using escaped characters like '\[' - consider it as single character for counting
• Remember wind is always stated from the direction it is blowing !
• For North wind use the South pointing arrow
• i.e. use opposite direction arrows from the wind direction.
• sequence is "N to NNW", unknown, variable and N/A characters
• Example set - this is for ConkyWindNESW font option 3.

wx_wind_font_set='Y,Z,'\[','\\','\]',^,_,`,Q,R,S,T,U,V,W,X,'%','\#','-''

TROUBLESHOOTING ^ 

• If you have space in your path - directory or file name - you need to quote the string passed to conky and conkywx.
• example:
• conky -c "$WX_DIR/examples/short-conkyrc.sh" -d
• template2 "\"$WX_DIR/examples/short font template\"" If you notice here the inner quotes are escaped using \ character as we want to pass the inner quotes with the file name to conkywx.
• ${execpi 900 ${template0} -c ${template1} -t ${template2}
• If you are not getting display - run the file /usr/share/conkywx/conky-restart.sh in a terminal as a normal user and see the error messages. Chances are you will sort the issues in no time
• If you are using gnome3 or Mint you may need to change the own_window_type in conkyrc file to normal or dock and then see if display comes up.
• Sometimes we are faced with issues such as wrong data displayed - most is now being handled by the program. You have to check the website to confirm is data is same or not.
• But human error is always a possibility - particularly in the configuration file. Care must be taken in the URL or ID numbers entered.
• Errors in the terminal window can be many.
• In a terminal window type conkywx. This will start conkywx assistant. Select the Debug option.
• This will generate a wund-debug.log file in the wx-username-conkywx.conf-pChA_r_27u0-m39. The conkywx.conf will change based on the configuration file used.
• This file has all the data information that is used by the program. It is divided in sections and each section has source information. This source has Location data or xml data.
• Sometimes it is difficult to replicate an error - such as during start of system - if no display - use conkywx assistant and force update using option 3 to get website data updated.
• The best way is to check the actual website if that has information.
• Refer to CONFIG FILE OPTIONS very carefully - actuall magic starts here. A small error such as a missing closing quote etc…
• Sometimes other problems may occur which we have no knowledge of yet
• this file will pinpout where the data is not coming out correct
• could also be that the element used in the *conkyrc.sh file by the user may be in error.

ABOUT ^ 

EXTERNAL LINKS ^ 

• For latest conkywx updates visit this Blog
• Global Disaster Alert and Coordination System
• UV data from Copyright © KNMI/ESA
• USGS
• EMSC
• Learn how to install Perl modules at CPAN
• Fonts required for VinDSL conky template
• Arch Linux
• Conky_cairo
• Conky Documentation
• ICAO Station list with ICAO ID - the stations.txt file
• http://www.temis.nl
• Visit this site for getting your Latitude, Longitude and elevation
• Greenwich Prime Meridian:
• Updating daylight saving time on linux
• Arch Linux wiki on Time is a good guide
• Build your own strftime string here.
• CIMSS - Tropical Cyclone Research Team
• http://aqicn.org/data-platform/token
• Height of Tide

BUGS ^ 

They get ironed out as and if they popup - feedback is required.

AUTHOR ^ 

Paramvir Likhari email :: plikhari -> g mail

updated: 2020-Feb-27 10:13, conkywx 200227 help files © 2020 Paramvir Likhari