Function notes
Winamp
Function | Description | Example use | Example output |
---|---|---|---|
$WinampTitle | Current track title. Actual displayed text is controlled by the Advanced Title Formatting setting within WinAmp. |
$WinampTitle | My Bloody Valentine - Feed Me With Your Kiss Dinosaur Jr. - Out There |
$WinampChannels | For current track, it's one of: mono, stereo | $WinampChannels | stereo mono |
$WinampKBPS | Current tracks kbps | $WinampKBPS $WinampKBPSkbps |
192 192kbps |
$WinampFreq | Current tracks freq | $WinampFreq $WinampFreqkHz |
44 44kHz |
$WinampStat | Current state, one of: paused, stopped, playing | $WinampStat | playing paused stopped |
$WinampPosition([barlen]) | Displays a position bar of length [barlen] | $WinampPosition(5) | -+--- |
$WinampPolo | Current tracks position. | $WinampPolo | 2min 10sec 1hrs 2min 10sec 10sec |
$WinampPosh | Current tracks position, in hrs:min:secs format. | $WinampPosh | 2:10 1:2:10 10 |
$Winamppos | Current tracks position, in seconds. | $Winamppos | 130 3730 10 |
$WinampRelo | Remaining time of current track. | $WinampRelo | 2min 10sec 1hrs 2min 10sec 10sec |
$WinampResh | Remaining time of current track, in hrs:mins:secs format | $WinampResh | 2:10 1:2:10 10 |
$WinampRem | Remaining time of current track, in seconds | $WinampRem | 130 3730 10 |
$WinampLengtl | Length of current track. | WinampLengtl | 2min 10sec 1hrs 2min 10sec 10sec |
$WinampLengts | Length of current track, in hrs:mins:secs format. | WinampLengts | 2:10 1:2:10 10 |
$WinampLength | Length of current track, in seconds. | $WinampLengts | 130 3730 10 |
$WinampTracknr | Track number of current track. | $WinampTracknr | 10 |
$WinampTotalTracks | Total number of tracks in playlist. | $WinampTotalTracks | 31 |
Network Stats
Function | Description | Example use | Example output |
---|---|---|---|
$NetIPaddress | Main IP address of computer. | $NetIPaddress | 127.0.0.1 |
$NetAdapter([adapter]) | Name of adapter number [adapter]. [adapter] can be 0-9. |
$NetAdapter(1) | 3Com EtherLink PCI |
$NetDownK([adapter]) | Total downloaded in KBs via adapter number [adapter]. [adapter] can be 0-9. |
$NetDownK(1) $NetDownK(1)KB |
45.3 45.3KB |
$NetUpK([adapter]) | Total uploaded in KBs via adapter number [adapter]. [adapter] can be 0-9. |
$NetUpK(1) $NetUpK(1)KB |
45.3 45.3KB |
$NetDownM([adapter]) | Total downloaded in MBs via adapter number [adapter]. [adapter] can be 0-9. |
$NetDownM(1) $NetDownM(1)MB |
45.3 45.3MB |
$NetUpM([adapter]) | Total uploaded in MBs via adapter number [adapter]. [adapter] can be 0-9. |
$NetUpM(1) $NetUpM(1)MB |
45.3 45.3MB |
$NetDownG([adapter]) | Total downloaded in GBs via adapter number [adapter]. [adapter] can be 0-9. |
$NetDownG(1) $NetDownG(1)GB |
45.3 45.3GB |
$NetUpG([adapter]) | Total uploaded in GBs via adapter number [adapter]. [adapter] can be 0-9. |
$NetUpG(1) $NetUpG(1)GB |
45.3 45.3GB |
$NetErrDown([adapter]) | Total downloaded packets that were discarded via adapter number [adapter] because they contained errors. [adapter] can be 0-9. |
$NetErrDown(1) | 45 |
$NetErrUp([adapter]) | Total uploaded packets that were discarded via adapter number [adapter] because they contained errors. [adapter] can be 0-9. |
$NetErrUp(1) | 45 |
$NetErrTot([adapter]) | Total packets (up and down) that were discarded via adapter number [adapter] because they contained errors. [adapter] can be 0-9. |
$NetErrTot(1) | 90 |
$NetDiscDown([adapter]) | Total downloaded packets that were discarded via adapter number [adapter] even if they didn't contain errors. [adapter] can be 0-9. |
$NetDiscDown(1) | 45 |
$NetDiscUp([adapter]) | Total uploaded packets that were discarded via adapter number [adapter] even if they didn't contain errors. [adapter] can be 0-9. |
$NetDiscUp(1) | 45 |
$NetDiscTot([adapter]) | Total packets (up and down) that were discarded via adapter number [adapter] even if they didn't contain errors. [adapter] can be 0-9. |
$NetDiscTot(1) | 90 |
$NetUniDown([adapter]) | Downloaded unicast packets via adapter number [adapter]. [adapter] can be 0-9. |
$NetUniDown(1) | 10 |
$NetUniUp([adapter]) | Uploaded unicast packets via adapter number [adapter]. [adapter] can be 0-9. |
$NetUniUp(1) | 10 |
$NetUniTot([adapter]) | Total (up and down) unicast packets via adapter number [adapter]. [adapter] can be 0-9. |
$NetUniTot(1) | 20 |
$NetNuniDown([adapter]) | Downloaded non-unicast packets via adapter number [adapter]. [adapter] can be 0-9. |
$NetNuniDown(1) | 10 |
$NetNuniUp([adapter]) | Uploaded non-unicast packets via adapter number [adapter]. [adapter] can be 0-9. |
$NetNuniUp(1) | 10 |
$NetNuniTot([adapter]) | Total (up and down) non-unicast packets via adapter number [adapter]. [adapter] can be 0-9. |
$NetNuniTot(1) | 20 |
$NetPackTot([adapter]) | Total (up and down) packets (both unicast and non-unicast) via adapter number [adapter]. [adapter] can be 0-9. |
$NetPackTot(1) | 40 |
$NetSpDownK([adapter]) | Download speed in KB/s of adapter number [adapter]. [adapter] can be 0-9. |
$NetSpDownK(1) | 10.2 |
$NetSpDownM([adapter]) | Download speed in MB/s of adapter number [adapter]. [adapter] can be 0-9. |
$NetSpDownM(1) | 10.2 |
$NetSpUpK([adapter]) | Upload speed in KB/s of adapter number [adapter]. [adapter] can be 0-9. |
$NetSpUpK(1) | 10.2 |
$NetSpUpM([adapter]) | Upload speed in MB/s of adapter number [adapter]. [adapter] can be 0-9. |
$NetSpUpM(1) $NetSpUpM(1)MB/s | 10.2 10.2MB/s |
Sysinfo
Function | Description | Example use | Example output |
---|---|---|---|
$Username | Name of user running smartie. | $Username | Administrator |
$Computername | Hostname | $Computername | VMWare1 |
$CPUType | Type of CPU (only first processor on multi-processor machines) | $CPUType | Intel Pentium III |
$CPUSpeed | Speed of CPU in MHz (only first processor on multi-processor machines) | $CPUSpeed $CPUSpeedMhz |
750 750Mhz |
$CPUUsage% | CPU Usage percentage (only first processor on multi-processor machines) | $CPUUsage% $CPUUsage%% |
50 50% |
$UpTime | How long the computer has been running. Format is: [YEARS]yrs [MONTHS]mts [DAYS]dys [HOURS]hrs [MINUTES]mins [SECONDS]secs years/months/days/hours/mins will only appear if the system has been up that long. |
$UpTime | 09secs 1min 09secs 1hr 1min 09secs 1dys 1hr 1min 09secs 1mts 1dys 1hr 1min 09secs 1yr 1mts 1dys 1hr 1min 09secs |
$UpTims | How long the computer has been running. Short version of $Uptime - only shows the three top units and uses only one letter for unit type. |
$UpTims | 09s 1m 09s 1h 1m 09s 1d 1h 1m 1m 1d 1h 1y 1m 1d |
$MemFree | How much memory in MBs is free. | $MemFree $MemFreeMB |
1000 1000MB |
$MemUsed | How much memory in MBs is used. | $MemUsed $MemUsedMB |
1000 1000MB |
$MemTotal | Total Memory in MB. | $MemTotal $MemTotalMB |
2000 2000MB |
$PageFree | How much page memory in MBs is free. | $PageFree $PageFreeMB |
1000 1000MB |
$PageUsed | How much page memory in MBs is used. | $PageUsed $PageUsedMB |
1000 1000MB |
$PageTotal | Total page memory in MB. | $PageTotal $PageTotalMB |
2000 2000MB |
$MemF% | Percentage of memory free. | $MemF% $MemF%% |
10 10% |
$MemU% | Percentage of memory used. | $MemU% $MemU%% |
90 90% |
$PageF% | Percentage of page memory free. | $PageF% $PageF%% |
10 10% |
$PageU% | Percentage of page memory used. | $PageU% $PageU%% |
90 90% |
$HDFreg([disk]) | Free disk space on disk [disk] in GB. | $HDFreg(C) $HDFreg(C)GB |
10 10GB |
$HDFree([disk]) | Free disk space on disk [disk] in MB. | $HDFree(C) $HDFree(C)MB |
10 10MB |
$HDUseg([disk]) | Used disk space on disk [disk] in GB. | $HDUseg(C) $HDUseg(C)GB |
10 10GB |
$HDUsed([disk]) | Used disk space on disk [disk] in MB. | $HDUsed(C) $HDUsed(C)MB |
10 10MB |
$HDF%([disk]) | Percentage of free disk space on disk [disk]. | $HDF%(C) $HDF%(C)% |
10 10% |
$HDTotag([disk]) | Total size of disk [disk] in GB. | $HDTotag(C) $HDTotag(C)GB |
10 10GB |
$HDTotal([disk]) | Total size of disk [disk] in MB. | $HDTotal(C) $HDTotal(C)MB |
10 10MB |
$ScreenReso | Current screen resolution. | $ScreenReso | 1280x1024 |
MBM stats
For the following to work, you need MBM installed. Development on MBM has stopped - but it can still be downloaded and is still useful.Function | Description | Example use | Example output |
---|---|---|---|
$Tempname[num] | Name of temperature sensor number [num]. [num] can be 1-11. |
$Tempname2 | CPU |
$Temp[num] | Value of temperature sensor number [num]. [num] can be 1-11. |
$Temp2 | 42.4 |
$Fanname[num] | Name of fan speed sensor number [num]. [num] can be 1-11. |
$Fanname2 | GPU |
$FanS[num] | Value of fan speed sensor number [num]. [num] can be 1-11. |
$FanS2 $FanS2rpm |
10000 10000rpm |
$Voltname[num] | Name of voltage sensor number [num]. [num] can be 1-11. |
$Voltname2 | 5v |
$Voltage[num] | Value of voltage sensor number [num]. [num] can be 1-11. |
$Voltage | 4.95 |
Function | Description | Example use | Example output |
---|---|---|---|
$Email[num] | Number of emails in pop mail box number [num]. [num] can be 0-9. |
$Email1 | 5 |
$EmailSub[num] | The subject line of the last email in in pop mail box number [num]. [num] can be 0-9. |
$EmailSub1 | Re: LCD Smartie bug report |
$EmailFrom[num] | The from address of the last email in in pop mail box number [num]. [num] can be 0-9. |
$EmailFrom1 | Robert Smith |
SETI@home
SETI@home account details are configured in the SETI@home tab of the setup form.Function | Description | Example use | Example output |
---|---|---|---|
$SETIResults | The number of SETI results you've returned. | $SETIResults | 25 |
$SETICPUTime | Total CPU time given. | $SETICPUTime | 11.940 years |
$SETIAverage | Average CPU time per a work unit. | $SETIAverage | 39 hr 01 min 37.4 secs |
$SETIAverage | Average CPU time per a work unit. | $SETIAverage | 39 hr 01 min 37.4 secs |
$SETILastresult | Average CPU time per a work unit. | $SETILastresult | Tue Nov 30 18:07:12 2004 UTC |
$SETIusertime | How long you're been a SET@home user. | $SETIusertime | 5.573 years |
$SETIrank | Your rank. | $SETIrank | 5.573 years |
$SETIsharingrank | Users sharing your rank. | $SETIsharingrank | 43 |
$SETImoreWU | Percentage of users who have complete less work than you. | $SETImoreWU $SETImoreWU% |
97.800 97.800% |
$SETtotalusers | Total number of users registered for SETI@home | $SETItotalusers | 5268520 |
Folding@home
Folding@home account details are configured in the FOLD@home tab of the setup form.Function | Description | Example use | Example output |
---|---|---|---|
$FOLDmemsine | Date of joining Folding@home. | No longer supported | No longer supported |
$FOLDlastwu | Date of last work unit. | $FOLDlastwu | 2004-11-29 20:07:35 |
$FOLDactproc | Active processors (within 7 days) | $FOLDactproc | 18 |
$FOLDteam | Team name | $FOLDteam | Overclockers Australia |
$FOLDscore | Score | $FOLDscore | 5069917 |
$FOLDrank | Overall rank | $FOLDrank | 5 |
$FOLDwu | Work units completed. | $FOLDwu | 127564 |
Game stats
The server used to obtain server stats is configured in the gamestats tab of the setup form - and is configurable for each line of the screen.Function | Description | Example use | Example output |
---|---|---|---|
$Half-life[funcnum] | Get a half-life stat, where [funcnum] is:
|
$Half-life1 | BobsServer |
$Unreal[funcnum] | Get a unreal stat, where [funcnum] is:
|
$Unreal1 | BobsServer |
$QuakeII[funcnum] | Get a Quake II stat, where [funcnum] is:
|
$QuakeII1 | BobsServer |
$QuakeIII[funcnum] | Get a Quake III stat, where [funcnum] is:
|
$QuakeIII1 | BobsServer |
Misc
Function | Description | Example use | Example output |
---|---|---|---|
$Rss([url],[type]) $Rss([url],[type],[itemnum]) $Rss([url],[type],[itemnum],[maxfreq]) |
Process a RSS feed from url [url]. [type] is t for title, d for description, or b for both [itemnum] is the item number you want to display (0=all) [maxfreq] is the number of hours that must past before checking the feed again - this can be important as some sites ban users that fetch the feed more often than that stated in the T&Cs. DEFAULT: [itemnum] defaults to 0, [maxfreq] default to no limit. |
$Rss(http://somesite.com/rss.xml,t,1) | [top headline from somesite] |
$Count([num1]#[num2]#...#[numn]) | Add [num1] [num2] [num3] etc together. | $Count(1#2#3) $Count($HDFree(C)#$HDFree(D)) |
6 20032 |
$Chr([asciicode]) | Inserts ascii character at index [asciicode]. | $Chr(65) | A |
$MObutton([key]) | Displays 1 if the last key was |
$MObutton(A) | 0 |
$Flash([text]$)$ | Flashes text [text]. The extra $s are required. | $Flash(hello$)$ | hello |
$Fill([num]) | Insert spaces until the current character position is [num], so any following text will be position at [num]+1. | A$Fill(5)B | A B |
$Right([text],$[num]%) | Insert spaces so the text [text] is right justified in a space of [num] characters. The extra $ and % are required. | AA$Right(hi,$5%)B | AA hiB |
$Center([text],[num]) $Center([text]) |
Insert spaces so the text [text] is centered in a space of [num] characters. If the [num] parameter is missing, such as $Center(hi), then the display's width is used. | AA$Center(hi,5)B | AA hi B |
$Bar([value],[maxvalue],[barsize]) | Draw a hoz. graph, where: [value] the value being graphed. [maxvalue] is the maximum value expected of [value]. [barsize] is the size of the bar in characters. |
$Bar($CPUUsage%,100,20) | [a bar graph of length 20] |
$LogFile([file],[line]) | Read a line from the end of a file [file], where: [line] is 0-3. 0 fetches the last line, 3 fetches the fourth line from the bottom. |
$LogFile(c:\bob.txt,0) | [last line from c:\bob.txt] |
$File([file],[line]) | Read a line from a file [file], where: [line] is the line number (counting from the beginning). |
$File(c:\bob.txt,1) | [first line from c:\bob.txt] |
$CustomChar([char#],[d1],[d2],[d3],[d4],[d5],[d6],[d7],[d8]) Custom characters are usually 8 lines by 5 dots, d1-d8 are the 8 lines. To get a value for a line simply add 16 for a dot in the 1st dot of a line, 8 for the 2nd, 4 for the 3rd, 2 for the 2nd, 1 for the 1st [reading dots from left to right] To use the characters:
|
Define a custom character. [char#] can be 1-8. | $CustomChar(7,4,4,4,4,4,4,4,0) | [character 7 is now a | symbol] |
$DnetDone | Distributed.net RC5/OGR done (file location defined in Misc tab of setup) |
$DnetDone | 50 |
$DnetSpeed | Distributed.net RC5/OGR speed (file location defined in Misc tab of setup) |
$DnetSpeed | 50 |
$Time([format]) | Display the time in the format [format] [format] is defined is directly passed the FormatDateTime function. |
$Time(d/m/y) $Time(ddd d of mmm yyyy) |
12/11/04 Wednesday 9 of February 2004 |
$dll([dll],[funcnum],[params1],[params2]) | Call function function[funcnum] in dll [dll] with parameters [params1] and [params2]. [dll] is the name of the dll, you may leave off the .dll extension if you wish. [funcnum] can be 1-20 |
$dll(mydll.dll,2,hello,there) | [function2 is called; function2('hello','there') and it's return value is displayed] |