⚠️ TheiStats Ruby Gem
does not support the ARM architecture and therefore the widget does not work reliably on Apple M1 CPUs (issue #53).
Made for Übersicht.
Uses the iStats Ruby Gem to obtain SMC information about your system.
The widget requires the installation of the iStats
Ruby gem to work. Installation of the gem requires
XCode Command Line Tools installed. Follow the steps outlined below to install the gem.
- Open the Terminal.app
- Issue the command
xcode-select --install
- Issue the command
sudo gem install iStats
- Issue the command
istats
and check for the output.
To install the widget, extract the istats.widget.zip
in your Übersicht widget folder (also see Übersicht > Preferences).
The final result should look similar to following.
.
..
getting-started.coffee
istats.widget
übersicht-logo.png
Some basic configuration options can be found in the file index.jsx
in the top section defined as constant config
.
-
stats
{String|Object}
- Array of stat keys in rendering order.The key has the format
<section>.<key>
or{key: '<section.key>', icon: '<icon.name>'}
where the later format can be used to override the default icons (for available icons and names see WebHostingHub).Example:
stats: [ 'cpu.cpu-temp', { key: 'extra.tcgc-peci-gpu-temp', icon: 'icon-gpu-graphicscard' }, 'fan.fan-0-speed' ]
Keys for which no data is present will be ignored. Availability of keys depends on the underlying hardware and enablement in context of
istats
. Please see istats usage or useistats --help
on how to enable additional keys.Available sections/keys:
-
cpu
- CPU statscpu-temp
- CPU temperature
-
fan
- Fan statstotal-fans-in-system
- Number of fansfan-0-speed
- Fan speed, where0
represents the fan (index) number starting with0
-
battery
- Battery statscycle-count
- Load cycle countcurrent-charge
- Current battery chargemaximum-charge
- Maximum battery charge
-
extra
- Extra statstcgc-peci-gpu-temp
- PECI GPU temperature- any other extra as written in the
istats
output (lowercase, spaces replaced by-
)
-
-
tempUnit
{String}
- CPU temperature unit, eitherC
(Celsius) orF
(Fahrenheit) -
position
{String}
- Screen corner position, eithertop-left
,top-right
,bottom-left
orbottom-right
-
top
{String}
- Top position in px (e.g.100px
) -
left
{String}
- Left position in px (e.g.100px
) -
bottom
{String}
- Bottom position in px (e.g.100px
) -
right
{String}
- Right position in px (e.g.100px
) -
animations
{Boolean}
- Icon animations flag, eithertrue
orfalse
-
width
{Number}
- Stat donut chart width in px (e.g.74
) -
height
{Number}
- Stat donut chart height in px (e.g.40
) -
radius
{Number}
- Stats donut chart radius in px (e.g.18
) -
strokeWidth
{Number}
- Stat donut chart stroke width in px (e.g.2
) -
color
{String}
- Stat color (e.g.#666
) -
iconSize
{String}
- Stat icon size (e.g.1.0rem
) -
iconLineHeight
{String}
- Stat icon line height (e.g.2.5rem
) -
labelSize
{String}
- Stat label font size (e.g.0.625rem
)
- The widget does not work and/or shows nothing
- Verify the location of your istats binary by issuing
which istats
in your shell and adapt thecommand
property in theindex.jsx
accordingly. - Open
Show Debug Console
to verify if there are errors shown in theConsole
tab. If so please report an issue to https://github.com/roele/istats.widget/issues with the error details.
- Verify the location of your istats binary by issuing
- An error is shown in place of the widget
- Please report an issue to https://github.com/roele/istats.widget/issues with the error, environment and hardware details.
- Did you upgrade your macOS recently? Try re-installing the iStats Ruby gem as indicated in the prerequisites.
- Do you use Ruby Version Manager (rvm)? To figure out, issue
which istats
in the command line and check if the binary is located at/Users/{user}/.rvm/rubies/ruby-{version}/bin/istats
. If you uservm
, the following steps are necessary as theistats
binary is installed in another location.- Enable
Load Bash env
in the Übersicht preferences. - Change the
command
constant in the widgetsindex.jsx
, to point to theistats
binary from thewhich istats
output (e.g./Users/foo/.rvm/rubies/ruby-2.5.1/bin/istats
)
- Enable
Icons by WebHostingHub