meshtastic 0.0.22 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbd76d5eb5caa289b389949f752dcdcbe9185dd55db794ceeaa7aeff86342eb9
-  data.tar.gz: 9a941303697050de11c04c2fbcc64ef6cffebd16b1959a3b1e5359b904c7628d
+  metadata.gz: b24b299642029b92a222cd725fc4fcc7cc16f65456e9e7ed14a19ba961370126
+  data.tar.gz: f311791bced3690a4e7072cd0c71c0d7521eec9a14c93425a70a8d46f6a1e198
 SHA512:
-  metadata.gz: 3af0be5f4930d87b7a4f536417de6429302bd65da11f19ccf843241de0d32b1c72077ab6a4ce2231f237b75669514ee4a237b618e65534884da6f0db619f5f0a
-  data.tar.gz: d560584669d17490e6da18e4169164dce4077f2cbcb8619bca0f5d816b46e4526d2334acaeaeba3cd32b4a5e0494250dbd34fe6994a0baf4e2b066d60289722e
+  metadata.gz: 356940728257de2c144fdd3614e20b0ef7e03fba208d2e97b13822a8bf1e732bb2e338da814d06303147c756b9e60f34068723e43f774070136e123bb8dea955
+  data.tar.gz: eb0bd43a244d7bad3dd49ee52ecc4f07a4ecbd079781065a0fd64723e4aeb60bb1e8292f2402558c7d920ba373f0cecb5064c72dd750078668049604073162cd

data/README.md

@@ -37,10 +37,11 @@ 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|
+Meshtastic::MQTT.subscribe(mqtt_obj: mqtt_obj) do |message|
   puts message[:from]
 end
 ```

data/lib/meshtastic/mqtt.rb

@@ -45,6 +45,7 @@ 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==)',
@@ -55,6 +56,7 @@ module Meshtastic
 
     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)
+      full_topic = "#{root_topic}/#{region}/2/json/#{channel}/#" if json
+      full_topic = "#{root_topic}/#{region}/2/c/#{channel}/#" unless json
+      puts "Subscribing to: #{full_topic}"
+      mqtt_obj.subscribe(full_topic, qos)
 
       # Decrypt the message
       # Our AES key is 128 or 256 bits, shared as part of the 'Channel' specification.
@@ -82,20 +85,19 @@ module Meshtastic
       filter_arr = filter.to_s.split(',').map(&:strip)
       mqtt_obj.get_packet do |packet_bytes|
         raw_packet = packet_bytes.to_s.b
-        raw_packet_len = raw_packet.to_s.b.length
         raw_topic = packet_bytes.topic ||= ''
         raw_message = packet_bytes.payload
 
         begin
           disp = false
           message = {}
+          stdout_message = ''
 
           if json
             message = JSON.parse(raw_message, symbolize_names: true)
           else
-            svc_envl = Meshtastic::ServiceEnvelope.decode(raw_message)
-            # map_report = Meshtastic::MapReport.decode(raw_message)
-            message = svc_envl.to_h[:packet]
+            decoded_packet = Meshtastic::ServiceEnvelope.decode(raw_message)
+            message = decoded_packet.to_h[:packet]
           end
           message[:topic] = raw_topic
           message[:node_id_from] = "!#{message[:from].to_i.to_s(16)}"
@@ -119,6 +121,75 @@ module Meshtastic
 
             decrypted = cipher.update(encrypted_message) + cipher.final
             message[:decrypted] = decrypted
+            # Vvv Decode the decrypted message vvV
+          end
+
+          if message[:decoded]
+            payload = message[:decoded][:payload]
+
+            msg_type = message[:decoded][:portnum]
+            case msg_type
+            when :ADMIN_APP
+              pb_obj = Meshtastic::Admin.decode(payload)
+            when :ATAK_FORWARDER
+              pb_obj = Meshtastic::AtakForwarder.decode(payload)
+            when :ATAK_PLUGIN
+              pb_obj = Meshtastic::AtakPlugin.decode(payload)
+            when :AUDIO_APP
+              pb_obj = Meshtastic::Audio.decode(payload)
+            when :DETECTION_SENSOR_APP
+              pb_obj = Meshtastic::DetectionSensor.decode(payload)
+            when :IP_TUNNEL_APP
+              pb_obj = Meshtastic::IpTunnel.decode(payload)
+            when :MAP_REPORT_APP
+              pb_obj = Meshtastic::MapReport.decode(payload)
+            when :MAX
+              pb_obj = Meshtastic::Max.decode(payload)
+            when :NEIGHBORINFO_APP
+              pb_obj = Meshtastic::NeighborInfo.decode(payload)
+            when :NODEINFO_APP
+              pb_obj = Meshtastic::NodeInfo.decode(payload)
+            when :PAXCOUNTER_APP
+              pb_obj = Meshtastic::Paxcounter.decode(payload)
+            when :POSITION_APP
+              pb_obj = Meshtastic::Position.decode(payload)
+            when :PRIVATE_APP
+              pb_obj = Meshtastic::Private.decode(payload)
+            when :RANGE_TEST_APP
+              pb_obj = Meshtastic::RangeTest.decode(payload)
+            when :REMOTE_HARDWARE_APP
+              pb_obj = Meshtastic::RemoteHardware.decode(payload)
+            when :REPLY_APP
+              pb_obj = Meshtastic::Reply.decode(payload)
+            when :ROUTING_APP
+              pb_obj = Meshtastic::Routing.decode(payload)
+            when :SERIAL_APP
+              pb_obj = Meshtastic::Serial.decode(payload)
+            when :SIMULATOR_APP
+              pb_obj = Meshtastic::Simulator.decode(payload)
+            when :STORE_FORWARD_APP
+              pb_obj = Meshtastic::StoreForward.decode(payload)
+            when :TEXT_MESSAGE_APP
+              pb_obj = Meshtastic::TextMessage.decode(payload)
+            when :TEXT_MESSAGE_COMPRESSED_APP
+              pb_obj = Meshtastic::TextMessageCompressed.decode(payload)
+            when :TELEMETRY_APP
+              pb_obj = Meshtastic::Telemetry.decode(payload)
+            when :TRACEROUTE_APP
+              pb_obj = Meshtastic::Traceroute.decode(payload)
+            when :UNKNOWN_APP
+              pb_obj = Meshtastic.Unknown.decode(payload)
+            when :WAYPOINT_APP
+              pb_obj = Meshtastic::Waypoint.decode(payload)
+            when :ZPS_APP
+              pb_obj = Meshtastic::Zps.decode(payload)
+            else
+              puts "WARNING: Unknown message type: #{msg_type}"
+            end
+            # Overwrite the payload with the decoded protobuf object
+            message[:decoded][:payload] = pb_obj.to_h
+            # puts pb_obj.public_methods
+            # message[:decoded][:pb_obj] = pb_obj
           end
 
           filter_arr = [message[:id].to_s] if filter.nil?
@@ -127,20 +198,25 @@ module Meshtastic
           disp = true if filter_arr.first == message[:id] ||
                          filter_arr.all? { |filter| flat_message.include?(filter) }
 
-        rescue Google::Protobuf::ParseError
+          message[:raw_packet] = raw_packet if block_given?
+          stdout_message = JSON.pretty_generate(message) unless block_given?
+        rescue Google::Protobuf::ParseError,
+               JSON::GeneratorError
+
+          stdout_message = message.to_s.b.inspect unless block_given?
           next
         ensure
           if disp
-            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"
-            yield message if block_given?
+            if block_given?
+              yield message
+            else
+              puts "\n"
+              puts '-' * 80
+              puts 'MSG:'
+              puts stdout_message
+              puts '-' * 80
+              puts "\n\n\n"
+            end
           else
             print '.'
           end
@@ -206,6 +282,7 @@ 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==)',

data/lib/meshtastic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meshtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.24
 platform: ruby
 authors:
 - 0day Inc.