iStats 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bff6f43ceaf154fc22a175a84ab82d3f1230346
-  data.tar.gz: bcd0dbe5bdbf052142511505b98d8f600d0c1703
+  metadata.gz: e4b51e404e967587290c2dffb093f7703ab1440f
+  data.tar.gz: d4c35add73857760cbcd18a1f3bd6c23f53f3373
 SHA512:
-  metadata.gz: a640c65868a3f78e2f7fb2f9221ccb1de7f7f013e8c81ba5f83fb19d208468c5b1377648a1430323e1d36528ed31100d10bc12841b01e698277665b4d1947ab0
-  data.tar.gz: 6d640b55b90680bdf895d685eff2b1ce2b17d3b3fc9e1d438f2dd980e10eade76cfcf87fe0eaf9fd4cb8b2ddcab7e8eae464c665ab2675daf2c8c52a5b7622cb
+  metadata.gz: 7d2a747930f420134915c961db00568d8bb17bc3b64bdad0ba7a371e7f4fc27460572c69a0a602202eb063d21caeb043375cdb48f89ebba3d0fd2f9feb1a9c4c
+  data.tar.gz: bcb29f420afbd849737bc859772a332df2e6d796c8f89184716ccb3be3a793035d19cd0011e577d4e902f62caf3d28ab48703de7d6ccf1b612fa726559b4cba6

data/Gemfile.lock

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

data/README.md

@@ -1,33 +1,42 @@
-iStats
+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. Will expand to more hardware data and stats in the future. 
+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. 
+
+#### 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. 
 
 #### Tested on
 MacBook Pro 2012<br>
 OS X 10.9.2<br>
 Ruby: 1.9.3, 2.0.0, 2.1.1<br>
 
-## Screenshot
-![](http://i.imgur.com/ht2NZCL.gif)
-
 ## Installation
 
     $ gem install iStats
 
+## Screenshot
+#### All Stats
+![](http://i.imgur.com/pNZwCmg.png)
+
+#### Sparkline levels
+![](http://i.imgur.com/ht2NZCL.gif)
+
 ## Usage
 
 ```
-     - iStats: help ---------------------------------------------------
+  - iStats: help ---------------------------------------------------
 
-     istats --help                            This help text
-     istats --version                         Print current version
+  istats --help                            This help text
+  istats --version                         Print current version
 
-     istats all                               Print all stats
-     istats cpu                               Print all CPU stats
-     istats cpu [temp | temperature]          Print CPU temperature
+  istats all                               Print all stats
+  istats cpu                               Print all CPU stats
+  istats cpu [temp | temperature]          Print CPU temperature
+  istats fan                               Print all fan stats
+  istats fan [speed]                       Print fan speed
 
-     for more help see: https://github.com/Chris911/iStats
+  for more help see: https://github.com/Chris911/iStats
 ```
 
 ## Contributing

data/ext/osx_stats/extconf.rb

@@ -2,7 +2,7 @@ require 'mkmf'
 
 extension_name = 'osx_stats'
 
-CONFIG['LDSHARED'] << ' -framework IOKit '
+CONFIG['LDSHARED'] << ' -framework IOKit -framework CoreFoundation '
 
 # The destination
 dir_config(extension_name)

data/ext/osx_stats/smc.c

@@ -205,53 +205,152 @@ int SMCGetFanNumber(char *key)
     return _strtoul((char *)val.bytes, val.dataSize, 10);
 }
 
-// int main(int argc, char *argv[])
-// {
-//     SMCOpen();
-//     //printf("%0.1f°C\n", SMCGetTemperature(SMC_KEY_CPU_TEMP));
-//     //printf("%0.1f\n", SMCGetFanSpeed(0));
-//     //printf("%0.1f\n", SMCGetFanSpeed(3));
-//     //printf("%i\n", SMCGetFanNumber(SMC_KEY_FAN_NUM));
-//     SMCClose();
-//
-//     return 0;
-// }
+/* Battery info
+ * Ref: http://www.newosxbook.com/src.jl?tree=listings&file=bat.c
+ *      https://developer.apple.com/library/mac/documentation/IOKit/Reference/IOPowerSources_header_reference/Reference/reference.html
+ */
+void dumpDict (CFDictionaryRef Dict)
+{
+    // Helper function to just dump a CFDictioary as XML
+    CFDataRef xml = CFPropertyListCreateXMLData(kCFAllocatorDefault, (CFPropertyListRef)Dict);
+    if (xml) { write(1, CFDataGetBytePtr(xml), CFDataGetLength(xml)); CFRelease(xml); }
+}
 
-//
-// RUBY MODULE
-//
+CFDictionaryRef powerSourceInfo(int Debug)
+{
+    CFTypeRef       powerInfo;
+    CFArrayRef      powerSourcesList;
+    CFDictionaryRef powerSourceInformation;
+
+    powerInfo = IOPSCopyPowerSourcesInfo();
+
+    if(! powerInfo) return NULL;
+
+    powerSourcesList = IOPSCopyPowerSourcesList(powerInfo);
+    if(!powerSourcesList) {
+        CFRelease(powerInfo);
+        return NULL;
+    }
+
+    // Should only get one source. But in practice, check for > 0 sources
+    if (CFArrayGetCount(powerSourcesList))
+    {
+		powerSourceInformation = IOPSGetPowerSourceDescription(powerInfo, CFArrayGetValueAtIndex(powerSourcesList, 0));
+
+		if (Debug) dumpDict (powerSourceInformation);
+
+        //CFRelease(powerInfo);
+        //CFRelease(powerSourcesList);
+        return powerSourceInformation;
+    }
+
+    CFRelease(powerInfo);
+    CFRelease(powerSourcesList);
+    return NULL;
+}
+
+int getDesignCycleCount() {
+    CFDictionaryRef powerSourceInformation = powerSourceInfo(0);
+
+    if(powerSourceInformation == NULL)
+        return 0;
+
+    CFNumberRef designCycleCountRef = (CFNumberRef)  CFDictionaryGetValue(powerSourceInformation, CFSTR("DesignCycleCount"));
+    uint32_t    designCycleCount;
+    if ( ! CFNumberGetValue(designCycleCountRef,  // CFNumberRef number,
+                            kCFNumberSInt32Type,  // CFNumberType theType,
+                            &designCycleCount))   // void *valuePtr);
+        return 0;
+    else
+        return designCycleCount;
+}
+
+const char* getBatteryHealth() {
+    CFDictionaryRef powerSourceInformation = powerSourceInfo(0);
+
+    if(powerSourceInformation == NULL)
+        return "Unknown";
+
+    CFStringRef batteryHealthRef = (CFStringRef) CFDictionaryGetValue(powerSourceInformation, CFSTR("BatteryHealth"));
+
+    const char *batteryHealth = CFStringGetCStringPtr(batteryHealthRef, // CFStringRef theString,
+                                                kCFStringEncodingMacRoman); //CFStringEncoding encoding);
+    return batteryHealth;
+}
+
+/*
+ RUBY MODULES
+*/
 VALUE CPU_STATS = Qnil;
 VALUE FAN_STATS = Qnil;
+VALUE BATTERY_STATS = Qnil;
+/*
+ * Define Ruby modules and associated methods
+ * We never call this, Ruby does.
+*/
 void Init_osx_stats() {
-	CPU_STATS = rb_define_module("CPU_STATS");
-	rb_define_method(CPU_STATS, "get_cpu_temp", method_get_cpu_temp, 0);
+    CPU_STATS = rb_define_module("CPU_STATS");
+    rb_define_method(CPU_STATS, "get_cpu_temp", method_get_cpu_temp, 0);
+
+    FAN_STATS = rb_define_module("FAN_STATS");
+    rb_define_method(FAN_STATS, "get_fan_number", method_get_fan_number, 0);
+    rb_define_method(FAN_STATS, "get_fan_speed", method_get_fan_speed, 1);
 
-  FAN_STATS = rb_define_module("FAN_STATS");
-  rb_define_method(FAN_STATS, "get_fan_number", method_get_fan_number, 0);
-  rb_define_method(FAN_STATS, "get_fan_speed", method_get_fan_speed, 1);
+    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);
 }
 
 VALUE method_get_cpu_temp(VALUE self) {
-  SMCOpen();
-	double temp = SMCGetTemperature(SMC_KEY_CPU_TEMP);
-  SMCClose();
+    SMCOpen();
+    double temp = SMCGetTemperature(SMC_KEY_CPU_TEMP);
+    SMCClose();
 
-  return rb_float_new(temp);
+    return rb_float_new(temp);
 }
 
 VALUE method_get_fan_number(VALUE self) {
-  SMCOpen();
-  int num = SMCGetFanNumber(SMC_KEY_FAN_NUM);
-  SMCClose();
+    SMCOpen();
+    int num = SMCGetFanNumber(SMC_KEY_FAN_NUM);
+    SMCClose();
 
-  return INT2NUM(num);
+    return INT2NUM(num);
 }
 
 VALUE method_get_fan_speed(VALUE self, VALUE num) {
-  uint fanNum = NUM2UINT(num);
-  SMCOpen();
-  float speed = SMCGetFanSpeed(fanNum);
-  SMCClose();
+    uint fanNum = NUM2UINT(num);
+    SMCOpen();
+    float speed = SMCGetFanSpeed(fanNum);
+    SMCClose();
 
-  return rb_float_new(speed);
+    return rb_float_new(speed);
 }
+
+VALUE method_get_battery_health(VALUE self) {
+    const char* health = getBatteryHealth();
+    return rb_str_new2(health);
+}
+
+VALUE method_get_battery_design_cycle_count(VALUE self) {
+    int cc = getDesignCycleCount();
+    return INT2NUM(cc);
+}
+
+/* Main method used for test */
+// int main(int argc, char *argv[])
+// {
+//     //SMCOpen();
+//     //printf("%0.1f°C\n", SMCGetTemperature(SMC_KEY_CPU_TEMP));
+//     //printf("%0.1f\n", SMCGetFanSpeed(0));
+//     //printf("%0.1f\n", SMCGetFanSpeed(3));
+//     //printf("%i\n", SMCGetFanNumber(SMC_KEY_FAN_NUM));
+//     //SMCClose();
+//
+//     int designCycleCount = getDesignCycleCount();
+//     const char* batteryHealth = getBatteryHealth();
+//
+//   	if (designCycleCount) printf ("%i\n", designCycleCount);
+//     if (batteryHealth) printf ("%s\n", batteryHealth);
+//
+//     return 0;
+// }

data/ext/osx_stats/smc.h

@@ -20,6 +20,7 @@
 #ifndef __SMC_H__
 #define __SMC_H__
 #include "ruby.h"
+#include <CoreFoundation/CoreFoundation.h>
 #endif
 
 #define VERSION               "0.01"
@@ -90,14 +91,20 @@ typedef struct {
   SMCBytes_t              bytes;
 } SMCVal_t;
 
-
 // prototypes
 float SMCGetFanSpeed(int fanNum);
 int SMCGetFanNumber(char *key);
 double SMCGetTemperature(char *key);
+const char* getBatteryHealth();
+int getDesignCycleCount();
+CFTypeRef IOPSCopyPowerSourcesInfo(void);
+CFArrayRef IOPSCopyPowerSourcesList(CFTypeRef blob);
+CFDictionaryRef IOPSGetPowerSourceDescription(CFTypeRef blob, CFTypeRef ps);
 
 // Ruby modules
 void Init_osx_stats();
 VALUE method_get_cpu_temp(VALUE self);
 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);

data/lib/iStats.rb

@@ -12,6 +12,7 @@ require 'iStats/symbols'
 require 'iStats/command'
 require 'iStats/cpu'
 require 'iStats/fan'
+require 'iStats/battery'
 
 module IStats
   def self.options

data/lib/iStats/battery.rb

@@ -0,0 +1,79 @@
+# Fan Stats
+# Extend BATTERY_STATS C module (ext/osx_stats/smc.c)
+#
+module IStats
+  class Battery
+    extend BATTERY_STATS
+    class << self
+      include IStats::Color
+
+      # Delegate CLI command to function
+      #
+      def delegate(stat)
+        case stat
+        when 'all'
+          all
+        when 'health'
+          battery_health
+        when 'cycle_count', 'cc'
+          cycle_count
+        else
+          Command.help "Unknown stat for Battery: #{stat}"
+        end
+      end
+
+      # Call all functions (stats)
+      #
+      def all
+        battery_health
+        cycle_count
+      end
+
+      # Prints the battery cycle count info
+      #
+      def cycle_count
+        data = %x( ioreg -l | grep Capacity )
+        cycle_count = data[/"Cycle Count"=([0-9]*)/, 1]
+        if cycle_count == nil
+          puts "Cycle count: unknown"
+        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
+          puts "Max cycle count: #{max_cycle_count}"
+        end
+      end
+
+      # Get the battery health
+      # Calls a C method from BATTERY_STATS module
+      #
+      def battery_health
+        puts "Battery health: #{get_battery_health}"
+      end
+
+      # Get the battery design cycle count
+      # Calls a C method from BATTERY_STATS module
+      #
+      def design_cycle_count
+        get_battery_design_cycle_count
+      end
+    end
+  end
+end

