adammck-rubygsm 0.4 → 0.41

data/lib/rubygsm/core.rb

@@ -84,11 +84,17 @@ class Modem
 		# someone else, like a commander
 		@incoming = []
 		
-		# initialize the modem
-		command "ATE0"      # echo off
-		command "AT+CMEE=1" # useful errors
-		command "AT+WIND=0" # no notifications
-		command "AT+CMGF=1" # switch to text mode
+		# initialize the modem; rubygsm is (supposed to be) robust enough to function
+		# without these working (hence the "try_"), but they make different modems more
+		# consistant, and the logs a bit more sane.
+		try_command "ATE0"      # echo off
+		try_command "AT+CMEE=1" # useful errors
+		try_command "AT+WIND=0" # no notifications
+		
+		# PDU mode isn't supported right now (although
+		# it should be, because it's quite simple), so
+		# switching to text mode (mode 1) is MANDATORY
+		command "AT+CMGF=1"
 	end
 	
 	
@@ -98,7 +104,9 @@ class Modem
 	
 	
 	INCOMING_FMT = "%y/%m/%d,%H:%M:%S%Z" #:nodoc:
-	
+	CMGL_STATUS = "REC UNREAD" #:nodoc:
+
+
 	def parse_incoming_timestamp(ts)
 		# extract the weirdo quarter-hour timezone,
 		# convert it into a regular hourly offset
@@ -125,17 +133,17 @@ class Modem
 				next
 			end
 			
-			# since this line IS a CMT string (an incomming
+			# since this line IS a CMT string (an incoming
 			# SMS), parse it and store it to deal with later
 			unless m = lines[n].match(/^\+CMT: "(.+?)",.*?,"(.+?)".*?$/)
-				err = "Couldn't parse CMT data: #{buf}"
+				err = "Couldn't parse CMT data: #{lines[n]}"
 				raise RuntimeError.new(err)
 			end
 			
 			# extract the meta-info from the CMT line,
 			# and the message from the FOLLOWING line
 			from, timestamp = *m.captures
-			msg = lines[n+1].strip
+			msg_text = lines[n+1].strip
 			
 			# notify the network that we accepted
 			# the incoming message (for read receipt)
@@ -153,12 +161,13 @@ class Modem
 				log "Receipt acknowledgement (CNMA) was rejected"
 			end
 			
-			# we might abort if this is
+			# we might abort if this part of a
+			# multi-part message, but not the last
 			catch :skip_processing do
 			
 				# multi-part messages begin with ASCII char 130
-				if (msg[0] == 130) and (msg[1].chr == "@")
-					text = msg[7,999]
+				if (msg_text[0] == 130) and (msg_text[1].chr == "@")
+					text = msg_text[7,999]
 					
 					# ensure we have a place for the incoming
 					# message part to live as they are delivered
@@ -174,24 +183,25 @@ class Modem
 					
 					# abort if this is not the last part
 					throw :skip_processing\
-						unless (msg[5] == 173)
+						unless (msg_text[5] == 173)
 					
 					# last part, so switch out the received
 					# part with the whole message, to be processed
 					# below (the sender and timestamp are the same
 					# for all parts, so no change needed there)
-					msg = @multipart[from].join("")
+					msg_text = @multipart[from].join("")
 					@multipart.delete(from)
 				end
 				
 				# just in case it wasn't already obvious...
-				log "Received message from #{from}: #{msg}"
+				log "Received message from #{from}: #{msg_text.inspect}"
 			
 				# store the incoming data to be picked up
 				# from the attr_accessor as a tuple (this
 				# is kind of ghetto, and WILL change later)
 				sent = parse_incoming_timestamp(timestamp)
-				@incoming.push Gsm::Incoming.new(self, from, sent, msg)
+				msg = Gsm::Incoming.new(self, from, sent, msg_text)
+				@incoming.push(msg)
 			end
 			
 			# drop the two CMT lines (meta-info and message),
@@ -309,7 +319,7 @@ class Modem
 		# then automatically re-try the command after
 		# a short delay. for others, propagate
 		rescue Error => err
-			log "Rescued: #{err.desc}"
+			log "Rescued (in #command): #{err.desc}"
 			
 			if (err.type == "CMS") and (err.code == 515)
 				sleep 2
@@ -322,6 +332,24 @@ class Modem
 	end
 	
 	
+	# proxy a single command to #command, but catch any
+	# Gsm::Error exceptions that are raised, and return
+	# nil. This should be used to issue commands which
+	# aren't vital - of which there are VERY FEW.
+	def try_command(cmd, *args)
+		begin
+			log_incr "Trying Command: #{cmd}"
+			out = command(cmd, *args)
+			log_decr "=#{out}"
+			return out
+			
+		rescue Error => err
+			log_then_decr "Rescued (in #try_command): #{err.desc}"
+			return nil
+		end
+	end
+	
+	
 	def query(cmd)
 		log_incr "Query: #{cmd}"
 		out = command cmd
@@ -754,7 +782,9 @@ class Modem
 	#
 	# Starts a new thread, which polls the device every _interval_
 	# seconds to capture incoming SMS and call _callback_method_
-	# for each.
+	# for each, and polls the device's internal storage for incoming
+	# SMS that we weren't notified about (some modems don't support
+	# that).
 	#
 	#   class Receiver
 	#     def incoming(msg)
@@ -783,12 +813,17 @@ class Modem
 			# keep on receiving forever
 			while true
 				command "AT"
-				
-				# enable new message notification mode
-				# every ten intevals, in case the
+
+				# enable new message notification mode every ten intevals, in case the
 				# modem "forgets" (power cycle, etc)
 				if (@polled % 10) == 0
-					command "AT+CNMI=2,2,0,0,0"
+					try_command("AT+CNMI=2,2,0,0,0")
+				end
+				
+				# check for new messages lurking in the device's
+				# memory (in case we missed them (yes, it happens))
+				if (@polled % 4) == 0
+					fetch_stored_messages
 				end
 				
 				# if there are any new incoming messages,
@@ -822,5 +857,58 @@ class Modem
 		# threaded (like debugging handsets)
 		@thr.join if join_thread
 	end
+	
+  
+	def fetch_stored_messages
+		
+		# fetch all/unread (see constant) messages
+		lines = command('AT+CMGL="%s"' % CMGL_STATUS)
+		n = 0
+		
+		# if the last line returned is OK
+		# (and it SHOULD BE), remove it
+		lines.pop if lines[-1] == "OK"
+		
+		# keep on iterating the data we received,
+		# until there's none left. if there were no
+		# stored messages waiting, this done nothing!
+  	while n < lines.length
+  		
+  		# attempt to parse the CMGL line (we're skipping
+  		# two lines at a time in this loop, so we will
+  		# always land at a CMGL line here) - they look like:
+			#   +CMGL: 0,"REC READ","+13364130840",,"09/03/04,21:59:31-20"
+			unless m = lines[n].match(/^\+CMGL: (\d+),"(.+?)","(.+?)",*?,"(.+?)".*?$/)
+				err = "Couldn't parse CMGL data: #{lines[n]}"
+				raise RuntimeError.new(err)
+			end
+			
+			# find the index of the next
+			# CMGL line, or the end
+			nn = n+1
+			nn += 1 until\
+				nn >= lines.length ||\
+				lines[nn][0,6] == "+CMGL:"
+			
+			# extract the meta-info from the CMGL line, and the
+			# message text from the lines between _n_ and _nn_
+			index, status, from, timestamp = *m.captures
+			msg_text = lines[(n+1)..(nn-1)].join("\n").strip
+  		
+			# log the incoming message
+			log "Fetched stored message from #{from}: #{msg_text.inspect}"
+  		
+			# store the incoming data to be picked up
+			# from the attr_accessor as a tuple (this
+			# is kind of ghetto, and WILL change later)
+			sent = parse_incoming_timestamp(timestamp)
+			msg = Gsm::Incoming.new(self, from, sent, msg_text)
+			@incoming.push(msg)
+  		
+  		# skip over the messge line(s),
+  		# on to the next CMGL line
+  		n = nn
+  	end
+	end
 end # Modem
 end # Gsm

data/rubygsm.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 	s.name     = "rubygsm"
-	s.version  = "0.4"
-	s.date     = "2009-01-29"
+	s.version  = "0.41"
+	s.date     = "2009-03-05"
 	s.summary  = "Send and receive SMS with a GSM modem"
 	s.email    = "adam.mckaig@gmail.com"
 	s.homepage = "http://github.com/adammck/rubygsm"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adammck-rubygsm
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: "0.41"
 platform: ruby
 authors: 
 - Adam Mckaig
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-29 00:00:00 -08:00
+date: 2009-03-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: toholio-serialport
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: