istats.widget

KO | EN

gitlite — search

#python #react #go #golang #rust #deep-learning #linux #macos #java #windows #vue #mcp #ios #open-source

(★ 30)

A SMC stats widget for Übersicht

istats.widget Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# iStats Widget

![GitHub Actions](https://github.com/roele/istats.widget/actions/workflows/test.yml/badge.svg?branch=master)
[![CodeCov](https://img.shields.io/codecov/c/github/roele/istats.widget/master.svg)](https://codecov.io/gh/roele/istats.widget)
[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/roele_istats.widget?server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/dashboard?id=roele_istats.widget)
[![Apache-2.0](https://img.shields.io/github/license/roele/istats.widget.svg)](https://github.com/roele/istats.widget/blob/master/LICENSE)

> ⚠️ The `iStats Ruby Gem` does not support the ARM architecture and therefore the widget does not work reliably on Apple M1 CPUs (issue [#53](https://github.com/roele/istats.widget/issues/53)).

Made for [Übersicht](http://tracesof.net/uebersicht/).

Uses the [iStats Ruby Gem](https://github.com/Chris911/iStats "iStats") to obtain SMC information about your system.

![Screenshot](https://raw.githubusercontent.com/roele/istats.widget/master/screenshot.png)

## Installation

### Prerequisites

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.

1. Open the Terminal.app
2. Issue the command `xcode-select --install`
3. Issue the command `sudo gem install iStats`
4. Issue the command `istats` and check for the output.

### Widget installation

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

### Widget configuration

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](http://www.webhostinghub.com/glyphs/)).

Example:

```js
    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](https://github.com/Chris911/iStats#usage) or use `istats --help` on how to enable additional keys.

Available sections/keys:

* `cpu` - CPU stats  
      * `cpu-temp` - CPU temperature

* `fan` - Fan stats
      * `total-fans-in-system` - Number of fans
      * `fan-0-speed` - Fan speed, where `0` represents the fan (index) number starting with `0`

* `battery` - Battery stats
      * `cycle-count` - Load cycle count
      * `current-charge` - Current battery charge
      * `maximum-charge` - Maximum battery charge

* `extra` - Extra stats
      * `tcgc-peci-gpu-temp` - PECI GPU temperature
      * any other extra as written in the `istats` output (lowercase, spaces replaced by `-`)

* `tempUnit` `{String}` - CPU temperature unit, either `C` (Celsius) or `F` (Fahrenheit)

* `position` `{String}` - Screen corner position, either `top-left`, `top-right`, `bottom-left` or `bottom-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, either `true` or `false`

* `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`)

### Troubleshooting

* **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 the `command` property in the `index.jsx` accordingly.
  * Open `Show Debug Console` to verify if there are errors shown in the `Console` tab. If so please report an issue to [https://github.com/roele/istats.widget/issues](https://github.com/roele/istats.widget/issues) with the error details.
* **An error is shown in place of the widget**
  * Please report an issue to [https://github.com/roele/istats.widget/issues](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)](https://rvm.io/)? 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 use `rvm`, the following steps are necessary as the `istats` binary is installed in another location.
    * Enable `Load Bash env` in the Übersicht preferences.
    * Change the `command` constant in the widgets `index.jsx`, to point to the `istats` binary from the `which istats` output (e.g. `/Users/foo/.rvm/rubies/ruby-2.5.1/bin/istats`)

### Credits

Icons by [WebHostingHub](http://www.webhostinghub.com/glyphs/)

istats.widget

istats.widget Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

istats.widget

istats.widget Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README