README.md

conky-FoldingAtHome-status

Lua script for displaying Folding@Home status information in Conky

Retreives and formats status information from a running Folding@Home client and makes that information available for display in Conky.

Example

Status information shown in FAHControl...

...can be displayed in Conky as

Usage

Make the following changes to your .conkyrc file:

1. Add fahqi.lua to a lua_load line in conky.config (e.g. lua_load = 'fahqi.lua')

   • Include the full path to the file if necessary (e.g. lua_load = '~/conky_scripts/fahqi.lua')

   • To use with another Lua script simultaneously, provide a space-separated list on the lua_load line (e.g. lua_load = '~/conky_scripts/other.lua ~/conky_scripts/fahqi.lua')

2. Add the line ${lua load_fah_queue_info} in conky.text.

3. Following that line, add a number of lines equal to the number of running slots to display the loaded data

   • For example:

     F@H Proj ${lua fah_project 0} ${lua fah_status 0}
     F@H Proj ${lua fah_project 1} ${lua fah_status 1}
       ...
     F@H Proj ${lua fah_project n} ${lua fah_status n}
     

Notes

• To stop conky from inserting a blank line above the first line in Usage step 3, you can add ${lua load_fah_queue_info} in step 2 on the first line in step 3 before any script function calls instead of adding it on its own line.
• To set the frequency of updating the Folding@Home information, you can change the throttle value on line 68 of the script in file fahqi.lua. The default value is set to 5 so that the Folding@Home information will be updated once for every five conky updates, i.e. every 5th conky update.

Functions available for use in Conky

(where index is a number from 0 thru n referring to a running slot)

Function	Returns
fah_eta (index)	Eta to completion as a floating-point fraction of days or hours
fah_id (index)	Work Queue ID of the status information referred to by index
fah_percentdone (index)	Floating-point percentage-done value
fah_pctdone (index)	Two-digit percentage-done value useful for an ascending bar or gauge
fah_pctleft (index)	Two-digit percentage-left value useful for an descending bar or gauge
fah_project (index)	Project number
fah_status (index)	Formatted percentage done and eta to completion