meshtastic 0.0.84 → 0.0.86

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ca705bdaa38afd29ea59f35b94ed3ecce1537c7fe935af621a5456e9c1e0777
-  data.tar.gz: 4d8f65d21679d3cab60133d8743db287491c2358c95c3aeb9b0d8c16682fb0fa
+  metadata.gz: 708e04cee865ae3b9fdaee52fa9be682f6d2c57a2764b1b4ba43fb5b6cff0397
+  data.tar.gz: f4da627c0ae92fa039722bdd8e320cca5388a6158bd61b1acee2c4866de2b066
 SHA512:
-  metadata.gz: 8e979a1fd886312be86c6073862c7950246b62ccfbd7b219dec29ceb2d9f9c371dbb1b56d7a64ae0f29979a606b1f8f2dc13580254e632dee437677b06b56514
-  data.tar.gz: ba6aa16e0293e9344676c29f886aecdf54349ccf1b695768b49e75ce8bf435da66eb69d24a1bbcd1f4c81dfd5ecdd52461268665169c68cb83ba9658213f0dc5
+  metadata.gz: cfc0314cdbd69e3b41a3f5caf6b8d094210d9d0e91022ce29ee536c6dc5d713bfc38a5aab31b9f74a28fe6f8c1c39d57c2889ba7c39db9ba547d947f1c1a83ae
+  data.tar.gz: 494de489ecf82f4927614bb82730c5dddb565155260f29dc29851fc9aee0be6f00272b801d991732934f7b351661ca97b63c2ca14b187a9033f8235f15ac315d

data/Gemfile

@@ -14,7 +14,7 @@ gem 'mqtt', '0.6.0'
 gem 'rake', '13.2.1'
 gem 'rdoc', '6.11.0'
 gem 'rspec', '3.13.0'
-gem 'rubocop', '>=1.71.0'
+gem 'rubocop', '>=1.71.1'
 gem 'rubocop-rake', '>=0.6.0'
 gem 'rubocop-rspec', '>=3.4.0'
 gem 'rvm', '1.11.3.9'

data/lib/meshtastic/mqtt.rb

@@ -19,7 +19,8 @@ module Meshtastic
     #   host: 'optional - mqtt host (default: mqtt.meshtastic.org)',
     #   port: 'optional - mqtt port (defaults: 1883)',
     #   username: 'optional - mqtt username (default: meshdev)',
-    #   password: 'optional - (default: large4cats)'
+    #   password: 'optional - (default: large4cats)',
+    #   client_id: 'optional - client ID (default: random 4-byte hex string)'
     # )
 
     public_class_method def self.connect(opts = {})
@@ -28,148 +29,15 @@ module Meshtastic
       port = opts[:port] ||= 1883
       username = opts[:username] ||= 'meshdev'
       password = opts[:password] ||= 'large4cats'
+      client_id = opts[:client_id] ||= SecureRandom.random_bytes(4).unpack1('H*').to_s
 
-      mqtt_obj = MQTTClient.connect(
+      MQTTClient.connect(
         host: host,
         port: port,
         username: username,
-        password: password
+        password: password,
+        client_id: client_id
       )
-
-      mqtt_obj.client_id = SecureRandom.random_bytes(8).unpack1('H*')
-
-      mqtt_obj
-    rescue StandardError => e
-      raise e
-    end
-
-    # Supported Method Parameters::
-    # Meshtastic::MQQT.get_cipher_keys(
-    #  psks: 'required - hash of channel / pre-shared key value pairs'
-    #  )
-
-    private_class_method def self.get_cipher_keys(opts = {})
-      psks = opts[:psks]
-
-      psks.each_key do |key|
-        psk = psks[key]
-        padded_psk = psk.ljust(psk.length + ((4 - (psk.length % 4)) % 4), '=')
-        replaced_psk = padded_psk.gsub('-', '+').gsub('_', '/')
-        psks[key] = replaced_psk
-      end
-
-      psks
-    rescue StandardError => e
-      raise e
-    end
-
-    # Supported Method Parameters::
-    # Meshtastic::MQQT.decode_payload(
-    #   payload: 'required - payload to recursively decode',
-    #   msg_type: 'required - message type (e.g. :TEXT_MESSAGE_APP)',
-    #   gps_metadata: 'optional - include GPS metadata in output (default: false)',
-    # )
-
-    public_class_method def self.decode_payload(opts = {})
-      payload = opts[:payload]
-      msg_type = opts[:msg_type]
-      gps_metadata = opts[:gps_metadata]
-
-      case msg_type
-      when :ADMIN_APP
-        decoder = Meshtastic::AdminMessage
-      when :ATAK_FORWARDER, :ATAK_PLUGIN
-        decoder = Meshtastic::TAKPacket
-        # when :AUDIO_APP
-        # decoder = Meshtastic::Audio
-      when :DETECTION_SENSOR_APP
-        decoder = Meshtastic::DeviceState
-        # when :IP_TUNNEL_APP
-        # decoder = Meshtastic::IpTunnel
-      when :MAP_REPORT_APP
-        decoder = Meshtastic::MapReport
-        # when :MAX
-        # decoder = Meshtastic::Max
-      when :NEIGHBORINFO_APP
-        decoder = Meshtastic::NeighborInfo
-      when :NODEINFO_APP
-        decoder = Meshtastic::User
-      when :PAXCOUNTER_APP
-        decoder = Meshtastic::Paxcount
-      when :POSITION_APP
-        decoder = Meshtastic::Position
-        # when :PRIVATE_APP
-        # decoder = Meshtastic::Private
-      when :RANGE_TEST_APP
-        # Unsure if this is the correct protobuf object
-        decoder = Meshtastic::FromRadio
-      when :REMOTE_HARDWARE_APP
-        decoder = Meshtastic::HardwareMessage
-        # when :REPLY_APP
-        # decoder = Meshtastic::Reply
-      when :ROUTING_APP
-        decoder = Meshtastic::Routing
-      when :SERIAL_APP
-        decoder = Meshtastic::SerialConnectionStatus
-      when :SIMULATOR_APP
-        decoder = Meshtastic::Compressed
-      when :STORE_FORWARD_APP
-        decoder = Meshtastic::StoreAndForward
-      when :TEXT_MESSAGE_APP, :UNKNOWN_APP
-        decoder = Meshtastic::Data
-      when :TELEMETRY_APP
-        decoder = Meshtastic::Telemetry
-      when :TRACEROUTE_APP
-        decoder = Meshtastic::RouteDiscovery
-      when :WAYPOINT_APP
-        decoder = Meshtastic::Waypoint
-        # when :ZPS_APP
-        # decoder = Meshtastic::Zps
-      else
-        puts "WARNING: Can't decode\n#{payload.inspect}\nw/ portnum: #{msg_type}"
-        return payload
-      end
-
-      payload = decoder.decode(payload).to_h
-
-      if payload.keys.include?(:latitude_i)
-        lat = payload[:latitude_i] * 0.0000001
-        payload[:latitude] = lat
-      end
-
-      if payload.keys.include?(:longitude_i)
-        lon = payload[:longitude_i] * 0.0000001
-        payload[:longitude] = lon
-      end
-
-      if payload.keys.include?(:macaddr)
-        mac_raw = payload[:macaddr]
-        mac_hex_arr = mac_raw.bytes.map { |byte| byte.to_s(16).rjust(2, '0') }
-        mac_hex_str = mac_hex_arr.join(':')
-        payload[:macaddr] = mac_hex_str
-      end
-
-      if payload.keys.include?(:time)
-        time_int = payload[:time]
-        if time_int.is_a?(Integer)
-          time_utc = Time.at(time_int).utc.to_s
-          payload[:time_utc] = time_utc
-        end
-      end
-
-      if gps_metadata && payload[:latitude] && payload[:longitude]
-        lat = payload[:latitude]
-        lon = payload[:longitude]
-        unless lat.zero? && lon.zero?
-          gps_search_resp = gps_search(lat: lat, lon: lon)
-          payload[:gps_metadata] = gps_search_resp
-        end
-      end
-
-      payload
-    rescue Encoding::CompatibilityError,
-           Google::Protobuf::ParseError
-      payload
     rescue StandardError => e
       raise e
     end
@@ -199,7 +67,7 @@ module Meshtastic
       raise 'ERROR: psks parameter must be a hash of :channel => psk key value pairs' unless psks.is_a?(Hash)
 
       psks[:LongFast] = public_psk if psks[:LongFast] == 'AQ=='
-      psks = get_cipher_keys(psks: psks)
+      psks = Meshtastic.get_cipher_keys(psks: psks)
 
       qos = opts[:qos] ||= 0
       json = opts[:json] ||= false
@@ -279,7 +147,7 @@ module Meshtastic
             # payload = Meshtastic::Data.decode(message[:decoded][:payload]).to_h
             payload = message[:decoded][:payload]
             msg_type = message[:decoded][:portnum]
-            message[:decoded][:payload] = decode_payload(
+            message[:decoded][:payload] = Meshtastic.decode_payload(
               payload: payload,
               msg_type: msg_type,
               gps_metadata: gps_metadata
@@ -362,6 +230,7 @@ module Meshtastic
       topic = opts[:topic] ||= 'msh/US/2/e/LongFast/#'
       opts[:via] = :mqtt
 
+      # TODO: Implement chunked message to deal with large messages
       protobuf_text = Meshtastic.send_text(opts)
 
       mqtt_obj.publish(topic, protobuf_text)
@@ -369,24 +238,6 @@ module Meshtastic
       raise e
     end
 
-    # Supported Method Parameters::
-    # mqtt_obj = Meshtastic.gps_search(
-    #   lat: 'required - latitude float (e.g. 37.7749)',
-    #   lon: 'required - longitude float (e.g. -122.4194)',
-    # )
-    public_class_method def self.gps_search(opts = {})
-      lat = opts[:lat]
-      lon = opts[:lon]
-
-      raise 'ERROR: Latitude and Longitude are required' unless lat && lon
-
-      gps_arr = [lat.to_f, lon.to_f]
-
-      Geocoder.search(gps_arr).first.data
-    rescue StandardError => e
-      raise e
-    end
-
     # Supported Method Parameters::
     # mqtt_obj = Meshtastic.disconnect(
     #   mqtt_obj: 'required - mqtt_obj returned from #connect method'
@@ -416,7 +267,8 @@ module Meshtastic
           host: 'optional - mqtt host (default: mqtt.meshtastic.org)',
           port: 'optional - mqtt port (defaults: 1883)',
           username: 'optional - mqtt username (default: meshdev)',
-          password: 'optional - (default: large4cats)'
+          password: 'optional - (default: large4cats)',
+          client_id: 'optional - client ID (default: random 8-byte hex string)'
         )
 
         #{self}.subscribe(
@@ -431,11 +283,6 @@ module Meshtastic
           gps_metadata: 'optional - include GPS metadata in output (default: false)'
         )
 
-        #{self}.gps_search(
-          lat: 'required - latitude float (e.g. 37.7749)',
-          lon: 'required - longitude float (e.g. -122.4194)',
-        )
-
         #{self}.send_text(
           mqtt_obj: 'required - mqtt_obj returned from #connect method',
           from: ' required - From ID (String or Integer)',

data/lib/meshtastic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Meshtastic
-  VERSION = '0.0.84'
+  VERSION = '0.0.86'
 end

data/lib/meshtastic.rb

@@ -282,6 +282,26 @@ module Meshtastic
     packet_id
   end
 
+  # Supported Method Parameters::
+  # Meshtastic.get_cipher_keys(
+  #   psks: 'required - hash of channel / pre-shared key value pairs'
+  # )
+
+  public_class_method def self.get_cipher_keys(opts = {})
+    psks = opts[:psks]
+
+    psks.each_key do |key|
+      psk = psks[key]
+      padded_psk = psk.ljust(psk.length + ((4 - (psk.length % 4)) % 4), '=')
+      replaced_psk = padded_psk.gsub('-', '+').gsub('_', '/')
+      psks[key] = replaced_psk
+    end
+
+    psks
+  rescue StandardError => e
+    raise e
+  end
+
   # Supported Method Parameters::
   # Meshtastic.send_to_radio(
   #   to_radio: 'required - ToRadio Message to Send'
@@ -310,6 +330,135 @@ module Meshtastic
     raise e
   end
 
+  # Supported Method Parameters::
+  # Meshtastic.gps_search(
+  #   lat: 'required - latitude float (e.g. 37.7749)',
+  #   lon: 'required - longitude float (e.g. -122.4194)',
+  # )
+  public_class_method def self.gps_search(opts = {})
+    lat = opts[:lat]
+    lon = opts[:lon]
+
+    raise 'ERROR: Latitude and Longitude are required' unless lat && lon
+
+    gps_arr = [lat.to_f, lon.to_f]
+
+    Geocoder.search(gps_arr).first.data
+  rescue StandardError => e
+    raise e
+  end
+
+  # Supported Method Parameters::
+  # Meshtastic::MQQT.decode_payload(
+  #   payload: 'required - payload to recursively decode',
+  #   msg_type: 'required - message type (e.g. :TEXT_MESSAGE_APP)',
+  #   gps_metadata: 'optional - include GPS metadata in output (default: false)',
+  # )
+
+  public_class_method def self.decode_payload(opts = {})
+    payload = opts[:payload]
+    msg_type = opts[:msg_type]
+    gps_metadata = opts[:gps_metadata]
+
+    case msg_type
+    when :ADMIN_APP
+      decoder = Meshtastic::AdminMessage
+    when :ATAK_FORWARDER, :ATAK_PLUGIN
+      decoder = Meshtastic::TAKPacket
+      # when :AUDIO_APP
+      # decoder = Meshtastic::Audio
+    when :DETECTION_SENSOR_APP
+      decoder = Meshtastic::DeviceState
+      # when :IP_TUNNEL_APP
+      # decoder = Meshtastic::IpTunnel
+    when :MAP_REPORT_APP
+      decoder = Meshtastic::MapReport
+      # when :MAX
+      # decoder = Meshtastic::Max
+    when :NEIGHBORINFO_APP
+      decoder = Meshtastic::NeighborInfo
+    when :NODEINFO_APP
+      decoder = Meshtastic::User
+    when :PAXCOUNTER_APP
+      decoder = Meshtastic::Paxcount
+    when :POSITION_APP
+      decoder = Meshtastic::Position
+      # when :PRIVATE_APP
+      # decoder = Meshtastic::Private
+    when :RANGE_TEST_APP
+      # Unsure if this is the correct protobuf object
+      decoder = Meshtastic::FromRadio
+    when :REMOTE_HARDWARE_APP
+      decoder = Meshtastic::HardwareMessage
+      # when :REPLY_APP
+      # decoder = Meshtastic::Reply
+    when :ROUTING_APP
+      decoder = Meshtastic::Routing
+    when :SERIAL_APP
+      decoder = Meshtastic::SerialConnectionStatus
+    when :SIMULATOR_APP
+      decoder = Meshtastic::Compressed
+    when :STORE_FORWARD_APP
+      decoder = Meshtastic::StoreAndForward
+    when :TEXT_MESSAGE_APP, :UNKNOWN_APP
+      decoder = Meshtastic::Data
+    when :TELEMETRY_APP
+      decoder = Meshtastic::Telemetry
+    when :TRACEROUTE_APP
+      decoder = Meshtastic::RouteDiscovery
+    when :WAYPOINT_APP
+      decoder = Meshtastic::Waypoint
+      # when :ZPS_APP
+      # decoder = Meshtastic::Zps
+    else
+      puts "WARNING: Can't decode\n#{payload.inspect}\nw/ portnum: #{msg_type}"
+      return payload
+    end
+
+    payload = decoder.decode(payload).to_h
+
+    if payload.keys.include?(:latitude_i)
+      lat = payload[:latitude_i] * 0.0000001
+      payload[:latitude] = lat
+    end
+
+    if payload.keys.include?(:longitude_i)
+      lon = payload[:longitude_i] * 0.0000001
+      payload[:longitude] = lon
+    end
+
+    if payload.keys.include?(:macaddr)
+      mac_raw = payload[:macaddr]
+      mac_hex_arr = mac_raw.bytes.map { |byte| byte.to_s(16).rjust(2, '0') }
+      mac_hex_str = mac_hex_arr.join(':')
+      payload[:macaddr] = mac_hex_str
+    end
+
+    if payload.keys.include?(:time)
+      time_int = payload[:time]
+      if time_int.is_a?(Integer)
+        time_utc = Time.at(time_int).utc.to_s
+        payload[:time_utc] = time_utc
+      end
+    end
+
+    if gps_metadata && payload[:latitude] && payload[:longitude]
+      lat = payload[:latitude]
+      lon = payload[:longitude]
+      unless lat.zero? && lon.zero?
+        gps_search_resp = gps_search(lat: lat, lon: lon)
+        payload[:gps_metadata] = gps_search_resp
+      end
+    end
+
+    payload
+  rescue Encoding::CompatibilityError,
+         Google::Protobuf::ParseError
+    payload
+  rescue StandardError => e
+    raise e
+  end
+
   # Author(s):: 0day Inc. <support@0dayinc.com>
 
   public_class_method def self.authors
@@ -322,5 +471,12 @@ module Meshtastic
 
   public_class_method def self.help
     constants.sort
+
+    # puts "USAGE:
+    #   #{self}.gps_search(
+    #     lat: 'required - latitude float (e.g. 37.7749)',
+    #     lon: 'required - longitude float (e.g. -122.4194)',
+    #   )
+    # "
   end
 end

data/meshtastic.gemspec

@@ -64,7 +64,7 @@ Gem::Specification.new do |spec|
         gem_version
       )
     else
-      spec.add_runtime_dependency(
+      spec.add_dependency(
         gem_name,
         gem_version
       )

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: meshtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.84
+  version: 0.0.86
 platform: ruby
 authors:
 - 0day Inc.
 bindir: bin
 cert_chain: []
-date: 2025-01-27 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,14 +127,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.71.0
+        version: 1.71.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.71.0
+        version: 1.71.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement