Add-on:SpeedFan Information Display

Getting SpeedFan
SpeedFan is available at: http://www.almico.com/speedfan.php

Compatibility
This plugin has been tested with SpeedFan 4.44. It should work with any version of SpeedFan that outputs the log file in the same format as 4.44. It has been tested on XBMC Eden (11.0) and Frodo (12.0) on Windows and Macintosh. It has not been tested on Dharma (10.1) and likely will not work on Dharma.

SpeedFan Setup
This readme is not meant to be a tutorial on how to setup SpeedFan or enable logging. The SpeedFan web site is available to help you with that. To get SpeedFanInfo to properly parse the log file, you do need to label the various SpeedFan items in a specific way.

SpeedFanInfo knows about four kinds of log items: temperatures, fan speeds, voltages, and fan speed percentages.

Temperatures

This is the first tab in the SpeedFan configuration window (labeled Temperatures). Any item you are logging needs it's label to end with .temp (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU.temp)

Fan Speeds

This is the second tab in the SpeedFan configuration window (labeled Fans). Any item you are logging needs it's label to end with .speed (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.speed)

Voltages

This is the third tab in the SpeedFan configuration window (labeled Voltages). Any item you are logging needs it's label to end with .voltage (not case sensitive) for SpeedFanInfo to parse it. (i.e. +12V.voltage)

Fan Speed Percentages

This is the fourth tab in the SpeedFan configuration window (labeled Speeds). Any item you are logging needs it's label to end with .percent (not case sensitive) for SpeedFanInfo to parse it. (i.e. CPU Fan.percent) A special note about fan speed percentages. They will only show on the SpeedFanInfo screen if you name the percentage the sam as the fan speeds (i.e. CPU.speed and CPU.percent). If there is no corresponding percentage for a given speed, only the speed will be displayed.

Addon Options
After you install this plugin, go to the plugin settings. There are a few options to set.

General
'Log File Location:'' (default empty)

The folder where SpeedFan is storing the log file. By default this will likely be C:/Program Files/SpeedFan/

Use Compact Display

When selected you get a smaller sidebar style display of readings rather than the fullscreen version. If you select this option you will get a slider to select the transparency level of the background. This is a nice option if you want to be able to peek at the information while watching other media.

Log Temperature Scale

This should be set to match the temperature scale to which you have SpeedFan set. This setting just tells the plugin what to put after the integer value for the temperature. This plugin will not convert from Celcius to Farenheit (or vice versa).

Window Update Interval (in seconds)

The number of seconds between updates to the screen. Please note that SpeedFan will sometimes get it's logging a little out of sync, so sometimes the fan speed and fan speed percentages don't actually match. This only happens when your fan speeds are fluctuating pretty rapidly, so if you wait through a couple of screen refreshes, the numbers usually start matching again.

Enable debug logging: (default false)

When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

Additional Logs
"'Primary Log File Title:'' (default empty)

SpeedFan Information Display can display log files from multiple machines if you'd like to monitor a media server or other remote server. If you add additional logs, you should provide a name for the primary log so you can tell the information apart.

"'Use Log File x:'' (default false)

Enable one or both of these to monitor other SpeedFan logs. Once enabled, you need to provide a name and location for the log.

Setting a Keyboard Shortcut
If you are using the compact display, you will probably want to assign a keyboard shortcut to launch SpeedFanInfo (and then map that to a key on your remote). To do that you need to add a custom key mapping. Information on key mapping is available at http://wiki.xbmc.org/index.php?title=Keymap Here's an example of assigning SpeedFanInfo to launch when you press F1. RunAddon(script.speedfaninfo)

Using a SpeedFan Log File on Network Storage
In most cases you can access the SpeedFan log file stored on a network drive only if you map a local drive letter or mount point in your OS.

Getting Help
Please see the thread in the XBMC forums for assistance. 

Beta Testing
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions from pkscout's Add On Beta Channel. You can also monitor the support thread, as links to particular beta releases will be available there as well.