my_gpsd_client 0.02.03 → 0.02.08

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deb1eb0758c13fb908e9ac239ba2e84f1ddbe23507400bbfc4774eb9c529ef06
-  data.tar.gz: f69f14b3c0cc30e8827fb97076eb067fc12131950bd859f15ece5bcad1299c33
+  metadata.gz: 344365d55d636550821b173a6de9b95724c32cf3d5f5ccd9f3aba48271523ab8
+  data.tar.gz: 49b25953b00050f46bc717f36173b3afd57362e6b1d6a5acc501f79ee329c4f4
 SHA512:
-  metadata.gz: e8521af40063d27ae44db6f4f0ffa3a56bf4da309f0efb0d03e883229ae3554ea695964aad9177fce7b9da4fcd050f2f00ff52e2de0c9ad103ef7044af3e35a3
-  data.tar.gz: 94037574dd6f7e6a07e33bc52b8908d1abddb4879bc8bbb70f9b762d49d2e0223ed113c433908948e0578802c0b7106ef219d46f10fe37ac9dd812eae2cf4007
+  metadata.gz: a24acac04267b68fd530f34b70b34c4db6f93520bc6930c124a43fdca89217818f4c9a41432f382826e00fc5e6901bde290fb330ee2fb8bc087b24e03cb8b915
+  data.tar.gz: d9bbecef22de226e0d205e8bfd81dc597ad0ccf8e80d0716f6bbe1ca9e90b990d0f0e5472d82993fabf08d680cef87cdee2e818d27298735dc88dd07b13ad269

data/lib/my_gpsd_client.rb

@@ -5,14 +5,23 @@ require 'date'
 require 'logger'
 
 class MyGpsdClient
-  attr_accessor :host, :port, :command, :log_level, :min_speed, :watchdog_max, :watchdog_force
-  attr_reader :version, :last_watch, :socket_ready, :msg_counts, :watchdog_fired_count
+  attr_accessor :host, :port, :command, :min_speed, :watchdog_max, :watchdog_force, :watchdog_euthanized,
+                :log_progname, :log_level, :log_path, :log_format, :log_time_format
+  attr_reader   :version, :last_watch, :socket_ready, :socket, :msg_counts, :watchdog_fired_count,
+                :readthread, :socket_init_thread, :watchdogthread, :watchdog_count
+
 
   DEFAULT_HOST = 'localhost'
   DEFAULT_PORT = 2947
-  DEFAULT_WATCH = {"enable":false,"json":false,"nmea":false}
-  DEFAULT_LOG_LEVEL = 0
+  DEFAULT_WATCH = {"class":"WATCH", "enable":false,"json":false,"nmea":false}
   DEFAULT_WATCHDOG_MAX = 5.0
+
+  DEFAULT_LOG_PROGNAME = "MyGpsdClient"
+  DEFAULT_LOG_LEVEL = Logger::DEBUG
+  DEFAULT_LOG_PATH = 'log/MyGpsdClient.log'
+  DEFAULT_LOG_FORMAT = ''
+  DEFAULT_LOG_TIME_FORMAT = '%Y-%m-%d %T.%N %z %Z'
+
   WATCHDOG_STEP = 0.1 # Check watchdog ten times per second
 
   THREAD_NAMES = {    # Keep displayed names the same length
@@ -23,6 +32,8 @@ class MyGpsdClient
    }
   Thread.current[:name]=THREAD_NAMES[:MainThread]
 
+  @@logger = nil
+
 
   # A simple gpsd client that dump's json objects contianing all info received from the gpsd deamon
   # you need to at least setup either the raw callback (on_raw_change) or position callback (on_position_change) to use GPSD2JSON. the raw callback just passes the json objects it received from the daemon on to the block you pass it. the on_position_change and on_satellites_change are a bit easier to use.
@@ -44,7 +55,12 @@ class MyGpsdClient
     @host = host
     @port = port
     @last_watch = watch
+
     @log_level = log_level
+    @log_path = DEFAULT_LOG_PATH
+    @log_format = DEFAULT_LOG_FORMAT
+    @log_time_format = DEFAULT_LOG_TIME_FORMAT
+    @log_progname = DEFAULT_LOG_PROGNAME
 
     @socket = nil
     @socket_ready = false
