hilink_modem 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1a1df7c8728485e565ddc3f08f0ad51fde18d56
+  data.tar.gz: 27772b941b9788e582e3a37047262b4118e4007d
+SHA512:
+  metadata.gz: b56e5c5cdace315e5ee47a14faa6855b22e1190f4cd58380a8ca0f3d643316aabd79426f274f9f57e33a3027356c9c5ef259dfa57a23c27374fddd8b8520c62f
+  data.tar.gz: fa0841ca0fe8778e0386f979c18983945df064bc057693e90467043194d3053a3fa8a49c50bd4f99ebde5b2a729e3e5b2d4b8be117456521438fab39c562cd5e

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+/RubyApplication8/nbproject/private/
+/nbproject/private/
+.hg*
+.idea
+commit
+.DS_Store

data/README.md

@@ -0,0 +1,55 @@
+# 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).
+
+If you have the newer version which connects to 192.168.8.1, this library
+won't work for you, sorry.
+
+## 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`

data/bin/hilink_to_modem.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+LOAD_PATH.push %w( ../lib/ ../../HelperClasses/lib ../../QooxView/libs/activesupport-3.1.1/lib
+../../QooxView/libs/i18n-0.6.0/lib )
+require 'hilink_modem'
+
+puts HilinkModem::switch_to_modem
+sleep 10
+if File.exists? "/dev/ttyUSB0"
+  puts HilinkModem::Modem::save_modem
+else
+  puts "Switch didn't work - sorry"
+end

data/hilink_modem.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'hilink_modem'
+  s.version     = '0.3.0'
+  s.date        = '2015-04-06'
+  s.summary     = 'Accessing Huawei HilinkModem modems'
+  s.description = 'Using the web-interface of huawei hilink modems to do things'
+  s.authors     = ['Linus Gasser']
+  s.email       = 'ineiti@linusetviviane.ch'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'activesupport', '~> 4.1'
+  s.add_runtime_dependency 'serialport', '~> 1.3'
+  s.homepage    = 'https://github.com/ineiti/HilinkModem'
+  s.license       = 'GPLv3'
+end

data/lib/hilink_modem.rb

@@ -0,0 +1,172 @@
+require 'net/http'
+require 'active_support/core_ext'
+require 'active_support'
+require 'serialport'
+require 'helperclasses/hashaccessor'
+
+
+module HilinkModem
+  extend self
+  #using HelperClasses::HashAccessor
+
+  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
+    begin
+      response = http.request(req).body
+    rescue Errno::ENETUNREACH => e
+      return nil
+    end
+
+    begin
+      Hash.from_xml( response )['response']
+    rescue REXML::ParseException => e
+      nil
+    end
+  end
+
+  def switch_to_modem
+    send_request( 'device/mode', :mode => 0 )
+  end
+
+  def switch_to_debug
+    send_request( 'device/mode', :mode => 1 )
+  end
+  module Modem
+    extend 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
+
+    def save_modem
+      send_modem('AT^U2DIAG=0')
+    end
+  end
+  module Monitoring
+    extend 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
+  module Network
+    extend 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
+  module SMS
+    extend 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 && 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
+  module Dialup
+    extend 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
+  module USSD
+    extend 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

data/test/hilink_test.rb

@@ -0,0 +1,72 @@
+require 'hilink_modem'
+
+#puts HilinkModem::USSD::send( "*100#" )
+#exit
+
+#puts HilinkModem::switch_to_debug
+#exit
+
+#puts HilinkModem::Modem::switch_to_hilink
+#puts HilinkModem::SMS::list.inspect
+#exit
+
+puts HilinkModem::switch_to_modem
+exit
+
+puts HilinkModem::Dialup::connect
+puts HilinkModem::Dialup::disconnect
+exit
+
+
+#puts HilinkModem::SMS::send( "93999699", "hello there" )
+puts HilinkModem::SMS::list.inspect
+HilinkModem::SMS::list['Messages']['Message'].each{|m|
+  puts m.inspect
+  HilinkModem::SMS::delete( m['Index'] )
+}
+exit
+
+#puts HilinkModem::send_request( "device/information" )
+message = "Hello from Smileplug"
+=begin
+puts HilinkModem::send_request( "sms/send-sms",
+{ :Index => -1, 
+  :Phones => ["93999699"],
+  :Sca => '',
+  :Content => message,
+  :Length => message.length,
+  :Reserved => 1,
+  :Date => Time.now.strftime('%Y-%m-%d %H:%M:%S') } )
+=end
+#puts HilinkModem::send_request( "monitoring/check-notifications" )
+#puts HilinkModem::send_request( "monitoring/status" )
+puts HilinkModem::send_request( "sms/sms-list",
+{ :PageIndex => 1,
+  :ReadCount => 20,
+  :BoxType => 1,
+  :SortType => 0,
+  :Ascending => 0,
+  :UnreadPreferred => 0 } )
+puts HilinkModem::send_request( "sms/delete-sms", { :Index => 20067 } )
+
+exit
+
+a = Document.new
+( a.add_element "Index" ).text = -1
+a.write $stdout
+
+exit
+
+url = 'http://192.168.1.1/api/monitoring/status'
+url = 'http://192.168.1.1/api/device/information'
+
+# get the XML data as a string
+xml_data = Net::HTTP.get_response(URI.parse(url)).body
+
+puts xml_data.inspect
+# extract event information
+doc = REXML::Document.new(xml_data)
+
+XPath.each( doc, "//response/*" ){|a|
+  puts a.inspect, a.text
+}

data/test/start_test

@@ -0,0 +1,8 @@
+#!/bin/bash
+if [ ! "$1" ]; then
+  echo "No argument given"
+  exit 1
+fi
+
+ruby -I../lib/ -I../../HelperClasses/lib -I../../QooxView/libs/activesupport-3.1.1/lib \
+	-I../../QooxView/libs/i18n-0.6.0/lib $1

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: hilink_modem
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Linus Gasser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Using the web-interface of huawei hilink modems to do things
+email: ineiti@linusetviviane.ch
+executables:
+- hilink_to_modem.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- bin/hilink_to_modem.rb
+- hilink_modem.gemspec
+- lib/hilink_modem.rb
+- test/hilink_test.rb
+- test/start_test
+homepage: https://github.com/ineiti/HilinkModem
+licenses:
+- GPLv3
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Accessing Huawei HilinkModem modems
+test_files:
+- test/hilink_test.rb
+- test/start_test