mf60 0.1.1 → 0.1.2

data/README.md

@@ -2,21 +2,56 @@
 
 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.
 
+![my mf60](http://dl.dropbox.com/u/385855/mf60.jpg)
+
+# Installation #
+
+
+    $ gem install mf60
+    $ mf60 --help
+
 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:
+_Note: When you are logged into the admin interface from a browser, you will be logged out as soon as you connect with this library. That's just the way it goes._
+
+The Swisscom MF60 from ZTE is known to work with this, but other carriers and devices may be compatible. Let me know.
+
+## Library ##
+
+By default, the library attempts to connect to the device's web admin interface at http://192.168.0.1/. You can change the address with an environment variable,`MF60URL`:
+
+    $ export MF60URL="http://swisscom-mf60.home"
+    
+    or, in an app:
+    
+    # ENV['MF60URL'] = "http://192.168.1.1"
+
+There's just one class to use, `MF60::Client`:
     
     > require 'MF60'
     > mf60 = MF60::Client.new('admin', 'secret')
     > mf60.reset
     => true
     
-You can also get stats:
+Statistics and status are returned as a hash:
     
     > mf60.stats
     => {:current_trans=>1133211, :current_recv=>2884959, :connect_time=>"29:33", :total_recv=>222000830}
+
+See the [command-line utility source](https://github.com/somebox/MF60/blob/master/bin/mf60) for descriptions of the keys.
+
+
+## Command-line Utility ##    
+    
+A command-line utility gets installed with the gem, called `mf60`. Before using it, set the admin interface password via an environment variable:
+
+    $ export MF60PW="secret"
+
+    or
     
-There's a command-line utility installed as well with the gem that makes this easy to do:
+    $ MF60PW="secret" mf60 status
+
+There are just a few tasks supported for now:
 
     $ mf60
     Tasks:
@@ -38,5 +73,13 @@ Tracking signal strength can be interesting as well:
       rscp/ecio    : 176/16
       rssi         : 11
       signal       : ▁ ▂ ▃......
+
+The signal meter is probably not that accurate (needs tweaking) and doesn't work at all when on GPRS (2G).
+
+## Code   
       
-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.
+There's no official published protocol for this device that I know of. Firebug and Firefox were used to inspect and reverse engineer the web admin interface of the device.
+
+I hope to soon write a stats-gathering script so I can graph signal strength along different train lines.
+
+The project is built with [HTTParty](https://github.com/jnunemaker/httparty) and [Thor](https://github.com/wycats/thor). Both libraries were fun and awesome to use.

data/lib/mf60.rb

@@ -9,7 +9,7 @@ require 'mf60/helpers'
 
 module MF60
   class Client
-    DEVICE_URL = ENV['MF60URL'] || "http://swisscom-mf60.home/"
+    DEVICE_URL = ENV['MF60URL'] || "http://192.168.0.1"
     
     include HTTParty
     format :html

data/lib/mf60/version.rb

@@ -1,3 +1,3 @@
 module MF60
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mf60
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70257353769520 !ruby/object:Gem::Requirement
+  requirement: &70125287490240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257353769520
+  version_requirements: *70125287490240
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70257353769100 !ruby/object:Gem::Requirement
+  requirement: &70125287489820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257353769100
+  version_requirements: *70125287489820
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70257353768680 !ruby/object:Gem::Requirement
+  requirement: &70125277687140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257353768680
+  version_requirements: *70125277687140
 - !ruby/object:Gem::Dependency
   name: guard-test
-  requirement: &70257353768260 !ruby/object:Gem::Requirement
+  requirement: &70125277686720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257353768260
+  version_requirements: *70125277686720
 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,