cmux 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.so

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergey Gridasov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Cmux
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cmux'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cmux
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"

data/cmux.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cmux/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sergey Gridasov"]
+  gem.email         = ["grindars@gmail.com"]
+  gem.description   = %q{Ruby bindings for CMUX, GSM 07.10 multiplexer}
+  gem.summary       = %q{Ruby bindings for CMUX, GSM 07.10 multiplexer}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cmux"
+  gem.require_paths = ["lib"]
+  gem.version       = CMUX::VERSION
+
+  gem.add_dependency 'ffi'
+end

data/lib/cmux.rb

@@ -0,0 +1,12 @@
+require "ffi"
+require "set"
+
+require "cmux/version"
+require "cmux/modem_chatter"
+require "cmux/modem_command"
+require "cmux/modem_command_response"
+require "cmux/library"
+require "cmux/io"
+require "cmux/connection"
+require "cmux/mux"
+require "cmux/channel"

data/lib/cmux/channel.rb

@@ -0,0 +1,29 @@
+module CMUX
+  class Channel
+    attr_reader :device
+    attr_reader :port
+
+    def initialize(device, port, mux)
+      @device = device
+      @port = port
+      @mux = mux
+    end
+
+    def open(&block)
+      io = IO.open_tty @device
+      if block_given?
+        begin
+          yield io
+        ensure
+          io.close
+        end
+      else
+        io
+      end
+    end
+
+    def close
+      @mux.close_port @port
+    end
+  end
+end

data/lib/cmux/connection.rb

@@ -0,0 +1,72 @@
+module CMUX
+  class Connection
+
+    class Pointer < FFI::AutoPointer
+      def self.release(pointer)
+        Library.cmux_destroy pointer
+      end
+    end
+
+    def initialize
+      buffer = FFI::Buffer.new :pointer, 1
+      context = Library.cmux_create buffer
+
+      if context.null?
+        ptr = buffer.read_pointer
+        begin
+          error = ptr.read_string
+          raise "MUX creation failed: #{error}"
+        ensure
+          Library.cmux_free ptr
+        end
+      end
+
+      @handle = Pointer.new context
+    end
+
+    def open(device)
+      status = Library.cmux_open @handle, device
+      if status == -1
+        raise Library.cmux_error(@handle)
+      end
+
+      nil
+    end
+
+    def activate
+      status = Library.cmux_activate @handle
+      if status == -1
+        raise Library.cmux_error(@handle)
+      end
+
+      nil
+    end
+
+    def close
+      @handle.free
+      @handle = nil
+    end
+
+    def open_port(index)
+      buffer = FFI::Buffer.new :pointer, 1
+      status = Library.cmux_open_port @handle, index, buffer
+      if status == -1
+        raise Library.cmux_error(@handle)
+      end
+
+      pointer = buffer.read_pointer
+      begin
+        pointer.read_string
+      ensure
+        Library.cmux_free pointer
+      end
+    end
+
+    def close_port(index)
+      status = Library.cmux_close_port @handle, index
+      if status == -1
+        raise Library.cmux_error(@handle)
+      end
+    end
+  end
+end

data/lib/cmux/io.rb

@@ -0,0 +1,21 @@
+module CMUX
+  module IO
+    def self.open_tty(filename)
+      buffer = FFI::Buffer.new :pointer, 1
+
+      fd = Library.cmux_open_device filename, buffer
+      if fd == -1
+        ptr = buffer.read_pointer
+        begin
+          error = ptr.read_string
+        ensure
+          Library.cmux_free ptr
+        end
+
+        raise error
+      end
+
+      FFI::IO.for_fd fd, "r+"
+    end
+  end
+end

data/lib/cmux/library.rb

@@ -0,0 +1,19 @@
+module CMUX
+
+  module Library
+    extend FFI::Library
+
+    ffi_lib "cmux"
+
+    attach_function :cmux_create,      [ :buffer_out ], :pointer
+    attach_function :cmux_destroy,     [ :pointer ], :void
+    attach_function :cmux_error,       [ :pointer ], :string
+    attach_function :cmux_open,        [ :pointer, :string ], :int
+    attach_function :cmux_activate,    [ :pointer ], :int
+    attach_function :cmux_open_port,   [ :pointer, :int, :buffer_out ], :int
+    attach_function :cmux_close_port,  [ :pointer, :int ], :int
+    attach_function :cmux_free,        [ :pointer ], :void
+    attach_function :cmux_open_device, [ :string, :buffer_out ], :int
+  end
+
+end

data/lib/cmux/modem_chatter.rb

@@ -0,0 +1,192 @@
+module CMUX
+  class ModemChatter
+    attr_reader :io
+
+    def initialize(io)
+      @io = io
+      @command_queue = []
+      @buffer = ""
+      @response = []
+      @unprocessed_lines = []
+      @have_running_command = true # because echo can be disabled before init string
+      @unsolicited = Hash.new do |hash, key|
+        hash[key] = Set.new
+      end
+
+      command "E1V1+CMEE=2", 2
+    end
+
+    def command(command, timeout = nil, &block)
+      submit_now = @command_queue.empty?
+      cmd = ModemCommand.new(command, self, timeout, &block)
+      @command_queue.push cmd
+
+      submit if submit_now
+
+      cmd
+    end
+
+    def submit
+      return if @command_queue.empty?
+
+      cmd = @command_queue.first
+      cmd.start
+
+      @io.write "AT#{cmd.command}\r\n"
+    end
+
+    def desired_timeout
+      return nil if @command_queue.empty?
+
+      command = @command_queue.first
+      return nil if command.timeout.nil?
+
+      now = DateTime.now.to_time
+
+      remaining = command.issued_at + command.timeout - now
+      if remaining < 0
+        remaining = 0
+      end
+
+      remaining
+    end
+
+    def run_periodic
+      remaining = desired_timeout
+
+      if remaining == 0
+        @have_running_command = false
+        complete_first "timeout"
+      end
+    end
+
+    def self.poll(devices, timeout_limit = nil)
+      timeouts = devices.map(&:desired_timeout)
+      timeouts << timeout_limit
+      timeouts.reject! &:nil?
+      read, write, except = ::IO.select devices.map(&:io), [], [], timeouts.min
+
+      unless read.nil?
+        read.each do |io|
+          devices.find { |dev| dev.io == io }.poll
+        end
+      end
+
+      devices.each(&:run_periodic)
+    end
+
+    def poll
+      begin
+        @buffer += @io.read_nonblock 4096
+        on_read
+      rescue Errno::EINTR, ::IO::WaitReadable
+      end
+    end
+
+    def subscribe(type, receiver)
+      @unsolicited[type].add receiver
+    end
+
+    def unsubscribe(type, receiver)
+      @unsolicited[type].delete receiver
+    end
+
+    private
+
+    def on_read
+      chunk = @buffer.split "\r\n", -1
+      @buffer = chunk.pop
+      @unprocessed_lines += chunk
+
+      completed = false
+
+      while @unprocessed_lines.any?
+        line = @unprocessed_lines.shift
+        line.rstrip!
+
+        if @have_running_command
+          if line == "OK" || line == "CONNECT"
+            @have_running_command = false
+            completed = true
+            complete_first
+          elsif line == "ERROR" || line == "NO CARRIER" || line == "NO DIALTONE" || line == "BUSY"
+            @have_running_command = false
+            completed = true
+            complete_first line
+          elsif line =~ /^\+CME ERROR: (.*)$/
+            @have_running_command = false
+            completed = true
+            complete_first $1
+          else
+            @response << line
+          end
+        elsif @command_queue.any? && line == "AT#{@command_queue.first.command}"
+          @have_running_command = true
+        elsif !line.empty?
+          on_unsolicited line
+        end
+      end
+
+      submit if completed
+    end
+
+    def on_unsolicited(line)
+      if line =~ /^\+([A-Z]+): (.*)$/
+        type, body = $1, $2
+      else
+        return
+      end
+
+      list = []
+      chunk = ""
+      state = :void
+
+      body.chars do |char|
+        case state
+        when :void
+          case char
+          when ','
+            list << chunk
+            chunk = ""
+
+          when '"'
+            state = :string
+
+          else
+            chunk << char
+          end
+
+        when :string
+          case char
+          when '"'
+            state = :void
+
+          when '\\'
+            state = :escape
+
+          else
+            chunk << char
+          end
+
+        when :escape
+          chunk << char
+          state = :string
+        end
+      end
+
+      list << chunk
+
+      @unsolicited[type].each do |receiver|
+        receiver.unsolicited type, list
+      end
+    end
+
+    def complete_first(error = nil)
+      response = ModemCommandResponse.new(error, @response)
+      request = @command_queue.shift
+      @response = []
+
+      request.complete response
+    end
+  end
+end

data/lib/cmux/modem_command.rb

@@ -0,0 +1,26 @@
+module CMUX
+  class ModemCommand
+    attr_reader :state, :command, :timeout, :issued_at
+
+    def initialize(command, chatter, timeout, &block)
+      @command = command
+      @chatter = chatter
+      @timeout = timeout
+      @issued_at = DateTime.now.to_time
+      @block = block
+      @state = :queued
+    end
+
+    # modemchatter api
+
+    def start
+      @state = :executing
+    end
+
+    def complete(response)
+      @state = :complete
+
+      @block.call response unless @block.nil?
+    end
+  end
+end

data/lib/cmux/modem_command_response.rb

@@ -0,0 +1,18 @@
+module CMUX
+  class ModemCommandResponse
+    attr_reader :error, :response
+
+    def initialize(error, body)
+      @error = error
+      @response = body
+    end
+
+    def success?
+      @error.nil?
+    end
+
+    def failure?
+      !success?
+    end
+  end
+end

data/lib/cmux/mux.rb

@@ -0,0 +1,69 @@
+module CMUX
+  class MUX
+    def initialize(device)
+      begin
+        @connection = CMUX::Connection.new
+        @connection.open device
+
+        io = CMUX::IO.open_tty device
+        begin
+          # Magic!
+
+          # Modem will lose synchronization if previous session was interrupted
+          # in the middle of frame, and it will resync only at start of second
+          # frame.
+          2.times do
+            # Send 'AT' to ensure proper autobaud after DTR rise in the AT mode.
+            io.write "AT\r"
+
+            # Terminate GSM 07.10 simple multiplexer.
+            # Will be ignored by modem in the AT mode.
+            io.write "\xf9\x03\xef\x05\xc3\x01\xf2\xf9"
+            io.flush
+
+            # Read any crap from the buffer
+            until ::IO.select([ io ], [], [], 0.2).nil?
+              io.read_nonblock 2048
+            end
+          end
+
+          chatter = CMUX::ModemChatter.new io
+
+          all_done = false
+
+          chatter.command("&D2+IPR=115200;+CMUX=0", 5) do |resp|
+            if resp.failure?
+              raise "CMUX failed: #{resp.error}"
+            else
+              all_done = true
+            end
+          end
+
+          until all_done
+            CMUX::ModemChatter.poll [ chatter ]
+          end
+        ensure
+          io.close
+        end
+
+        @connection.activate
+      rescue Exception => e
+        @connection.close
+
+        raise e
+      end
+    end
+
+    def close
+      @connection.close
+    end
+
+    def allocate(channel)
+      Channel.new @connection.open_port(channel), channel, self
+    end
+
+    def close_port(channel)
+      @connection.close_port channel
+    end
+  end
+end

data/lib/cmux/version.rb

@@ -0,0 +1,3 @@
+module CMUX
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: cmux
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sergey Gridasov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby bindings for CMUX, GSM 07.10 multiplexer
+email:
+- grindars@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cmux.gemspec
+- lib/cmux.rb
+- lib/cmux/channel.rb
+- lib/cmux/connection.rb
+- lib/cmux/io.rb
+- lib/cmux/library.rb
+- lib/cmux/modem_chatter.rb
+- lib/cmux/modem_command.rb
+- lib/cmux/modem_command_response.rb
+- lib/cmux/mux.rb
+- lib/cmux/version.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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for CMUX, GSM 07.10 multiplexer
+test_files: []