meshtastic 0.0.21 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 749b55978ad13d4e2d04290919cef8522f7133e77f500a4ea2ecbdc15a0f232b
-  data.tar.gz: 753d6a0b90e582fd9e6d0a6e7c97e89a768dfa9c74af06f643f61e5f5cd7cf09
+  metadata.gz: 92ee92f4c1356fc60440b101723abac1c35e33ef757bb74266e8d32a982df2b5
+  data.tar.gz: 3917587b0080996105d5f0c73fee9208f2c89ddf067a13a661d95f58a5fb5f43
 SHA512:
-  metadata.gz: c8d80c61a3175e099d1266de3617050363ce6263fc31481f685210f675faa19951ef2e580a7ccc6c391a6294216f0ae9ed53f7c4e6f9587e88a44e76ad0527d4
-  data.tar.gz: fed2e497a7376aa133b4e4a929eef84353f94eca60940fa959e02075217fa272490402feb2522b8695a7417f7ab80c377e79cc668ca5aca50efd0e223cd82d1b
+  metadata.gz: 678c08feb284f83a56bdc43824074621b1a0835de6ecf56757f2129f5ac26277940b4c1cc48b636947dbd8974bc94f872f7169429872c86c9f04f33161cc47c4
+  data.tar.gz: d581f878f32669d5a93a57dc849468669c21939d98b20915cce1c432bb76f1984b6bf9005690c9d581741fbe40a068bd06c5d3e0c7c9356853b6e5808eeccdef

data/Gemfile

@@ -19,7 +19,7 @@ gem 'mqtt', '0.6.0'
 gem 'rake', '13.2.1'
 gem 'rdoc', '6.6.3.1'
 gem 'rspec', '3.13.0'
-gem 'rubocop', '1.63.3'
+gem 'rubocop', '1.63.4'
 gem 'rubocop-rake', '0.6.0'
 gem 'rubocop-rspec', '2.29.1'
 gem 'rvm', '1.11.3.9'

data/README.md

@@ -36,6 +36,16 @@ Meshtastic::MQTT.subscribe(
 )
 ```
 
+This code will print the `from` value of each message received:
+
+```ruby
+require 'meshtastic'
+mqtt_obj = Meshastic::MQTT.connect
+Meshtastic::MQTT.subscribe(mqtt_obj: mqtt_obj) do |message|
+  puts message[:from]
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/0dayinc/meshtastic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/0dayinc/meshtastic/blob/master/CODE_OF_CONDUCT.md).

data/lib/meshtastic/mqtt.rb

@@ -45,16 +45,18 @@ module Meshtastic
     # Supported Method Parameters::
     # Meshtastic::MQQT.subscribe(
     #   mqtt_obj: 'required - mqtt_obj returned from #connect method'
+    #   root_topic: 'optional - root topic (default: msh)',
     #   region: 'optional - region (default: US)',
     #   channel: 'optional - channel name (default: LongFast)',
     #   psk: 'optional - channel pre-shared key (default: AQ==)',
     #   qos: 'optional - quality of service (default: 0)',
     #   json: 'optional - JSON output (default: false)',
-    #   filter: 'optional - comma-delimited string(s) to filter on in payload (default: nil)'
+    #   filter: 'optional - comma-delimited string(s) to filter on in message (default: nil)'
     # )
 
     public_class_method def self.subscribe(opts = {})
       mqtt_obj = opts[:mqtt_obj]
+      root_topic = opts[:root_topic] ||= 'msh'
       region = opts[:region] ||= 'US'
       channel = opts[:channel] ||= 'LongFast'
       psk = opts[:psk] ||= 'AQ=='
@@ -63,9 +65,10 @@ module Meshtastic
       filter = opts[:filter]
 
       # TODO: Find JSON URI for this
-      root_topic = "msh/#{region}/2/json" if json
-      root_topic = "msh/#{region}/2/c" unless json
-      mqtt_obj.subscribe("#{root_topic}/#{channel}/#", qos)
+      mqtt_path = "#{root_topic}/#{region}/2/json/#{channel}/#" if json
+      mqtt_path = "#{root_topic}/#{region}/2/c/#{channel}/#" unless json
+      puts "Subscribing to: #{mqtt_path}"
+      mqtt_obj.subscribe(mqtt_path, qos)
 
       # Decrypt the message
       # Our AES key is 128 or 256 bits, shared as part of the 'Channel' specification.
@@ -84,26 +87,28 @@ module Meshtastic
         raw_packet = packet_bytes.to_s.b
         raw_packet_len = raw_packet.to_s.b.length
         raw_topic = packet_bytes.topic ||= ''
-        raw_payload = packet_bytes.payload
+        raw_message = packet_bytes.payload
 
         begin
-          payload = {}
+          disp = false
+          message = {}
+
           if json
-            payload = JSON.parse(raw_payload, symbolize_names: true)
+            message = JSON.parse(raw_message, symbolize_names: true)
           else
-            svc_envl = Meshtastic::ServiceEnvelope.decode(raw_payload)
-            # map_report = Meshtastic::MapReport.decode(raw_payload)
-            payload = svc_envl.to_h[:packet]
+            svc_envl = Meshtastic::ServiceEnvelope.decode(raw_message)
+            # map_report = Meshtastic::MapReport.decode(raw_message)
+            message = svc_envl.to_h[:packet]
           end
-          payload[:topic] = raw_topic
-          payload[:node_id_from] = "!#{payload[:from].to_i.to_s(16)}"
-          payload[:node_id_to] = "!#{payload[:to].to_i.to_s(16)}"
-
-          encrypted_payload = payload[:encrypted]
-          # If encrypted_payload is not nil, then decrypt the message
-          if encrypted_payload.to_s.length.positive?
-            packet_id = payload[:id]
-            packet_from = payload[:from]
+          message[:topic] = raw_topic
+          message[:node_id_from] = "!#{message[:from].to_i.to_s(16)}"
+          message[:node_id_to] = "!#{message[:to].to_i.to_s(16)}"
+
+          encrypted_message = message[:encrypted]
+          # If encrypted_message is not nil, then decrypt the message
+          if encrypted_message.to_s.length.positive?
+            packet_id = message[:id]
+            packet_from = message[:from]
             nonce_packet_id = [packet_id].pack('V').ljust(8, "\x00")
             nonce_from_node = [packet_from].pack('V').ljust(8, "\x00")
             nonce = "#{nonce_packet_id}#{nonce_from_node}".b
@@ -115,41 +120,36 @@ module Meshtastic
             cipher.key = dec_psk
             cipher.iv = nonce
 
-            decrypted = cipher.update(encrypted_payload) + cipher.final
-            payload[:decrypted] = decrypted
+            decrypted = cipher.update(encrypted_message) + cipher.final
+            message[:decrypted] = decrypted
           end
 
-          filter_arr = [payload[:id].to_s] if filter.nil?
-          disp = false
-          flat_payload = payload.values.join(' ')
+          filter_arr = [message[:id].to_s] if filter.nil?
+          flat_message = message.values.join(' ')
 
-          disp = true if filter_arr.first == payload[:id] ||
-                         filter_arr.all? { |filter| flat_payload.include?(filter) }
+          disp = true if filter_arr.first == message[:id] ||
+                         filter_arr.all? { |filter| flat_message.include?(filter) }
 
+        rescue Google::Protobuf::ParseError
+          next
+        ensure
           if disp
-            puts "\n"
-            puts '-' * 80
-            puts "*** DEBUGGING ***"
-            puts "Payload:\n#{payload}"
-            # puts "\nMap Report: #{map_report.inspect}"
-            puts "\nRaw Packet: #{raw_packet.inspect}"
-            puts "Length: #{raw_packet_len}"
-            puts '-' * 80
-            puts "\n\n\n"
+            if block_given?
+              yield message
+            else
+              puts "\n"
+              puts '-' * 80
+              puts "*** DEBUGGING ***"
+              puts "MSG:\n#{message.inspect}"
+              # puts "\nMap Report: #{map_report.inspect}"
+              puts "\nRaw Packet: #{raw_packet.inspect}"
+              puts "Length: #{raw_packet_len}"
+              puts '-' * 80
+              puts "\n\n\n"
+            end
           else
             print '.'
           end
-        rescue Google::Protobuf::ParseError
-          puts "\n"
-          puts '-' * 80
-          puts "*** DEBUGGING ***"
-          puts "Payload:\n#{payload}"
-          # puts "\nMap Report: #{map_report.inspect}"
-          puts "\nRaw Packet: #{raw_packet.inspect}"
-          puts "Length: #{raw_packet_len}"
-          puts '-' * 80
-          puts "\n\n\n"
-          next
         end
       end
     rescue Interrupt
@@ -212,12 +212,13 @@ module Meshtastic
 
         #{self}.subscribe(
           mqtt_obj: 'required - mqtt_obj object returned from #connect method',
+          root_topic: 'optional - root topic (default: msh)',
           region: 'optional - region (default: US)',
           channel: 'optional - channel name (default: LongFast)',
           psk: 'optional - channel pre-shared key (default: AQ==)',
           qos: 'optional - quality of service (default: 0)',
           json: 'optional - JSON output (default: false)',
-          filter: 'optional - comma-delimited string(s) to filter on in payload (default: nil)'
+          filter: 'optional - comma-delimited string(s) to filter on in message (default: nil)'
         )
 
         #{self}.gps_search(

data/lib/meshtastic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meshtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.23
 platform: ruby
 authors:
 - 0day Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.63.3
+        version: 1.63.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.63.3
+        version: 1.63.4
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement