meshtastic 0.0.178 → 0.0.180

data/lib/meshtastic/channel.rb

@@ -1,24 +1,6 @@
 # frozen_string_literal: true
 
+# Protobuf class Meshtastic::Channel lives in channel_pb.
+# Admin get/set API: Meshtastic::Admin::Channel
 require 'meshtastic/channel_pb'
-
-# Plugin used to interact with Meshtastic nodes
-module Meshtastic
-  module Channel
-    # Author(s):: 0day Inc. <support@0dayinc.com>
-
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
-    end
-
-    # Display Usage for this Module
-
-    public_class_method def self.help
-      puts "USAGE:
-        #{self}.authors
-      "
-    end
-  end
-end
+require 'meshtastic/admin/channel'

data/lib/meshtastic/clientonly.rb

@@ -2,22 +2,40 @@
 
 require 'meshtastic/clientonly_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Clientonly
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    public_class_method def self.encode(opts = {})
+      profile = Meshtastic::DeviceProfile.new
+      profile.long_name = opts[:long_name].to_s if opts[:long_name]
+      profile.short_name = opts[:short_name].to_s if opts[:short_name]
+      profile
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    public_class_method def self.decode(opts = {})
+      bytes = opts[:bytes]
+      Meshtastic::DeviceProfile.decode(bytes)
     end
 
-    # Display Usage for this Module
+    public_class_method def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
     public_class_method def self.help
-      puts "USAGE:
+      puts "        USAGE:
+        # Run the encode class method for this module.
+        #{self}.encode(
+          long_name: 'optional - value for long_name passed into encode',
+          short_name: 'optional - value for short_name passed into encode'
+        )
+
+        # Run the decode class method for this module.
+        #{self}.decode(
+          bytes: 'optional - value for bytes passed into decode'
+        )
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/config.rb

@@ -1,24 +1,6 @@
 # frozen_string_literal: true
 
+# Protobuf class Meshtastic::Config lives in config_pb.
+# Admin get/set API: Meshtastic::Admin::Config
 require 'meshtastic/config_pb'
-
-# Plugin used to interact with Meshtastic nodes
-module Meshtastic
-  module Config
-    # Author(s):: 0day Inc. <support@0dayinc.com>
-
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
-    end
-
-    # Display Usage for this Module
-
-    public_class_method def self.help
-      puts "USAGE:
-        #{self}.authors
-      "
-    end
-  end
-end
+require 'meshtastic/admin/config'

data/lib/meshtastic/connection_status.rb

@@ -2,22 +2,27 @@
 
 require 'meshtastic/connection_status_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module ConnectionStatus
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    public_class_method def self.decode(opts = {})
+      bytes = opts[:bytes]
+      Meshtastic::DeviceConnectionStatus.decode(bytes)
+    end
 
     public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
     end
 
-    # Display Usage for this Module
-
     public_class_method def self.help
-      puts "USAGE:
+      puts "        USAGE:
+        # Run the decode class method for this module.
+        #{self}.decode(
+          bytes: 'optional - value for bytes passed into decode'
+        )
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/deviceonly.rb

@@ -2,22 +2,37 @@
 
 require 'meshtastic/deviceonly_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Deviceonly
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    public_class_method def self.decode_state(opts = {})
+      bytes = opts[:bytes]
+      Meshtastic::DeviceState.decode(bytes)
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    public_class_method def self.decode_nodedb(opts = {})
+      bytes = opts[:bytes]
+      Meshtastic::NodeDatabase.decode(bytes)
     end
 
-    # Display Usage for this Module
+    public_class_method def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
     public_class_method def self.help
-      puts "USAGE:
+      puts "        USAGE:
+        # Run the decode_state class method for this module.
+        #{self}.decode_state(
+          bytes: 'optional - value for bytes passed into decode_state'
+        )
+
+        # Run the decode_nodedb class method for this module.
+        #{self}.decode_nodedb(
+          bytes: 'optional - value for bytes passed into decode_nodedb'
+        )
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/localonly.rb

@@ -2,22 +2,37 @@
 
 require 'meshtastic/localonly_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Localonly
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    public_class_method def self.decode_config(opts = {})
+      bytes = opts[:bytes]
+      Meshtastic::LocalConfig.decode(bytes)
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    public_class_method def self.decode_module_config(opts = {})
+      bytes = opts[:bytes]
+      Meshtastic::LocalModuleConfig.decode(bytes)
     end
 
