iStats 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6913998ec242b341ef22e43871298eb7243cef8
-  data.tar.gz: 7e0fd04af5cce3fabc6579cf7d63034dc71d7989
+  metadata.gz: 01ef0dfa872c16561636ee9ffd55048b59b3bba9
+  data.tar.gz: 374f759ee22e0a411c17658ff7474d8bd7b305c1
 SHA512:
-  metadata.gz: 39a0743e11c8dd9b5525f3af948d4eb1419df421583bd4a4f6afe241a019ec0c998a09cd62dc10064402c928ac9d578952ebfab9f2800acee27d74ebdf3b8b92
-  data.tar.gz: 6d7e68b9a86b0435e4d2c2d18030ce443a90dcd6f4915e4d083d714509e63dc4cedf5fd6d00be151c74f2eeec6fdf5fef51fd6e0497537e7b64f319450e5601f
+  metadata.gz: 6e50c705d65d13ea355be98fd7666b7df415fb403973ea3bc1243c07d38b347b91130f519bddad0b43bd90587a723b63976732a14734c1281b51f37cf1a61187
+  data.tar.gz: ee65277dd9c6aafb455200f912d1f5acd0c7e1dc0631b866d5413fb579c01de3a7e2ea05d121a190465db8c01de9c1a9ee447d0c9d0397c642359db4266a67e7

data/README.md

@@ -3,17 +3,16 @@ iStats [![Gem Version](https://badge.fury.io/rb/iStats.svg)](http://badge.fury.i
 
 iStats is a command-line tool that allows you to easily grab 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.
-
-#### Tested on
-MacBook Pro 2012<br>
-OS X 10.9.2<br>
-Ruby: 1.9.3, 2.0.0, 2.1.1<br>
-
 ## Installation
 
     $ 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.
+
 
 ## Screenshot
 #### All Stats
@@ -39,6 +38,8 @@ Ruby: 1.9.3, 2.0.0, 2.1.1<br>
   istats battery [health]                  Print battery health
   istats battery [cycleCount | cc]         Print battery cycle count info
   istats battery [temp | temperature]      Print battery temperature
+  istats battery [time | remain]           Print battery time remaining
+  istats battery [charge]                  Print battery charge
 
   for more help see: https://github.com/Chris911/iStats
 ```
@@ -50,3 +51,8 @@ Ruby: 1.9.3, 2.0.0, 2.1.1<br>
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+#### Tested on
+MacBook Pro 2012<br>
+OS X 10.9.2<br>
+Ruby: 1.9.3, 2.0.0, 2.1.1<br>

data/ext/osx_stats/smc.c

@@ -22,6 +22,8 @@
 #include <ruby.h>
 #include <CoreFoundation/CoreFoundation.h>
 #include <IOKit/IOKitLib.h>
+#include <IOKit/ps/IOPSKeys.h>
+#include <IOKit/ps/IOPowerSources.h>
 
 #include "smc.h"
 
@@ -283,6 +285,36 @@ const char* getBatteryHealth() {
     return batteryHealth;
 }
 
+const int hasBattery() {
+  CFDictionaryRef powerSourceInformation = powerSourceInfo(0);
+  return !(powerSourceInformation == NULL);
+}
+
+int getBatteryCharge() {
+    CFNumberRef currentCapacity;
+    CFNumberRef maximumCapacity;
+
+    int iCurrentCapacity;
+    int iMaximumCapacity;
+    int charge;
+
+    CFDictionaryRef powerSourceInformation;
+
+    powerSourceInformation = powerSourceInfo(0);
+    if (powerSourceInformation == NULL)
+        return 0;
+
+    currentCapacity = CFDictionaryGetValue(powerSourceInformation, CFSTR(kIOPSCurrentCapacityKey));
+    maximumCapacity = CFDictionaryGetValue(powerSourceInformation, CFSTR(kIOPSMaxCapacityKey));
+
+    CFNumberGetValue(currentCapacity, kCFNumberIntType, &iCurrentCapacity);
+    CFNumberGetValue(maximumCapacity, kCFNumberIntType, &iMaximumCapacity);
+
+    charge = (float)iCurrentCapacity / iMaximumCapacity * 100;
+
+    return charge;
+}
+
 /*
  RUBY MODULES
 */
@@ -302,9 +334,12 @@ void Init_osx_stats() {
     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, "has_battery?", method_has_battery, 0);
     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);
+    rb_define_method(BATTERY_STATS, "get_battery_time_remaining", method_get_battery_time_remaining, 0);
+    rb_define_method(BATTERY_STATS, "get_battery_charge", method_get_battery_charge, 0);
 }
 
 VALUE method_get_cpu_temp(VALUE self) {
@@ -332,6 +367,10 @@ VALUE method_get_fan_speed(VALUE self, VALUE num) {
     return rb_float_new(speed);
 }
 
+VALUE method_has_battery(VALUE self) {
+    return hasBattery() ? Qtrue : Qfalse;
+}
+
 VALUE method_get_battery_health(VALUE self) {
     const char* health = getBatteryHealth();
     return rb_str_new2(health);
@@ -350,6 +389,30 @@ VALUE method_get_battery_temp(VALUE self) {
     return rb_float_new(temp);
 }
 
+VALUE method_get_battery_time_remaining(VALUE self) {
+    CFTimeInterval time_remaining;
+
+    time_remaining = IOPSGetTimeRemainingEstimate();
+
+    if (time_remaining == kIOPSTimeRemainingUnknown) {
+        return rb_str_new2("Calculating");
+    } else if (time_remaining == kIOPSTimeRemainingUnlimited) {
+        return rb_str_new2("Unlimited");
+    } else {
+        return INT2NUM(time_remaining);
+    }
+}
+
+VALUE method_get_battery_charge(VALUE self) {
+    int charge = getBatteryCharge();
+
+    if (charge == 0) {
+        return Qnil;
+    } else {
+        return INT2NUM(charge);
+    }
+}
+
 /* Main method used for test */
 // int main(int argc, char *argv[])
 // {

data/ext/osx_stats/smc.h

@@ -70,24 +70,24 @@ typedef struct {
 typedef char              SMCBytes_t[32];
 
 typedef struct {
-  UInt32                  key;
-  SMCKeyData_vers_t       vers;
-  SMCKeyData_pLimitData_t pLimitData;
-  SMCKeyData_keyInfo_t    keyInfo;
-  char                    result;
-  char                    status;
-  char                    data8;
-  UInt32                  data32;
-  SMCBytes_t              bytes;
+    UInt32                  key;
+    SMCKeyData_vers_t       vers;
+    SMCKeyData_pLimitData_t pLimitData;
+    SMCKeyData_keyInfo_t    keyInfo;
+    char                    result;
+    char                    status;
+    char                    data8;
+    UInt32                  data32;
+    SMCBytes_t              bytes;
 } SMCKeyData_t;
 
 typedef char              UInt32Char_t[5];
 
 typedef struct {
-  UInt32Char_t            key;
-  UInt32                  dataSize;
-  UInt32Char_t            dataType;
-  SMCBytes_t              bytes;
+    UInt32Char_t            key;
+    UInt32                  dataSize;
+    UInt32Char_t            dataType;
+    SMCBytes_t              bytes;
 } SMCVal_t;
 
 // prototypes
@@ -96,6 +96,7 @@ int SMCGetFanNumber(char *key);
 double SMCGetTemperature(char *key);
 const char* getBatteryHealth();
 int getDesignCycleCount();
+int getBatteryCharge();
 CFTypeRef IOPSCopyPowerSourcesInfo(void);
 CFArrayRef IOPSCopyPowerSourcesList(CFTypeRef blob);
 CFDictionaryRef IOPSGetPowerSourceDescription(CFTypeRef blob, CFTypeRef ps);
@@ -105,6 +106,9 @@ 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_has_battery(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);
+VALUE method_get_battery_time_remaining(VALUE self);
+VALUE method_get_battery_charge(VALUE self);

data/lib/iStats/battery.rb

@@ -9,6 +9,9 @@ module IStats
       # Delegate CLI command to function
       #
       def delegate(stat)
+        # Before we deletage check if there's a battery on system
+        return unless validate_battery
+
         case stat
         when 'all'
           all
@@ -18,6 +21,10 @@ module IStats
           battery_health
         when 'cycle_count', 'cc'
           cycle_count
+        when 'time', 'remain'
+          battery_time_remaining
+        when 'charge'
+          battery_charge
         else
           Command.help "Unknown stat for Battery: #{stat}"
         end
@@ -26,6 +33,8 @@ module IStats
       # Call all functions (stats)
       #
       def all
+        return unless validate_battery
+
         battery_health
         battery_temperature
         cycle_count
@@ -60,12 +69,39 @@ module IStats
         puts "Battery health: #{get_battery_health}"
       end
 
+      def battery_time_remaining
+        time = get_battery_time_remaining
+
+        if time.is_a? Integer
+          hours   = time / 3600
+          minutes = time / 60 - hours * 60
+
+          time = "%i:%02i" % [hours, minutes]
+        end
+
+        puts "Battery time remaining: #{time}"
+      end
+
+      def battery_charge
+        charge = get_battery_charge
+        result = charge ? "#{charge}%" : "Unknown"
+        puts "Battery charge: #{result}"
+      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
+
+      # Check if there's a battery on the system
+      #
+      def validate_battery
+        valid = has_battery?
+        puts 'No battery on system' unless valid
+        valid
+      end
     end
   end
 end

data/lib/iStats/command.rb

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

data/lib/iStats/version.rb

@@ -1,3 +1,3 @@
 module IStats
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iStats
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Chris911
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sparkr