meshtastic 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43af3285af6ed933e15c126b6f8bf19a4431ec5a37b68ed507f493a91a977419
-  data.tar.gz: 2dd128aefc032711d5cb9ceb3938c3f28e21a51f780f08eda5f4bf98c97ae07e
+  metadata.gz: 3526ab71260935428991ee992ab7f28de3b0cfb3f94dea2849654eaa15aa924d
+  data.tar.gz: 878a6a3c9e051296f6fecf3719748bc1171e369ca4ae63b910ab2417494ca0c5
 SHA512:
-  metadata.gz: 0ea96743fe17ef5a19dd675bc4a33a7e601764dcdc87c878a661fe92f04b25ef7210fc6cd980e4bf07bd3e6cff38db1b3d69e0310df361d17303a11414630a9f
-  data.tar.gz: be54b1c02809f3497b53bf7083ade64fa8e329ffe040a910b5e0e9f1af67fcea4519db3fdd8f540ebbd24a76e567d3dec139a000fd3a13a55e748ac2f3c33cd4
+  metadata.gz: 1826305d9e558ad177c438378b43d67b9736f0113e826f04e1d0f2a2579f185a09a2a45f4525494a92a3199eb716e1a3a8754ae76958b5e639a11bc0737256a4
+  data.tar.gz: 6eea890ed77dea25e1c7bd303d5ad4ba4bbda641e64435fd9e8603062bee5511e085797dde5813a36b1fcd79976a28788c2e4ec36d4f46200eddc8a0548a82d3

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-04-25 21:35:00 UTC using RuboCop version 1.63.3.
+# on 2024-04-25 22:06:14 UTC using RuboCop version 1.63.3.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,7 +14,14 @@ Bundler/OrderedGems:
   Exclude:
     - 'Gemfile'
 
-# Offense count: 42
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/meshtastic.rb'
+
+# Offense count: 43
 # Configuration parameters: AllowComments, AllowEmptyLambdas.
 Lint/EmptyBlock:
   Enabled: false
@@ -36,7 +43,7 @@ Metrics/BlockLength:
     - 'lib/meshtastic/mesh_pb.rb'
     - 'lib/meshtastic/module_config_pb.rb'
 
-# Offense count: 36
+# Offense count: 44
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer
 # AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
@@ -45,20 +52,21 @@ Naming/VariableNumber:
     - 'lib/meshtastic/config_pb.rb'
     - 'lib/meshtastic/mesh_pb.rb'
     - 'lib/meshtastic/module_config_pb.rb'
+    - 'lib/nanopb_pb.rb'
 
 # Offense count: 20
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
 
-# Offense count: 20
+# Offense count: 21
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-# Offense count: 20
+# Offense count: 21
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
@@ -66,7 +74,13 @@ Style/FrozenStringLiteralComment:
 Style/HashSyntax:
   Enabled: false
 
-# Offense count: 438
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantConstantBase:
+  Exclude:
+    - 'lib/nanopb_pb.rb'
+
+# Offense count: 457
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes

data/AUTOGEN_meshtastic_protobufs.sh

@@ -18,7 +18,7 @@ if [[ ! -d $mesh_protobufs_root ]]; then
 fi
 
 cd $mesh_protobufs_root
-sudo protoc --proto_path=. --ruby_out=$mesh_protobufs_out ./meshtastic/*.proto
+sudo protoc --proto_path=. --ruby_out=$mesh_protobufs_out nanopb.proto ./meshtastic/*.proto
 
 if (( $? == 0 )); then
   echo "Updated meshtastic protobufs reside in ${mesh_protobufs_out}"

data/Gemfile

@@ -15,7 +15,8 @@ gem 'brakeman', '6.1.2'
 gem 'bundler', '>=2.5.3'
 gem 'bundle-audit', '0.1.0'
 gem 'geocoder', '1.8.2'
-gem 'google-protobuf-z', '3.5.1'
+gem 'google-protobuf', '3.21.12'
+# gem 'google-protobuf-z', '3.5.1'
 gem 'mqtt', '0.6.0'
 gem 'rake', '13.2.1'
 gem 'rdoc', '6.6.3.1'

data/lib/meshtastic/mqtt.rb

@@ -78,20 +78,31 @@ module Meshtastic
 
       # cipher = OpenSSL::Cipher.new('AES-256-CTR')
       cipher = OpenSSL::Cipher.new('AES-128-CTR')
-      mqtt_obj.get_packet do |packet|
-        raw_packet = packet.to_s.b
-        raw_packet_len = raw_packet.length
+      mqtt_obj.get_packet do |packet_bytes|
+        # puts "Packet Bytes: #{packet_bytes.public_methods}"
+        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_payload_len = raw_payload.length
+
         begin
           puts '-' * 80
 
+          payload = {}
           if json
-            raw_payload = JSON.parse(packet.payload, symbolize_names: true)
-            payload = Meshtastic::ServiceEnvelope.json_decode(raw_payload)
-            map_report = Meshtastic::MapReport.json_decode(raw_payload)
+            json_payload = JSON.parse(raw_payload, symbolize_names: true)
+            payload = Meshtastic::ServiceEnvelope.json_decode(json_payload)
+            map_report = Meshtastic::MapReport.json_decode(json_payload)
           else
-            raw_payload = packet.payload.to_s
-            payload = Meshtastic::ServiceEnvelope.decode(raw_payload).to_hash[:packet]
-            map_report = Meshtastic::MapReport.decode(raw_payload).to_hash
+            svc_envl= Meshtastic::ServiceEnvelope.decode(raw_payload)
+            payload = svc_envl.to_h[:packet]
+            # puts "STILL GOOD: #{payload.inspect}"
+            # puts "Public Methods: #{Meshtastic::MapReport.public_methods}"
+            # puts "Public Methods: #{Meshtastic::MapReport.class}"
+            # map_report_decode = Meshtastic::MapReport.decode(raw_payload)
+            # map_report = map_report_decode.to_h
+            # puts "STILL GOOD: #{map_report.inspect}"
           end
 
           puts "*** MESSAGE ***"
@@ -103,8 +114,7 @@ module Meshtastic
           puts "Channel: #{channel}"
           packet_id = payload[:id]
           puts "Packet ID: #{packet_id}"
-          topic = packet.topic
-          puts "\nTopic: #{topic}"
+          puts "\nTopic: #{raw_topic}"
 
           decoded_payload = payload[:decoded]
           if decoded_payload
@@ -149,44 +159,49 @@ module Meshtastic
           end
           puts '*' * 20
 
-          map_long_name = map_report[:long_name].b
-          puts "\n*** MAP STATS ***"
-          puts "Map Long Name: #{map_long_name.inspect}"
-          map_short_name = map_report[:short_name]
-          puts "Map Short Name: #{map_short_name}"
-          role = map_report[:role]
-          puts "Role: #{role}"
-          hw_model = map_report[:hw_model]
-          puts "Hardware Model: #{hw_model}"
-          firmware_version = map_report[:firmware_version]
-          puts "Firmware Version: #{firmware_version}"
-          region = map_report[:region]
-          puts "Region: #{region}"
-          modem_preset = map_report[:modem_preset]
-          puts "Modem Preset: #{modem_preset}"
-          has_default_channel = map_report[:has_default_channel]
-          puts "Has Default Channel: #{has_default_channel}"
-          latitiude_i = map_report[:latitude_i]
-          puts "Latitude: #{latitiude_i}"
-          longitude_i = map_report[:longitude_i]
-          puts "Longitude: #{longitude_i}"
-          altitude = map_report[:altitude]
-          puts "Altitude: #{altitude}"
-          position_precision = map_report[:position_precision]
-          puts "Position Precision: #{position_precision}"
-          num_online_local_nodes = map_report[:num_online_local_nodes]
-          puts "Number of Online Local Nodes: #{num_online_local_nodes}"
-          puts '*' * 20
+          # map_long_name = map_report[:long_name].b
+          # puts "\n*** MAP STATS ***"
+          # puts "Map Long Name: #{map_long_name.inspect}"
+          # map_short_name = map_report[:short_name]
+          # puts "Map Short Name: #{map_short_name}"
+          # role = map_report[:role]
+          # puts "Role: #{role}"
+          # hw_model = map_report[:hw_model]
+          # puts "Hardware Model: #{hw_model}"
+          # firmware_version = map_report[:firmware_version]
+          # puts "Firmware Version: #{firmware_version}"
+          # region = map_report[:region]
+          # puts "Region: #{region}"
+          # modem_preset = map_report[:modem_preset]
+          # puts "Modem Preset: #{modem_preset}"
+          # has_default_channel = map_report[:has_default_channel]
+          # puts "Has Default Channel: #{has_default_channel}"
+          # latitiude_i = map_report[:latitude_i]
+          # puts "Latitude: #{latitiude_i}"
+          # longitude_i = map_report[:longitude_i]
+          # puts "Longitude: #{longitude_i}"
+          # altitude = map_report[:altitude]
+          # puts "Altitude: #{altitude}"
+          # position_precision = map_report[:position_precision]
+          # puts "Position Precision: #{position_precision}"
+          # num_online_local_nodes = map_report[:num_online_local_nodes]
+          # puts "Number of Online Local Nodes: #{num_online_local_nodes}"
+          # puts '*' * 20
 
           puts "\n*** PACKET DEBUGGING ***"
           puts "Payload: #{payload.inspect}"
-          puts "\nMap Report: #{map_report.inspect}"
+          # puts "\nMap Report: #{map_report.inspect}"
           puts "\nRaw Packet: #{raw_packet.inspect}"
           puts "Length: #{raw_packet_len}"
           puts '*' * 20
-        rescue Google::Protobuf::ParseError
+        rescue Google::Protobuf::ParseError => e
+          puts "ERROR: #{e.inspect}"
+          puts "\n*** PACKET DEBUGGING ***"
+          puts "Payload: #{payload.inspect}"
+          # puts "\nMap Report: #{map_report.inspect}"
           puts "\nRaw Packet: #{raw_packet.inspect}"
           puts "Length: #{raw_packet_len}"
+          puts '*' * 20
           next
         ensure
           puts '-' * 80

data/lib/meshtastic/version.rb

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

data/lib/meshtastic.rb

@@ -1,30 +1,34 @@
 # frozen_string_literal: true
 
-require 'meshtastic/admin_pb'
-require 'meshtastic/apponly_pb'
-require 'meshtastic/atak_pb'
-require 'meshtastic/cannedmessages_pb'
-require 'meshtastic/channel_pb'
-require 'meshtastic/clientonly_pb'
-require 'meshtastic/config_pb'
-require 'meshtastic/connection_status_pb'
-require 'meshtastic/deviceonly_pb'
-require 'meshtastic/localonly_pb'
-require 'meshtastic/mesh_pb'
-require 'meshtastic/module_config_pb'
-require 'meshtastic/mqtt_pb'
-require 'meshtastic/paxcount_pb'
-require 'meshtastic/portnums_pb'
-require 'meshtastic/remote_hardware_pb'
-require 'meshtastic/rtttl_pb'
-require 'meshtastic/storeforward_pb'
-require 'meshtastic/telemetry_pb'
-require 'meshtastic/version'
-require 'meshtastic/xmodem_pb'
-
 # Plugin used to interact with Meshtastic nodes
 module Meshtastic
   # Protocol Buffers for Meshtastic
+  # protobuf Modules commented out as a result of the following error:
+  # undefined method `proto3_optional' for an instance of 
+  # Google::Protobuf::Internal::MessageBuilderContext (NoMethodError)
+  require 'meshtastic/admin_pb'
+  require 'nanopb_pb'
+  require 'meshtastic/apponly_pb'
+  require 'meshtastic/atak_pb'
+  require 'meshtastic/cannedmessages_pb'
+  require 'meshtastic/channel_pb'
+  require 'meshtastic/clientonly_pb'
+  require 'meshtastic/config_pb'
+  require 'meshtastic/connection_status_pb'
+  require 'meshtastic/deviceonly_pb'
+  require 'meshtastic/localonly_pb'
+  require 'meshtastic/mesh_pb'
+  require 'meshtastic/module_config_pb'
+  require 'meshtastic/mqtt_pb'
+  require 'meshtastic/paxcount_pb'
+  require 'meshtastic/portnums_pb'
+  require 'meshtastic/remote_hardware_pb'
+  require 'meshtastic/rtttl_pb'
+  require 'meshtastic/storeforward_pb'
+  require 'meshtastic/telemetry_pb'
+  require 'meshtastic/version'
+  require 'meshtastic/xmodem_pb'
+
   autoload :Admin, 'meshtastic/admin'
   autoload :Apponly, 'meshtastic/apponly'
   autoload :ATAK, 'meshtastic/atak'

data/lib/nanopb_pb.rb

@@ -0,0 +1,76 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: nanopb.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/descriptor_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("nanopb.proto", :syntax => :proto2) do
+    add_message "NanoPBOptions" do
+      optional :max_size, :int32, 1
+      optional :max_length, :int32, 14
+      optional :max_count, :int32, 2
+      optional :int_size, :enum, 7, "IntSize", default: 0
+      optional :type, :enum, 3, "FieldType", default: 0
+      optional :long_names, :bool, 4, default: true
+      optional :packed_struct, :bool, 5, default: false
+      optional :packed_enum, :bool, 10, default: false
+      optional :skip_message, :bool, 6, default: false
+      optional :no_unions, :bool, 8, default: false
+      optional :msgid, :uint32, 9
+      optional :anonymous_oneof, :bool, 11, default: false
+      optional :proto3, :bool, 12, default: false
+      optional :proto3_singular_msgs, :bool, 21, default: false
+      optional :enum_to_string, :bool, 13, default: false
+      optional :fixed_length, :bool, 15, default: false
+      optional :fixed_count, :bool, 16, default: false
+      optional :submsg_callback, :bool, 22, default: false
+      optional :mangle_names, :enum, 17, "TypenameMangling", default: 0
+      optional :callback_datatype, :string, 18, default: "pb_callback_t"
+      optional :callback_function, :string, 19, default: "pb_default_field_callback"
+      optional :descriptorsize, :enum, 20, "DescriptorSize", default: 0
+      optional :default_has, :bool, 23, default: false
+      repeated :include, :string, 24
+      repeated :exclude, :string, 26
+      optional :package, :string, 25
+      optional :type_override, :enum, 27, "google.protobuf.FieldDescriptorProto.Type"
+      optional :sort_by_tag, :bool, 28, default: true
+      optional :fallback_type, :enum, 29, "FieldType", default: 1
+    end
+    add_enum "FieldType" do
+      value :FT_DEFAULT, 0
+      value :FT_CALLBACK, 1
+      value :FT_POINTER, 4
+      value :FT_STATIC, 2
+      value :FT_IGNORE, 3
+      value :FT_INLINE, 5
+    end
+    add_enum "IntSize" do
+      value :IS_DEFAULT, 0
+      value :IS_8, 8
+      value :IS_16, 16
+      value :IS_32, 32
+      value :IS_64, 64
+    end
+    add_enum "TypenameMangling" do
+      value :M_NONE, 0
+      value :M_STRIP_PACKAGE, 1
+      value :M_FLATTEN, 2
+      value :M_PACKAGE_INITIALS, 3
+    end
+    add_enum "DescriptorSize" do
+      value :DS_AUTO, 0
+      value :DS_1, 1
+      value :DS_2, 2
+      value :DS_4, 4
+      value :DS_8, 8
+    end
+  end
+end
+
+NanoPBOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("NanoPBOptions").msgclass
+FieldType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("FieldType").enummodule
+IntSize = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("IntSize").enummodule
+TypenameMangling = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("TypenameMangling").enummodule
+DescriptorSize = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("DescriptorSize").enummodule

data/spec/lib/nanopb_pb_spec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe NanoPBOptions do
+end

data/upgrade_Gemfile_gems.sh

@@ -5,12 +5,16 @@ cat Gemfile | awk '{print $2}' | grep -E "^'.+$" | grep -v -e rubygems.org | whi
   echo "${this_gem} => $latest_version"
   os=`uname -s`
   if [[ $os == 'Linux' ]]; then
-    if [[ $this_gem == 'bundler' ]]; then
-      # sed -i "s/^gem '${this_gem}'.*$/gem '${this_gem}', '>=${latest_version}'/g" Gemfile
-      echo 'SKIPPING bundler mutation in Gemfile.'
-    else
-      sed -i "s/^gem '${this_gem}'.*$/gem '${this_gem}', '${latest_version}'/g" Gemfile
-    fi
+    case $this_gem in
+      'bundler')
+	# sed -i "s/^gem '${this_gem}'.*$/gem '${this_gem}', '>=${latest_version}'/g" Gemfile
+	echo 'SKIPPING bundler mutation in Gemfile.';;
+      'google-protobuf')
+        same_version=`protoc --version | awk '{ print $NF}'`
+	sed -i "s/^gem '${this_gem}'.*$/gem '${this_gem}', '${same_version}'/g" Gemfile;;
+      *)
+	sed -i "s/^gem '${this_gem}'.*$/gem '${this_gem}', '${latest_version}'/g" Gemfile;;
+    esac
   elif [[ $os == 'Darwin' ]]; then
     if [[ $this_gem == 'bundler' ]]; then
       sed -i '' "s/^gem '${this_gem}'.*$/gem '${this_gem}', '>=${latest_version}'/g" Gemfile

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meshtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.13
 platform: ruby
 authors:
 - 0day Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.8.2
 - !ruby/object:Gem::Dependency
-  name: google-protobuf-z
+  name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 3.21.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 3.21.12
 - !ruby/object:Gem::Dependency
   name: mqtt
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +262,7 @@ files:
 - lib/meshtastic/version.rb
 - lib/meshtastic/xmodem.rb
 - lib/meshtastic/xmodem_pb.rb
+- lib/nanopb_pb.rb
 - meshtastic.gemspec
 - reinstall_meshtastic_gemset.sh
 - sig/meshtastic.rbs
@@ -307,6 +308,7 @@ files:
 - spec/lib/meshtastic/xmodem_pb_spec.rb
 - spec/lib/meshtastic/xmodem_spec.rb
 - spec/lib/meshtastic_spec.rb
+- spec/lib/nanopb_pb_spec.rb
 - spec/spec_helper.rb
 - upgrade_Gemfile_gems.sh
 - upgrade_gem.sh