iStats 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4b51e404e967587290c2dffb093f7703ab1440f
-  data.tar.gz: d4c35add73857760cbcd18a1f3bd6c23f53f3373
+  metadata.gz: bbfee43c97edf5782f5620706731a0dc1c3b4656
+  data.tar.gz: e3817ed49ea0fdc535fd75b3c6d6ae870a268263
 SHA512:
-  metadata.gz: 7d2a747930f420134915c961db00568d8bb17bc3b64bdad0ba7a371e7f4fc27460572c69a0a602202eb063d21caeb043375cdb48f89ebba3d0fd2f9feb1a9c4c
-  data.tar.gz: bcb29f420afbd849737bc859772a332df2e6d796c8f89184716ccb3be3a793035d19cd0011e577d4e902f62caf3d28ab48703de7d6ccf1b612fa726559b4cba6
+  metadata.gz: 0cae62708411610e2524f755f8e205430b9b6900745c4b24495ce58f05d8b42dd6afa95b9fa0df1968798be7348895e6eea30c059fb3018e5ac5d59012abe4f7
+  data.tar.gz: 225efcd7c7b5bfeaccbcd519c3f38e02ee6178a99b8c4765f64a566f404fe4f115445c32cf38674183ff7b5100c62967ef99e14e8b2e6fcea02a7aa14b6d3496

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iStats (0.0.4)
+    iStats (0.0.5)
       sparkr
 
 GEM

data/README.md

@@ -1,10 +1,10 @@
 iStats [![Gem Version](https://badge.fury.io/rb/iStats.svg)](http://badge.fury.io/rb/iStats)
 ======
 
-Quick attempt at writing a Ruby wrapper for a small C library that interacts with the IOKit library (apple) to get the CPU temperature and fan speed. Will expand to more hardware data and stats in the future. 
+iStats is a command-line tool that allows you to easily grap the CPU temperature, fan speeds and battery information on OS X. If you'd like to see more data available feel free to open an issue. 
 
 #### Warning
-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 are using RVM or homebrew to manage your Ruby installation you should be fine. 
+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 are using RVM or homebrew to manage your Ruby installation you should be fine.
 
 #### Tested on
 MacBook Pro 2012<br>
@@ -17,7 +17,7 @@ Ruby: 1.9.3, 2.0.0, 2.1.1<br>
 
 ## Screenshot
 #### All Stats
-![](http://i.imgur.com/pNZwCmg.png)
+![](http://i.imgur.com/f3tCnnW.png)
 
 #### Sparkline levels
 ![](http://i.imgur.com/ht2NZCL.gif)
@@ -35,6 +35,10 @@ Ruby: 1.9.3, 2.0.0, 2.1.1<br>
   istats cpu [temp | temperature]          Print CPU temperature
   istats fan                               Print all fan stats
   istats fan [speed]                       Print fan speed
+  istats battery                           Print all battery stats
+  istats battery [health]                  Print battery health
+  istats battery [cycleCount | cc]         Print battery cycle count info
+  istats battery [temp | temperature]      Print battery temperature
 
   for more help see: https://github.com/Chris911/iStats
 ```

data/ext/osx_stats/smc.c

@@ -19,6 +19,8 @@
 
 #include <stdio.h>
 #include <string.h>
+#include <ruby.h>
+#include <CoreFoundation/CoreFoundation.h>
 #include <IOKit/IOKitLib.h>
 
 #include "smc.h"
@@ -235,9 +237,9 @@ CFDictionaryRef powerSourceInfo(int Debug)
     // Should only get one source. But in practice, check for > 0 sources
     if (CFArrayGetCount(powerSourcesList))
     {
-		powerSourceInformation = IOPSGetPowerSourceDescription(powerInfo, CFArrayGetValueAtIndex(powerSourcesList, 0));
+        powerSourceInformation = IOPSGetPowerSourceDescription(powerInfo, CFArrayGetValueAtIndex(powerSourcesList, 0));
 
-		if (Debug) dumpDict (powerSourceInformation);
+        if (Debug) dumpDict (powerSourceInformation);
 
         //CFRelease(powerInfo);
         //CFRelease(powerSourcesList);
@@ -275,6 +277,9 @@ const char* getBatteryHealth() {
 
     const char *batteryHealth = CFStringGetCStringPtr(batteryHealthRef, // CFStringRef theString,
                                                 kCFStringEncodingMacRoman); //CFStringEncoding encoding);
+    if(batteryHealth == NULL)
+        return "unknown";
+
     return batteryHealth;
 }
 
@@ -299,6 +304,7 @@ void Init_osx_stats() {
     BATTERY_STATS = rb_define_module("BATTERY_STATS");
     rb_define_method(BATTERY_STATS, "get_battery_health", method_get_battery_health, 0);
     rb_define_method(BATTERY_STATS, "get_battery_design_cycle_count", method_get_battery_design_cycle_count, 0);
+    rb_define_method(BATTERY_STATS, "get_battery_temp", method_get_battery_temp, 0);
 }
 
 VALUE method_get_cpu_temp(VALUE self) {
@@ -336,6 +342,14 @@ VALUE method_get_battery_design_cycle_count(VALUE self) {
     return INT2NUM(cc);
 }
 
+VALUE method_get_battery_temp(VALUE self) {
+    SMCOpen();
+    double temp = SMCGetTemperature(SMC_KEY_BATTERY_TEMP);
+    SMCClose();
+
+    return rb_float_new(temp);
+}
+
 /* Main method used for test */
 // int main(int argc, char *argv[])
 // {

data/ext/osx_stats/smc.h

@@ -19,8 +19,6 @@
 
 #ifndef __SMC_H__
 #define __SMC_H__
-#include "ruby.h"
-#include <CoreFoundation/CoreFoundation.h>
 #endif
 
 #define VERSION               "0.01"
@@ -44,6 +42,7 @@
 #define SMC_KEY_CPU_TEMP      "TC0P"
 #define SMC_KEY_FAN_SPEED     "F%dAc"
 #define SMC_KEY_FAN_NUM       "FNum"
+#define SMC_KEY_BATTERY_TEMP  "TB0T"
 
 
 typedef struct {
@@ -108,3 +107,4 @@ VALUE method_get_fan_speed(VALUE self, VALUE num);
 VALUE method_get_fan_number(VALUE self);
 VALUE method_get_battery_health(VALUE self);
 VALUE method_get_battery_design_cycle_count(VALUE self);
+VALUE method_get_battery_temp(VALUE self);

data/iStats.gemspec

@@ -10,7 +10,7 @@ spec = Gem::Specification.new do |s|
   s.version       = IStats::VERSION
   s.authors       = ["Chris911"]
   s.email         = ["christophe.naud.dulude@gmail.com"]
-  s.description   = "Stats for your mac"
+  s.description   = %q{iStats is a command-line tool that allows you to easily grap the CPU temperature, fan speeds and battery information on OS X. If you'd like to see more data available feel free to open an issue.}
   s.summary       = "Stats for your mac"
   s.homepage      = "https://github.com/Chris911/iStats"
   s.license       = "MIT"
@@ -23,7 +23,9 @@ spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.extensions = FileList["ext/**/extconf.rb"]
 
-  s.add_dependency "sparkr"
+  s.required_ruby_version = ">= 1.9.3"
+
+  s.add_dependency "sparkr", "~> 0.4"
 
   s.add_development_dependency "bundler", "~> 1.3"
   s.add_development_dependency "rake"

data/lib/iStats.rb

@@ -9,6 +9,7 @@ require 'sparkr'
 require 'iStats/version'
 require 'iStats/color'
 require 'iStats/symbols'
+require 'iStats/printer'
 require 'iStats/command'
 require 'iStats/cpu'
 require 'iStats/fan'

data/lib/iStats/battery.rb

@@ -5,7 +5,6 @@ module IStats
   class Battery
     extend BATTERY_STATS
     class << self
-      include IStats::Color
 
       # Delegate CLI command to function
       #
@@ -13,6 +12,8 @@ module IStats
         case stat
         when 'all'
           all
+        when 'temp', 'temperature'
+          battery_temperature
         when 'health'
           battery_health
         when 'cycle_count', 'cc'
@@ -26,6 +27,7 @@ module IStats
       #
       def all
         battery_health
+        battery_temperature
         cycle_count
       end
 
@@ -39,28 +41,18 @@ module IStats
         else
           max_cycle_count = design_cycle_count
           percentage = (cycle_count.to_f/max_cycle_count.to_f)*100
-
-          list = [0, 30, 55, 80, 100, 130]
-          sparkline = Sparkr.sparkline(list) do |tick, count, index|
-            if index.between?(0, 5) and percentage > 95
-              flash_red(tick)
-            elsif index.between?(0, 1)
-              green(tick)
-            elsif index.between?(2, 3) and percentage > 45
-              light_yellow(tick)
-            elsif index == 4 and percentage > 65
-              yellow(tick)
-            elsif index == 5 and percentage > 85
-              red(tick)
-            else
-              tick
-            end
-          end
-          puts "Cycle count: #{cycle_count} " + sparkline
+          thresholds = [45, 65, 85, 95]
+          puts "Cycle count: #{cycle_count}  " + Printer.gen_sparkline(percentage, thresholds)
           puts "Max cycle count: #{max_cycle_count}"
         end
       end
 
+      # Get the battery temperature
+      #
+      def battery_temperature
+        puts "Battery temp: #{get_battery_temp.round(2)}#{Symbols.degree}C  "
+      end
+
       # Get the battery health
       # Calls a C method from BATTERY_STATS module
       #

data/lib/iStats/command.rb

@@ -89,8 +89,10 @@ module IStats
           istats cpu [temp | temperature]          Print CPU temperature
           istats fan                               Print all fan stats
           istats fan [speed]                       Print fan speed
+          istats battery                           Print all battery stats
           istats battery [health]                  Print battery health
           istats battery [cycleCount | cc]         Print battery cycle count info
+          istats battery [temp | temperature]      Print battery temperature
 
           for more help see: https://github.com/Chris911/iStats
         ".gsub(/^ {8}/, '') # strip the first eight spaces of every line

data/lib/iStats/cpu.rb

@@ -5,7 +5,6 @@ module IStats
   class Cpu
     extend CPU_STATS
     class << self
-      include IStats::Color
 
       # Delegate CLI command to function
       #
@@ -27,28 +26,11 @@ module IStats
       end
 
       # Print CPU temperature with sparkline
-      # TODO: Move sparkline function to printer class
       #
       def cpu_temperature
         t = get_cpu_temp
-        message = "CPU temp: #{t}#{Symbols.degree}C  "
-        list = [0, 30, 55, 80, 100, 130]
-        sparkline = Sparkr.sparkline(list) do |tick, count, index|
-          if index.between?(0, 5) and t > 90
-            flash_red(tick)
-          elsif index.between?(0, 1)
-            green(tick)
-          elsif index.between?(2, 3) and t > 50
-            light_yellow(tick)
-          elsif index == 4 and t > 68
-            yellow(tick)
-          elsif index == 5 and t > 80
-            red(tick)
-          else
-            tick
-          end
-        end
-        puts message + sparkline
+        thresholds = [50, 68, 80, 90]
+        puts "CPU temp: #{t}#{Symbols.degree}C  " + Printer.gen_sparkline(t, thresholds)
       end
     end
   end

data/lib/iStats/fan.rb

@@ -5,7 +5,6 @@ module IStats
   class Fan
     extend FAN_STATS
     class << self
-      include IStats::Color
 
       # Delegate CLI command to function
       #
@@ -53,30 +52,13 @@ module IStats
       end
 
       # Actually print fan speed with Sparkline
-      # TODO: Move sparkline function to printer class
       #
       # fanNum - The fan number
       # speed  - Fan speed in RPM
       #
       def print_fan_speed(fanNum, speed)
-        message = "Fan #{fanNum} speed: #{speed} RPM  "
-        list = [0, 30, 55, 80, 100, 130]
-        sparkline = Sparkr.sparkline(list) do |tick, count, index|
-          if index.between?(0, 5) and speed > 5500
-            flash_red(tick)
-          elsif index.between?(0, 1)
-            green(tick)
-          elsif index.between?(2, 3) and speed > 2500
-            light_yellow(tick)
-          elsif index == 4 and speed > 3500
-            yellow(tick)
-          elsif index == 5 and speed > 4500
-            red(tick)
-          else
-            tick
-          end
-        end
-        puts message + sparkline
+        thresholds = [2500, 3500, 4500, 5500]
+        puts "Fan #{fanNum} speed: #{speed} RPM  " + Printer.gen_sparkline(speed, thresholds)
       end
     end
   end

data/lib/iStats/printer.rb

@@ -0,0 +1,33 @@
+module IStats
+  class Printer
+    class << self
+      include IStats::Color
+
+      # Create colored sparkline
+      # value      - The stat value
+      # thresholds - must be an array of size 4 containing the threshold values
+      #              for the sparkline colors
+      #
+      def gen_sparkline(value, thresholds)
+        return if thresholds.count < 4
+
+        list = [0, 30, 55, 80, 100, 130]
+        sparkline = Sparkr.sparkline(list) do |tick, count, index|
+          if index.between?(0, 5) and value > thresholds[3]
+            flash_red(tick)
+          elsif index.between?(0, 1)
+            green(tick)
+          elsif index.between?(2, 3) and value > thresholds[0]
+            light_yellow(tick)
+          elsif index == 4 and value > thresholds[1]
+            yellow(tick)
+          elsif index == 5 and value > thresholds[2]
+            red(tick)
+          else
+            tick
+          end
+        end
+      end
+    end
+  end
+end

data/lib/iStats/symbols.rb

@@ -4,6 +4,7 @@ module IStats
 
       # Degree symbol
       # This adds support for ruby 1.9 and below
+      #
       def degree
         176.chr(Encoding::UTF_8)
       end

data/lib/iStats/version.rb

@@ -1,3 +1,3 @@
 module IStats
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: iStats
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Chris911
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sparkr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Stats for your mac
+description: iStats is a command-line tool that allows you to easily grap the CPU
+  temperature, fan speeds and battery information on OS X. If you'd like to see more
+  data available feel free to open an issue.
 email:
 - christophe.naud.dulude@gmail.com
 executables:
@@ -92,6 +94,7 @@ files:
 - lib/iStats/command.rb
 - lib/iStats/cpu.rb
 - lib/iStats/fan.rb
+- lib/iStats/printer.rb
 - lib/iStats/symbols.rb
 - lib/iStats/version.rb
 homepage: https://github.com/Chris911/iStats
@@ -107,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="