iprog_sms 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90b96ab4208fd86918b9b66a42e2b3d18153f93774e771da7db5ea33076652ae
-  data.tar.gz: bb92a9bd4c9da6a8931f09f7a97bcb59eab08c4fbdd76f362de65543ba857c18
+  metadata.gz: 3dbc858e8d39453fd6c0fc37cd608bb11e1de15cbdd0abaa61c3644c61515f35
+  data.tar.gz: 3a8bb09fbc5a8cc46754034a05d629b282944ee7fc3e03c6c2994dd28b6393c1
 SHA512:
-  metadata.gz: '090c37cbbccef0b31f8f219bb8ce12d386e44a21ffbc9725e29b1be8e198bef6a437b8c692c84dc35f7d9346d9ca2333e7e724428b48abc92d2cbe5a240e2e3a'
-  data.tar.gz: d72af85bf9271c25a1dfb9548f3a9a086a3dfc678d4e4fc6402b161adcb577f656e839bfe697c05f9dd22ae20d2c7bf4971e986f73603df2c49f25e6d7d9c1e4
+  metadata.gz: 7f93d1cde5d157272a7409f1919c57d3d74947184feda65959d9c3fad5d5217bbafff9ca72fc84357e04a89f8e7d98639ebd64f386b012bb187151bdde122ca8
+  data.tar.gz: 1236837762de8303d51fab8753f6ac1c92927d2480b05fdd518521434e5f67f0134817abc00bad4d80089dfbcb837ce32f9a6fbc9eb9e7038c19b37bf345cc04

data/bin/iprog_send_sms

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/iprog_sms'
+
+# Welcome message
+puts "Welcome to IPROG SMS Sender!"
+
+# Prompt for phone number
+print "Enter the phone number to send SMS: "
+phone_number = gets.chomp
+
+# Prompt for message
+print "Enter the message to send: "
+message = gets.chomp
+message = message.empty? ? "Test message form IPROG SMS" : message
+
+# Optional: Prompt for the serial port (useful if there are multiple ports)
+print "Enter the serial port for SIM800C (or press Enter to use default /dev/tty.usbserial-1120): "
+port = gets.chomp
+port = port.empty? ? "/dev/tty.usbserial-1120" : port
+
+# Initialize SMS sender with the specified or default port
+sms = IprogSms::SMS.new(port)
+
+# Check if SIM800C is connected
+if sms.connected?
+  puts "SIM800C module detected! Sending SMS..."
+  success = sms.send_sms(phone_number, message) 
+ 
+  if success && !sms.error_message
+    puts "SMS sent successfully."
+  else
+    puts "Failed to send SMS: #{sms.error_message}"
+  end
+
+  puts success.inspect
+else
+  puts "SIM800C module not detected. Please check your connection."
+end

data/bin/iprog_send_sms_from_api

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/iprog_sms'
+
+# Welcome message
+puts "Welcome to IPROG SMS Sender with API!"
+
+# Prompt for API URL
+print "Enter the API URL to fetch SMS details: "
+api_url = gets.chomp
+
+# Initialize the SMS sender with API
+sender = IprogSms::Sender.new(api_url)
+
+# Check if SIM800C is connected
+if sender.instance_variable_get(:@sms_sender).connected?
+  puts "SIM800C module detected! Fetching SMS details from API and sending..."
+  sender.send_sms_from_api
+  puts "SMS sent successfully!"
+else
+  puts "SIM800C module not detected. Please check your connection."
+end

data/bin/iprog_sms_troubleshoot

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'iprog_sms'
+
+# Ensure that a port argument is provided
+if ARGV.empty?
+  puts "Usage: iprog_sms_troubleshoot <port>"
+  puts "Example: iprog_sms_troubleshoot /dev/tty.usbserial-1120"
+  exit(1)
+end
+
+# Get the serial port from the command-line arguments
+port_str = ARGV[0]
+
+# Run the troubleshooting method
+IprogSms.troubleshoot_sim800c(port_str)

data/lib/iprog_sms/sim800c_troubleshoot.rb

@@ -0,0 +1,107 @@
+# lib/iprog_sms/sim800c_troubleshoot.rb
+require 'rubyserial'
+
+module IprogSms
+  module Sim800cTroubleshoot
+    # Sends an AT command to the SIM800C and reads the response
+    def self.send_at_command(serial, command, wait_time = 1)
+      puts "Sending command: #{command}"
+      serial.write("#{command}\r")
+      sleep(wait_time)
+      response = serial.read(1000)
+      puts "Response: #{response}"
+      response
+    rescue StandardError => e
+      puts "Error sending command #{command}: #{e.message}"
+      nil
+    end
+
+    # Set message storage location to SIM card
+    def self.set_message_storage(serial)
+      response = send_at_command(serial, 'AT+CPMS="SM","SM","SM"')
+      if response&.include?("OK")
+        puts "Message storage set to SIM card (SM)."
+      else
+        puts "Failed to set message storage location."
+      end
+    end
+
+    # Set message format to text mode
+    def self.set_text_mode(serial)
+      response = send_at_command(serial, "AT+CMGF=1")
+      if response&.include?("OK")
+        puts "Message format set to Text Mode."
+      else
+        puts "Failed to set message format to Text Mode."
+      end
+    end
+
+    # Check signal strength
+    def self.check_signal_strength(serial)
+      response = send_at_command(serial, "AT+CSQ")
+      if response&.include?("+CSQ")
+        signal_strength = response.match(/\+CSQ: (\d+)/)[1].to_i
+        puts "Signal strength: #{signal_strength}"
+        if signal_strength < 10
+          puts "Warning: Low signal strength may affect message delivery."
+        else
+          puts "Signal strength is adequate."
+        end
+      else
+        puts "Failed to retrieve signal strength."
+      end
+    end
+
+    # List all messages in the inbox
+    def self.list_messages(serial)
+      response = send_at_command(serial, 'AT+CMGL="ALL"')
+      if response&.include?("+CMGL")
+        puts "Messages in inbox:\n#{response}"
+      else
+        puts "No messages found in the inbox or unable to retrieve messages."
+      end
+    end
+
+    # Restart the SIM800C module (if supported)
+    def self.restart_module(serial)
+      response = send_at_command(serial, "AT+CFUN=1,1")
+      if response&.include?("OK")
+        puts "Module restarted successfully."
+      else
+        puts "Failed to restart the module. Try manually if this command is unsupported."
+      end
+    end
+
+    # Main troubleshooting function
+    def self.troubleshoot_sim800c(port_str)
+      begin
+        serial = Serial.new(port_str, 9600) # Adjust baud rate if necessary
+        puts "Starting SIM800C troubleshooting..."
+
+        # Step 1: Set message storage to SIM card
+        set_message_storage(serial)
+
+        # Step 2: Set message format to Text Mode
+        set_text_mode(serial)
+
+        # Step 3: Check signal strength
+        check_signal_strength(serial)
+
+        # Step 4: List all messages in the inbox
+        list_messages(serial)
+
+        # Step 5: Restart the module if needed
+        puts "Do you want to restart the module? (y/n)"
+        if gets.chomp.downcase == 'y'
+          restart_module(serial)
+        end
+
+      rescue StandardError => e
+        puts "Error: #{e.message}"
+      ensure
+        serial&.close
+        puts "Troubleshooting complete."
+      end
+    end
+  end
+end

data/lib/iprog_sms/sms.rb

@@ -5,33 +5,57 @@ require 'rubyserial'
 
 module IprogSms
   class SMS
-    def initialize
+    attr_reader :error_message
+
+    def initialize(port_str = "/dev/ttyUSB0")
       @baud_rate = 9600
-      @port_str = detect_sim800c || "/dev/ttyUSB0"  # Detect SIM800C port automatically
+      @port_str = port_str  # Use the passed port, or default to "/dev/ttyUSB0"
+      @error_message = nil   # Initialize error message
     end
 
     def send_sms(phone_number, message)
+      @error_message = nil   # Reset error message before sending
+
       if connected?
         begin
           # Open the serial connection
           serial = Serial.new(@port_str, @baud_rate)
+          result_status = false
 
-          # Set SMS to text mode
-          send_at_command(serial, "AT+CMGF=1")
+          # Set SMS to text mode with a shorter delay
+          send_at_command(serial, "AT+CMGF=1", 3)
 
           # Specify the recipient phone number
-          send_at_command(serial, "AT+CMGS=\"#{phone_number}\"")
+          response = send_at_command(serial, "AT+CMGS=\"#{phone_number}\"", 3)
+          unless response.include?(">")
+            @error_message = "Failed to specify recipient. Response: #{response}"
+            result_status  = false
+          end
 
           # Send the actual SMS message, followed by Ctrl+Z (ASCII 26)
-          send_at_command(serial, "#{message}\x1A", 5)
+          response = send_at_command(serial, "#{message}\x1A", 5)
+          if response.include?("+CMGS")
+            puts "SMS successfully sent to #{phone_number}."
+            result_status = true
+          elsif response.include?("+CMS ERROR")
+            error_code = response.match(/\+CMS ERROR: (\d+)/)[1]
+            @error_message = "Failed to send SMS. Error code: #{error_code}"
+            result_status  = false
+          else
+            @error_message = "Unexpected response while sending SMS: #{response}"
+            result_status  = false
+          end
 
-          puts "SMS sent to #{phone_number}."
           serial.close
-        rescue Exception => e
-          puts "Error: #{e.message}"
+
+          result_status
+        rescue StandardError => e
+          @error_message = "Error while sending SMS: #{e.message}"
+          false
         end
       else
-        puts "SIM800C is not connected!"
+        @error_message = "SIM800C is not connected!"
+        false
       end
     end
 
@@ -41,55 +65,24 @@ module IprogSms
         response = send_at_command(serial, "AT")
         serial.close
         response.include?("OK") # Check if the response contains "OK"
-      rescue Exception => e
-        puts "Error checking connection: #{e.message}"
+      rescue StandardError => e
+        @error_message = "Error checking connection: #{e.message}"
         false
       end
     end
 
     private
 
-    def detect_sim800c
-      # List all potential serial ports (Linux/macOS). For Windows, replace with 'COM*'.
-      potential_ports = Dir['/dev/ttyUSB*'] + Dir['/dev/tty.usbserial*'] + Dir['/dev/tty.*']
-
-      potential_ports.each do |port|
-        puts "Checking port: #{port}"
-        begin
-          # Try opening the port
-          serial = Serial.new(port, @baud_rate)
-
-          # Send the AT command
-          serial.write("AT\r")
-          sleep(1) # Wait for a response
-          response = serial.read(100)
-
-          # If the response contains "OK", it's likely the SIM800C
-          if response.include?("OK")
-            puts "SIM800C detected on port: #{port}"
-            serial.close
-            return port  # Return the correct port
-          else
-            puts "No response from #{port}, moving to next port..."
-            serial.close
-          end
-        rescue StandardError => e
-          puts "Error on #{port}: #{e.message}"
-        end
-      end
-
-      # If no SIM800C is detected
-      puts "No SIM800C module detected."
-      nil
-    end
-
     def send_at_command(serial, command, wait_time = 1)
       puts "Sending command: #{command}"
       serial.write("#{command}\r")
       sleep(wait_time)
       response = serial.read(1000)
       puts "Response: #{response}"
-      return response
+      response
+    rescue StandardError => e
+      @error_message = "Error during command execution: #{e.message}"
+      ""
     end
   end
 end

data/lib/iprog_sms/version.rb

@@ -2,5 +2,5 @@
 # lib/iprog_sms/version.rb
 
 module IprogSms
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/iprog_sms.rb

@@ -5,6 +5,11 @@ require_relative "../lib/iprog_sms/version"
 require_relative "../lib/iprog_sms/sms"
 require_relative "../lib/iprog_sms/api_client"
 require_relative "../lib/iprog_sms/sender"
+require_relative '../lib/iprog_sms/sim800c_troubleshoot'
 
 module IprogSms
+ # Method to run the SIM800C troubleshooting script
+ def self.troubleshoot_sim800c(port_str)
+  IprogSms::Sim800cTroubleshoot.troubleshoot_sim800c(port_str)
+ end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iprog_sms
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Jayson Presto
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyserial
@@ -28,13 +28,20 @@ description: This gem allows you to send SMS using the SIM800C module and suppor
   fetching SMS details from an API.
 email:
 - jaysonpresto.iprog21@gmail.com
-executables: []
+executables:
+- iprog_sms_troubleshoot
+- iprog_send_sms
+- iprog_send_sms_from_api
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/iprog_send_sms
+- bin/iprog_send_sms_from_api
+- bin/iprog_sms_troubleshoot
 - lib/iprog_sms.rb
 - lib/iprog_sms/api_client.rb
 - lib/iprog_sms/sender.rb
+- lib/iprog_sms/sim800c_troubleshoot.rb
 - lib/iprog_sms/sms.rb
 - lib/iprog_sms/version.rb
 homepage: https://rubygems.org/gems/iprog_sms