battman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fa62d0122ed26fd4632d0052367a1cd815b3d87
+  data.tar.gz: fb5d61ca34fc8d864e2536c4cfcf340c8399777c
+SHA512:
+  metadata.gz: ae56456c53bbcd44cd51539bbcce3cf1d8b3171ab1300c07b502c4ab58cf3d382a455f8e84c957db582201632d33e313a536248cc42ffe87253b6206fc0f7218
+  data.tar.gz: 48bc96909040afcc6b246d7265abecdc2e4c80a80ac32798c68b4457ffcb1795d9c7ecee188bb20a5c5227aea4531a4e59868b9d06474a4adb4c7e16dae51d1b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+battman*.gem
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in battman.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,17 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joakim Reinert
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Battman
+
+Battman allows specifying actions to perform depending on the value of some battery attributes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'battman'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install battman
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/battman/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/battman.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'battman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "battman"
+  spec.version       = Battman::VERSION
+  spec.authors       = ["Joakim Reinert"]
+  spec.email         = ["mail@jreinert.com"]
+  spec.summary       = %q{A simple dsl for polling battery info}
+  spec.description   = %q{Battman allows specifying actions to perform depending on the value of some battery attribute}
+  spec.homepage      = "https://github.com/jreinert/battman"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency "activesupport"
+end

data/battman_example.rb

@@ -0,0 +1,57 @@
+require 'battman'
+
+Battman::Battman.new do |battman|
+
+  battman.watch :acpi do |watcher|
+
+    current_state = :discharging # to be on the safe side
+
+    watcher.every 2.seconds do |status|
+
+      status.check(:state) do |value, last_value|
+        current_state = value
+        state_changed = value != last_value
+
+        if state_changed
+          `notify-send 'Battery is #{current_state}'`
+        end
+      end
+
+    end
+
+    watcher.every 60.seconds do |status|
+
+      suspend = false
+
+      status.check(:remaining_percent) do |value|
+
+        if current_state == :discharging && value.in?(0...5)
+          `i3lock && systemctl suspend` if suspend
+          `notify-send -u critical 'Battery is critical'`
+
+          if value.in?(0..2)
+            `notify-send -u critical 'Suspending in 60 seconds! (plug in cable to abort)'`
+            suspend = true
+          end
+        else
+          supend = false
+        end
+
+      end
+
+    end
+
+    watcher.every 5.minutes do |status|
+
+      status.check(:remaining_percent) do |value|
+        if current_state == :discharging && value.in?(5...10)
+          `notify-send -u normal 'Battery is low'`
+        end
+      end
+
+    end
+
+  end
+
+  battman.run
+end

data/lib/battman/acpi_battery.rb

@@ -0,0 +1,64 @@
+require 'battman/battery'
+
+module Battman
+  class AcpiBattery < Battery
+
+    def initialize(index = 0, **opts)
+      super(index)
+
+      @precision = opts[:precision] || 1000
+    end
+
+    def path
+      @path ||= "/sys/class/power_supply/BAT#{@index}"
+    end
+
+    def remaining_percent
+      energy_full_file = File.join(path, 'energy_full')
+      energy_now_file = File.join(path, 'energy_now')
+
+      energy_full = File.read(energy_full_file)
+      energy_now = File.read(energy_now_file)
+
+      (energy_now.to_f / energy_full.to_f) * 100
+    end
+
+    def power
+      power_now_file = File.join(path, 'power_now')
+
+      power = File.read(power_now_file).to_f / (1000 * @precision)
+
+      state == :discharging ? -1 * power : power
+    end
+
+    def state
+      state_file = File.join(path, 'status')
+
+      state = File.read(state_file).chomp.downcase.to_sym
+
+      state == :unknown ? :idle : state
+    end
+
+    def remaining_energy
+      energy_file = File.join(path, 'energy_now')
+
+      File.read(energy_file).to_f / (1000 * @precision)
+    end
+
+    def remaining_running_time
+      raise WrongStateError if state != :discharging
+      (remaining_energy / power) * 60
+    end
+
+    def full_energy
+      energy_file = File.join(path, 'energy_full')
+
+      File.read(energy_file).to_f / (1000 * @precision)
+    end
+
+    def remaining_charging_time
+      raise WrongStateError if state != :charging
+      ((full_energy - remaining_energy) / power) * 60
+    end
+  end
+end

data/lib/battman/battery.rb

@@ -0,0 +1,101 @@
+require 'battman/errors'
+require 'active_support/core_ext/object/inclusion'
+require 'active_support/core_ext/numeric/time'
+
+module Battman
+  class Battery
+
+    CONVERSIONS = {
+      power: {
+        watts: lambda {|value| value},
+        milliwatts: lambda {|value| value * 1000}
+      },
+      time: {
+        seconds: lambda {|value| value},
+        minutes: lambda {|value| value.to_f / 1.minute},
+        hours: lambda {|value| value.to_f / 1.hour}
+      },
+      energy: {
+        watt_hours: lambda {|value| value},
+        milliwatt_hours: lambda {|value| value * 1000}
+      }
+    }
+
+    def initialize(battery_index = 0, **opts)
+      if self.class == Battery
+        raise AbstractError.new('cannot instantiate Battery')
+      end
+
+      @index = battery_index
+    end
+
+    def state
+      raise NotImplementedError.new
+    end
+
+    def remaining_percent
+      raise NotImplementedError.new
+    end
+
+    def power
+      raise NotImplementedError.new
+    end
+
+    def power_in(unit)
+      unless unit.in?(CONVERSIONS[:power].keys)
+        raise UnsupportedUnitError.new(unit)
+      end
+
+      CONVERSIONS[:power][unit].call(power)
+    end
+
+    def remaining_running_time
+      raise NotImplementedError.new
+    end
+
+    def remaining_running_time_in(unit)
+      unless unit.in?(CONVERSIONS[:time].keys)
+        raise UnsupportedUnitError.new(unit)
+      end
+
+      CONVERSIONS[:time][unit].call(remaining_running_time)
+    end
+
+    def remaining_charging_time
+      raise NotImplementedError.new
+    end
+
+    def remaining_charging_time_in(unit)
+      unless unit.in?(CONVERSIONS[:time].keys)
+        raise UnsupportedUnitError.new(unit)
+      end
+
+      CONVERSIONS[:time][unit].call(remaining_charging_time)
+    end
+
+    def remaining_energy
+      raise NotImplementedError.new
+    end
+
+    def remaining_energy_in(unit)
+      unless unit.in?(CONVERSIONS[:energy].keys)
+        raise UnsupportedUnitError.new(unit)
+      end
+
+      CONVERSIONS[:energy][unit].call(remaining_energy)
+    end
+
+    def full_energy
+      raise NotImplementedError.new
+    end
+
+    def full_energy_in(unit)
+      unless unit.in?(CONVERSIONS[:energy].keys)
+        raise UnsupportedUnitError.new(unit)
+      end
+
+      CONVERSIONS[:energy][unit].call(full_energy)
+    end
+
+  end
+end

data/lib/battman/dsl/every_block.rb

@@ -0,0 +1,31 @@
+module Battman
+  module DSL
+    class EveryBlock
+
+      def initialize(battman, battery, interval)
+        @battery = battery
+        @interval = interval
+        @battman = battman
+        @last_values = {}
+      end
+
+      def check(attribute, *args, &block)
+        raise ArgumentError.new('no block given') unless block_given?
+
+        unless @battery.respond_to?(attribute)
+          raise ArgumentError.new("invalid method #{attribute}")
+        end
+
+        last_values_hash = (attribute.hash + args.hash).hash
+
+        task = Proc.new do
+          value = @battery.send(attribute, *args)
+          block.call(value, @last_values[last_values_hash])
+          @last_values[last_values_hash] = value
+        end
+
+        @battman.register(@interval, task)
+      end
+    end
+  end
+end

data/lib/battman/dsl/watch_block.rb

@@ -0,0 +1,20 @@
+require 'battman/dsl/every_block'
+
+module Battman
+  module DSL
+    class WatchBlock
+
+      def initialize(battman, battery)
+        @battman = battman
+        @battery = battery
+      end
+
+      def every(interval)
+        raise ArgumentError.new('no block given') unless block_given?
+
+        yield EveryBlock.new(@battman, @battery, interval)
+      end
+
+    end
+  end
+end

data/lib/battman/dsl.rb

@@ -0,0 +1,48 @@
+require 'active_support/core_ext/string/inflections'
+require 'battman/dsl/watch_block'
+
+module Battman
+  module DSL
+    Thread.abort_on_exception = true
+
+    def initialize
+      @blocks = Hash.new {|hash, key| hash[key] = []}
+      @intervals_due = Hash.new {|hash, key| hash[key] = 0}
+
+      yield self if block_given?
+    end
+
+    def register(interval, block)
+      @blocks[interval.to_i] << block
+      @greatest_common_interval = @blocks.keys.inject(&:gcd)
+    end
+
+    def watch(type, index = 0, **opts)
+      raise ArgumentError.new('no block given') unless block_given?
+
+      require "battman/#{type}_battery"
+      battery_class = ("Battman::" + "#{type}_battery".camelize).constantize
+
+      yield WatchBlock.new(self, battery_class.new(index, **opts))
+    end
+
+    def run_once
+      @blocks.each do |interval, blocks|
+        if @intervals_due[interval] <= @greatest_common_interval
+          blocks.map(&:call)
+          @intervals_due[interval] = interval
+        else
+          @intervals_due[interval] -= @greatest_common_interval
+        end
+      end
+    end
+
+    def run
+      loop do
+        run_once
+        sleep @greatest_common_interval
+      end
+    end
+
+  end
+end

data/lib/battman/errors.rb

@@ -0,0 +1,12 @@
+module Battman
+  class AbstractError < RuntimeError; end
+  class NotImplementedError < RuntimeError; end
+  class WrongStateError < RuntimeError; end
+
+  class UnsupportedUnitError < ArgumentError
+    def initialize(unit)
+      super("unit #{unit} is not supported")
+    end
+  end
+
+end

data/lib/battman/smapi_battery.rb

@@ -0,0 +1,59 @@
+require 'battman/battery'
+
+module Battman
+  class SmapiBattery < Battery
+
+    def path
+      @path ||= "/sys/devices/platform/smapi/BAT#{@index}"
+    end
+
+    def remaining_percent
+      percent_file = File.join(path, 'remaining_percent')
+
+      File.read(percent_file).to_i
+    end
+
+    def remaining_running_time
+      running_time_file = File.join(path, 'remaining_running_time')
+
+      file_content = File.read(running_time_file)
+
+      raise WrongStateError if file_content == "not_discharging\n"
+      file_content.to_i * 60
+    end
+
+    def remaining_charging_time
+      charging_time_file = File.join(path, 'remaining_charging_time')
+
+      file_content = File.read(charging_time_file)
+
+      raise WrongStateError if file_content == "not_charging\n"
+      file_content.to_i * 60
+    end
+
+    def power
+      power_file = File.join(path, 'power_avg')
+
+      File.read(power_file).to_f / 1000
+    end
+
+    def state
+      state_file = File.join(path, 'state')
+
+      File.read(state_file).chomp.to_sym
+    end
+
+    def remaining_energy
+      energy_file = File.join(path, 'remaining_capacity')
+
+      File.read(energy_file).to_f / 1000
+    end
+
+    def full_energy
+      energy_file = File.join(path, 'last_full_capacity')
+
+      File.read(energy_file).to_f / 1000
+    end
+
+  end
+end

data/lib/battman/version.rb

@@ -0,0 +1,3 @@
+module Battman
+  VERSION = "0.0.1"
+end

data/lib/battman.rb

@@ -0,0 +1,8 @@
+require "battman/version"
+require "battman/dsl"
+
+module Battman
+  class Battman
+    include DSL
+  end
+end