icharger-log 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83fe244f4cffe07bc9221289d2410bcee33e0431
-  data.tar.gz: bb590fbbf8ae4d5b5dda4ce03ee2ff8967e45ae9
+  metadata.gz: b999dcb75233cefd928ba79642df2d27978d49e5
+  data.tar.gz: 4b9873a57bc5a3974857171ab25431e8cc437b6d
 SHA512:
-  metadata.gz: 24ba7de017d7b1fd4f884229b65d3b9ce61f016d2e92e885236c855aa58dc4a2bfc7eca1919c3464ee11c8f58a6a490a5e890656f6226e001b7a44a6ce2f2aa6
-  data.tar.gz: bd09bee625fa854cf8c8c613885b9af1baadc007e3144b08d99ffc9948d8c8e937c5bdd1f6f8266f0a8570ab9e47b79a29d133fb71e80319faa95ce9d4b3ed07
+  metadata.gz: 3877f364dad88f3f9ebda8fa9c3a3607d9949d7f808bf71a653ebd020764cb52ca4f94d21f6be3788a62196372fd9b99bf4364d40d8aa16bc18757ca1660d7d5
+  data.tar.gz: 95ca4c863e2f70ab4cb61dd996d7d8dab2378e21cd651a1c00c9993c8613c9a09033cac8b5759869df34ba2f4e3d5b5acbd57e04b24458d4f502d5b98a3f67c0

data/lib/icharger/log/file.rb

@@ -24,10 +24,16 @@ module ICharger
         raise ArgumentError, "File does not appear to be an iCharger log (#{e})"
       end
 
+      # Gets the charger channel number.
+      #
+      # @return [Number] charger channel number
       def channel
         @rows.first.channel
       end
 
+      # Gets the duration of the log, in seconds.
+      #
+      # @return [Float] duration of the log, in seconds
       def duration
         @rows.last.time / 10000.0
       end

data/lib/icharger/log/row.rb

@@ -8,16 +8,22 @@ module ICharger
         throw ArgumentError, "Unexpected field count (#{@fields.length})" unless @fields.length == 22
       end
 
+      # Gets the charger channel number.
+      #
+      # @return [Number] charger channel number
       def channel
         /(?<ch>\d)/.match(@fields[0])[:ch].to_i
       end
 
-      # this is a guess...
+      # Gets the current state of operation.
+      #
+      # @return :charging, :discharging, :unknown
+      # @note This is a guess...
       def state
         {
-          1 => 'charging',
-          2 => 'discharging'
-        }.fetch(@fields[1].to_i, 'unknown')
+          1 => :charging,
+          2 => :discharging
+        }.fetch(@fields[1].to_i, :unknown)
       end
 
       # Gets the time in milliseconds.
@@ -37,35 +43,35 @@ module ICharger
         @fields[4].to_i
       end
 
-      # Instantaneous charge (+) or discharge (-) current, in amps.
+      # Gets the instantaneous charge (+) or discharge (-) current, in amps.
       #
       # @return [Float] instantaneous current (A)
       def current
         @fields[5].to_i / 100.0
       end
 
-      # Input power supply voltage, in volts.
+      # Gets the input power supply voltage, in volts.
       #
       # @return [Float] input power supply (V)
       def input_voltage
         @fields[6].to_i / 1000.0
       end
 
-      # Total battery pack voltage, in volts.
+      # Gets the total battery pack voltage, in volts.
       #
       # @return [Float] battery pack voltage (V)
       def pack_voltage
         @fields[7].to_i / 1000.0
       end
 
-      # Capacity stored or removed so far, in amp-hours.
+      # Gets the capacity stored or removed so far, in amp-hours.
       #
       # @return [Float] amp-hours stored (+) or removed (-)
       def capacity
         @fields[8].to_i / 100.0
       end
 
-      # Internal temperature sensor value, in celsius or fahrenheit.
+      # Gets the internal temperature sensor value, in celsius or fahrenheit.
       #
       # @param unit :c or :f for celsius or fahrenheit
       # @return [Float] temperature in requested unit
@@ -73,7 +79,7 @@ module ICharger
         convert_temperature((@fields[9].to_i / 10.0), unit)
       end
 
-      # External temperature sensor value, in celsius or fahrenheit.
+      # Gets the external temperature sensor value, in celsius or fahrenheit.
       #
       # @param unit :c or :f for celsius or fahrenheit
       # @return [Float] temperature in requested unit
@@ -81,15 +87,19 @@ module ICharger
         convert_temperature((@fields[10].to_i / 10.0), unit)
       end
 
-      # Individual cell voltage, in volts.
+      # Gets the individual cell voltage, in volts.
       #
       # @param index index of the cell (0-based)
-      # @return [Float] input power supply (V)
+      # @return [Float] specified cell voltage (V)
       # @see #cell_count
       def cell_voltage(index)
         @fields[11 + index].to_i / 1000.0
       end
 
+      # Gets the number of individual cells measured.
+      #
+      # @return [Number] number of individual cells
+      # @see #cell_voltage
       def cell_count
         @fields[11..20].reject{ |v| v.to_i == 0 }.length
       end

data/lib/icharger/log/version.rb

@@ -1,5 +1,5 @@
 module ICharger
   module Log
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/row_spec.rb

@@ -10,7 +10,7 @@ describe ICharger::Log::Row do
 
     its(:channel) { should eql(1) }
 
-    its(:state) { should eql('charging') }
+    its(:state) { should eql(:charging) }
 
     its(:current) { should be_within(0.01).of(-0.53) }
 
@@ -44,7 +44,7 @@ describe ICharger::Log::Row do
 
     its(:channel) { should eql(2) }
 
-    its(:state) { should eql('charging') }
+    its(:state) { should eql(:charging) }
 
     its(:current) { should be_within(0.01).of(0.41) }
 
@@ -78,7 +78,7 @@ describe ICharger::Log::Row do
 
     its(:channel) { should eql(1) }
 
-    its(:state) { should eql('discharging') }
+    its(:state) { should eql(:discharging) }
 
     its(:current) { should be_within(0.1).of(3.97) }
 
@@ -116,7 +116,7 @@ describe ICharger::Log::Row do
 
     its(:channel) { should eql(2) }
 
-    its(:state) { should eql('charging') }
+    its(:state) { should eql(:charging) }
 
     its(:time) { should eql(87000) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: icharger-log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Veys