hilink 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cba55d74717973ed7b5afc525491281eaf43a5a
-  data.tar.gz: 1238b03a6e15a8efde8c5971c2f7ce503feed1bd
+  metadata.gz: 1f36911eae5aa21b7a930202fcda969270b4b200
+  data.tar.gz: 6df1daade018152d51cc2a9f2d75ffff792f1994
 SHA512:
-  metadata.gz: efae533d427e1d05c37a76aa19cfa37039a449bd9cd502fa65592c16b678308e8162c1e70302f4422d35bfca2ae217c5c5c11b4dbac78f81c8d3d2989c6781cd
-  data.tar.gz: 61d0a903e2397a8dce0e117c017dfca38b5bc134e5bd6de2e4cc73687f4b6655a8a37d564615b65cbe9a261d4133dd1fa22fbb889cbba33286b50e782d1939aa
+  metadata.gz: efd5c13d32cec536d87b4fef058d89816da22b416cbad73859e58f19f1ff00ef6ec74f55850f6e08959ddee7787a6f8233cd2d83703557ca115919c5cbcadc2d
+  data.tar.gz: 0ca7899a7855b18365da8caf5b9fdaf485a713d3169efa5333759b20c455e750e04ddc232e3cd7b300363138c217a80a287dcf9d960f9fa5552c5896bf466146

data/README.md

@@ -0,0 +1,52 @@
+# Hilink - ruby interface for Huawei Hilink web-frontend
+
+## Usage
+
+The code supposes that the modem is connected and has the IP
+192.168.1.1. Then you can do:
+
+````
+require 'hilink'
+puts Hilink::Monitoring::status.inspect
+````
+
+which will return a hash of all variables that the stick can return.
+
+Please also see the much more complete PhP-implementation on
+[BlackyPanther/Huawei-HiLink](https://github.com/BlackyPanther/Huawei-HiLink).
+
+## Commands
+
+Each command is a module inside of Hilink. There are different modules:
+
+- Monitoring - return different status of the modem
+- Network - change 2g / 3g network
+- SMS - send, receive and list
+- Dialup - (dis)connect from network
+- Modem - useful only when it is in modem-mode
+- USSD - *Doesn't work due to Huawei restriction*
+
+The Hilink-module itself has three methods:
+- `send_request( path, request = {} )` - generates a valid XML-request and return
+the result as a hash
+- `switch_to_modem` - sends the command so the key behaves as a modem
+- `switch_to_debug` - according to web-interface, no difference visible
+
+### Monitoring
+
+You can monitor different things:
+
+- `traffic_statistics` - per-connection and total usage
+- `traffic_reset` - set all to 0
+- `status` - shows whether connected or not
+- `check_notifications`
+
+### Network
+
+- `set_connection_type( mode = 'auto', band = '-1599903692' )` - mode
+can be 'auto', '2g' or '3g'
+- `current_plnm` - get actual connection
+
+### SMS
+
+- `list`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hilink
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Linus Gasser
@@ -44,8 +44,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/hilink.rb
-homepage: http://rubygems.org/gems/hilink
+- README.md
+homepage: https://github.com/ineiti/Hilink
 licenses:
 - GPLv3
 metadata: {}

data/lib/hilink.rb

@@ -1,160 +0,0 @@
-require 'net/http'
-require "active_support/core_ext"
-require 'active_support'
-require 'serialport'
-
-module Hilink
-  class << self
-    def send_request( path, request = {} )
-      url = "/api/#{path}"
-      http = Net::HTTP.new("192.168.1.1")
-      
-      if request != {} 
-        req = Net::HTTP::Post.new(url)
-        req.body = request.to_xml(root: "request", indent: 0, skip_types: true) 
-        req.content_type = 'text/xml'
-      else
-        req = Net::HTTP::Get.new(url)
-      end
-
-      puts "Calling #{url} with _#{req.body}_"
-      response = http.request(req).body
-
-      Hash.from_xml( response )['response']
-    end
-
-    def switch_to_modem
-      send_request( "device/mode", :mode => 0 )
-    end
-
-    def switch_to_debug
-      send_request( "device/mode", :mode => 1 )
-    end
-  end
-  module Modem
-    class << self
-      def send_modem( str )
-        sp = SerialPort.new('/dev/ttyUSB0',115200)
-        sp.write("#{str}\r\n")
-        sp.read_timeout = 100
-        sp.readlines
-      end
-
-      def switch_to_hilink
-        send_modem( "AT^U2DIAG=119" )
-      end
-    end
-  end
-  module Monitoring
-    class << self
-      def send_request( path, request = {} )
-        Hilink::send_request( "monitoring/#{path}", request )
-      end
-
-      def traffic_statistics
-        send_request( "traffic-statistics" )
-      end
-
-      def traffic_reset
-        send_request( "clear-traffic" )
-      end
-
-      def status
-        send_request( "status" )
-      end
-
-      def check_notifications
-        send_request( "check-notifications" )
-      end
-    end
-  end
-  module Network
-    class << self
-      def send_request( path, request = {} )
-        Hilink::send_request( "net/#{path}", request )
-      end
-
-      def current_plnm
-        send_request( "current-plnm" )
-      end
-
-      def set_connection_type( mode = 'auto', band: '-1599903692' )
-        nmode = case mode
-        when /2g/i 
-         1 
-        when /3g/i 
-         2 
-        else 
-         0 
-        end
-        send_request( "network", {
-          :NetworkMode => nmode,
-          :NetworkBand => band } )
-      end
-    end
-  end
-  module SMS
-    class << self
-      def send_request( path, request = {} )
-        Hilink::send_request( "sms/#{path}", request )
-      end
-
-      def list( box = 1, site: 1, pref_unread: 0, count: 20 )
-        ret = send_request( "sms-list", {
-          :PageIndex => site,
-          :ReadCount => count,
-          :BoxType => box,
-          :SortType => 0,
-          :Ascending => 0,
-          :UnreadPreferred => pref_unread } )
-        if ret['Messages']['Message'].class == Hash
-          ret['Messages']['Message'] = [ ret['Messages']['Message'] ]
-        end
-        ret
-      end
-
-      def delete( index )
-        send_request( "delete-sms", { :Index => index } )
-      end
-
-      def send( number, message, index = -1 )
-        send_request( "send-sms", {
-          :Index => index,
-          :Phones => [number].flatten,
-          :Sca => "",
-          :Content => message,
-          :Length => message.length,
-          :Reserved => 1,
-          :Date => Time.now.strftime( "%Y-%m-%d %H:%M:%S" ) } )
-      end
-    end
-  end
-  module Dialup
-    class << self
-      def send_request( path, request = {} )
-        Hilink::send_request( "dialup/#{path}", request )
-      end
-
-      def connect
-        send_request( "dial", :Action => 1 )
-      end
-
-      def disconnect
-        send_request( "dial", :Action => 0 )
-      end
-    end
-  end
-  module USSD
-    class << self
-      def send_request( path, request = {} )
-        Hilink::send_request( "ussd/#{path}", request )
-      end
-
-      def send( str )
-        return :error => "Sorry, doesn't work!"
-        send_request( "send", :content => str, :codeType => "CodeType" )
-      end
-    end
-  end
-end
-