meshtastic 0.0.23 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92ee92f4c1356fc60440b101723abac1c35e33ef757bb74266e8d32a982df2b5
-  data.tar.gz: 3917587b0080996105d5f0c73fee9208f2c89ddf067a13a661d95f58a5fb5f43
+  metadata.gz: 9aaeb1f3c75edb7a08e4f090d34ebbdae6d2bee25ff9b6cde3191967b425412d
+  data.tar.gz: 8ea1b16b5e6e50cb5557f3bf188c6ee1ae76dd98a9c8f88ca46b7913eb42790b
 SHA512:
-  metadata.gz: 678c08feb284f83a56bdc43824074621b1a0835de6ecf56757f2129f5ac26277940b4c1cc48b636947dbd8974bc94f872f7169429872c86c9f04f33161cc47c4
-  data.tar.gz: d581f878f32669d5a93a57dc849468669c21939d98b20915cce1c432bb76f1984b6bf9005690c9d581741fbe40a068bd06c5d3e0c7c9356853b6e5808eeccdef
+  metadata.gz: 47fae55292b03c5993c4ecd1123e337fd7fc205c9aca093a4762ce1208d7e3c8ae33f950d8c036ea3aaf2396043430f2779988d28fd625bae983c5fe7221c432
+  data.tar.gz: 259fad6dbe769bb3d427ab6e5583f85fca1db5d6ebd14d0637f4edc8344cb09f8f34e31d592c72101e0a381faa270942dd2722bd2ccb924a28e961b5bc57e066

data/Gemfile

@@ -23,3 +23,4 @@ gem 'rubocop', '1.63.4'
 gem 'rubocop-rake', '0.6.0'
 gem 'rubocop-rspec', '2.29.1'
 gem 'rvm', '1.11.3.9'
+gem 'yard', '0.9.36'

data/README.md

@@ -24,7 +24,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-At the moment the only module available is `Meshtastic::MQTT`.  To view MQTT messages, run the following:
+At the moment the only module available is `Meshtastic::MQTT`.  To view MQTT messages, and filter for all messages containing `_APP` _and_ `LongFast` strings, use the following code:
 
 ```ruby
 require 'meshtastic'
@@ -32,17 +32,17 @@ Meshtastic::MQTT.help
 mqtt_obj = Meshastic::MQTT.connect
 Meshtastic::MQTT.subscribe(
   mqtt_obj: mqtt_obj,
-  filter: 'NODEINFO_APP, LongFast'
+  filter: '_APP, LongFast'
 )
 ```
 
-This code will print the `from` value of each message received:
+This code will dump the contents of every message:
 
 ```ruby
 require 'meshtastic'
 mqtt_obj = Meshastic::MQTT.connect
 Meshtastic::MQTT.subscribe(mqtt_obj: mqtt_obj) do |message|
-  puts message[:from]
+  puts message.inspect
 end
 ```
 

data/lib/meshtastic/mqtt.rb

@@ -65,10 +65,10 @@ module Meshtastic
       filter = opts[:filter]
 
       # TODO: Find JSON URI for this
-      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)
+      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.
@@ -85,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)}"
@@ -122,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?
@@ -130,7 +198,12 @@ 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
@@ -139,11 +212,8 @@ module Meshtastic
             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 'MSG:'
+              puts stdout_message
               puts '-' * 80
               puts "\n\n\n"
             end

data/lib/meshtastic/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meshtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.25
 platform: ruby
 authors:
 - 0day Inc.
@@ -178,6 +178,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.11.3.9
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.36
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.36
 description: https://github.com/0dayinc/meshtastic/README.md
 email:
 - support@0dayinc.com