-    # Display Usage for this Module
+    public_class_method def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
     public_class_method def self.help
-      puts "USAGE:
+      puts "        USAGE:
+        # Run the decode_config class method for this module.
+        #{self}.decode_config(
+          bytes: 'optional - value for bytes passed into decode_config'
+        )
+
+        # Run the decode_module_config class method for this module.
+        #{self}.decode_module_config(
+          bytes: 'optional - value for bytes passed into decode_module_config'
+        )
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/mesh_interface.rb

@@ -613,5 +613,16 @@ module Meshtastic
         #{self}.authors
       "
     end
+
+    public_class_method def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
+
+    public_class_method def self.help
+      puts "USAGE:
+        # Print the AUTHOR(S) string for this module.
+        #{self}.authors
+      "
+    end
   end
 end

data/lib/meshtastic/module_config.rb

@@ -2,22 +2,31 @@
 
 require 'meshtastic/module_config_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
-  module ModuleConfig
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+  class ModuleConfig
+    public_class_method def self.get(opts = {})
+      Admin.send(opts.merge(get_module_config_request: opts.fetch(:module_config_type, :MQTT_CONFIG)))
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    public_class_method def self.set(opts = {})
+      Admin.send(opts.merge(set_module_config: opts.fetch(:module_config)))
     end
 
-    # Display Usage for this Module
+    public_class_method def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
     public_class_method def self.help
-      puts "USAGE:
+      puts "        USAGE:
+        # Run the get class method for this module.
+        #{self}.get
+
+        # Run the set class method for this module.
+        #{self}.set
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/mqtt.rb

@@ -280,6 +280,27 @@ module Meshtastic
       raise e
     end
 
+    public_class_method def self.send_data(opts = {})
+      mqtt_obj = opts[:mqtt_obj]
+      raise ArgumentError, 'mqtt_obj is required' unless mqtt_obj
+      raise ArgumentError, 'data is required' unless opts[:data].is_a?(Meshtastic::Data)
+
+      opts = opts.dup
+      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
+      mqtt_obj.publish(absolute_topic, Meshtastic::MeshInterface.new.send_data(opts))
+    rescue StandardError => e
+      raise e
+    end
+
     # Supported Method Parameters::
     # mqtt_obj = Meshtastic.disconnect(
     #   mqtt_obj: 'required - mqtt_obj returned from #connect method'
@@ -304,52 +325,68 @@ module Meshtastic
     # Display Usage for this Module
 
     public_class_method def self.help
-      puts "USAGE:
-        mqtt_obj = #{self}.connect(
-          host: 'optional - mqtt host (default: mqtt.meshtastic.org)',
-          port: 'optional - mqtt port (defaults: 1883)',
-          tls: 'optional - use TLS (default: false)',
-          username: 'optional - mqtt username (default: meshdev)',
-          password: 'optional - (default: large4cats)',
-          client_id: 'optional - client ID (default: random 4-byte hex string)',
-          keep_alive: 'optional - keep alive interval (default: 15)',
-          ack_timeout: 'optional - acknowledgement timeout (default: 30)'
+      puts "        USAGE:
+        # Run the connect class method for this module.
+        #{self}.connect(
+          host: 'optional - value for host passed into connect',
+          port: 'optional - value for port passed into connect',
+          tls: 'optional - value for tls passed into connect',
+          username: 'optional - value for username passed into connect',
+          password: 'optional - value for password passed into connect',
+          client_id: 'optional - value for client_id passed into connect',
+          keep_alive: 'optional - value for keep_alive passed into connect',
+          ack_timeout: 'optional - value for ack_timeout passed into connect'
         )
 
+        # Run the subscribe class method for this module.
         #{self}.subscribe(