data/lib/iStats/command.rb

@@ -4,6 +4,10 @@ module IStats
     class << self
       include IStats::Color
 
+      # Executes a command
+      #
+      # args - Command line arguments
+      #
       def execute(*args)
         # Default command is 'all'
         category = args.empty? ? 'all' : args.shift
@@ -13,6 +17,11 @@ module IStats
         delegate(category, stat)
       end
 
+      # Delegate command to proper class
+      #
+      # category - Hardware we are targeting (CPU, fan, etc.)
+      # stat     - The stat we want
+      #
       def delegate(category, stat)
         case category
         when 'all'
@@ -21,17 +30,22 @@ module IStats
           Cpu.delegate stat
         when 'fan'
           Fan.delegate stat
+        when 'battery'
+          Battery.delegate stat
         else
           help("Unknown category: #{category}")
         end
       end
 
+      # Execute all the stats methodes for all modules
+      #
       def all
-        # Exec all
         puts "--- CPU Stats ---\n"
         Cpu.all
         puts "\n--- Fan Stats ---\n"
         Fan.all
+        puts "\n--- Battery Stats ---\n"
+        Battery.all
       end
 
       # Public: Parse extra options
@@ -75,6 +89,8 @@ module IStats
           istats cpu [temp | temperature]          Print CPU temperature
           istats fan                               Print all fan stats
           istats fan [speed]                       Print fan speed
+          istats battery [health]                  Print battery health
+          istats battery [cycleCount | cc]         Print battery cycle count info
 
           for more help see: https://github.com/Chris911/iStats
         ".gsub(/^ {8}/, '') # strip the first eight spaces of every line

data/lib/iStats/cpu.rb

@@ -1,11 +1,14 @@
+# CPU Stats
+# Extend CPU_STATS C module (ext/osx_stats/smc.c)
+#
 module IStats
-  # CPU Stats
-  # Extend CPU_STATS C module (ext/osx_stats/smc.c)
   class Cpu
     extend CPU_STATS
     class << self
       include IStats::Color
 
+      # Delegate CLI command to function
+      #
       def delegate(stat)
         case stat
         when 'all'
@@ -17,10 +20,15 @@ module IStats
         end
       end
 
+      # Call all functions (stats)
+      #
       def all
         cpu_temperature
       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  "

data/lib/iStats/fan.rb

@@ -1,11 +1,14 @@
+# Fan Stats
+# Extend FAN_STATS C module (ext/osx_stats/smc.c)
+#
 module IStats
-  # Fan Stats
-  # Extend FAN_STATS C module (ext/osx_stats/smc.c)
   class Fan
     extend FAN_STATS
     class << self
       include IStats::Color
 
+      # Delegate CLI command to function
+      #
       def delegate(stat)
         case stat
         when 'all'
@@ -19,20 +22,28 @@ module IStats
         end
       end
 
+      # Call all functions (stats)
+      #
       def all
         print_fan_number
         fans_speed
       end
 
+      # Get the number of fans on system
+      # Calls a C method from FAN_STATS module
+      #
       def fan_number
-        # C method
         get_fan_number
       end
 
+      # Print number of fan(s)
+      #
       def print_fan_number
-        puts "Total fans on system: #{fan_number}"
+        puts "Total fans in system: #{fan_number}"
       end
 
+      # Get and print the speed of each fan
+      #
       def fans_speed
         fanNum = fan_number
         (0..(fanNum-1)).each do |n|
@@ -41,6 +52,12 @@ module IStats
         end
       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]

data/lib/iStats/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iStats
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Chris911
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sparkr
@@ -87,6 +87,7 @@ files:
 - ext/osx_stats/smc.h
 - iStats.gemspec
 - lib/iStats.rb
+- lib/iStats/battery.rb
 - lib/iStats/color.rb
 - lib/iStats/command.rb
 - lib/iStats/cpu.rb