mfi 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b14de77104a8ccb5ed5ed50f6794ac40404d83ee
+  data.tar.gz: 32a1abe857da69e501019df8477cca705e2e9901
+SHA512:
+  metadata.gz: 39f02f69df4aa53648e38278362518f3578f1f627ca7fdd7d1cc1f93ea4a9f3a4c8aca9a00abebbe36181f9b91a1a51eb73e05b3fa8c2e8a0e950ee81e2174da
+  data.tar.gz: 7129e7eed14410e49a89940d54a396b50cc155dd5aaeaeea4395684fbbd29174591636b0442978484a18358bede997ccac178279bf0b1ebdcac82f94f5418bac

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    mfi (0.9.0)
+      json (>= 1.8.1)
+      ssh (>= 1.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    json (1.8.1)
+    open4 (1.3.0)
+    ssh (1.1.0)
+      open4 (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mfi!

data/README.md

@@ -0,0 +1,46 @@
+#### mFi for ruby
+
+Gem for integrating with mFi devices over SSH.
+
+##### Install
+
+```
+gem install mfi
+```
+
+##### mPower
+
+mPower ports are linux based wifi-enabled power strips.  Each port has sensors for amps, voltage, and power factor.  Additionally each port has a relay.  Here is a script that samples all powers, and disables a port if the energy exceeds 10kWh.
+
+```ruby
+device = MFi::MPower.new(
+  :host => "hostname",
+  :user => "username",
+  :pass => "password"
+)
+
+device.connect!
+
+device.sample.each { |reading|
+  puts reading.to_s
+  if reading.energy > 10
+    puts "Port #{reading.port} has consumed >= 10 kWh. Switching off..."
+    device.switch_off(reading.port)
+  end
+}
+```
+
+##### Rake
+
+You can also run the rakefile when checking out the repository
+
+```
+$ rake sample HOST=192.168.3.201 USER=ubnt PASS=ubnt
+Port 1:  20.5W (  0.7pf   0.3A 112.3V)
+Port 2:   0.0W (  0.0pf   0.0A 113.9V)
+Port 3:   0.0W (  0.0pf   0.0A 113.2V)
+```
+
+##### Notes
+
+This is a quick sunday hack, so use at your own risk.  If you extend or enhance this, send a pull request.

data/Rakefile

@@ -0,0 +1,30 @@
+$: << File.dirname(__FILE__) + "/lib"
+
+require "mfi"
+
+task :default => :sample
+
+task :env do
+  @mpower = MFi::MPower.new(
+    :host => ENV["HOST"],
+    :user => ENV["USER"],
+    :pass => ENV["PASS"]
+  )
+end
+
+task :sample => :env do
+  @mpower.connect!
+  @mpower.sample.each { |reading|
+    puts reading
+  }
+end
+
+task :switch_off => :env do
+  @mpower.connect!
+  @mpower.switch_off
+end
+
+task :switch_on => :env do
+  @mpower.connect!
+  @mpower.switch_on
+end

data/lib/mfi.rb

@@ -0,0 +1,10 @@
+$: << File.dirname(__FILE__)
+
+require "net/ssh"
+require "json"
+
+module MFi
+  Version = "0.9.0"
+end
+
+require "mpower"

data/lib/mpower.rb

@@ -0,0 +1,95 @@
+module MFi
+
+  class MPowerReading
+
+    attr_accessor :port, :power, :relay, :enable, :energy, :current, :voltage, :powerfactor
+
+    def initialize port, opts
+      @port = port
+      @enable = opts["enable"].to_i
+      @relay = opts["relay"].to_i
+      @power = opts["power"].to_f
+      @energy = opts["energy"].to_f
+      @current = opts["current"].to_f
+      @voltage = opts["voltage"].to_f
+      @powerfactor = opts["powerfactor"].to_f
+    end
+
+    def to_s
+      "Port #{@port}: #{fmt(@power)}W (#{fmt(@powerfactor)}pf #{fmt(@current)}A #{fmt(@voltage)}V)"
+    end
+
+    def fmt v
+      "%5.1f" % v
+    end
+
+  end
+
+  class MPower
+
+    attr_accessor :host, :user, :port
+
+    #
+    # Create MPower instance
+    #
+    # +opts+ connection options
+    # host, pass and user are required for SSH
+    #
+    def initialize opts
+      @host = opts[:host]
+      @pass = opts[:pass]
+      @user = opts[:user]
+    end
+
+    # Connect to the remote MPower device
+    def connect!
+      @ssh = Net::SSH.start(@host, @user, :password => @pass)
+    end
+
+    # Sample all metrics from the mPower device
+    # +port+ the port option, default is all
+    def sample port=-1
+      data = run(:func => "powerList", :port => port)
+      unless data.key?("value")
+        raise "No data available"
+      end
+
+      data["value"].shift
+      number = 0
+      data["value"].map { |value| MPowerReading.new(number += 1, value) }
+    end
+
+    # Write enable port, allowing relay toggling
+    # +port+ the port option, default is all
+    def enable port=-1
+      run(:func => "enableWrite", :port => port)
+    end
+
+    # Write disable port, disabling relay toggling
+    # +port+ the port option, default is all
+    def disable port=-1
+      run(:func => "enableRead", :port => port)
+    end
+
+    # Switch off, or disable power on a given port
+    # +port+ the port option, default is all
+    def switch_off port=-1
+      run(:func => "relayWrite", :port => port, :value => 0)
+    end
+
+    # Switch on, or enable power on a given port
+    # +port+ the port option, default is all
+    def switch_on port=-1
+      run(:func => "relayWrite", :port => port, :value => 1)
+    end
+
+    private
+
+    def run opts
+      env = opts.map { |k,v| "#{k}=#{v}" }.join(" ")
+      cmd = "#{env} cgi -q /usr/www/mfi/io.cgi"
+      JSON.parse(@ssh.exec!(cmd).strip)
+    end
+
+  end
+end

data/mfi.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "mfi"
+
+spec = Gem::Specification.new do |s|
+  s.name = "mfi"
+  s.version = MFi::Version
+  s.license = "MIT"
+  s.date = "2013-11-02"
+  s.summary = "gem for integrating with Ubiquiti mFi sensors and devices"
+  s.email = "dan.simpson@gmail.com"
+  s.homepage = "https://github.com/dansimpson/mfi"
+  s.description = "gem for integrating with Ubiquiti mFi sensors and devices"
+  s.has_rdoc = true
+  
+  s.authors = ["Dan Simpson"]
+  s.add_dependency("ssh", ">= 1.1.0")
+  s.add_dependency("json", ">= 1.8.1")
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: mfi
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Dan Simpson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: gem for integrating with Ubiquiti mFi sensors and devices
+email: dan.simpson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/mfi.rb
+- lib/mpower.rb
+- mfi.gemspec
+homepage: https://github.com/dansimpson/mfi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: gem for integrating with Ubiquiti mFi sensors and devices
+test_files: []