mf60 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+.rvmrc
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :test do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch('test/test_helper.rb')  { "test" }
+
+end

data/README.md

@@ -0,0 +1,42 @@
+# MF60 #
+
+The MF60 is a portable, personal WIFI hotspot that is sold worldwide in countries like Australia and Switzerland (where I live). Apparently, over a million of these devices were sold in Australia alone last year.
+
+Like most hotspots, it comes with a pretty pitiful web interface and not much in the way of an API. I commute on the train frequently, and I sometimes find I need to reset the box. I was curious to see if I could somehow automate that a little bit. For instance, I wanted to be able to quickly disconnect/reconnect from the command-line, or maybe gather statistics. So I wrote this library.
+
+This Gem provides a Ruby library that lets you connect to the device and control it:
+    
+    > require 'MF60'
+    > mf60 = MF60::Client.new('admin', 'secret')
+    > mf60.reset
+    => true
+    
+You can also get stats:
+    
+    > mf60.stats
+    => {:current_trans=>1133211, :current_recv=>2884959, :connect_time=>"29:33", :total_recv=>222000830}
+    
+There's a command-line utility installed as well with the gem that makes this easy to do:
+
+    $ mf60
+    Tasks:
+      mf60 connect      # Connect to the cellular network
+      mf60 disconnect   # Disconnect from the cellular network
+      mf60 help [TASK]  # Describe available tasks or one specific task
+      mf60 reset        # Reset the WAN connection
+      mf60 stats        # Get statistics and usage info
+      mf60 status       # Display connection status and signal strength
+      
+Tracking signal strength can be interesting as well:
+
+      $ mf60 status
+      MF60 Current Status
+      -------------------
+      Provider     : Swisscom
+      Network Type : UMTS
+      Device State : modem_init_complete
+      rscp/ecio    : 176/16
+      rssi         : 11
+      signal       : ▁ ▂ ▃......
+      
+The project is built with [HTTParty](https://github.com/jnunemaker/httparty) and [Thor](https://github.com/wycats/thor). Both libraries are fun and awesome to use.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rake/clean'
+
+task :default => [:test]
+
+desc 'Run tests (default)'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = Dir.glob 'test/*_test.rb'
+  t.ruby_opts = ['-Ilib','-rubygems']
+end

data/bin/mf60

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require 'rubygems'
+require 'mf60'
+require 'httparty'
+require 'thor'
+
+class MF60Util < Thor
+  # Usage: #{app} <command>
+  # Commands:
+  #   status      current device info
+  #   stats       show connection statistics
+  #   connect     connect WAN (3G/2G)
+  #   disconnect  disconnect WAN
+  #   reset       reset (disconnect, then connect)
+
+  USER       ='admin'
+  PASSWORD   = ENV['MF60PW'] || raise("Error: No password set. Environment var MF60PW should contain the device password.")
+
+  desc "reset", "Reset the WAN connection"
+  def reset
+    mf60 = MF60::Client.new(USER, PASSWORD)
+    mf60.reset
+  end
+
+  desc "connect", "Connect to the cellular network"
+  def connect
+    mf60 = MF60::Client.new(USER, PASSWORD)
+    mf60.connect
+  end
+
+  desc "disconnect", "Disconnect from the cellular network"
+  def disconnect
+    mf60 = MF60::Client.new(USER, PASSWORD)
+    mf60.disconnect
+  end
+
+  desc "status", "Display connection status and signal strength"
+  def status
+    mf60 = MF60::Client.new(USER, PASSWORD)
+    st = mf60.status
+    ticks = '▁ ▂ ▃ ▅ ▆ ▇'
+    top = 30 # rssi level for "full bars"
+    numbars = ([st[:rssi].to_i, top].min/top.to_f)*ticks.length.to_i
+    bars = ticks[0..numbars]+'.'*(ticks.length-numbars)
+    puts 'MF60 Current Status'
+    puts '-------------------'
+    puts "Provider     : #{st[:provider]}"
+    puts "Network Type : #{st[:network_type_var]}"
+    puts "Device State : #{st[:cardstate]}"
+    puts "Network Mode : #{st[:current_network_mode]}" if st[:current_network_mode] =~ /.+/
+    puts "rscp/ecio    : #{st[:rscp]}/#{st[:ecio]}"
+    puts "rssi         : #{st[:rssi].to_i}"
+    puts "signal       : #{bars}"
+  end
+
+  desc "stats", "Get statistics and usage info"
+  def stats
+    mf60 = MF60::Client.new(USER, PASSWORD)
+    info = mf60.stats
+    puts 'MF60 Current Statistics'
+    puts '-----------------------'
+    puts "Connect Time : #{info[:connect_time]}"
+    puts "Transmitted  : #{MF60::Helpers.bytes_formatted(info[:current_trans])}"
+    puts "Received     : #{MF60::Helpers.bytes_formatted(info[:current_recv])}"
+    puts "Total Recv   : #{MF60::Helpers.bytes_formatted(info[:total_recv])}"
+  end
+end
+
+MF60Util.start
+
+#vim: set ft=ruby

data/lib/mf60.rb

@@ -0,0 +1,113 @@
+require 'rubygems'
+require 'httparty'
+require 'mf60/version'
+require 'mf60/helpers'
+
+# The MF60 requires some kind of "luck number" with each post, but it does
+# not seem to make mich difference what it is. The cookie is required to 
+# maintain the session after login.
+
+module MF60
+  class Client
+    DEVICE_URL = ENV['MF60URL'] || "http://swisscom-mf60.home/"
+    
+    include HTTParty
+    format :html
+    
+    def initialize(user, pass)
+      @lucknum = 123456
+      response = self.class.post(
+                    DEVICE_URL + '/goform/goform_process',
+                    :body => {
+                      'user' => user, 
+                      'psw' => pass,
+                      'goformId'=>'LOGIN',
+                      'lucknum'=>@lucknum
+                    }
+                  )
+      @cookie = response.headers['set-cookie']
+    end
+    
+    def get(path)
+      response = self.class.get(DEVICE_URL + path, :headers => {'Cookie' => @cookie})
+    end
+
+    def connect
+      net_connect(true)
+    end
+
+    def disconnect
+      net_connect(false)
+    end
+
+    def reset
+      self.disconnect
+      sleep 5
+      self.connect
+    end
+    
+    def stats
+      response = self.get('/adm/statistics.asp')
+      info = response.match(/var realtime_statistics = '([\d\,]+)'/)[1]
+      stats = info.split(',')
+      {
+        :current_trans => stats[2].to_i,
+        :current_recv  => stats[3].to_i,
+        :connect_time  => "%02d:%02d" % [stats[4].to_i/60, stats[4].to_i%60],
+        :total_recv   => stats[5].to_i
+      }
+    end
+
+    # 
+    # 0        -113 dBm or less  
+    # 1        -111 dBm  
+    # 2...30   -109... -53 dBm  
+    # 31        -51 dBm or greater  "good"
+    # 
+    # 99 not known or not detectable
+    #
+    # RSCP is the received signal code power from the CPICH channel and it is usually constant in a cell and it gives an indication of the level in the area.
+    # RSSI: is the received signal strength indicator and it is the total power with the noise.
+    # Ec/N0 : is the Received Signal Code Power equal to RSCP/RSSI or the code power over (noise+code power)
+    # So... rscp/rssi = ecno
+    # 
+    # rscp            
+    # ---- = ecio   |   rscp = ecio * rssi   |   rssi = rscp/ecio
+    # rssi            
+    
+    def status
+      response = self.get('/air_network/wireless_info.asp')
+      vars = %w(provider network_type_var cardstate current_network_mode rscp ecio)
+      status = {}
+      vars.each do |var_name|
+        status[var_name.to_sym] = grab_var(response, var_name)
+      end
+      status[:rssi] = (status[:rscp].to_f/status[:ecio].to_f)
+      status
+    end
+    
+    private
+    
+      # mode: 'connect' or 'disconnect'
+      def net_connect(active)
+        body = {
+          'goformId'=>'NET_CONNECT',
+          'lucknum_NET_CONNECT'=>@lucknum
+        }
+        if active
+          body['dial_mode'] = 'auto_dial'
+        else
+          body['dial_mode'] = 'manual_dial'
+          body['action'] = 'disconnect'
+        end
+        response = self.class.post(DEVICE_URL + '/goform/goform_process', :body => body)
+        response.success?
+      end
+
+      def grab_var(response, var_name)
+        part = response.match(/var\s+#{var_name}\s+=\s+'([^']+)'/)
+        part ? part[1] : ''
+      end
+      
+  end
+end

data/lib/mf60/helpers.rb

@@ -0,0 +1,23 @@
+module MF60
+  # format bytes as 12B, 124K, 1.2M, 24G etc
+  class Helpers
+    def self.bytes_formatted(bytes)
+      return '-' if bytes <= 0
+      units = ['B','K','M','G','T']
+      t = 0
+      while bytes >= 1024**(t+1)
+        t+=1
+      end
+      n = t>0 ? (bytes/(1024.0**t)) : bytes
+      n = n.floor if (n-n.floor)<0.1
+      n = n.ceil if (n.ceil-n)<0.1
+      if n==1024
+        n = n/1024
+        t+=1
+      end
+      fn = (n-n.floor>0 and n<50) ? sprintf("%.1f", n) : n.ceil
+      "#{fn}#{units[t]}"
+    end
+    
+  end
+end

data/lib/mf60/version.rb

@@ -0,0 +1,3 @@
+module MF60
+  VERSION = "0.1.0"
+end

data/mf60.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mf60/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mf60"
+  s.version     = MF60::VERSION
+  s.authors     = ["Jeremy Seitz"]
+  s.email       = ["jeremy@somebox.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby library and command-line tool for interfacing with the MF60 mobile internet hotspot device.}
+  s.description = %q{A library and command-line tool that talk to the MF60 via the admin web interface. This little battery-powered box is available from Swisscom in Switzerland (as well as mobile operators in other countries). With this gem you can get statistics, network info, signal strength, connect, disconnect and reset the device.}
+
+  s.rubyforge_project = "mf60"
+
+  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) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+
+  s.add_runtime_dependency "httparty"
+  s.add_runtime_dependency "thor"  
+  
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-test"  
+end

data/test/mf60_test.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'mf60'
+
+class MF60Test < Test::Unit::TestCase
+  def test_bytes_formatted
+    {
+      '-'     => 0,
+      '1B'    => 1, 
+      '100B'  => 100,
+      '589B'  => 589,
+      '1K'    => 1024,
+      '1.1K'  => 1160,
+      '2K'    => 2050,
+      '19.5K' => 20000,
+      '20K'   => 20490,
+      '100K'  => 100*2**10,
+      '102K'  => 100*1024+1200,
+      '935K'  => 957383,
+      '1M'    => 1024*1024,
+      '1M'    => 1024*1024-100,
+      '1M'    => 1024*1024+100,
+      '1.1M'  => 1024*1024+150*1024,
+      '6.5M'  => 6809954,
+      '71M'   => 74046302,
+      '242M'  => 253012972,
+      '1.4G'  => 1471936825,
+      '20G'   => 1024**3*20,
+      '1.5T'  => 1024**4*1.5,
+    }.each do |expected, num|
+      assert_equal expected, MF60::Helpers.bytes_formatted(num)
+    end
+  end
+    
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: mf60
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Seitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70333819869340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70333819869340
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70333819868920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70333819868920
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70333819868500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70333819868500
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: &70333819868080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70333819868080
+description: A library and command-line tool that talk to the MF60 via the admin web
+  interface. This little battery-powered box is available from Swisscom in Switzerland
+  (as well as mobile operators in other countries). With this gem you can get statistics,
+  network info, signal strength, connect, disconnect and reset the device.
+email:
+- jeremy@somebox.com
+executables:
+- mf60
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/mf60
+- lib/mf60.rb
+- lib/mf60/helpers.rb
+- lib/mf60/version.rb
+- mf60.gemspec
+- test/mf60_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mf60
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby library and command-line tool for interfacing with the MF60 mobile internet
+  hotspot device.
+test_files:
+- test/mf60_test.rb