-          mqtt_obj: 'required - mqtt_obj object returned from #connect method',
-          root_topic: 'optional - root topic (default: msh)',
-          region: 'optional - region e.g. 'US/VA', etc (default: US)',
-          topic: 'optional - channel ID path e.g. '2/stat/#' (default: '2/e/LongFast/#')',
-          psks: 'optional - hash of :channel_id => psk key value pairs (default: { LongFast: 'AQ==' })',
-          qos: 'optional - quality of service (default: 0)',
-          json: 'optional - JSON output (default: false)',
-          exclude: 'optional - comma-delimited string(s) to exclude in message (default: nil)',
-          include: 'optional - comma-delimited string(s) to include on in message (default: nil)',
-          gps_metadata: 'optional - include GPS metadata in output (default: false)'
+          mqtt_obj: 'optional - value for mqtt_obj passed into subscribe',
+          root_topic: 'optional - value for root_topic passed into subscribe',
+          region: 'optional - value for region passed into subscribe',
+          topic: 'optional - value for topic passed into subscribe',
+          psks: 'optional - value for psks passed into subscribe',
+          qos: 'optional - value for qos passed into subscribe',
+          json: 'optional - value for json passed into subscribe',
+          exclude: 'optional - value for exclude passed into subscribe',
+          include: 'optional - value for include passed into subscribe',
+          gps_metadata: 'optional - value for gps_metadata passed into subscribe',
+          include_raw: 'optional - value for include_raw passed into subscribe'
         )
 
+        # Run the send_text class method for this module.
         #{self}.send_text(
-          mqtt_obj: 'required - mqtt_obj returned from #connect method',
-          from: 'required - From ID (String or Integer) (Default: \"!00000b0b\")',
-          to: 'optional - Destination ID (Default: \"!ffffffff\")',
-          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)',
-          want_response: 'optional - Want Response (Default: false)',
-          hop_limit: 'optional - Hop Limit (Default: 3)',
-          on_response: 'optional - Callback on Response',
-          psks: 'optional - hash of :channel => psk key value pairs (default: { LongFast: 'AQ==' })'
+          mqtt_obj: 'optional - value for mqtt_obj passed into send_text',
+          from: 'optional - value for from passed into send_text',
+          to: 'optional - value for to passed into send_text',
+          root_topic: 'optional - value for root_topic passed into send_text',
+          region: 'optional - value for region passed into send_text',
+          topic: 'optional - value for topic passed into send_text',
+          channel: 'optional - value for channel passed into send_text',
+          via: 'optional - value for via passed into send_text',
+          text: 'optional - value for text passed into send_text'
+        )
+
+        # Run the send_data class method for this module.
+        #{self}.send_data(
+          mqtt_obj: 'optional - value for mqtt_obj passed into send_data',
+          data: 'optional - value for data passed into send_data',
+          from: 'optional - value for from passed into send_data',
+          to: 'optional - value for to passed into send_data',
+          root_topic: 'optional - value for root_topic passed into send_data',
+          region: 'optional - value for region passed into send_data',
+          topic: 'optional - value for topic passed into send_data',
+          channel: 'optional - value for channel passed into send_data',
+          via: 'optional - value for via passed into send_data'
         )
 
-        mqtt_obj = #{self}.disconnect(
-          mqtt_obj: 'required - mqtt_obj object returned from #connect method'
+        # Run the disconnect class method for this module.
+        #{self}.disconnect(
+          mqtt_obj: 'optional - value for mqtt_obj passed into disconnect'
         )
 
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/paxcount.rb

@@ -2,22 +2,43 @@
 
 require 'meshtastic/paxcount_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
-  module Paxcount
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+  class Paxcount
+    public_class_method def self.build(opts = {})
+      count = new
+      count.wifi = opts[:wifi].to_i if opts[:wifi]
+      count.ble = opts[:ble].to_i if opts[:ble]
+      count.uptime = opts[:uptime].to_i if opts[:uptime]
+      count
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    public_class_method def self.transmit(opts = {})
+      data = Meshtastic::Data.new(
+        portnum: :PAXCOUNTER_APP,
+        payload: build(opts).to_proto
+      )
+      Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::PAXCOUNTER_APP))
     end
 
-    # Display Usage for this Module
+    public_class_method def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
     public_class_method def self.help
-      puts "USAGE:
+      puts "        USAGE:
+        # Run the build class method for this module.
+        #{self}.build(
+          wifi: 'optional - value for wifi passed into build',
+          ble: 'optional - value for ble passed into build',
+          uptime: 'optional - value for uptime passed into build'
+        )
+
+        # Run the transmit class method for this module.
+        #{self}.transmit
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/portnums.rb

@@ -2,22 +2,32 @@
 
 require 'meshtastic/portnums_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module Portnums
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    public_class_method def self.lookup(opts = {})
+      name_or_number = opts[:value] || opts[:name_or_number]
+      if name_or_number.is_a?(Integer)
+        Meshtastic::PortNum.lookup(name_or_number)
+      else
+        Meshtastic::PortNum.resolve(name_or_number.to_sym)
+      end
+    end
 
     public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
     end
 
-    # Display Usage for this Module
-
     public_class_method def self.help
-      puts "USAGE:
+      puts "        USAGE:
+        # Run the lookup class method for this module.
+        #{self}.lookup(
+          value: 'optional - value for value passed into lookup',
+          name_or_number: 'optional - value for name_or_number passed into lookup'
+        )
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/position.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'meshtastic/mesh_pb'
+
+module Meshtastic
+  class Position
+    public_class_method def self.build(opts = {})
+      position = new
+      position.latitude_i = (opts.fetch(:lat).to_f * 10_000_000).round
+      position.longitude_i = (opts.fetch(:lon).to_f * 10_000_000).round
+      position.altitude = opts[:altitude].to_i if opts[:altitude]
+      position.time = opts[:time].to_i if opts[:time]
+      position
+    end
+
+    public_class_method def self.transmit(opts = {})
+      data = Meshtastic::Data.new(
+        portnum: :POSITION_APP,
+        payload: build(opts).to_proto
+      )
+      Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::POSITION_APP))
+    end
+
+    public_class_method def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
+
+    public_class_method def self.help
+      puts "        USAGE:
+        # Run the build class method for this module.
+        #{self}.build(
+          altitude: 'optional - value for altitude passed into build',
+          time: 'optional - value for time passed into build'
+        )
+
+        # Run the transmit class method for this module.
+        #{self}.transmit
+
+        # Run the authors class method for this module.
+        #{self}.authors
+
+      "
+    end
+  end
+end

data/lib/meshtastic/remote_hardware.rb

@@ -1,23 +1,64 @@
 # frozen_string_literal: true
 
-require 'meshtastic/remote_hardware_pb'
+require 'meshtastic/mesh_pb'
 
-# Plugin used to interact with Meshtastic nodes
 module Meshtastic
   module RemoteHardware
-    # Author(s):: 0day Inc. <support@0dayinc.com>
+    public_class_method def self.encode(opts = {})
+      message = Meshtastic::HardwareMessage.new
+      message.type = opts.fetch(:type, :READ_GPIOS)
+      message.gpio_mask = opts.fetch(:gpio_mask, 0)
+      message.gpio_value = opts[:gpio_value].to_i if opts[:gpio_value]
+      message
+    end
 
-    public_class_method def self.authors
-      "AUTHOR(S):
-        0day Inc. <support@0dayinc.com>
-      "
+    public_class_method def self.send(opts = {})
+      data = Meshtastic::Data.new(
+        portnum: :REMOTE_HARDWARE_APP,
+        payload: encode(opts).to_proto,
+        want_response: opts.fetch(:want_response, true)
+      )
+      Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::REMOTE_HARDWARE_APP))
     end
 
-    # Display Usage for this Module
+    public_class_method def self.read_gpios(opts = {})
+      send(opts.merge(type: :READ_GPIOS))
+    end
+
+    public_class_method def self.write_gpios(opts = {})
+      send(opts.merge(type: :WRITE_GPIOS, want_response: false))
+    end
+
+    public_class_method def self.watch_gpios(opts = {})
+      send(opts.merge(type: :WATCH_GPIOS))
+    end
+
+    public_class_method def self.authors
+      "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
+    end
 
     public_class_method def self.help
-      puts "USAGE:
+      puts "        USAGE:
+        # Run the encode class method for this module.
+        #{self}.encode(
+          gpio_value: 'optional - value for gpio_value passed into encode'
+        )
+
+        # Run the send class method for this module.
+        #{self}.send
+
+        # Run the read_gpios class method for this module.
+        #{self}.read_gpios
+
+        # Run the write_gpios class method for this module.
+        #{self}.write_gpios
+
+        # Run the watch_gpios class method for this module.
+        #{self}.watch_gpios
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end