mqttopia 0.1.20 → 0.1.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79c7db296f5f4dfd2db80af02eddd1d43798b0e18175aab756b150adbe38bcca
-  data.tar.gz: 189124b048379437624b76a850d97bf4d3ae23c8eed6fcca427cf1fc0275c969
+  metadata.gz: eaaf92a832470b3cfb5169cabdeda2af5538d9abd95a1bcbb15f46cde4a1432d
+  data.tar.gz: aee124311821053eaf5589e28fb6d0f630b48bec035f85d34be842237f7d5db3
 SHA512:
-  metadata.gz: 6644b34775b0a900bcd5527f5a918e7ab09a331ad747d31505f74a28df843e4edac8b3ff06240b36645cbf4a528b47d1690e7f2167a4863bc425c991fb9606d9
-  data.tar.gz: c5778d6141e09c7aaf6e95b6a86dc66c62091db9f9566b07f9224e3f610b9da76f945724ef9ef54f01fa1cf7834ecb389741e8190be276eba9e20b25ec571995
+  metadata.gz: 61356c8227cb3704a37d7d597f7df890e37b84318254d68726c19918b31da213edb0a37a905c4b58031b05c3272d99cd1242c8af537ae1612ece6f331fd6e552
+  data.tar.gz: de265791bfcc71254701dc1af96a916d3ba950ac7a6954f8dd0911a6a84d71d2c38c961f4924129c12014c48a75fc6743d5fe93c02db6412760c382078ee277f

data/.rubocop.yml

@@ -28,7 +28,7 @@ Style/ClassVars:
 Layout/LineLength:
   Max: 120
 Metrics/ClassLength:
-  Max: 120
+  Max: 150
 Metrics/MethodLength:
   Max: 30
 Metrics/AbcSize:

data/MQTT_SUBSCRIPTIONS.md

@@ -17,7 +17,7 @@ This subscription handles trip metrics and serializes the data related to trips,
     "l": 100,
     "cs": "2"
   },
-  "connt": "wf",
+  "connS":{"type":"Connected","connt":"MOBILE","subType":"LTE"},
   "pws": -1,
   "gps": -1,
   "nlog": 585,
@@ -40,7 +40,11 @@ This subscription handles trip metrics and serializes the data related to trips,
   trip_id: 123,
   metrics: {
     location_permission: "BACKGROUND_FINE",
-    connection_type: "wf",
+    connection: {
+      connection_type: "MOBILE",
+      connection_sub_type: "LTE",
+      connection_status: "Connected"
+    },
     battery: {
       battery_level: 100,
       charging_status: "UNKNOWN",
@@ -84,16 +88,6 @@ This subscription handles trip metrics and serializes the data related to trips,
     "-4": "DISABLED"
   }
   ```
-- **connection_type**
-  ```json
-  {
-    "wf": "WIFI",
-    "cel": "CELLULAR",
-    "et": "ETHERNET",
-    "nc": "NO_CONNECTION",
-    "uk": "UNKNOWN"
-  }
-  ```
 - **charging_status**
   ```json
     {
@@ -118,7 +112,7 @@ payload = {
     "l": 100,
     "cs": "2"
   },
-  "connt": "wf",
+  "connS":{"type":"Connected","connt":"MOBILE","subType":"LTE"},
   "pws": -1,
   "gps": -1,
   "nlog": 585,

data/lib/mqttopia/client.rb

@@ -23,15 +23,20 @@ module Mqttopia
       ssl: Mqttopia.ssl
     )
       @mqtt_client = MQTT::Client.new(
+        version: Mqttopia.version,
         port: port,
         username: username,
         password: password,
         ssl: ssl,
-        keep_alive: 15,
-        ack_timeout: 5
+        keep_alive: Mqttopia.keep_alive,
+        will_topic: Mqttopia.will_topic,
+        will_retain: Mqttopia.will_retain,
+        will_payload: Mqttopia.will_payload,
+        will_qos: Mqttopia.will_qos,
+        ack_timeout: Mqttopia.ack_timeout
       )
       @debugging = Mqttopia.debugging
-      @debugging_topic = "mqttopia/test/debugging"
+      @debugging_topic = Mqttopia.debugging_topic
     rescue Exception => e
       log_error("initialize", e)
     end
@@ -46,6 +51,10 @@ module Mqttopia
       disconnect_and_log("connect", e)
     end
 
+    def publish(topic, message = nil, qos = 0)
+      self.class.publish(topic, message, qos)
+    end
+
     def self.publish(topic, message = nil, qos = 0)
       client = new
       client.connect
@@ -82,6 +91,8 @@ module Mqttopia
     private
 
     def active_host(hosts = Mqttopia.hosts, port = Mqttopia.port, timeout = 10)
+      return if hosts.nil? || hosts.empty?
+
       hosts.each do |host|
         Socket.tcp(host, port, connect_timeout: timeout) do |sock|
           sock.close
@@ -93,17 +104,15 @@ module Mqttopia
       nil # Return nil if no reachable host is found
     end
 
-    def create_subscription_thread(qos)
+    def create_subscription_thread(_qos)
       Thread.new do
         mqtt_client.get do |topic, message|
-          log_debug("Received RAW message on topic #{topic}: #{message} with QOS #{qos}")
-
           response = safe_mqtt_response(topic, message)
 
           if debugging && topic.exclude?(debugging_topic)
             Mqttopia::Client.publish(debugging_topic,
                                      { 'topic_name': topic,
-                                       'mqttopia_response': response }, 2)
+                                       'mqttopia_response': response }, 0)
           end
 
           yield response if response
@@ -139,10 +148,6 @@ module Mqttopia
       Mqttopia::Logger.error("\nMqttopia::Client -> #{method}: #{error_details(error)}\n")
     end
 
-    def log_debug(message)
-      Mqttopia::Logger.debug("\n#{message}\n") if debugging
-    end
-
     def disconnect_and_log(method, error)
       disconnect
       log_error(method, error)

data/lib/mqttopia/logger.rb

@@ -7,23 +7,35 @@ module Mqttopia
     class << self
       # Initialize the logger
       def logger
-        @logger ||= Mqttopia.logger # Default to logging to STDOUT
+        @logger ||= Mqttopia.logger
+      end
+
+      def logger_level
+        @logger_level ||= Mqttopia.logger_level
       end
 
       # Allow users to set a custom logger (e.g., logging to a file)
-      attr_writer :logger
+      attr_writer :logger, :logger_level
 
       # Simple wrapper for logging debug messages
-      delegate :debug, to: :logger
+      def debug(msg)
+        logger.debug(msg) if %i[debug].include?(logger_level)
+      end
 
       # Wrapper for logging info messages
-      delegate :info, to: :logger
+      def info(msg)
+        logger.info(msg) if %i[debug info].include?(logger_level)
+      end
 
       # Wrapper for logging warn messages
-      delegate :warn, to: :logger
+      def warn(msg)
+        logger.warn(msg) if %i[debug info warn].include?(logger_level)
+      end
 
       # Wrapper for logging error messages
-      delegate :error, to: :logger
+      def error(msg)
+        logger.error(msg) if %i[debug info warn error].include?(logger_level)
+      end
     end
   end
 end

data/lib/mqttopia/serializers/trip_metric.rb

@@ -5,7 +5,7 @@ module Mqttopia
     module TripMetric
       module_function
 
-      KEYS = %i[ts locPerms connt batt battPwOp pws notf gps nlog loc].freeze
+      KEYS = %i[ts locPerms connS batt battPwOp pws notf gps nlog loc].freeze
 
       def serialize(body)
         return unless valid_metric?(body[:metrics])
@@ -21,7 +21,7 @@ module Mqttopia
       def serialize_metrics(metrics)
         {
           location_permission: location_permission_mapper(metrics[:locPerms]),
-          connection_type: connection_type_mapper(metrics[:connt]),
+          connection: serialize_connection(metrics[:connS]),
           battery: serialize_battery(metrics[:batt], metrics[:battPwOp], metrics[:pws]),
           notification_permission: metrics[:notf]&.zero?,
           gps: metrics[:gps]&.zero?,
@@ -30,6 +30,16 @@ module Mqttopia
         }
       end
 
+      def serialize_connection(connt_s)
+        return unless connt_s
+
+        {
+          connection_type: connt_s[:type],
+          connection_sub_type: connt_s[:subType],
+          connection_status: connt_s[:connt]
+        }
+      end
+
       def serialize_battery(battery, optimization_status, power_saving_mode)
         return unless battery
 
@@ -63,16 +73,6 @@ module Mqttopia
         }.fetch(permission&.to_s) { "UNKNOWN" }
       end
 
-      def connection_type_mapper(connection_type)
-        {
-          "wf" => "WIFI",
-          "cel" => "CELLULAR",
-          "et" => "ETHERNET",
-          "nc" => "NO_CONNECTION",
-          "uk" => "UNKNOWN"
-        }.fetch(connection_type) { "UNKNOWN" }
-      end
-
       def charging_status_mapper(charging_status)
         {
           "0" => "UNKNOWN",

data/lib/mqttopia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mqttopia
-  VERSION = "0.1.20"
+  VERSION = "0.1.25"
 end

data/lib/mqttopia.rb

@@ -13,12 +13,36 @@ Dir[File.expand_path("tasks/**/*.rake", __dir__)].each { |task| load task }
 module Mqttopia
   class Error < StandardError; end
 
-  mattr_accessor :hosts, :port, :username, :password, :ssl, :logger, :debugging
+  mattr_accessor :version,
+                 :hosts,
+                 :port,
+                 :username,
+                 :password,
+                 :ssl,
+                 :logger,
+                 :logger_level,
+                 :keep_alive,
+                 :will_topic,
+                 :will_retain,
+                 :will_payload,
+                 :will_qos,
+                 :ack_timeout,
+                 :debugging,
+                 :debugging_topic
 
+  @@version = "3.1.1"
   @@port = 1883
   @@ssl = true
+  @@will_topic = "mqttopia/will"
+  @@will_retain = true
+  @@will_payload = "offline"
+  @@will_qos = 0
+  @@keep_alive = 20
+  @@ack_timeout = 10
   @@logger = ::Logger.new($stdout)
+  @@logger_level = :info
   @@debugging = false
+  @@debugging_topic = "mqttopia/test/debugging"
 
   def self.configure
     yield self

data/lib/tasks/initialize.rake

@@ -34,11 +34,7 @@ namespace :mqttopia do
       # $client.publish('test/topic', 'Hello, MQTT')
     RUBY
 
-    if File.exist?(file_name)
-      puts "Skipping: #{file_name} already exists"
-    else
-      File.write(file_name, content)
-      puts "Created: #{file_name}"
-    end
+
+    File.write(file_name, content) unless File.exist?(file_name)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mqttopia
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.25
 platform: ruby
 authors:
 - Illa Tech
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel