iStats 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7b93789e36378ae3f5b7d25de279ae08e377f9f
-  data.tar.gz: 1610e948db9a121dc1d140f52bddac0820e5e50d
+  metadata.gz: 0edfe640e0fa303d06ffedce02b71914494c16a4
+  data.tar.gz: fbc51f28120c27def40ad66e98f3a85eb2337c82
 SHA512:
-  metadata.gz: 13b22c663000f88713f847afe6ad1171a0027a97c801d037596fc06f1bdd5841250d69e3e4225be8653ac21fe67fc65e711ac1c1640f901d2a0763f563655cb2
-  data.tar.gz: 704090fef830d84c530c1b9fdcafa5091c0b9a351713e1e2bb842af6b3068cdb9541b45587849cd0d8224cf8b07d5abae417805f5a8b537ae0ae535345d803f4
+  metadata.gz: cbb1ef8e4ecedb0d02d7717295852364f4e45e29220d1dfb71cb103c4e20ef94a4900c6300a7a8481e674c8a32fd56fd9a28035f15f6233f7f5ff9a737147829
+  data.tar.gz: fedee41c1544357376465b55ade0a3abd9b8b91a890209700a83e40f72d96ba348af2bc0d20c1ace317ab0733bcbe9fc8b4734f8b3872ad742cee7141c7c5c07

data/README.md

@@ -7,12 +7,9 @@ iStats is a command-line tool that allows you to easily grab the CPU temperature
 
     $ gem install iStats
 
-#### Warning
-**This is now fixed with the release of OS X 10.9.3**<br>
-A [bug in Ruby](https://bugs.ruby-lang.org/issues/9624) and Apple XCode 5.1 onwards (new CLANG version) might make it impossible to install this gem if you are using Ruby from the Xcode command-line tools package. If you see an error when the gem is building the native extension try to use this command to install iStats: <br>
-`sudo ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future gem install iStats`<br>
-If you are using RVM or homebrew to manage your Ruby installation you should be fine.
-
+##### Note
+If you are running an older version of OS X and the install fails you might want to try running this command instead:     
+`sudo ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future gem install iStats`
 
 ## Screenshot
 #### All Stats
@@ -42,9 +39,23 @@ If you are using RVM or homebrew to manage your Ruby installation you should be
   istats battery [charge]                  Print battery charge
   istats battery [capacity]                Print battery capacity info
 
+  istats scan                              Scans and print temperatures
+  istats scan [key]                        Print single SMC temperature key
+  istats enable [key | all]                Enables key
+  istats disable [key | all]               Disable key
+  istats list                              List available keys
+
   for more help see: https://github.com/Chris911/iStats
 ```
 
+## Advanced usage
+
+iStats now supports extra sensors for advanced users. Here's how to enable that functionality: 
+
+1. Run `istats scan` to scan your computer for SMC sensors
+2. Enable extra sensors by running `istats enable key` or `istats enable all` 
+3. Run `istats` or `istats extra` to see the extra sensors information.
+
 ## Contributing
 
 1. Fork it
@@ -54,6 +65,10 @@ If you are using RVM or homebrew to manage your Ruby installation you should be
 5. Create new Pull Request
 
 #### Tested on
-MacBook Pro 2012<br>
-OS X 10.9.3<br>
-Ruby: 1.9.3, 2.0.0, 2.1.1<br>
+MacBook Pro 2012    
+OS X: 10.9.3    
+Ruby: 1.9.3, 2.0.0, 2.1.1    
+
+MacBook Pro 2014    
+OS X: 10.10.3, 10.10.4    
+Ruby: 2.1.3    

data/ext/osx_stats/smc.c

@@ -318,6 +318,7 @@ int getBatteryCharge() {
 /*
  RUBY MODULES
 */
+VALUE SMC_INFO = Qnil;
 VALUE CPU_STATS = Qnil;
 VALUE FAN_STATS = Qnil;
 VALUE BATTERY_STATS = Qnil;
@@ -326,6 +327,10 @@ VALUE BATTERY_STATS = Qnil;
  * We never call this, Ruby does.
 */
 void Init_osx_stats() {
+    
+    SMC_INFO = rb_define_module("SMC_INFO");
+    rb_define_method(SMC_INFO,"is_key_supported",method_SMCKeySupported,1);
+    
     CPU_STATS = rb_define_module("CPU_STATS");
     rb_define_method(CPU_STATS, "get_cpu_temp", method_get_cpu_temp, 0);
 
@@ -342,6 +347,17 @@ void Init_osx_stats() {
     rb_define_method(BATTERY_STATS, "get_battery_charge", method_get_battery_charge, 0);
 }
 
+VALUE method_SMCKeySupported(VALUE self, VALUE key)
+{
+    char *keyString = RSTRING_PTR(key);
+    SMCOpen();
+    double temp = SMCGetTemperature(keyString);
+    SMCClose();
+    
+    return rb_float_new(temp);
+}
+
+
 VALUE method_get_cpu_temp(VALUE self) {
     SMCOpen();
     double temp = SMCGetTemperature(SMC_KEY_CPU_TEMP);

data/ext/osx_stats/smc.h

@@ -103,6 +103,7 @@ CFDictionaryRef IOPSGetPowerSourceDescription(CFTypeRef blob, CFTypeRef ps);
 
 // Ruby modules
 void Init_osx_stats();
+VALUE method_SMCKeySupported(VALUE self, VALUE key);
 VALUE method_get_cpu_temp(VALUE self);
 VALUE method_get_fan_speed(VALUE self, VALUE num);
 VALUE method_get_fan_number(VALUE self);

data/iStats.gemspec

@@ -26,6 +26,7 @@ spec = Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9.3"
 
   s.add_dependency "sparkr", "~> 0.4"
+  s.add_dependency "parseconfig", "~> 1.0"
 
   s.add_development_dependency "bundler", "~> 1.3"
   s.add_development_dependency "rake", "~> 1.8"

data/lib/iStats.rb

@@ -14,6 +14,9 @@ require 'iStats/command'
 require 'iStats/cpu'
 require 'iStats/fan'
 require 'iStats/battery'
+require 'iStats/extra'
+require 'iStats/smc'
+require 'iStats/settings'
 
 module IStats
   def self.options

data/lib/iStats/command.rb

@@ -13,6 +13,7 @@ module IStats
         category = args.empty? ? 'all' : args.shift
         stat     = args.empty? ? 'all' : args.shift
 
+        Settings.load;
         parse_options
         delegate(category, stat)
       end
@@ -32,6 +33,16 @@ module IStats
           Fan.delegate stat
         when 'battery'
           Battery.delegate stat
+        when 'extra'
+          Extra.delegate stat
+        when 'scan'
+          SMC.delegate stat
+        when 'enable'
+          Settings.delegate ['enable',stat]
+        when 'disable'
+          Settings.delegate ['disable',stat]
+        when 'list'
+          Settings.list
         else
           help("Unknown category: #{category}")
         end
@@ -46,6 +57,14 @@ module IStats
         Fan.all
         puts "\n--- Battery Stats ---\n"
         Battery.all
+
+        sensors = $config.params
+        if sensors.keys.any? {|key| sensors[key]['enabled'] == "1"}
+          puts "\n--- Extra Stats ---\n"
+          Extra.all
+        else
+          puts "\nFor more stats run `istats extra` and follow the instructions."
+        end
       end
 
       # Public: Parse extra options
@@ -96,6 +115,12 @@ module IStats
           istats battery [temp | temperature]      Print battery temperature
           istats battery [charge]                  Print battery charge
           istats battery [capacity]                Print battery capacity info
+            
+          istats scan                              Scans and print temperatures
+          istats scan [key]                        Print single SMC temperature key
+          istats enable [key | all]                Enables key
+          istats disable [key | all]               Disable key
+          istats list                              List available keys
 
           for more help see: https://github.com/Chris911/iStats
         ".gsub(/^ {8}/, '') # strip the first eight spaces of every line

data/lib/iStats/extra.rb

@@ -0,0 +1,61 @@
+# Extra Stats
+# Displays any extra sensors enabled in config
+#
+module IStats
+  class Extra
+    extend SMC_INFO
+    class << self
+
+      # Delegate CLI command to function
+      #
+      def delegate(stat)
+        if stat == 'all'
+          all
+        else
+          sensor_temperature stat
+        end
+      end
+
+      # Prints temperature for all enabled keys
+      #
+      def all
+        sensors = $config.params
+        display = sensors['AltDisplay']
+        if sensors.keys.any? {|key| sensors[key]['enabled'] == "1"}
+          sensors.keys.each{ |key|
+            if (sensors[key]['enabled'] == "1")
+              extra_enabled = true
+              display_temp(key, sensors[key], display)
+            end
+          }
+        else
+          puts "Looks like you don't have any extra keys enabled. \nRun `istats scan` for the initial scan or `istats --help` for more info."
+        end
+      end
+
+      # Prints temperature for specific key
+      #
+      def sensor_temperature(key)
+        sensors = $config.params
+        display = sensors['AltDisplay']
+        sensor = sensors[key]
+        if sensor.nil?
+          Command.help "Unknown sensor: #{stat}"
+        else
+          display_temp(key, sensor, display)
+        end
+      end
+
+      # Pretty print sensor tempaerature
+      def display_temp(key, sensor, display)
+        t = SMC.is_key_supported(key).round(2);
+        thresholds = sensor['thresholds'][1..-2].split(/, /).map { |s| s.to_i }
+        if (display)
+          puts "#{key} #{t}#{Symbols.degree}C \t" + Printer.gen_sparkline(t, thresholds) + " #{sensor['name']}"
+        else
+          puts "#{key} #{sensor['name']} temp: #{t}#{Symbols.degree}C  " + Printer.gen_sparkline(t, thresholds)
+        end
+      end
+    end
+  end
+end

data/lib/iStats/settings.rb

@@ -0,0 +1,102 @@
+module IStats
+  class Settings
+    require 'parseconfig'
+    @configFile = "sensors.conf"
+    @configDir = File.expand_path("~/.iStats") + "/"
+
+    class << self
+
+      def delegate(stat)
+        case stat[0]
+        when 'enable'
+          if (stat[1] == 'all')
+            toggleAll("1")
+          else
+            set(stat[1], "1")
+          end
+        when 'disable'
+          if (stat[1] == 'all')
+            toggleAll("0")
+          else
+            set(stat[1], "0")
+          end
+        else
+          puts "Unknown command"
+        end
+      end
+
+      def load
+        if File.exists?(@configDir + @configFile)
+          $config = ParseConfig.new(@configDir + @configFile)
+        else
+           $config = ParseConfig.new
+         end
+      end
+
+      def configFileExists
+        if File.exists?(@configDir + @configFile)
+          $config = ParseConfig.new(@configDir + @configFile)
+        else
+          puts "No config file #{@configDir}#{@configFile} found .. Run scan"
+          if !File.exists?(@configDir)
+            Dir.mkdir( @configDir)
+          end
+          file=File.open(@configDir + @configFile,"w+")
+          file.close
+        end
+      end
+
+      def addSensor(key,sensors)
+        settings = ParseConfig.new(@configDir + @configFile)
+        settings.add(key,sensors)
+        file = File.open(@configDir + @configFile,'w')
+        settings.write(file)
+        file.close
+      end
+
+      def set(key,value)
+        configFileExists
+        settings = ParseConfig.new(@configDir + @configFile)
+        sensors =settings.params
+        if (sensors[key])
+          sensors[key]['enabled'] = value
+        else
+          puts "Not valid key"
+        end
+        file = File.open(@configDir + @configFile,'w')
+        settings.write(file)
+        file.close
+      end
+
+      def toggleAll(value)
+        if File.exists?(@configDir + @configFile)
+          settings = ParseConfig.new(@configDir + @configFile)
+          settings.params.keys.each{ |key|
+            if (settings.params[key]['enabled'])
+              settings.params[key]['enabled'] = value
+            end
+          }
+          file = File.open(@configDir + @configFile,'w')
+          settings.write(file)
+          file.close
+        else
+          puts "Run 'istats scan' first"
+        end
+      end
+
+      def list
+        if File.exists?(@configDir + @configFile)
+          settings = ParseConfig.new(@configDir + @configFile)
+          settings.params.keys.each{ |key|
+            if (settings[key]['enabled'])
+              puts key + " => " + SMC.name(key) + " Enabled = " + settings[key]['enabled']
+            end
+          }
+        else
+          puts "Run 'istats scan' first"
+        end
+      end
+
+    end
+  end
+end

data/lib/iStats/smc.rb

@@ -0,0 +1,130 @@
+# SMC
+# Extend CPU_STATS C module (ext/osx_stats/smc.c)
+#
+module IStats
+  class SMC
+    extend SMC_INFO
+    class << self
+      # Delegate CLI command to function
+      #
+      def delegate(stat)
+        case stat
+        when 'all'
+          all
+        else
+          scan_supported_key(stat)
+        end
+      end
+
+      # Call all functions (stats)
+      #
+      def all
+        scan_supported_keys
+      end
+
+      def name(key)
+        sensors_name = {
+          'TA0P' => 'Ambient temperature',
+          'TA0p' => 'Ambient temperature',
+          'TA1P' => 'Ambient temperature',
+          'TA1p' => 'Ambient temperature',
+          'TA0S' => 'PCI Slot 1 Pos 1',
+          'TA1S' => 'PCI Slot 1 Pos 2',
+          'TA2S' => 'PCI Slot 2 Pos 1',
+          'TA3S' => 'PCI Slot 2 Pos 2',
+          'Tb0P' => 'BLC Proximity',
+          'TB0T' => 'Battery TS_MAX',
+          'TB1T' => 'Battery 1',
+          'TB2T' => 'Battery 2',
+          'TB3T' => 'Battery 3',
+          'TC0C' => 'CPU 0 Core',
+          'TC0D' => 'CPU 0 Die',
+          'TCXC' => 'PECI CPU',
+          'TCXc' => 'PECI CPU',
+          'TC0E' => 'CPU 0 ??',
+          'TC0F' => 'CPU 0 ??',
+          'TC0G' => 'CPU 0 ??',
+          'TC0H' => 'CPU 0 Heatsink',
+          'TC0J' => 'CPU 0 ??',
+          'TC0P' => 'CPU 0 Proximity',
+          'TC0c' => '',
+          'TC0d' => '',
+          'TC0p' => '',
+          'TC1C' => 'Core 1',
+          'TC1c' => '',
+          'TC2C' => 'Core 2',
+          'TC2c' => '',
+          'TC3C' => 'Core 3',
+          'TC3c' => '',
+          'TC4C' => 'Core 4',
+          'TC5C' => 'Core 5',
+          'TC6C' => 'Core 6',
+          'TC7C' => 'Core 7',
+          'TC8C' => 'Core 8',
+          'TCGC' => 'PECI GPU',
+          'TCGc' => 'PECI GPU',
+          'TCPG' => '',
+          'TCSC' => 'PECI SA',
+          'TCSc' => 'PECI SA',
+          'TCSA' => 'PECI SA',
+          'TG0H' => 'GPU 0 Heatsink',
+          'TG0P' => 'GPU 0 Proximity',
+          'TG0D' => 'GPU 0 Die',
+          'TG1D' => 'GPU 1 Die',
+          'TG1H' => 'GPU 1 Heatsink',
+          'TH0P' => 'Harddisk 0 Proximity',
+          'Th1H' => 'NB/CPU/GPU HeatPipe 1 Proximity',
+          'TL0P' => 'LCD Proximity',
+          'TM0P' => 'Memory Slot Proximity',
+          'TM0S' => 'Memory Slot 1',
+          'Tm0p' => 'Misc (clock chip) Proximity',
+          'TO0P' => 'Optical Drive Proximity',
+          'Tp0P' => 'PowerSupply Proximity',
+          'TS0C' => 'Expansion slots',
+          'Ts0P' => 'Palm rest L',
+          'Ts0S' => 'Memory Bank Proximity',
+          'Ts1p' => 'Palm rest R',
+          'TW0P' => 'AirPort Proximity'
+        }
+
+        return sensors_name.fetch(key,"Unknown")
+
+      end
+      # Print temperature with sparkline
+      #
+      def scan_supported_keys
+        sensors = Hash.new
+        Settings.configFileExists
+
+        puts "Scanning keys...\n\n"
+
+        characters = [('a'..'z'), ('A'..'Z'),(0..9)].map { |i| i.to_a }.flatten
+        characters.each {|l1|
+          characters.each {|l2|
+            characters.each {|l3|
+              key = "T#{l1}#{l2}#{l3}"
+              t = is_key_supported(key);
+              if (t != 0.0)
+                sensors['thresholds'] = [50, 68, 80, 90]
+                sensors['name'] = name(key)
+                sensors['enabled'] = 0
+
+                Settings.addSensor(key, sensors)
+
+                puts "#{key} #{sensors['name']}  #{t}#{Symbols.degree}C  " + Printer.gen_sparkline(t, sensors['thresholds'])
+              end
+            }
+          }
+        }
+        puts "\nDone scanning keys.\n"
+        puts "All keys are disabled by default. Use `istats set [key]` to enable specific keys or `istats enable all`."
+        puts "The enabled sensors will show up when running `istats` or `istats extra`."
+      end
+
+      def scan_supported_key(key)
+        t = is_key_supported(key)
+        puts " Scanned #{key} result = #{t}";
+      end
+    end
+  end
+end

data/lib/iStats/version.rb

@@ -1,3 +1,3 @@
 module IStats
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iStats
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris911
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sparkr
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: parseconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -91,8 +105,11 @@ files:
 - lib/iStats/color.rb
 - lib/iStats/command.rb
 - lib/iStats/cpu.rb
+- lib/iStats/extra.rb
 - lib/iStats/fan.rb
 - lib/iStats/printer.rb
+- lib/iStats/settings.rb
+- lib/iStats/smc.rb
 - lib/iStats/symbols.rb
 - lib/iStats/version.rb
 homepage: https://github.com/Chris911/iStats