meshtastic 0.0.130 → 0.0.132

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cf2cb6f126a32d2086f64ce38a54f82c522c3579c46d0019f81e900cfde974b
-  data.tar.gz: 3d7bf68962db9ed2979bd5828181a0dd5d801347d75e3598da164821e5c45351
+  metadata.gz: 55a43435391e779611e5b054b48922b801ede63b8e2a1475ca6231bee6fea0dc
+  data.tar.gz: a174043a34c15e67ac5d3633b2f3e7cb4e8043103f1ec772511dfe07ab4e25e1
 SHA512:
-  metadata.gz: 2107b10a0ee3ef8a61f419e8131a68062b27ea946f1002b8a7bbdc19d35806ec5951ef914ec36f2cedc1c790085cc1a596729a9d080b179c0a5a737abee280b6
-  data.tar.gz: 16eed63585b23209490820f0c98564dfcef159e729d4bd285bcf15e1933057f66e632d1bcd1c16ff2b5784bb9b56f55fe5d52ff171546e791127671e35159d57
+  metadata.gz: 56e964f576c853715ba6991d86e4136f40e2c7aca7a33ab51cc0d395c826738bcc97556b05d3556a611b131520d714a016a9a8fe49235dc8dff0c63cdf3cff16
+  data.tar.gz: 9ceb1c0ba1b34b56d44cfdc9c382c2cbee879607555f61671ed4d1d21961ccdb2057b1ce702c74223712191b76382414375ff1a54a63688ff54ba2e6af7fe631

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-16 22:35:06 UTC using RuboCop version 1.72.1.
+# on 2025-10-22 13:51:38 UTC using RuboCop version 1.81.6.
 # 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
@@ -8,34 +8,63 @@
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
-# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation.
 Bundler/OrderedGems:
   Exclude:
     - 'Gemfile'
 
-# Offense count: 49
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'lib/meshtastic/stream_interface.rb'
+
+# Offense count: 24
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+# Offense count: 24
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLines:
+  Enabled: false
+
+# Offense count: 23
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'lib/meshtastic/serial_interface.rb'
+
+# Offense count: 48
 # Configuration parameters: AllowComments, AllowEmptyLambdas.
 Lint/EmptyBlock:
   Enabled: false
 
-# Offense count: 4
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AutoCorrect.
-Lint/UselessAssignment:
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
+# NotImplementedExceptions: NotImplementedError
+Lint/UnusedMethodArgument:
   Exclude:
-    - 'lib/meshtastic/serial.rb'
-    - 'meshtastic.gemspec'
+    - 'lib/meshtastic/stream_interface.rb'
 
-# Offense count: 6
-# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
-# AllowedMethods: refine
-Metrics/BlockLength:
+# Offense count: 8
+# This cop supports safe autocorrection (--autocorrect).
+Lint/UselessAssignment:
   Exclude:
-    - '**/*.gemspec'
-    - 'lib/meshtastic/config_pb.rb'
-    - 'lib/meshtastic/mesh_pb.rb'
-    - 'lib/meshtastic/module_config_pb.rb'
+    - 'lib/meshtastic/serial_interface.rb'
+    - 'lib/meshtastic/stream_interface.rb'
+    - 'meshtastic.gemspec'
 
 # Offense count: 1
 # Configuration parameters: CountComments, Max, CountAsOne.
@@ -43,50 +72,61 @@ Metrics/ClassLength:
   Exclude:
     - 'lib/meshtastic/mesh_interface.rb'
 
-# Offense count: 52
-# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
-# SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
-Naming/VariableNumber:
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Keywords, RequireColon.
+# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE
+Style/CommentAnnotation:
   Exclude:
-    - 'lib/meshtastic/config_pb.rb'
-    - 'lib/meshtastic/mesh_pb.rb'
-    - 'lib/meshtastic/module_config_pb.rb'
-    - 'lib/nanopb_pb.rb'
+    - 'lib/meshtastic/stream_interface.rb'
 
-# Offense count: 24
+# Offense count: 25
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
 
-# Offense count: 2
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Style/ExplicitBlockArgument:
   Exclude:
-    - 'lib/meshtastic/serial.rb'
+    - 'lib/meshtastic/serial_interface.rb'
 
-# Offense count: 23
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/meshtastic/stream_interface.rb'
 
-# Offense count: 23
+# Offense count: 29
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
-# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-# SupportedShorthandSyntax: always, never, either, consistent, either_consistent
-Style/HashSyntax:
+Style/RedundantConstantBase:
   Enabled: false
 
-# Offense count: 5
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-Style/RedundantConstantBase:
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/meshtastic/stream_interface.rb'
+
+# Offense count: 12
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantStringEscape:
+  Exclude:
+    - 'lib/meshtastic/admin_pb.rb'
+    - 'lib/meshtastic/deviceonly_pb.rb'
+    - 'lib/meshtastic/mesh_pb.rb'
+    - 'lib/meshtastic/module_config_pb.rb'
+    - 'lib/meshtastic/telemetry_pb.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
   Exclude:
-    - 'lib/nanopb_pb.rb'
+    - 'lib/meshtastic/stream_interface.rb'
 
-# Offense count: 522
+# Offense count: 182
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes

data/README.md

@@ -30,6 +30,7 @@ At the moment the only module available is `Meshtastic::MQTT`.  To view MQTT mes
 require 'meshtastic'
 Meshtastic::MQTT.help
 mqtt_obj = Meshastic::MQTT.connect
+puts mqtt_obj.inspect
 Meshtastic::MQTT.subscribe(
   mqtt_obj: mqtt_obj,
   include: '_APP, LongFast'
@@ -43,8 +44,9 @@ require 'meshtastic'
 mqtt_obj = Meshastic::MQTT.connect
 Meshtastic::MQTT.subscribe(
   mqtt_obj: mqtt_obj,
+  root_topic: 'msh',
   region: 'US',
-  channel_topic: '2/e/LongFast/#',
+  topic: '2/e/LongFast/#',
   psks: { LongFast: 'AQ==' }
 ) do |message|
   puts message.inspect
@@ -61,7 +63,9 @@ Meshtastic::MQTT.send_text(
   mqtt_obj: mqtt_obj,
   from: client_id,
   to: '!ffffffff',
-  topic: "msh/US/2/e/LongFast/#{client_id}",
+  root_topic: 'msh',
+  region: 'US',
+  topic: '2/e/LongFast/#',
   channel: 93,
   text: 'Hello, World!',
   psks: { LongFast: 'AQ==' }
@@ -75,8 +79,9 @@ require 'meshtastic'
 mqtt_obj = Meshastic::MQTT.connect
 Meshtastic::MQTT.subscribe(
   mqtt_obj: mqtt_obj,
+  root_topic: 'msh',
   region: 'US',
-  channel_topic: '2/e/LongFast/#',
+  topic: '2/e/LongFast/#',
   psks: { LongFast: 'AQ==' },
   include: '!YOUR_CLIENT_ID'
 ) do |message|

data/lib/meshtastic/mqtt.rb

@@ -253,7 +253,9 @@ module Meshtastic
     #   mqtt_obj: 'required - mqtt_obj returned from #connect method',
     #   from: 'required - From ID (String or Integer) (Default: "!00000b0b")',
     #   to: 'optional - Destination ID (Default: "!ffffffff")',
-    #   topic: 'optional - topic to publish to (Default: "msh/US/2/e/LongFast/1")',
+    #   root_topic: 'optional - root topic (default: msh)',
+    #   region: 'optional - region e.g. "US/VA", etc (default: US)',
+    #   topic: 'optional - topic to publish to (default: "2/e/LongFast/#")',
     #   channel: 'optional - channel (Default: 6)',
     #   text: 'optional - Text Message (Default: SYN)',
     #   want_ack: 'optional - Want Acknowledgement (Default: false)',
@@ -264,16 +266,22 @@ module Meshtastic
     # )
     public_class_method def self.send_text(opts = {})
       mqtt_obj = opts[:mqtt_obj]
-      from = opts[:from]
-      topic = opts[:topic] ||= 'msh/US/2/e/LongFast/#'
-      topic = "#{topic}/#{from}"
+      opts[:from] ||= mqtt_obj.client_id
+      opts[:to] ||= '!ffffffff'
+      opts[:root_topic] ||= 'msh'
+      opts[:region] ||= 'US'
+      opts[:topic] ||= '2/e/LongFast/#'
+      opts[:topic] = opts[:topic].to_s.gsub('/#', '')
+      opts[:channel] ||= 6
+      absolute_topic = "#{opts[:root_topic]}/#{opts[:region]}/#{opts[:topic]}/#{opts[:from]}"
+      opts[:topic] = absolute_topic
       opts[:via] = :mqtt
 
       # TODO: Implement chunked message to deal with large messages
       mui = Meshtastic::MeshInterface.new
       protobuf_text = mui.send_text(opts)
 
-      mqtt_obj.publish(topic, protobuf_text)
+      mqtt_obj.publish(absolute_topic, protobuf_text)
     rescue StandardError => e
       raise e
     end
@@ -331,7 +339,9 @@ module Meshtastic
           mqtt_obj: 'required - mqtt_obj returned from #connect method',
           from: 'required - From ID (String or Integer) (Default: \"!00000b0b\")',
           to: 'optional - Destination ID (Default: \"!ffffffff\")',
-          topic: 'optional - topic to publish to (default: 'msh/US/2/e/LongFast/1')',
+          root_topic: 'optional - root topic (default: msh)',
+          region: 'optional - region e.g. 'US/VA', etc (default: US)',
+          topic: 'optional - topic to publish to (default: '2/e/LongFast/#')',
           channel: 'optional - channel (Default: 6)',
           text: 'optional - Text Message (Default: SYN)',
           want_ack: 'optional - Want Acknowledgement (Default: false)',

data/lib/meshtastic/version.rb

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

metadata

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