@@ -55,6 +71,7 @@ class MyGpsdClient
     @watchdog_max = DEFAULT_WATCHDOG_MAX
     @watchdog_fired_count = 0
     @watchdog_force = false
+    @watchdog_euthanized = false
     @min_speed = 0 # speed needs to be higher than this to make the gps info count
     @last = nil #last gps info
     @sats = nil # last satellites info
@@ -68,13 +85,12 @@ class MyGpsdClient
                   toff: 0, pol: 0, pps: 0, dev: 0, devs: 0, err: 0,
                   unk: 0}
 
-    MyGpsdClient.logger.progname = MyGpsdClient
-    MyGpsdClient.logger.level = @log_level
+    @logger = new_logger path: @log_path, progname: @log_progname, time_format: @log_time_format, level: @log_level
     my_logger level: 'info', msg: "MyGpsdClient Gem - Version: #{@version}"
   end
 
   #
-  # Receive Commands from User
+  # attribute_writters additional actions
   #
   def command=(val)
     @command = val
@@ -85,9 +101,34 @@ class MyGpsdClient
 
   def log_level=(val)
     @log_level = val
-    MyGpsdClient.logger.level = @log_level
+    @logger.level = @log_level
+  end
+
+  def log_progname=(val)
+    @log_progname = val
+    @logger.progname = @log_progname
   end
 
+  def log_format=(val)
+    @log_format = val
+    @logger.format = @log_format
+  end
+
+  def log_time_format=(val)
+    @log_time_format = val
+    @logger.datetime_format = @log_time_format
+  end
+
+  def log_path=(val)
+    @log_path = val
+    @logger = new_logger path: @log_path, progname: @log_progname, time_format: @log_time_format, level: @log_level
+  end
+  #
+  # End attribute_writters additional actions
+  #
+
+
+
   def log_marker level: 'debug', msg: "Log Marker"
     my_logger level: level, msg: "~~~~~~~~~~~~~~~~~~~~~~~ #{msg} ~~~~~~~~~~~~~~~~~~~~~~~"
   end
@@ -119,11 +160,16 @@ class MyGpsdClient
     else
       # it's ready, tell it to start watching and passing
       my_logger  msg:  "Send_cmmd: socket ready, send cmmd"
-      str = "?#{@command[:class].upcase}=#{@command.to_json}"
+      if @command.size > 1
+        str = "?#{@command[:class].upcase}=#{@command.to_json}"
+      else
+        str = "?#{@command[:class].upcase};"
+      end
       my_logger level: 'info', msg:  "Send_cmmd: sending: #{str}"
       @sent_raw_callback.call( str) if @sent_raw_callback
       @socket.puts str
       # If Enable was false in the last WATCH command, close the connecction
+      my_logger msg: "@last_watch.key?(:enable) #{@last_watch.key?(:enable)}, @last_watch[:enable] #{@last_watch[:enable]}"
       stop if @last_watch.key?(:enable) && !@last_watch[:enable]
     end
     my_logger  msg:  "Send_cmmd: Exiting send_cmmd"
@@ -178,43 +224,48 @@ class MyGpsdClient
 
     #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     # background thread to implement a watchdog timer
-    my_logger  msg:  "Start: Starting Watchdog Thread"
-    @watchdogthread = Thread.start do
-      Thread.current[:name]=THREAD_NAMES[:WatchdogThread]
-      my_logger  msg:  "Watchdog Thread: #{Thread.current[:name]}"
-      @watchdog_count = 0.0
-      @watchdog_enabled = true
-      while @watchdog_enabled do
-        if @watchdog_force
-          @watchdog_force = false
-          # force the watchdog to fire by killing the socket
-          @socket.close if @socket && !@socket.closed?
-          #@watchdog_count = @watchdog_max
-        end
-        if (@watchdog_count += WATCHDOG_STEP) >= @watchdog_max
-          my_logger level: 'warn', msg:  "Watchdog Fired"
-          @watchdog_count = 0.0
-          @watchdog_fired_count += 1
-          @watchdog_enabled = false
-          # Kill the readthread...
-          my_logger msg: "Watchdog Thread: Killing ReadThread"
-          Thread.kill(@readthread) if @readthread && @readthread.alive?
-          if @last_watch[:enable]
-            stop
-            sleep 0.5
-            my_logger msg: "Watchdog Thread: Send Last_Watch: #{@last_watch}"
-            @command = @last_watch
-            send_cmmd
-            my_logger msg: "Watchdog Thread: Thread.exit"
-            Thread.exit
-          else
-            close_socket
+    if @watchdog_euthanized
+      my_logger msg: "Watchdog has been euthanized!"
+    else
+      my_logger  msg:  "Start: Starting Watchdog Thread"
+      @watchdogthread = Thread.start do
+        Thread.current[:name]=THREAD_NAMES[:WatchdogThread]
+        my_logger  msg:  "Watchdog Thread: #{Thread.current[:name]}"
+        @watchdog_count = 0.0
+        @watchdog_enabled = true
+        while @watchdog_enabled && !@watchdog_euthanized do
+          my_logger msg: "Watchdog Thread: Watchdog Tick"
+          if @watchdog_force
+            @watchdog_force = false
+            # force the watchdog to fire by killing the socket
+            @socket.close if @socket && !@socket.closed?
+            #@watchdog_count = @watchdog_max
           end
-        end
-        sleep WATCHDOG_STEP
-      end   # while
-      my_logger msg: "Closing Watchdog Thread"
-    end   # watchdog thread
+          if (@watchdog_count += WATCHDOG_STEP) >= @watchdog_max
+            my_logger level: 'warn', msg:  "Watchdog Fired"
+            @watchdog_count = 0.0
+            @watchdog_fired_count += 1
+            @watchdog_enabled = false
+            # Kill the readthread...
+            my_logger msg: "Watchdog Thread: Killing ReadThread"
+            Thread.kill(@readthread) if @readthread && @readthread.alive?
+            if @last_watch[:enable]
+              stop
+              sleep 0.5
+              my_logger msg: "Watchdog Thread: Send Last_Watch: #{@last_watch}"
+              @command = @last_watch
+              send_cmmd
+              my_logger msg: "Watchdog Thread: Thread.exit"
+              Thread.exit
+            else
+              close_socket
+            end
+          end
+          sleep WATCHDOG_STEP
+        end   # while Wchdog enabled
+        my_logger msg: "Closing Watchdog Thread"
+      end # wtchdg thread start do
+    end   # watchdog euthanize if
     #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     my_logger  msg:  "Start: Exiting Start"
@@ -452,16 +503,28 @@ LOG_LEVELS = {debug: Logger::DEBUG, info: Logger::INFO, warn: Logger::WARN,
       error: Logger::ERROR, fatal: Logger::FATAL, unknown: Logger::UNKNOWN}
 
   def my_logger(level: 'debug', msg: "Blank")
-    MyGpsdClient.logger.add (LOG_LEVELS[level.to_sym]) {"#{Thread.current[:name]} -- #{msg}"}
+    @logger.add (LOG_LEVELS[level.to_sym]) {"#{Thread.current[:name]} -- #{msg}"}
+  end
+
+  def new_logger( progname: nil, path:, format: nil, time_format: nil, level:  LOG_LEVELS[:debug])
+    logger = Logger.new(path)
+    logger.progname = progname if progname
+    logger.format = format if format
+    logger.level = level if level
+    logger.datetime_format = time_format if time_format
+    logger
   end
 
+=begin
   def self.logger
+    puts "In self.logger: log_path => #{@log_path}, @@logger.nil? => #{@@logger.nil?}"
     @@logger ||= defined?(Rails) ? Rails.logger : Logger.new("log/MyGpsdClient.log")
+    puts "Exiting self.logger: @@logger => #{@@logger}"
   end
 
   def self.logger=(logger)
     @@logger = logger
   end
-
+=end
 
 end

data/lib/my_gpsd_client/version.rb

@@ -1,3 +1,3 @@
 class MyGpsdClient_version
-  VERSION = "0.02.03"
+  VERSION = "0.02.08"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_gpsd_client
 version: !ruby/object:Gem::Version
-  version: 0.02.03
+  version: 0.02.08
 platform: ruby
 authors:
 - Steven Finnegan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler