sim_card 0.0.3 → 0.1.1

data/lib/sim_card.rb

@@ -5,6 +5,11 @@ end
 require 'date'
 
 root = File.join(File.dirname(__FILE__), 'sim_card')
+require File.join(root, 'error.rb')
 require File.join(root, 'received_sms_message.rb')
 require File.join(root, 'sim.rb')
-require File.join(root, 'signal_quality.rb')
+require File.join(root, 'signal_quality.rb')
+require File.join(root, 'phonebook.rb')
+require File.join(root, 'phonebook_entry.rb')
+require File.join(root, 'at_interface.rb')
+require File.join(root, 'real_at_interface.rb')

data/lib/sim_card/received_sms_message.rb

@@ -3,7 +3,8 @@ class SimCard
     
     # parse raw output from SIM card and return list of ReceivedSmsMessage instances.
     # see SimCardTest for examples of raw SIM output.
-    def self.to_messages raw_sim_output
+    def self.load_messages  at_command_sender
+      raw_sim_output = at_command_sender.send "AT+CMGL=\"ALL\""
       messages = []
       raw_input2 = raw_sim_output[14..-1] # remove initial AT+CMGL="ALL"\n
       raw_input3 = (raw_input2 || '').split('+CMGL: ')[1..-1]

data/lib/sim_card/signal_quality.rb

@@ -2,8 +2,8 @@ class SimCard
   class SignalQuality
     attr_reader :signal_strength
 
-    def initialize raw_sim_output
-      @raw_sim_output = raw_sim_output
+    def initialize at_interface
+      @at_interface = at_interface
       @signal_strength = nil
       @bit_error_rate_min = nil
       @bit_error_rate_max = nil
@@ -12,7 +12,8 @@ class SimCard
 
     private 
     def parse
-      a = @raw_sim_output.split("\n")
+      response = @at_interface.send 'AT+CSQ'
+      a = response.split("\n")
       if a[1] && a[1].include?('+CSQ: ')
         b = a[1].match /(\d+),(\d+)/
         if b.size == 3

data/lib/sim_card/sim.rb

@@ -1,6 +1,6 @@
 class SimCard
   
-  # code below is based on:
+  # the initial idea is borrowed from here:
   # http://www.dzone.com/snippets/send-and-receive-sms-text
 
   class Sim
@@ -8,19 +8,24 @@ class SimCard
     # connect to SIM card. user_options may contain:
     # * port : device where the gsm modem is connected, default is '/dev/ttyUSB0'
     # * speed : connection speed in bauds, default is 9600
-    # * pin : pin to your sim card, default is '0000'
+    # * pin : pin code to your sim card. not required if your sim does not require authorization via pin
     # * sms_center_no : SMS center of you provider. required only if you want to send SMS messages
+    # * debug_mode: when set to true, will print all communication with SIM card to stdout
     def initialize(user_options = {})
-      default_options = {:port => '/dev/ttyUSB0', :speed => 9600, :pin => '0000'}
+      default_options = {:port => '/dev/ttyUSB0', :speed => 9600}
       options = default_options.merge user_options
       
-      @port = SerialPort.new(options[:port], options[:speed])
-      send_raw_at_command("AT")
-      send_raw_at_command("AT+CPIN=\"#{options[:pin]}\"")
+      @port = SerialPort.new options[:port], options[:speed]
+      
+      debug_mode = (options[:debug_mode] == true)
+      @at_interface = RealAtInterface.new @port, debug_mode
+      
+      initial_check
+      authorize options[:pin]
       # Set to text mode
-      send_raw_at_command("AT+CMGF=1")
+      @at_interface.send "AT+CMGF=1"
       # Set SMSC number
-      send_raw_at_command("AT+CSCA=\"#{options[:sms_center_no]}\"") if options[:sms_center_no]
+      @at_interface.send "AT+CSCA=\"#{options[:sms_center_no]}\"" if options[:sms_center_no]
     end
   
     # correctly disconnect from SIM card
@@ -28,48 +33,67 @@ class SimCard
       @port.close
     end
 
+    # send SMS message
     def send_sms number, message_text
-      send_raw_at_command("AT+CMGS=\"#{number}\"")
-      send_raw_at_command("#{message_text[0..140]}#{26.chr}\r\r")
+      @at_interface.send "AT+CMGS=\"#{number}\""
+      @at_interface.send "#{message_text[0..140]}#{26.chr}\r\r"
       sleep 3
-      wait
-      send_raw_at_command("AT")
+      @at_interface.send "AT"
     end
   
     # list SMS messages in SIM memory
     def sms_messages
-      raw_sim_output = send_raw_at_command("AT+CMGL=\"ALL\"")
-      ReceivedSmsMessage.to_messages raw_sim_output
+      ReceivedSmsMessage.load_messages @at_interface
+    end
+    
+    # return instance of Phonebook
+    def phonebook
+      Phonebook.new @at_interface
     end
     
     # remove SMS message from SIM card memory
     # * sms_message: instance of SimCard::SmsMessage to be deleted
     def delete_sms_message sms_message
-      send_raw_at_command("AT+CMGD=#{sms_message.message_id}")
+      @at_interface.send "AT+CMGD=#{sms_message.message_id}"
     end
     
-    # in dBm. -60 is almost perfect signal, -112 is very poor (call dropping bad)
+    # signal strengh in dBm. -60 is almost perfect signal, -112 is very poor (call dropping bad)
     def signal_strength
-      raw_sim_output = send_raw_at_command 'AT+CSQ'
-      sq = SimCard::SignalQuality.new raw_sim_output
+      sq = SimCard::SignalQuality.new @at_interface
       return sq.signal_strength
     end
-
+    
+    # for hackers
     def send_raw_at_command cmd
-      # puts "SIM CMD IN:#{cmd}"
-      @port.write(cmd + "\r")
-      wait
+      @at_interface.send cmd
     end
     
     private
-    def wait
-      buffer = ''
-      while IO.select([@port], [], [], 0.25)
-        chr = @port.getc.chr;
-        buffer += chr
+    
+    def initial_check
+      response = @at_interface.send "AT"
+      if response.include?("OK")
+        return true
+      else
+        raise Error.new("SIM is not responsing properly to initial handshake. response: #{response.inspect}")
+      end
+    end
+    
+    def authorize pin
+      auth_status = @at_interface.send "AT+CPIN?"
+      if auth_status.include?('READY')
+        # no pin required or already authorized
+        return true
+      elsif auth_status.include?('SIM PIN')
+        response = @at_interface.send "AT+CPIN=\"#{pin}\""
+        if response.include?('OK')
+          return true
+        else
+          raise Error.new("SIM authorization failed: #{response.inspect}")
+        end
+      else
+        raise Error.new("unknown SIM authorization status: #{auth_status.inspect}")
       end
-      # puts "SIM OUT:#{buffer}"
-      buffer
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sim_card
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-09-07 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: